SDF 2.001: SDF Reference: pod Filter

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

# 5.25. pod Filter

## Interface

The general syntax is:

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

The parameters are:

Name | Type | Rule
main | boolean |

See Understanding Filter Interfaces, if necessary.

## Description

The pod filter is used to nest POD text within an SDF document.

The main parameter is used to specify that the first paragraph after "=head1 NAME" is the document name. This parameter is used internally by the sdf program when it needs to convert a POD document to another format.

## Examples

Some examples are:

        # Insert some pod
        !block pod
        A normal POD paragraph.

            And some verbatim text.
        !endblock

        # Get pod from a file
        !include "perlre.pod"; pod

        # Get pod from standard output
        !execute "getpod 'hello.c'"; pod