You are using a browser which doesn't fully support Cascading Style Sheets. This site will look much better in a browser that supports web standards, but its content is accessible to any browser or Internet device.

preFormatter()

This is an optional method called before formatting. It is no formatter by itself, but useful to recognize global state switches and the like (e.g. if in an embedded part and of what language). When defined, it is called for all entities, using the traditional directive interface. See the traditional model for details. Here is a list of parameters to expect:

1: type directive	2: used flags (modes)	3...: more parameters
`DIRECTIVE_BLOCK`	`DIRECTIVE_START`, `DIRECTIVE_COMPLETE`	-
`DIRECTIVE_COMMENT`	`DIRECTIVE_START`, `DIRECTIVE_COMPLETE`	-
`DIRECTIVE_DLIST`	`DIRECTIVE_START`, `DIRECTIVE_COMPLETE`	a reserved parameter, two parameters describing type and level of a preceeding list shift if any (0 otherwise, only provided in start directives), two parameters describing type and level of a following list shift if any (0 otherwise, only provided in completion directives)
`DIRECTIVE_DOCUMENT`	`DIRECTIVE_START`, `DIRECTIVE_COMPLETE`	(base)name of source file
`DIRECTIVE_DPOINT`	`DIRECTIVE_START`, `DIRECTIVE_COMPLETE`	a reserved parameter, two parameters describing type and level of a preceeding list shift if any (0 otherwise, only provided in start directives), two parameters describing type and level of a following list shift if any (0 otherwise, only provided in completion directives)
`DIRECTIVE_DPOINT_ITEM`	`DIRECTIVE_START`, `DIRECTIVE_COMPLETE`	-
`DIRECTIVE_DSTREAM_ENTRYPOINT`	`DIRECTIVE_START`	stream name
`DIRECTIVE_HEADLINE`	`DIRECTIVE_START`, `DIRECTIVE_COMPLETE`	Headline level. The full headline title (tags stripped off), a short version of the title and a reference to an array of docstreams used in this chapter are provided additionally in the startup directive only. (If no short title version (or "shortcut") was specified, an empty string is provided.)
`DIRECTIVE_LIST_LSHIFT`	`DIRECTIVE_START`	number of levels to shift
`DIRECTIVE_LIST_RSHIFT`	`DIRECTIVE_START`	number of levels to shift
`DIRECTIVE_NEW_LINE`	`DIRECTIVE_START`	a hash reference: key "file" provides the current source file name, key "line" the new line number
`DIRECTIVE_OLIST`	`DIRECTIVE_START`, `DIRECTIVE_COMPLETE`	A prefered startup number (defaults to 1). Two parameters describing type and level of a preceeding list shift if any (0 otherwise, only provided in start directives), two parameters describing type and level of a following list shift if any (0 otherwise, only provided in completion directives)
`DIRECTIVE_OPOINT`	`DIRECTIVE_START`, `DIRECTIVE_COMPLETE`	-
`DIRECTIVE_SIMPLE`	`DIRECTIVE_START`	a list of strings
`DIRECTIVE_TAG`	`DIRECTIVE_START`, `DIRECTIVE_COMPLETE`	First, the tag name, then a reference to a hash of tag options taken from the source, then the number of stream parts following for the body (0 means: no tag body). Tag options in the open directive might have been modified by a tag finish hook and therefore differ from the options provided in the closing directive, which reflects the original options (before finish hook invokation).
`DIRECTIVE_TEXT`	`DIRECTIVE_START`, `DIRECTIVE_COMPLETE`	-
`DIRECTIVE_ULIST`	`DIRECTIVE_START`, `DIRECTIVE_COMPLETE`	-
`DIRECTIVE_UPOINT`	`DIRECTIVE_START`, `DIRECTIVE_COMPLETE`	-
`DIRECTIVE_VARRESET`	`DIRECTIVE_START`	-
`DIRECTIVE_VARSET`	`DIRECTIVE_START`	a hash reference: key "var" provides the variables name, key "value" the new value
`DIRECTIVE_VERBATIM`	`DIRECTIVE_START`, `DIRECTIVE_COMPLETE`	-