svn commit: r1344206 - /incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/enhancementstructure.mdtext

[rw...@apache.org]

Author: rwesten
Date: Wed May 30 11:47:15 2012
New Revision: 1344206

URL: http://svn.apache.org/viewvc?rev=1344206&view=rev
Log:
minor

Modified:
    incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/enhancementstructure.mdtext

Modified: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/enhancementstructure.mdtext
URL: http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/enhancementstructure.mdtext?rev=1344206&r1=1344205&r2=1344206&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/enhancementstructure.mdtext (original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/enhancementstructure.mdtext Wed May 30 11:47:15 2012
@@ -149,23 +149,26 @@ This describes a user interface similar 
 
 ![Occurrence based Annotation UI](hallo-annotate_scrrenshot.png "hallo.js with the annotate.js plugin used to implement an text occurrence based annotation UI")
 
-To implement user interfaces like that one needs to acquire the following information form the enhancements returned by the Stanbol Enhancer.
+To implement user interfaces like that one needs to (1) show occurrences of extracted features within the text and (2) let the user interact with suggested entities.
 
-__Showing the Occurrences within the Text__
+### Visualise Occurrences of extracted features
 
-This described how to obtain the necessary information needed to visualize extracted Entities within the text.
+The occurrence of extracted features are represented by instances of the concept 'fise:TextAnnotation'. However not all TextAnnotations are of interest for this use case as they are also used for other things (e.g. annotating the language of the parsed content).
+
+Typically the following steps are required to correctly show extracted features within the content.
 
 1. Query for/iterate over 'fise:TextAnnotation's of the enhancement results.
     * it is important to only use TextAnnotations that define a 'fise:selected-text' property. TextAnnotations that do not define this property usually select whole sections or even the document as a whole. Those are not of interest for this use case.
 2. Determine the exact occurrence of the TextAnnoations
     * in case of plain text content this can be easily done by using the values of 'fise:start' and 'fise:end'
     * in case the content includes additional markup the char indexes of 'fise:start'/'fise:end' will not match. In such cases the preferred way is to first search the occurrence of'fise:selection-context' and thann the occurrence of 'fise:selected-text' within.
-3. Retrieve suggested Entities for a given TextAnnotation. For that one needs to search for "?suggestion dc:relation {text-annotation}" where '{text-annotation}' refers to the URI of the current TextAnnotation.
-    * Note that there will be TextAnnotations with no suggestions.
+3. Retrieve the suggestions ('fise:TextAnnoation' instances) for a given TextAnnotation. For that one needs to search for "?suggestion dc:relation {text-annotation}" where '{text-annotation}' refers to the URI of the current TextAnnotation. Note that:
+    * Not every TextAnnotation will have suggestions
+    * One and the same suggestion might be linked with several TextAnnotations.
 
 The following SPARQL query could be used to select all the required information. However the use of SPARQL is optional as the required information can be also easily retrieved by other means (e.g. the filtered Iteratros as typically provided by RDF frameworks). 
 
-    :::sparql
+    :::sql
     select * 
     from {
         ?textAnnotation rdfs:type fise:TextAnnotation
@@ -180,7 +183,7 @@ The following SPARQL query could be used
 Additionally:
 
 * The value of the 'dc:type' is well suited to select different style sheets. See the section for [fise:TextAnnotation](#fisetextannotation) for detailed information.
-* The UI might need to differentiate between TextAnnotations with/without suggestions.
+* Note hat one 
 
 __Processing Suggested Entities__