John McNamara > App-Pod2Epub > App::Pod2Epub

Download:
App-Pod2Epub-0.05.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.05   Source  

NAME ^

App::Pod2Epub - Convert Pod to an ePub eBook.

DESCRIPTION ^

This module is used for converting Pod documents to ePub eBooks. The output eBook can be read on a variety of hardware and software eBook readers.

Pod is Perl's Plain Old Documentation format, see http://perldoc.perl.org/perlpod.html. EPub is an eBook format, see http://en.wikipedia.org/wiki/Epub.

This module comes with a pod2epub utility that will convert Pod to an ePub eBook.

SYNOPSIS ^

To create a simple filter to convert Pod to an XHTML format suitable for inclusion in an ePub eBook.

    #!/usr/bin/perl -w

    use strict;
    use App::Pod2Epub;


    my $parser = App::Pod2Epub->new();

    if (defined $ARGV[0]) {
        open IN, $ARGV[0]  or die "Couldn't open $ARGV[0]: $!\n";
    } else {
        *IN = *STDIN;
    }

    if (defined $ARGV[1]) {
        open OUT, ">$ARGV[1]" or die "Couldn't open $ARGV[1]: $!\n";
    } else {
        *OUT = *STDOUT;
    }

    $parser->output_fh(*OUT);
    $parser->parse_file(*IN);

    __END__

To convert Pod to ePub using the installed pod2epub utility:

    pod2epub some_module.pm -o some_module.epub

USING THIS MODULE ^

At the moment this module isn't very useful on its own. It is mainly in existence as a backend for pod2epub.

It provides a framework to convert Pod documents to an XHTML format suitable for inclusion in an ePub eBook. The ePub creation is handled by EBook::EPUB in pod2epub. Future versions will move that functionality into this module so that it has a utility of its own.

METHODS ^

new()

The new method is used to create a new App::Pod2Epub object.

Other methods

App::Pod2Epub inherits all of the methods of its parent modules Pod::Simple and Pod::Simple::XHTML. See Pod::Simple for more details if you need finer control over the output of this module.

SEE ALSO ^

This module also installs a pod2epub command line utility. See pod2epub --help for details.

EBook::EPUB, a general module for generating EPUB documents.

Pod::Simple::XHTML which this module subclasses.

ACKNOWLEDGEMENTS ^

Thanks to Sean M. Burke and the past and current maintainers for Pod::Simple.

Thanks to Oleksandr Tymoshenko for the excellent EBook::EPUB.

AUTHOR ^

John McNamara, jmcnamara@cpan.org

COPYRIGHT & LICENSE ^

Copyright 2010-2012 John McNamara.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License. See http://dev.perl.org/licenses/ for more information.

syntax highlighting: