Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

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

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)

Check Out this Related Man Page

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

NAME

       Pod::Elemental::PerlMunger - a thing that takes a string of Perl and rewrites its documentation

VERSION

       version 0.093331

OVERVIEW

       This role is to be included in classes that rewrite the documentation of a Perl document, stripping out all the Pod, munging it, and
       replacing it into the Perl.

       The only relevant method is "munge_perl_string", which must be implemented with a different interface than will be exposed.

       When calling the "munge_perl_string" method, arguments should be passed like this:

	 $object->munge_perl_string($perl_string, \%arg);

       %arg may contain any input for the underlying procedure.  The only key with associated meaning is "filename" which may be omitted.  If
       given, it should be the name of the file whose contents are being munged.

       The method will return a string containing the rewritten and combined document.

       Classes including this role must implement a "munge_perl_string" that expects to be called like this:

	 $object->munge_perl_string(\%doc, \%arg);

       %doc will have two entries:

	 ppi - a PPI::Document of the Perl document with all its Pod removed
	 pod - a Pod::Document with no transformations yet performed

       This "munge_perl_string" method should return a hashref in the same format as %doc.

AUTHOR

       Ricardo SIGNES <rjbs@cpan.org>

COPYRIGHT AND LICENSE

       This software is copyright (c) 2011 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.12.4							    2011-09-19					   Pod::Elemental::PerlMunger(3pm)
Man Page