|$perl_pod = new Pod::Tree::PerlPod $perl_dir, $HTML_dir, $perl_map, %options||
Creates and returns a new Pod::Tree::PerlPod 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 POD names to URLs.
%options are passed through to Pod::Tree::HTML.
|$perl_pod->scan;||Does a recursive subdirectory search through $perl_dir to locate PODs. Each POD that is located is entered into $perl_map.|
|$perl_pod->index||Generates a top-level index of all the PODs. The index is written to HTML_dir/pod.html.|
|$perl_pod->translate||Translates each POD found by scan to HTML. The HTML pages are written to HTML_dir, in a subdirectory hierarchy that mirrors the the Perl source distribution.|
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::PerlPod indexes PODs by the base name of the POD file. To link to perlsub.pod, write
5.005; File::Find; HTML::Stream; IO::File; 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::PERLPOD (3)||2015-05-25|