Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
dev:scaffold [2011/03/01 11:22] – rmzelle | dev:scaffold [2018/05/07 13:09] (current) – bwiernik | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Scaffold - an IDE for Zotero translators ====== | + | See [[dev/translators/ |
- | + | ||
- | Translators in Zotero 2.x are stored as individual JavaScript files in the " | + | |
- | + | ||
- | ===== Installation ===== | + | |
- | + | ||
- | Separate versions of Scaffold exist for Zotero 2.0 and 2.1: | + | |
- | + | ||
- | [[http:// | + | |
- | (compatible with Zotero 2.1.x, released February 27, 2011) | + | |
- | + | ||
- | [[http:// | + | |
- | + | ||
- | ===== Interface ===== | + | |
- | + | ||
- | After installation, | + | |
- | + | ||
- | {{: | + | |
- | + | ||
- | ==== Top buttons ==== | + | |
- | + | ||
- | {{: | + | |
- | Opens the "Load Translator" | + | |
- | + | ||
- | {{: | + | |
- | Saves the translator you are currently working on. Provide a unique label and translator ID for your translator if you don't want to overwrite an existing translator. New translator IDs can be automatically generated via the " | + | |
- | + | ||
- | {{: | + | |
- | Saves and runs the '' | + | |
- | + | ||
- | {{: | + | |
- | Saves and runs the '' | + | |
- | + | ||
- | ==== Tabs ==== | + | |
- | + | ||
- | **Metadata** \\ Shows the translator metadata. Translator IDs can be generated via the " | + | |
- | + | ||
- | **Code** \\ The text box in this tab contains the translators JavaScript code: | + | |
- | + | ||
- | {{: | + | |
- | + | ||
- | ==== Debug Output ==== | + | |
- | + | ||
- | The main strength of Scaffold is its ability to provide you with immediate feedback, which can dramatically speed up translator development. After a code change, a single click suffices to run the modified translator and generate debug output. The following types of debug output can be generated: | + | |
- | + | ||
- | === Metadata === | + | |
- | When the "Test Regex" button in the " | + | |
- | + | ||
- | < | + | |
- | 09:54:11 ===> | + | |
- | </ | + | |
- | + | ||
- | === detectWeb and doWeb === | + | |
- | + | ||
- | When the "Run detectWeb" | + | |
- | + | ||
- | Debug output for the '' | + | |
- | + | ||
- | < | + | |
- | 19:19:43 detectWeb returned type " | + | |
- | </ | + | |
- | + | ||
- | Debug output for the '' | + | |
- | + | ||
- | < | + | |
- | 19:24:21 Returned item: | + | |
- | ' | + | |
- | ' | + | |
- | ' | + | |
- | ' | + | |
- | ' | + | |
- | ' | + | |
- | ' | + | |
- | ' | + | |
- | ' | + | |
- | ' | + | |
- | ' | + | |
- | ' | + | |
- | ' | + | |
- | ' | + | |
- | ' | + | |
- | ' | + | |
- | ' | + | |
- | ' | + | |
- | ' | + | |
- | ' | + | |
- | ' | + | |
- | ' | + | |
- | ' | + | |
- | + | ||
- | 19:24:21 Translation successful | + | |
- | </ | + | |
- | + | ||
- | If running '' | + | |
- | + | ||
- | '' | + |