Hacking Thy Fearful Symmetry

Hacker, hacker coding bright

Pod::Manual

July 14, 2007
pod::manual perl

A while ago, I hacked together a way to gather many pod files into a single pdf file. Well, finally I got around cleaning up the code and released it as Pod::Manual.

It's still very muchly alpha quality, but the basics seem to work. For example, the following works (at least on my machine)[*]:

use Pod::Manual;
 
my $manual = Pod::Manual->new({ title => 'Catalyst' });
 
$manual->add_chapter( $_ ) for qw/
    Catalyst::Manual::About
    Catalyst::Manual::Actions
    Catalyst::Manual::Cookbook
    Catalyst::Manual::DevelopmentProcess
    Catalyst::Manual::Internals
    Catalyst::Manual::Intro
    Catalyst::Manual::Plugins
    Catalyst::Manual::Tutorial
    Catalyst::Manual::Tutorial::Intro
    Catalyst::Manual::Tutorial::CatalystBasics
    Catalyst::Manual::Tutorial::BasicCRUD
    Catalyst::Manual::Tutorial::Authentication
    Catalyst::Manual::Tutorial::Authorization
    Catalyst::Manual::Tutorial::Debugging
    Catalyst::Manual::Tutorial::Testing
    Catalyst::Manual::Tutorial::AdvancedCRUD
    Catalyst::Manual::Tutorial::Appendices
    Catalyst::Manual::WritingPlugins
/;
 
$manual->save_as_pdf( 'catalyst_manual.pdf' );

At this stage of the game, bug reports and feature requests would be very welcome. As well as suggestions for other example manuals.

[*] caveat: for the moment you need TeTeX installed to generate pdf documents. One of the items on my todo list is to allow for other means to generate the pdf (jadetex, FOP, etc)

comments powered by Disqus

About the author

Yanick Champoux
Perl necrohacker , ACP writer, orchid lover. Slightly bonker all around. he/him/his