Comment on page

1.23 Sidebar

Folgende Elemente schalten Links in der Sidebar zu den verschiedenen Arten der Werkansicht an beziehungsweise ab:
config_viewer.xml
<sidebar>
    <page enabled="true" />
    <toc enabled="true" />
    <thumbs enabled="true" />
    <searchInItem enabled="true" />
    <metadata enabled="true" />
    <fulltext enabled="true" />
    <opac enabled="false" />
    <sidebarBrowsingTerms enabled="true" />
    <sidebarRssFeed enabled="true" />
    <sidebarWidgetUsage enabled="true">
        <page>
            <downloadOptions enabled="true">
                <option label="label__download_option_preview_150" format="jpg" boxSizeInPixel="150" />
                <option label="label__download_option_small_1024" format="jpg" boxSizeInPixel="1024" />
                <option label="label__download_option_medium_2048" format="jpg" boxSizeInPixel="2048" />
                <option label="label__download_option_large_4096" format="jpg" boxSizeInPixel="4096" />
                <option label="Master" format="MASTER" boxSizeInPixel="max"/>
            </downloadOptions>
        </page>
        <citationLinks enabled="true">
            <links>
                <link type="URL" for="record" label="URN" field="URN" pattern="https://nbn-resolving.org/{value}" />
                <link type="URL" for="record" label="Handle" field="MD_PI_HANDLE" pattern="https://hdl.handle.net/{value}" />
                <link type="URL" for="record" label="DOI" field="MD_PI_DOI" pattern="https://doi.org/{value}" />
                <link type="URL" for="record" label="ARK" field="MD_PI_ARK" pattern="https://n2t.net/{value}" />
                <link type="URL" for="record" label="PURL" field="MD_PURL_IAI" />
                <link type="URL" for="image"  label="DOI" field="MD_PI_DOI" pattern="https://doi.org/{value}#?page={page}" />
                <link type="URL" for="image"  label="ARK" field="MD_PI_ARK" pattern="https://n2t.net/{value}/{page}/" topstructValueFallback="true" />
                <link type="URL" for="image"  label="URN" field="IMAGEURN" pattern="https://nbn-resolving.org/{value}" />
                <link type="URL" for="image"  label="URN" field="URN" pattern="https://nbn-resolving.org/{value}/fragment/page={page}" topstructValueFallback="true" />
                <link type="INTERNAL" for="record" label="LABEL_VIEWER_PURL" />
                <link type="INTERNAL" for="docstruct" label="LABEL_VIEWER_PURL" />
                <link type="INTERNAL" for="image" label="LABEL_VIEWER_PURL" />
            </links>
        </citationLinks>
        <citationRecommendation enabled="true">
            <styles>
                <style>modern-language-association-7th-edition</style>
                <style>apa-6th-edition</style>
                <style>chicago-author-date-16th-edition</style>
                <style>harvard-cite-them-right-no-et-al</style>
                <style>oscola</style>
            </styles>
            <source>
                <metadata label="MD_CITATION" value="MASTERVALUE_CITATION">
                    <param type="citeproc" dest="title" key="MD_TITLE" />
                    <param type="citeproc" dest="author" key="MD_CREATOR" />
                    <param type="citeproc" dest="publisher" key="MD_PUBLISHER" />
                    <param type="citeproc" dest="placepublish" key="MD_PLACEPUBLISH"/>
                    <param type="citeproc" dest="issued" key="MD_YEARPUBLISH" />
                    <param type="citeproc" dest="isbn" key="MD_ISBN"/>
                </metadata>
            </source>
        </citationRecommendation>
    </sidebarWidgetUsage>
    <sidebarWidgetDownloads enabled="true">
        <hideFileRegex>(EXAMPLE_.*|HIDDEN_.*)</hideFileRegex>
    </sidebarWidgetDownloads>
    <copyrightIndicator enabled="true" style="widget">
        <status field="ACCESSCONDITION">
            <value content="OPENACCESS" status="OPEN" description="COPYRIGHT_DESCRIPTION_STATUS_OPEN" />
            <value content="PDFLOCKED" status="PARTIAL" description="COPYRIGHT_DESCRIPTION_STATUS_PDFLOCKED" />
        </status>
        <license field="MD_USEANDREPRODUCTIONLICENSE">
            <value content="CC0 1.0 Universal (CC0 1.0) Public Domain Dedication" description="COPYRIGHT_DESCRIPTION_LICENSE_CC010">
                <icon>cc.svg</icon>
                <icon>zero.svg</icon>
            </value>
            <value content="In Copyright 1.0" description="COPYRIGHT_DESCRIPTION_LICENSE_RSINC10">
                <icon>rs-inc.svg</icon>
            </value>
        </license>
    </copyrightIndicator>
