1. Manuals
  2. Tumbleweed
  3. perl-Pod-Elemental
  4. Pod::Elemental::Element::Pod5::Region(3pm)

Scroll to navigation

Pod::Elemental::Element::Pod5::Region(3) User Contributed Perl Documentation Pod::Elemental::Element::Pod5::Region(3)

NAME

Pod::Elemental::Element::Pod5::Region - a region of Pod (this role likely to be removed)

VERSION

version 0.103006

OVERVIEW

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.

PERL VERSION

This library should run on perls released even a long time ago. It should work on any version of perl released in the last five years.

Although it may work on older versions of perl, no guarantee is made that the minimum required version will not be increased. The version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl.

ATTRIBUTES

format_name

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

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

WARNING

This class is somewhat sketchy and may be refactored somewhat in the future, specifically to refactor its similarities to Pod::Elemental::Element::Nested.

AUTHOR

Ricardo SIGNES <cpan@semiotic.systems>

COPYRIGHT AND LICENSE

This software is copyright (c) 2022 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.

2023-01-01 perl v5.40.0