@@ -5,80 +5,50 @@ Annotator
5
5
6
6
|Build Matrix |
7
7
8
- ::
9
-
10
- ┌──────────────────────────────────────────────────────┐
11
- │ WARNING! Unstable code in this branch! │
12
- ├──────────────────────────────────────────────────────┤
13
- │ Please be aware that the current stable release of │
14
- │ Annotator is v1.2.9 and can be found on the releases │
15
- │ page (see below) or the v1.2.x branch. │
16
- │ │
17
- │ The code in the master branch is what will become │
18
- │ v2.0 in due course, but is likely to have a highly │
19
- │ unstable API. You are advised NOT to build on the │
20
- │ contents of the master branch at this stage unless │
21
- │ you are happy dealing with APIs breaking frequently! │
22
- └──────────────────────────────────────────────────────┘
23
-
24
- Annotator is a JavaScript library for building annotation systems on the web. It
25
- provides a set of tools to annotate text (and other content) in webpages, and to
26
- save those annotations to a remote storage system. For a simple demonstration,
27
- visit the `Annotator home page `_ or download a tagged release of Annotator from
28
- `the releases page `_ and open ``demo.html ``.
8
+ Annotator is a JavaScript library for building annotation applications in
9
+ browsers. It provides a set of interoperable tools for annotating content in
10
+ webpages. For a simple demonstration, visit the `Annotator home page `_ or
11
+ download a tagged release of Annotator from `the releases page `_ and open
12
+ ``demo.html ``.
29
13
30
14
.. _Annotator home page : http://annotatorjs.org/
31
15
.. _the releases page : https://github.com/openannotation/annotator/releases
32
16
33
- Annotator aims to provide a sensible default configuration which allows for
34
- annotations of text in the browser, but it can also be extended in order to
35
- provide:
17
+ Components within Annotator provide:
36
18
19
+ - user interface: components to create, edit, and display annotations in a
20
+ browser.
37
21
- persistence: storage components help you save your annotations to a remote
38
- server. One notable example is the |HttpStorageComponent |_ which ships with
39
- Annotator and talks to the |AnnotatorStore |_.
40
- - rich metadata: the |DocumentPlugin |_ sniffs the page on which annotations are
41
- being made for document metadata (such as that provided by `Dublin Core
22
+ server.
23
+ - authorization and identity: integrate Annotator with your application's login
24
+ and permissions systems.
25
+ - rich metadata: the |documentmodule |_ sniffs the page on which annotations
26
+ are being made for document metadata (such as that provided by `Dublin Core
42
27
tags `_ or the `Facebook Open Graph `_) that allows you to enrich the
43
28
presentation of these annotations.
44
- - authentication and authorization: the |AuthComponent |_ allows you to restrict
45
- the creation of annotations to logged in users, while the
46
- |PermissionsComponent |_ allow you fine-grained control over who has
47
- permission to create and update annotations.
48
-
49
- .. |HttpStorageComponent | replace :: ``HttpStorage `` component
50
- .. _HttpStorageComponent : http://docs.annotatorjs.org/en/latest/storage/http.html
51
- .. |AnnotatorStore | replace :: ``annotator-store `` API
52
- .. _AnnotatorStore : https://github.com/openannotation/annotator-store/
29
+
53
30
.. _Dublin Core tags : http://dublincore.org/
54
31
.. _Facebook Open Graph : https://developers.facebook.com/docs/opengraph
55
- .. |AuthComponent | replace :: ``Auth `` component
56
- .. _AuthComponent : http://docs.annotatorjs.org/en/latest/storage/auth.html
57
- .. |PermissionsComponent | replace :: ``Permissions `` component
58
- .. _PermissionsComponent : http://docs.annotatorjs.org/en/latest/permissions.html
59
-
60
- For a list of plugins that ship with Annotator, see the `plugin pages `_ of
61
- the Annotator documentation. For a list of 3rd party plugins, or to add your
62
- plugin, see the `list of 3rd party plugins `_ on the wiki.
63
-
64
- .. _plugin pages : http://docs.annotatorjs.org/en/latest/plugins/index.html
65
- .. _list of 3rd party plugins : https://github.com/openannotation/annotator/wiki#plugins-3rd-party
32
+ .. |documentmodule | replace :: ``annotator.ext.document `` module
33
+ .. _documentmodule : http://docs.annotatorjs.org/en/latest/modules/document.html
66
34
67
35
68
36
Usage
69
37
-----
70
38
71
- See ` Getting started with Annotator `_.
39
+ See Installing _ and ` Configuring and using Annotator `_ from the documentation _ .
72
40
73
- .. _Getting started with Annotator : http://docs.annotatorjs.org/en/latest/getting-started.html
41
+ .. _Installing : http://docs.annotatorjs.org/en/latest/installing.html
42
+ .. _Configuring and using Annotator : http://docs.annotatorjs.org/en/latest/usage.html
43
+ .. _documentation : http://docs.annotatorjs.org/en/latest/
74
44
75
45
76
- Writing a plugin
46
+ Writing a module
77
47
----------------
78
48
79
- See `Plugin development `_.
49
+ See `Module development `_.
80
50
81
- .. _ Plugin development : http://docs.annotatorjs.org/en/latest/hacking/plugin -development.html
51
+ .. _ Module development : http://docs.annotatorjs.org/en/latest/module -development.html
82
52
83
53
84
54
Development
0 commit comments