ediarum-Frameworks einrichten

Sie machen die ediarum-Funktionalitäten in Ihrer Oxygen-Editionsumgebung verfügbar, indem Sie zwei ediarum-spezifische Oxygen-"Frameworks" einbinden.

Überblick über den Ablauf:

  • Sie laden sich die beiden ediarum-Frameworks auf Ihren lokalen Rechner.
  • Sie ändern den Standardordner, in dem Oxygen XML Author die Frameworks verwaltet. Dadurch vermeiden Sie Probleme mit Zugriffsrechten seitens des Betriebssystems (insbesondere Windows).
  • Sie legen ein eigenes Framework für Ihre Edition an. Sie legen dieses Framework als eine Erweiterung des ediarum.BASE.edit-Frameworks an, damit Sie alle Funktionalitäten von ediarum zur Verfügung haben. Nach Abschluss des Basis-Setups können Sie in diesem Framework Ihre eigenen Konfigurationen der Editionsumgebung speichern.

Benötigtes Vorwissen:

  • Grundverständnis von GitHub
  1. Legen Sie in Ihrem lokalen Dateisystem einen Ordner für alle Frameworks an.
  2. Laden Sie sich die folgenden GitHub-Repositorien in den Ordner, den Sie gerade angelegt haben (in GitHub: Button Latest release, dann gezippte Datei lokal speichern und entpacken):
    1. https://github.com/ediarum/ediarum.BASE.edit/releases
    2. https://github.com/ediarum/ediarum.REGISTER.edit/releases
  3. Legen Sie in dem Ordner zusätzlich gleich ein Verzeichnis an, in das Sie später Ihr editionsspezifisches Framework legen können.
    Empfehlung: Behalten Sie im Namen des Ordners ediarum als ersten Teil bei, um kenntlich zu machen, dass Ihr editionsspezifisches Framework eine Erweiterung von ediarum ist. Zum Beispiel: ediarum.meineEdition.edit.
    Tipp: Auf GitHub finden Sie eine Vorlage für ein editionsspezifisches Framework-Verzeichnis, welches bereits erste Beispielkomponenten oder Platzhalter beinhaltet. (https://github.com/ediarum/ediarum.BASE.template)
  4. Stellen Sie sicher, dass der Framework-Ordner folgende Struktur hat:
    • frameworks
      • ediarum.BASE.edit
        • css
        • fonts
        • icons
        • resources
        • schemata
        • templates
      • ediarum.REGISTER.edit
        • css
        • resources
        • schema
      • ediarum.meineEdition.edit
  5. Ändern Sie in Oxygen den Speicherort für Frameworks, sodass der Speicherort auf den Ordner verweist, der alle Framework-Ordner enthält:
    1. Wählen Sie in Oxygen das Menü Optionen > Einstellungen aus.
    2. Wählen Sie im nun geöffneten Einstellungen-Fenster den Eintrag Dokumenttypen-Zuordnung > Orte aus.
    3. Aktivieren Sie die Option Benutzerdefiniert.
    4. Benutzen Sie das Ordner-Icon, um den Pfad auszuwählen.
  6. Klicken Sie auf OK, um das Einstellungen-Fenster zu schließen.
  7. Starten Sie Oxygen XML Author neu.

    Unter Optionen > Einstellungen > Dokumenttypen-Zuordnung werden die zwei ediarum-Frameworks angezeigt.

  8. Legen Sie das Erweiterungsframework für Ihre Edition an.
    1. Wählen Sie im Fenster Dokumenttypen-Zuordnung das ediarum.BASE.edit Framework aus (nicht doppelklicken!) und klicken Sie auf Erweitern.
    2. Geben Sie im Feld Name: den Namen für Ihr editionsspezifisches Framework ein.
      Empfehlung: Verwenden Sie denselben Namen, den Sie dem editionsspezifischen Ordner in Ihrem Dateisystem gegeben haben. Zum Beispiel: ediarum.meineEdition.edit
    3. Aktivieren Sie für Speicherort: die Option Extern.
    4. Geben Sie den Pfad bis zu der .framework-Datei an, die innerhalb Ihres Editionsordners liegt. Zum Beispiel: ediarum.meineEdition.edit/ediarum.meineEditon.edit.framework. Benutzen Sie das Ordner-Icon, um die Datei auszuwählen.
  9. Klicken Sie auf OK, um das Einstellungen Fenster zu schließen.