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::Transformer::Gatherer(3pm)		User Contributed Perl Documentation		Pod::Elemental::Transformer::Gatherer(3pm)

NAME

       Pod::Elemental::Transformer::Gatherer - gather related paragraphs under a shared header

VERSION

       version 0.102362

OVERVIEW

       Like the Nester transformer, this Gatherer produces structure and containment in a Pod document.  Unlike that Nester, it does not find top-
       level elements, but instead produces them.

       It looks for all elements matching the "gather_selector".  They are removed from the node.  In the place of the first found element, the
       "container" node is placed into the transformed node, and all the gathered elements are made children of the container.

       So, given this document:

	 Document
	   =head1 Foo
	   =over 4
	   =item * xyzzy
	   =item * abcdef
	   =back
	   =head1 Bar
	   =over 4
	   =item * 1234
	   =item * 8765
	   =back

       ...and this nester...

	 my $gatherer = Pod::Elemental::Transformer::Gatherer->new({
	   gather_selector => s_command( [ qw(over item back) ] ),
	   container	   => Pod::Elemental::Element::Pod5::Command->new({
	     command => 'head1',
	     content => "LISTS
",
	   }),
	 });

       Then this:

	 $nester->transform_node($document);

       Will result in this document:

	 Document
	   =head1 Foo
	   =head1 LISTS
	     =over 4
	     =item * xyzzy
	     =item * abcdef
	     =back
	     =over 4
	     =item * 1234
	     =item * 8765
	     =back
	   =head1 Bar

ATTRIBUTES

   gather_selector
       This is a coderef (a predicate) used to find the paragraphs to gather up.

   container
       This is a Pod::Elemental::Node that will be inserted into the node, containing all gathered elements.

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::Transformer::Gatherer(3pm)