| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
| dev:translators [2017/11/22 11:31] – [Update Contributing Translators] bwiernik | dev:translators [2021/05/01 18:20] – Update XPath tools to suggest browser DevTools jryans |
|---|
| <html><p id="zotero-5-update-warning" style="color: red; font-weight: bold">We’re | |
| in the process of updating the documentation for | |
| <a href="https://www.zotero.org/blog/zotero-5-0">Zotero 5.0</a>. Some documentation | |
| may be outdated in the meantime. Thanks for your understanding.</p></html> | |
| |
| |
| ====== Zotero Translators ====== | ====== Zotero Translators ====== |
| |
| **Note:** Before writing a translator for a site, look at the [[dev:exposing_metadata|documentation on exposing metadata]]; website authors should try embedding the necessary metadata before attempting to write a translator. | **Note:** Before writing a translator for a site, look at the [[dev:exposing_metadata|documentation on exposing metadata]]; website authors should try embedding the necessary metadata before attempting to write a translator. |
| |
| If you're looking for a broken translator to fix, see the [[https://repo.zotero.org/errors|recent translator errors]] and check on one of the top reported errors. You can also check the status of many translators by reviewing the [[dev:translators:testing#running_tests|translator test overview]]. | If you're looking for a broken translator to fix, see the [[/errors|recent translator errors]] and check on one of the top reported errors. You can also check the status of many translators by reviewing the [[dev:translators:testing#running_tests|translator test overview]]. |
| ===== Translator Types - Web, Import, Export and Search ===== | ===== Translator Types - Web, Import, Export and Search ===== |
| |
| |
| * **[[dev:translators:coding#web_translators|Web translators]]** | * **[[dev:translators:coding#web_translators|Web translators]]** |
| * //detectWeb// \\ After a web translator has been selected based by its matching target and its priority ranking, ''detectWeb'' is run to determine whether item metadata can indeed be retrieved from the webpage. Should return the detected item type (e.g. "journalArticle", see the [[http://gsl-nagoya-u.net/http/pub/csl-fields/index.html|overview of Zotero item types]]), or, if multiple items are found, "multiple". If ''detectWeb'' does not return a value, the translator with the next-highest priority is selected, until all translators with a matching target have been exhausted. | * //detectWeb// \\ After a web translator has been selected based by its matching target and its priority ranking, ''detectWeb'' is run to determine whether item metadata can indeed be retrieved from the webpage. Should return the detected item type (e.g. "journalArticle", see the [[https://aurimasv.github.io/z2csl/typeMap.xml|overview of Zotero item types]]), or, if multiple items are found, "multiple". If ''detectWeb'' does not return a value, the translator with the next-highest priority is selected, until all translators with a matching target have been exhausted. |
| * //doWeb// \\ Performs the actual item metadata retrieval. | * //doWeb// \\ Performs the actual item metadata retrieval. |
| * **[[dev:translators:coding#import_translators|Import translators]]** | * **[[dev:translators:coding#import_translators|Import translators]]** |
| |
| * [[:dev:translators:scaffold|Scaffold]] - Scaffold is a Firefox add-on developed by CHNM to create and modify web translators. Translators can be quickly [[:dev:translators:testing|tested]] and debugged, and item saving is simulated, so no changes are made to your Zotero library. | * [[:dev:translators:scaffold|Scaffold]] - Scaffold is a Firefox add-on developed by CHNM to create and modify web translators. Translators can be quickly [[:dev:translators:testing|tested]] and debugged, and item saving is simulated, so no changes are made to your Zotero library. |
| * XPath Tools \\ Many web translators rely on [[dev:technologies#xpath|XPath]] to extract information from HTML or XML. XPath construction is made easier by using the [[http://dl.dropbox.com/u/848981/it/xp/xp.html|XCpath bookmarklet]] or one of the following Firefox add-ons: | * XPath Tools - Many web translators rely on XPath to extract information from HTML or XML. Various tools can assist with generating and checking XPath expressions, including the DevTools built into browsers. For example, in Firefox, you can get the XPath for any element by finding it in the browser's Inspector tool, right-clicking on the element, and choosing Copy -> XPath. |
| * [[http://getfirebug.com/|Firebug]] - Useful to inspect the HTML structure of webpages, and [[dev:technologies#using_firebug_to_design_xpath_expressions|find XPath expressions for elements of interest]]. | |
| * [[https://addons.mozilla.org/fr/firefox/addon/firepath/|FirePath]] - Extension to Firebug to edit, inspect and generate XPath expressions. | |
| ===== Contributing Translators ===== | ===== Contributing Translators ===== |
| |
Upgrade Storage