Erstellen von HTML-Vorlagen

Erstellen von HTML-Vorlagen#

Sie können aus dem Wiki mit HTML/Freemarker-Vorlagen PDF-Dokumente erstellen. In diesem Abschnitt wird erklärt, wie Sie Text- und Metadaten aus Ihrem Wiki-Dokument mit einer HTML/Freemarker-Vorlage in ein PDF-Dokument konvertieren können.

HTML-Vorlage entwickeln#

Zur Entwicklung von HTML-Vorlagen genügt ein Webbrowser mit Debug-Funktionalität. Sie sollten Projekt-Administrator-Rechte haben oder als Systemmanager oder Systemadministrator angemeldet sein. Gehen Sie in der Verwaltung nach Vorlagen > Wiki-Exportvorlagen. Öffnen Sie den Ordner “HTML-Vorlagen” und darin den gewünschten Vorlagenordner.

Es ist am einfachsten, wenn Sie für die Entwicklung eigener Vorlagen von einer bestehenden ausgehen. Sie können die CSS-Stile direkt in Allegra ändern.

Die Vorlagen-Struktur#

Eine HTML-Vorlage besteht aus einer ZIP-Datei mit der Endung „.hlx“. Die Vorlage kann direkt im Wiki oder in der Verwaltung von dazu Berechtigten hochgeladen werden.

Die nächste Abbildung zeigt eine expandierte Vorlage. Die oberste Ebene muss die Template-Dateien enthalten und darf kein Ordner sein. Sie können dei Datei mit dem Befehl

zip -r ../Framed.hlx *

ausgeführt im Template-Verzeichnis erzeugen. Im folgenden werden die einzelnen Dateien und Ordner erklärt.

../_images/html-template1.PNG

Expandierte Vorlage#

  • {template name}.html: Beispiel: Framed.html. Die ZIP-Datei muss auf der obersten Ebene eine HTML-Vorlagendatei beinhalten, die den gleichen Basisnamen wie die ZIP-Datei hat. Heißt z.B. die ZIP-Datei “Framed.hlx”, muss sie eine Datei “Framed.html” beinhalten. Die HTML-Datei darf Freemarker-Ausdrücke enthalten, z.B.

  • {template name}.properties: Bespiel: Framed.properties. Dieses Element ist optional und enthält Parameter zur Steuerung der Anzeigeeigenschaften (siehe unten). Diese Datei kann FreeMarker-Ausdrücke enthalten.

  • Verzeichnis “resources”. Muss exakt so heißen. Verzeichnis enthält Bilder und andere Ressourcen .

  • Verzeichnis “fonts”. Muss exakt so heißen und enthält Fonts für die Erstellung eines PDF-Dokuments.

  • Eine oder mehrere CSS-Dateien

Die Vorlagen-Datei#

Die Vorlagendatei ist eine einfache XML-Datei mit Freemarker-Ausdrücken. Bitte stellen Sie sicher, dass die Vorlagendatei eine gültige xhtml-Datei ist (alle Tags sind geschlossen). Die Vorlagendatei und der Vorlagenname müssen identisch sein. Die Erweiterung muss .html sein. Diese Datei kann Freemarker-Ausdrücke enthalten. Alle Dokumentfelder können durch Eingabe des eindeutigen Feldnamens als Freemarker-Ausdrücke verwendet werden. Auf die Feldnamen kann zugegriffen werden über Perspektive Verwaltung > Anpassen > Vorgangsattribute oder in der Vorgangsübersicht über die Spaltenauswahl.

Zusätzlich gibt es noch einige weitere Freemarker-Variablen:

  • cssBasePath: der absolute Pfad zum Vorlagen-Verzeichnis. Beispiel: href = „${cssBasePath}/base.css“

  • imgBasePath: der absolute Pfad des resource-Verzeichnisses vom Vorlagen-Verzeichnis aus gesehen. Beispiel: ${imgBasePath}/allegraLogo.png

  • summary: die Zusammenfassung (Inhaltstabelle) des Dokuments

  • wikiContent: der Inhalt des Wiki-Dokuments ohne Zusammenfassung

  • pageLbl: das lokalisierte Wort „Seite“

  • ofLbl: das lokalisierte Wort „von“ (Seite 1 von 17 oder Seite 1 / 17)

  • IssueNo: Die ID des Dokuments (global oder bereichsspezifisch)

  • parentSynopsis: Der Titel des übergeordneten Vorgangs, falls vorhanden

  • timeStamp: Zeitpunkt der Erstellung des PDF-Dokuments

  • licenseHolder: Name des Lizenzinhabers

  • locale: das Gebietsschema des Benutzers

Die Vorlagen-Konfigurationsdatei#

Wenn das Vorlagenverzeichnis eine Datei {templateName}.properties enthält, wird sie vom System verwendet. Die Datei ist optional. Sie kann Freemarker-Ausdrücke enthalten. Alle Dokumentfelder können als Freemarker-Ausdrücke verwendet werden. Verfügbare Konfigurationen sind:

  • contentMaxWidth: Eine Ganzzahl in Pixel. Ist das „width“-Attribut eines Bildes oder einer Tabelle größer als dieser Wert, wird das entsprechende Objekt skaliert.

  • watermarkImgName: Der Name einer Bilddatei, deren Bild als Wasserzeichen verwendet werden soll

  • watermarkText: Dieser Text wird auf jeder Seite mittig und evtl. gedreht als Wasserzeichen dargestellt

  • watermarkTextSize: in Punkten (Points)

  • watermarkTextColor: Farbe in Hex-Notation

  • watermarkTextRotation: Drehung. 0 ist horizontal, 90 ist vertikal.

Alle Felder sind optional. Wenn sowohl watermarkImgName wie auch watermarkText definiert sind, hat `` watermarkImgName`` Priorität.

Inhalt