- OVERRIDING A SPECIFIC SECTION
- ADDING STOPWORDS FOR SPELLING TESTS
- SEE ALSO
- COPYRIGHT AND LICENSE
Pod::Weaver::PluginBundle::ATOOMIC - A plugin bundle for pod woven by ATOOMIC
In your weaver.ini:
Or in your dist.ini
[PodWeaver] config_plugin = @ATOOMIC
It is also used automatically when your dist.ini contains:
[@ATOOMIC] :version = 0.094
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 ; ATOOMIC::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]
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 LICENSE section and still use the plugin bundle:
[@ATOOMIC] [AllowOverride / OverrideLegal] header_re = ^COPYRIGHT match_anywhere = 1
As noted in Dist::Zilla::PluginBundle::ATOOMIC, 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
I am also usually active on IRC as 'autarch' on
The source code repository for Dist-Zilla-PluginBundle-ATOOMIC can be found at https://github.com/atoomic/Dist-Zilla-PluginBundle-ATOOMIC.
Nicolas R <firstname.lastname@example.org>
This software is Copyright (c) 2018 by Nicolas R.
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.