Annotator
  • Getting started with Annotator
    • The Annotator libraries
      • Hosted Annotator Library
      • Deploy the Annotator Locally
      • Including Annotator on your webpage
    • Setting up Annotator
    • Options
    • Setting up the default plugins
    • Adding more plugins
    • Saving annotations
  • Annotation format
  • Authentication
    • What’s the authentication system for?
    • Technical overview
    • Technical specification
    • Colophon
  • Storage
    • Core storage API
      • root
      • index
      • create
      • read
      • update
      • delete
    • Search API
      • search
    • Storage Implementations
  • Internationalisation and localisation (I18N, L10N)
    • For users
    • For translators
    • For developers
  • Plugins
    • Auth plugin
      • Usage
      • Options
        • Token format
    • Filter plugin
      • Interface Overview
      • Usage
        • Options
        • Filters
    • Markdown Plugin
      • Requirements
      • Usage
        • Options
    • Permissions plugin
      • Interface Overview
        • Viewer
        • Editor
      • Usage
        • user (required)
        • permissions
        • userId(user)
        • userString(user)
        • userAuthorize(action, annotation, user)
    • Store plugin
      • Actions
      • Stores
      • Interface Overview
      • Usage
        • Options
    • Tags plugin
      • Interface Overview
        • Viewer
        • Editor
      • Usage
    • Unsupported plugin
      • Usage
        • Options
  • Plugin development
    • Getting Started
      • Using Your Plugin
      • Setup
      • pluginInit()
    • Extending Annotator.Plugin
    • Annotator.Plugin API
      • element
      • options
      • events
      • publish(name, parameters)
      • subscribe(name, callback)
      • unsubscribe(name, callback)
    • Annotator Events
      • Example
 
Annotator
  • Docs »
  • Welcome to Annotator’s documentation!
  • Edit on GitHub

Welcome to Annotator’s documentation!¶

Contents:

  • Getting started with Annotator
    • The Annotator libraries
    • Setting up Annotator
    • Options
    • Setting up the default plugins
    • Adding more plugins
    • Saving annotations
  • Annotation format
  • Authentication
    • What’s the authentication system for?
    • Technical overview
    • Technical specification
    • Colophon
  • Storage
    • Core storage API
    • Search API
    • Storage Implementations
  • Internationalisation and localisation (I18N, L10N)
    • For users
    • For translators
    • For developers
  • Plugins
    • Auth plugin
    • Filter plugin
    • Markdown Plugin
    • Permissions plugin
    • Store plugin
    • Tags plugin
    • Unsupported plugin
  • Plugin development
    • Getting Started
    • Extending Annotator.Plugin
    • Annotator.Plugin API
    • Annotator Events

Indices and tables¶

  • Index
  • Module Index
  • Search Page
Next

© Copyright 2014, The Annotator project contributors.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: v1.2.x
Versions
latest
stable
v1.2.x
architecture-proposal
apidocs
Downloads
pdf
htmlzip
epub
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.