OutputMode setting

This section describes the OutputMode setting.

 OutputMode

Optional, string.

The OutputMode specifies the type of output document produced by the ITPRun command.

The following formats are currently supported:

  • native produces a document in the same format as the template.
  • utf8 produces text in UTF-8 encoding.
  • utf16 produces text in UTF-16 encoding.
  • aiadocxml produces an XML file representing the structure of the result document. This structure is based on the Content Wizards used in the document.
  • pack produces a Document Pack. If the template is a Document Template, it is treated as a Document Pack Template. The produced Document Pack will have a single slot containing the result of that template.

The default is native.

A template can query the OutputMode parameter by calling the function runmodel_setting("OutputMode").

The following Template scripting language functions are prohibited if the OutputMode is set to something other than native:

  • add_to_output
  • footers
  • headers
  • inc
  • pagestyle
  • paper_types
  • put_buffer_in_document
  • put_in_document
  • put_in_text_file
  • put_in_text_file2
  • stylesheet

In the OutputMode XML, the template is not allowed to produce any output. This restriction also prohibits the use of #...# and the TEXTBLOCK statement (unless it uses the ASSIGN_TO keyword).

The OutputMode setting is available in KCM Core 4.2.3 or higher.