We’re in the process of updating the documentation for Zotero 5.0. Some documentation may be outdated in the meantime. Thanks for your understanding.
This page describes the situation for Zotero 1.0, and is heavily outdated.
Most of the files listed below are contained within the zotero.jar archive in the chrome directory. For more information on extracting and modifying such files, see Modifying Zotero Files.
- Registers chrome files
- Used by the Firefox add-on system
- Educational Community License
- SQL to initialize site translator and CSL style tables — bundled translators and styles may be overwritten during extension upgrades or updates from central repository, but the table definitions are stored within userdata.sql, so user-added rows are preserved.
- SQL to initialize system tables — data in these tables may be overwritten during upgrades. Modifying these tables to add new item types, etc., may seem like a good idea, but it quite likely is not.
- SQL to initialize user data tables — data in these tables is preserved during upgrades, and any schema changes require migration steps in schema.js.
Main overlay, windows and dialogs
- The About Zotero dialog
- Bibliography output options dialog
- Export options dialog
- File import/export handler
- Progress window for import/export
getService()on the Zotero XPCOM component and assigns the core JS object to the variable
Zotero. XUL files that aren't in the global scope need to include this file to gain access to the Zotero object:
- Display and editing logic for the metadata pane
- Included from overlay.xul — creates the metadata pane on the right
- Logic for standalone note window
- Standalone note window — note itself is created in the noteeditor.xml binding
- Logic for the main Zotero overlay, including actions for many of the primary UI elements
- The main Zotero overlay on the browser window — this creates the Zotero pane and specifies actions for most of its UI elements.
- Logic for the preferences window
- The preferences window
- Passes data to the search dialog
- The window containing the search dialog — the search interface itself is created in the zoterosearch.xml binding.
- Used by the See Also box
XBL bindings for reusable UI elements (contains both structure and logic)
- Note editor
- See Also tab
- Textbox in search dialog
- Tag entry pane
- Used by note editor to trigger auto-save
- Search dialog
UI elements for site scraping
- URL bar icon
- Scraping progress popup
- Selection dialog for saving multiple items from a site
Persistent objects stored within the core JS object — loaded in components/zotero-service.js
- Methods for attaching files, snapshots and links
- CSL engine
- Implements nsITreeView for the collections pane
- Core data layer objects (e.g.
- DB abstraction layer (e.g.
Zotero.DB.query()) — these methods should not be used outside of the data layer unless absolutely necessary.
- Helper functions for file operations
- Full-text indexer
- Proxy detection, OpenURL functionality, and EndNote file download handling
- Implements nsITreeView for the items pane
- MIME type detection and handling methods
- The Zotero Notifier — used by the UI to receive notification of changes to the data layer (and can also be used by other extensions).
- Database initialization and upgrade logic (including repository updates)
- Search engine logic (including saved searches)
- Data translation engine for import, export and scraping
- Assorted functions, some local to the translator sandbox
- Creates the core JS object and several other key function groups (e.g. Zotero.Date)
- Localizations for CSL
- Main entities file (for XUL labels)
- Main properties file (for JS strings)
Image and style files for the default skin
- Styles for About Zotero dialog
- Styles for elements in the main browser overlay
- Main style file — the distinction between this and overlay.css has become rather poorly defined, and the two files will likely be merged at some point (and/or separated into disparate files for the various UI sections).
- Image files for UI elements
CSS for XBL bindings
- Implements the Zotero autocomplete service, which can be enabled on an autocomplete textbox with
autocompletesearch=“zotero”. The search field is specified with
autocompletesearchparam=“fieldName”, optionally followed by other parameters after a slash.
- The base XPCOM component, which provides access to the core JS object from privileged code in Firefox — mostly boilerplate, but new files in chrome/content/zotero/xpcom must be included here using
- Sets defaults for Zotero preferences — changes to existing defaults only take effect on new installs (though new defaults can be added at any time).