Pod::Tree::PerlLib: Translate module pods to html

SYNOPSIS

  $perl_map = new Pod::Tree::PerlMap;
  $perl_lib = new Pod::Tree::PerlLib $perl_dir, $HTML_dir, $perl_map, %opts;

  $perl_lib->scan(@INC);
  $perl_lib->index;
  $perl_lib->translate;

  $top = $perl_lib->get_top_entry;

DESCRIPTION

\*(C`Pod::Tree::PerlLib\*(C' translates module PODs to \s-1HTML\s0. It does a recursive subdirectory search through a list of directories (typically @INC) to find PODs.

\*(C`Pod::Tree::PerlLib\*(C' generates a top-level index of all the PODs that it finds, and writes it to HTML_dir\*(C`/lib.html\*(C'.

\*(C`Pod::Tree::PerlLib\*(C' generates and uses an index of the PODs that it finds to construct \s-1HTML\s0 links. Other modules can also use this index.

METHODS

Creates and returns a new \*(C`Pod::Tree::PerlLib\*(C' object. $HTML_dir is the directory where \s-1HTML\s0 files will be written. $perl_map maps module names to URLs. %options are passed through to \*(C`Pod::Tree::HTML\*(C'. The $perl_dir argument is included for consistency with the other \*(C`Pod::Tree::Perl*\*(C' modules, but is currently unused. Does a recursive subdirectory search through @INC to locate module PODs. Each module that is identified is entered into $perl_map. Generates a top-level index of all the modules. The index is written to HTML_dir\*(C`/lib.html\*(C'. Translates each module \s-1POD\s0 found by \*(C`scan\*(C' to \s-1HTML\s0. The \s-1HTML\s0 pages are written to HTML_dir\*(C`/lib/\*(C', in a subdirectory hierarchy that maps the module names. Returns a hash reference of the form { URL => $URL, description => $description } \*(C`Pod::Tree::PerlTop\*(C' uses this to build a top-level index of all the Perl PODs.

LINKING

\*(C`Pod::Tree::PerlLib\*(C' expects the second paragraph of the \s-1POD\s0 to have the form

Foo::Bar - description

and enters Foo::Bar into $perl_map. To link to a module \s-1POD\s0, write

L<Foo::Bar>

REQUIRES

5.005; HTML::Stream; Pod::Tree; Pod::Tree::HTML; Pod::Tree::PerlUtil;

EXPORTS

Nothing.

RELATED TO Pod::Tree::PerlLib…

\*(C`Pod::Tree::HTML\*(C', \*(C`Pod::Tree::PerlMap\*(C'

AUTHOR

Steven McDougall, [email protected]

Pod::Tree::PerlLib (3pm)