Differences

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

--- dev:translators:scaffold [2018/02/08 07:02] – Update to Zotero 5.0 zuphilip
+++ dev:translators:scaffold [2019/08/05 05:47] – [Further Reading] dstillman
@@ Line 1: / Line 1: @@
 <html><p id="zotero-5-update-warning" style="color: red; font-weight: bold">We’re
-in the process of updating the documentation for
+in the process of updating this page after recent changes to Scaffold. Some parts may be outdated in the meantime. Thanks for your understanding.</p></html>
-<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>
@@ Line 11: / Line 9: @@
 Scaffold supports editing and testing web translators and import translators. Search and export translators can not yet be tested using the IDE.
-Scaffold 3 includes support for the [[dev:translators:testing|automated translator testing]] system that was introduced in Zotero 2.1.9, as well as for specifying [[dev:translators:connectors|connector compatibility]]. Documentation for these features is not yet available.
-===== Installation =====
-Scaffold does run within Zotero 5.0 as an [[:plugins|plugin]], which is installed by the following steps:
-  * Download the XPI file of the [[https://github.com/zotero/scaffold/releases/latest|latest release of Scaffold]]
-  * Open Zotero
-  * Tools -> Add-ons -> (gear wheel) -> Install Add-on From File
-Previously to Zotero Version 5.0, Scaffold was a Firefox Plugin.
 ===== Interface =====
-After installation, the "Tools" menu in Firefox should contain a "Scaffold" item. (If you don't have a Tools menu, see the Firefox instructions on how to [[https://support.mozilla.org/en-US/kb/what-happened-to-the-file-edit-and-view-menus|show the Menu Bar again]].)
+Scaffold is available via Tools → Developer → Translator Editor in Zotero.
-Selecting the Tools menu's "Scaffold" item opens the main Scaffold window:
+When you first open Scaffold, you'll need to select your translator development directory. In most cases, this should be a git clone of the [[https://github.com/zotero/translators|Zotero translators repository]] on GitHub.
-{{:dev:scaffold2.0-metadata.png?640&nocache&nolink|}}
+After selecting your translator directory, the main Scaffold window will open:
+{{:dev:translators:scaffold.png?640&nocache&nolink|}}
 ==== Top buttons ====
@@ Line 41: / Line 30: @@
 {{:dev:detectweb.png?nocache&nolink|}} **Run detectWeb** \\
-Saves and runs the ''detectWeb'' function of the translator code on the site loaded in the most recently selected tab.
+Saves and runs the ''detectWeb'' function of the translator code on the site loaded in the browser tab.
 {{:dev:doweb.png?nocache&nolink|}} **Run doWeb** \\
-Saves and runs the ''doWeb'' function of the translator code on the site loaded in the most recently selected tab.
+Saves and runs the ''doWeb'' function of the translator code on the site loaded in the browser tab.
+{{:dev:translators:detectimport.png?nocache&nolink|}} **Run detectImport** \\
+Saves and runs the ''detectImport'' function of the translator code on the content entered in the Import tab.
+{{:dev:translators:doimport.png?nocache&nolink|}} **Run doImport** \\
+Saves and runs the ''doImport'' function of the translator code on the content entered in the Import tab.
 ==== Tabs ====
@@ Line 50: / Line 46: @@
 **Metadata** \\ Shows the translator metadata. Translator IDs can be generated via the "Generate" button. The target regular expression can be tested with the "Test Regex" button.
-**Code** \\ The text box in this tab contains the translator's JavaScript code:
+**Code** \\ The text box in this tab contains the translator's JavaScript code. The editor supports syntax highlighting, folding of code parts, and search and replace.
+**Import** \\ For import translator you can copy here test data to import.
+**Tests**\\ This tab contains the data for all test cases saved with the translator, which is currently open.
+**Testing**\\ This is a list of all test cases for the current translator, which you can run, check or update.
-{{:dev:scaffold2.0-code.png?640&nocache&nolink|}}
+**Browser**\\ You can open specified URLs in the browser tab and then test the detection and data extraction for that website.
 ==== Debug Output ====
@@ Line 113: / Line 115: @@
 In the translator load window, import translators are arranged in alphabetical order at the bottom of the list.
-**Note:** The screenshots on this page do not reflect the changes made in Scaffold 2.1.2 to add support for import translators.
 ===== Scaffold Troubleshooting =====
@@ Line 131: / Line 132: @@
 ====== Further Reading ======
-More detailed instructions are available at [[https://www.mediawiki.org/wiki/Citoid/Creating_Zotero_translators#For_translation-server_side_development |MediaWiki]]. See [[https://www.mediawiki.org/wiki/Citoid/Creating_Zotero_translators#For_development_through_IDE|For development through IDE]]
+More detailed instructions are available at [[https://www.mediawiki.org/wiki/Citoid/Creating_Zotero_translators|MediaWiki]].
- and [[https://www.mediawiki.org/wiki/Citoid/Creating_Zotero_translators#Run_on_Scaffold|Run on Scaffold]].