Changes between Version 18 and Version 19 of FormAnnotate


Ignore:
Timestamp:
02/13/08 11:40:08 (13 years ago)
Author:
pichota
Comment:

started typical use case

Legend:

Unmodified
Added
Removed
Modified
  • FormAnnotate

    v18 v19  
    7373All !JavaScript / DOJO / AJAX related aspects are contained in the !JavaScript and JSP file. AJAX request are handled by the servlets and delegated to the Annotation Manager which in turn communicates with the Annotation Store. 
    7474 
    75 See the source code documentation for implementation details: 
     75=== Typical Use Case === 
    7676 
    77  * [source:trunk/kaukolu/src/de/opendfki/kaukoluwiki/servlet/AnnotationActionServlet.java de.opendfki.kaukoluwiki.annotation.AnnotationActionServlet] 
    78  * [source:trunk/kaukolu/src/de/opendfki/kaukoluwiki/servlet/AnnotationContentServlet.java de.opendfki.kaukoluwiki.annotation.AnnotatioContentServlet] 
     77The user selects a text passage with the mouse, performs a right-click and selects "Create Annotation". The annotation panel appears showing a class hierarchy on the left-hand side 
     78(served by [source:trunk/kaukolu/src/de/opendfki/kaukoluwiki/servlet/AnnotationContentServlet.java AnnotationContentServlet].getChildren()). 
     79He expands various tree nodes before the desired class is found and clicks on it. The corresponding properties are presented on the right-handside 
     80(served by [source:trunk/kaukolu/src/de/opendfki/kaukoluwiki/servlet/AnnotationContentServlet.java AnnotationContentServlet].getAnnotationFormHtml()). 
     81He enters some information and clicks in "Create". This triggers 
     82[source:trunk/kaukolu/src/de/opendfki/kaukoluwiki/servlet/AnnotationActionServlet.java AnnotationActionServlet].createAnnotation(), 
     83followed by 
     84[source:trunk/kaukolu/src/de/opendfki/kaukoluwiki/annotation/AnnotationManager.java AnnotationManager].createAnnotation()) and 
     85[source:trunk/kaukolu/src/de/opendfki/kaukoluwiki/storage/AnnotationStore.java  AnnotationStore].storeAnnotation(). 
     86 
     87The page reloads. The user hovers the annotated text, does a right-click, expands "Edit Annotation" and selects the underlying annotations. The annotation panel opens showing the descent tree on the right-hand side 
     88(served by [source:trunk/kaukolu/src/de/opendfki/kaukoluwiki/servlet/AnnotationContentServlet.java AnnotationContentServlet].getDescentTree()) 
     89and the currently stored properties in the right hand side, generated by the usual method. The click on "Update" goes a similar way to 
     90[source:trunk/kaukolu/src/de/opendfki/kaukoluwiki/storage/AnnotationStore.java].updateAnnotation(). 
     91 
     92A click on "Delete Annotation" i nthe context menu results in a call to 
     93[source:trunk/kaukolu/src/de/opendfki/kaukoluwiki/storage/AnnotationStore.java].removeAnnotation() 
     94in the end. 
     95 
     96 
     97=== References to the source code === 
     98 
     99 * [source:trunk/kaukolu/src/de/opendfki/kaukoluwiki/servlet/AnnotationActionServlet.java de.opendfki.kaukoluwiki.servlet.AnnotationActionServlet] 
     100 * [source:trunk/kaukolu/src/de/opendfki/kaukoluwiki/servlet/AnnotationContentServlet.java de.opendfki.kaukoluwiki.servlet.AnnotatioContentServlet] 
    79101 * [source:trunk/kaukolu/src/de/opendfki/kaukoluwiki/annotation/AnnotationManager.java de.opendfki.kaukoluwiki.annotation.AnnotationManager] 
    80102 * [source:trunk/kaukolu/src/de/opendfki/kaukoluwiki/storage/AnnotationStore.java de.opendfki.kaukoluwiki.storage.AnnotationStore]