Annotate documents

    The general annotation process is as follows:

    • First, you draw a shape on the image;
    • Then, from that shape you create an element;
      • You have to select the type of the element to create it;
      • You can name your element, and assign it a class.
    • Once an element is created, you can edit it or add a transcription to it.

    Annotation interface🔗

    The annotation interface can be opened on any page by clicking the icon in the top-right corner.

    Image annotation mode Image annotation mode
    Image annotation mode

    From top to bottom:

    • You can draw rectangular shapes,
    • Or polygons;
    • The third button allows you to select already existing shapes on the image;
    • The [x] closes the interface;
    • Under the annotation buttons, whether the interface is open or closed, is a zoom.

    Element tree🔗

    On the left of the image is the element tree. This tree allows you to hide, display, and select children elements on your page. The eye icon next to each element is grey when they are hidden, green when they are displayed on the image.

    Element tree actions
    Element tree actions

    When you hover over an element, two icons appear:

    • The first one allows you to edit the element;
    • The second one is for adding a transcription to that element.

    When you select an element, either directly on the image or from the element tree, detailed information (such as classes, transcriptions, or creation information) about this element is displayed on the right side of the image.

    Element creation🔗

    Once you have drawn a shape on the image, a pop-up window opens for element creation.

    Element creation modal
    Element creation modal

    When creating an element, you have to select its type, and you can give it a name and assign it a class. Once an element is created, it shows up on the image and in the element tree.

    Transcription🔗

    You can add transcriptions to existing elements by clicking the [A+] button next to an element in the element tree. This opens up a pop-up window into which you can type your text.

    Element transcriptions modal
    Element transcriptions modal

    Manual class annotation🔗

    You can also annotate the pages/images with a class. For example, you may want to annotate the handwritten pages in a project and this will be the example on which we will illustrate the class annotation process.

    In order to annotate a project with classes, the classes need to be defined beforehand by an administrator. You can start by increasing the number of elements that are displayed on a page, to do so go to the main page of the folder or the project and click on the Display button that is on the top right part of the page. You can then change the pagination size to 500 as shown in the picture below:

    How to change the pagination size
    How to change the pagination size

    You can start adding elements that belong to a given class to the selection. In our example, we are going to add all handwritten images to the selection. We do so by clicking on the check mark button at the bottom right of every handwritten page's widget as shown in the picture below:

    Selected page widget
    Selected page widget

    After you have selected all the elements that belong to a given class on a page, click on the document icon on the top-right corner of the screen to open the selection.

    Opening the selection page
    Opening the selection page

    By clicking this button, you will be redirected to the page that contains all the elements that you selected. To add a classification for all the selected elements, click on the Actions button that is on the top right of the page, then select the Add a classification button in the drop down list that gets displayed.

    how to add a classification
    how to add a classification

    This will open a modal window where you can select the right class for these images. Clicking the button Add will add the classification to all the elements that you have selected.

    The classification modal window
    The classification modal window

    You can view all the elements that belong to a certain class on the main page of the project or folder, you can do so by clicking on the Best class filter button that is on top right of the page. A drop down list will appear where you can write the name of the class:

    Filtering elements by best class
    Filtering elements by best class