The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Pod-Weaver-Section-AllowOverride-0.03
River stage one • 5 direct dependents • 6 total dependents
1 ++
/ Pod::Weaver::Section::AllowOverride

NAME

Pod::Weaver::Section::AllowOverride - Allow POD to override a Pod::Weaver-provided section

VERSION

This document describes version 0.03 of Pod::Weaver::Section::AllowOverride, released August 11, 2012.

SYNOPSIS

  [Authors]
  [AllowOverride]
  header_re = ^AUTHORS?$

DESCRIPTION

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.

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.

ATTRIBUTES

header_re

This regular expression is used to select the section you want to override. It's matched against the section name from the =head1 line. The default is an exact match with the name of this plugin. (e.g. if the plugin name is AUTHOR, the default would be ^AUTHOR$)

action

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

Replace the Pod::Weaver-provided section with the POD-provided one. (This is the default.)

prepend

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.

append

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.

SEE ALSO

Pod::Weaver::Role::SectionReplacer, Pod::Weaver::PluginBundle::ReplaceBoilerplate

BUGS

Please report any bugs or feature requests to bug-pod-weaver-section-allowoverride@rt.cpan.org or through the web interface at: http://rt.cpan.org/Public/Dist/Display.html?Name=Pod-Weaver-Section-AllowOverride

AUTHOR

Christopher J. Madsen <perl@cjmweb.net>

SOURCE

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

COPYRIGHT AND LICENSE

This software is copyright (c) 2012 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.