forked from openannotation/annotator
-
Notifications
You must be signed in to change notification settings - Fork 0
Home
kartiksubbarao edited this page Aug 29, 2012
·
33 revisions
This is the Annotator wiki. While Annotator has extensive inline documentation, the wiki is your best starting point for simple use of the Annotator, and is the canonical resource for information not provided in the README or code.
- Getting Started - using the Annotator
- Annotation Format - overview of the serialization of annotations
- Authentication - documentation of authentication system
- Storage - storage of annotations and available back-ends
- I18N - internationalization and localization
- Store Plugin - support for saving and loading annotations from a remote web store
- Permissions Plugin - support for controlling who can view/edit annotations
- Auth Plugin - support for the Annotator Store authentication system
- Tags Plugin - tag annotations
- Unsupported Plugin - show a notification if the browser doesn't support Annotator
- Markdown Plugin - parse annotation text as Markdown
- Filter Plugin - show a filter bar to selectively display annotations
- Touch Plugin - support for touch devices (iOS, Android, etc.)
- Offline Plugin - support for working on documents while offline, using your browser's localStorage
- Annotator Wordpress plugin - installs and integrates the Annotator with your Wordpress site. (plugin source code)
- [Categories Plugin] (https://github.com/ezietsman/annotator ) - assign pre-defined categories to annotation and highlight each with different colors. (There is a pull request pending that is not yet fully integrated (waiting for tests)). This does not work with HEAD for now and requires a full check out of the fork (based on a slightly older fork). plugin source code
- [Roundup Plugin] (https://github.com/ezietsman/annotator ) - provide some integration with the Roundup ticket tracker . plugin source code
- Margin Viewer Plugin - to display annotations in the margins
- Heatmap Plugin - some heatmap related plugin
- Readmill Plugin - allows you to submit highlights and comments to Readmill
- annotator-store - the OKFN's reference implementation of the Annotator Store, used to run AnnotateIt
- roundup fork - provide some integration with the Roundup ticket tracker
- django-mongo-annotator - store based on Python, Django and MongoDB.
- annotator-fluidinfo - Fluidinfo store written in Perl, uses the Mojolicious and Net::Fluidinfo modules
- DEPRECATED annotator-store-flask - older and very simple store based on Python, Flask and Elixir/SQLite.
- Open Shakespeare for making community-created critical editions of Shakespeare's works - see, for example, Annotated Hamlet on Open Shakespeare
- Siyavula - for annotating textbooks
- Hypothes.is
- PaperGrader.org - for annotating and grading academic papers
If you'd like to contribute to the wiki you can do so using the GitHub interface or a better way is to check out the Wiki and modify it using a text editor. There's some basic instructions in the Gollum readme.