The Report Template Header

Each report template has to start with a header. This header has to be placed right at the beginning of your template. This implies that no space characters are allowed in front of the header.
A header has to consist of three parameters:

• targetType: specifies the format for the generated report. If you want to generate a DocBook set this parameter to "docbook". For all other formats, such as CSV or XML, the file extension of the format - e.g. "csv" or "xml" - has to be set as the target type.
• outputTypesIf set: Comma separated list of supported output formats (ASCII_DOCUMENT, DOCBOOK_XML, HTML_DOCUMENT, ODT_DOCUMENT, WORD_DOCUMENT, WORDML_DOCUMENT, PDF_DOCUMENT, ANALYSE_DOCUMENT, ...), all otherwise
• requiredFormatPaletteIf set: Only format templates will be provided that contain the given format palette in their properties.
• templateEncoding: Insert the character encoding that is been used by your text editor here. Most windows editors (Notepad, Wordpad, ConText, ...) use "Cp1252". Other valid values are e.g. "ISO-8859-1" and "UTF-8".
  "UTF-8" is the only encoding that allows using all unicode characters. Special characters may get lost with the other formats. We strongly recommend that all participants that work on the report template use text editors the same character encoding.
• targetEncoding: This parameter specifies the file encoding that will be used by the target document (the generated report). If you selected DocBook or any other XML format for your report this parameter has to be set to "UTF-8". For these cases a valid XML-header has to inserted below the header.
  If you selected any other target format this parameter has to be set to the corresponding encoding. For text documents and csv files the encoding is "Cp1252".
• cancelable: optional, set to true to allow cancelation; if true, $logger.checkForCancelation() or $logger.reportProgress(message) must be called frequently
• velocimacroMaxDepth: optional, defines the macro call depth
• directiveParseMaxDepth: optional, defines the depth for recursive #parse calls
• noEmptyLineAfterWordTables: optional, set to true to suppress empty lines after word tables
• noEmptyLineAtEndOfWordTableCells: optional, set to true to suppress empty lines at the end of word table cells
• allowMarkups: optional, set to true to support mark ups in docbook

A header sample can be found here.

Related Topics:
Tutorial: Creating individual Report Templatesn
Example Header (DocBook)
Example Header (other Formats)