SDF 2.001: SDF Reference: verbatim Filter

Contents | Parent Topic | Previous Topic | Next Topic
Home | Catalog

# 5.34. verbatim Filter

## Interface

The general syntax is:

      !block verbatim[; parameters]
      ...
      !endblock

The parameters are:

Name | Type | Rule
skipheader | boolean |
lang | string |
wide | boolean |
listitem | integer |

See Understanding Filter Interfaces, if necessary.

## Description

The verbatim filter is used to specify a section of fixed-width text. Unlike the verbatim filter, embedded SDF symbols (like {{) are treated like normal text.

The skipheader parameter is useful when an external file is being included as an example, but you do not want the header comment in the example. The lang parameter, if any, is used to determine the commenting conventions. If no language is specified, comments are assumed to start with a # and be terminated by the end of line.

The wide parameter can be used to ensure that at least 80 characters are output on a line before it is wrapped.

The listitem parameter can be used to specify that this block of text is part of a list. The value is the logical indent of the list (e.g. 1, 2, etc.).

## Examples

    # Include myfile.c but exclude the copyright, revision history, etc.
    !include "myfile.c"; verbatim; skipheader; lang='c'