SDF 2.001: SDF Reference: define Filter

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

# 5.12. define Filter

## Interface

The general syntax is:

      !block define[; parameters]
      table
      !endblock

The parameters are:

Name | Type | Rule
family | string | <\w+>
export | boolean |

The table fields are:

Field | Category | Rule
Name | key | <\w+>
Value | optional |

See Understanding Filter Interfaces, if necessary.

## Description

The define filter is a convenient way of calling the define macro for several variables.

The family parameter is often used to specify a common prefix.

The export parameter can be used to export the variables to the target document system. See the export macro for further details on variable exporting.

## Examples

    !block define
    Name            Value
    COMPANY_NAME    ACME Mining
    COMPANY_PHONE   1234 5678
    !endblock

A simpler version is:

    !block define; family="COMPANY"
    Name    Value
    NAME    ACME Mining
    PHONE   1234 5678
    !endblock