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.
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.
ediarum.DB App installieren
Über das Dashboard der eXist-db installieren Sie ediarum.DB mithilfe der XAR-Datei. Danach enthält Ihre Datenbank einige grundlegende Funktionen und Zugriffs-Einstellungen und Sie können die ediarum.DB-App verwenden.

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.
  - ediarum.DB App installieren
    Über das Dashboard der eXist-db installieren Sie ediarum.DB mithilfe der XAR-Datei. Danach enthält Ihre Datenbank einige grundlegende Funktionen und Zugriffs-Einstellungen und Sie können die ediarum.DB-App verwenden.
  - Projekt in der Datenbank anlegen
    In der Datenbank muss für Ihre Edition ein Projekt mit einer standardisierten Ablagestruktur und einigen standardisierten Settings vorhanden sein. Um die Standards automatisiert korrekt anzulegen, benutzen Sie die ediarum.DB-App.
  - ediarum-Register aktivieren
    Sie aktivieren die mitgelieferten Personen- und Ortsregister, die typischerweise in einer Edition benötigt werden. Sie haben die Möglichkeit, zusätzlich weitere ediarum-Standardregister zu aktivieren: Sachbegriffe, Körperschaften, Werke, Briefe, Anmerkungen.
  - Nutzer-Account anlegen
    Die Nutzer-Accounts in der ediarum.DB-App sind Voraussetzung, damit die Editor:innen ihre Oxygen-Instanzen mit der eXist-db verbinden können.
- 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.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.DB App installieren

Über das Dashboard der eXist-db installieren Sie ediarum.DB mithilfe der XAR-Datei. Danach enthält Ihre Datenbank einige grundlegende Funktionen und Zugriffs-Einstellungen und Sie können die ediarum.DB-App verwenden.

Klicken Sie auf der Webseite https://github.com/ediarum/ediarum.DB/releases auf den Button Latest Release und speichern Sie die Datei ediarum.db-〈version〉.xar lokal ab.
Melden Sie sich im Dashboard Ihrer eXist-db mit Admin-Rechten an.
Öffnen Sie die Package Manager-App.
Ziehen Sie die gespeicherte Datei ediarum.db-〈version〉.xar in die Dropzone. Oder: Klicken Sie auf Upload und wählen Sie die XAR-Datei über den Dateiexplorer aus. Schließen Sie das Fenster Package Manager anschließend, indem Sie auf Launcher klicken.

Im Dashboard sehen Sie nun die ediarum.DB-App.
In Ihrer eXist-db wurde nun Folgendes eingerichtet:
- Nutzer-Gruppen: website, oxygen
- Nutzer: exist-bot (Passwort: exist-bot), oxygen-bot (Passwort: oxygen-bot), website-user (Passwort: website-user)
  - Achtung: Denken Sie unbedingt daran, die Default-Passwörter für die Bots zu ändern!
- Zugriffsrechte zu benötigten Verzeichnissen und Prozessen