chromatic > Pod-PseudoPod-0.18 > Pod::PseudoPod::HTML

Download:
Pod-PseudoPod-0.18.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  2
Open  0
View/Report Bugs
Module Version: 0.18   Source  

NAME ^

Pod::PseudoPod::HTML -- format PseudoPod as HTML

SYNOPSIS ^

  use Pod::PseudoPod::HTML;

  my $parser = Pod::PseudoPod::HTML->new();

  ...

  $parser->parse_file('path/to/file.pod');

DESCRIPTION ^

This class is a formatter that takes PseudoPod and renders it as wrapped html.

This is a subclass of Pod::PseudoPod and inherits all its methods.

METHODS ^

add_body_tags

  $parser->add_body_tags(1);
  $parser->parse_file($file);

Adds beginning and ending "<html>" and "<body>" tags to the formatted document.

add_css_tags

  $parser->add_css_tags(1);
  $parser->parse_file($file);

Imports a css stylesheet to the html document and adds additional css tags to url, footnote, and sidebar elements for a nicer display. If you don't plan on writing a style.css file (or using the one provided in "examples/"), you probably don't want this option on.

SEE ALSO ^

Pod::PseudoPod, Pod::Simple

COPYRIGHT ^

Copyright (c) 2003-2004 Allison Randal. All rights reserved.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of the license can be found in the LICENSE file included with this module.

This library 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 ^

Allison Randal <allison@perl.org>

syntax highlighting: