pod::tree::perltop(3pm) [debian man page]
Pod::Tree::PerlTop(3pm) User Contributed Perl Documentation Pod::Tree::PerlTop(3pm) NAME
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
"Pod::Tree::PerlTop" 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
$perl_top = "new" "Pod::Tree::PerlTop" $perl_dir, $HTML_dir, $perl_map, %options Creates and returns a new "Pod::Tree::PerlTop" 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. "Pod::Tree::PerlTop" uses it to resolve links in the perl.pod page. %options are passed through to "Pod::Tree::HTML". $perl_top->"index"(@translators) Generates a top-level index of all the PODs. The index is written to HTML_dir"/index.html". @translators is a list of other "Pod::Tree::Perl*" translator objects. "index" makes a "get_top_entry" call on each of them to obtain URLs and descriptions of the pages that it links to. $perl_top->"translate" Translates the perl.pod file to HTML. The HTML page is written to HTML_dir"/pod/perl.html" $perl_top->"get_top_entry" Returns a hash reference of the form { URL => $URL, description => $description } "Pod::Tree::PerlTop" uses this to build a top-level index of all the Perl PODs. REQUIRES
5.005; Pod::Tree::HTML; Pod::Tree::PerlUtil; EXPORTS
Nothing. SEE ALSO
"Pod::Tree::HTML", "Pod::Tree::PerlMap", AUTHOR
Steven McDougall, swmcd@world.std.com COPYRIGHT
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.10.1 2006-04-17 Pod::Tree::PerlTop(3pm)
Check Out this Related Man Page
Pod::Tree::PerlMap(3pm) User Contributed Perl Documentation Pod::Tree::PerlMap(3pm) NAME
Pod::Tree::PerlMap - map names to URLs SYNOPSIS
$perl_map = new Pod::Tree::PerlMap; $perl_map->add_page ($name, $file); $perl_map->add_func ($func, $file); $perl_map->force_func(0); $perl_map->force_func(1); $perl_map->set_depth ($depth); ($base, $page, $section) = $perl_map->map($base, $page, $section); DESCRIPTION
"Pod::Tree::PerlMap" maps L<> markups to URLs. The "Pod::Tree::Perl*" translators make entries in the map. "Pod::Tree::HTML" uses the map to translate links before it emits them. METHODS
$perl_map->"add_page"($name, $file) Map $name to $file. $name is the name of a POD, as used in L<> markups. $file is the path to the HTML file that is the target of the link. $perl_map->"add_func"($func, $file) Maps $func to $file. $func is the name of a function described in perlfunc.pod. $file is the name of the HTML file where it is described. $perl_map->"force_func"($state) Controls interpretation of links of the form L<func>. If $state is true, calls to "map" will interpret L<func> as L<perlfunc/func>. If $state is false, calls to "map" will interpret L<func> normally. $perl_map->"set_depth"($depth) Informs $perl_map of the depth of the referring page in the HTML directory tree. $perl_map needs to know this so that it can construct relative links. ($base, $page, $section) = $perl_map->"map"($base, $page, $section) Remaps a link. $base is the base URL for the HTML page, if any. $page is the page given in an L<> markup. $section is the section given in the L<> markup, if any. "map" returns a new $base, $page, and $section that can be used to construct a link to the HTML page. REQUIRES
Nothing. EXPORTS
Nothing. AUTHOR
Steven McDougall, swmcd@world.std.com COPYRIGHT
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.10.1 2004-10-11 Pod::Tree::PerlMap(3pm)