</sidebar>
Option
Beschreibung
page/@enabled
Bild-/Video-/Audio
toc/@enabled
Sichtbarkeit des Links zum Inhaltsverzeichnis in der Werks-Navigation. Achtung: dies ist nicht das Sidebar-Inhaltsverzeichnis, hierfür siehe sidebarToc.
thumbs/@enabled
Seitenvorschau (Thumbnails)
searchInItem/@enabled
Suche im Werk
metadata/@enabled
Metadaten / Bibliographische Daten
Wird dieser Schalter deaktiviert, wird das gesamte Widget nicht gerendert.
fulltext/@enabled
Volltext
opac/@enabled
Zeigt einen zusätzlichen Link zum Katalog an. Standardwert ist false
sidebarBrowsingTerms/@enabled
Blendet das Stöbern Widget ein oder aus. Standardwert ist true
sidebarRssFeed/@enabled
Blendet das RSS Feed Widget ein oder aus. Standardwert ist true
sidebarWidgetUsage/@enabled
Blendet das Widget ein oder aus. Standardwert ist true
sidebarWidgetUsage/page/downloadOptions/@enabled
Blendet die Downloadoptionen ein oder aus. Standardwert ist true
sidebarWidgetUsage/page/downloadOptions/option
Liste an Einträgen die zum Download zur Verfügung gestellt werden sollen. 
Das Attribut label enthält einen Message Key.
Im Attribut format wird das Dateiformat angegeben. Dieses muss ein von der IIIF Image API unterstütztes Format sein. Der statische StringMASTER wird automatisch in das Bildformat des Masterimages übersetzt.
Das Attribut boxSizeInPixel beinhaltet einen Wert in Pixeln. Daraus wird ein Quadrat erstellt. Der Goobi viewer skaliert dann - unter Beibehaltung der Seitenverhältnisse - das Bild in die angegebene Box und zeigt die reale Größe in Pixeln im Download Popover an.
sidebarWidgetUsage/citationLinks/@enabled
Blendet den Bereich ein oder aus. Standardwert ist true
sidebarWidgetUsage/citationLinks/links/link
Liste an Einträgen die als Zitierlinks angezeigt werden sollen.
type: kann den Wert URL annehmen wenn ein Link gebaut werden soll, oder INTERNAL sein um die interne vom Goobi viewer gebaute URL zu verwenden.
for: kann die Werte record, docstruct oder image enthalten und definiert für welchen Bereich der Zitierlink gilt
label: enthält den Message Key zu dem Namen des angezeigten Zitierlinks.
field: definiert das Solr-Feld aus dem der Wert für den Zitierlink kommen soll. Es wird nur bei type="URL" ausgewertet.
pattern: baut die URL zusammen. Erlaubt sind die Platzhalter {value} (Wert des Feldes) und {page} (aktuelle Seitenzahl im geladenen Werk).
topstructValueFallback: Wenn  true wird der Wert  des Hauptelements aus dem Solr-Index genommen, auch wenn for="docstruct" oder for="image" gesetzt ist. Standardwert ist false.
sidebarWidgetUsage/citationRecommendation/@enabled
Blendet den Bereich ein oder aus. Standardwert ist true
sidebarWidgetUsage/citationRecommendation/styles
Enthält die Liste an Citeproc Zitierstilen die in dem Dropdown Menü angeboten werden sollen.
sidebarWidgetUsage/citationRecommendation/source/metadata
Enthält das Mapping von den Solr-Feldern zu den Citeproc Werten. 
sidebarWidgetDownloads/@enabled
Blendet das Widget ein oder aus. Standardwert ist true
sidebarWidgetDownlads/hideFileRegex
Wenn ein Regulärer Ausdruck definiert ist, werden Dateien die darauf matchen im Widget ausgeblendet. Es handelt sich hierbei um eine rein visuelle Option, der Download der Dateien ist weiterhin möglich.
copyrightIndicator/@enabled
Aktiviert oder deaktiviert die Anzeige der Funktionalität. Standardwert ist true.
copyrightIndicator/@style
Definiert die Orte an denen die Information angezeigt wird. Mögliche Werte sind widget und trafficlight. Die Anzeige als Widget erfolgt in der Seitenleiste. Die Anzeige als Ampel erfolgt neben dem Titel des Datensatzes. Standardwert ist widget.
copyrightIndicator/status/@field
Definiert das Solr Feld, indem die Informationen zur Zugriffsbeschränkung stehen. Standardwert ist ACCESSCONDITION
copyrightIndicator/status/value/@content
Legt den Inhalt des definierten Feldes fest für den die Einstellung gelten soll
copyrightIndicator/status/value/@status
Setzt den Status für den Inhalt. Mögliche Werte sind OPEN, PARTIAL und LOCKED. Wird das Widget angezeigt wird der Status OPEN als geöffnetes Schloss und PARTIAL und LOCKED als geschlossenes Schloss visualisiert. Ansonsten wird der Status in den Ampelfarben OPEN=grün, PARTIAL=gelb und LOCKED=rot angezeigt.
copyrightIndicator/status/value/@description
Legt den Message Key fest, indem die Zugriffsbeschränkung weiter beschrieben wird.
copyrightIndicator/license/@field
Definiert das Solr Feld, indem die Informationen zur Nutzungslizenz stehen. Standardwert ist MD_USEANDREPRODUCTIONLICENSE
copyrightIndicator/license/value/@content
Legt den Inhalt des definierten Feldes fest für den die Einstellung gelten soll
copyrightIndicator/license/value/@description
Legt den Message Key fest, indem die Nutzungslizenz weiter beschrieben wird.
copyrightIndicator/license/value/icon
Wiederholbarer Eintrag der die Namen der Dateien auflistet, die für die Repräsentation der Nutzungslizenz verwendet werden sollen. Die Dateien befinden sich im Theme oder Core im Ordner images/licence/
Innerhalb dieser Sektion wird in der Konfigurationsdatei auch das Sidebar-Inhaltsverzeichnis konfiguriert. Aufgrund der thematischen Nähe, ist es in Kapitel  1.20.2 beschrieben.
Ebenfalls wird hier der Download für Originalinhalte beschrieben. Historisch bedingt ist das noch in Kapitel 1.30 beschrieben.

