|$perl_dist = new Pod::Tree::PerlDist $perl_dir, $HTML_dir, $perl_map, %options||
Creates and returns a new Pod::Tree::PerlDist object.
$perl_dir is the root of the Perl source tree.
$HTML_dir is the directory where HTML files will be written.
$perl_map maps file names to URLs.
%options are passed through to Pod::Tree::HTML.
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.
|$perl_dist->index||Generates a top-level index of all the distribution documents, and writes it to HTML_dir/dist.html.|
|$perl_dist->translate||Translates each distribution document found by scan to HTML. The HTML pages are written to HTML_dir.|
Returns a hash reference of the form
Pod::Tree::PerlTop uses this to build a top-level index of all the Perl PODs.
Pod::Tree::PerlDist indexes files by their name. To link to a file named README.win32 write
5.005; HTML::Stream; Pod::Tree; Pod::Tree::HTML; Pod::Tree::PerlUtil;
Steven McDougall, email@example.com
Copyright (c) 2000 by Steven McDougall. This module is free software; you can redistribute it and/or modify it under the same terms as Perl.
|perl v5.20.3||POD::TREE::PERLDIST (3)||2015-05-25|