1.33.2 IIIF

The Goobi viewer implements the IIIF Presentation API in version 2.1.1. This is configured in the following block:

<webapi>
    <iiif use-version="2.1.1">
        <metadataFields>
            <field>MD_TITLE</field>
            <field>MD_CREATOR</field>
            <field label="OTHERLABEL_PURL">MD_PURL</field>
            <event>Production/MD_EVENTACTOR</event>
            <event>Use/MD_EVENTACTOR</event>
        </metadataFields>
        <labelFields>
            <field>MD_TITLE</field>
            <field>LABEL</field>
        </labelFields>
        <descriptionFields>
            <field>MD_CONTENTDESCRIPTION</field>
        </descriptionFields>
        <navDateField>YEAR</navDateField>
        <rendering>
            <viewer enabled="true">
                <label>Goobi viewer</label>
            </viewer>
            <pdf enabled="true">
                <label>PDF</label>
            </pdf>
            <plaintext enabled="true">
                <label>Fulltext</label>
            </plaintext>
            <alto enabled="true">
                <label>ALTO</label>
            </alto>
        </rendering>
        <seeAlso>
            <mets enabled="true">
                <label>METS/MODS</label>
            </mets>
            <lido enabled="true">
                <label>LIDO</label>
            </lido>
            <!--metadata label="metadata_dl_opac" format="text/html">
                <param type="field" key="OPACURL"/>
            </metadata-->
        </seeAlso>
        <translations>
            <locale>de</locale>
            <locale>en</locale>
        </translations>
        <attribution>iiif_requiredstatement_value</attribution>
        <license>iiif_license</license>
        <logo>dfgviewer_intranda.jpg</logo>
        <requiredStatement>
            <label>iiif_requiredstatement</label>
            <value>iiif_requiredstatement_value</value>
        </requiredStatement>
        <rights>MD_SOLR-FIELD-WITH-RECORD-LICENSE</rights>
        <provider>
            <url>https://www.intranda.com</url>
            <label>iiif_provider_label</label>
            <homepage>
                <url>https://goobi.io/viewer/</url>
                <label>iiif_provider_homepage_label</label>
            </homepage>
            <homepage>
                <url>https://www.intranda.com/</url>
                <label>intranda homepage</label>
            </homepage>
            <logo>https://goobi.io/dfgviewer_intranda.jpg</logo>
        </provider>
        <discloseContentLocation>false</discloseContentLocation>
    </iiif>
</webapi>

Setting

Description

@use-version

The preferred IIIF version can be entered here. The following values are supported:

2.1.1 (default)
3.0

Depending on the setting, IIIF manifests according to IIIF Presentation API 2.1.1 or IIIF Presentation API 3.0 are delivered in the sidebar widget Cite and Repurpose. The respective version is also used for the link to the Mirador view in the same widget.

metadataFields/field

A list of all metadata fields output in the IIIF Presentation Manifest. Wildcards are allowed here, for example MD_*

metadataFields/field[@label]

Each field element can be labelled with an optional label="" attribute. Here an overwriting message key can be defined, which is then only used in the IIIF Presentation Manifest.

metadataFields/event

To output metadata from LIDO events in the IIIF Presentation Manifest, a list of events can be defined. In an event element the value is always EVENTNAME/FELDNAME. In the above example, the field MD_EVENTACTOR is taken from the Production and Use events. Events can also use the optional label="" attribute.

labelFields/field

A list of all metadata fields that can contain a label for an IIIF Presentation Manifest. The label is filled with content from the first field.

descriptionFields/field

A list of all metadata fields that may contain a IIIF Presentation Manifest description. The description is filled with content from the first field.

navDateField

Solr field for the IIIF presentation navDate property

attribution

Defines a message key whose content is specified as attribution in the IIIF 2.1.1 manifest.

requiredStatement/label

Message key for the caption of a text that must be displayed in IIIF viewers when using an IIIF 3.0 manifest. If this field is not configured but requiredStatement/value is, attribution is used as default.

requiredStatement/value

Message key for a text to be displayed in IIIF viewers when using an IIIF 3.0 manifest

provider

Provider of IIIF 3.0 resources. Multiple providers can be configured. Each provider can contain the elements listed below.

provider/url

URL of a provider. This entry is mandatory for every provider

provider/label

Message key for the designation of a provider. This entry is mandatory for every provider

provider/homepage

Description of an Internet page of a provider. Each provider can have several homepage entries. Each entry must in turn contain the sub-elements url and label, which are to be understood analogously to the corresponding fields of provider.

provider/logo

URL to a logo of the provider. A provider can have several logos.

logo

URL to an image that is specified as a logo in the IIIF Manifesto. If the URL starts with http(s), it will be forwarded directly. If a filename or relative path is specified here, the path is built relative to the resources/themes/THEMENAME/images/ folder. If no image is defined, the image footer is used.

license

Link URL to a licence resource for IIIF 2.1.1 manifests. Repeatable

rights

A SOLR field name can be entered here containing a URL to a CreativCommons or RightsStatements licence to be entered in an IIIF 3.0 manift. Not repeatable

discloseContentLocation

Allows you to add a content-Location header to Image requests with the complete URI of the tatsächlich delivered image, for example a file:// URL from the local data repository or a http:// URL of externally linked images. Default value is true.

rendering/viewer[@visible]

If the value is set to true, matching Goobi viewer pages are linked in IIIF presentation documents. Default value is true

rendering/viewer/label

Text for the label of links to Goobi Viewer pages in IIIF presentation documents. Default value is Goobi viewer

rendering/pdf[@visible]

If set to true, PDF resources are linked in IIIF presentation documents. Default value is true

rendering/pdf/label

Text for the label of PDF links in IIIF presentation documents. Default value is PDF

rendering/plaintext[@visible]

If set to true, OCR text resources are linked in plain text format in IIIF presentation documents. Default value is true

rendering/plaintext/label

Text for the label of plaintext links in IIIF presentation documents. Default value is Fulltext

rendering/alto[@visible]

If set to true, OCR text resources in ALTO format are linked in IIIF presentation documents. Default value is true

rendering/alto/label

Text for the label of ALTO links in IIIF presentation documents. Default value is ALTO

tranlsations/locale

For each of these entries, a translation for the corresponding language is generated in metadata and labels of IIIF documents, if one is available. If only one language is specified, the metadata and labels are displayed as plain text in the corresponding language, otherwise as a JSON object with attributes for all languages. If no languages are configured, all languages available for the viewer are used. The languages must be specified as ISO 639-1 language code (de, en, fr, es, ...).

CORS must be permitted so that the manifests can be integrated externally.

Previous1.33.1 JSON Next1.33.3 Authentication

Last updated 9 months ago