diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 19:43:11 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 19:43:11 +0000 |
commit | fc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch) | |
tree | ce1e3bce06471410239a6f41282e328770aa404a /upstream/debian-unstable/man3/Pod::Simple::SimpleTree.3perl | |
parent | Initial commit. (diff) | |
download | manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.tar.xz manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.zip |
Adding upstream version 4.22.0.upstream/4.22.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/debian-unstable/man3/Pod::Simple::SimpleTree.3perl')
-rw-r--r-- | upstream/debian-unstable/man3/Pod::Simple::SimpleTree.3perl | 166 |
1 files changed, 166 insertions, 0 deletions
diff --git a/upstream/debian-unstable/man3/Pod::Simple::SimpleTree.3perl b/upstream/debian-unstable/man3/Pod::Simple::SimpleTree.3perl new file mode 100644 index 00000000..48fdb390 --- /dev/null +++ b/upstream/debian-unstable/man3/Pod::Simple::SimpleTree.3perl @@ -0,0 +1,166 @@ +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) +.\" +.\" 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 +.. +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. +.ie n \{\ +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. 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 3perl" +.TH Pod::Simple::SimpleTree 3perl 2024-01-12 "perl v5.38.2" "Perl Programmers Reference Guide" +.\" 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 "Tree" 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`[ \fR\f(CIelementname\fR\f(CW, \e%attributes, \fR\f(CI...subnodes...\fR\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(CWref($node)\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, +\&\fR\f(CI...subnodes...\fR\f(CW ]\*(C'\fR +.SH "SEE ALSO" +.IX Header "SEE ALSO" +Pod::Simple +.PP +perllol +.PP +The "Tree" subsubsection in XML::Parser +.SH SUPPORT +.IX Header "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. +.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 |