Annotation tools for the web. Select text, images, or (nearly) anything else, and add your notes.
JavaScript CSS HTML Makefile
Failed to load latest commit information.
.tx Add transifex-client configuration (see http://help.transifex.net/fea… Mar 16, 2012
contrib Remove unneeded annotator-plugintools package Apr 10, 2015
css Remove uses of the word 'plugin' Apr 24, 2015
doc whitespace Oct 1, 2015
img Add permalink detection and display to Viewer. Mar 20, 2012
locale Fixed the broken building of the i18n template. (Which did not make t… Jul 8, 2013
src Add hook to set user for identity.simple Nov 13, 2015
test Test beforeAnnotationCreated identity.simple hook Nov 13, 2015
tools Fix serve for connect 3.x Sep 25, 2015
.ackrc Add .ackrc to ignore files in lib/ and pkg/ May 29, 2013
.gitignore Add packaging directories to .gitignore Mar 30, 2014
.jscsrc lint Sep 25, 2015
.jshintignore Add jshint and jscs configuration Oct 6, 2014
.jshintrc lint Sep 25, 2015
.travis.yml Configure Travis notifications Oct 22, 2015
AUTHORS Add Fernando Aramendi to AUTHORS Mar 2, 2015
CHANGES.rst Annotator release v2.0.0-alpha.3 Jul 2, 2015
HACKING.rst Remove tools/setup and update HACKING.rst Apr 24, 2015
LICENSE Add licenses Feb 16, 2011
LICENSE-GPL Add licenses Feb 16, 2011
LICENSE-MIT Add licenses Feb 16, 2011
Makefile Drop the extensions altogether Sep 24, 2015
README.rst Drop the extensions altogether Sep 25, 2015
browser.js Replace `util.getGlobal()` with `global` Jul 1, 2015
demo.html Polish up demo.html, dev.html Apr 22, 2015
dev.html Polish up demo.html, dev.html Apr 22, 2015
index.js Rename annotator.Annotator to annotator.App Apr 14, 2015
karma.conf.js Don't use core-js core in tests Sep 25, 2015
manifest.json first pass at chrome Apr 6, 2012
package.json The through module is a dev dependency Oct 22, 2015

README.rst

Annotator

Build Status Version on NPM #hypothes.is IRC channel

Build Matrix

Annotator is a JavaScript library for building annotation applications in browsers. It provides a set of interoperable tools for annotating content in webpages. For a simple demonstration, visit the Annotator home page or download a tagged release of Annotator from the releases page and open demo.html.

Components within Annotator provide:

  • user interface: components to create, edit, and display annotations in a browser.
  • persistence: storage components help you save your annotations to a remote server.
  • authorization and identity: integrate Annotator with your application's login and permissions systems.

Usage

See Installing and Configuring and using Annotator from the documentation.

Writing a module

See Module development.

Development

See HACKING.rst.

Reporting a bug

Please report bugs using the GitHub issue tracker. Please be sure to use the search facility to see if anyone else has reported the same bug -- don't submit duplicates.

Please endeavour to follow good practice for reporting bugs when you submit an issue.

Lastly, if you need support or have a question about Annotator, please do not use the issue tracker. Instead, you are encouraged to email the mailing list.

Community

The Annotator project has a mailing list, annotator-dev, which you're encouraged to use for any questions and discussions. It is archived for easy browsing and search at gmane.comp.web.annotator. We can also be found in the #annotator channel on Freenode.