Oxydition Open Source

Übersicht über die Komponenten der frei zu Verfügung gestellten Anpassungen am Oxygen XML Editor zur Erstellung historisch-kritischer Editionen durch die historische Kommission bei der BADW

Einführung

Oxydition ist der Sammelbegriff für den Ansatz der Historischen Kommission zur Anpassung des Oxygen XML Editor für historisch-kritische Editionsprojekte, sowohl digital als auch im Druck. Der Ansatz beruht in Teilen auf den Vorarbeiten der Berlin-Brandenburgischen Akademie der Wissenschaften in ihrem Projekt ediarum (https://www.ediarum.org); Ausgangsbasis für Oxydition war die 2014 unter GNU Lesser Public Lizenz veröffentlichte ediarum-Version 1.2). Seit 2014 entwickelt sich Oxydition allerdings in eine eigne Richtung.


Das erste Kernkonzept von Oxydition ist zum einen, dass den Bearbeiter*innen eine Editionsumgebung im Author-Modus Oxygen bereitgestellt wird, die es Ihnen ermöglicht bequem und mit nur minimalen XML-Vorkenntnissen Editionstexte in gültigen TEI-XML zu erstellen. So soll die Einstiegshürde und der Mehraufwand für die Arbeit in XML gegenüber klassischeren Textverarbeitungsprogrammen reduziert werden.

Das zweite Kernkonzept ist die Registerdatenbank (RDB). Dies ist eine Sammlung von XML-Dateien in denen an zentraler Stelle alle registerrelevanten Entitäten (z.B. Personen, Orte, Literaturtitel) gegebenenfalls mit Zusatzinformation gesammelt und verwaltet werden. Durch Verlinkungen vom Editionstext auf die Registerdatenbank wird eine hohe innere Verknüpfung des Editionstexts erreicht, redundante Datenspeicherung vermieden und bei Bedarf die halbautomatische Erstellung eines Registers für ein gedrucktes Buch ermöglicht.

Oxydition wird inzwischen, jeweils abgewandelt und an die individuellen Anforderungen angepasst, in mehreren Editionsprojekten - derzeit Brief- und Protokolleditionen - der Historischen Kommission angewandt.

Die hier vorgestellte Open Source Version stellt alle typischen Komponenten des Oxydition-Ansatzes zum Anschauen, Ausprobieren und Weiterentwickeln zur Verfügung. Dies geschieht am Beispiel der Edition der „Protokolle des Bayerischen Ministerrats 1945-1962“ (MinRProt). Dies war das erste Editionsprojekt das mit Oxydition bearbeitet wurde und das erste, für das ein Editionsband fertiggestellt und in den Druck gegeben werden konnte. Dabei muss betont werden, dass die Programmierungen und Konfigurationen stark auf die speziellen Voraussetzungen der Ministerratsprotokolledition angepasst sind. Es handelt sich also nicht um ein direkt nachnutzbares Tool, dass unverändert auch auf andere Editionsprojekte übertragen werden kann. Nichtsdestotrotz können die Codes und Beispiele von Oxydition als Inspiration oder Ausgangspunkt für weitere Entwicklungen dienen.


Komponenten

Das Open Source Version von Oxydition besteht aus drei Komponenten. Sie können unabhängig voneinander installiert, eingesetzt und verändert werden. Zusammen bieten Sie einen umfassenden Überblick über die Implementierung von Oxydition für das Editionsprojekt „Die Protokolle des Bayerischen Ministerrats 1945-1962“.

Frameworks

Frameworks sind das Mittel um im Author-Modus von Oxygen individualisierte Arbeitsumgebungen einzurichten, die spezialisierte Ansichten und Funktionalitäten zu Verfügung stellen. Die Open Source Variante beinhaltet drei Frameworks für das Projekt MinRProt, die sich gegenseitig ergänzen. Jede passt die Arbeitsumgebung für einen anderen Teil der Editionsdateien an.

Dokumentation Frameworks

Download Frameworks

Beispielprojekt

Um die Funktionalitäten der Edition am konkreten Beispiel ausprobieren zu können, werden die Dateien des Editionsbandes „Das Kabinett Ehard III. Band 3 [1953]“ in gekürzter Form bereitgestellt. Dabei handelt es sich um den ersten Band der Edition, der mit Oxydition hergestellt wurde. Im August 2019 konnte die Historische Kommission und der zuständige Bearbeiter, Dr. Oliver Braun, die Arbeiten an diesem Band erfolgreich abschließen und das Buch in den Druck geben.

Dokumentation Beispielprojekt

Download Beispielprojekt

Java-Projekt

Während viele Funktionalitäten der Editionsumgebung mit den von Oxygen bereitgestellten Werkzeugen umgesetzt werden konnten, musste zur Umsetzung komplexerer Anforderungen Java benutzt werden. Oxygen bietet hierfür eine Programmierschnittstelle. Mit dieser wurde das Java-Projekt „oxydition-operations“ angelegt, das zahlreiche neue Operationen für den Author-Modus bereitstellt.

Das Ergebnis des Projekts ist bereits in die Frameworks eingebaut. Es muss nur installiert werden, falls der Quellcode der neuen Operationen betrachtet oder verändert werden soll.

Dokumentation Java-Projekt

Download Java-Projekt


Installation

Voraussetzungen

Um die Frameworks und das Beispielprojekt zu nutzen, muss der Oxygen XML Editor installiert sein. Oxydition wird hauptsächlich unter Oxygen Version 17.1 entwickelt und getestet. Probleme mit neueren Oxygenversionen sind bisher aber nicht bekannt.

Um das Java-Projekt laden und bearbeiten zu können, bedarf einer Java-SDK-Installation der Version 1.8 oder höher.

Frameworks

Kopieren Sie die drei Frameworkordner „tei_oxydition_minrprot“, „tei_oxydition_minrprot_register“ und „tei_oxydition_minrprot_gesamt“ in den Unterordner „frameworks“ des Oxygen-Installationsverzeichnisses (z.B. „Oxygen XML Editor 17“).

Nach einem Neustart von Oxygen, sollten die Frameworks automatisch erkannt und aktiviert worden sein. Ist dies nicht geschehen, können Sie unter dem Punkt „Dokumententypzuordnung“ in den Oxygen-Einstellungen überprüfen, ob die Frameworks vorhanden und aktiv sind. Dort heißen die Frameworks „TEI-Oxydition: MinRProt – Edition“, „TEI-Oxydition: MinRProt – Register“, „TEI-Oxydition: MinRProt – Gesamtdatei“. Die Frameworks werden automatisch auf Dateien angewandt, die ihnen über den Dateinamen zugeordnet sind (siehe Dokumentation).

Beispielprojekt

Kopieren Sie den Ordner „MinRProt-Beispiel“ an eine beliebige Stelle auf ihrem System.

Öffnen Sie dann die Datei „MinRProt-Beispiel.xpr“ mit Oxygen. In der Projektansicht des Editors sind darauf die Inhalte des Projektordners angezeigt und durchsuchbar.

Um die (optionale) verbesserte Silbentrennung bei der PDF-Umwandlung zu aktivieren, öffnen Sie die Datei „fop-minrprot.xconf“ im Unterordner „Tools“ und ergänzen Sie in Zeile 4 im Element „<hyphenation-base>" den Pfad zum „MinRProt-Beispiel“-Ordner.

Für das Einrichten der Druckfunktion auf Nicht-Windows-Systemen, folgen Sie bitte der Anleitung in der Datei „README.txt“ im Unterordner „tools“ unter dem Punkt „Externen FOP konfigurieren“.

Java-Projekt

Um den Quellcode das Java-Projekt zu bearbeiten, importieren sie den Inhalt von „oxydition-operations“ in ein neues Projekt in Ihrer Java-Entwicklungsumgebung. Fügen Sie alle .jar-Dateien aus dem Unterordner „lib“ im Oxygen-Installationsverzeichnis zum Klassenpfad des Projekt hinzu. Hinweis: Die Quellcode-Dateien sind in UTF-8 kodiert.

Um Änderungen an den Java-Klassen nach Oxygen zu übertragen, exportieren die das Projekt als JAR-Datei namens „sdf.jar“. Kopieren Sie diese dann in den Unterordner „operations“ innerhalb der einzelnen Framework-Verzeichnisse.


Maximilian Schrott [zuletzt geändert: 16.12.2020]