Skip to content
This repository has been archived by the owner on Apr 2, 2023. It is now read-only.

Developers

Rainer Simon edited this page Dec 12, 2013 · 31 revisions

Developers

Annotorious makes heavy use of the Google Closure Library underneath the hood. This might take a little bit of getting used to if you haven't worked with this library before. But other than that, Annotorious is just plain old JavaScript.

To get started quickly, I recommend using the plovr build tool. plovr includes all necessary Closure library dependencies, and is packaged into the Annotorious source code project in the plovr folder. So there's no need for a separate download or installation. The only pre-requisite is that you need to have Java installed on your system.

Note: the version of plovr I included in this repository is the October 2012 release (plovr-eba786b34df9.jar).

Hacking on Annotorious

In the project directory, run

java -jar plovr/plovr.jar serve standalone.json

This will serve the compiled Annotorious JavaScript code (standalone version) on an embedded server. Simply open test/image/index.html for an example page that uses it. Any change you make to the code will be effective immediately, as soon as you refresh the test page in your browser. If you want to hack on the OKFN Annotator plugin version of Annotorious, run

java -jar plovr/plovr.jar serve okfn_plugin.json 

and open the OKFN Plugin test page test/okfn/image_okfn.html in your browser.

Building Minified JavaScript

To build the minified JavaScript for Annotorious (standalone version), run

java -jar plovr/plovr.jar build standalone.json > annotorious.min.js

To build the minified JavaScript for the Annotorious OKFN Annotator plugin, run

java -jar plovr/plovr.jar build okfn_plugin.json > annotorious.okfn.js

Developing Annotorious Plugins

Information on how you can develop plugins to Annotorious are here:

Understanding the Code

Information to help you find your way around the source code is available on these Wiki pages: