Pod::Elemental::Transformer::Gatherer - gather related paragraphs under a shared header
version 0.103006
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.
gather_selector
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\n", }), });
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
This library should run on perls released even a long time ago. It should work on any version of perl released in the last five years.
Although it may work on older versions of perl, no guarantee is made that the minimum required version will not be increased. The version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl.
This is a coderef (a predicate) used to find the paragraphs to gather up.
This is a Pod::Elemental::Node that will be inserted into the node, containing all gathered elements.
Ricardo SIGNES <cpan@semiotic.systems>
This software is copyright (c) 2022 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.
To install Pod::Elemental, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Pod::Elemental
CPAN shell
perl -MCPAN -e shell install Pod::Elemental
For more information on module installation, please visit the detailed CPAN module installation guide.