NAME
Apache2::Pod - base class for converting Pod files to prettier forms
VERSION
Version 0.27
SYNOPSIS
The Apache2::Pod::* are mod_perl handlers to easily convert Pod to HTML or other forms. You can also emulate perldoc.
CONFIGURATION
All configuration is done in one of the subclasses.
TODO
I could envision a day when the user can specify which output format he'd like from the URL, such as
http://your.server/perldoc/f/printf?rtf
FUNCTIONS
No functions are exported. I don't want to dink around with Exporter in mod_perl if I don't need to.
getpodfile( $r )
Returns the filename requested off of the $r
request object, or what Perldoc would find, based on Pod::Find.
resolve_modname( $r )
Returns a module name based on $r->path_info
.
getpodfuncdoc( $file, $function_name )
Given the full filepath of the perlfunc
pod file and a function name, returns the section of that pod document pertaining to the function. If the function is not found, returns a pod document phrase stating so.
SEE ALSO
Apache2::Pod::HTML, Apache2::Pod::Text,
AUTHOR
Theron Lewis <theron at theronlewis dot com>
HISTORY
Adapteded from Andy Lester's <andy at petdance dot com>
Apache::Pod package which was adapted from Apache2::Perldoc by Rich Bowen <rbowen@ApacheAdmin.com>
ACKNOWLEDGEMENTS
Thanks also to Pete Krawczyk, Kjetil Skotheim, Kate Yoak and Chris Eade for contributions.
LICENSE
This package is licensed under the same terms as Perl itself.