1Pod::Elemental(3)     User Contributed Perl Documentation    Pod::Elemental(3)
2
3
4

NAME

6       Pod::Elemental - work with nestable Pod elements
7

VERSION

9       version 0.103006
10

SYNOPSIS

12         use Pod::Elemental;
13         use Pod::Elemental::Transformer::Pod5;
14
15         my $document = Pod::Elemental->read_file('lib/Pod/Elemental.pm');
16
17         Pod::Elemental::Transformer::Pod5->new->transform_node($document);
18
19         print $document->as_debug_string, "\n"; # quick overview of doc structure
20
21         print $document->as_pod_string, "\n";   # reproduce the document in Pod
22

DESCRIPTION

24       Pod::Elemental is a system for treating a Pod (plain old documentation)
25       documents as trees of elements.  This model may be familiar from many
26       other document systems, especially the HTML DOM.  Pod::Elemental's
27       document object model is much less sophisticated than the HTML DOM, but
28       still makes a lot of document transformations easy.
29
30       In general, you'll want to read in a Pod document and then perform a
31       number of prepackaged transformations on it.  The most common of these
32       will be the Pod5 transformation, which assumes that the basic meaning
33       of Pod commands described in the Perl 5 documentation hold: "=begin",
34       "=end", and "=for" commands mark regions of the document, leading
35       whitespace marks a verbatim paragraph, and so on.  The Pod5 transformer
36       also eliminates the need to track elements representing vertical
37       whitespace.
38

PERL VERSION

40       This library should run on perls released even a long time ago.  It
41       should work on any version of perl released in the last five years.
42
43       Although it may work on older versions of perl, no guarantee is made
44       that the minimum required version will not be increased.  The version
45       may be increased for any reason, and there is no promise that patches
46       will be accepted to lower the minimum required perl.
47

ATTRIBUTES

49   event_reader
50       The event reader (by default a new instance of Pod::Eventual::Simple is
51       used to convert input into an event stream.  In general, it should
52       provide "read_*" methods that behave like Pod::Eventual::Simple.
53
54   objectifier
55       The objectifier (by default a new Pod::Elemental::Objectifier) must
56       provide an "objectify_events" method that converts Pod events into
57       Pod::Elemental::Element objects.
58
59   document_class
60       This is the class for documents created by reading pod.
61

METHODS

63   read_handle
64   read_file
65   read_string
66       These methods read the given input and return a
67       Pod::Elemental::Document.
68

AUTHOR

70       Ricardo SIGNES <cpan@semiotic.systems>
71

CONTRIBUTORS

73       •   Christian Walde <walde.christian@googlemail.com>
74
75       •   Justin Cook <jcook@cray.com>
76
77       •   Karen Etheridge <ether@cpan.org>
78
79       •   Philippe Bruhat (BooK) <book@cpan.org>
80
81       •   Ricardo Signes <rjbs@semiotic.systems>
82

84       This software is copyright (c) 2022 by Ricardo SIGNES.
85
86       This is free software; you can redistribute it and/or modify it under
87       the same terms as the Perl 5 programming language system itself.
88
89
90
91perl v5.38.0                      2023-07-21                 Pod::Elemental(3)
Impressum