```{index} single: Pod::Simple::HTML
```
# Pod::Simple::HTML
convert Pod to HTML
## SYNOPSIS
```text
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](PullParser.md) 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](HTMLBatch.md).
## CALLING FROM THE COMMAND LINE
TODO
```text
perl -MPod::Simple::HTML -e Pod::Simple::HTML::go Thing.pod Thing.html
```
## CALLING FROM PERL
### Minimal code
```perl
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
```perl
use Pod::Simple::HTML;
```
Set the content type:
```perl
$Pod::Simple::HTML::Content_decl = q{};
my $p = Pod::Simple::HTML->new;
```
Include a single javascript source:
```perl
$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)
```perl
$p->html_javascript('
');
```
Include a single css source in the header:
```perl
$p->html_css('/style.css');
```
or insert multiple css sources:
```perl
$p->html_css('
');
```
Tell the parser where should the output go. In this case it will be placed in the $html variable:
```perl
my $html;
$p->output_string(\$html);
```
Parse and process a file with pod in it:
```perl
$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:
```perl
$Pod::Simple::HTML::Doctype_decl = qq{\n};
```
Set the content-type in the HTML head: (defaults to ISO-8859-1)
```perl
$Pod::Simple::HTML::Content_decl = q{};
```
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 "")
```perl
$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:
```perl
$p->html_header_before_title('');
```
### top\_anchor
By default Pod::Simple::HTML adds a dummy anchor at the top of the HTML.
You can change it by calling
```perl
$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:
```perl
$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.
```perl
$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
```perl
$p->html_header_after_title('...');
```
### html\_footer
The very end of the document:
```perl
$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:
```perl
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:
```perl
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 ALSO
[Pod::Simple](../Simple.md), [Pod::Simple::HTMLBatch](HTMLBatch.md)
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/](https://github.com/perl-pod/pod-simple/). Feel free to fork and contribute, or
to clone [https://github.com/perl-pod/pod-simple.git](https://github.com/perl-pod/pod-simple.git) and send patches!
Patches against Pod::Simple 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.
## AUTHOR
Pod::Simple was created by Sean M. Burke .
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`