.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" 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" ''
.    ds C`
.    ds C'
'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 >0, 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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "BounceURL 3pm"
.TH BounceURL 3pm "2020-05-17" "perl v5.30.0" "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::Hyperlink::BounceURL \- Allow off\-page links in POD to point to a URL
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 4
\&        use Pod::Hyperlink::BounceURL;
\&        my $linkparser = new Pod::Hyperlink::BounceURL;
\&        $linkparser\->configure( URL => \*(Aq/cgi\-perl/support/bounce.pl?page=%s\*(Aq );
\&        my $pod2xhtml = new Pod::Xhtml( LinkParser => $linkparser );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Some links in your pod may not be resolveable by Pod::Hyperlink, e.g. \f(CW\*(C`L<Some::Module>\*(C'\fR \-
this module allows you to detect such links and generate a hyperlink instead of some static text.
The target \s-1URL\s0 will probably be some kind of dynamic webpage or \s-1CGI\s0 application which can then serve up
the relevant page or send a redirect to the page, hence the \*(L"bounce\*(R" in this module's name.
.PP
This module overrides the \fBtype()\fR method and, for relevant links, will return a string which is
\&\*(L"bounceurl:\*(R" followed by the \s-1URL,\s0 instead of returning \*(L"page\*(R" or \*(L"item\*(R".
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.
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP "configure( %OPTIONS )" 4
.el .IP "configure( \f(CW%OPTIONS\fR )" 4
.IX Item "configure( %OPTIONS )"
Set persistent configuration for this object. See \*(L"\s-1OPTIONS\*(R"\s0.
.IP "\fBtype()\fR" 4
.IX Item "type()"
Behaves as Pod::Hyperlink's \fBtype()\fR method except for the unresolveable links, where the string returned is
as described in \*(L"\s-1DESCRIPTION\*(R"\s0.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\s-1URL\s0" 4
.IX Item "URL"
The \s-1URL\s0 to handle the link, which may be absolute or relative, of any protocol \- it's just
treated as a string and is passed through \fBsprintf()\fR, with two string arguments that are both
already URL-escaped.
.Sp
The first argument is the page name, and will always exist. The second argument is the \*(L"node\*(R" within the page, and may be
empty.
.Sp
Insert '%s' where you wish the arguments to be interpolated. The string goes through \fBsprintf()\fR 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 \*(L"sprintf\*(R" in perlfunc.
.SH "VERSION"
.IX Header "VERSION"
\&\f(CW$Revision:\fR 1.7 $
.SH "AUTHOR"
.IX Header "AUTHOR"
P Kent <cpan _at_ bbc _dot_ co _dot_ uk>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
(c) \s-1BBC 2007.\s0 This program is free software; you can redistribute it and/or modify it under the \s-1GNU GPL.\s0
.PP
See the file \s-1COPYING\s0 in this distribution, or http://www.gnu.org/licenses/gpl.txt