STWRView.md 9.68 KB
Newer Older
tanja tu's avatar
tanja tu committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
# ATHEN STWRView

If you want to annotate frames along with the respective speaker, the respective introductory expression and the respective speech representation 
and speech-, thought- and writing representation (short: STWR) along with some attributes, ATHEN offers the STWRView. This tutorial will show, how to use it.  
First of all, switch to STWRView:

<img src="pictures/STWRView_switch_stwrview.jpg" alt="switch view"/>

## Opening a document in STWRView

To open a document in STWRView, double-click the desired document on the left side of ATHEN (If you don't know how to import documents to ATHEN, please refer to the guide [ATHEN -Importing data](de.uniwue.mk.athen/releng/de.uniwue.mk.athen.docu/ATHEN_importData.md)):
  
<img src="pictures/STWRView_open_document_in_stwrView.jpg" alt="open document"/>

Then your document will be opened in the editor. 

## Annotation

### New Annotations

Now you can either annotate a frame (along with the respective speaker and the respective introductory expression) or a STWR.

## Annotate frame

If you want to annotate a frame, do the following:
1) Mark the respective string you want to annotate as a frame.
2) Click on the "Frame"-Button.
3) Your string will be marked grey and it will appear in the table on the bottom right with some additional information:

tanja tu's avatar
tanja tu committed
30
<img src="pictures/STWRView_1.jpg" alt="mark frame"/>
tanja tu's avatar
tanja tu committed
31 32 33 34 35 36 37

- "Start": the starting point of the frame according to the text
- "Frame": the marked string
- "Pos": the default value of "Pos" is set to "start", you can change the value by pushing the key "p" in the respective row in the table or by right-clicking on the respective row and left-click on the menu entry "Change pos (p)"
- "ID": the ID of the frame, this value is used to connect the corresponding speaker, the corresponding introductory expression and the corresponding STWR with the frame. At first the ID is empty, but you may connect the corresponding STWR with the frame by dragging the corresponding STWR from the table above to the respective frame in the table beneath. The frame-id will be updated and appear above your marked string:
Attention! The combined annotations can't get separated afterwards, unless you delete one of them! You may also connect a frame immediately to a STWR instead of creating multiple frames before connecting them to the STWR to avoid complications.

tanja tu's avatar
tanja tu committed
38
<img src="pictures/STWRView_2.jpg" alt="drag speech to frame"/>
tanja tu's avatar
tanja tu committed
39

tanja tu's avatar
tanja tu committed
40
<img src="pictures/STWRView_3.jpg" alt="frame id"/>
tanja tu's avatar
tanja tu committed
41
 
tanja tu's avatar
tanja tu committed
42 43
- "Speaker": the speaker you've assigned to the frame-annotation
- "Note": you may add a note to your annotation by pushing the "+"-key in the respective row in the table. A dialog will appear and you may enter your note. The note will also appear in the table.
tanja tu's avatar
tanja tu committed
44 45 46 47 48 49 50 51 52

If you create more new frames, the list in the table will be extended.
If you wrongly marked a string, single-click it in the text and push the "Del"-key or right-click on the respective row in the table and left-click on the menu entry "Delete selected annotation". The grey marking and the entry in the table will disappear then.

## Annotate speaker

If you want to annotate a speaker within a frame, do the following:
1) Mark the respective string you want to annotate as a speaker.
2) Click on the "Speaker"-Button.
tanja tu's avatar
tanja tu committed
53
3) Your string will be surrounded by a black box and the speaker id will appear above your string with the letter "S". The speaker id will automatically be set to the same value as the frame id:
tanja tu's avatar
tanja tu committed
54

tanja tu's avatar
tanja tu committed
55 56 57
<img src="pictures/STWRView_4.jpg" alt="speaker"/>

4) The speaker will also automatically be assigned to the direct STWR respectively the indirect STWR which has the same id as the frame. 
tanja tu's avatar
tanja tu committed
58 59 60 61

If the speaker id is not correct, you can change the id by single-click on the speaker annotation in the text and then double-click on the correct frame in the frame-table. The speaker id will be updated.
If you wrongly marked a string, single-click it in the text, go to the SelectionAnalyzer, open Speaker, left-click the string you want to delete and push the "del"-button:

tanja tu's avatar
tanja tu committed
62 63 64 65 66 67 68 69 70 71 72 73 74 75
<img src="pictures/STWRView_5.jpg" alt="delete speaker"/>


If you want to annotate a speaker within a reported STWR, do the following:
1) Mark the respective string you want to annotate as a speaker.
2) Click on the "Speaker"-Button.
3) Your string will be surrounded by a black box and the speaker id will appear above your string with the letter "S". The speaker id will automatically be set to the same value as the reported STWR id.

If the speaker id is not correct, you can change the id by single-click on the speaker annotation in the text and pressing the "Enter"-key. A new window will appear and you may enter the correct speaker id in the section "speaker id". After you changed the speaker id, confirm it by clicking on the "OK"-Button.


