pod::hyperlink::bounceurl(3pm) [debian man page]

BounceURL(3pm)						User Contributed Perl Documentation					    BounceURL(3pm)

NAME

       Pod::Hyperlink::BounceURL - Allow off-page links in POD to point to a URL

SYNOPSIS

	       use Pod::Hyperlink::BounceURL;
	       my $linkparser = new Pod::Hyperlink::BounceURL;
	       $linkparser->configure( URL => '/cgi-perl/support/bounce.pl?page=%s' );
	       my $pod2xhtml = new Pod::Xhtml( LinkParser => $linkparser );

DESCRIPTION

       Some links in your pod may not be resolveable by Pod::Hyperlink, e.g. "L<Some::Module>" - this module allows you to detect such links and
       generate a hyperlink instead of some static text.  The target URL will probably be some kind of dynamic webpage or CGI application which
       can then serve up the relevant page or send a redirect to the page, hence the "bounce" in this module's name.

       This module overrides the type() method and, for relevant links, will return a string which is "bounceurl:" followed by the URL, instead of
       returning "page" or "item".  Your pod-conversion module can then switch on this case and emit the correct kind of markup.  Pod::Xhtml
       supports the use of this module.

METHODS

       configure( %OPTIONS )
	   Set persistent configuration for this object. See "OPTIONS".

       type()
	   Behaves as Pod::Hyperlink's type() method except for the unresolveable links, where the string returned is as described in
	   "DESCRIPTION".

OPTIONS

       URL The URL to handle the link, which may be absolute or relative, of any protocol - it's just treated as a string and is passed through
	   sprintf(), with two string arguments that are both already URL-escaped.

	   The first argument is the page name, and will always exist. The second argument is the "node" within the page, and may be empty.

	   Insert '%s' where you wish the arguments to be interpolated. The string goes through sprintf() so you should have '%%' where you want
	   an actual percent sign. If you need the arguments in a different order, see the perl-specific features of "sprintf" in perlfunc.

VERSION

       $Revision: 1.7 $

AUTHOR

       P Kent <cpan _at_ bbc _dot_ co _dot_ uk>

COPYRIGHT

       (c) BBC 2007. This program is free software; you can redistribute it and/or modify it under the GNU GPL.

       See the file COPYING in this distribution, or http://www.gnu.org/licenses/gpl.txt

perl v5.10.1							    2010-07-28							    BounceURL(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)

Linux and UNIX Man Pages

pod::hyperlink::bounceurl(3pm) [debian man page]

Check Out this Related Man Page