Pod::PseudoPod - A framework for parsing PseudoPod


Pod-PseudoPod documentation  | view source Contained in the Pod-PseudoPod distribution.

Index


NAME

Top

Pod::PseudoPod - A framework for parsing PseudoPod

SYNOPSIS

Top

  use strict;
  package SomePseudoPodFormatter;
  use base qw(Pod::PseudoPod);

  sub handle_text {
    my($self, $text) = @_;
    ...
  }

  sub start_head1 {
    my($self, $flags) = @_;
    ...
  }
  sub end_head1 {
    my($self) = @_;
   ...
  }

  ...and start_*/end_* methods for whatever other events you
  want to catch.

DESCRIPTION

Top

PseudoPod is an extended set of Pod tags used for book manuscripts. Standard Pod doesn't have all the markup options you need to mark up files for publishing production. PseudoPod adds a few extra tags for footnotes, tables, sidebars, etc.

This class adds parsing support for the PseudoPod tags. It also overrides Pod::Simple's _handle_element_start, _handle_text, and _handle_element_end methods so that parser events are turned into method calls.

In general, you'll only want to use this module as the base class for a PseudoPod formatter/processor.

SEE ALSO

Top

Pod::Simple, Pod::PseudoPod::HTML, Pod::PseudoPod::Tutorial

COPYRIGHT

Top

AUTHOR

Top

Allison Randal <allison@perl.org>


Pod-PseudoPod documentation  | view source Contained in the Pod-PseudoPod distribution.