Comment on page

1.33.2 IIIF

Der Goobi viewer implementiert die IIIF Presentation API in der Version 2.1.1. Diese wird in dem folgenden Block konfiguriert:
config_viewer.xml
<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>
Option
Beschreibung
@use-version
Hier kann die bevorzugte IIIF-Version eingetragen werden. Unterstützt werden folgende Werte:
2.1.1 (default)
3.0
Je nach Einstellung werden im Sidebar-Widget Zitieren und Nachnutzen IIIF-Manifeste nach IIIF Presentation API 2.1.1 oder IIIF Presentation API 3.0 ausgeliefert. Die jeweilige Version wird auch für den Link zm Mirador-View im selben Widget verwendet.
metadataFields/field
Eine Liste mit allen Metadatenfeldern, die im IIIF Presentation Manifest ausgegeben werden. Wildcards sind hier erlaubt, zum Beispiel MD_*
metadataFields/field[@label]
Jedes Field-Element kann über ein optionales label="" Attribut verfügen. Hier kann ein überschreibender message Key definiert werden, der dann nur im IIIF Presentation Manifest verwendet wird.
metadataFields/event
Um Metadaten aus LIDO Events im IIIF Presentation Manifest mit auszugeben kann eine Liste an Events definiert werden. In einem Event-Element ist der Wert immer EVENTNAME/FELDNAME. Im obigen Beispiel also aus den Events Production und Use das Feld MD_EVENTACTOR.
Auch Events können das optionale label="" Attribut enthalten.
labelFields/field
Eine Liste mit allen Metadatenfeldern, die ein Label für ein IIIF Presentation Manifest enthalten können. Das Label wird aus dem ersten Feld mit Inhalt befüllt.
descriptionFields/field
Eine Liste mit allen Metadatenfeldern, die eine IIIF Presentation Manifest Beschreibung enthalten können. Die Beschreibung wird aus dem ersten Feld mit Inhalt befüllt.
navDateField
Solr Feld für die IIIF Presentation navDate Eigenschaft
attribution
Definiert eine message Key, dessen Inhalt als attribution im IIIF 2.1.1 Manifest angegeben ist.
requiredStatement/label
Message-Key für die Beschriftung eines Textes der in IIIF-Viewern bei Verwendung eines IIIF 3.0 Manifestes angezeigt werden muss. Ist dieses Feld nicht konfiguriert, aber requiredStatement/value schon, wird Attribution als default verwendet.
requiredStatement/value
Message-Key für einen Text, der in IIIF-Viewern bei Verwendung eines IIIF 3.0 Manifestes angezeigt werden muss
provider
Anbieter ("Provider") von IIIF 3.0 Resourcen. Es können mehrere Provider konfiguriert werden. Jeder Provider kann die folgend aufgeführten Elemente enthalten.
provider/url
URL eines Providers. Dieser Eintrag ist für jeden Provider verpflichtend
provider/label
Message-Key für die Bezeichnung eines Providers. Dieser Eintrag ist für jeden Provider verpflichtend
provider/homepage
Beschreibung einer Internet-Seite eines Providers. Jeder Provider kann mehrere homepage Einträge haben. Jeder Eintrag muss wiederum die Unterelemente url und label enthalten, die analog zu den entsprechenden Feldern von provider zu verstehen sind.
provider/logo
URL zu einem Logo des Providers. Ein Provider kann mehrere Logos haben.
logo
URL zu einem Bild, dass als Logo im IIIF Manifest angegeben ist. Beginnt die URL mit http(s), wird sie direkt durchgereicht. Wird hier ein Dateiname oder relativer Pfad angegeben, so wird der Pfad relativ ab dem Ordner resources/themes/THEMENAME/images/ gebaut. Ist kein Bild definiert, wird der Bildfooter verwendet.
license
Link-URL zu einer Lizenz-Resource für IIIF 2.1.1 Manifeste. Wiederholbar
rights
Hier kann ein SOLR-Feldname eingetragen werden, der eine URL zu einer CreativCommons oder RightsStatements Lizenz enthält, die in ein IIIF 3.0 Manift eingetragen werden soll. Nicht wiederholbar
discloseContentLocation
Erlaubt das Anfügen eines Content-Location Headers an Bildanfragen mit der kompletten URI des tatsächlich ausgelieferten Bildes, zum Beispiel eine file:// URL vom lokalen Data-Repository oder eine http:// URL von extern verlinkten Bildern. Default-Wert ist true.
rendering/viewer[@visible]
Ist der Wert auf true gesetzt, werden passende Goobi-Viewer-Seiten in IIIF-Presentation Dokumenten verlinkt . Default-Wert ist true
rendering/viewer/label
Text für das Label von Links zu Goobi-Viewer Seiten in IIIF-Presentation Dokumenten. Default-Wert ist Goobi viewer
rendering/pdf[@visible]
Ist der Wert auf true gesetzt, werden PDF-Resourcen in IIIF-Presentation Dokumenten verlinkt. Default-Wert ist true
rendering/pdf/label
Text für das Label von PDF-Links in IIIF-Presentation Dokumenten. Default-Wert ist PDF
rendering/plaintext[@visible]
Ist der Wert auf true gesetzt, werden OCR-Text Resourcen im Plaintext-Format in IIIF-Presentation Dokumenten verlinkt. Default-Wert ist true
rendering/plaintext/label
Text für das Label von Plaintext-Links in IIIF-Presentation Dokumenten. Default-Wert ist Fulltext
rendering/alto[@visible]
Ist der Wert auf true gesetzt, werden OCR-Text Resourcen im ALTO-Format in IIIF-Presentation Dokumenten verlinkt. Default-Wert ist true
rendering/alto/label
Text für das Label von ALTO-Links in IIIF-Presentation Dokumenten. Default-Wert ist ALTO
tranlsations/locale
Für jedes dieser Einträge wird eine Übersetzung für die entsprechende Sprache in Metadaten und Labeln von IIIF Dokumenten erzeugt, so eine verfügbar ist. Ist nur eine Sprache angegeben, werden die Metadaten und Label als reiner Text in der entsprechenden Sprache angezeigt, ansonsten als JSON-Objekt mit Attributen für alle Sprachen.
Sind keine Sprachen konfiguriert, werden alle für den Viewer verfügbaren Sprachen verwendet. 
Die Sprachen müssen als ISO 639-1 Sprachcode (de, en, fr, es, ...) angegeben werden.
Damit die Manifeste von extern eingebunden werden können muss CORS erlaubt sein.

