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.018
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 SUPPORT

35       This module has the same support period as perl itself:  it supports
36       the two most recent versions of perl.  (That is, if the most recently
37       released version is v5.40, then this module should work on both v5.40
38       and v5.38.)
39
40       Although it may work on older versions of perl, no guarantee is made
41       that the minimum required version will not be increased.  The version
42       may be increased for any reason, and there is no promise that patches
43       will be accepted to lower the minimum required perl.
44

ATTRIBUTES

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

AUTHOR

57       Ricardo SIGNES <rjbs@semiotic.systems>
58

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