pod::elemental::element::pod5::region(3pm) [debian man page]

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

NAME

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

VERSION

       version 0.102362

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>

COPYRIGHT AND LICENSE

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

perl v5.14.2							    2012-05-05				Pod::Elemental::Element::Pod5::Region(3pm)

Pod::Elemental(3pm)					User Contributed Perl Documentation				       Pod::Elemental(3pm)

NAME

       Pod::Elemental - work with nestable Pod elements

VERSION

       version 0.102362

SYNOPSIS

	 use Pod::Elemental;
	 use Pod::Elemental::Transformer::Pod5;

	 my $document = Pod::Elemental->read_file('lib/Pod/Elemental.pm');

	 Pod::Elemental::Transformer::Pod5->new->transform_node($document);

	 print $document->as_debug_string, "
"; # quick overview of doc structure

	 print $document->as_pod_string, "
";	 # reproduce the document in Pod

DESCRIPTION

       Pod::Elemental is a system for treating a Pod (plain old documentation) documents as trees of elements.	This model may be familiar from
       many other document systems, especially the HTML DOM.  Pod::Elemental's document object model is much less sophisticated than the HTML DOM,
       but still makes a lot of document transformations easy.

       In general, you'll want to read in a Pod document and then perform a number of prepackaged transformations on it.  The most common of these
       will be the Pod5 transformation, which assumes that the basic meaning of Pod commands described in the Perl 5 documentation hold: "=begin",
       "=end", and "=for" commands mark regions of the document, leading whitespace marks a verbatim paragraph, and so on.  The Pod5 transformer
       also eliminates the need to track elements representing vertical whitespace.

ATTRIBUTES

   event_reader
       The event reader (by default a new instance of Pod::Eventual::Simple is used to convert input into an event stream.  In general, it should
       provide "read_*" methods that behave like Pod::Eventual::Simple.

   objectifier
       The objectifier (by default a new Pod::Elemental::Objectifier) must provide an "objectify_events" method that converts Pod events into
       Pod::Elemental::Element objects.

   document_class
       This is the class for documents created by reading pod.

METHODS

   read_handle
   read_file
   read_string
       These methods read the given input and return a Pod::Elemental::Document.

AUTHOR

       Ricardo SIGNES <rjbs@cpan.org>

COPYRIGHT AND LICENSE

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

perl v5.14.2							    2012-05-05						       Pod::Elemental(3pm)