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 updaten
Sie erstellen eine aktualisierte Version Ihres Add-Ons, spielen dieses aus und aktualisieren das Add-On auf den nutzenden Rechnern.

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 updaten

Sie erstellen eine aktualisierte Version Ihres Add-Ons, spielen dieses aus und aktualisieren das Add-On auf den nutzenden Rechnern.

Erstellen Sie eine aktualisierte Version Ihres Frameworks.

Erstellen Sie eine neue Add-On-(ZIP-)Datei mit den aktualisierten Framework-Dateien. Verfahren Sie dazu wie beim Erstellen eines Add-Ons. Die ZIP-Datei muss eine höhere Versionsnummer als die vorherige Version erhalten, z.B. ediarum.MeineEdition.edit_v1-5-3.zip.

Passen Sie die update.xml an folgenden Stellen an:


Name des Elements	Beschreibung	Was ist zu ändern?
xt:location	Name der aktuellen ZIP-Datei des Add-Ons	Passen Sie die Versionsnummer im Namen der ZIP-Datei an.
xt:version	Version des aktuellen Add-Ons	Passen Sie die Versionsnummer an.
xt:description	Beschreibung des Add-Ons als HTML für die Darstellung in Oxygens Update-Fenster.	Falls Sie hier ein Changelog führen, sollte dieses natürlich ergänzt werden.

Laden Sie die neue ZIP- und die aktualisierte update.xml-Datei in das Verzeichnis, in dem bereits die vorherige Version Ihres Add-Ons lag und dessen URL zur Installation des Add-Ons in Oxygen verwendet wurde.
Durch das Aktualisieren der update.xml-Datei mit einer höheren Versionsnummer im Feld xt:version wird Oxygen automatisch ein Update des Add-Ons anstoßen.
Führen Sie das Update in Oxygen durch.
1. Öffnen Sie Hilfe > Auf Add-On Updates überprüfen....
  Falls eingestellt, wird Oxygen Sie automatisch auf das Update hinweisen. Folgen Sie der Anweisung auf dem Bildschirm, um das oben genannte Update-Fenster automatisch zu öffnen.
2. Überprüfen Sie, dass das Häkchen am zu updatenden Add-On gesetzt ist und die richtige Version in der Spalte "Status" angezeigt wird.
3. Klicken Sie anschließend auf Aktualisieren.
  
  Abbildung 1. Auswahlfenster für vorhandene Updates.
4. Akzeptieren Sie die Lizenzerklärung und klicken Sie dann auf Abschließen.
5. Falls Sie dem Add-On keine offizielle Signatur gegeben haben, können Sie das folgende Hinweisfenster mit Trotzdem fortsetzen bestätigen.
6. Nach dem Update werden Sie aufgefordert, Oxygen neu zu starten.

Sie haben eine aktualisierte Version Ihres Frameworks als Add-On verpackt und an alle User ausgespielt, die dieses Add-On installiert haben.