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.

Eine "Editorvariable" ist eine generische Angabe in dem Tool Oxygen XML "Editor" (oder Oxygen XML Author). Oxygen XML Author speichert diese Einstellungen in einer Datei mit der Endung XPR. Im Anschluss an das Basis-Setup dient das "Projekt" später als Container für weitere editionsspezifische Konfigurationen.

Tipp: Diese Anleitung beschreibt das manuelle Einrichten eines Oxygen-Projekts. Alternativ können Sie auch die ediarum-Vorlage für editionsspezifische Frameworks (inkl. Projektdatei) benutzen. Sie finden diese unter https://github.com/ediarum/ediarum.BASE.template.
  1. Wählen Sie Projekt > Neues Projekt aus.
  2. Wählen Sie im nun geöffneten Neues Projekt-Fenster den Eintrag Voreingestelltes Projekt aus und geben Sie einen Namen für die Projektdatei ein (zum Beispiel: meineEditon.xpr). Vergeben Sie anschließend im Feld Projektverzeichnis mit Hilfe des Ordner-Symbols den Speicherort Ihres editionsspezifischen Frameworks.
  3. Legen Sie fest, dass die Editorvariablen im Projekt gespeichert werden:
    1. Wählen Sie das Menü Optionen > Einstellungen.
    2. Wählen Sie im nun geöffneten Einstellungen-Fenster den Eintrag Benutzerspezifische Editorvariablen aus.
    3. Aktivieren Sie die Option Projekt-Optionen und klicken Sie auf Anwenden.
    Der Eintrag Benutzerspezifische Editorvariablen ist jetzt mit einem [P] gekennzeichnet und fett dargestellt.
  4. Klicken Sie auf Neu und tragen Sie im nun geöffneten Editorvariablen-Fenster die Editorvariablen ${ediarum_project_name} und ${ediarum_project_domain} samt Werten ein.
    Hinweis: Die Beschreibung der Editorvariable ist optional.
    Name: ${ediarum_project_name} Der Wert muss mit dem in eXist-db festgelegten Projektnamen übereinstimmen. Wert: (Beispiel) meineEdition
    Name: ${ediarum_project_domain}

    Basis-URL zur Datenbank. Der Wert muss Domain, ggf. Server-Port und Server-Anmeldedaten enthalten.

    Als User sollte der vordefinierte User "Oxygen-Bot" verwendet werden, da dieser alle notwendigen Rechte besitzt, um von Oxygen aus auf die ediarum-Schnittstellen (z.B. ins Register) zuzugreifen.

    		Wert: (Beispiel; bitte geben Sie an Stelle von ****** das Passwort für den angelegten User (hier "Oxygen-Bot" an) http://oxygen-bot:******@example.de:8028
    Beispiel: Eingabefenster für die Editorvariable ediarum_project_name
  5. Klicken Sie auf Anwenden und OK.
  6. Prüfen Sie, ob folgende Editorvariablen für die Datenbankverbindung passend zu Ihrer Infrastruktur gesetzt sind.
    Name: ${ediarum_projects_directory} Pfad zu den Projektordnern in der eXist-DB via REST-Verbindung.

    Wert: (Standard) /exist/rest/db/projects/

    Anstelle von exist ggf. eine andere Angabe, z.B. ediarum
    Name: ${ediarum_projects_directory_webdav} Pfad zu den Projekt-Ordnern in der eXist-DB via WebDAV-Verbindung.

    Wert: (Standard) /exist/webdav/db/projects/

    Anstelle von exist ggf. eine andere Angabe, z.B. ediarum
  7. Ergänzen Sie folgende Editorvariablen, die für bestimmte Standard-ediarum-Aktionen benötigt werden.
    Name: ${ediarum_id} Pfad zur idGenerator.xql für automatische Generierung der IDs.

    Wert: (Standard) ${xpath_eval(doc('${ediarum_project_domain}${ediarum_projects_directory}/${ediarum_project_name}/oxygen/ediarum_idGenerator.xql')//new-id/text())}
    Name: ${ediarum_manual_url} URL zum offiziellen ediarum-Handbuch.

    Wert: (Standard) https://www.ediarum.org/docs/ediarum.BASE.manual/
    Name: ${ediarum_getGeoname} Pfad zur getGeoname.xql für Suchen in Geonames aus ediarum heraus.

    Wert: (Standard) /oxygen/getGeoname.xql
  8. Klicken Sie auf Anwenden und OK.
Wenn Sie das Dokument-Template aus dem ediarum.BASE.edit-Framework öffnen (Datei > Öffnen... > .../frameworks/ediarum.BASE.edit/templates, werden im Autor-Modus die ediarum-spezifischen Schaltflächen angezeigt. Sie können nun Dokumente und Briefe edieren und mit den aktivierten Registern arbeiten.