Translations of this page:

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.

A Sample Zotero 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 Interacting with Zotero from Within Firefox for more information.

You can obtain the Hello World code from github.

For more information on the basic elements and layout of a Firefox extension, see the XUL School Tutorial in the Mozilla Developer Center.

The most important code is in 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 chrome://helloworldzotero/content/include.js, which is included into the main overlay by chrome/content/helloworldzotero/overlay.xul. The latter also adds a menu item to the Zotero Actions menu.

Once installed, the plugin will display an alert whenever an item is added, modified or deleted in Zotero. (You'll probably want your own plugin to do something slightly less annoying.)


Note: This file is loaded by chrome://helloworldzotero/content/include.js, which makes sure the Zotero.HelloWorldZotero object is only created once.

Zotero.HelloWorldZotero = {
	DB: null,
	init: function () {
		// Connect to (and create, if necessary) helloworld.sqlite in the Zotero directory
		this.DB = new Zotero.DBConnection('helloworld');
		if (!this.DB.tableExists('changes')) {
			this.DB.query("CREATE TABLE changes (num INT)");
			this.DB.query("INSERT INTO changes VALUES (0)");
		// Register the callback in Zotero as an item observer
		var notifierID = Zotero.Notifier.registerObserver(this.notifierCallback, ['item']);
		// Unregister callback when the window closes (important to avoid a memory leak)
		window.addEventListener('unload', function(e) {
		}, false);
	insertHello: function() {
		var data = {
			title: "Zotero",
			company: "Center for History and New Media",
			creators: [
				['Dan', 'Stillman', 'programmer'],
				['Simon', 'Kornblith', 'programmer']
			version: '1.0.1',
			company: 'Center for History and New Media',
			place: 'Fairfax, VA',
			url: ''
		Zotero.Items.add('computerProgram', data); // returns a Zotero.Item instance
	// Callback implementing the notify() method to pass to the Notifier
	notifierCallback: {
		notify: function(event, type, ids, extraData) {
			if (event == 'add' || event == 'modify' || event == 'delete') {
				// Increment a counter every time an item is changed
				Zotero.HelloWorldZotero.DB.query("UPDATE changes SET num = num + 1");
				if (event != 'delete') {
					// Retrieve the added/modified items as Item objects
					var items = Zotero.Items.get(ids);
				else {
					var items = extraData;
				// Loop through array of items and grab titles
				var titles = [];
				for each(var item in items) {
					// For deleted items, get title from passed data
					if (event == 'delete') {
						titles.push(item.old.title ? item.old.title : '[No title]');
					else {
				if (!titles.length) {
				// Get the localized string for the notification message and
				// append the titles of the changed items
				var stringName = 'notification.item' + (titles.length==1 ? '' : 's');
				switch (event) {
					case 'add':
						stringName += "Added";
					case 'modify':
						stringName += "Modified";
					case 'delete':
						stringName += "Deleted";
				var str = document.getElementById('hello-world-zotero-strings').
					getFormattedString(stringName, [titles.length]) + ":\n\n" +
// Initialize the plugin
window.addEventListener('load', function(e) { Zotero.HelloWorldZotero.init(); }, false);

More plugin ideas:

  • Automatically update a blog with the titles of items added to a certain folder
  • Send a notice every time you tag something
  • Pull out all of the place names in a document and map them on Google Maps, implemented as the Maps plugin
  • Send text from a Zotero item to an online translation service
dev/sample_plugin.txt · Last modified: 2012/11/09 14:46 by willshanks