User guide

Last update : 21/04/2020 by Chloë

What is Arkindex ?

Arkindex is a platform for the management and automatic processing of digital documents. The platform allows you to organize documents, annotate them, launch automatic processing tasks (classification,document layout analysis, handwritten or printed text recognition, information extraction), correct and validate the results.


Sign up (Administrators only)

Registration of a new user can only done by an administrator. Send us an email to get an account created.

Your login has to be a valid email address, and you must choose a secure password.
No validation email is sent after account creation.

Log in

Once your account is created, you can log in with your email address and chosen password.

Reset your password

If you forget your password, you can reset it using Forgotten password button in the login area.

An email containing a link to reset the password will be sent to you email adress.

Rights and corpus (Administrators only)

Different types of users have different rights:

RightsSuper adminCorpus adminWriting rights on corpusRead-only access
User creation
Corpus creation
Element deletion
Corpus deletion

File import

.jpg or .pdf imports

You can import an image or pdf file through the Import tab, clicking Files. You can choose the corpus you want to import your file into using the Select a corpus drop-down list. Choose a file to import from your local workstation. The Upload to button [Name of the corpus] sends the file to the Available files to import space, from which you can then select it (or multiple uploaded files of the same type) and choose a Folder and Element type before importing it.

During the import, Elements are created from your files. You can follow your import’s progressin the Workflow status interface.

By clicking View Folder you can access the folder your image(s) have been imported in.

This import process creates IIIF images.

IIIF manifest import

You can upload IIIF manifests to Arkindex.

Corpus processing

What is an element ?

It is an object: a book, a page, a line of text… An element can contain other elements and be itself contained in an element.

See the detail article on elements.

Filtering elements

Elements can be filtered by name, by simply typing the name of the element you are looking for in the filter bar. They can also be filtered by type:

There are several ways to navigate through the elements.

In the folders and page visualisation
We can easily browse files and pages thanks to arrow keys and numbers of pages results.

Des modifications risques d'être apportées concernant l'ergonomie

Or simply with keyboard shortcuts :

In the element three
We can browse element thanks to the three. This one is accessible on the element view in the menu [3 small bars]. Display element’s children on the same element.

IIIF Visualisation

Mirador and Universal Viewer

You can open an element in IIIf viewers through the Actions menu, clicking View in Mirador or View in UV. This opens a IIIF visualisation interface through which you can browse a volume. Using a mouse wheel or touchpad, you can easily navigate in a page: zoom in, zoom out, move around. In the navigation bar on the left, the index allows you to jump to the desired folio. You can also use UV to search in the document’s transcription as well as its annotations.

Annotation interface

This one is symbolized by a pencil. To draw the area to be annotated, use the Rectangle or Polygon tool, as needed. Select is used to move the area(s) drawn and Reset … Once areas to be annotated have been drawn, they appear on the right side of the screen in the Polygon results. They can then be given a name other than the one automatically assigned, as well as a type [ML: le type est required, les autres facultatifs] and class. Click Create to save your annotation.

In the Polygon results you can see all the annotations and thus modify their attributes (Name, Type, Class) if needed. Update to save the modifications.