Pod::Simple::HTML - Online Linux Manual PageSection : 3
Updated : 2023-01-20
Source : perl v5.36.0
Note : User Contributed Perl Documentation
NAMEPod::Simple::HTML − convert Pod to HTML
SYNOPSIS perl −MPod::Simple::HTML −e Pod::Simple::HTML::go thingy.pod
DESCRIPTIONThis class is for making an HTML rendering of a Pod document. This is a subclass of Pod::Simple::PullParser and inherits all its methods (and options). Note that if you want to do a batch conversion of a lot of Pod documents to HTML, you should see the module Pod::Simple::HTMLBatch.
CALLING FROM THE COMMAND LINETODO perl −MPod::Simple::HTML −e Pod::Simple::HTML::go Thing.pod Thing.html
CALLING FROM PERL
Minimal code use Pod::Simple::HTML;
my $p = Pod::Simple::HTML−>new;
$p−>output_string(\my $html);
$p−>parse_file('path/to/Module/Name.pm');
open my $out, '>', 'out.html' or die "Cannot open 'out.html': $!\n";
print $out $html;
More detailed example use Pod::Simple::HTML;
Set the content type: $Pod::Simple::HTML::Content_decl = q{<meta http−equiv="Content−Type" content="text/html; charset=UTF−8" >};
my $p = Pod::Simple::HTML−>new;
Include a single javascript source: $p−>html_javascript('http://abc.com/a.js');
Or insert multiple javascript source in the header (or for that matter include anything, thought this is not recommended) $p−>html_javascript('
<script type="text/javascript" src="http://abc.com/b.js"></script>
<script type="text/javascript" src="http://abc.com/c.js"></script>');
Include a single css source in the header: $p−>html_css('/style.css');
or insert multiple css sources: $p−>html_css('
<link rel="stylesheet" type="text/css" title="pod_stylesheet" href="http://remote.server.com/jquery.css">
<link rel="stylesheet" type="text/css" title="pod_stylesheet" href="/style.css">');
Tell the parser where should the output go. In this case it will be placed in the $html variable: my $html;
$p−>output_string(\$html);
Parse and process a file with pod in it: $p−>parse_file('path/to/Module/Name.pm');
METHODSTODO all (most?) accessorized methods The following variables need to be set before the call to the −>new constructor. Set the string that is included before the opening <html> tag: $Pod::Simple::HTML::Doctype_decl = qq{<!DOCTYPE HTML PUBLIC "−//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">\n};
Set the content-type in the HTML head: (defaults to ISO−8859−1) $Pod::Simple::HTML::Content_decl = q{<meta http−equiv="Content−Type" content="text/html; charset=UTF−8" >};
Set the value that will be embedded in the opening tags of F, C tags and verbatim text. F maps to <em>, C maps to <code>, Verbatim text maps to <pre> (Computerese defaults to "") $Pod::Simple::HTML::Computerese = ' class="some_class_name';
html_css
html_javascript
title_prefix
title_postfix
This includes everything before the <title> opening tag including the Document type and including the opening <title> tag. The following call will set it to be a simple HTML file: $p−>html_header_before_title('<html><head><title>');
top_anchorBy default Pod::Simple::HTML adds a dummy anchor at the top of the HTML. You can change it by calling $p−>top_anchor('<a name="zz" >');
html_h_levelNormally =head1 will become <h1>, =head2 will become <h2> etc. Using the html_h_level method will change these levels setting the h level of =head1 tags: $p−>html_h_level(3);
Will make sure that =head1 will become <h3> and =head2 will become <h4> etc...
indexSet it to some true value if you want to have an index (in reality a table of contents) to be added at the top of the generated HTML. $p−>index(1);
Includes the closing tag of </title> and through the rest of the head till the opening of the body $p−>html_header_after_title('</title>...</head><body id="my_id">');
The very end of the document: $p−>html_footer( qq[\n<!−− end doc −−>\n\n</body></html>\n] );
SUBCLASSINGCan use any of the methods described above but for further customization one needs to override some of the methods: package My::Pod;
use strict;
use warnings;
use base 'Pod::Simple::HTML';
# needs to return a URL string such
# http://some.other.com/page.html
# #anchor_in_the_same_file
# /internal/ref.html
sub do_pod_link {
# My::Pod object and Pod::Simple::PullParserStartToken object
my ($self, $link) = @_;
say $link−>tagname; # will be L for links
say $link−>attr('to'); #
say $link−>attr('type'); # will be 'pod' always
say $link−>attr('section');
# Links local to our web site
if ($link−>tagname eq 'L' and $link−>attr('type') eq 'pod') {
my $to = $link−>attr('to');
if ($to =~ /^Padre::/) {
$to =~ s{::}{/}g;
return "/docs/Padre/$to.html";
}
}
# all other links are generated by the parent class
my $ret = $self−>SUPER::do_pod_link($link);
return $ret;
}
1;
Meanwhile in script.pl: use My::Pod;
my $p = My::Pod−>new;
my $html;
$p−>output_string(\$html);
$p−>parse_file('path/to/Module/Name.pm');
open my $out, '>', 'out.html' or die;
print $out $html;
TODO maybe override do_beginning do_end
SEE ALSOPod::Simple, Pod::Simple::HTMLBatch TODO: a corpus of sample Pod input and HTML output? Or common idioms?
SUPPORTQuestions 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, <https://github.com/perl−pod/pod−simple/>. Feel free to fork and contribute, or to clone <git://github.com/perl−pod/pod−simple.git> and send patches! Patches against Pod::Simple are welcome. Please send bug reports to <bug−pod−simple@rt.cpan.org>.
COPYRIGHT AND DISCLAIMERSCopyright (c) 2002−2004 Sean M. Burke. 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.
ACKNOWLEDGEMENTSThanks to Hurricane Electric <http://he.net/> for permission to use its Linux man pages online <http://man.he.net/> site for man page links. Thanks to search.cpan.org <http://search.cpan.org/> for permission to use the site for Perl module links.
AUTHORPod::Simple was created by Sean M. Burke <sburke@cpan.org>. But don't bother him, he's retired. Pod::Simple is maintained by: • Allison Randal \*(C`allison@perl.org\*(C'\fR • Hans Dieter Pearcey \*(C`hdp@cpan.org\*(C'\fR • David E. Wheeler \*(C`dwheeler@cpan.org\*(C'\fR 0
Johanes Gumabo
Data Size : 28,991 byte
man-Pod::Simple::HTML.3pmBuild : 2024-12-29, 07:25 :
Visitor Screen : x
Visitor Counter ( page / site ) : 2 / 255,789
Visitor ID : :
Visitor IP : 18.116.49.38 :
Visitor Provider : AMAZON-02 :
Provider Position ( lat x lon ) : 39.962500 x -83.006100 : x
Provider Accuracy Radius ( km ) : 1000 :
Provider City : Columbus :
Provider Province : Ohio , : ,
Provider Country : United States :
Provider Continent : North America :
Visitor Recorder : Version :
Visitor Recorder : Library :
Online Linux Manual Page : Version : Online Linux Manual Page - Fedora.40 - march=x86-64 - mtune=generic - 24.12.29
Online Linux Manual Page : Library : lib_c - 24.10.03 - march=x86-64 - mtune=generic - Fedora.40
Online Linux Manual Page : Library : lib_m - 24.10.03 - march=x86-64 - mtune=generic - Fedora.40
Data Base : Version : Online Linux Manual Page Database - 24.04.13 - march=x86-64 - mtune=generic - fedora-38
Data Base : Library : lib_c - 23.02.07 - march=x86-64 - mtune=generic - fedora.36
Very long time ago, I have the best tutor, Wenzel Svojanovsky . If someone knows the email address of Wenzel Svojanovsky , please send an email to johanes_gumabo@yahoo.co.id .
If error, please print screen and send to johanes_gumabo@yahoo.co.id
Under development. Support me via PayPal.
ERROR : Need New Coding : (parse_manual_page_|252|Pod::Simple::HTML.3pm|24/25|el══─{─══.|.el══─{─══. ds C`
) (htmlprn|149|Pod::Simple::HTML.3pm|24/25|.el══─{─══. ds C` |.el══─{─══. ds C`
) (parse_manual_page_|252|Pod::Simple::HTML.3pm|27|br══─}─══|'br══─}─══
) (htmlprn|149|Pod::Simple::HTML.3pm|27|'br══─}─══ |'br══─}─══
) (rof_escape_sequence|91|Pod::Simple::HTML.3pm|339|\*(C`allison@perl.org\*(C'\fR |Allison Randal \f(CW\*(C`allison@perl.org\*(C'\fR
) (rof_escape_sequence|91|Pod::Simple::HTML.3pm|341|\*(C`hdp@cpan.org\*(C'\fR |Hans Dieter Pearcey \f(CW\*(C`hdp@cpan.org\*(C'\fR
) (rof_escape_sequence|91|Pod::Simple::HTML.3pm|343|\*(C`dwheeler@cpan.org\*(C'\fR |David E. Wheeler \f(CW\*(C`dwheeler@cpan.org\*(C'\fR
)