1Pod::Weaver::Section::GUesneerriCco(n3t)ributed Perl DocPuomde:n:tWaetaivoenr::Section::Generic(3)
2
3
4

NAME

6       Pod::Weaver::Section::Generic - a generic section, found by lifting
7       sections
8

VERSION

10       version 4.019
11

OVERVIEW

13       This section will find and include a located hunk of Pod.  In general,
14       it will find a "=head1" command with a content of the plugin's name.
15
16       In other words, if your configuration include:
17
18         [Generic]
19         header = OVERVIEW
20
21       ...then this weaver will look for "=head1 OVERVIEW" and include it at
22       the appropriate location in your output.
23
24       Since you'll probably want to use Generic several times, and that will
25       require giving each use a unique name, you can omit "header" if you
26       provide a plugin name, and it will default to the plugin name.  In
27       other words, the configuration above could be specified just as:
28
29         [Generic / OVERVIEW]
30
31       If the "required" attribute is given, and true, then an exception will
32       be raised if this section can't be found.
33

PERL VERSION

35       This module should work on any version of perl still receiving updates
36       from the Perl 5 Porters.  This means it should work on any version of
37       perl released in the last two to three years.  (That is, if the most
38       recently released version is v5.40, then this module should work on
39       both v5.40 and v5.38.)
40
41       Although it may work on older versions of perl, no guarantee is made
42       that the minimum required version will not be increased.  The version
43       may be increased for any reason, and there is no promise that patches
44       will be accepted to lower the minimum required perl.
45

ATTRIBUTES

47   required
48       A boolean value specifying whether this section is required to be
49       present or not. Defaults to false.
50
51       If it's enabled and the section can't be found an exception will be
52       raised.
53
54   header
55       The name of this section. Defaults to the plugin name.
56

AUTHOR

58       Ricardo SIGNES <cpan@semiotic.systems>
59

61       This software is copyright (c) 2023 by Ricardo SIGNES.
62
63       This is free software; you can redistribute it and/or modify it under
64       the same terms as the Perl 5 programming language system itself.
65
66
67
68perl v5.36.0                      2023-01-12  Pod::Weaver::Section::Generic(3)
Impressum