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

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

NAME

       Pod::Elemental::Transformer::Nester - group the document into sections

VERSION

       version 0.102362

OVERVIEW

       The Nester transformer is meant to find potential container elements and make them into actual containers.  It works by being told what
       elements may be made into containers and what subsequent elements they should allow to be stuffed into them.

       For example, given the following nester:

	 use Pod::Elemental::Selectors qw(s_command s_flat);

	 my $nester = Pod::Elemental::Transformer::Nester->new({
	   top_selector      => s_command('head1'),
	   content_selectors => [
	     s_command([ qw(head2 head3 head4) ]),
	     s_flat,
	   ],
	 });

       ..then when we apply the transformation:

	 $nester->transform_node($document);

       ...the nester will find all "=head1" elements in the top-level of the document.	It will ensure that they are represented by objects that
       perform the Pod::Elemental::Node role, and then it will move all subsequent elements matching the "content_selectors" into the container.

       So, if we start with this input:

	 =head1 Header
	 =head2 Subheader
	 Pod5::Ordinary <some content>
	 =head1 New Header

       The nester will convert its structure to look like this:

	 =head1 Header
	   =head2 Subheader
	   Pod5::Ordinary <some content>
	 =head1 New Header

       Once an element is reached that does not pass the content selectors, the nesting ceases until the next potential container.

ATTRIBUTES

   top_selector
       This attribute must be a coderef (presumably made from Pod::Elemental::Selectors) that will test elements in the transformed node and
       return true if the element is a potential new container.

   content_selectors
       This attribute must be an arrayref of coderefs (again presumably made from Pod::Elemental::Selectors) that will test whether paragraphs
       subsequent to the top-level container may be moved under the container.

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