Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
dev:sample_plugin [2011/08/29 19:18] – regenerate page cache dstillman | dev:sample_plugin [2012/11/09 14:46] – Updating Firefox extension basic info link to point towards a more up to date tutorial. willshanks |
---|
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. | 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. |
| |
[[/download/plugins/HelloWorldPlugin-1.0.3.xpi|Download]] | You can obtain the [[https://github.com/zotero/zotero-hello-world| Hello World code from github]]. |
| |
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.** | 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. |
| |
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: | |
| |
svn co https://www.zotero.org/svn/plugins/helloworld/trunk helloworld | |
| |
| |
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. | |
| |
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. |