Changes between Version 3 and Version 4 of json-annotation-format

Timestamp:

Nov 22, 2012, 1:43:58 PM (11 years ago)

Author:

casties

Comment:

--

json-annotation-format

@@ -4 +4 @@
 The [[http://en.wikipedia.org/wiki/JSON|JSON]] format for annotations is based on the [[https://github.com/okfn/annotator/wiki/Storage|Annotator Store API]].
 
-== Image areas ==
+== Annotation ==
+
+An annotation is an object that links a text (the annotation body) to a specific part (the selection) of a resource (the annotation target).
+
+The JSON representation of an annotation has a few required elements while additional elements are added by optional plugins.
+
+id:: an identifier for the annotation, required for modifying and deleting annotations
+test:: the annotation body, required ([[http://daringfireball.net/projects/markdown/syntax|Markdown syntax]] can be used with the Markdown plugin.
+uri:: identifies the annotation target, i.e. the annotated page, required for retrieving annotations from the store.
+
+{{{
+{
+  "id": "aHR0cDovL2VudGl0aWVMTM1MzQ5ODc1OTE5Nw",
+  "text": "That would be [Charles Emmanuel](http://en.wikipedia.org/wiki/Charles_Emmanuel_I,_Duke_of_Savoy)",
+  "uri": "http://echo.mpiwg-berlin.mpg.de/documents/experimental/digilib-test/benedetti-1585?pn=5",
+  "ranges": [{
+    "start":"/div[1]/div[2]/p[4]/span[1]",
+    "startOffset":"16",
+    "end":"/div[1]/div[2]/p[4]/span[1]",
+    "endOffset":"33"}],
+  "resource": "http://echo.mpiwg-berlin.mpg.de/documents/experimental/digilib-test/benedetti-1585",
+  "user": {
+    "id":"casties",
+    "name":"Robert Casties",
+    "uri":"http://entities.mpiwg-berlin.mpg.de/persons/casties"},
+  "permissions": {
+    "update":["casties"],
+    "admin":["casties"],
+    "delete":["casties"],
+    "read":[]}
+}
+}}}
+
+
+== Image area ==
 
 Annotations of image areas have a "shapes" member, specifying a list of shapes on the image. The shape definitions are based on the [[http://www.w3.org/TR/SVG/shapes.html|SVG shape definitions]].