SDF 2.001beta1: SDF User Guide: Building a title

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

# 1.6. Building a title

Each document style category has a different way of building a title section:

- administration styles use the title filter
- general styles use the build_title macro
- miscellaneous styles do not have a title.

Refer to Document styles for a summary of the styles available and the category of each style.

## 1.6.1. The title filter

The title filter generates a title block for administration-style documents like memos and faxes. For example:

    !block title
    Name        Value
    Date:       [[DATE:DOC_MODIFIED]]
    To:         Joe Bloggs, Sue Brown, Maree Jones
    Copy:       David Smith
    From:       Neil Armstrong
    Subject:    Solar System Information
    Ref. No:    XY.002/GUI/96
    !endblock

Refer to the documentation on the title filter within the SDF Reference for further details.

## 1.6.2. The build_title macro

The build_title macro tunes the layout and content of the title section for each target format. Typically:

- paper-based documents have all the title information formatted on a page (or two)
- online documents only have the essential title information formatted in a few lines.

By convention, parameters are passed to build_title via predefined variable names. For example:

      !define DOC_NAME           "GalaxyBuilder"
      !define DOC_TYPE           "User Guide"
      !define DOC_AUTHOR         "Joe Bloggs"
      !build_title

## 1.6.3. Variables used by build_title

The following variables are commonly defined before build_title is called:

Variable | Description
DOC_NAME | the title, excluding the type (e.g. SDF)
DOC_TYPE | the title type (e.g. User Guide)
DOC_AUTHOR | the author

Refer to the documentation on the build_title macro within the SDF Reference for further details.

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