Pod::Tree::PerlMap - map names to URLs
$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);
Pod::Tree::PerlMap maps L<> markups to URLs.
Pod::Tree::PerlMap
The Pod::Tree::Perl* translators make entries in the map. Pod::Tree::HTML uses the map to translate links before it emits them.
Pod::Tree::Perl*
Pod::Tree::HTML
add_page
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.
add_func
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.
force_func
Controls interpretation of links of the form L<func>.
If $state is true, calls to map will interpret L<func> as L<perlfunc/func>.
map
If $state is false, calls to map will interpret L<func> normally.
set_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.
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.
Nothing.
Steven McDougall, swmcd@world.std.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.
To install Pod::Tree, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Pod::Tree
CPAN shell
perl -MCPAN -e shell install Pod::Tree
For more information on module installation, please visit the detailed CPAN module installation guide.