Grundlegende Einrichtung von ediarum.PDF im Projekt

Sie richten ediarum.PDF mit den Basiseinstellungen in Ihrem Projekt ein und legen so die Grundlage für weitere projektspezifische Anpassungen der PDF-Ausgabe.

Es muss ediarum.BASE und ein Projekt (Projektdatei .xpr) in Oxygen eingerichtet sein.
  1. Kopieren Sie die Datei pdf_print_project.xsl aus ediarum.BASE.edit/ressources und fügen Sie sie in den ressources-Ordner Ihres Frameworks ein.
  2. Öffnen Sie die kopierte Datei und überprüfen Sie folgende projektspezifische Pfade:
    1. Stellen Sie sicher, dass im Abschnitt "Project - Einbindungen" der Pfad auf die pdf_print.xsl im BASE-Framework ediarum.BASE.edit/resources/pdf_print.xsl richtig angegeben ist. (Bei einer standardmäßigen ediarum-Installation lautet der relative Pfad "../../ediarum.BASE.edit/resources/pdf_print.xsl".
      Bei einer standardmäßigen ediarum-Installation sollte das Framework-Verzeichnis wie folgt aussehen:
      • frameworks
        • ediarum.BASE.edit
          • css
          • fonts
          • icons
          • resources
          • schemata
          • templates
        • ediarum.meineEdition.edit
          • css
          • resources
          • schema

      Siehe: ediarum-Frameworks einrichten

    2. Überprüfen Sie den Parameter p_pathToOxygen. Dieser muss die URL zum oxygen-Verzeichnis Ihrer eXist-Datenbank enthalten. Die Verbindung wird für das Einbinden von Registerdaten in das fertige PDF benötigt. Standardmäßig können hier benutzerspezifische Editorvariablen, welche Sie in Ihrer Oxygen-Projektdatei definieren, verwendet werden.
      Siehe Projekt im Oxygen XML Author anlegen
    3. optional: Überprüfen Sie den Parameter p_pathToRegister. Dieser muss die URL zum web/register-Verzeichnis Ihrer eXist-Datenbank enthalten. Die Verbindung wird für das Verlinken von Registerdaten aus dem fertigen PDF benötigt. Standardmäßig können hier benutzerspezifische Editorvariablen, welche Sie in Ihrer Oxygen-Projektdatei definieren, verwendet werden.
      Siehe Projekt im Oxygen XML Author anlegen
  3. Öffnen Sie über Optionen > Einstellungen... > Dokumenttypen-Zuordnung die Einstellungen Ihres projektspezifischen Frameworks und wählen Sie den Reiter Transformation.
    Abbildung 1. Transformationsszenarien des Frameworks


  4. Duplizieren Sie das Transformationsszenario ediarum.BASE.pdf_xsl mit Hilfe des Buttons unter dem Auswahlfenster. Das Szenario ist für die Transformation des XML-Ausgangsdokuments in das temporäre HTML-Dokument zuständig.
  5. Passen Sie die Einstellungen im sich öffnenden Fenster an.
    Abbildung 2. Transformationsszenario XML -> HTML


    1. Ändern Sie den Namen des Szenarios entsprechend Ihrem Framework, z.B. ediarum.meineEdition.pdf_xsl.
    2. Ersetzen Sie im Feld XSL URL die Editorvariable ${baseFramework} durch ${framework}, damit das XSLT-Skript pdf_print_project.xsl aus Ihrem Framework-Verzeichnis statt dem ediarum.BASE.edit-Verzeichnis verwendet wird.
    3. Schließen Sie das Fenster anschließend mit dem Button OK.
  6. Schalten Sie das soeben erstellte Transformationsszenario aktiv, indem Sie das Häkchen daneben setzen.
  7. Öffnen Sie nun den Reiter Autor > Aktionen.
  8. Suchen Sie die ediarum.BASE-Aktion "PDF erstellen" (ID: printPDF) heraus und duplizieren Sie diese.
  9. Bearbeiten Sie die duplizierte Version der Aktion "PDF erstellen".
    Durch das Duplizieren der Aktion bleibt die PDF-Generierung mit den Standardeinstellungen von ediarum.BASE erhalten und kann auch weiterhin in die Nutzeroberfläche eingebunden und genutzt werden. Ein Überschreiben der Standard-Aktion kann zudem zu Problemen bei späteren Updates von ediarum.BASE.edit führen.
    1. Wählen Sie passende Werte für die Felder ID,Name und (optional) Beschreibung.
    2. Ersetzen Sie im Argument scenarioNames den Wert ediarum.BASE.pdf_xsl durch den Namen des zuvor von Ihnen erstellten Transformationsszenarios, z.B. ediarum.meineEdition.pdf_xsl
    3. Bestätigen Sie die Änderungen mit dem Button OK.
    Abbildung 3. Einstellungen für die projektspezifische Aktion "PDF erstellen".


  10. Öffnen Sie den Reiter Autor > Kontextmenü.
  11. Fügen Sie die zuvor erstellte projektspezifische Aktion "PDF erstellen" in das Kontextmenü ein.
    • Sie können entweder die Standard-Funktion "PDF erstellen" löschen, wenn Ihren Nutzer*innen nur die projektspezifische PDF-Generierung zur Verfügung stehen soll.
    • Oder sie lassen die Standard-Funktion "PDF erstellen" und die projektspezifische angepasste Funktion (z.B. "PDF erstellen (meineEdition)") parallel in der Nutzeroberfläche, um Ihren Nutzer*innen das Ausführen von beiden Varianten der PDF-Generierung zu ermöglichen.
    Selbstverständlich können Sie die Aktionen statt im Kontextmenü auch an anderen Stellen der Benutzeroberfläche einfügen.
  12. Schließen Sie die beiden offenen Fenster jeweils mit dem Button OK.
Sie haben eine projektspezifische Variante von ediarum.PDF eingerichtet und können diese im Folgenden weiter anpassen.