\*(C'\fR element. This is often the most sensible
option. If you pass something like \f(CW\*(C`{ within => "foobar" }\*(C'\fR
where "foobar" is not a real HTML element name (as found in the HTML5
spec), then this method will croak; if you pass the name of a void
element (e.g. \f(CW"br"\fR or \f(CW"meta"\fR) then this method will
croak; there are a handful of other unsupported elements which will
croak (namely: \f(CW"noscript"\fR, \f(CW"noembed"\fR, \f(CW"noframes"\fR).
.Sp
Note that the second time around, although we parsed the string "as
if it were within a \f(CW\*(C`
\*(C'\fR element", the \f(CW\*(C`Hello\*(C'\fR
bit did not strictly end up within the \f(CW\*(C` | \*(C'\fR element (not
even within the \f(CW\*(C`\*(C'\fR element!) yet it still gets returned.
We'll call things such as this "outliers". There is a "force_within"
option which tells parse_balanced_chunk to ignore outliers:
.Sp
.Vb 3
\& $frag3 = $parser\->parse_balanced_chunk($string,
\& {force_within=>\*(Aqtd\*(Aq});
\& say $frag3\->toString; # Hello
.Ve
.Sp
There is a boolean option "mark_outliers" which marks each outlier
with an attribute (\f(CW\*(C`data\-perl\-html\-html5\-parser\-outlier\*(C'\fR) to
indicate its outlier status. Clearly, this is ignored when you use
"force_within" because no outliers are returned. Some outliers may
be XML::LibXML::Text elements; text nodes don't have attributes, so
these will not be marked with an attribute.
.Sp
A last note is to mention what gets returned by this method. Normally
it's an XML::LibXML::DocumentFragment object, but if you call the
method in list context, a list of the individual node elements is
returned. Alternatively you can request the data to be returned as an
XML::LibXML::NodeList object:
.Sp
.Vb 2
\& # Get an XML::LibXML::NodeList
\& my $list = $parser\->parse_balanced_chunk($str, {as=>\*(Aqlist\*(Aq});
.Ve
.Sp
The exact implementation of this method may change from version to
version, but the long-term goal will be to approach how common
desktop browsers parse HTML fragments when implementing the setter
for DOM's \f(CW\*(C`innerHTML\*(C'\fR attribute.
.PP
The push parser and SAX-based parser are not supported. Trying
to change an option (such as recover_silently) will make
HTML::HTML5::Parser carp a warning. (But you can inspect the
options.)
.SS "Error Handling"
.IX Subsection "Error Handling"
Error handling is obviously different to XML::LibXML, as errors are
(bugs notwithstanding) non-fatal.
.ie n .IP """error_handler""" 4
.el .IP \f(CWerror_handler\fR 4
.IX Item "error_handler"
Get/set an error handling function. Must be set to a coderef or undef.
.Sp
The error handling function will be called with a single parameter, a
HTML::HTML5::Parser::Error object.
.ie n .IP """errors""" 4
.el .IP \f(CWerrors\fR 4
.IX Item "errors"
Returns a list of errors that occurred during the last parse.
.Sp
See HTML::HTML5::Parser::Error.
.SS "Additional Methods"
.IX Subsection "Additional Methods"
The module provides a few methods to obtain additional, non-DOM data from
DOM nodes.
.ie n .IP """dtd_public_id""" 4
.el .IP \f(CWdtd_public_id\fR 4
.IX Item "dtd_public_id"
.Vb 1
\& $pubid = $parser\->dtd_public_id( $doc );
.Ve
.Sp
For an XML::LibXML::Document which has been returned by
HTML::HTML5::Parser, using this method will tell you the
Public Identifier of the DTD used (if any).
.ie n .IP """dtd_system_id""" 4
.el .IP \f(CWdtd_system_id\fR 4
.IX Item "dtd_system_id"
.Vb 1
\& $sysid = $parser\->dtd_system_id( $doc );
.Ve
.Sp
For an XML::LibXML::Document which has been returned by
HTML::HTML5::Parser, using this method will tell you the
System Identifier of the DTD used (if any).
.ie n .IP """dtd_element""" 4
.el .IP \f(CWdtd_element\fR 4
.IX Item "dtd_element"
.Vb 1
\& $element = $parser\->dtd_element( $doc );
.Ve
.Sp
For an XML::LibXML::Document which has been returned by
HTML::HTML5::Parser, using this method will tell you the
root element declared in the DTD used (if any). That is,
if the document has this doctype:
.Sp
.Vb 1
\&
.Ve
.Sp
\&... it will return "html".
.Sp
This may return the empty string if a DTD was present but
did not contain a root element; or undef if no DTD was
present.
.ie n .IP """compat_mode""" 4
.el .IP \f(CWcompat_mode\fR 4
.IX Item "compat_mode"
.Vb 1
\& $mode = $parser\->compat_mode( $doc );
.Ve
.Sp
Returns 'quirks', 'limited quirks' or undef (standards mode).
.ie n .IP """charset""" 4
.el .IP \f(CWcharset\fR 4
.IX Item "charset"
.Vb 1
\& $charset = $parser\->charset( $doc );
.Ve
.Sp
The character set apparently used by the document.
.ie n .IP """source_line""" 4
.el .IP \f(CWsource_line\fR 4
.IX Item "source_line"
.Vb 2
\& ($line, $col) = $parser\->source_line( $node );
\& $line = $parser\->source_line( $node );
.Ve
.Sp
In scalar context, \f(CW\*(C`source_line\*(C'\fR returns the line number of the
source code that started a particular node (element, attribute or
comment).
.Sp
In list context, returns a tuple: \f(CW$line\fR, \f(CW$column\fR, \f(CW$implicitness\fR.
Tab characters count as one column, not eight.
.Sp
\&\f(CW$implicitness\fR indicates that the node was not explicitly marked
up in the source code, but its existence was inferred by the parser.
For example, in the following markup, the HTML, TITLE and P elements
are explicit, but the HEAD and BODY elements are implicit.
.Sp
.Vb 4
\&
\& I have an implicit head
\& And an implicit body too!
\&
.Ve
.Sp
(Note that implicit elements do still have a line number and column
number.) The implictness indicator is a new feature, and I'd appreciate
any bug reports where it gets things wrong.
.Sp
XML::LibXML::Node has a \f(CW\*(C`line_number\*(C'\fR method. In general this
will always return 0 and HTML::HTML5::Parser has no way of influencing
it. However, if you install XML::LibXML::Devel::SetLineNumber on
your system, the \f(CW\*(C`line_number\*(C'\fR method will start working (at least for
elements).
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.
.PP
HTML::HTML5::Writer,
HTML::HTML5::Builder,
XML::LibXML,
XML::LibXML::PrettyPrint,
XML::LibXML::Devel::SetLineNumber.
.SH AUTHOR
.IX Header "AUTHOR"
Toby Inkster,
.SH "COPYRIGHT AND LICENCE"
.IX Header "COPYRIGHT AND LICENCE"
Copyright (C) 2007\-2011 by Wakaba
.PP
Copyright (C) 2009\-2012 by Toby Inkster
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
.SH "DISCLAIMER OF WARRANTIES"
.IX Header "DISCLAIMER OF WARRANTIES"
THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
|