Pod::PseudoPod::LaTeX - convert Pod::PseudoPod documents into LaTeX


Pod-PseudoPod-LaTeX documentation  | view source Contained in the Pod-PseudoPod-LaTeX distribution.

Index


NAME

Top

Pod::PseudoPod::LaTeX - convert Pod::PseudoPod documents into LaTeX

VERSION

Top

version 1.101650

SYNOPSIS

Top

This module is a Pod::PseudoPod subclass, itself a Pod::Simple subclass. This means that this is a full-fledged POD parser. Anything those modules can do, this can do.

Perhaps a little code snippet.

    use Pod::PseudoPod::LaTeX;

    my $parser = Pod::PseudoPod::LaTeX->new();
        $parser->emit_environments( sidebar => 'sidebar' );
    $parser->output_fh( $some_fh );
    $parser->parse_file( 'some_document.pod' );

    ...

LATEX PRELUDE

Top

The generated LaTeX code needs some packages to be loaded to work correctly. Currently it needs

    \usepackage{fancyvrb}

The standard font in LaTeX (Computer Modern) does not support bold and italic variants of its monospace font, an alternative is

    \usepackage[T1]{fontenc}
    \usepackage{textcomp}
    \usepackage[scaled]{beramono}

STYLES / EMITTING ENVIRONMENTS

Top

The emit_environments method accepts a hashref whose keys are POD environments and values are latex environments. Use this method if you would like Pod::PseudoPod::LaTeX to emit a simple \begin{foo}...\end{foo} environment rather than emit specific formatting codes. You must define any environemtns you use in this way in your latex prelude.

AUTHOR

Top

chromatic, <chromatic at wgz.org>

BUGS

Top

Please report any bugs or feature requests to bug-pod-pseudopod-tex at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Pod-PseudoPod-LaTeX. I'll hear about it and you'll hear about any progress on your bug as I make changes.

SUPPORT

Top

Read this documentation with the perldoc command:

    $ B<perldoc Pod::PseudoPod::LaTeX>

You can also look for information at:

* AnnoCPAN: Annotated CPAN documentation

http://annocpan.org/dist/Pod-PseudoPod-LaTeX

* CPAN Ratings

http://cpanratings.perl.org/d/Pod-PseudoPod-LaTeX

* RT: CPAN's request tracker

http://rt.cpan.org/NoAuth/Bugs.html?Dist=Pod-PseudoPod-LaTeX

* Search CPAN

http://search.cpan.org/dist/Pod-PseudoPod-LaTeX

ACKNOWLEDGEMENTS and SEE ALSO

Top

Based on Allison Randal's Pod::PseudoPod module.

See also perlpod, Pod::Simple and Pod::TeX. I did not reuse the latter because I need to support the additional POD directives found in PseudoPod.

Thanks to Onyx Neon Press (http://www.onyxneon.com/) for sponsoring this work under free software guidelines.

COPYRIGHT & LICENSE

Top


Pod-PseudoPod-LaTeX documentation  | view source Contained in the Pod-PseudoPod-LaTeX distribution.