Skip to content

pauline-ng/annotator

Repository files navigation

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.

About

No description, website, or topics provided.

Resources

License

Unknown and 2 other licenses found

Licenses found

Unknown
LICENSE
GPL-3.0
LICENSE-GPL
MIT
LICENSE-MIT

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published