table of contents
|Pod::Elemental::Element::Pod5::Region(3pm)||User Contributed Perl Documentation||Pod::Elemental::Element::Pod5::Region(3pm)|
Pod::Elemental::Element::Pod5::Region - a region of Pod (this role likely to be removed)
A Pod5::Region element represents a region marked by a "=for" command or a pair of "=begin" and "=end" commands. It may have content of its own as well as child paragraphs.
Its "as_pod_string" method will emit either a "=begin/=end"-enclosed string or a "=for" command, based on whichever is permissible.
This is the format to which the region was targeted.
Note! The format name should not include the leading colon to indicate a pod paragraph. For that, see "is_pod".
If true, this region contains pod (ordinary or verbatim) paragraphs, as opposed to data paragraphs. This will generally result from the document originating in a "=begin" block with a colon-prefixed target identifier:
=begin :html This is still a verbatim paragraph. =end :html
This class is somewhat sketchy and may be refactored somewhat in the future, specifically to refactor its similarities to Pod::Elemental::Element::Nested.
Ricardo SIGNES <email@example.com>
COPYRIGHT AND LICENSE¶
This software is copyright (c) 2020 by Ricardo SIGNES.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.