| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| dev:sample_plugin [2008/11/06 03:12] – external edit 127.0.0.1 | dev:sample_plugin [2019/10/01 09:30] (current) – [A Sample Zotero Plugin] bwiernik |
|---|
| ====== A Sample Zotero Plugin ====== | <html><p id="zotero-5-update-warning" style="color: red; font-weight: bold">We’re |
| | in the process of updating the documentation for |
| | <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> |
| |
| |
| To help you get started creating Zotero plugins, we’ve created a simple Hello World plugin that demonstrates how to access Zotero from an external extension. See [[Interacting with Zotero from Within Firefox]] for more information. | ====== A Sample Zotero Plugin ====== |
| | |
| [[/download/HelloWorldPlugin-1.0.3.xpi|{{download_medium.gif}}]] | |
| | |
| Current version: 1.0.3, released December 13, 2007 | |
| | |
| ** Be sure you've upgraded to at least Zotero 1.0.0b4.r5, released on April 29, 2007, before installing the plugin.** | |
| |
| You can also browse the [[https://www.zotero.org/trac/browser/plugins/helloworld/trunk| Hello World code]] via Trac or checkout the plugin from the source code repository without installing the plugin: | To help you get started creating Zotero plugins, we’ve created a simple Hello World plugin that demonstrates how to access Zotero from an external extension. See [[dev:client_coding:javascript_api|Interacting with Zotero from Within Firefox]] for more information. |
| |
| svn co https://www.zotero.org/svn/plugins/helloworld/trunk helloworld | You can obtain the [[https://github.com/zotero/zotero-hello-world| Hello World code from github]]. |
| |
| |
| For more information on the basic elements and layout of a Firefox extension, see [[http://developer.mozilla.org/en/docs/Building_an_Extension|Building an Extension]] in the Mozilla Developer Center. | For more information on the basic elements and layout of a Firefox extension, see the [[https://developer.mozilla.org/en-US/docs/XUL_School|XUL School Tutorial]] in the Mozilla Developer Center. |
| |
| The most important code is in [[https://www.zotero.org/trac/browser/plugins/helloworld/trunk/chrome/content/helloworldzotero/hello.js|chrome://helloworldzotero/content/hello.js]], which defines a method to insert a new item into the Zotero database and registers a callback function with the Zotero Notifier to receive a notification when an item is modified. The script is loaded by [[https://www.zotero.org/trac/browser/plugins/helloworld/trunk/chrome/content/helloworldzotero/include.js|chrome://helloworldzotero/content/include.js]], which is included into the main overlay by [[https://www.zotero.org/trac/browser/plugins/helloworld/trunk/chrome/content/helloworldzotero/overlay.xul|chrome/content/helloworldzotero/overlay.xul]]. The latter also adds a menu item to the Zotero Actions menu. | The most important code is in [[https://www.zotero.org/trac/browser/plugins/helloworld/trunk/chrome/content/helloworldzotero/hello.js|chrome://helloworldzotero/content/hello.js]], which defines a method to insert a new item into the Zotero database and registers a callback function with the Zotero Notifier to receive a notification when an item is modified. The script is loaded by [[https://www.zotero.org/trac/browser/plugins/helloworld/trunk/chrome/content/helloworldzotero/include.js|chrome://helloworldzotero/content/include.js]], which is included into the main overlay by [[https://www.zotero.org/trac/browser/plugins/helloworld/trunk/chrome/content/helloworldzotero/overlay.xul|chrome/content/helloworldzotero/overlay.xul]]. The latter also adds a menu item to the Zotero Actions menu. |
| |
| </code> | </code> |
| |
| |
| More plugin ideas: | |
| |
| * Automatically update a blog with the titles of items added to a certain folder | |
| * Send del.icio.us a notice every time you tag something (such a plugin is already under development) | |
| * Pull out all of the place names in a document and map them on Google Maps | |
| * Send text from a Zotero item to an online translation service | |
Upgrade Storage