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.
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.
Ein Add-On installieren
Sie installieren ein bereitgestelltes benutzerspezifisches Framework als Add-On im Oxygen XML Author.

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.
- 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.
  - Ein Add-On erstellen
    Sie erstellen aus Ihrem benutzerspezifischen Framework ein Add-On und stellen dieses für andere User zur Verfügung.
  - Ein Add-On installieren
    Sie installieren ein bereitgestelltes benutzerspezifisches Framework als Add-On im Oxygen XML Author.
  - Ein Add-On updaten
    Sie erstellen eine aktualisierte Version Ihres Add-Ons, spielen dieses aus und aktualisieren das Add-On auf den nutzenden Rechnern.
  - Ein Add-On entfernen
    Sie deinstallieren ein nicht mehr benötigtes Framework von Ihrem Rechner.
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.

Ein Add-On installieren

Sie installieren ein bereitgestelltes benutzerspezifisches Framework als Add-On im Oxygen XML Author.

Das Framework muss als ZIP-Datei verpackt und gemeinsam mit einer XML-Datei zum Update bereitgestellt sein.

Öffnen Sie in Oxygen das Fenster Hilfe > Neue Add-Ons installieren...
Geben Sie im Feld Add-Ons zeigen von: die URL zu Ihrer update.xml ein.
HINWEIS: Wenn Sie statt "update" einen anderen Namen für Ihre XML-Datei gewählt haben, müssen Sie hier diesen Namen angeben.
Haken Sie die Box neben dem Namen des Add-Ons an und klicken Sie dann auf Weiter.

Abbildung 1. Auswahlfenster für neue Add-Ons
Akzeptieren Sie die Bestimmungen zur Lizenzerklärung per Klick auf die Box und fahren Sie mit Installieren fort.
1. Falls Sie dem Add-On keine offizielle Signatur gegeben haben, können Sie das folgende Hinweisfenster mit Trotzdem fortsetzen bestätigen.
Nach der Installation werden Sie aufgefordert, Oxygen neu zu starten.
Nach dem Neustart ist das Add-On installiert. Überprüfen Sie, ob das Framework geladen ist und die höchste Priorität unter den aktiven Frameworks hat. Öffnen Sie Optionen > Einstellungen... > Dokumenttypen-Zuordnungen und aktivieren Sie das gewünschte Framework bzw. deaktivieren Sie nicht benötigte Frameworks. Bestätigen Sie die Änderungen anschließend mit OK.
Falls das Framework eine Projektdatei verwendet, kann es sein, dass Sie diese noch öffnen müssen. Siehe Tipp: Die Projektdatei laden.

Sie haben ein Framework als externes Add-On installiert.