Changes between Version 4 and Version 5 of DASISH/SpecificationDocument


Ignore:
Timestamp:
04/04/13 15:15:43 (11 years ago)
Author:
Przemek
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • DASISH/SpecificationDocument

    v4 v5  
    1 Technical Summary.
     1== DASISH WEB-ANNOTATOR ==
     2=== TLA
     3
     4This document specifies a browser extension for annotating web-documents.  We present the class structure of the implementation, describe the functionality from the user perspective and define the REST API.
     5
     6Document version: 1.0
     7
     8Date: 4 April 2013
     9
     10Authors: Olha Shkaravska, Przemek Lenkiewicz, Menzo Windhouwer, Twan Goosen, Daan Broeder
     11
     12
     13== Technical Summary. ==
    214
    315The aim of this document is to give specifications for a web-annotating tool, which is to be developed within the DASISH project. The tool is a browser extension that allows to annotate fragments of web documents by tags, colors and text notes. The annotatable fragments may be texts and, on the later stages of development, graphical objects as well.
     
    1022
    1123An example of <sid> is given by the URI
    12  http://tla.mpi.nl/#xpointer(//div[id='post-1157']/p/substring(.,33,3))
    13 Here  the part   http://tla.mpi.nl/ is an <aoid> and  the part  xpointer(//div[id='post-1157']/p/substring(.,33,3)) is a <fid>.  Since <vid> is not given, the <sid> refers to the latest version of the resource located at http://tla.mpi.nl/ .
     24
     25{{{ http://tla.mpi.nl/#xpointer(//div[id='post-1157']/p/substring(.,33,3)) }}}
     26
     27Here  the part   {{{ http://tla.mpi.nl/ }}} is an  {{{ <aoid> }}} and  the part {{{ xpointer(//div[id='post-1157']/p/substring(.,33,3)) }}} is a  {{{ <fid> }}} .  Since {{{ <vid> }}} is not given, the {{{ <sid> }}} refers to the latest version of the resource located at {{{ http://tla.mpi.nl/ }}}.
    1428
    1529<uid> is not mentioned explicitly below, as a parameter in the description of the REST service, because it is known from the session via “Shibboleth” identification procedure. 
     
    1731An owner is either the principal who has created the annotation or a principal to whom the ownership has been assigned.
    1832
    19 Class Schema
     33== Class Schema ==
     34
    2035The schema is based on the following interfaces and classes: 
    2136* class Source represents (a specific fragment of) a specific version of an  annotatable object; it contains information about this version, such as  a time stamp, the lists of references to cashed representations;
     
    2439* interface Body (of annotation) (can be text, “like”, color, relation, etc.); contains the reference to the annotation.
    2540
    26 UML DIAGRAM
     41[[Image(https://trac.clarin.eu/raw-attachment/wiki/DASISH/SpecificationDocument/Screen%20shot%202013-03-26%20at%203.18.43%20PM.png)]]
    2742
    2843We propose the following XML-serializations.