.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Pod::Tree::PerlMap 3pm"
.TH Pod::Tree::PerlMap 3pm "2004-10-11" "perl v5.10.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Pod::Tree::PerlMap \- map names to URLs
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  $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);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`Pod::Tree::PerlMap\*(C'\fR maps L<> markups to URLs.
.PP
The \f(CW\*(C`Pod::Tree::Perl*\*(C'\fR translators make entries in the map.
\&\f(CW\*(C`Pod::Tree::HTML\*(C'\fR uses the map to translate links before it emits
them.
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP "\fI\fI$perl_map\fI\fR\->""add_page""(\fI\fI$name\fI\fR, \fI\fI$file\fI\fR)" 4
.el .IP "\fI\f(CI$perl_map\fI\fR\->\f(CWadd_page\fR(\fI\f(CI$name\fI\fR, \fI\f(CI$file\fI\fR)" 4
.IX Item "$perl_map->add_page($name, $file)"
Map \fI\f(CI$name\fI\fR to \fI\f(CI$file\fI\fR.
\&\fI\f(CI$name\fI\fR is the name of a \s-1POD\s0, as used in L<> markups.
\&\fI\f(CI$file\fI\fR is the path to the \s-1HTML\s0 file that is the target of the link.
.ie n .IP "\fI\fI$perl_map\fI\fR\->""add_func""(\fI\fI$func\fI\fR, \fI\fI$file\fI\fR)" 4
.el .IP "\fI\f(CI$perl_map\fI\fR\->\f(CWadd_func\fR(\fI\f(CI$func\fI\fR, \fI\f(CI$file\fI\fR)" 4
.IX Item "$perl_map->add_func($func, $file)"
Maps \fI\f(CI$func\fI\fR to \fI\f(CI$file\fI\fR.
\&\fI\f(CI$func\fI\fR is the name of a function described in \fIperlfunc.pod\fR.
\&\fI\f(CI$file\fI\fR is the name of the \s-1HTML\s0 file where it is described.
.ie n .IP "\fI\fI$perl_map\fI\fR\->""force_func""(\fI\fI$state\fI\fR)" 4
.el .IP "\fI\f(CI$perl_map\fI\fR\->\f(CWforce_func\fR(\fI\f(CI$state\fI\fR)" 4
.IX Item "$perl_map->force_func($state)"
Controls interpretation of links of the form L<func>.
.Sp
If \fI\f(CI$state\fI\fR is true, calls to \f(CW\*(C`map\*(C'\fR will interpret
L<func> as L<perlfunc/func>.
.Sp
If \fI\f(CI$state\fI\fR is false, calls to \f(CW\*(C`map\*(C'\fR will interpret 
L<func> normally.
.ie n .IP "\fI\fI$perl_map\fI\fR\->""set_depth""(\fI\fI$depth\fI\fR)" 4
.el .IP "\fI\f(CI$perl_map\fI\fR\->\f(CWset_depth\fR(\fI\f(CI$depth\fI\fR)" 4
.IX Item "$perl_map->set_depth($depth)"
Informs \fI\f(CI$perl_map\fI\fR of the depth of the referring page in the \s-1HTML\s0
directory tree. 
\&\fI\f(CI$perl_map\fI\fR needs to know this so that it can construct
relative links.
.ie n .IP "(\fI\fI$base\fI\fR, \fI\fI$page\fI\fR, \fI\fI$section\fI\fR) = \fI\fI$perl_map\fI\fR\->""map""(\fI\fI$base\fI\fR, \fI\fI$page\fI\fR, \fI\fI$section\fI\fR)" 4
.el .IP "(\fI\f(CI$base\fI\fR, \fI\f(CI$page\fI\fR, \fI\f(CI$section\fI\fR) = \fI\f(CI$perl_map\fI\fR\->\f(CWmap\fR(\fI\f(CI$base\fI\fR, \fI\f(CI$page\fI\fR, \fI\f(CI$section\fI\fR)" 4
.IX Item "($base, $page, $section) = $perl_map->map($base, $page, $section)"
Remaps a link.
.Sp
\&\fI\f(CI$base\fI\fR is the base \s-1URL\s0 for the \s-1HTML\s0 page, if any.
\&\fI\f(CI$page\fI\fR is the page given in an L<> markup.
\&\fI\f(CI$section\fI\fR is the section given in the L<> markup, if any.
.Sp
\&\f(CW\*(C`map\*(C'\fR returns a new \fI\f(CI$base\fI\fR, \fI\f(CI$page\fI\fR, and \fI\f(CI$section\fI\fR
that can be used to construct a link to the \s-1HTML\s0 page.
.SH "REQUIRES"
.IX Header "REQUIRES"
Nothing.
.SH "EXPORTS"
.IX Header "EXPORTS"
Nothing.
.SH "AUTHOR"
.IX Header "AUTHOR"
Steven McDougall, swmcd@world.std.com
.SH "COPYRIGHT"
.IX Header "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.