Januar

Goobi viewer Digest für Januar 2021

Coming soon 🚀

  • Anpassungen an den IIIF Schnittstellen

  • Themes mit rechts-nach-links Leserichtung

  • Aus der Oberfläche heraus Caches leeren

Ankündigungen

Der Goobi viewer hat das Schema der Versionierung mit Goobi workflow synchronisiert. Dadurch ist jetzt immer direkt ersichtlich aus welchem Jahr und Monat eine Version stammt. Diese Version ist jetzt die 21.01. Die beiden FAQ Beiträge um herauszufinden wie alt ein Goobi viewer ist und wie die Versionierung funktioniert wurden entsprechend überarbeitet.

Mit dieser Version wird die Funktionalität um Strukturtypen während der Indexierung automatisch durch andere zu ersetzen (siehe Kapitel 2.4) offiziell abgekündigt. Wenn sie noch von Einrichtungen genutzt wird werden diese hiermit aufgefordert sich per E-Mail oder im Community Forum mit uns in Verbindung zu setzen. Wir planen die Funktionalität mit einem der kommenden Versionen im Goobi viewer Indexer ersatzlos zu löschen.

Bei der REST API gibt es einen Breaking Change! Siehe dazu auch den entsprechenden Abschnitt weiter unten.

Entwicklungen

Werkshinweise

Im Backend gibt es einen neuen Bereich für Werkshinweise. Über die neue Funktionalität ist es möglich für ein Werk ein individuelles neues Sidebar Widget mit einem eigenen Titel und eigenem Text hinzuzufügen. Je nach Styling im Theme kann die Funktionalität aber auch an andere Stellen verschoben werden.

In der Werkansicht steht dafür eingeloggten Benutzern mit Administratorenrechten im Widget "Änderungen am Werk" ein neuer Link zur Verfügung: "Werkshinweis hinzufügen". Nach einem Klick öffnet sich automatisch der neue Bereich im Backend. Während in der Seitenleiste ein paar Informationen zum Werk selbst angezeigt werden, können in der Mitte Titel und Text eingegeben werden. Dabei steht die inzwischen bekannte Reiteransicht mit der visuellen Hervorhebung der Übersetzungen zur Verfügung. Im Backend gibt es weiter eine tabellarische Übersicht der angelegten Hinweise. Dort lässt sich unter Eingabe eines Identifiers auch ein Hinweis anlegen.

Im Widget "Änderungen am Werk" gibt es einen neuen Link "Werkshinweis hinzufügen"
Rechts stehen Informationen zum Werk, in der Mitte können Titel und Text verwaltet werden
Der Hinweis wird im Werk prominent in der Seitenleiste angezeigt
Im Backend gibt es eine tabellarische Übersicht aller Werkshinweise

API

Die Arbeiten zur Refaktorisierung der API sind endlich komplett fertiggestellt. Im Juli letzten Jahres war bereits ein großer Teil der API refaktorisiert und in einen neuen Namespace umgezogen. In den letzen Monaten sind nun auch die letzten, vornehmlich internen Teile final umgezogen. Damit entfällt der Bereich unter /rest/ komplett und wird durch die neue Struktur unterhalb von /api/v1/ ersetzt.

Der neue Bereich /api/v1/ biete viele Vorteile. So ist zum erstem Mal die API komplett dokumentiert (siehe /api/swagger/). Außerdem gibt es eine Testinfrastruktur in der bereits viel Code automatisch getestet wird und die ermöglicht die Abdeckung dort in Zukunft auch noch weiter zu erhöhen. Auch ist die API ab jetzt versioniert. Das bedeutet, dass nicht abwärtskompatible Änderungen in einem anderen Namespace durchgeführt werden können (zum Beispiel /api/v2/). Aufrufe an /api/v1/ sind dadurch dann nicht betroffen.

Einen sauren Apfel gibt es trotzdem noch: Es handelt sich hierbei um einen sogenannten Breaking Change. Sofern noch die alte REST Schnittstelle verwendet wird müssen die Aufrufe entsprechend angepasst werden.

Karten

Es ist ab sofort möglich auch eigene Mapbox Styles für die Karten zu verwenden. Dafür gibt es die neuen optionalen Optionen und in der Konfigurationsdatei. Siehe auch Kapitel 1.36 in der Dokumentation

Messages

Mit der Maven Umstellung ging einher, dass die globalen Messages Dateien nach einer Installation nicht mehr entpackt im Dateisystem lagen, sondern gepackt innerhalb der viewer-core.jar enthalten waren. Wir konnten die messages Dateien jetzt in das goobi-viewer-core-config Repository umziehen. Damit liegen diese nach der Installation wieder im Dateisystem und sind deutlich einfacher zugänglich.

Goobi viewer Indexer

Der Goobi viewer Indexer hat einen neuen Parameter bekommen um automatisch ein Boolean-Feld zu generieren wenn das dazugehörige Metadatum vorhanden ist. Diese können dann zum Beispiel in der Facettierung eingesetzt werden. Ein Anwendungsbeispiel ist zum Beispiel, dass nur bestimmte Werke Ortsangaben besitzen und man nur nach diesen Werken facettieren möchte.

Siehe dazu auch Kapitel 2.5 in der Dokumentation

Dokumentation

Die Dokumentation des Goobi viewers wurde massiv überarbeitet. Sie ist jetzt in verschiedene Sektionen aufgeteilt um schneller eine bessere Übersicht zu bekommen. Die Abschnitte für den Goobi viewer Indexer und den Goobi viewer Connector wurden inhaltlich, stilistisch und strukturell an den Goobi viewer Core angepasst. Komplett neu ist die Beschreibung der Backend Oberfläche für die bereits überarbeiteten Seiten. Einfach einmal rein schauen, viel Spaß beim Stöbern und Nachschlagen. Hinweise bitte gerne ins Community Forum🙂

Versionsnummern

Die Versionen die in der pom.xml des Themes eingetragen werden müssen um die in diesem Digest beschriebenen Funktionen zu erhalten lauten:

<dependency>
<groupId>io.goobi.viewer</groupId>
<artifactId>viewer-core</artifactId>
<version>21.01.2</version>
</dependency>
<dependency>
<groupId>io.goobi.viewer</groupId>
<artifactId>viewer-core-config</artifactId>
<version>21.01</version>
</dependency>

Der Goobi viewer Indexer hat die Versionsnummer 21.01.1

Der Goobi viewer Connector hat die Versionsnummer 21.01

Das Goobi viewer Crowdsourcing Modul hat die Versionsnummer 21.01