-
-
19 Jun 2021 14:55:35 UTC
- Distribution: Pod-Weaver
- Module version: 4.018
- Source (raw)
- Browse (raw)
- Changes
- Homepage
- How to Contribute
- Repository
- Issues
- Testers (1405 / 0 / 42)
- Kwalitee
Bus factor: 1- 91.88% Coverage
- License: perl_5
- Perl: v5.20.0
- Activity
24 month- Tools
- Download (42.46KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
and 25 contributors-
Ricardo SIGNES
-
Alex Peters
-
Apocalypse
-
Blabos de Blebe
-
Caleb Cushing
-
Christian Walde
-
Christopher J. Madsen
-
Chris Weyl
-
Dave Houston
-
Dave Rolsky
-
David E. Wheeler
-
David Golden
-
David Miguel Susano Pinto
-
David Zurborg
-
Doug Bell
-
Florian Ragwitz
-
Jonathan "Duke" Leto
-
Joshua Keroes
-
Karen Etheridge
-
Kent Fredric
-
Kivanc Yazan
-
Marcel Gruenauer
-
Randy Stauner
-
Sam Graham
-
Shlomi Fish
- Dependencies
- Config::MVP
- Config::MVP::Assembler
- Config::MVP::Assembler::WithBundles
- Config::MVP::Reader::Finder
- Config::MVP::Reader::INI
- DateTime
- File::Spec
- List::MoreUtils
- List::Util
- Log::Dispatchouli
- Mixin::Linewise::Readers
- Module::Runtime
- Moose
- Moose::Role
- Moose::Util::TypeConstraints
- Params::Util
- Pod::Elemental
- Pod::Elemental::Document
- Pod::Elemental::Element::Nested
- Pod::Elemental::Element::Pod5::Command
- Pod::Elemental::Element::Pod5::Ordinary
- Pod::Elemental::Element::Pod5::Region
- Pod::Elemental::Element::Pod5::Verbatim
- Pod::Elemental::Selectors
- Pod::Elemental::Transformer::Gatherer
- Pod::Elemental::Transformer::Nester
- Pod::Elemental::Transformer::Pod5
- Pod::Elemental::Types
- String::Flogger
- String::Formatter
- String::RewritePrefix
- Text::Template
- Text::Wrap
- experimental
- feature
- namespace::autoclean
- strict
- utf8
- warnings
- Reverse dependencies
- CPAN Testers List
- Dependency graph
NAME
Pod::Weaver::Section::Generic - a generic section, found by lifting sections
VERSION
version 4.018
OVERVIEW
This section will find and include a located hunk of Pod. In general, it will find a
=head1
command with a content of the plugin's name.In other words, if your configuration include:
[Generic] header = OVERVIEW
...then this weaver will look for "=head1 OVERVIEW" and include it at the appropriate location in your output.
Since you'll probably want to use Generic several times, and that will require giving each use a unique name, you can omit
header
if you provide a plugin name, and it will default to the plugin name. In other words, the configuration above could be specified just as:[Generic / OVERVIEW]
If the
required
attribute is given, and true, then an exception will be raised if this section can't be found.PERL VERSION SUPPORT
This module has the same support period as perl itself: it supports the two most recent versions of perl. (That is, if the most recently released version is v5.40, then this module should work on both v5.40 and v5.38.)
Although it may work on older versions of perl, no guarantee is made that the minimum required version will not be increased. The version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl.
ATTRIBUTES
required
A boolean value specifying whether this section is required to be present or not. Defaults to false.
If it's enabled and the section can't be found an exception will be raised.
header
The name of this section. Defaults to the plugin name.
AUTHOR
Ricardo SIGNES <rjbs@semiotic.systems>
COPYRIGHT AND LICENSE
This software is copyright (c) 2021 by Ricardo SIGNES.
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, copy and paste the appropriate command in to your terminal.
cpanm Pod::Weaver
perl -MCPAN -e shell install Pod::Weaver
For more information on module installation, please visit the detailed CPAN module installation guide.