If you want to assign more than one speaker to a STWR-annotation or the speaker for the STWR-annotation is outside a frame, do the following:
1) Choose a speaker from the editor and left-click on the speaker.
2) Double-click on the STWR in the STWR-table you want to assign the speaker to. The speaker id will get the same value as the STWR id. If you assign more than one speaker to a STWR-annotation, than the speaker id values will be concatenated.
tanja tu's avatar
tanja tu committed
76 77 78

## Annotate introductory expression

tanja tu's avatar
tanja tu committed
79
If you want to annotate an introductory expression within a frame or a reported STWR-annotation, do the following:
tanja tu's avatar
tanja tu committed
80 81
1) Mark the respective string you want to annotate as an introductory expression.
2) Click on the "IntExpr"-Button.
tanja tu's avatar
tanja tu committed
82
3) Your string will be surrounded by a black box and the introductory expression id will appear above your string with the letter "I". The introductory expression id will automatically set to the same value as the frame id or the reported STWR id: 
tanja tu's avatar
tanja tu committed
83

tanja tu's avatar
tanja tu committed
84
<img src="pictures/STWRView_6.jpg" alt="introductory expression"/>
tanja tu's avatar
tanja tu committed
85 86 87 88 89 90 91 92 93 94 95

If the introductory expression id is not correct, you can change the id by single-click on the introductory expression annotation in the text and then double-click on the correct frame in the frame-table. The introductory expression id will be updated.
If you wrongly marked a string, single-click it in the text, go to the SelectionAnalyzer, open IntExpression, left-click the string you want to delete and push the "del"-button:

## Annotate speech, thought, writing representation

If you want to annotate a STWR, do the following:
1) Mark the respective string you want to annotate as a STWR.
2) Click on the "Direct"-, "Indirect", "FreeIndirect"- or "Reported"-Button. The button you’ve clicked on will be disabled.
3) Now click on the "Speech"-, "Thought"- or "Writing"-Button. The button you’ve clicked on in step 2) will be enabled and your string will be marked in a certain color (depending on the buttons you’ve clicked on). The string will appear in the table on the top right with some additional information:

tanja tu's avatar
tanja tu committed
96
<img src="pictures/STWRView_7.jpg" alt="speech-, thought- and writing representation"/>
tanja tu's avatar
tanja tu committed
97 98 99 100 101

- "Start": the starting point of the string according to the text
- "Stwr": the marked string
- "Medium": the medium you’ve chosen by clicking on one of the buttons
- "Type": the type you’ve chosen by clicking on one of the buttons
tanja tu's avatar
tanja tu committed
102 103 104 105 106 107 108 109 110
- "ID": the ID of the STWR, this value is used to connect the corresponding frame, the corresponding speaker, the corresponding introductory expression and, if existing, the corresponding STWR with the STWR. The IDs will be set automatically while creating an STWR-annotation. To combine STWRs, drag one of the STWR in the table and drop it to the other. Then the annotations will get the same ID:

<img src="pictures/STWRView_8.jpg" alt="drag speech"/>

<img src="pictures/STWRView_9.jpg" alt="speech id"/>

Attention! The combined STWRs can't get separated afterwards, unless you delete one of them! 

- "Speaker": the speaker you've assigned to the STWR-annotation
tanja tu's avatar
tanja tu committed
111 112 113 114 115
- "Level": the default value of "Level" is set to 1, you can change the value by clicking on the key "l" in the respective row in the table or by right-clicking on the respective row and left-click on the menu entry "Change level (l), (v)"
- "NonFact": the default value of "NonFact" is set to an empty string, you can change the value by clicking on the key "n" in the respective row in the table or by right-clicking on the respective row and left-click on the menu entry "Change nonFact (n)"
- "Prag": the default value of "Prag" is set to an empty string, you can change the value by clicking on the key "p" in the respective row in the table or by right-clicking on the respective row and left-click on the menu entry "Change prag (p)"
- "Border": the default value of "Border" is set to an empty string, you can change the value by clicking on the key "b" in the respective row in the table or by right-clicking on the respective row and left-click on the menu entry "Change border (b)"
- "Metaph": the default value of "Metaph" is set to an empty string, you can change the value by clicking on the key "m" in the respective row in the table or by right-clicking on the respective row and left-click on the menu entry "Change metaph (m)"
tanja tu's avatar
tanja tu committed
116
- "Note": you may add a note to your annotation by pushing the "+"-key in the respective row in the table. A dialog will appear and you may enter your note. The note will also appear in the table.
tanja tu's avatar
tanja tu committed
117 118 119 120 121 122 123 124

If you create more STWRs, the list in the table will be extended.
If you wrongly marked a string, single-click it in the text and push the "Del"-key or right-click on the respective row in the table and left-click on the menu entry "Delete selected annotation". The marking and the entry in the table will disappear then.

### Saving

To save your document you can either close ATHEN or change the view. If you are doing so, a popup-window appears that asks you to choose your name. If you click on your name and on the "OK"- Button your changes will be saved:

tanja tu's avatar
tanja tu committed
125
<img src="pictures/STWRView_10.jpg" alt="metadata"/>