{% extends 'annotate_document/base.html' %} {% load static %} {% load annotate_extras %} {% block content %}

Annotating Documents

Tutorial Video

1. Overview

For each task we want to find all the names which refer to the same person. To do this we need to find occurrences of names (or nicknames/aliases) and link them to the person to whom they refer.
In the document the following terms are used:

The image below shows the basic structure of each document to be annotated.

Overview Image

2. Select a name(mention)

To link a name(mention) to an entity. Start by selecting the name from the textbox.
Please make sure you highlight the whole name and try not to include any spaces before/after.
Please include any titles that appear as part of the name for example chief Senzangakhona rather than just Senzangakhona.

Select name Image

3. Highlight the name

Clicking Highlight will highlight the name.
The name now shows up as a selected mention along with its position in the document.
You can close the pop-up and repeat this process to highlight all the names that refer to the same person(entity).

Select name Image

4. Ignoring a selected name

If you accidentally highlight a mention and don't want to link it then you can uncheck the checkbox next to the mention in the selected mentions section.
If you want to clear all the selected mentions you close the select person pop-up and click the clear button.

Select name Image

5. Select a person

Use the search bar to search for the person who being referred to by the selected name(s).
When searching it is best to try searching for the simplest form of the person's name. If that doesn't give the correct result try searching for just the first few letters of their name. A list of the people who possibly match your search will be shown as well as an option to create a new entity if there are no matches.
For each of the entities you can click on Description or Alias to display/hide more infromation about the entity or the previous name that have been associated with the entity.

Select an entity

5.1. Edit Candidate Entity

If you are using an existing entity but you think there is a mistake in either the entity name or description you can suggest changes. By clicking the Suggest Edit button. This opens up an Edit Entity form.
To edit the name or description check the relevant box and edit the text box.

Select an entity

6. Create a new entity

If the names selected match none of the entities please try searching for other possible names. If a match is still not found then you may need to create a new entity.
Selecting the Create New option will open a form for creating a new entity.
The name field is automatically filled in. However, you can edit if it isn't suitable.
If you edit the name please use the most complete name for the entity e.g "Shaka kaSenzangakhona" instead of "Shaka Zulu".
The date of birth and date of death fields are optional.
The description field is automatically filled in although you can edit it if you can provide a better description.

Select an entity

7. Link the mention(s) with the entity

Once you have selected an entity or filled in the form for a new entity you can click Link to link them.

Select an entity

8. Complete line

Once you have annotated all, if any, of the names in a row please check the checkbox at the end of the row.

Select an entity

9. Delete/View Link

To check if a name is correctly linked click on the highlighted text to view the name of the person it has been linked to.
If the name is linked to the wrong person you can delete the link by pressing delete then recreate the link.

Select an entity

10. Completing the annotation of the document

Repeat the above steps to link all the names in the document.
Once all the lines are checked you can move on to the next document.

Select an entity

Contact

If you have any further questions please send an email to: {% settings_value "EMAIL_ADMIN" %}

{% block page_nav %}{% endblock %} {% endblock %}