Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Pod::Tree::PerlMap(3) User Contributed Perl DocumentationPod::Tree::PerlMap(3)

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.24.1			  2015-05-25		 Pod::Tree::PerlMap(3)

NAME | SYNOPSIS | DESCRIPTION | METHODS | REQUIRES | EXPORTS | AUTHOR | COPYRIGHT

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Pod::Tree::PerlMap&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help