Annotating documents on Arkindex

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.

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.

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.

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.


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.