NAME
Pod::Weaver::PluginBundle::Author::ETHER - A plugin bundle for pod woven by ETHER
VERSION
version 0.100
SYNOPSIS
In your weaver.ini:
[@Author::ETHER]
Or in your dist.ini
[PodWeaver]
config_plugin = @Author::ETHER
It is also used automatically when your dist.ini contains:
[@Author::ETHER]
:version = 0.094
DESCRIPTION
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
[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]
[Authors]
[Contributors]
:version = 0.008
[Legal]
[Region / footer]
This is also equivalent (other than section ordering) to:
[-Transformer / List]
transformer = List
[Region / header]
[@Default]
[Collect / TYPES]
command = type
[Contributors]
:version = 0.008
[Region / footer]
OPTIONS / OVERRIDES
None at this time. (The bundle is never instantiated, so this doesn't seem to be possible without updates to Pod::Weaver.)
ADDING STOPWORDS FOR SPELLING TESTS
As noted in Dist::Zilla::PluginBundle::Author::ETHER, 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 through the RT bug tracker (or bug-Dist-Zilla-PluginBundle-Author-ETHER@rt.cpan.org). I am also usually active on irc, as 'ether' at irc.perl.org
.
NAMING SCHEME
This distribution follows best practices for author-oriented plugin bundles; for more information, see KENTNL's distribution.
AUTHOR
Karen Etheridge <ether@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2013 by Karen Etheridge.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.