The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Dist-Zilla-PluginBundle-DROLSKY-1.22
River stage zero No dependents
1 ++
/ Pod::Weaver::PluginBundle::DROLSKY

NAME

Pod::Weaver::PluginBundle::DROLSKY - A plugin bundle for pod woven by DROLSKY

VERSION

version 1.22

SYNOPSIS

In your weaver.ini:

    [@DROLSKY]

Or in your dist.ini

    [PodWeaver]
    config_plugin = @DROLSKY

It is also used automatically when your dist.ini contains:

    [@DROLSKY]
    :version = 0.094

DESCRIPTION

The contents of this bundle were mostly copied from Pod::Weaver::PluginBundle::Author::ETHER.

This is a Pod::Weaver plugin bundle. It is approximately equal to the following weaver.ini, minus some optimizations:

    [@CorePrep]

    [-SingleEncoding]

    [-Transformer / List]
    transformer = List

    [-Transformer / Verbatim]
    transformer = Verbatim

    [Region / header]
    [Name]
    [Version]

    [Region / prelude]

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

    [Collect / ATTRIBUTES]
    command = attr

    [Collect / METHODS]
    command = method

    [Collect / FUNCTIONS]
    command = func

    [Collect / TYPES]
    command = type

    [Leftovers]

    [Region / postlude]

    [GenerateSection / generate SUPPORT]
    title = SUPPORT
    main_module_only = 0
    text = <template>

    [AllowOverride / allow override SUPPORT]
    header_re = ^(SUPPORT|BUGS)
    action = prepend
    match_anywhere = 0

    ; Can be disabled in dist.ini with
    ;   DROLSKY::WeaverConfig.include_donations_pod = 0
    [GenerateSection / generate DONATIONS]
    title = DONATIONS
    main_module_only = 1
    text = ...

    [Authors]
    [Contributors]
    :version = 0.008

    [Legal]
    :version = 4.011
    header = COPYRIGHT AND <license filename>

    [Region / footer]

This is also equivalent (other than section ordering) to:

    [-Transformer / List]
    transformer = List
    [-Transformer / Verbatim]
    transformer = Verbatim

    [Region / header]
    [@Default]

    [Collect / TYPES]
    command = type

    [GenerateSection / generate SUPPORT]
    title = SUPPORT
    main_module_only = 0
    text = <template>

    [AllowOverride / allow override SUPPORT]
    header_re = ^(SUPPORT|BUGS)
    action = prepend
    match_anywhere = 0

    [GenerateSection / generate DONATIONS]
    title = DONATIONS
    main_module_only = 0
    text = ...

    [Contributors]
    :version = 0.008

    [Region / footer]

OPTIONS

None at this time. (The bundle is never instantiated, so this doesn't seem to be possible without updates to Pod::Weaver.)

OVERRIDING A SPECIFIC SECTION

This weaver.ini will let you use a custom COPYRIGHT AND LICENSE section and still use the plugin bundle:

    [@DROLSKY]
    [AllowOverride / OverrideLegal]
    header_re = ^COPYRIGHT
    match_anywhere = 1

ADDING STOPWORDS FOR SPELLING TESTS

As noted in Dist::Zilla::PluginBundle::DROLSKY, stopwords for spelling tests can be added by adding a directive to pod:

    =for stopwords foo bar baz

However, if the stopword appears in the module's abstract, it is moved to the NAME section, which will be above your stopword directive. You can handle this by declaring the stopword in the special header section, which will be woven ahead of everything else:

    =for :header
    =for stopwords foo bar baz

SEE ALSO

SUPPORT

Bugs may be submitted at https://github.com/autarch/Dist-Zilla-PluginBundle-DROLSKY/issues.

SOURCE

The source code repository for Dist-Zilla-PluginBundle-DROLSKY can be found at https://github.com/autarch/Dist-Zilla-PluginBundle-DROLSKY.

AUTHOR

Dave Rolsky <autarch@urth.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2013 - 2022 by Dave Rolsky.

This is free software, licensed under:

  The Artistic License 2.0 (GPL Compatible)

The full text of the license can be found in the LICENSE file included with this distribution.