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

ATTRIBUTES

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

AUTHOR

81       Ricardo SIGNES <rjbs@cpan.org>
82

84       This software is copyright (c) 2021 by Ricardo SIGNES.
85
86       This is free software; you can redistribute it and/or modify it under
87       the same terms as the Perl 5 programming language system itself.
88
89
90
91perl v5.32.1                      2021-04-19   Pod::Weaver::Section::Region(3)
Impressum