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_anchor By default [Pod::Simple::HTML](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3ASimple%3A%3AHTML/markdown) adds a dummy anchor at the top of the HTML. You can change it by calling $p->top_anchor('<a name="zz" >'); html_h_level Normally =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)](https://www.chedong.com/phpMan.php/man/htmlhlevel/3/markdown); Will make sure that =head1 will become <h3> and =head2 will become <h4> etc... index Set 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)](https://www.chedong.com/phpMan.php/man/index/1/markdown); html_header_after

# Pod::Simple::HTML(3perl) - man - phpMan ## NAME [Pod::Simple::HTML](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3ASimple%3A%3AHTML/markdown) - convert Pod to HTML ## SYNOPSIS perl -[MPod::Simple::HTML](https://www.chedong.com/phpMan.php/perldoc/MPod%3A%3ASimple%3A%3AHTML/markdown) -e [Pod::Simple::HTML::go](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3ASimple%3A%3AHTML%3A%3Ago/markdown) thingy.pod ## DESCRIPTION This class is for making an HTML rendering of a Pod document. This is a subclass of [Pod::Simple::PullParser](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3ASimple%3A%3APullParser/markdown) 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](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3ASimple%3A%3AHTMLBatch/markdown). ## CALLING FROM THE COMMAND LINE TODO perl -[MPod::Simple::HTML](https://www.chedong.com/phpMan.php/perldoc/MPod%3A%3ASimple%3A%3AHTML/markdown) -e [Pod::Simple::HTML::go](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3ASimple%3A%3AHTML%3A%3Ago/markdown) Thing.pod Thing.html ## CALLING FROM PERL ### Minimal code use [Pod::Simple::HTML](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3ASimple%3A%3AHTML/markdown); my $p = [Pod::Simple::HTML](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3ASimple%3A%3AHTML/markdown)->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](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3ASimple%3A%3AHTML/markdown); Set the content type: $[Pod::Simple::HTML::Content_decl](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3ASimple%3A%3AHTML%3A%3AContentdecl/markdown) = q{}; my $p = [Pod::Simple::HTML](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3ASimple%3A%3AHTML/markdown)->new; Include a single javascript source: $p->html_javascript(''); Or insert multiple javascript source in the header (or for that matter include anything, thought this is not recommended) $p->html_javascript(' '); Include a single css source in the header: $p->html_css('/style.css'); or insert multiple css sources: $p->html_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'); ## METHODS TODO 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 tag: $[Pod::Simple::HTML::Doctype_decl](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3ASimple%3A%3AHTML%3A%3ADoctypedecl/markdown) = qq{">\n}; Set the content-type in the HTML head: (defaults to ISO-8859-1) $[Pod::Simple::HTML::Content_decl](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3ASimple%3A%3AHTML%3A%3AContentdecl/markdown) = q{}; Set the value that will be embedded in the opening tags of F, C tags and verbatim text. F maps to , C maps to , Verbatim text maps to (Computerese defaults to "") $[Pod::Simple::HTML::Computerese](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3ASimple%3A%3AHTML%3A%3AComputerese/markdown) = ' class="some_class_name'; html_css html_javascript title_prefix title_postfix html_header_before_title This includes everything before the 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_anchor By default [Pod::Simple::HTML](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3ASimple%3A%3AHTML/markdown) adds a dummy anchor at the top of the HTML. You can change it by calling $p->top_anchor('<a name="zz" >'); html_h_level Normally =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)](https://www.chedong.com/phpMan.php/man/htmlhlevel/3/markdown); Will make sure that =head1 will become <h3> and =head2 will become <h4> etc... index Set 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)](https://www.chedong.com/phpMan.php/man/index/1/markdown); html_header_after_title Includes the closing tag of and through the rest of the head till the opening of the body $p->html_header_after_title('...'); html_footer The very end of the document: $p->html_footer( qq[\n\n\n\n] ); ## SUBCLASSING Can use any of the methods described above but for further customization one needs to override some of the methods: package [My::Pod](https://www.chedong.com/phpMan.php/perldoc/My%3A%3APod/markdown); use strict; use warnings; use base '[Pod::Simple::HTML](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3ASimple%3A%3AHTML/markdown)'; # needs to return a URL string such # # #anchor_in_the_same_file # /internal/ref.html sub do_pod_link { # [My::Pod](https://www.chedong.com/phpMan.php/perldoc/My%3A%3APod/markdown) object and [Pod::Simple::PullParserStartToken](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3ASimple%3A%3APullParserStartToken/markdown) 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](https://www.chedong.com/phpMan.php/perldoc/SUPER%3A%3Adopodlink/markdown)($link); return $ret; } 1; Meanwhile in script.pl: use [My::Pod](https://www.chedong.com/phpMan.php/perldoc/My%3A%3APod/markdown); my $p = [My::Pod](https://www.chedong.com/phpMan.php/perldoc/My%3A%3APod/markdown)->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 ALSO [Pod::Simple](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3ASimple/markdown), [Pod::Simple::HTMLBatch](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3ASimple%3A%3AHTMLBatch/markdown) TODO: a corpus of sample Pod input and HTML output? Or common idioms? ## SUPPORT Questions or discussion about POD and [Pod::Simple](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3ASimple/markdown) should be sent to the mail list. Send an empty email to to subscribe. This module is managed in an open GitHub repository, <>. Feel free to fork and contribute, or to clone and send patches! Patches against [Pod::Simple](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3ASimple/markdown) are welcome. Please send bug reports to <>. ## COPYRIGHT AND DISCLAIMERS Copyright (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. ## ACKNOWLEDGEMENTS Thanks to Hurricane Electric <> for permission to use its Linux man pages online <> site for man page links. Thanks to search.cpan.org <> for permission to use the site for Perl module links. ## AUTHOR [Pod::Simple](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3ASimple/markdown) was created by Sean M. Burke <>. But don't bother him, he's retired. [Pod::Simple](https://www.chedong.com/phpMan.php/perldoc/Pod%3A%3ASimple/markdown) is maintained by: * Allison Randal "" * Hans Dieter Pearcey "" * David E. Wheeler ""