1Pod::Elemental::ElementU:s:eProdC5o:n:tRreigbiuotne(d3P)Poedr:l:EDloecmuemnetnatla:t:iEolnement::Pod5::Region(3)
2
3
4
6 Pod::Elemental::Element::Pod5::Region - a region of Pod (this role
7 likely to be removed)
8
10 version 0.103006
11
13 A Pod5::Region element represents a region marked by a "=for" command
14 or a pair of "=begin" and "=end" commands. It may have content of its
15 own as well as child paragraphs.
16
17 Its "as_pod_string" method will emit either a "=begin/=end"-enclosed
18 string or a "=for" command, based on whichever is permissible.
19
21 This library should run on perls released even a long time ago. It
22 should work on any version of perl released in the last five years.
23
24 Although it may work on older versions of perl, no guarantee is made
25 that the minimum required version will not be increased. The version
26 may be increased for any reason, and there is no promise that patches
27 will be accepted to lower the minimum required perl.
28
30 format_name
31 This is the format to which the region was targeted.
32
33 Note! The format name should not include the leading colon to indicate
34 a pod paragraph. For that, see "is_pod".
35
36 is_pod
37 If true, this region contains pod (ordinary or verbatim) paragraphs, as
38 opposed to data paragraphs. This will generally result from the
39 document originating in a "=begin" block with a colon-prefixed target
40 identifier:
41
42 =begin :html
43
44 This is still a verbatim paragraph.
45
46 =end :html
47
49 This class is somewhat sketchy and may be refactored somewhat in the
50 future, specifically to refactor its similarities to
51 Pod::Elemental::Element::Nested.
52
54 Ricardo SIGNES <cpan@semiotic.systems>
55
57 This software is copyright (c) 2022 by Ricardo SIGNES.
58
59 This is free software; you can redistribute it and/or modify it under
60 the same terms as the Perl 5 programming language system itself.
61
62
63
64perl v5.38.0 2023-P0o7d-:2:1Elemental::Element::Pod5::Region(3)