SDF 2.001: SDF Reference: about Filter

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

# 5.2. about Filter

## Interface

The general syntax is:

      !block about
      ...
      !endblock

See Understanding Filter Interfaces, if necessary.

## Description

The about filter is used when including a topic as an "about" section within a document. Typically, this implies:

- the headings are converted to plain headings and slid down one level
- the headings (except those initially at level 1) are removed from the table of contents.

## Examples

A typical book might look like this:

    !init OPT_STYLE="manual"

    !define DOC_NAME "A Sample Book"
    !build_title

    !include "myabout.sdf"; about
    !include "chapter1.sdf"
    !include "chapter2.sdf"
    !include "chapter3.sdf"
    !include "appendx1.sdf"; appendix

A typical about topic looks like this:

    H1: About this manual

    H2: Purpose

    This manual provides information on ...

    H2: Scope

    This manual contains information on ...