Der Berichtsvorlagen-Header
Jede Berichtsvorlage muss mit einem Header beginnen. Dieser muss in der
ersten Zeile der Vorlage beginnen. Es dürfen sich demnach keine Leerzeilen vor
dem Header befinden.
Ein Header muss aus drei Parametern bestehen.
- targetType legt das Format für den generierten
Bericht fest. Möchten Sie ein DocBook
generieren, wählen Sie den Typ "docbook". Für alle anderen Formate, wie
z. B. XML oder CSV tragen Sie als Wert die Dateiendung
für dieses Format ein - also z. B. "xml" oder "csv".
- outputTypesFalls gesetzt: Komma-getrennte Liste, welche Ausgabetypen unterstützt werden (ASCII_DOCUMENT, DOCBOOK_XML, HTML_DOCUMENT, ODT_DOCUMENT, WORD_DOCUMENT, WORDML_DOCUMENT, PDF_DOCUMENT, ANALYSE_DOCUMENT, ...), sonst alle
- requiredFormatPaletteFalls gesetzt: Es werden nur Formatvorlagen angeboten, bei denen die hier angegebene Formatpalette in deren Eigenschaften eingetragen ist.
- templateEncoding: Tragen Sie hier die
Zeichenkodierung ein, die Ihr Texteditor verwendet. Die meisten
Windows-Editoren (Notepad, Wordpad, Context, ...) verwenden "Cp1252".
Andere gültige Werte sind z. B. "ISO-8859-1" und "UTF-8".
Nur mit "UTF-8" können Sie alle Unicode Zeichen nutzen. Bei allen
anderen Formaten können Sonderzeichen verloren gehen. Wenn Sie sich
mit weiteren Projektbeteiligten über Ihre Berichtsvorlage austauschen
wollen, sollten Sie darauf achten, dass alle Beteiligten die gleiche
Zeichenkodierung verwenden.
- targetEncoding: Dieser Paramter gibt an, welche
Dateikodierung das Zieldokument verwendet. Haben Sie als Format für Ihre
Berichte "docbook" oder ein anderes XML-Format (wie z.B. "xml") gewählt,
muss dieser Wert auf "UTF-8" gesetzt werden. Zusätzlich muss in diesen
Fällen ein gültiger XML-Header unter den Vorlagen-Header eingefügt
werden.
Entscheiden Sie sich für ein anderes Zielformat, dann müssen Sie die
entsprechende Kodierung wählen. Für Textdokumente und CSV-Dateien wäre
dies z. B. "Cp1252".
- cancelable: optional, auf true setzen ermöglicht dem Nutzer die Berichtsvorstufe abzubrechen; damit das Abbrechen
Effekt hat, muss in der Berichtsvorlage regelmäßig $logger.checkForCancelation() bzw. $logger.reportProgress(message) aufgerufen werden
- velocimacroMaxDepth: optional, legt die maximale Aufruftiefe für Makros fest
- directiveParseMaxDepth: optional, legt die maximale Aufruftiefe für #parse-Aufrufe fest
- noEmptyLineAfterWordTables: optional, auf true setzen, um Leerzeilen nach Word-Tabellen zu unterdrücken
- noEmptyLineAtEndOfWordTableCells: optional, auf true setzen, um Leerzeilen am Ende von Word-Tabellenzellen zu unterdrücken
- allowMarkups: optional, auf true setzen, um Mark-Up-Konstrukte in DocBook zu unterstützen
Einen Beispiel-Header finden Sie hier.
Verwandte Themen:
Anleitung: Erstellen eigener Berichtsvorlagen
Beispiel-Header (DocBook)
Beispiel-Header (andere Formate)