Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
[[Category:XQuery]]
no edit summary
This [[Module Library|XQuery Module]] provides functions for converting HTML to XML. Conversion will only take place if [http://home.ccil.org/~cowan/XML/tagsoup/ TagSoup] is included in the classpath (see [[Parsers#HTML Parser|HTML Parsing]] for more details).
=Conventions=
All functions and errors in this module are assigned to the <code><nowiki>http://basex.org/modules/html</nowiki></code> namespace, which is statically bound to the {{Code|html}} prefix.<br/>All errors are assigned to the <code><nowiki>http://basex.org/errors</nowiki></code> namespace, which is statically bound to the {{Code|bxerr}} prefix.
=Functions=
==html:parse==
{| width='100%'
|-
| width='120' | '''Signatures'''
|{{Func|html:parse|$input as xs:anyAtomicType|document-node()}}<br />{{Func|html:parse|$input as xs:anyAtomicType, $options as map(xs:string, xs:string*)?|document-node()}}<br />
|-
| '''Summary'''
|Converts the HTML document specified by {{Code|$input}} to XML, and returns a document node:<br/>
* The input may either be a string or a binary item (xs:hexBinary, xs:base64Binary).
* If the input is passed on in its binary representation, the HTML parser will try to automatically choose the correct encoding.
The {{Code|$options}} argument can be used to set [[Parsers#TagSoup Options|TagSoup Options]].
|-
| '''Errors'''
|{{Error|BXHL0001parse|#Errors}} the input cannot be converted to XML.|} ==html:doc== {{Mark|Introduced with BaseX 9.4:}} {| width='100%'|-| width='120' | '''Signatures'''|{{Func|html:doc|$uri as xs:string?|document-node()?}}<br />{{Func|html:doc|$uri as xs:string?, $options as map(*)?|document-node()?}}<br />|-| '''Summary'''|Fetches the HTML document referred to by the given {{Code|$uri}}, converts it to XML and returns a document node. The {{Code|$options}} argument can be used to set [[Parsers#Options|TagSoup Options]].|-| '''Errors'''|{{Error|parse|#Errors}} the input cannot be converted to XML.
|}
;Query:
<pre classsyntaxhighlight lang="brush:xquery">
html:parse("<html>")
</presyntaxhighlight>
;Result:
<pre classsyntaxhighlight lang="brush:xml">
<html xmlns="http://www.w3.org/1999/xhtml"/>
</presyntaxhighlight>
===Specifying Options===
The next query creates an XML document without with namespaces:
;Query:
<pre classsyntaxhighlight lang="brush:xquery">html:parse("<a href='ok.html'/>", map { 'nons': truefalse() })</presyntaxhighlight>
;Result:
<pre classsyntaxhighlight lang="brush:xml"><htmlxmlns="http://www.w3.org/1999/xhtml">
<body>
<a shape="rect" href="ok.html"/>
</body>
</html>
</presyntaxhighlight>
===Parsing Binary Input===
;Query:
<pre classsyntaxhighlight lang="brush:xquery">html:parse(fetch:binary("httphttps://en.wikipedia.org"))</presyntaxhighlight>
;Result:
<pre classsyntaxhighlight lang="brush:xml">
<html xmlns="http://www.w3.org/1999/xhtml" class="client-nojs" dir="ltr" lang="en">
<head>
<meta charset="UTF-8"/>
...
</presyntaxhighlight>
=Errors=
|Description
|-
|{{Code|BXHL0001parse}}
|The input cannot be converted to XML.
|}
=Changelog=
;Version 9.4
* Added: [[#html:doc|html:doc]]
;Version 9.0
* Updated: error codes updated; errors now use the module namespace
The module was introduced with Version 7.6.
