pod::elemental::transformer::pod5(3pm) [debian man page]
Pod::Elemental::Transformer::Pod5(3pm) User Contributed Perl Documentation Pod::Elemental::Transformer::Pod5(3pm) NAME
Pod::Elemental::Transformer::Pod5 - the default, minimal semantics of Perl5's pod element hierarchy VERSION
version 0.102362 SYNOPSIS
Pod::Elemental::Transformer::Pod5->new->transform_node($pod_elem_document); ...and that's it. OVERVIEW
The Pod5 transformer is meant to be used to convert the result of a "stock" Pod::Elemental::Document into something simpler to work with. It assumes that the document conforms more or less to the convetions laid out in perlpod and perlpodspec. It is not very strict, and makes very few assumptions, described here: o =begin/=end and =for enclose or produce regions within the document o regions are associated with format names; format names that begin with a colon enclose more pod-like content o regions nest strictly; all inner regions must end before outer regions o paragraphs in non-pod regions are "data" paragraphs o non-data paragraphs that start with spaces are "verbatim" paragraphs o groups of data or verbatim paragraphs can be consolodated Further, all elements are replaced with equivalent elements that perform the Pod::Elemental::Autoblank role, so all "blank" events can be removed form the tree and ignored. CONFIGURATION
None. For now, it just does the same thing every time with no configuration or options. 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::Pod5(3pm)
Check Out this Related Man Page
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)