diff --git a/de.uniwue.mk.athen/releng/de.uniwue.mk.athen.docu/STWRView.md b/de.uniwue.mk.athen/releng/de.uniwue.mk.athen.docu/STWRView.md index 2415e239669a9363bb425543a5592f814e613cbb..e8faa616a2d6e67585e2c7cc6b6e8c67c218d34f 100644 --- a/de.uniwue.mk.athen/releng/de.uniwue.mk.athen.docu/STWRView.md +++ b/de.uniwue.mk.athen/releng/de.uniwue.mk.athen.docu/STWRView.md @@ -1,109 +1,109 @@ -# 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: - -<img src="pictures/STWRView_markFrame.jpg" alt="mark frame"/> - -- "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. - -<img src="pictures/STWRView_dragSpeechToFrame.jpg" alt="drag speech to frame"/> - -<img src="pictures/STWRView_frameID.jpg" alt="frame id"/> - -- "Note": you may add a note to your annotation by pushing the "Enter"-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. - -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. -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 set to the same value as the frame id: - -<img src="pictures/STWRView_speaker.jpg" alt="speaker"/> - -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: - -<img src="pictures/STWRView_deleteSpeaker.jpg" alt="delete speaker"/> - -## Annotate introductory expression - -If you want to annotate an introductory expression within a frame, do the following: -1) Mark the respective string you want to annotate as an introductory expression. -2) Click on the "IntExpr"-Button. -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: - -<img src="pictures/STWRView_intExpr.jpg" alt="introductory expression"/> - -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: - -<img src="pictures/STWRView_deleteIntExpr.jpg" alt="delete intExpr/> - -## 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: - -<img src="pictures/STWRView_stwrAnnotation.jpg" alt="speech-, thought- and writing representation"/> - -- "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 -- "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)" -- "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_dragSpeech.jpg" alt="drag speech"/> - -<img src="pictures/STWRView_speechId.jpg" alt="speech id"/> - -Attention! The combined STWRs can't get separated afterwards, unless you delete one of them! - -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: - -<img src="pictures/STWRView_metaData.jpg" alt="metadata/> +# 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: + +<img src="pictures/STWRView_markFrame.jpg" alt="mark frame"/> + +- "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. + +<img src="pictures/STWRView_dragSpeechToFrame.jpg" alt="drag speech to frame"/> + +<img src="pictures/STWRView_frameID.jpg" alt="frame id"/> + +- "Note": you may add a note to your annotation by pushing the "Enter"-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. + +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. +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 set to the same value as the frame id: + +<img src="pictures/STWRView_speaker.jpg" alt="speaker"/> + +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: + +<img src="pictures/STWRView_deleteSpeaker.jpg" alt="delete speaker"/> + +## Annotate introductory expression + +If you want to annotate an introductory expression within a frame, do the following: +1) Mark the respective string you want to annotate as an introductory expression. +2) Click on the "IntExpr"-Button. +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: + +<img src="pictures/STWRView_intExpr.jpg" alt="introductory expression"/> + +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: + +<img src="pictures/STWRView_deleteIntExpr.jpg" alt="delete intExpr/> + +## 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: + +<img src="pictures/STWRView_stwrAnnotation.jpg" alt="speech-, thought- and writing representation"/> + +- "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 +- "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)" +- "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_dragSpeech.jpg" alt="drag speech"/> + +<img src="pictures/STWRView_speechId.jpg" alt="speech id"/> + +Attention! The combined STWRs can't get separated afterwards, unless you delete one of them! + +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: + +<img src="pictures/STWRView_metaData.jpg" alt="metadata"/>