podtree2html: Translate a pod to html

SYNOPSIS

\*(C`podtree2html\*(C' [\*(C`--base\*(C' url] [\*(C`--css\*(C' url] [\*(C`--\*(C'[\*(C`no\*(C']\*(C`toc\*(C'] [\*(C`--hr\*(C' level] [\*(C`--bgcolor\*(C' #rrggbb] [\*(C`--text\*(C' #rrggbb] [\*(C`--variables\*(C' values.pl] source dest [template] [variable=value ...]]

DESCRIPTION

\*(C`podtree2html\*(C' reads the \s-1POD\s0 in file source, translates it to \s-1HTML\s0, and writes it to file dest. dest is created world-readable.

If a template file is provided, then template will be filled in by the \*(C`Text::Template\*(C' module and written to dest. Here is a minimal template, showing all the variables that are set by \*(C`podtree2html\*(C'.

  <html>
   <head>
    <base href="{$base}">
    <link href="{$css}" rel="stylesheet" type="text/css">
    <title>{$title}</title>
   </head>
   <body bgcolor="{$bgcolor}" text="{$text}">
    {$toc}
    {$body}
   </body>
  </html>

If the \*(C`--variables\*(C' option is provided, then the file values.pl will be executed with a \*(C`do\*(C' call before the template is filled in. values.pl may contain arbitrary Perl code. The program fragments in the template are evaulted in the \*(C`Pod::Tree::HTML\*(C' package. Any variables that values.pl sets in this package will be available to the template.

Additional scalar variables may be set on the command line with the variable=value syntax. Do not prefix variable with a \*(C`$\*(C' sigil. Variables set on the command line override variables set in values.pl.

OPTIONS

Translate \*(C`L<>\*(C' sequences into \s-1HTML\s0 links relative to url. Specifies a Cascanding Style Sheet for the generated \s-1HTML\s0 page. Here are example rules for all the different \s-1HTML\s0 elements that may appear in a \s-1POD\s0. a:link { background: #ff8080 } body { background: #f0f0f0 } code { background: #c0ffc0 } dd { background: #ffffe0 } dl { background: #fffff0 } dt { background: #ffffc0 } h1 { background: #ffc0c0 } h2 { background: #ffe0e0 } hr { background: #ff0000; height: 5px } i { background: #ffc0c0 } li { background: #e0e0e0 } ol { background: #fff0ff } p { background: #f0f0ff } pre { background: #f0fff0 } ul { background: #f0ffff } Includes or omits the table of contents. Default is to include the \s-1TOC\s0. Controls the profusion of horizontal lines in the output, as follows: level horizontal lines 0 none 1 between TOC and body 2 after each =head1 3 after each =head1 and =head2 Default is level 1. Set the background color to #rrggbb. Default is white. Set the text color to #rrggbb. Default is black. Execute the file values.pl with a \*(C`do\*(C' call before filling in template. values.pl may contain arbitrary Perl code.

REQUIRES

\*(C`Pod::Tree::HTML\*(C'

RELATED TO podtree2html…

\*(C`pods2html\*(C', \*(C`Pod::Tree::HTML\*(C'

AUTHOR

Steven McDougall, <[email protected]>

podtree2html (1p)