SDF 2.001: SDF Reference: inline Filter

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

# 5.19. inline Filter

## Interface

The general syntax is:

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

The parameters are:

Name | Type | Rule
target | string | <\w+>
expand | boolean |

See Understanding Filter Interfaces, if necessary.

## Description

The inline filter is used to pass a section of text directly to a target documentation system.

The target parameter is used to specify which target system the nominated text is to be passed to. The default target is html.

The expand parameter can be used to request expansion of SDF expressions (enclosed in [[ and ]]) within the text.

## Examples

To embed HTML within an SDF document:

    !block inline
      add arbitrary HTML here ...
    !endblock

SDF expressions can be expand like this:

    !define VERB "is"
    ...
    !block inline; expand
    <P>
    This HTML [[VERB]] expanded.
    !endblock