NAME
Pod::Advent - POD Formatter for The Perl Advent Calendar
VERSION
Version 0.01
SYNOPSIS
use Pod::Advent;
my $pod = shift @ARGV or die "need pod filename";
my $advent = Pod::Advent->new;
$advent->parse_file( \*STDIN );
DESCRIPTION
This module provides a POD formatter that is designed to facilitate the create of submissions for The Perl Advent Calendar (http://perladvent.pm.org) by providing authors with simple markup that will be automatically transformed to full-fill the specific formatting guidelines. This makes it easier for authors to provide calendar-ready submissions, and for the editors to save lots of time in editting submissions.
For example, 'file-, module and program names should be wrapped in <tt>,' and 'the code sample should be appended to the document from the results of a perltidy -nnn -html'. Both of these can be trivially accomplished:
This entry is for M<Foo::Bar> and the F<scrip.pl> program.
=sourcedcode mod0.pl
The meta-data of title, date (year & day), and author is now easy to specify as well, and is used to automatically generate the full HTML header (including style) that the calendar entries require before being posted.
SUPPORTED POD
Custom Codes
A<>
M<>
N<>
Custom Directives
sourcedcode
Custom Targets
advent_title
advent_author
advent_year
advent_day
code
codeNNN
pre
quote
eds
Standard Codes
L<>
F<>
C<>
I<>
B<>
Standard Directives
headN
TODO
create test suite
include sample.pod and sample.html
code cleanup (remove the =head1 NAME support, and Y-code support)
code refactoring (package var usage; also maybe make code/directive behavior based on a config data structure)
footnotes
over/item
optional stylesheet
supported pod docs
docs re: html passing through
METHODS
See Pod::Simple for all of the inherited methods. Also see Pod::Simple::Subclassing for more information.
new
Constructor. See Pod::Simple.
AUTHOR
David Westbrook, <dwestbrook at gmail.com>
BUGS
Please report any bugs or feature requests to bug-pod-advent at rt.cpan.org
, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Pod-Advent. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
SUPPORT
You can find documentation for this module with the perldoc command.
perldoc Pod::Advent
You can also look for information at:
RT: CPAN's request tracker
AnnoCPAN: Annotated CPAN documentation
CPAN Ratings
Search CPAN
SEE ALSO
http://perladvent.pm.org - The Perl Advent Calendar
http://perladvent.pm.org/2007/17 - The 2007-12-17 submission that discussed this application of Pod::Simple
Pod::Simple - The base class for Pod::Advent
Pod::Simple::Subclassing - Discusses the techniques that Pod::Advent is based on
perlpod - POD documentation
Perl::Tidy - used for formatting code
ACKNOWLEDGEMENTS
The maintainers of The Perl Advent Calendar at http://perladvent.pm.org.
The 2007 editors, Bill Ticker & Jerrad Pierce, for reviewing and providing feedback on this concept.
COPYRIGHT & LICENSE
Copyright 2007 David Westbrook, all rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.