pod::elemental::paragraph(3pm) [debian man page]

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

NAME

       Pod::Elemental::Paragraph - a paragraph in a Pod document

VERSION

       version 0.102362

OVERVIEW

       This is probably the most important role in the Pod-Elemental distribution.  Classes including this role represent paragraphs in a Pod
       document.  The paragraph is the fundamental unit of dividing up Pod documents, so this is a often-included role.

ATTRIBUTES

   content
       This is the textual content of the element, as in a Pod::Eventual event.  In other words, this Pod:

	 =head2 content

       has a content of "content
"

   start_line
       This attribute, which may or may not be set, indicates the line in the source document where the element began.

METHODS

   as_pod_string
       This returns the element  as a string, suitable for turning elements back into a document.  Some elements, like a "=over" command, will
       stringify to include extra content like a "=back" command.  In the case of elements with children, this method will include the stringified
       children as well.

   as_debug_string
       This method returns a string, like "as_string", but is meant for getting an overview of the document structure, and is not suitable for
       reproducing a document.	Its exact output is likely to change over time.

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::Paragraph(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)