Pod::SAX 0.14 review

Download
by rbytes.net on

Pod::SAX is a SAX parser for Pod. SYNOPSIS my $h = XML::SAX::Writer->new(); my $p = Pod::SAX->new( Handler => $h ); $p-

License: Perl Artistic License
File size: 13K
Developer: Matt Sergeant
0 stars award from rbytes.net

Pod::SAX is a SAX parser for Pod.

SYNOPSIS

my $h = XML::SAX::Writer->new();
my $p = Pod::SAX->new( Handler => $h );
$p->parse_uri('perlpodspec.pod');

Very simply, this module parses POD (or perl) files and turns the Plain Old Documentation into SAX events (which often you'll use to turn into XML, but there are other uses as well).

The aim of this module is not round-tripping, so some things may be lost in the conversion. The aim is to be as standards compliant as possible, while giving you very simple access to the data.

The main motivation for this module though was simple standards compliance - all the Pod parsers out there seem to have their own unique way of doing things, and so my aim was to unify that and allow the flexibility that SAX gives me at the same time.

For an introduction to SAX, please read XML::SAX::Intro.

One very important point to note is that just because this is a SAX module it doesn't mandate that the results are XML. You could just as easily use this module to extract all filenames from a POD file, or extract custom =for/=begin sections. And because it uses standardised interfaces this is a lot simpler than working with any other POD parser out there, and the knowledge is transferrable.

Requirements:
Perl

Pod::SAX 0.14 keywords