Pod::Tree::PerlDist: Translate perl distribution documentation to html

SYNOPSIS

  $perl_map  = new Pod::Tree::PerlMap;
  $perl_dist = new Pod::Tree::PerlDist $perl_dir, $HTML_dir, $perl_map, %opts;

  $perl_dist->scan;
  $perl_dist->index;
  $perl_dist->translate;

  $top = $perl_dist->get_top_entry;

DESCRIPTION

\*(C`Pod::Tree::PerlDist\*(C' translates documents in the Perl distribution to \s-1HTML\s0. These include Changes, \s-1README\s0, and assored other files that appear in the top level of the Perl source tree.

Files that contain PODs are parsed as PODs; files that do not contain PODs are converted to \s-1HTML\s0 as preformatted text.

\*(C`Pod::Tree::PerlDist\*(C' generates and uses an index of the files 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::PerlDist\*(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 file names to URLs. %options are passed through to \*(C`Pod::Tree::HTML\*(C'. Scans the top level of the Perl source tree for documentation files. Files that do not generally contain user-level documentation, such as source files, are ignored. The search does not recurse through subdirectories. Each file that is located is entered into $perl_map. Generates a top-level index of all the distribution documents, and writes it to HTML_dir\*(C`/dist.html\*(C'. Translates each distribution document found by \*(C`scan\*(C' to \s-1HTML\s0. The \s-1HTML\s0 pages are written to HTML_dir. 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::PerlDist\*(C' indexes files by their name. To link to a file named \s-1README\s0.win32 write

L<README.win32>

REQUIRES

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

EXPORTS

Nothing.

RELATED TO Pod::Tree::PerlDist…

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

AUTHOR

Steven McDougall, [email protected]

Pod::Tree::PerlDist (3pm)