NAME
Pod::Weaver::Plugin::EnsureUniqueSections - Ensure that POD has no
duplicate section headers.
VERSION
version 0.103520
SYNOPSIS
In weaver.ini
[-EnsureUniqueSections]
strict = 0 ; The default
DESCRIPTION
This plugin simply ensures that the POD after weaving has no duplicate
top-level section headers. This can help you if you are converting a
dist to Dist::Zilla and Pod::Weaver, and you forgot to remove POD
sections that are now auto-generated.
By default, this module does some tricks to detect similar headers, such
as "AUTHOR" and "AUTHORS". You can turn this off by setting "strict = 1"
in weaver.ini.
ATTRIBUTES
strict
If set to true (1), section headers will only be considered duplicates
if they match exactly. If false (the default), certain similar section
headers will be considered equivalent. The following similarities are
considered (more may be added later):
All whitespace and punctuation are equivalant
For example, the following would all be considered duplicates of
each other: " SEE ALSO", "SEE ALSO", "SEE,ALSO:".
Case-insensitive
For example, "Name" and "NAME" would be considered duplicates.
Sets of words separated by "AND".
For example, "COPYRIGHT AND LICENSE" would be considered a duplicate
of "LICENSE AND COPYRIGHT".
Plurals
"AUTHOR" and "AUTHORS" are the same section. A section header
consisting of multiple words, such as "DISCLAIMER OF WARRANTY", is
not affected by this rule.
This rule uses Lingua::EN::Inflect::Number to interconvert between
singulars and plurals. Hopefully you don't need to make a section
called "OCTOPI".
Note that these rules apply recursively, so "Authors; and Contributors"
would be a duplicate of " CONTRIBUTORS AND AUTHOR".
METHODS
finalize_document
This method checks the document for duplicate headers, and throws an
error if any are found. If no duplicates are found, it simply does
nothing. It does not modify the POD in any way.
BUGS AND LIMITATIONS
I would like to convert this to a Dist::Zilla testing plugin, but I
haven't yet figured out how to find all files in a dist with POD and
extract all their headers.
Please report any bugs or feature requests to
"
[email protected]".
SEE ALSO
* Pod::Weaver
INSTALLATION
See perlmodinstall for information and options on installing Perl
modules.
AUTHOR
Ryan C. Thompson <
[email protected]>
COPYRIGHT AND LICENSE
This software is copyright (c) 2010 by Ryan C. Thompson.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
DISCLAIMER OF WARRANTY
BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
NECESSARY SERVICING, REPAIR, OR CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE
TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES.