1.33 API

1.33.3 Authentifizierung

Last modified 1mo ago

Option	Beschreibung
@use-version	Hier kann die bevorzugte IIIF-Version eingetragen werden. Unterstützt werden folgende Werte: 2.1.1 (default) 3.0 Je nach Einstellung werden im Sidebar-Widget Zitieren und Nachnutzen IIIF-Manifeste nach IIIF Presentation API 2.1.1 oder IIIF Presentation API 3.0 ausgeliefert. Die jeweilige Version wird auch für den Link zm Mirador-View im selben Widget verwendet.
metadataFields/field	Eine Liste mit allen Metadatenfeldern, die im IIIF Presentation Manifest ausgegeben werden. Wildcards sind hier erlaubt, zum Beispiel `MD_*`
metadataFields/field[@label]	Jedes Field-Element kann über ein optionales `label=""` Attribut verfügen. Hier kann ein überschreibender message Key definiert werden, der dann nur im IIIF Presentation Manifest verwendet wird.
metadataFields/event	Um Metadaten aus LIDO Events im IIIF Presentation Manifest mit auszugeben kann eine Liste an Events definiert werden. In einem Event-Element ist der Wert immer EVENTNAME/FELDNAME. Im obigen Beispiel also aus den Events Production und Use das Feld MD_EVENTACTOR. Auch Events können das optionale `label=""` Attribut enthalten.
labelFields/field	Eine Liste mit allen Metadatenfeldern, die ein Label für ein IIIF Presentation Manifest enthalten können. Das Label wird aus dem ersten Feld mit Inhalt befüllt.
descriptionFields/field	Eine Liste mit allen Metadatenfeldern, die eine IIIF Presentation Manifest Beschreibung enthalten können. Die Beschreibung wird aus dem ersten Feld mit Inhalt befüllt.
navDateField	Solr Feld für die IIIF Presentation navDate Eigenschaft
attribution	Definiert eine message Key, dessen Inhalt als attribution im IIIF 2.1.1 Manifest angegeben ist.
requiredStatement/label	Message-Key für die Beschriftung eines Textes der in IIIF-Viewern bei Verwendung eines IIIF 3.0 Manifestes angezeigt werden muss. Ist dieses Feld nicht konfiguriert, aber `requiredStatement/value` schon, wird `Attribution` als default verwendet.
requiredStatement/value	Message-Key für einen Text, der in IIIF-Viewern bei Verwendung eines IIIF 3.0 Manifestes angezeigt werden muss
provider	Anbieter ("Provider") von IIIF 3.0 Resourcen. Es können mehrere Provider konfiguriert werden. Jeder Provider kann die folgend aufgeführten Elemente enthalten.
provider/url	URL eines Providers. Dieser Eintrag ist für jeden Provider verpflichtend
provider/label	Message-Key für die Bezeichnung eines Providers. Dieser Eintrag ist für jeden Provider verpflichtend
provider/homepage	Beschreibung einer Internet-Seite eines Providers. Jeder Provider kann mehrere `homepage` Einträge haben. Jeder Eintrag muss wiederum die Unterelemente `url` und `label` enthalten, die analog zu den entsprechenden Feldern von provider zu verstehen sind.
provider/logo	URL zu einem Logo des Providers. Ein Provider kann mehrere Logos haben.
logo	URL zu einem Bild, dass als Logo im IIIF Manifest angegeben ist. Beginnt die URL mit http(s), wird sie direkt durchgereicht. Wird hier ein Dateiname oder relativer Pfad angegeben, so wird der Pfad relativ ab dem Ordner `resources/themes/THEMENAME/images/` gebaut. Ist kein Bild definiert, wird der Bildfooter verwendet.
license	Link-URL zu einer Lizenz-Resource für IIIF 2.1.1 Manifeste. Wiederholbar
rights	Hier kann ein SOLR-Feldname eingetragen werden, der eine URL zu einer CreativCommons oder RightsStatements Lizenz enthält, die in ein IIIF 3.0 Manift eingetragen werden soll. Nicht wiederholbar
discloseContentLocation	Erlaubt das Anfügen eines `Content-Location` Headers an Bildanfragen mit der kompletten URI des tatsächlich ausgelieferten Bildes, zum Beispiel eine file:// URL vom lokalen Data-Repository oder eine http:// URL von extern verlinkten Bildern. Default-Wert ist `true.`
rendering/viewer[@visible]	Ist der Wert auf `true` gesetzt, werden passende Goobi-Viewer-Seiten in IIIF-Presentation Dokumenten verlinkt . Default-Wert ist `true`
rendering/viewer/label	Text für das Label von Links zu Goobi-Viewer Seiten in IIIF-Presentation Dokumenten. Default-Wert ist `Goobi viewer`
rendering/pdf[@visible]	Ist der Wert auf `true` gesetzt, werden PDF-Resourcen in IIIF-Presentation Dokumenten verlinkt. Default-Wert ist `true`
rendering/pdf/label	Text für das Label von PDF-Links in IIIF-Presentation Dokumenten. Default-Wert ist `PDF`
rendering/plaintext[@visible]	Ist der Wert auf `true` gesetzt, werden OCR-Text Resourcen im Plaintext-Format in IIIF-Presentation Dokumenten verlinkt. Default-Wert ist `true`
rendering/plaintext/label	Text für das Label von Plaintext-Links in IIIF-Presentation Dokumenten. Default-Wert ist `Fulltext`
rendering/alto[@visible]	Ist der Wert auf `true` gesetzt, werden OCR-Text Resourcen im ALTO-Format in IIIF-Presentation Dokumenten verlinkt. Default-Wert ist `true`
rendering/alto/label	Text für das Label von ALTO-Links in IIIF-Presentation Dokumenten. Default-Wert ist `ALTO`
tranlsations/locale	Für jedes dieser Einträge wird eine Übersetzung für die entsprechende Sprache in Metadaten und Labeln von IIIF Dokumenten erzeugt, so eine verfügbar ist. Ist nur eine Sprache angegeben, werden die Metadaten und Label als reiner Text in der entsprechenden Sprache angezeigt, ansonsten als JSON-Objekt mit Attributen für alle Sprachen. Sind keine Sprachen konfiguriert, werden alle für den Viewer verfügbaren Sprachen verwendet. Die Sprachen müssen als ISO 639-1 Sprachcode (`de`, `en`, `fr`, `es`, ...) angegeben werden.