Changes between Version 5 and Version 6 of eXist-interface/annotations

Timestamp:

Jul 5, 2011, 3:16:48 PM (14 years ago)

Author:

jwillenborg

Comment:

--

eXist-interface/annotations

@@ -9 +9 @@
     * uid: user id (normally email address) of the operation (e.g. andy@mpiwg-berlin.mpg.de)
     * documentId: the eXist document identifier (e.g. /tei/en/Test_1789.xml)
-    * xpointer: the xpointer to the position in that document (e.g.: id('page2')/TEI[1]/text[1]/body[1]/p[1]/s[3]/point(4)); see [/wiki/schema/xpointer XPointer specification]
+    * xpointer: the xpointer to the position in that document (e.g.: id('page2')/TEI[1]/text[1]/body[1]/p[1]/s[3]/point(4)); see [/wiki/schema/xpointer XPointer specification]; it consists of 3 parts:
+      * page number: (e.g. id('page2'))
+      * XPath identifier of the XML page node (e.g.: /TEI[1]/text[1]/body[1]/p[1]/s[3])
+      * text point within that node (e.g: /point(4))
   * value: if operation is create or update: the new object (e.g. <note>This is an annotation of Andy</note>)
+
+To maintain a user annotation "at the HTML side" one needs the XPath identifier of the XML page node at which the annotation should be created/updated/deleted. This identifier is displayed by the parameter "options=withXmlNodeIds" in the interface function /mpdl/interface/page-fragment.xql. Then the output HTML document page contains an additional attribute "xmlNodeId" in all HTML nodes which are XML nodes (e.g. <span class="s" xmlNodeId="/TEI[1]/text[1]/body[1]/p[1]/s[1]">This is the first sentence of the first paragraph.</s>)
+
 
 == Limitations ==
@@ -22 +28 @@
 
 === Example document ===
-[http://mpdl-test.mpiwg-berlin.mpg.de:30030/mpdl/page-query-result.xql?document=/tei/en/Test_1789.xml&mode=text&pn=2 Test document with user annotations]
+* [http://mpdl-test.mpiwg-berlin.mpg.de:30030/mpdl/page-query-result.xql?document=/tei/en/Test_1789.xml&mode=text&pn=1&options=withXmlNodeIds Test document: Display of page 1 with XPath identifiers for all XML nodes]
+* [http://mpdl-test.mpiwg-berlin.mpg.de:30030/mpdl/page-query-result.xql?document=/tei/en/Test_1789.xml&mode=text&pn=2 Test document: Display of page 2 with external user annotations]
 
 === Read annotations ===