1BounceURL(3)          User Contributed Perl Documentation         BounceURL(3)
2
3
4

NAME

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

SYNOPSIS

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

DESCRIPTION

16       Some links in your pod may not be resolveable by Pod::Hyperlink, e.g.
17       "L<Some::Module>" - this module allows you to detect such links and
18       generate a hyperlink instead of some static text.  The target URL will
19       probably be some kind of dynamic webpage or CGI application which can
20       then serve up the relevant page or send a redirect to the page, hence
21       the "bounce" in this module's name.
22
23       This module overrides the type() method and, for relevant links, will
24       return a string which is "bounceurl:" followed by the URL, instead of
25       returning "page" or "item".  Your pod-conversion module can then switch
26       on this case and emit the correct kind of markup.  Pod::Xhtml supports
27       the use of this module.
28

METHODS

30       configure( %OPTIONS )
31           Set persistent configuration for this object. See "OPTIONS".
32
33       type()
34           Behaves as Pod::Hyperlink's type() method except for the
35           unresolveable links, where the string returned is as described in
36           "DESCRIPTION".
37

OPTIONS

39       URL The URL to handle the link, which may be absolute or relative, of
40           any protocol - it's just treated as a string and is passed through
41           sprintf(), with two string arguments that are both already URL-
42           escaped.
43
44           The first argument is the page name, and will always exist. The
45           second argument is the "node" within the page, and may be empty.
46
47           Insert '%s' where you wish the arguments to be interpolated. The
48           string goes through sprintf() so you should have '%%' where you
49           want an actual percent sign. If you need the arguments in a
50           different order, see the perl-specific features of "sprintf" in
51           perlfunc.
52

VERSION

54       $Revision: 1.7 $
55

AUTHOR

57       P Kent <cpan _at_ bbc _dot_ co _dot_ uk>
58

60       (c) BBC 2007. This program is free software; you can redistribute it
61       and/or modify it under the GNU GPL.
62
63       See the file COPYING in this distribution, or
64       http://www.gnu.org/licenses/gpl.txt
65
66
67
68perl v5.34.0                      2022-01-21                      BounceURL(3)
Impressum