Inline annotation for the web. Select text, images, or (nearly) anything else, and add your notes.
Annotator is a web annotation system. Loaded into a webpage, it provides the
user with tools to annotate text (and other elements) in the page. For a simple
demonstration, visit the demo page or download a tagged release of
Annotator and open demo.html.
The Annotator project also has a simple but powerful plugin architecture. While the core annotator code does the bare minimum, it is easily extended with plugins that perform such tasks as:
Store plugin saves all your annotations to a REST API
backend (see Storage wiki page for more and a link to a reference
implementation)Auth and Permissions plugins allow
you to decouple the storage of your annotations from the website on which the
annotation happens. In practice, this means that users could edit pages across
the web, with all their annotations being saved to one server.Markdown plugin renders all annotation text as
MarkdownTags plugin allows you to tag individual annotationsTo use Annotator, it's easiest to download a packaged release. The most
important files in these packages are annotator.min.js (or
annotator-full.min.js), which contains the core Annotator code, and
annotator.min.css, which contains all the CSS and embedded images for the
annotator.
Annotator requires jQuery. As of Annotator v1.2.7, jQuery v1.9 is assumed.
If you require an older version of jQuery, or are using an older version of
Annotator and require the new jQuery, you can use the jQuery Migrate Plugin.
The quickest way to get going with Annotator is to include the following in the
<head> of your document (paths relative to the root of the unzipped download):
<script src='http://ajax.googleapis.com/ajax/libs/jquery/1.9/jquery.min.js'></script>
<script src='annotator.min.js'></script>
<link rel='stylesheet' href='annotator.min.css'>
Or, with migrate:
<script src='http://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js'></script>
<script src= "http://code.jquery.com/jquery-migrate-1.2.1.js"></script>
<script src='annotator.min.js'></script>
<link rel='stylesheet' href='annotator.min.css'>
You can then initialize Annotator for the whole document by including the
following at the end of the <body> tag:
<script>
$(document.body).annotator()
</script>
See demo.html for an example how to load and interact with plugins.
As mentioned, Annotator has a simple but powerful plugin architecture. In order to write your own plugin, you need only add your plugin to the Annotator.Plugin object, ensuring that the first argument to the constructor is a DOM Element, and the second is an "options" object. Below is a simple Hello World plugin:
Annotator.Plugin.HelloWorld = (function() {
function HelloWorld(element, options) {
this.element = element;
this.options = options;
console.log("Hello World!");
}
HelloWorld.prototype.pluginInit = function() {
console.log("Initialized with annotator: ", this.annotator);
};
return HelloWorld;
})();
Other than the constructor, the only "special" method is pluginInit, which is
called after the Annotator has constructed the plugin, and set
pluginInstance.annotator to itself. In order to load this plugin into an
existing annotator, you would call addPlugin("HelloWorld"). For example:
$(document.body).annotator()
.annotator('addPlugin', 'HelloWorld')
Look at the existing plugins to get a feel for how they work. The Markdown plugin is a good place to start.
Useful events are triggered on the Annotator element (passed to the
constructor of the plugin):
| Callback name | Description |
|---|---|
annotationsLoaded(annotations) | called when annotations are loaded into the DOM. Provides an array of all annotations. |
beforeAnnotationCreated(annotation) | called immediately before an annotation is created. If you need to modify the annotation before it is saved to the server by the Store plugin, use this event. |
annotationCreated(annotation) | called when the annotation is created. Used by the Store plugin to save new annotations. |
beforeAnnotationUpdated(annotation) | as above, but just before an existing annotation is saved. |
annotationUpdated(annotation) | as above, but for an existing annotation which has just been edited. |
annotationDeleted(annotation) | called when the user deletes an annotation. |
annotationEditorShown(editor, annotation) | called when the annotation editor is presented to the user. Allows a plugin to add extra form fields. See the Tags plugin for an example of its use. |
annotationEditorHidden(editor) | called when the annotation editor is hidden, both when submitted and when editing is cancelled. |
annotationEditorSubmit(editor, annotation) | called when the annotation editor is submitted. |
annotationViewerShown(viewer, annotations) | called when the annotation viewer is displayed provides the annotations being displayed |
annotationViewerTextField(field, annotation) | called when the text field displaying the annotation in the viewer is created |
See HACKING.markdown
The Annotator project has a mailing list for developer discussion and
community members can sometimes be found in the #annotator channel on
Freenode IRC.
FAQs
Annotation for the web. Select text, images, or (nearly) anything else, and add your notes.
The npm package annotator receives a total of 89 weekly downloads. As such, annotator popularity was classified as not popular.
We found that annotator demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."