Changes between Version 42 and Version 43 of DASISH/SpecificationDocument

Timestamp:

04/11/13 12:09:17 (11 years ago)

Author:

olhsha

Comment:

--

DASISH/SpecificationDocument

@@ -16 +16 @@
 }}}
 
-[[PageOutline(1-2, , inline)]]
+[[PageOutline(1-3, , inline)]]
 
 {{{
@@ -229 +229 @@
 = User Interface prototype =
 
-== Main window view: ==
+== Main window view ==
 
 [[Image(https://trac.clarin.eu/raw-attachment/wiki/DASISH/SpecificationDocument/UI.png)]]
 
-== Context menu: ==
+== Context menu ==
 
 [[Image(https://trac.clarin.eu/raw-attachment/wiki/DASISH/SpecificationDocument/MENU.png)]]
@@ -273 +273 @@
 ||{{{PUT api/annotations/<aid>/body}}}||Updates the body of the annotation <aid>. Used e.g. for correcting typos in the text part. The updated annotation’s body is given in the body of the request.||
 
+== Sources ==
+
+A source represents (a specific fragment of) a specific version of an annotatable object.  For instance, if an annotatable object is a web-page that has 3 versions and users have annotated versions 1 and 3, then there are 2 sources in the Data Base that correspond to the “web-page”.  Naturally, these sources represent versions 1 and 3.
+
+Note that access to the whole document with <aoid> is possible via its <sid>=<aoid>#, with empty fragment descriptor.
+
+Adding sources to the DataBase and removing them is a responsibility of the DataBase Management System.  In fact, adding a source is a “side effect” of creating an annotation on a certain URI.  Moreover, is the source with <sid>=<aoid>@<vid>#XXX is added to the DB, then the source <sid>=<aoid>@<vid># must be added as well, unless it is already in the DB.
+
+If all the annotations that refer to a certain source are deleted, then the DB managing part deletes this source from the DB. A read-only REST API for inspecting Sources (incl. fragments) is needed. 
+
+Cached representations are managed by the client, therefore creation and deletion API is necessary. It is possible to store the cashed representation not only of the fragment precisely corresponding to an annotation target source, but of a larger fragment and even of the entire annotatable object.
+
 
 === api/sources ===
 
-A source represents (a specific fragment of) a specific version of an annotatable object.  For instance, if an annotatable object is a web-page that has 3 versions and users have annotated versions 1 and 3, then there are 2 sources in the Data Base that correspond to the “web-page”.  Naturally, these sources represent versions 1 and 3.
-
-Note that access to the whole document with <aoid> is possible via its <sid>=<aoid>#, with empty fragment descriptor.
-
-Adding sources to the DataBase and removing them is a responsibility of the DataBase Management System.  In fact, adding a source is a “side effect” of creating an annotation on a certain URI.  Moreover, is the source with <sid>=<aoid>@<vid>#XXX is added to the DB, then the source <sid>=<aoid>@<vid># must be added as well, unless it is already in the DB.
-
-If all the annotations that refer to a certain source are deleted, then the DB managing part deletes this source from the DB. A read-only REST API for inspecting Sources (incl. fragments) is needed. 
-
-Cached representations are managed by the client, therefore creation and deletion API is necessary. It is possible to store the cashed representation not only of the fragment precisely corresponding to an annotation target source, but of a larger fragment and even of the entire annotatable object.
 
 ||= '''Resource''' =||= '''Description''' =||
@@ -294 +297 @@
 ||{{{POST api/sources/<sid>/cached}}}||It is a multipart POST, with the request body consisting of a description containing the metadata specified by the Cached Representation realization class, e.g., screenshot, and a single file (multiple files must be archived). The description has a form as follows: {{{<cachedrepresentation-description>}}}{{{<mime>multipart/related</mime>}}}{{{<tool>ToolID01</tool>}}}{{{<type>MHTML</type>}}}{{{</cachedrepresentation-description>}}} Adds a new cached representation of {{{<sid>}}}, by taking the cached representation from the request body.|| 
 ||{{{DELETE api/sources/<sid>/cached/<cid>}}}||Removes the cached representation {{{<cid>}}} given in the body of the request from the list of cached representations of the {{{<sid>}}}. It is removed from the database as well, unless there are no more references to this representation.|| 
+
+== Notebooks ==
 
 === api/notebooks ===