🌜
🌞
annotator

annotator

v2.0.0-alpha.3

Annotation for the web. Select text, images, or (nearly) anything else, and add your notes.

npm install annotator

README

Annotator

|Build Status| |Version on NPM| |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.

.. _Annotator home page: http://annotatorjs.org/ .. _the releases page: https://github.com/openannotation/annotator/releases

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 |documentmodule|_ 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.

.. _Dublin Core tags: http://dublincore.org/ .. _Facebook Open Graph: https://developers.facebook.com/docs/opengraph .. |documentmodule| replace:: annotator.ext.document module .. _documentmodule: http://docs.annotatorjs.org/en/latest/modules/document.html

Usage

See Installing_ and Configuring and using Annotator_ from the documentation_.

.. _Installing: http://docs.annotatorjs.org/en/latest/installing.html .. _Configuring and using Annotator: http://docs.annotatorjs.org/en/latest/usage.html .. _documentation: http://docs.annotatorjs.org/en/latest/

Writing a module

See Module development_.

.. _Module development: http://docs.annotatorjs.org/en/latest/module-development.html

Development

See HACKING.rst <./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_.

.. _GitHub issue tracker: https://github.com/openannotation/annotator/issues .. _good practice for reporting bugs: http://www.chiark.greenend.org.uk/~sgtatham/bugs.html

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 |IRC|_.

.. _mailing list: https://lists.okfn.org/mailman/listinfo/annotator-dev .. _gmane.comp.web.annotator: http://dir.gmane.org/gmane.comp.web.annotator .. |IRC| replace:: the #annotator channel on Freenode .. _IRC: https://webchat.freenode.net/?channels=#annotator

.. |Build Status| image:: https://secure.travis-ci.org/openannotation/annotator.svg?branch=master :target: http://travis-ci.org/openannotation/annotator .. |Version on NPM| image:: http://img.shields.io/npm/v/annotator.svg :target: https://www.npmjs.org/package/annotator .. |Build Matrix| image:: https://saucelabs.com/browser-matrix/hypothesisannotator.svg :target: https://saucelabs.com/u/hypothesisannotator .. |IRC Channel| image:: https://img.shields.io/badge/IRC-%23annotator-blue.svg :target: https://www.irccloud.com/invite?channel=%23annotator&hostname=irc.freenode.net&port=6697&ssl=1 :alt: #hypothes.is IRC channel

Release Notes

2.0.0-alpha.3
By Randall Leeds • Published on July 3, 2015

Features

  • The authz, identity, and notification modules are now exposed as public API on the annotator page global.
  • The notifier, identityPolicy and authorizationPolicy are now retrieved from component registry. It should now be possible to register alternative implementations.
  • Performance of the highlighter should be slightly improved.
  • Showing the viewer with a mouse hover should be much faster when there are many overlapping highlights. (#520)
  • The getGlobal() function of the util module has been removed and Annotator should now work with Content Security Policy rules that prevent eval of code.
  • The markdown extension has been upgraded to require and support version 1.0 or greater of the Showdown library.

Bug Fixes

  • Fix a bug in the ui.filter extension so that the filters option now works as specified.
  • Make the highlighter work even when the global document symbol is not window.document.
  • Fix an issue with the editor where adding custom fields could result in fields appearing more than once. (#533)
  • With the autoViewHighlights options of the viewer, don't show the viewer while the primary mouse button is pressed. Before, this prevention applied to every button except the primary button, which was not the intended behavior.

Documentation

  • Fix some broken links.
  • Fix some example syntax.
  • Add example markup in the documentation for the document extension.
2.0.0-alpha.2
By Nick Stenning • Published on April 25, 2015

This is an early alpha release of Annotator v2.0.0, which represents a major update from the v1.2.x release series. It's important to state clearly, with ringing bells and flashing lights, that this release has rough edges, missing features, and may in some rare circumstances cause harm to your pets and loved ones.

With that warning out of the way, here's a sampling of what you'll find in this release:

  • a code base rewritten in plain JavaScript
  • a dramatically improved extension architecture
  • support for composing applications from all, some, or none of the default user interface
  • support for asynchronous module hooks
  • support for custom storage modules
  • support for custom authorization and identity modules -- integrate Annotator with your own user database and permissions models

Some things didn't quite make it into this release, but we hope to get to them shortly:

  • the Auth plugin -- if you use the Annotator v1.2.x Auth plugin you may wish to hold off on upgrading for now
  • an Open Annotation-compatible storage component -- this will now probably appear in v2.1

The annotation format used by this release of Annotator is compatible with that used by v1.2.x, although you will need to update your code for the new version. For full upgrade guidelines please see the documentation.

General

Typescript Types
None found
Tree-shakeable
No

Popularity

GitHub Stargazers
2,553
Community Interest
3,191
Number of Forks
542

Maintenance

Commits
11/2110/2201
Last Commit
Nov 13, 2015
Open Issues
97
Closed Issues
455
Open Pull Requests
6
Closed Pull Requests
44

Versions

Versions Released
11/2110/2201
Latest Version Released
Jul 3, 2015
Current Tags
latest2.0.0-alpha.3
dev2.0.0-dev.2

Contributors

nickstenning
nickstenning
Commits: 743
aron
aron
Commits: 359
tilgovi
tilgovi
Commits: 293
csillag
csillag
Commits: 38
krusynth
krusynth
Commits: 36
edsu
edsu
Commits: 20
gergely-ujvari
gergely-ujvari
Commits: 17
wjt
wjt
Commits: 9
BigBlueHat
BigBlueHat
Commits: 9
nikolas
nikolas
Commits: 5
scharf
scharf
Commits: 3
tomjrees
tomjrees
Commits: 2
danielcebrian
danielcebrian
Commits: 2
jhou2
jhou2
Commits: 1
shaunagm
shaunagm
Commits: 1