view release on metacpan or  search on metacpan

lib/Pod/Weaver/PluginBundle/Author/MAXHQ.pm  view on Meta::CPAN

use strict;
package Pod::Weaver::PluginBundle::Author::MAXHQ;
# ABSTRACT: MAXHQ's default Pod::Weaver configuration
$Pod::Weaver::PluginBundle::Author::MAXHQ::VERSION = '3.3.3';
# Thanks to
# - Joshua Keroes (http://rjbs.manxome.org/rubric/entry/1809)
# - rjbs (http://de.slideshare.net/jkeroes/getting-started-with-podweaver)

#pod =head1 SYNOPSIS
#pod
#pod Put the following into your C<weaver.ini>:
#pod
#pod     [@Author::MAXHQ]
#pod
#pod =head1 OVERVIEW
#pod
#pod Currently this plugin bundle is equivalent to:
#pod
#pod     [@CorePrep]
#pod
#pod     [Name]
#pod     [Version]
#pod
#pod     ;#
#pod     ;# prelude
#pod     ;#
#pod     [Region  / prelude]
#pod
#pod     [Generic / SYNOPSIS]
#pod     [Generic / DESCRIPTION]
#pod     [Generic / OVERVIEW]
#pod
#pod     [Extends]
#pod
#pod     ;#
#pod     ;# functions etc.
#pod     ;#
#pod     [Collect / REX TASKS]
#pod     command = rex_task
#pod
#pod     [Collect / MOJOLICIOUS PLUGINS]
#pod     command = mojo_plugin
#pod
#pod     [Collect / MOJOLICIOUS SHORTCUTS]
#pod     command = mojo_short
#pod
#pod     [Collect / MOJOLICIOUS CONDITIONS]
#pod     command = mojo_cond
#pod
#pod     [Collect / MOJOLICIOUS HELPERS]
#pod     command = mojo_helper
#pod
#pod     [Collect / FUNCTIONS ]
#pod     command = func
#pod
#pod     [Collect / ATTRIBUTES]
#pod     command = attr
#pod
#pod     [Collect / METHODS REQUIRED BY THIS ROLE]
#pod     command = requires
#pod
#pod     [Collect / CLASS METHODS]
#pod     command = class_method
#pod
#pod     [Collect / METHODS]
#pod     command = method
#pod
#pod
#pod     [Leftovers]
#pod
#pod     ;#
#pod     ;# postlude
#pod     ;#
#pod     [Region  / postlude]
#pod
#pod     [Authors]
#pod     [Legal]
#pod
#pod     ;#
#pod     ;# plugins
#pod     ;#
#pod     [-Transformer]
#pod     transformer = List
#pod
#pod =cut

use Pod::Weaver::Config::Assembler;
sub _exp { Pod::Weaver::Config::Assembler->expand_package($_[0]) }

#pod =for Pod::Coverage mvp_bundle_config
#pod
#pod =cut
#
#Returns my C<Pod::Weaver> plugin configuration. Based on
#L<Pod::Weaver::PluginBundle::RJBS>.
#
#The return format is a list of ArrayRefs, where each ArrayRef looks like:
#
#    [$name, $package, $payload]
#
#(Described in L<Config::MVP::Assembler::WithBundles/replace_bundle_with_contents>)
#
#This method is called by L<Pod::Weaver>, or more specific by
#L<Config::MVP::Assembler::WithBundles/replace_bundle_with_contents>.
sub mvp_bundle_config {
    return (
        [ '@MAXHQ/CorePrep',       _exp('@CorePrep'),        {} ],
        [ '@MAXHQ/Name',           _exp('Name'),             {} ],
        [ '@MAXHQ/Version',        _exp('Version'),          {} ],

        # Header
        [ '@MAXHQ/Prelude',        _exp('Region'),  { region_name => 'prelude'     } ],

        [ '@MAXHQ/Synopsis',       _exp('Generic'), { header      => 'SYNOPSIS'    } ],
        [ '@MAXHQ/Description',    _exp('Generic'), { header      => 'DESCRIPTION' } ],
        [ '@MAXHQ/Overview',       _exp('Generic'), { header      => 'OVERVIEW'    } ],

        # Rex specific
        [ '@MAXHQ/RexTasks',       _exp('Collect'), { command => 'rex_task',     header => 'REX TASKS' } ],

lib/Pod/Weaver/PluginBundle/Author/MAXHQ.pm  view on Meta::CPAN

=head1 NAME

Pod::Weaver::PluginBundle::Author::MAXHQ - MAXHQ's default Pod::Weaver configuration

=head1 VERSION

version 3.3.3

=head1 SYNOPSIS

Put the following into your C<weaver.ini>:

    [@Author::MAXHQ]

=head1 OVERVIEW

Currently this plugin bundle is equivalent to:

    [@CorePrep]

    [Name]
    [Version]

    ;#
    ;# prelude
    ;#
    [Region  / prelude]

    [Generic / SYNOPSIS]
    [Generic / DESCRIPTION]
    [Generic / OVERVIEW]

    [Extends]

    ;#
    ;# functions etc.
    ;#
    [Collect / REX TASKS]
    command = rex_task

    [Collect / MOJOLICIOUS PLUGINS]
    command = mojo_plugin

    [Collect / MOJOLICIOUS SHORTCUTS]
    command = mojo_short

    [Collect / MOJOLICIOUS CONDITIONS]
    command = mojo_cond

    [Collect / MOJOLICIOUS HELPERS]
    command = mojo_helper

    [Collect / FUNCTIONS ]
    command = func

    [Collect / ATTRIBUTES]
    command = attr

    [Collect / METHODS REQUIRED BY THIS ROLE]
    command = requires

    [Collect / CLASS METHODS]
    command = class_method

    [Collect / METHODS]
    command = method


    [Leftovers]

    ;#
    ;# postlude
    ;#
    [Region  / postlude]

    [Authors]
    [Legal]

    ;#
    ;# plugins
    ;#
    [-Transformer]
    transformer = List

=for Pod::Coverage mvp_bundle_config

=head1 AUTHOR

Jens Berthold <jens.berthold@jebecs.de>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2016 by Jens Berthold.

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

=cut