Pod::Tree::PerlPod: Translate perl pods to html

SYNOPSIS

  $perl_map = new Pod::Tree::PerlMap;
  $perl_pod = new Pod::Tree::PerlPod $perl_dir, $HTML_dir, $perl_map, %opts;

  $perl_pod->scan;
  $perl_pod->index;
  $perl_pod->translate;

  $top = $perl_pod->get_top_entry;

DESCRIPTION

\*(C`Pod::Tree::PerlPod\*(C' translates Perl PODs to \s-1HTML\s0. It does a recursive subdirectory search through $perl_dir to find PODs.

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

\*(C`Pod::Tree::PerlPod\*(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::PerlPod\*(C' object. $perl_dir is the root of the Perl source tree. $HTML_dir is the directory where \s-1HTML\s0 files will be written. $perl_map maps \s-1POD\s0 names to URLs. %options are passed through to \*(C`Pod::Tree::HTML\*(C'. Does a recursive subdirectory search through $perl_dir to locate PODs. Each \s-1POD\s0 that is located is entered into $perl_map. Generates a top-level index of all the PODs. The index is written to HTML_dir\*(C`/pod.html\*(C'. Translates each \s-1POD\s0 found by \*(C`scan\*(C' to \s-1HTML\s0. The \s-1HTML\s0 pages are written to HTML_dir, in a subdirectory hierarchy that mirrors the the Perl source distribution. 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::PerlPod\*(C' indexes PODs by the base name of the \s-1POD\s0 file. To link to perlsub.pod, write

L<perlsub>

REQUIRES

5.005; File::Find; HTML::Stream; IO::File; Pod::Tree::HTML; Pod::Tree::PerlUtil;

EXPORTS

Nothing.

RELATED TO Pod::Tree::PerlPod…

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

AUTHOR

Steven McDougall, [email protected]

Pod::Tree::PerlPod (3pm)