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:translators:scaffold [2017/11/12 19:53] – external edit 127.0.0.1dev:translators:scaffold [2018/02/08 07:02] – Update to Zotero 5.0 zuphilip
Line 7: Line 7:
 ====== Scaffold - an IDE for Zotero translators ====== ====== Scaffold - an IDE for Zotero translators ======
  
-Translators are stored as individual JavaScript files in the "translators" subdirectory of the [[:zotero_data|Zotero data directory]]. While translators can be edited with any tool, Scaffold is a Firefox add-on dedicated to writing Zotero translators, offering advantages such as real-time testing and debugging.+Translators are stored as individual JavaScript files with additional metadata at the top and tests at the bottom in the "translators" subdirectory of the [[:zotero_data|Zotero data directory]]. While translators can be edited with any tool, Scaffold is dedicated to writing Zotero translators, offering advantages such as real-time testing and debugging.
  
 Scaffold supports editing and testing web translators and import translators. Search and export translators can not yet be tested using the IDE. 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 ===== ===== Installation =====
  
-  * [[https://github.com/zotero/scaffold/releases/latest|Install Scaffold]]+Scaffold does run within Zotero 5.0 as an [[:plugins|plugin]], which is installed by the following steps:
  
-Scaffold 3 includes support for the [[dev:translators:testing|automated translator testing]] system that was introduced in Zotero 2.1.9as well as for specifying [[dev:translators:connectors|connector compatibility]]. Documentation for these features is not yet available.+  * 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.0Scaffold was a Firefox Plugin.
  
-Scaffold does not run in Zotero Standalone. 
  
-**Note:** Scaffold will not work correctly when Zotero Standalone is open, as Zotero in Firefox will switch to "connector mode", disabling key features that Scaffold relies upon. Just make sure to keep Zotero Standalone closed while using Scaffold, and everything should work well. 
 ===== Interface ===== ===== Interface =====
  
dev/translators/scaffold.txt · Last modified: 2023/01/30 09:02 by boconnell