NAME Pod::Simple::XHTML format Pod as validating XHTML SYNOPSIS use Pod::Simple::XHTML;
my $parser = Pod::Simple::XHTML->new(); ...
$parser->parsefile('path/to/file.pod'); DESCRIPTION This class is a formatter that takes Pod and renders it as XHTML validating HTML. This is a subclass of Pod::Simple::Methody and inherits all its methods. The implementation is entirely different than Pod::Simple::HTML, but it largely preserves the same interface. Minimal code use Pod::Simple::XHTML;
my $psx = Pod::Simple::XHTML->new;
$psx->outputstring(\my $html);
$psx->parsefile('path/to/Module/Name.pm');
open my $out, '>', 'out.html' or die "Cannot open 'out.html': $!\n";
print $out $html; You can also control the character encoding and entities. For example, if you're sure that the POD is properly encoded (using the "=encoding"
command), you can prevent high-bit characters from being encoded as
HTML entities and declare the output character set as UTF-8 before parsing, like so:
$psx->htmlcharset('UTF-8');
$psx->htmlencodechars('&<>">'); METHODS Pod::Simple::XHTML offers a number of methods that modify the format of the HTML output. Call these after creating the parser object, but before the call to "parsefile":
my $parser = Pod::PseudoPod::HTML->new();
$parser->setoptionalparam("value");
$parser->parsefile($file); perldocurlprefix
In turning Foo::Bar into http://whatever/Foo%3a%3aBar, what to put
before the "Foo%3a%3aBar". The default value is "http://search.cpan.org/perldoc?". perldocurlpostfix
What to put after "Foo%3a%3aBar" in the URL. This option is not set by default. manurlprefix In turning crontab(5) into http://whatever/man/1/crontab, what to put before the "1/crontab". The default value is "http://man.he.net/man". manurlpostfix What to put after "1/crontab" in the URL. This option is not set by default. titleprefix, titlepostfix What to put before and after the title in the head. The values should
already be &-escaped. htmlcss
$parser->htmlcss('path/to/style.css'); The URL or relative path of a CSS file to include. This option is not set by default. htmljavascript The URL or relative path of a JavaScript file to pull in. This option is not set by default. htmldoctype A document type tag for the file. This option is not set by default. htmlcharset
The charater set to declare in the Content-Type meta tag created by default for "htmlheadertags". Note that this option will be ignored if the value of "htmlheadertags" is changed. Defaults to
"ISO-8859-1". htmlheadertags Additional arbitrary HTML tags for the header of the document. The default value is just a content type header tag:
Add additional meta tags here, or blocks of inline CSS or JavaScript (wrapped in the appropriate tags). htmlencodechars A string containing all characters that should be encoded as HTML entities, specified using the regular expression character class syntax (what you find within brackets in regular expressions). This value will be passed as the second argument to the "encodeentities" function of HTML::Entities. If HTML::Entities is not installed, then any characters other than "&<""'> will be encoded numerically. htmlhlevel This is the level of HTML "Hn" element to which a Pod "head1" corresponds. For example, if "htmlhlevel" is set to 2, a head1 will produce an H2, a head2 will produce an H3, and so on. defaulttitle Set a default title for the page if no title can be determined from the
content. The value of this string should already be &-escaped. forcetitle Force a title for the page (don't try to determine it from the
content). The value of this string should already be &-escaped. htmlheader, htmlfooter Set the HTML output at the beginning and end of each file. The default header includes a title, a doctype tag (if "htmldoctype" is set), a content tag (customized by "htmlheadertags"), a tag for a CSS file (if "htmlcss" is set), and a tag for a Javascript file (if "htmljavascript" is set). The default footer simply closes the "html" and "body" tags. The options listed above customize parts of the default header, but
setting "htmlheader" or "htmlfooter" completely overrides the built- in header or footer. These may be useful if you want to use template tags instead of literal HTML headers and footers or are integrating converted POD pages in a larger website. If you want no headers or footers output in the HTML, set these options to the empty string. index
Whether to add a table-of-contents at the top of each page (called an index for the sake of tradition). anchoritems Whether to anchor every definition "=item" directive. This needs to be enabled if you want to be able to link to specific "=item" directives, which are output as "
$new->accepttargetsastext( 'foo' ); Then override the "startfor" method in the subclass to check for when
"$flags->{'target'}" is equal to 'foo' and set a flag that marks that
you're in a foo block (maybe "$self->{'infoo'} = 1"). Then override
the "handletext" method to check for the flag, and pass $text to your custom subroutine to construct the HTML output for 'foo' elements, something like: sub handletext {
my ($self, $text) = @;
if ($self->{'infoo'}) {
$self->{'scratch'} .= buildfoohtml($text); return; }
$self->SUPER::handletext($text); } handlecode This method handles the body of text that is marked up to be code. You might for instance override this to plug in a syntax highlighter. The base implementation just escapes the text. The callback methods "startcode" and "endcode" emits the "code" tags before and after "handlecode" is invoked, so you might want to override these together with "handlecode" if this wrapping isn't suiteable. Note that the code might be broken into mulitple segments if there are nested formatting codes inside a "C<...>" sequence. In between the calls to "handlecode" other markup tags might have been emitted in that case. The same is true for verbatim sections if the "codesinverbatim" option is turned on. accepttargetsashtml This method behaves like "accepttargetsastext", but also marks the region as one whose content should be emitted literally, without HTML entity escaping or wrapping in a "div" element. resolvepodpagelink
my $url = $pod->resolvepodpagelink('Net::Ping', 'INSTALL');
my $url = $pod->resolvepodpagelink('perlpodspec');
my $url = $pod->resolvepodpagelink(undef, 'SYNOPSIS'); Resolves a POD link target (typically a module or POD file name) and section name to a URL. The resulting link will be returned for the above examples as:
http://search.cpan.org/perldoc?Net::Ping#INSTALL http://search.cpan.org/perldoc?perlpodspec
#SYNOPSIS Note that when there is only a section argument the URL will simply be a link to a section in the current document. resolvemanpagelink
my $url = $pod->resolvemanpagelink('crontab(5)', 'EXAMPLE CRON FILE');
my $url = $pod->resolvemanpagelink('crontab');
Resolves a man page link target and numeric section to a URL. The
resulting link will be returned for the above examples as:
http://man.he.net/man5/crontab
http://man.he.net/man1/crontab
Note that the first argument is required. The section number will be
parsed from it, and if it's missing will default to 1. The second
argument is currently ignored, as man.he.net my $id = $pod->idify($text);
my $hash = $pod->idify($text, 1);
This method turns an arbitrary string into a valid XHTML ID attribute
value. The rules enforced, following
· The id must start with a letter (a-z or A-Z)
· All subsequent characters can be letters, numbers (0-9), hyphens
(-), underscores (), colons (:), and periods (.).
· The final character can't be a hyphen, colon, or period. URLs
ending with these characters, while allowed by XHTML, can be
awkward to extract from plain text.
· Each id must be unique within the document.
In addition, the returned value will be unique within the context of
the Pod::Simple::XHTML object unless a second argument is passed a true
value. ID attributes should always be unique within a single XHTML
document, but pass the true value if you are creating not an ID but a
URL hash to point to an ID (i.e., if you need to put the "#foo" in " href="#foo">foo $pod->batchmodepageobjectinit($batchconvobj, $module, $infile, $outfile, $depth);
Called by Pod::Simple::HTMLBatch so that the class has a chance to
initialize the converter. Internally it sets the "batchmode" property
to true and sets "batchmodecurrentlevel()", but Pod::Simple::XHTML
does not currently use those features. Subclasses might, though.
SEE ALSO
Pod::Simple, Pod::Simple::Text, Pod::Spell
SUPPORT
Questions or discussion about POD and Pod::Simple should be sent to the
pod-people@perl.org mail list. Send an empty email to
pod-people-subscribe@perl.org to subscribe.
This module is managed in an open GitHub repository,
contribute, or to clone Copyright (c) 2003-2005 Allison Randal.
This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
This program is distributed in the hope that it will be useful, but
without any warranty; without even the implied warranty of
merchantability or fitness for a particular purpose.
ACKNOWLEDGEMENTS
Thanks to Hurricane Electric perl v5.16.3 2013-05-03 Pod::Simple::XHTML(3)