NAME
Pod::GroveBuilder - use Pod::Parser to create SGML::Grove objects
SYNOPSIS
use Pod::GroveBuilder;
$grove = Pod::GroveBuilder->new ($sysid);
DESCRIPTION
Pod::GroveBuilder
uses Pod::Parser to create SGML::Grove objects. The resulting SGML::Grove objects can then be used by any module that supports them, including writing SGML/XML output (SGML::Writer), formatting the POD to Ascii or HTML (Quilt), or using SGML::Grove iterators to perform multiple passes over the POD or working with multiple PODs at the same time.
Pod::GroveBuilder->new ($sysid)
creates a grove from a $sysid
, a $sysid
may be a file name or a FileHandle
object.
GroveBuilder will build a grove that is hierarchical, for example, `head2' sections will be contained inside of `head1' sections, and `item' paragraphs will be contained within lists, etc.
HEAD1
"text"
HEAD2
LIST
ITEM
"text"
ITEM
"text"
HEAD2
"text"
See SGML::Grove
for details on using the grove returned by Pod::GroveBuilder
.
AUTHOR
Ken MacLeod, ken@bitsko.slc.ut.us
SEE ALSO
perl(1), Pod::Parser(3), SGML::Grove(3), SGML::Writer(3), Quilt(3).