IIIF manifests
Arkindex has limited support for generating IIIF Presentation API 2.1 manifests and annotation lists. Projects may have variable element structures, but some IIIF viewers are not as flexible as Arkindex might be, which constrains IIIF exports.
Manifests
IIIF manifests group IIIF images together and provide a structure, similarly to how a document will contain distinct pages. A manifest can be accessed for any folder element through the action, or the RetrieveFolderManifest API endpoint.
All elements that are direct children of this folder, are not folders themselves, and have images, will be included in the manifest. They will be sorted by their position within the folder.
When a metadata named folio exists, its value will be used as the name for an image within the manifest. Otherwise, the name of the child element will be used.
All metadata except those of type Markdown will also be included. Those will usually be found in IIIF viewers in a separate panel dedicated to information about the manifest as a whole.
Annotation lists
Within a manifest, each child element will be associated with an annotation list, allowing IIIF viewers to display rectangles around lines of text along with their transcription. Annotation lists can either be accessed by opening an IIIF manifest and enabling the relevant option in the IIIF viewer, or using the RetrieveElementAnnotationList API endpoint.
Annotation lists are only available for elements that have images. For each transcription found on an element and all its child elements recursively, one annotation will be included in the list, with the transcription’s text. Because IIIF only supports rectangles and Arkindex supports any polygon, a rectangle that surrounds the whole polygon will be used for each annotation.
| There are known issues with transcriptions found on child elements, such as text lines on pages, that may not display correctly on some IIIF viewers. |