Pod::Elemental::Element::Pod5::Region.3pm

Langue: en

Version: 2010-06-11 (ubuntu - 24/10/10)

Section: 3 (Bibliothèques de fonctions)

Sommaire

NAME

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

VERSION

version 0.101620

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.

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 <rjbs@cpan.org>
This software is copyright (c) 2010 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.