Differences

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

--- dev:translators:framework [2011/11/27 00:44] – [Functions] adding explanation by erik from zotero-dev ajlyon
+++ dev:translators:framework [2017/11/18 16:20] (current) – Add legacy notice adamsmith
@@ Line 1: / Line 1: @@
+**While the Translator Framework still works, new translators using the Framework are no longer accepted, and we are migrating existing translators away from the format.**
+**This page exists as legacy documentation only.**
 ====== Translator Framework ======
 The translator framework is a way to build web translators that lets translator authors avoid most of the boilerplate that usually is required for new translators, making it possible to write simple content scrapers in just a few lines of JavaScript.
-The framework was written and contributed by Erik Hetzner and is licensed under the AGPLv3+. It currently resides at http://e6h.org/~egh/hg/zotero-transfw/, but there are plans to include it in Zotero itself.
+The framework was written and contributed by Erik Hetzner and is licensed under the AGPLv3+. It currently resides at https://gitlab.com/egh/zotero-transfw, but there are plans to include it in Zotero itself.
-To use the framework, simply insert the framework code at the beginning of your translator, after the translator information block (JSON header). If you are using [[dev/translators/Scaffold]] to develop your translator, you won't see the information block, and you can just insert the framework at the top of the code box. The latest version of the code is [[http://e6h.org/~egh/hg/zotero-transfw/raw-file/tip/framework.js|here]].
+To use the framework, simply insert the framework code at the beginning of your translator, after the translator information block (JSON header). If you are using [[dev/translators/Scaffold]] to develop your translator, you won't see the information block, and can click "Uses translator framework" on Scaffold's Metadata tab to automatically include the code.
 You'll start writing beneath the line that reads:
@@ Line 54: / Line 58: @@
 === FW.Scraper ===
-  * Required keys: ''detect'', ''itemType''
+  * Required keys: ''detect'', ''itemType'' ([[http://aurimasv.github.io/z2csl/typeMap.xml|list of itemType options]])
-  * Optional keys: ''attachments'', all [[http://gsl-nagoya-u.net/http/pub/csl-fields/index.html|Zotero item fields]]
+  * Optional keys: ''attachments''
 === FW.MultiScraper ===
@@ Line 84: / Line 88: @@
 </code>
 Here the option is used to guarantee that the multiple item page has links to the BibTeX files that the translator uses.
-== Delegation ==
-It is possible to have a translator using this framework delegate processing to another translator, by setting the key ''itemTrans'', as in this example from the framework-derived version of the Google Scholar translator:
-<code javascript>
-itemTrans : FW.DelegateTranslator({ translatorType : "import",
-                                    translatorId   : "9cb70025-a888-4a29-a210-93ec52da40d4"}),
-</code>
-This delegation method can only be used with a ''MultiScraper'' -- each response will be sent to the specified translator to be processed, instead of being matched against the other scrapers defined in the current translator.
 === Attachments ===
@@ Line 193: / Line 187: @@
 </code>
 ==== FW.Scraper ====
-For possible values of ''itemType'' and the legal fields for each type, see the schema description at http://gsl-nagoya-u.net/http/pub/csl-fields/index.html .
+For possible values of ''itemType'' and the legal fields for each type, see the schema description at http://aurimasv.github.io/z2csl/typeMap.xml .
 <code javascript>
 FW.Scraper({