Commit f41fd1f2 authored by Markus Krug's avatar Markus Krug

Update CorefView.md

parent 91198b47
Pipeline #7696 passed with stages
in 18 minutes and 5 seconds
#ATHEN CorefView
If you want to annotate named entity (NE) and coreference information, ATHEN offers the CorefView. This tutorial will show, how to use it.
First of all, switch to CorefView:
<img src="pictures/switch_view.png" alt="switch view"/>
##Opening a document in CorefView
To open a document in CorefView, doubleclick 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/open_document.png" alt="open document"/>
Then your document will be opened in the editor. If you did not do any preprocessing, there won't be any annotations; you will only see a text.
##Annotation
###New Annotations
To create an annotation, mark the respective string and click "New Entity" on the right side of CorefView. Your string will be colored yellow then. The number, that appears right above your string, is the string's ID (which will be explained later).
The string you marked, will appear on the list on the right side of CorefView:
<img src="pictures/new_annotation_01.png" alt="first annotation"/>
If you create more new entities, the list will be extended.
If you wrongly marked a string, singleclick it in the text or at the list and then click "No Entity" on the right upper side of CoreView. The yellow marking and the entry on the list will disappear then.
###Coreference
If some strings refer to the same entity, you may distribute the same IDs. There are two ways to do so. Either you mark the respective string (or single click on it, if it is already marked as NE) and doubleclick the desired entry in the list on the right. Or you mark the repective string (or single click on it, if it is already marked as NE) and doubleclick the desired word in the editor itself. The last method is better especially when your list on the right has grown up to a length searching would be very time-consuming.
Whatever method you choose, your new entity will get the same ID as the NE it is referred to. Moreover, the frequency ot the respective NE will be increased by 1 on the list right:
<img src="pictures/new_annotation_02.png" alt="first coref"/>
Go on annotating like this until you finished your document.
###Attributs
You can give many different attributs to your annotations. To give attributes, take care, that the ID filter and jump-to-next aren't activated (ID-filter and jump-to-next-function will be explained later).
There are five different attributes: "Type", "Uncertain?", "Numerus", "Gender", "Pseudo":
<img src="pictures/attributes.png" alt="attributes"/>
Now you can give attributes to every single annotation. To do so, click on the repective annotation either in the list or in the text.
To change "Type" click Ctrl+T until the right type appears. There are four different types: AppTdfW, AppA, pron, Core. To mark a NE as "Core", you have to click Ctrl+K. Then a popup-window appears where you have to click on every word you want to mark as "Core". "Core"-NEs will be bordered red in the Editor afterwards.
To change "Uncertain?" click Ctrl+C.
To change "Numerus" click Ctrl+U.
To change "Gender" click Ctrl+G.
To change "Pseudo" click Crtl+P.
When you finished, your document might look like this:
<img src="pictures/finished_document.png" alt="finished document"/>
As seen in the picture, every annotation in the text gets small symbols to show different types. For example, NEs that are marked as "Pseudo" will get underlined; NEs that are marked as plural will get a plural symbol left above.
##More functions
####Is Entity
Usually you only use this function if you're working with a prepocessed text which suggests annotations. If the tool's suggestion is right (and the ID, too!), you can click "Is Entity" to accept the suggestion.
####ID-filter
To activate the ID-filter, set a mark on the respective box at the right. Afterwards every ID in your list will be reduced to one single entry which makes it more clearly.
<img src="pictures/ID_filter.png" alt="ID filter"/>
####Show only handled
To activate show-only-handled-function, set a mark on the repective box at the right. Now your list only shows annotations you did by yourself (and no prepocessing-tool).
<img src="pictures/show_only_handled.png" alt="show only handled"/>
####Draw just Core
To activate draw-just-core-function, set a mark on the resprective box at the right. Now only "Core"-annotations are shown in the editor.
<img src="pictures/draw_just_core.png" alt="draw just core"/>
####Jump to next?
To activate jump-to-next-function, set a mark on the respective box at the right. From now on, the marker jumps to the next annotation after you finished your previous annotation (this is usually helpful if you're working with preprocessed texts).
<img src="pictures/jump_to_next.png" alt="jump to next"/>
####Changing a name in the list
To change a name on the list, singleclick the respective entry on the list. Then press Enter. A popup-window appears where you can write in the name you want to give to this NE.
<img src="pictures/change_name.png" alt="change list name"/>
####Combining annotations
To combine two annotations, drag one of the two respective annotations on the list and drop it to the other. Then these two annotations will get the same ID and there frequencies will be added up.
<img src="pictures/combining_annotations.png" alt="combine two list entries"/>
Attention! The two combined entities can't get separated afterwards!
####Searching
If you want to search something on your list, write the respective string into the "Search:"-description field.
<img src="pictures/searching.png" alt="searching"/>
###Saving
To save your document you can either close ATHEN or change the view. If you are doing so, a popup-window appears that askes you wheater you want to save your changes or not.
<img src="pictures/saving.png" alt="saving"/>
# ATHEN CorefView
If you want to annotate named entity (NE) and coreference information, ATHEN offers the CorefView. This tutorial will show, how to use it.
First of all, switch to CorefView:
<img src="pictures/switch_view.png" alt="switch view"/>
## Opening a document in CorefView
To open a document in CorefView, doubleclick 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/open_document.png" alt="open document"/>
Then your document will be opened in the editor. If you did not do any preprocessing, there won't be any annotations; you will only see a text.
## Annotation
### New Annotations
To create an annotation, mark the respective string and click "New Entity" on the right side of CorefView. Your string will be colored yellow then. The number, that appears right above your string, is the string's ID (which will be explained later).
The string you marked, will appear on the list on the right side of CorefView:
<img src="pictures/new_annotation_01.png" alt="first annotation"/>
If you create more new entities, the list will be extended.
If you wrongly marked a string, singleclick it in the text or at the list and then click "No Entity" on the right upper side of CoreView. The yellow marking and the entry on the list will disappear then.
### Coreference
If some strings refer to the same entity, you may distribute the same IDs. There are two ways to do so. Either you mark the respective string (or single click on it, if it is already marked as NE) and doubleclick the desired entry in the list on the right. Or you mark the repective string (or single click on it, if it is already marked as NE) and doubleclick the desired word in the editor itself. The last method is better especially when your list on the right has grown up to a length searching would be very time-consuming.
Whatever method you choose, your new entity will get the same ID as the NE it is referred to. Moreover, the frequency ot the respective NE will be increased by 1 on the list right:
<img src="pictures/new_annotation_02.png" alt="first coref"/>
Go on annotating like this until you finished your document.
### Attributes
You can give many different attributs to your annotations. To give attributes, take care, that the ID filter and jump-to-next aren't activated (ID-filter and jump-to-next-function will be explained later).
There are five different attributes: "Type", "Uncertain?", "Numerus", "Gender", "Pseudo":
<img src="pictures/attributes.png" alt="attributes"/>
Now you can give attributes to every single annotation. To do so, click on the repective annotation either in the list or in the text.
To change "Type" click Ctrl+T until the right type appears. There are four different types: AppTdfW, AppA, pron, Core. To mark a NE as "Core", you have to click Ctrl+K. Then a popup-window appears where you have to click on every word you want to mark as "Core". "Core"-NEs will be bordered red in the Editor afterwards.
To change "Uncertain?" click Ctrl+C.
To change "Numerus" click Ctrl+U.
To change "Gender" click Ctrl+G.
To change "Pseudo" click Crtl+P.
When you finished, your document might look like this:
<img src="pictures/finished_document.png" alt="finished document"/>
As seen in the picture, every annotation in the text gets small symbols to show different types. For example, NEs that are marked as "Pseudo" will get underlined; NEs that are marked as plural will get a plural symbol left above.
## More functions
#### Is Entity
Usually you only use this function if you're working with a prepocessed text which suggests annotations. If the tool's suggestion is right (and the ID, too!), you can click "Is Entity" to accept the suggestion.
#### ID-filter
To activate the ID-filter, set a mark on the respective box at the right. Afterwards every ID in your list will be reduced to one single entry which makes it more clearly.
<img src="pictures/ID_filter.png" alt="ID filter"/>
#### Show only handled
To activate show-only-handled-function, set a mark on the repective box at the right. Now your list only shows annotations you did by yourself (and no prepocessing-tool).
<img src="pictures/show_only_handled.png" alt="show only handled"/>
#### Draw just Core
To activate draw-just-core-function, set a mark on the resprective box at the right. Now only "Core"-annotations are shown in the editor.
<img src="pictures/draw_just_core.png" alt="draw just core"/>
#### Jump to next?
To activate jump-to-next-function, set a mark on the respective box at the right. From now on, the marker jumps to the next annotation after you finished your previous annotation (this is usually helpful if you're working with preprocessed texts).
<img src="pictures/jump_to_next.png" alt="jump to next"/>
#### Changing a name in the list
To change a name on the list, singleclick the respective entry on the list. Then press Enter. A popup-window appears where you can write in the name you want to give to this NE.
<img src="pictures/change_name.png" alt="change list name"/>
#### Combining annotations
To combine two annotations, drag one of the two respective annotations on the list and drop it to the other. Then these two annotations will get the same ID and there frequencies will be added up.
<img src="pictures/combining_annotations.png" alt="combine two list entries"/>
Attention! The two combined entities can't get separated afterwards!
#### Searching
If you want to search something on your list, write the respective string into the "Search:"-description field.
<img src="pictures/searching.png" alt="searching"/>
### Saving
To save your document you can either close ATHEN or change the view. If you are doing so, a popup-window appears that askes you wheater you want to save your changes or not.
<img src="pictures/saving.png" alt="saving"/>
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment