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)

Pod::Tree::PerlLib(3pm) 				User Contributed Perl Documentation				   Pod::Tree::PerlLib(3pm)

NAME

       Pod::Tree::PerlLib - translate module PODs to HTML

SYNOPSIS

	 $perl_map = new Pod::Tree::PerlMap;
	 $perl_lib = new Pod::Tree::PerlLib $perl_dir, $HTML_dir, $perl_map, %opts;

	 $perl_lib->scan(@INC);
	 $perl_lib->index;
	 $perl_lib->translate;

	 $top = $perl_lib->get_top_entry;

DESCRIPTION

       "Pod::Tree::PerlLib" translates module PODs to HTML.  It does a recursive subdirectory search through a list of directories (typically
       @INC) to find PODs.

       "Pod::Tree::PerlLib" generates a top-level index of all the PODs that it finds, and writes it to HTML_dir"/lib.html".

       "Pod::Tree::PerlLib" generates and uses an index of the PODs that it finds to construct HTML links.  Other modules can also use this index.

METHODS

       $perl_lib = "new" "Pod::Tree::PerlLib" $perl_dir, $HTML_dir, $perl_map, %options
	   Creates and returns a new "Pod::Tree::PerlLib" object.

	   $HTML_dir is the directory where HTML files will be written.

	   $perl_map maps module names to URLs.

	   %options are passed through to "Pod::Tree::HTML".

	   The $perl_dir argument is included for consistency with the other "Pod::Tree::Perl*" modules, but is currently unused.

       $perl_lib->"scan"(@INC)
	   Does a recursive subdirectory search through @INC to locate module PODs.  Each module that is identified is entered into $perl_map.

       $perl_lib->"index"
	   Generates a top-level index of all the modules.  The index is written to HTML_dir"/lib.html".

       $perl_lib->"translate"
	   Translates each module POD found by "scan" to HTML.	The HTML pages are written to HTML_dir"/lib/", in a subdirectory hierarchy that
	   maps the module names.

       $perl_lib->"get_top_entry"
	   Returns a hash reference of the form

	     { URL	   => $URL,
	       description => $description }

	   "Pod::Tree::PerlTop" uses this to build a top-level index of all the Perl PODs.

LINKING

       "Pod::Tree::PerlLib" expects the second paragraph of the POD to have the form

	   Foo::Bar - description

       and enters Foo::Bar into $perl_map.  To link to a module POD, write

	   L<Foo::Bar>

REQUIRES

	   5.005;
	   HTML::Stream;
	   Pod::Tree;
	   Pod::Tree::HTML;
	   Pod::Tree::PerlUtil;

EXPORTS

       Nothing.

SEE ALSO

       "Pod::Tree::HTML", "Pod::Tree::PerlMap"

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							    2007-04-07						   Pod::Tree::PerlLib(3pm)