Yanick Champoux > Pod-Manual-0.08_04 > Pod::Manual

Download:
Pod-Manual-0.08_04.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  5
Open  0
View/Report Bugs
Module Version: 0.08_04   Source  

NAME ^

Pod::Manual - Aggregates several PODs into a single manual

VERSION ^

This document describes Pod::Manual version 0.08

This module is still in early development and must be considered as alpha quality. Use with caution.

SYNOPSIS ^

    use Pod::Manual;

    my $manual = Pod::Manual->new( title => 'My Manual' );

    $manual->add_chapter( 'Some::Module' );
    $manual->add_chapter( 'Some::Other::Module' );

    $manual->save_as_pdf( 'manual.pdf' );

DESCRIPTION ^

The goal of Pod::Manual is to gather the pod of several modules into a comprehensive manual. Its primary objective is to generate a document that can be printed, but it also allow to output the document into other formats (e.g., docbook).

METHODS ^

new( %options )

Creates a new manual. Several options can be passed to the constructor:

title => $title

Sets the title of the manual to $title.

ignore_sections => $section_name
ignore_sections => \@sections_name

When importing pods, discards any section having its title set as $section_name or listed in @section_names.

pdf_generator => $generator

Sets the pdf generation engine to be used. Can be latex (the default) or prince.

add_chapter( $module, \%options )

    $manual->add_chapter( 'Pod::Manual', { set_title => 1 } );

Adds the pod of $module to the manual.

set_title

If true, uses the shortened title of the chapter as the title of the manual.

add_chapters( @modules, \%options )

    $manual->add_chapters( 'Some::Module', 'Some::Other::Module' )

Adds the pod of several modules to the manual.

as_docbook( { css => $filename } )

    print $manual->as_docbook({ css => 'stylesheet.css' });

Returns the manual in a docbook format. If the option css is given, a 'xml-stylesheet' PI pointing to $filename will be added to the document.

as_latex

    print $manual->as_latex;

Returns the manual in a LaTeX format.

save_as_pdf( $filename )

    $manual->save_as_pdf( '/path/to/document.pdf' );

Saves the manual as a pdf file. Several temporary files will be created (and later on cleaned up) in the same directory. If any of those files already exist, the method will abort.

Returns 1 if the pdf has been created, 0 otherwise.

NOTE: this function requires to have TeTeX installed and pdflatex accessible via the $PATH.

set_pdf_generator( $generator )

Sets the pdf generation engine to be used. Can be latex (the default) or prince.

get_pdf_generator

Returns the pdf generation engine used by the object.

BUGS AND LIMITATIONS ^

As this is a preliminary release, a lot of both.

Please report any bugs or feature requests to bug-pod-manual@rt.cpan.org, or through the web interface at http://rt.cpan.org.

REPOSITORY ^

Pod::Manual's development git repository can be accessed at git://github.com/yanick/pod-manual.git

AUTHOR ^

Yanick Champoux <yanick@cpan.org>

LICENCE AND COPYRIGHT ^

Copyright (c) 2007, Yanick Champoux <yanick@cpan.org>. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY ^

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

syntax highlighting: