.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Pod::Simple::SimpleTree 3"
.TH Pod::Simple::SimpleTree 3 "2016-11-29" "perl v5.26.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Pod::Simple::SimpleTree \-\- parse Pod into a simple parse tree
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  % cat ptest.pod
\&
\&  =head1 PIE
\&
\&  I like B<pie>!
\&
\&  % perl \-MPod::Simple::SimpleTree \-MData::Dumper \-e \e
\&     "print Dumper(Pod::Simple::SimpleTree\->new\->parse_file(shift)\->root)" \e
\&     ptest.pod
\&
\&  $VAR1 = [
\&            \*(AqDocument\*(Aq,
\&            { \*(Aqstart_line\*(Aq => 1 },
\&            [
\&              \*(Aqhead1\*(Aq,
\&              { \*(Aqstart_line\*(Aq => 1 },
\&              \*(AqPIE\*(Aq
\&            ],
\&            [
\&              \*(AqPara\*(Aq,
\&              { \*(Aqstart_line\*(Aq => 3 },
\&              \*(AqI like \*(Aq,
\&              [
\&                \*(AqB\*(Aq,
\&                {},
\&                \*(Aqpie\*(Aq
\&              ],
\&              \*(Aq!\*(Aq
\&            ]
\&          ];
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class is of interest to people writing a Pod processor/formatter.
.PP
This class takes Pod and parses it, returning a parse tree made just
of arrayrefs, and hashrefs, and strings.
.PP
This is a subclass of Pod::Simple and inherits all its methods.
.PP
This class is inspired by XML::Parser's \*(L"Tree\*(R" parsing-style, although
it doesn't use exactly the same LoL format.
.SH "METHODS"
.IX Header "METHODS"
At the end of the parse, call \f(CW\*(C`$parser\->root\*(C'\fR to get the
tree's top node.
.SH "Tree Contents"
.IX Header "Tree Contents"
Every element node in the parse tree is represented by an arrayref of
the form: \f(CW\*(C`[ \f(CIelementname\f(CW, \e%attributes, \f(CI...subnodes...\f(CW ]\*(C'\fR.
See the example tree dump in the Synopsis, above.
.PP
Every text node in the tree is represented by a simple (non-ref)
string scalar.  So you can test \f(CW\*(C`ref($node)\*(C'\fR to see whether you have
an element node or just a text node.
.PP
The top node in the tree is \f(CW\*(C`[ \*(AqDocument\*(Aq, \e%attributes,
\&\f(CI...subnodes...\f(CW ]\*(C'\fR
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Pod::Simple
.PP
perllol
.PP
The \*(L"Tree\*(R" subsubsection in XML::Parser
.SH "SUPPORT"
.IX Header "SUPPORT"
Questions or discussion about \s-1POD\s0 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.
.PP
This module is managed in an open GitHub repository,
<https://github.com/perl\-pod/pod\-simple/>. Feel free to fork and contribute, or
to clone <git://github.com/perl\-pod/pod\-simple.git> and send patches!
.PP
Patches against Pod::Simple are welcome. Please send bug reports to
<bug\-pod\-simple@rt.cpan.org>.
.SH "COPYRIGHT AND DISCLAIMERS"
.IX Header "COPYRIGHT AND DISCLAIMERS"
Copyright (c) 2002 Sean M. Burke.
.PP
This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
.PP
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.
.SH "AUTHOR"
.IX Header "AUTHOR"
Pod::Simple was created by Sean M. Burke <sburke@cpan.org>.
But don't bother him, he's retired.
.PP
Pod::Simple is maintained by:
.IP "\(bu" 4
Allison Randal \f(CW\*(C`allison@perl.org\*(C'\fR
.IP "\(bu" 4
Hans Dieter Pearcey \f(CW\*(C`hdp@cpan.org\*(C'\fR
.IP "\(bu" 4
David E. Wheeler \f(CW\*(C`dwheeler@cpan.org\*(C'\fR
