Marcel Grünauer > Template-Plugin-CPAN-Packages > Template::Plugin::CPAN::Packages

Download:
Template-Plugin-CPAN-Packages-0.03.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.03   Source  

NAME ^

Template::Plugin::CPAN::Packages - Template plugin to help generate CPAN bundles

SYNOPSIS ^

in Bundle::MARCEL:

    =head1 CONTENTS

    [%
        USE c = CPAN.Packages
            '/Users/marcel/mirrors/minicpan/modules/02packages.details.txt.gz';
        c.bundle_for_author(
            'cpanid'   => 'MARCEL',
            'unwanted' => [ 'Class::Factory::Patched' ]
        );
    %]

DESCRIPTION ^

This is a plugin for the Template Toolkit that you can use to generate CPAN bundles. It works together with Pod::Generated. Use it as shown in the synopsis.

When you instantiate the plugin, you have to pass the name of the 02packages.details.txt.gz file. You might find it in your ~/.cpan directory or in your CPAN::Mini mirror, if you keep one.

METHODS ^

bundle_for_author

Creates the contents of a bundle for all the distributions an author using his unique CPAN ID. A bundle requires module names - e.g., Text::Pipe -, not distribution names - e.g., Text-Pipe -, however, so for each distribution, the primary module from that distribution is listed - that is the module with the shortest name.

Takes named arguments. The following keys are recognized:

cpanid

The CPAN ID of the author whose bundle you would like to create. For example, my CPAN ID is MARCEL.

unwanted

A single string or a reference to a list of strings of modules, and therefore, distributions, that should not be included in the list. This might be useful if an earlier version of one of your distributions included a module but newer ones don't. The old module will still be indexed, so it would be picked up by this method.

bundle_by_dist_prefix

Creates the contents of a bundle for all the distributions whose name starts with a given prefix. A bundle requires module names - e.g., Text::Pipe -, not distribution names - e.g., Text-Pipe -, however, so for each distribution, the primary module from that distribution is listed - that is the module with the shortest name.

Takes named arguments. The following keys are recognized:

prefix

All distributions with the given prefix are included. Note that this is a distribution name prefix - e.g., Text-Pipe -, not a module name prefix - e.g., Text::Pipe.

unwanted

A single string or a reference to a list of strings of modules, and therefore, distributions, that should not be included in the list.

TAGS ^

If you talk about this module in blogs, on del.icio.us or anywhere else, please use the templateplugincpanpackages tag.

VERSION ^

This document describes version 0.03 of Template::Plugin::CPAN::Packages.

BUGS AND LIMITATIONS ^

No bugs have been reported.

Please report any bugs or feature requests to <bug-template-plugin-cpan-packages@rt.cpan.org>, or through the web interface at http://rt.cpan.org.

INSTALLATION ^

See perlmodinstall for information and options on installing Perl modules.

AVAILABILITY ^

The latest version of this module is available from the Comprehensive Perl Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a CPAN site near you. Or see <http://www.perl.com/CPAN/authors/id/M/MA/MARCEL/>.

AUTHOR ^

Marcel Grünauer, <marcel@cpan.org>

COPYRIGHT AND LICENSE ^

Copyright 2007-2008 by Marcel Grünauer

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: