NAME

XML::Filter::EzPod - A SAX filter (for Pod::SAX) that makes writing Pod easier.

SYNOPSIS

  my $p = Pod::SAX->new(
            Handler => XML::Filter::EzPod->new(
                Handler => XML::SAX::Writer->new(
                    Output => \$output
                )
            )
        );

DESCRIPTION

Don't you just get sick of writing lists in pod? So much annoying vertical whitespace! I got sick of it too. So this filter turns something like:

    * A bullet
    * Point
    ** With extra levels
    ** Going
    *** Up
    ** and
    * Down
    ** And up again

Into the appropriate SAX events as though the source were a POD list.

SUPPORTED SYNTAX

Itemized Lists

Can be created with asterisks. These must be in the first column, and followed by whitespace. Arbitrary asterisk levels are supported.

Example:

  * an itemized
  * list is created
  * as follows
  ** with possible further indents

Ordered Lists

Can be created with hashes (also known as the pound sign). These must be in the first column and followed by whitespace. Arbitrary levels are supported.

Example:

  # An ordered
  # list is created
  # as follows
  ## with possible
  ## further indents

The indent_width Value

It is possible to set the value normally given in POD's =over N parameter using the greater-than sign before your list:

  >6
  * A bulleted list
  * equivalent to =over 6

A single greater-than sign on its own will set the indent_width to -1 which is useful in conjunction with AxKit2's spod5 plugin, indicating the points should appear incrementally.

A double greater-than sign will set the indent_width to -2. Again, for spod5, indicating the points should appear incrementally with the first point shown automatically.

LICENSE

This is free software. You may use it and redistribute it under the same terms as perl itself.

AUTHOR

Matt Sergeant, <matt@sergeant.org>

BUGS

The test suite doesn't actually test anything - it's there for me as a visual inspection to check everything's working.