headers

The function headers allows the model developer to specify the headers for the current section of the document.

@(headers (first; odd; even))

The result of the function headers is of type TEXT. This function has three parameters:

1. first, type TEXT; the content for the header on the first page. The content depends on the specific word processor you use to develop the model.
2. odd, type TEXT; the content for the headers on odd numbered pages. The content depends on the specific word processor you use to develop the model.
3. even, type TEXT; the content for the headers on even numbered pages. The content depends on the specific word processor you use to develop the model.

The result of the function headers is of type TEXT. The output of this function will have effect at the location where it is put into the result document.

Remarks

If the result of multiple calls to the function headers is put in the same section, only the last result will affect the section.

Restrictions

The functionality of the function headers is only available for ITP Microsoft Word output (both DOC and DOCX), and will be ignored for other document formats.

Example

# BEGIN 
 
#
@(headers ("First page header"; ""; "Even page header containing two lines of text.")
#

END #

Microsoft Word specific remarks

The option Different first page in the Microsoft Word GUI controls for each section, whether or not the first page header is shown on the first page. If this option is disabled in a section the first page header is not shown, even though it is present in the result document.

The option Different odd and even in the Microsoft Word GUI applies to the complete document and is controlled by the setting from the model document. It can be changed by use of the pagestyle or pragma functions.

All headers must end with a paragraph break. As Microsoft Word will accept headers, which do not end with a paragraph break, the behavior will be undefined.

It is possible to completely disable a header by specifying an empty string for that header. Note that this will also absorb the white space around the headers compared to a header that is empty. This feature is not available in the Microsoft Word GUI.