Element is the base unit to describe any type of document. At its core, it only has a name, and a type; other fields are optional.
To represent a document in Arkindex, we'll need to:
Typeto each elements. Types are managed at projects level, and can be though of categories for elements,
Elementcan use a part of an
Imageby specifying the
For example, a project with historical books could have the following simple structure:
In this example, we have 4 different Element types:
Arkindex do not assume any structure for a Project types, the Project administrator is free to create as many types as needed. To know more about Element types, please read the next page dedicated to Types.
The hierarchy between elements is not enforced at the Type level (there is no graph between different Type), but at the Element level.
A user can create any hierarchy between Elements using multiple Paths. A Path is simply a link between elements, linking a Parent element with Children elements. Using the example above, we can see that different instances of
Page are all linked to a single
We would then have two paths to represent that hierarchy:
To know more about Element paths, please read the page dedicated to Paths.
Element may have a link towards an
Image, but this is not mandatory. Some elements are purely present for organisation purposes (like a folder on a file system).
In the example above, different elements would be linked to parts of images:
Pageelements would be linked to full size images directly provided by the client,
Paragraphelements would be linked to a large zone of an image,
Lineelements would be linked to a thinner zone of an image.
Arkindex link Element and Image by using a Zone in between the two instances.
A Zone will store the
polygon (list of raster points or pixels) that specify which part of an image is represented by an element.
These endpoints are the most useful to handle