NAME

Pod::Weaver::PluginBundle::Author::TABULO - A plugin bundle for pod woven for TABULO

VERSION

version 0.197

SYNOPSIS

In your weaver.ini:

    [@Author::TABULO]

Or in your dist.ini

    [PodWeaver]
    config_plugin = @Author::TABULO

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

    [@Author::TABULO]
    :version = 0.094    ; or any higher version

DESCRIPTION

This is a Pod::Weaver plugin bundle used for TABULO's distributions. Like his dzil plugin-bundle, the starting point of this profile was ETHER's.

And since TABULO initially forked the whole thing from ETHER's, most of the documentation you see here actually come from her originally, ...

Thank you ETHER!

WARNING

Please note that, although this module needs to be on CPAN for obvious reasons, it is really intended to be a collection of personal preferences, which are expected to be in great flux, at least for the time being.

Therefore, please do NOT base your own distributions on this one, since anything can change at any moment without prior notice, while I get accustomed to dzil myself and form those preferences in the first place... Absolutely nothing in this distribution is guaranteed to remain constant or be maintained at this point. Who knows, I may even give up on dzil altogether...

You have been warned.

DESCRIPTION (at last)

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

    [-EnsurePod5]
    [-H1Nester]

    [-SingleEncoding]

    [-Transformer / List]
    transformer = List

    [-Transformer / Verbatim]
    transformer = Verbatim

    [-Transformer / WikiDoc]  ; Added by TABULO
    transformer = WikiDoc

    [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

    [Authors]
    [Contributors]
    :version = 0.008

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

    [Region / footer]

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

    [-Transformer / List]
    transformer = List

    [-Transformer / Verbatim]
    transformer = Verbatim

    [-Transformer / WikiDoc]  ; Added by TABULO
    transformer = WikiDoc

    [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

    [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 LICENCE section and still use the plugin bundle:

    [@Author::TABULO]
    [AllowOverride / OverrideLegal]
    header_re = ^COPYRIGHT
    match_anywhere = 1

ADDING STOPWORDS FOR SPELLING TESTS

As noted in Dist::Zilla::PluginBundle::Author::TABULO, 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

• Pod::Weaver

• Pod::Weaver::PluginBundle::Default

• Dist::Zilla::Plugin::PodWeaver

• Dist::Zilla::PluginBundle::Author::TABULO

• Dist::Zilla::MintingProfile::Author::TABULO

• Pod::Weaver::PluginBundle::Author::ETHER (the original bundle of ETHER)

NAMING SCHEME

This distribution follows best practices for author-oriented plugin bundles; for more information, see KENTNL's distribution.

ORIGINAL AUTHOR

This distribution is based on Pod::Weaver::PluginBundle::Author::ETHER by :

Karen Etheridge cpan:ETHER

Thank you ETHER!

SUPPORT

Bugs may be submitted through the RT bug tracker (or bug-Dist-Zilla-PluginBundle-Author-TABULO@rt.cpan.org).

AUTHOR

Ayhan Ulusoy <tabulo@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2017 by Ayhan Ulusoy.

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

cpanm Dist::Zilla::PluginBundle::Author::TABULO

perl -MCPAN -e shell
install Dist::Zilla::PluginBundle::Author::TABULO