- OVERRIDING A SPECIFIC SECTION
- ADDING STOPWORDS FOR SPELLING TESTS
- SEE ALSO
- NAMING SCHEME
- COPYRIGHT AND LICENCE
Pod::Weaver::PluginBundle::Author::ETHER - A plugin bundle for pod woven by ETHER
In your weaver.ini:
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 ; or any higher version
This is a Pod::Weaver plugin bundle. It is approximately equal to the following weaver.ini, minus some optimizations:
[-EnsurePod5] [-H1Nester] [-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 [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 [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]
None at this time. (The bundle is never instantiated, so this doesn't seem to be possible without updates to Pod::Weaver.)
This weaver.ini will let you use a custom
COPYRIGHT AND LICENCE section and still use the plugin bundle:
[@Author::ETHER] [AllowOverride / OverrideLegal] header_re = ^COPYRIGHT match_anywhere = 1
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
This distribution follows best practices for author-oriented plugin bundles; for more information, see KENTNL's distribution.
Bugs may be submitted through the RT bug tracker (or bug-Dist-Zilla-PluginBundle-Author-ETHER@rt.cpan.org).
There is also a mailing list available for users of this distribution, at http://dzil.org/#mailing-list.
There is also an irc channel available for users of this distribution, at
I am also usually active on irc, as 'ether' at
Karen Etheridge <firstname.lastname@example.org>
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.