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

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

ATTRIBUTES

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

AUTHOR

92       Ricardo SIGNES <rjbs@semiotic.systems>
93

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