NAME Pod::Weaver::PluginBundle::Apocalyptic - Let the apocalypse generate your POD! VERSION This document describes v0.002 of Pod::Weaver::PluginBundle::Apocalyptic - released March 05, 2011 as part of Pod-Weaver-PluginBundle-Apocalyptic. DESCRIPTION In your weaver.ini: [@Apocalyptic] Or alternatively, in your Dist::Zilla dist's dist.ini: [PodWeaver] config_plugin = @Apocalyptic This plugin bundle formats your POD and adds some sections and sets some custom options. Naturally, in order for most of the plugins to work, you need to use this in conjunction with Dist::Zilla. It is nearly equivalent to the following in your weaver.ini: [@CorePrep] ; setup the pod stuff [-Encoding] ; add the =encoding command to your POD via Pod::Weaver::Plugin::Encoding encoding = utf-8 [Region / Pod::Coverage] ; move any Pod::Coverage markers to the top ( =for Pod::Coverage foo bar ) [-StopWords] ; gather our stopwords and add some extra ones via Pod::Weaver::Plugin::StopWords [Name] ; automatically generate the NAME section [Version] ; automatically generate the VERSION section format = This document describes v%v of %m - released %{LLLL dd, yyyy}d as part of %r. is_verbatim = 1 [Generic / SYNOPSIS] ; move the SYNOPSIS section here, if it exists [Generic / DESCRIPTION] ; move the DESCRIPTION section here ( it is required to exist! ) required = 1 [Collect / ATTRIBUTES] ; get any POD marked as =attr and list them here command = attr [Collect / METHODS] ; get any POD marked as =method and list them here command = method [Collect / FUNCTIONS] ; get any POD marked as =func and list them here command = func [Leftovers] ; any other POD you use [SeeAlso] ; generate the SEE ALSO section via Pod::Weaver::Section::SeeAlso [Support] ; generate the SUPPORT section via Pod::Weaver::Section::Support ( only present in main module ) irc = irc.perl.org, #perl-help, Apocalypse irc = irc.freenode.net, #perl, Apocal irc = irc.efnet.org, #perl, Ap0cal email = APOCAL [Authors] ; automatically generate the AUTHOR(S) section [Generic / ACKNOWLEDGEMENTS] ; move the ACKNOWLEDGEMENTS section here, if it exists [Legal] ; automatically generate the COPYRIGHT AND LICENSE section [WarrantyDisclaimer] ; automatically generate the DISCLAIMER OF WARRANTY section via Pod::Weaver::Section::WarrantyDisclaimer [-Transformer] transformer = List ; mangle all :list pod into proper lists via Pod::Elemental::Transformer::List [-EnsureUniqueSections] ; sanity check your sections to make sure they are unique via Pod::Weaver::Plugin::EnsureUniqueSections If you need something to be configurable ( probably the Support section, ha! ) please let me know and I can add it in a future version. Future Plans auto image in POD? SEE ALSO Please see those modules/websites for more information related to this module. * Dist::Zilla * Pod::Weaver * Pod::Weaver::Plugin::Encoding * Pod::Weaver::Plugin::StopWords * Pod::Weaver::Section::SeeAlso * Pod::Weaver::Section::Support * Pod::Weaver::Section::WarrantyDisclaimer * Pod::Elemental::Transformer::List * Pod::Weaver::Plugin::EnsureUniqueSections SUPPORT Perldoc You can find documentation for this module with the perldoc command. perldoc Pod::Weaver::PluginBundle::Apocalyptic Websites The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources. * Search CPAN * RT: CPAN's Bug Tracker * AnnoCPAN: Annotated CPAN documentation * CPAN Ratings * CPAN Forum * CPANTS Kwalitee * CPAN Testers Results * CPAN Testers Matrix Email You can email the author of this module at "APOCAL at cpan.org" asking for help with any problems you have. Internet Relay Chat You can get live help by using IRC ( Internet Relay Chat ). If you don't know what IRC is, please read this excellent guide: . Please be courteous and patient when talking to us, as we might be busy or sleeping! You can join those networks/channels and get help: * irc.perl.org You can connect to the server at 'irc.perl.org' and join this channel: #perl-help then talk to this person for help: Apocalypse. * irc.freenode.net You can connect to the server at 'irc.freenode.net' and join this channel: #perl then talk to this person for help: Apocal. * irc.efnet.org You can connect to the server at 'irc.efnet.org' and join this channel: #perl then talk to this person for help: Ap0cal. Bugs / Feature Requests Please report any bugs or feature requests by email to "bug-pod-weaver-pluginbundle-apocalyptic at rt.cpan.org", or through the web interface at . You will be automatically notified of any progress on the request by the system. Source Code The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :) git clone git://github.com/apocalypse/perl-pod-weaver-pluginbundle-apocalyptic.git AUTHOR Apocalypse COPYRIGHT AND LICENSE This software is copyright (c) 2011 by Apocalypse. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. The full text of the license can be found in the LICENSE file included with this distribution. 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.