Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revisionBoth sides next revision
dev:translator_development_outside_scaffold [2010/07/24 16:56] – added tomrochewikidev:translator_development_outside_scaffold [2010/07/24 17:05] – sync with my emacs buffer tomrochewiki
Line 35: Line 35:
 === Translator file location === === Translator file location ===
  
-Zotero installs its translators and related code as files in the subdirectory //translators//. I.e.+Zotero installs its translators and related code as files in the subdirectory ''translators''. I.e.
   * if the path to your Firefox profile=<code>${FIREFOX_PROFILE}</code> then the path to your Zotero is <code>${FIREFOX_PROFILE}/zotero</code>   * if the path to your Firefox profile=<code>${FIREFOX_PROFILE}</code> then the path to your Zotero is <code>${FIREFOX_PROFILE}/zotero</code>
   * if the path to your Zotero=<code>${FIREFOX_PROFILE}/zotero</code> then the path to your translators, and hence to your translator development environment, is <code>${FIREFOX_PROFILE}/zotero/translators</code> (See above regarding using Zotero UI to identify the path to your current Zotero.)   * if the path to your Zotero=<code>${FIREFOX_PROFILE}/zotero</code> then the path to your translators, and hence to your translator development environment, is <code>${FIREFOX_PROFILE}/zotero/translators</code> (See above regarding using Zotero UI to identify the path to your current Zotero.)
Line 44: Line 44:
  
 At the highest level, a Zotero translator (for versions >= 2.0) consists of At the highest level, a Zotero translator (for versions >= 2.0) consists of
-  * a single [[translators_reference_guide#translator_metadata|metadata block]], usually at the beginning of the file. The most important of its fields is the //translatorID//, which is the global identifier for the translator.+  * a single [[translators_reference_guide#translator_metadata|metadata block]], usually at the beginning of the file. The most important of its fields is the ''translatorID'', which is the global identifier for the translator.
   * non-metadata code, consisting of   * non-metadata code, consisting of
-    * a //detectWeb// function. This must return a string corresponding to a defined Zotero type. For a list of Zotero type names, see the values of the //itemTypes.//* properties in [[https://www.zotero.org/trac/browser/extension/branches/2.0/chrome/locale/en-US/zotero/zotero.properties#L240|this Zotero property list]] (or a newer one). +    * a ''detectWeb'' function. This must return a string corresponding to a defined Zotero type. For a list of Zotero type names, see the values of the ''itemTypes.''* properties in [[https://www.zotero.org/trac/browser/extension/branches/2.0/chrome/locale/en-US/zotero/zotero.properties#L240|this Zotero property list]] (or a newer one). 
-    * a //doWeb// function. This actually writes an item corresponding to your web resource to your Zotero repository.+    * a ''doWeb'' function. This actually writes an item corresponding to your web resource to your Zotero repository.
  
 ==== Translator development tools ==== ==== Translator development tools ====
Line 58: Line 58:
  
 ===== Create or modify a translator file ===== ===== Create or modify a translator file =====
 +
 +One can
 +  * create a new translator file by copy/modify-ing an existing one. This may involve 
 +  * work directly on an existing translator file (e.g. to fix a bug or add an feature) without modifying the ''translatorID''
  
 ===== Edit, run, test, debug ===== ===== Edit, run, test, debug =====
dev/translator_development_outside_scaffold.txt · Last modified: 2017/11/12 19:53 by 127.0.0.1