Startseite
Basis-Setup
Das Basis-Setup macht mit ediarum eine Arbeitsumgebung für wissenschaftliche Editionen verfügbar. Nach erfolgreichem Setup können Editor:innen in dieser visuellen, Word-ähnlichen Umgebung TEI-konforme XML-Daten mit Registern, Kommentaren u.ä. erstellen.
Arbeitsumgebung in Oxygen XML Author einrichten
Sie verbinden Oxygen XML Author mit eXist-db (Datenbank) und machen alle in ediarum enthaltenen Funktionalitäten verfügbar.
ediarum-Register mit Oxygen-Projekt verknüpfen
Für das Register-Lookup ist eine eigene Datenbankverbindung nötig, die mithilfe von Editorvariablen in einem Oxygen-Projekt hinterlegt wird.

Basis-Setup
Das Basis-Setup macht mit ediarum eine Arbeitsumgebung für wissenschaftliche Editionen verfügbar. Nach erfolgreichem Setup können Editor:innen in dieser visuellen, Word-ähnlichen Umgebung TEI-konforme XML-Daten mit Registern, Kommentaren u.ä. erstellen.
- Über diese Anleitung
  Das Basis-Setup macht ediarum zunächst in der Standardvariante verfügbar, ohne besondere Konfigurationen für Ihr Editionsprojekt und ohne dass Sie Programmierkenntnisse benötigen.
- Überblick über das Basis-Setup
  ediarum steht auf github zur Verfügung, in Form von Konfigurationskomponenten für den Oxygen XML Author (den sogenannten Frameworks) und für die XML-Datenbank eXist-db (den sogenannten Apps).
- Installationstipps eXist-db und Oxygen
  Die Installationsanleitungen für eXist-db und Oxygen finden Sie auf deren Webseiten. Die hier versammelten zusätzlichen Tipps basieren auf der Erfahrung der ediarum-Entwickler:innen und können bei typischen Installationsproblemen hilfreich sein.
- Datenbank einrichten
  Sie installieren sich die eXist-App ediarum.DB. Mithilfe dieser App generieren Sie in Ihrer Datenbank ein eigenes Projekt, das alle benötigten Settings für das Zusammenspiel von Datenbank und Oxygen XML Author enthält.
- Arbeitsumgebung in Oxygen XML Author einrichten
  Sie verbinden Oxygen XML Author mit eXist-db (Datenbank) und machen alle in ediarum enthaltenen Funktionalitäten verfügbar.
  - Oxygen mit der Datenbank verbinden
    Sie konfigurieren die Verbindung für den Lese- und Schreibzugriff von der Eingabeoberfläche auf die XML-Dateien. Die WebDAV-Verbindung verhindert Schreibkonflikte zwischen verschiedenen Benutzer:innen.
  - ediarum-Frameworks einrichten
    Sie machen die ediarum-Funktionalitäten in Ihrer Oxygen-Editionsumgebung verfügbar, indem Sie zwei ediarum-spezifische Oxygen-"Frameworks" einbinden.
  - Projekt im Oxygen XML Author anlegen
    In einem Oxygen-Projekt werden sogenannte "Editorvariablen" hinterlegt, die für die Verbindung von ediarum und Oxygen-Aktionen nötig sind.
  - ediarum-Register mit Oxygen-Projekt verknüpfen
    Für das Register-Lookup ist eine eigene Datenbankverbindung nötig, die mithilfe von Editorvariablen in einem Oxygen-Projekt hinterlegt wird.
- ediarum.DB App updaten
  Über das Dashboard der eXist-db können Sie ediarum.DB mithilfe der XAR-Datei updaten/downgraden.
- Ein externes Add-On updaten
  Sie überprüfen Ihre in Oxygen installierten Add-Ons (z.B. ediarum.BASE.edit oder ediarum.REGISTER.edit) auf Updates.
- Grundlagen und Funktion von ediarum.PDF
  ediarum.PDF ist ein in ediarum.BASE.edit integriertes Feature, um direkt aus der Arbeitsoberfläche von Oxygen XML heraus XML-Dokumente als PDF auszugeben.
- Framework als Add-On erstellen und installieren
  Sie speichern das erstellte Framework als Add-On, um es auf anderen Rechnern installieren und zentral updaten zu können.
Editionsspezifische Konfiguration
Wenn für Ihre Edition ein umfassenderes XML-Schema benötigt wird als das mit ediarum abgedeckte, können Sie das Schema und die Arbeitsumgebung erweitern. Sie können außerdem zusätzliche Register erstellen.
Tipps und Fehler
Einige Tipps und Lösungshilfen zu häufig auftretenden Fehlermeldungen.

ediarum-Register mit Oxygen-Projekt verknüpfen

Für das Register-Lookup ist eine eigene Datenbankverbindung nötig, die mithilfe von Editorvariablen in einem Oxygen-Projekt hinterlegt wird.

Die einzubindenden Register müssen in ediarum angelegt sein. (siehe: ediarum-Register aktivieren)

Für das Basis-Setup von ediarum müssen mindestens die für das Register-Lookup benötigten Editorvariablen im Projekt gespeichert werden. Diese sorgen dafür, dass die Daten im ediarum-Register auch vom Oxygen XML Editor bzw. Oxygen XML Author abgerufen werden können.

Stellen Sie sicher, dass die richtige Projektdatei (.xpr) in Oxygen geöffnet ist. (Ggf. müssen Sie über Projekt > Projekt öffnen... die richtige Datei auswählen.)
Wählen Sie nun Optionen > Einstellungen > Benutzerspezifische Editorvariablen [P].

Erstellen Sie mit Neu eine neue Editorvariable.

Abbildung 1. Fenster für den neuen Eintrag einer benutzerspezifischen Editorvariable

Tabelle 1. Werte der Editorvariable zur Einbindung verschiedener Register
ediarum-Register	Name	Wert
Personenregister	ediarum_index_person	/oxygen/ediarum.xql?index=persons
Ortsregister	ediarum_index_place	/oxygen/ediarum.xql?index=places
Sachbegriffe	ediarum_index_item	/oxygen/ediarum.xql?index=items
Körperschaftsregister	ediarum_index_org	/oxygen/ediarum.xql?index=organisations
Werkregister	ediarum_index_bibl	/oxygen/ediarum.xql?index=bibliography
Briefregister	ediarum_index_letters	/oxygen/ediarum.xql?index=letters
Anmerkungsregister	ediarum_index_comments	/oxygen/ediarum.xql?index=comments

ACHTUNG: Falls Sie das ediarum-Register auf mehrere Dateien aufgeteilt haben (Registeraufbau: Register nach Buchstaben getrennt), müssen Sie an den Wert der Editorvariable folgendes anhängen: &letter=${ask('Buchstabe A-Z', generic, '')}, also z.B. für das Personenregister: /oxygen/ediarum.xql?index=persons&letter=${ask('Buchstabe A-Z', generic, '')}.

Schließen Sie das "Einstellungen"-Fenster abschließend mit OK.

Sie können nun über Aktionen aus Oxygen heraus auf eingerichtete ediarum-Register zugreifen und in Texten auf Registereinträge verlinken. Hinweis: Bitte beachten Sie, dass Sie zuerst einen Eintrag im Register anlegen müssen, bevor Sie in Texten darauf verlinken können.