saona-raimundo / hellozotero

Basic Zotero plug-in development example.

Basic Zotero plug-in development example.

Goal

Help those developing Zotero plug-ins for the first time.

Design

This is a "hello-world" example: a simple template with no real functionality.

See ZoteroPlugins, for a detailed guide of Zotero plugins.

Directory

This is the directory structure.

• install.rdf

• hello_zotero-update.rdf

• chrome.manifest

• defaults

  • preferences

    • defaults.js

• chrome

  • skin

    • default
      • hello_zotero

  • locale

    • en-US

      • hello_zotero.dtd

  • content

    • hello_zotero

      • include.js

Deployment

Zotero uses the .xpi format for plugins. This is just another name for compressed files. You may

1. Compress this repository, making sure that install.rdf and the chrome directory need to be at the root of the compressed folder.

2. Change the extension by renaming the file so that it ends in .xpi.

3. Install in Zotero.

Note: Downloading a compressed file directly from GitHub will consist of a folder inside the compressed file download containing the repo. To compress this repo you will have to unzip it, enter the inner folder and zip it again.

Acknowledgements

I thank everyone involved in the projects ZotFile and Zotero-plugins. Their plugins were very useful guidance.

License

Distributed under the terms of both the MIT license and the Apache License (Version 2.0).

See LICENSE-APACHE and LICENSE-MIT for details.