chromatic > Pod-PseudoPod > Pod::PseudoPod

Download:
Pod-PseudoPod-0.18.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  2
Open  0
View/Report Bugs
Module Version: 0.18   Source  

NAME ^

Pod::PseudoPod - A framework for parsing PseudoPod

SYNOPSIS ^

  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 ^

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 ^

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

COPYRIGHT ^

Copyright (C) 2003-2009 Allison Randal.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of the license can be found in the LICENSE file included with this module.

This library is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose.

AUTHOR ^

Allison Randal <allison@perl.org>

syntax highlighting: