06 May 2014 01:45:45 UTC
- Distribution: Pod-Weaver-Section-AllowOverride
- Module version: 0.05
- Source (raw)
- Browse (raw)
- How to Contribute
- Issues (0)
- Testers (3634 / 5 / 59)
- KwaliteeBus factor: 1
- 87.80% Coverage
- License: perl_5
- Perl: v5.10.0
- Download (15.23KB)
- MetaCPAN Explorer
- Subscribe to distribution
- This version
- Latest version++ed by:Christopher J. Madsen /
- SEE ALSO
- COPYRIGHT AND LICENSE
Pod::Weaver::Section::AllowOverride - Allow POD to override a Pod::Weaver-provided section
This document describes version 0.05 of Pod::Weaver::Section::AllowOverride, released May 5, 2014.
[Authors] [AllowOverride] header_re = ^AUTHORS?$ action = replace ; this is the default match_anywhere = 0 ; this is the default
Sometimes, you might want to override a normally-generic section in one of your modules. This section plugin replaces the preceding section with the corresponding section taken from your POD (if it exists). If your POD doesn't contain a matching section, then the Pod::Weaver-provided one will be used.
Both the original section in your POD and the section provided by Pod::Weaver must match the
header_re. Also, this plugin must immediately follow the section you want to replace (unless you set
match_anywhereto a true value).
It's a similar idea to Pod::Weaver::Role::SectionReplacer, except that it works the other way around. SectionReplacer replaces the section from your POD with a section provided by Pod::Weaver.
This regular expression is used to select the section you want to override. It's matched against the section name from the
=head1line. The default is an exact match with the name of this plugin. (e.g. if the plugin name is AUTHOR, the default would be
This controls what to do when both a Pod::Weaver-provided section and a POD-provided section are found. It must be one of the following values:
Replace the Pod::Weaver-provided section with the POD-provided one. (This is the default.)
Place the POD-provided section at the beginning of the Pod::Weaver-provided one. The POD-provided header is used, and the Pod::Weaver-provided header is discarded.
Place the POD-provided section at the end of the Pod::Weaver-provided one. The POD-provided header is used, and the Pod::Weaver-provided header is discarded.
By default, AllowOverride must immediately follow the section to be overriden in your weaver.ini. If you set
match_anywhereto a true value, then it can come anywhere after the section to be overriden (i.e. there can be other sections in between). AllowOverride will search backwards for a section matching
header_re, and die if there is no such section.
This is useful if the section you want to override comes from a bundle.
Please report any bugs or feature requests to firstname.lastname@example.org or through the web interface at: http://rt.cpan.org/Public/Dist/Display.html?Name=Pod-Weaver-Section-AllowOverride
Christopher J. Madsen <email@example.com>
The development version is on github at http://github.com/madsen/pod-weaver-section-allowoverride and may be cloned from git://github.com/madsen/pod-weaver-section-allowoverride.git
This software is copyright (c) 2014 by Christopher J. Madsen.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
Module Install Instructions
To install Pod::Weaver::Section::AllowOverride, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell install Pod::Weaver::Section::AllowOverride
For more information on module installation, please visit the detailed CPAN module installation guide.
|s||Focus search bar|
|?||Bring up this help dialog|
|g p||Go to pull requests|
|g i||go to github issues (only if github is preferred repository)|
|g a||Go to author|
|g c||Go to changes|
|g i||Go to issues|
|g d||Go to dist|
|g r||Go to repository/SCM|
|g s||Go to source|
|g b||Go to file browse|