1Pod::Weaver::Section::RUesgeironC(o3n)tributed Perl DocuPmoedn:t:aWteiaovner::Section::Region(3)
2
3
4

NAME

6       Pod::Weaver::Section::Region - find a region and put its contents in
7       place where desired
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 region with the specified name, such as:
15
16         =begin :myfoo
17
18         =head1 More Pod Here
19
20         =end :myfoo
21
22       In other words, if your configuration include:
23
24         [Region]
25         region_name = myfoo
26
27       ...then this weaver will look for "=begin :myfoo" ( and "=for :myfoo"
28       and... ) and include it at the appropriate location in your output.
29
30       Since you'll probably want to use Region several times, and that will
31       require giving each use a unique name, you can omit "region_name" if
32       you provide a plugin name, and it will default to the plugin name.  In
33       other words, the configuration above could be specified just as:
34
35         [Region / myfoo]
36
37       If the "required" attribute is given, and true, then an exception will
38       be raised if this region can't be found.
39

PERL VERSION

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

ATTRIBUTES

53   required
54       A boolean value specifying whether this region is required to be
55       present or not. Defaults to false.
56
57       If it's enabled and the region can't be found an exception will be
58       raised.
59
60   region_name
61       The name of this region. Defaults to the plugin name.
62
63   allow_nonpod
64       A boolean value specifying whether nonpod regions are allowed or not.
65       Defaults to false.
66
67       "nonpod" regions are regions without a ":" prefix as explained in
68       perlpodspec
69
70         # region_name = myregion
71         # is_pod = false
72         =begin myregion
73
74         # region_name = myregion
75         # is_pod = true
76         =begin :myregion
77
78   flatten
79       A boolean value specifying whether the region's contents should be
80       flattened or not. Defaults to true.
81
82         #unflattened
83         =begin :myregion
84
85         =head1
86
87         =end :myregion
88
89         #flattened
90         =head1
91

AUTHOR

93       Ricardo SIGNES <cpan@semiotic.systems>
94

96       This software is copyright (c) 2023 by Ricardo SIGNES.
97
98       This is free software; you can redistribute it and/or modify it under
99       the same terms as the Perl 5 programming language system itself.
100
101
102
103perl v5.38.0                      2023-07-21   Pod::Weaver::Section::Region(3)
Impressum