Christopher J. Madsen > Dist-Zilla-Plugin-PodLoom-5.00 > Dist::Zilla::Plugin::PodLoom

Download:
Dist-Zilla-Plugin-PodLoom-5.00.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 5.00   Source  

NAME ^

Dist::Zilla::Plugin::PodLoom - Process module documentation through Pod::Loom

VERSION ^

This document describes version 5.00 of Dist::Zilla::Plugin::PodLoom, released November 13, 2013 as part of Dist-Zilla-Plugin-PodLoom version 5.00.

SYNOPSIS ^

In your dist.ini:

  [PodLoom]
  template = Default      ; this is the default
  data = loom.pl          ; there is no default for this

DESCRIPTION ^

If included, this plugin will process each .pm and .pod file under lib or in the root directory through Pod::Loom.

ATTRIBUTES ^

data

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 weave method.

PodLoom automatically includes the following keys, which will be merged with the hashref from your code. (Your code can override these values.)

abstract

The abstract for the file being processed (if it can be determined)

authors

$zilla->authors

dist

$zilla->name

license_notice

$zilla->license->notice

module

The primary package of the file being processed (if Module::Build::ModuleInfo could determine it)

repository

$zilla->distmeta->{resources}{repository}{web} (or the url key if web is not set)

version

The version number of the file being processed (if Module::Build::ModuleInfo could determine it)

zilla

The Dist::Zilla object itself

finder

This is the name of a FileFinder whose files will be processed by Pod::Loom. It may be specified multiple times. The default value is :InstallModules.

template

This will be passed to Pod::Loom as its template. Defaults to Default.

INCOMPATIBILITIES ^

None reported.

BUGS AND LIMITATIONS ^

No bugs have been reported.

AUTHOR ^

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.

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2013 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.

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 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.

syntax highlighting: