[ Features | Manual | Examples | Configuration | Sitemap]

This page explains the basic functionalities of the TextAE annotation tool.

Launch parameters

http://bionlp.dbcls.jp/textae/textae.html?config=http://example.org/config.json&target=http://example.org/annotation.json

config

target

  • target = URL_of_the_target_documant/annotation (json)
  • Use PubAnnotation as the storage for your annotation project.

Controller

Load document

To open a document, click on the load icon to bring out the dialog box below. Input the location (URL) of the document and press the OK button or press the enter/return key on your keyboard. The document can also be opened via the address bar of browser. Refer to the launch parameters. EX. http://pubannotation.dbcls.jp/annsets/test-term/pmcdocs/3245220/divs/1/annotations.json

Save annotation

To save annotation, click on the save icon to bring out the dialog box below. Input the location where you want the document to be saved and press the OK button or press the enter/return key on your keyboard. The default location is the same as the target launch parameter and can be changed. EX. http://pubannotation.dbcls.jp/annsets/test-term/pmcdocs/3245220/divs/1/annotations.json

Undo and redo

TextAE offers virtually unlimited level of undo and redo operations, which are very useful during annotation. The possible times of undo (redo) operation is shown together with the undo (redo) icon.

Replicate and auto replicate

TextAE offers an assistance on annotation, i.e. auto-annotation. To annotate a document, annotate a span first and click the replicate icon. Then, in the document, all the spans which are the same as the previously annotated one will be automatically annotated, with the same color coding.
The auto replicate functionality works slightly differently. Click the auto replicate icon first and then perform annotation. During the process of the annotation, once one span is annotated, TextAE will automatically annotate all the left spans which are the same as the just annotated one.

But once the auto replicate functionality is chosen, is it impossible to return to the normal replicate functionality?

Three modes

View mode

  • Read only.
  • Making annotation is not allowed in the view mode.

Span edit mode

  • Click the span edit mode icon
  • Delete a span annotation
    • Select the target span annotation (mouse click), and
    • press 'delete' or 'd'

Relation edit mode

  • Click the relation edit mode icon
  • Create a relation annotation
    • Select a span (or instance) annotation, and
    • select another span (or instance) annotation.
    • A relation annotation is created between the two, then choose its annotation label unless the default one is not what you want.
  • Delete a relation annotation
    • Select the target relation annotation (mouse click), and
    • press 'delete' or 'd'
  • Functionalities for annotating two complicated relations
    • Refer to attachment:textae.pdf for the detailed definition of the two relations
    • Star sharped relation Example of star sharped relation annotation
      • Predicate-argument relation
      • Besides one predicate, there are more than one arguments.
      • First, use the span edit mode to annotate the predicate and the arguments.
      • And then, switch to the relation edit mode.
      • Next, with pressing a control/command key, select the predicate and the arguments in order.
    • Chained relation Example of chained relation annotation
      • Coreference relation
      • More than two concepts are involved.
      • First, use the span edit mode to annotate all the involved concepts.
      • And then, switch to the relation edit mode.
      • Next, select one concept (mouse click).
      • Last, with pressing a shift key, select the other concepts in order.

Label palette

An example of labels and their color codings used for annotation. Refer to the configuration page for more details.

Shortcut keys

v View mode
s Span edit mode
r Relation edit mode
z Undo
y Redo
d Delete
i Instance annotation
x Negation annotation
s Speculation annotation

btn_mode_view.png (1.33 KB) Jin-Dong Kim, 05/01/2013 03:11 PM

btn_mode_span.png (1.03 KB) Jin-Dong Kim, 05/01/2013 03:13 PM

btn_mode_relation.png (1009 Bytes) Jin-Dong Kim, 05/01/2013 03:13 PM

btn_redo.png (1.14 KB) Yue Wang, 05/22/2013 10:41 AM

btn_save.png (1.15 KB) Yue Wang, 05/22/2013 10:41 AM

btn_undo.png (1.15 KB) Yue Wang, 05/22/2013 10:41 AM

btn_load.png (1.35 KB) Yue Wang, 05/22/2013 10:42 AM

btn_replicate.png (972 Bytes) Yue Wang, 05/23/2013 10:56 AM

btn_replicate_auto.png (1.21 KB) Yue Wang, 05/23/2013 10:56 AM

load.png (23 KB) Yue Wang, 05/29/2013 12:11 PM

save.png (23.1 KB) Yue Wang, 05/29/2013 12:11 PM

palette.png (35.4 KB) Yue Wang, 05/29/2013 12:11 PM