Pod::Tree::PerlTop: Generate a top-level index for perl pods

SYNOPSIS

  $perl_map = new Pod::Tree::PerlMap;
  $perl_top = new Pod::Tree::PerlTop $perl_dir, $HTML_dir, $perl_map, %opts;

  $perl_top->index(@translators);
  $perl_top->translate;

  $top = $perl_top->get_top_entry;

DESCRIPTION

\*(C`Pod::Tree::PerlTop\*(C' generates a top-level index for Perl PODs.

It also translates perl.pod to perl.html The translator is specially hacked to insert links into the big verbatim paragraph that lists all the other Perl PODs.

METHODS

Creates and returns a new \*(C`Pod::Tree::PerlTop\*(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. \*(C`Pod::Tree::PerlTop\*(C' uses it to resolve links in the perl.pod page. %options are passed through to \*(C`Pod::Tree::HTML\*(C'. Generates a top-level index of all the PODs. The index is written to HTML_dir\*(C`/index.html\*(C'. @translators is a list of other \*(C`Pod::Tree::Perl*\*(C' translator objects. \*(C`index\*(C' makes a \*(C`get_top_entry\*(C' call on each of them to obtain URLs and descriptions of the pages that it links to. Translates the perl.pod file to \s-1HTML\s0. The \s-1HTML\s0 page is written to HTML_dir\*(C`/pod/perl.html\*(C' 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.

REQUIRES

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

EXPORTS

Nothing.

RELATED TO Pod::Tree::PerlTop…

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

AUTHOR

Steven McDougall, [email protected]

Pod::Tree::PerlTop (3pm)