Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

pod::elemental(3pm) [debian 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)

Check Out this Related Man Page

Pod::Simple::Checker(3pm)				 Perl Programmers Reference Guide				 Pod::Simple::Checker(3pm)

NAME

       Pod::Simple::Checker -- check the Pod syntax of a document

SYNOPSIS

	 perl -MPod::Simple::Checker -e 
	  "exit Pod::Simple::Checker->filter(shift)->any_errata_seen" 
	  thingy.pod

DESCRIPTION

       This class is for checking the syntactic validity of Pod.  It works by basically acting like a simple-minded version of Pod::Simple::Text
       that formats only the "Pod Errors" section (if Pod::Simple even generates one for the given document).

       This is a subclass of Pod::Simple and inherits all its methods.

SEE ALSO

       Pod::Simple, Pod::Simple::Text, Pod::Checker

SUPPORT

       Questions or discussion about POD and Pod::Simple should be sent to the pod-people@perl.org mail list. Send an empty email to
       pod-people-subscribe@perl.org to subscribe.

       This module is managed in an open GitHub repository, <https://github.com/theory/pod-simple/>. Feel free to fork and contribute, or to clone
       <git://github.com/theory/pod-simple.git> and send patches!

       Patches against Pod::Simple are welcome. Please send bug reports to <bug-pod-simple@rt.cpan.org>.

COPYRIGHT AND DISCLAIMERS

       Copyright (c) 2002 Sean M. Burke.

       This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

       This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of
       merchantability or fitness for a particular purpose.

AUTHOR

       Pod::Simple was created by Sean M. Burke <sburke@cpan.org>.  But don't bother him, he's retired.

       Pod::Simple is maintained by:

       o   Allison Randal "allison@perl.org"

       o   Hans Dieter Pearcey "hdp@cpan.org"

       o   David E. Wheeler "dwheeler@cpan.org"

perl v5.18.2							    2013-11-14						 Pod::Simple::Checker(3pm)
Man Page