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.017
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

ATTRIBUTES

35   required
36       A boolean value specifying whether this section is required to be
37       present or not. Defaults to false.
38
39       If it's enabled and the section can't be found an exception will be
40       raised.
41
42   header
43       The name of this section. Defaults to the plugin name.
44

AUTHOR

46       Ricardo SIGNES <rjbs@cpan.org>
47

49       This software is copyright (c) 2021 by Ricardo SIGNES.
50
51       This is free software; you can redistribute it and/or modify it under
52       the same terms as the Perl 5 programming language system itself.
53
54
55
56perl v5.32.1                      2021-04-19  Pod::Weaver::Section::Generic(3)
Impressum