.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" 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 "MKDoc::XML::TreeBuilder 3pm" .TH MKDoc::XML::TreeBuilder 3pm "2022-10-13" "perl v5.34.0" "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" MKDoc::XML::TreeBuilder \- Builds a parsed tree from XML data .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& my @top_nodes = MKDoc::XML::TreeBuilder\->process_data ($some_xml); .Ve .SH "SUMMARY" .IX Header "SUMMARY" MKDoc::XML::TreeBuilder uses MKDoc::XML::Tokenizer to turn \s-1XML\s0 data into a parsed tree. Basically it smells like an \s-1XML\s0 parser, looks like an \&\s-1XML\s0 parser, and awfully overlaps with \s-1XML\s0 parsers. .PP But it's not an \s-1XML\s0 parser. .PP \&\s-1XML\s0 parsers are required to die if the \s-1XML\s0 data is not well formed. MKDoc::XML::TreeBuilder doesn't give a rip: it'll parse whatever as long as it's good enough for it to parse. .PP \&\s-1XML\s0 parsers expand entities. MKDoc::XML::TreeBuilder doesn't. At least not yet. .PP \&\s-1XML\s0 parsers generally support namespaces. MKDoc::XML::TreeBuilder doesn't \- and probably won't. .SH "DISCLAIMER" .IX Header "DISCLAIMER" \&\fBThis module does low level \s-1XML\s0 manipulation. It will somehow parse even broken \s-1XML\s0 and try to do something with it. Do not use it unless you know what you're doing.\fR .SH "API" .IX Header "API" .ie n .SS "my @top_nodes = MKDoc::XML::Tokenizer\->process_data ($some_xml);" .el .SS "my \f(CW@top_nodes\fP = MKDoc::XML::Tokenizer\->process_data ($some_xml);" .IX Subsection "my @top_nodes = MKDoc::XML::Tokenizer->process_data ($some_xml);" Returns all the top nodes of the \f(CW$some_xml\fR parsed tree. .PP Although the \s-1XML\s0 spec says that there can be only one top element in an \s-1XML\s0 file, you have to take two things into account: .PP 1. Pseudo-elements such as \s-1XML\s0 declarations, processing instructions, and comments. .PP 2. MKDoc::XML::TreeBuilder is not an \s-1XML\s0 parser, it's not its job to care about the \s-1XML\s0 specification, so having multiple top elements is just fine. .ie n .SS "my $tokens = MKDoc::XML::Tokenizer\->process_data ('/some/file.xml');" .el .SS "my \f(CW$tokens\fP = MKDoc::XML::Tokenizer\->process_data ('/some/file.xml');" .IX Subsection "my $tokens = MKDoc::XML::Tokenizer->process_data ('/some/file.xml');" Same as MKDoc::XML::TreeBuilder\->process_data ($some_xml), except that it reads \f(CW$some_xml\fR from '/some/file.xml'. .SH "Returned parsed tree \- data structure" .IX Header "Returned parsed tree - data structure" I have tried to make MKDoc::XML::TreeBuilder look enormously like HTML::TreeBuilder. So most of this section is stolen and slightly adapted from the HTML::Element man page. .PP \&\s-1START PLAGIARISM HERE\s0 .PP It may occur to you to wonder what exactly a \*(L"tree\*(R" is, and how it's represented in memory. Consider this \s-1HTML\s0 document: .PP .Vb 9 \& \&
\&