Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
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…
contrib Remove unneeded annotator-plugintools package
css Remove uses of the word 'plugin'
doc Make the top level documentation heading above all
img Add permalink detection and display to Viewer.
locale Fixed the broken building of the i18n template. (Which did not make t…
src lint
test lint
tools Allow serving `npm link`ed modules using tools/serve
.ackrc Add .ackrc to ignore files in lib/ and pkg/
.gitignore Add packaging directories to .gitignore
.jscsrc Add jshint and jscs configuration
.jshintignore Add jshint and jscs configuration
.jshintrc Forbid use of coercive equality operator
.travis.yml Run lint on pull requests
AUTHORS Add Fernando Aramendi to AUTHORS
CHANGES.rst Annotator release v2.0.0-alpha.3
HACKING.rst Remove tools/setup and update HACKING.rst
LICENSE Add licenses
LICENSE-GPL Add licenses
LICENSE-MIT Add licenses
Makefile Fix extension module build
README.rst Switch to shields.io for IRC badge
browser.js Replace `util.getGlobal()` with `global`
demo.html Polish up demo.html, dev.html
dev.html Polish up demo.html, dev.html
index.js Rename annotator.Annotator to annotator.App
karma.conf.js Remove auth plugin
manifest.json first pass at chrome
package.json Annotator release v2.0.0-alpha.3

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.
  • rich metadata: the annotator.ext.document module sniffs the page on which annotations are being made for document metadata (such as that provided by Dublin Core tags or the Facebook Open Graph) that allows you to enrich the presentation of these annotations.

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.

Something went wrong with that request. Please try again.