1.22 Resolver

1.24 Navigation und Anzeige

Last modified 1yr ago

Option	Beschreibung
page/@enabled	Bild-/Video-/Audio
toc/@enabled	Sichtbarkeit des Links zum Inhaltsverzeichnis in der Werks-Navigation. Achtung: dies ist nicht das Sidebar-Inhaltsverzeichnis, hierfür siehe `sidebarToc`.
thumbs/@enabled	Seitenvorschau (Thumbnails)
searchInItem/@enabled	Suche im Werk
metadata/@enabled	Metadaten / Bibliographische Daten Wird dieser Schalter deaktiviert, wird das gesamte Widget nicht gerendert.
fulltext/@enabled	Volltext
opac/@enabled	Zeigt einen zusätzlichen Link zum Katalog an. Standardwert ist `false`
sidebarBrowsingTerms/@enabled	Blendet das Stöbern Widget ein oder aus. Standardwert ist `true`
sidebarRssFeed/@enabled	Blendet das RSS Feed Widget ein oder aus. Standardwert ist `true`
sidebarWidgetUsage/@enabled	Blendet das Widget ein oder aus. Standardwert ist `true`
sidebarWidgetUsage/page/downloadOptions/@enabled	Blendet die Downloadoptionen ein oder aus. Standardwert ist `true`
sidebarWidgetUsage/page/downloadOptions/option	Liste an Einträgen die zum Download zur Verfügung gestellt werden sollen. Das Attribut `label` enthält einen Message Key. Im Attribut `format` wird das Dateiformat angegeben. Dieses muss ein von der IIIF Image API unterstütztes Format sein. Der statische String`MASTER` wird automatisch in das Bildformat des Masterimages übersetzt. Das Attribut `boxSizeInPixel` beinhaltet einen Wert in Pixeln. Daraus wird ein Quadrat erstellt. Der Goobi viewer skaliert dann - unter Beibehaltung der Seitenverhältnisse - das Bild in die angegebene Box und zeigt die reale Größe in Pixeln im Download Popover an.
sidebarWidgetUsage/citationLinks/@enabled	Blendet den Bereich ein oder aus. Standardwert ist `true`
sidebarWidgetUsage/citationLinks/links/link	Liste an Einträgen die als Zitierlinks angezeigt werden sollen. type: kann den Wert `URL` annehmen wenn ein Link gebaut werden soll, oder `INTERNAL` sein um die interne vom Goobi viewer gebaute URL zu verwenden. for: kann die Werte `record`, `docstruct` oder `image` enthalten und definiert für welchen Bereich der Zitierlink gilt label: enthält den Message Key zu dem Namen des angezeigten Zitierlinks. field: definiert das Solr-Feld aus dem der Wert für den Zitierlink kommen soll. Es wird nur bei `type="URL"` ausgewertet. pattern: baut die URL zusammen. Erlaubt sind die Platzhalter `{value}` (Wert des Feldes) und `{page}` (aktuelle Seitenzahl im geladenen Werk). topstructValueFallback: Wenn `true` wird der Wert des Hauptelements aus dem Solr-Index genommen, auch wenn `for="docstruct"` oder `for="image"` gesetzt ist. Standardwert ist `false`.
sidebarWidgetUsage/citationRecommendation/@enabled	Blendet den Bereich ein oder aus. Standardwert ist `true`
sidebarWidgetUsage/citationRecommendation/styles	Enthält die Liste an Citeproc Zitierstilen die in dem Dropdown Menü angeboten werden sollen.
sidebarWidgetUsage/citationRecommendation/source/metadata	Enthält das Mapping von den Solr-Feldern zu den Citeproc Werten.
sidebarWidgetDownloads/@enabled	Blendet das Widget ein oder aus. Standardwert ist `true`
sidebarWidgetDownlads/hideFileRegex	Wenn ein Regulärer Ausdruck definiert ist, werden Dateien die darauf matchen im Widget ausgeblendet. Es handelt sich hierbei um eine rein visuelle Option, der Download der Dateien ist weiterhin möglich.
copyrightIndicator/@enabled	Aktiviert oder deaktiviert die Anzeige der Funktionalität. Standardwert ist `true`.
copyrightIndicator/@style	Definiert die Orte an denen die Information angezeigt wird. Mögliche Werte sind `widget` und `trafficlight`. Die Anzeige als Widget erfolgt in der Seitenleiste. Die Anzeige als Ampel erfolgt neben dem Titel des Datensatzes. Standardwert ist `widget`.
copyrightIndicator/status/@field	Definiert das Solr Feld, indem die Informationen zur Zugriffsbeschränkung stehen. Standardwert ist `ACCESSCONDITION`
copyrightIndicator/status/value/@content	Legt den Inhalt des definierten Feldes fest für den die Einstellung gelten soll
copyrightIndicator/status/value/@status	Setzt den Status für den Inhalt. Mögliche Werte sind `OPEN`, `PARTIAL` und `LOCKED`. Wird das Widget angezeigt wird der Status OPEN als geöffnetes Schloss und PARTIAL und LOCKED als geschlossenes Schloss visualisiert. Ansonsten wird der Status in den Ampelfarben OPEN=grün, PARTIAL=gelb und LOCKED=rot angezeigt.
copyrightIndicator/status/value/@description	Legt den Message Key fest, indem die Zugriffsbeschränkung weiter beschrieben wird.
copyrightIndicator/license/@field	Definiert das Solr Feld, indem die Informationen zur Nutzungslizenz stehen. Standardwert ist `MD_USEANDREPRODUCTIONLICENSE`
copyrightIndicator/license/value/@content	Legt den Inhalt des definierten Feldes fest für den die Einstellung gelten soll
copyrightIndicator/license/value/@description	Legt den Message Key fest, indem die Nutzungslizenz weiter beschrieben wird.
copyrightIndicator/license/value/icon	Wiederholbarer Eintrag der die Namen der Dateien auflistet, die für die Repräsentation der Nutzungslizenz verwendet werden sollen. Die Dateien befinden sich im Theme oder Core im Ordner `images/licence/`