local-lib5/man/man3/Pod::Simple::SimpleTree.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "Pod::Simple::SimpleTree 3"
 132 .TH Pod::Simple::SimpleTree 3 "2008-06-03" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 Pod::Simple::SimpleTree \-\- parse Pod into a simple parse tree
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 1
 138 \&  % cat ptest.pod
 139 .Ve
 140 .PP
 141 .Vb 1
 142 \&  =head1 PIE
 143 .Ve
 144 .PP
 145 .Vb 1
 146 \&  I like B<pie>!
 147 .Ve
 148 .PP
 149 .Vb 3
 150 \&  % perl \-MPod::Simple::SimpleTree \-MData::Dumper \-e \e
 151 \&     "print Dumper(Pod::Simple::SimpleTree\->new\->parse_file(shift)\->root)" \e
 152 \&     ptest.pod
 153 .Ve
 154 .PP
 155 .Vb 20
 156 \&  $VAR1 = [
 157 \&            'Document',
 158 \&            { 'start_line' => 1 },
 159 \&            [
 160 \&              'head1',
 161 \&              { 'start_line' => 1 },
 162 \&              'PIE'
 163 \&            ],
 164 \&            [
 165 \&              'Para',
 166 \&              { 'start_line' => 3 },
 167 \&              'I like ',
 168 \&              [
 169 \&                'B',
 170 \&                {},
 171 \&                'pie'
 172 \&              ],
 173 \&              '!'
 174 \&            ]
 175 \&          ];
 176 .Ve
 177 .SH "DESCRIPTION"
 178 .IX Header "DESCRIPTION"
 179 This class is of interest to people writing a Pod processor/formatter.
 180 .PP
 181 This class takes Pod and parses it, returning a parse tree made just
 182 of arrayrefs, and hashrefs, and strings.
 183 .PP
 184 This is a subclass of Pod::Simple and inherits all its methods.
 185 .PP
 186 This class is inspired by XML::Parser's \*(L"Tree\*(R" parsing\-style, although
 187 it doesn't use exactly the same LoL format.
 188 .SH "METHODS"
 189 .IX Header "METHODS"
 190 At the end of the parse, call \f(CW\*(C`$parser\->root\*(C'\fR to get the
 191 tree's top node.
 192 .SH "Tree Contents"
 193 .IX Header "Tree Contents"
 194 Every element node in the parse tree is represented by an arrayref of
 195 the form: \f(CW\*(C`[ \f(CIelementname\f(CW, \e%attributes, \f(CI...subnodes...\f(CW ]\*(C'\fR.
 196 See the example tree dump in the Synopsis, above.
 197 .PP
 198 Every text node in the tree is represented by a simple (non\-ref)
 199 string scalar.  So you can test \f(CW\*(C`ref($node)\*(C'\fR to see whather you have
 200 an element node or just a text node.
 201 .PP
 202 The top node in the tree is \f(CW\*(C`[ 'Document', \e%attributes,
 203 \&\f(CI...subnodes...\f(CW ]\*(C'\fR
 204 .SH "SEE ALSO"
 205 .IX Header "SEE ALSO"
 206 Pod::Simple
 207 .PP
 208 perllol
 209 .PP
 210 The \*(L"Tree\*(R" subsubsection in XML::Parser
 211 .SH "COPYRIGHT AND DISCLAIMERS"
 212 .IX Header "COPYRIGHT AND DISCLAIMERS"
 213 Copyright (c) 2002 Sean M. Burke.  All rights reserved.
 214 .PP
 215 This library is free software; you can redistribute it and/or modify it
 216 under the same terms as Perl itself.
 217 .PP
 218 This program is distributed in the hope that it will be useful, but
 219 without any warranty; without even the implied warranty of
 220 merchantability or fitness for a particular purpose.
 221 .SH "AUTHOR"
 222 .IX Header "AUTHOR"
 223 Sean M. Burke \f(CW\*(C`sburke@cpan.org\*(C'\fR