Perl 5 version documentation

Pod::Simple::HTML

NAME

Pod::Simple::HTML - convert Pod to HTML

SYNOPSIS

  1.   perl -MPod::Simple::HTML -e Pod::Simple::HTML::go thingy.pod

DESCRIPTION

This 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 LINE

TODO

  1.   perl -MPod::Simple::HTML -e Pod::Simple::HTML::go Thing.pod Thing.html

CALLING FROM PERL

Minimal code

  1.   use Pod::Simple::HTML;
  2.   my $p = Pod::Simple::HTML->new;
  3.   $p->output_string(\my $html);
  4.   $p->parse_file('path/to/Module/Name.pm');
  5.   open my $out, '>', 'out.html' or die "Cannot open 'out.html': $!\n";
  6.   print $out $html;

More detailed example

  1.   use Pod::Simple::HTML;

Set the content type:

  1.   $Pod::Simple::HTML::Content_decl =  q{<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" >};
  3.   my $p = Pod::Simple::HTML->new;

Include a single javascript source:

  1.   $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)

  1.   $p->html_javascript('
  2.             <script type="text/javascript" src="http://abc.com/b.js"></script>
  3.             <script type="text/javascript" src="http://abc.com/c.js"></script>');

Include a single css source in the header:

  1.   $p->html_css('/style.css');

or insert multiple css sources:

  1.   $p->html_css('
  2.             <link rel="stylesheet" type="text/css" title="pod_stylesheet" href="http://remote.server.com/jquery.css">
  3.             <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:

  1.   my $html;
  2.   $p->output_string(\$html);

Parse and process a file with pod in it:

  1.   $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 <html> tag:

  1.   $Pod::Simple::HTML::Doctype_decl = qq{<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" 
  2. 	 	 "http://www.w3.org/TR/html4/loose.dtd">\n};

Set the content-type in the HTML head: (defaults to ISO-8859-1)

  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 "")

  1.   $Pod::Simple::HTML::Computerese =  ' class="some_class_name';

html_css

html_javascript

title_prefix

title_postfix

html_header_before_title

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:

  1.   $p->html_header_before_title('<html><head><title>');

top_anchor

By default Pod::Simple::HTML adds a dummy anchor at the top of the HTML. You can change it by calling

  1.   $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:

  1.   $p->html_h_level(3);

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.

  1.   $p->index(1);

html_header_after_title

Includes the closing tag of </title> and through the rest of the head till the opening of the body

  1.   $p->html_header_after_title('</title>...</head><body id="my_id">');

html_footer

The very end of the document:

  1.   $p->html_footer( qq[\n<!-- end doc -->\n\n</body></html>\n] );

SUBCLASSING

Can use any of the methods described above but for further customization one needs to override some of the methods:

  1.   package My::Pod;
  2.   use strict;
  3.   use warnings;
  5.   use base 'Pod::Simple::HTML';
  7.   # needs to return a URL string such
  8.   # http://some.other.com/page.html
  9.   # #anchor_in_the_same_file
  10.   # /internal/ref.html
  11.   sub do_pod_link {
  12.     # My::Pod object and Pod::Simple::PullParserStartToken object
  13.     my ($self, $link) = @_;
  15.     say $link->tagname;          # will be L for links
  16.     say $link->attr('to');       # 
  17.     say $link->attr('type');     # will be 'pod' always
  18.     say $link->attr('section');
  20.     # Links local to our web site
  21.     if ($link->tagname eq 'L' and $link->attr('type') eq 'pod') {
  22.       my $to = $link->attr('to');
  23.       if ($to =~ /^Padre::/) {
  24.           $to =~ s{::}{/}g;
  25.           return "/docs/Padre/$to.html";
  26.       }
  27.     }
  29.     # all other links are generated by the parent class
  30.     my $ret = $self->SUPER::do_pod_link($link);
  31.     return $ret;
  32.   }
  34.   1;

Meanwhile in script.pl:

  1.   use My::Pod;
  3.   my $p = My::Pod->new;
  5.   my $html;
  6.   $p->output_string(\$html);
  7.   $p->parse_file('path/to/Module/Name.pm');
  8.   open my $out, '>', 'out.html' or die;
  9.   print $out $html;

TODO

maybe override do_beginning do_end

SEE ALSO

Pod::Simple, Pod::Simple::HTMLBatch

TODO: a corpus of sample Pod input and HTML output? Or common idioms?

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, 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 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 was created by Sean M. Burke <sburke@cpan.org>. But don't bother him, he's retired.

Pod::Simple is maintained by:

  • Allison Randal allison@perl.org
  • Hans Dieter Pearcey hdp@cpan.org
  • David E. Wheeler dwheeler@cpan.org