Ü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).

ediarum baut auf zwei Programmen auf:

  • Oxygen XML Author: XML-Editor, mithilfe dessen die Editionstexte als XML-Dateien erstellt werden.
  • eXist-db: XML-Datenbank, in der die edierten XML-Dateien gespeichert werden.

In beiden Programmen ist es möglich, die Funktionalität zu konfigurieren und zu erweitern. Des Weiteren ist es möglich, diese Konfigurationen gebündelt an andere Programm-Instanzen weiterzugeben, zum Beispiel an alle Mitglieder Ihrer Arbeitsgruppe:

  • Im Oxygen XML Author kann man eigene GUI-Elemente für XML-Bearbeitungsfunktionen erstellen. Der Container, in dem diese Add-On-Funktionalitäten gespeichert werden, heißt im Oxygen XML Author "Framework" oder auch "Dokumenttyp-Zuordnung". Diese Dokumentation verwendet den Term "Framework".
  • In eXist-db kann man Webanwendungen mit Datenbankfunktionalitäten erstellen. Diese Webanwendungen heißen in eXist-db "Apps".
Nach erfolgreichem Basis-Setup von ediarum haben Sie mehrere solcher Oxygen-Frameworks und eXist-Apps sowie zwei "Projekte" in Ihrer lokalen Umgebung:

In Oxygen:

  • Frameworks:
    • ediarum.BASE.edit
    • ediarum.REGISTER.edit
    • meineEdition.edit
  • Projekt: Enthält die Konfiguration einer REST-Schnittstelle mit der Datenbank.

In eXist-db:

  • App: ediarum.DB
  • Projekt: Enthält ediarum-spezifische Datenhaltungsstrukturen und Datenbanksettings.

Das Einrichten der Komponenten erfolgt in folgender Reihenfolge:

  1. eXist-db und Oxygen XML Author installieren.
  2. eXist-db: Die App ediarum.DB einrichten und ein Projekt erstellen.
  3. Die WEBDAV-Verbindung zwischen eXist-db und Oxygen XML Author konfigurieren
  4. Oxygen XML Author: Die Frameworks ediarum.BASE.edit und ediarum.REGISTER.edit einrichten. Ein eigenes Framework meineEdition.edit anlegen, das ediarum.BASE.edit erweitert.
  5. Oxygen XML Author: Ein Projekt anlegen.