- BUGS AND LIMITATIONS
- COPYRIGHT AND LICENSE
- DISCLAIMER OF WARRANTY
Dist::Zilla::Plugin::PodLoom - Process module documentation through Pod::Loom
This document describes version 5.001 of Dist::Zilla::Plugin::PodLoom, released July 18, 2015 as part of Dist-Zilla-Plugin-PodLoom version 5.001.
In your dist.ini:
[PodLoom] template = Default ; this is the default data = loom.pl ; there is no default for this
If included, this plugin will process each .pm and .pod file under lib or in the root directory through Pod::Loom.
Since Pod::Loom templates may want configuration that doesn't fit in an INI file, you can specify a file containing Perl code to evaluate. The result should be a hash reference, which will be passed to Pod::Loom's
PodLoom automatically includes the following keys, which will be merged with the hashref from your code. (Your code can override these values.)
The abstract for the file being processed (if it can be determined)
The primary package of the file being processed. If Module::Metadata could not determine the package, or if it is explicitly
main, this is the filename (without directories), because that's the equivalent of a package name for scripts.
webis not set)
The version number of the file being processed (if Module::Metadata could determine it)
The Dist::Zilla object itself
This will be passed to Pod::Loom as its
template. Defaults to
No bugs have been reported.
Christopher J. Madsen
<perl AT cjmweb.net>
Please report any bugs or feature requests to
<bug-Dist-Zilla-Plugin-PodLoom AT rt.cpan.org> or through the web interface at http://rt.cpan.org/Public/Bug/Report.html?Queue=Dist-Zilla-Plugin-PodLoom.
You can follow or contribute to Dist-Zilla-Plugin-PodLoom's development at https://github.com/madsen/dist-zilla-plugin-podloom.
This software is copyright (c) 2015 by Christopher J. Madsen.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
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 LICENSE, 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.