Difference between revisions of "HTML Module"

From BaseX Documentation
Jump to navigation Jump to search
Line 7: Line 7:
 
=Functions=
 
=Functions=
  
==html:parser==
+
==html:doc==
  
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
 
| width='120' | '''Signatures'''
 
| width='120' | '''Signatures'''
|{{Code|'''html:parser'''() as xs:string}}<br />
+
|{{Func|html:doc|$uri as xs:string?|document-node()?}}<br />{{Func|html:doc|$uri as xs:string?, $options as map(*)?|document-node()?}}<br />
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
|Returns the name of the applied HTML parser (currently: {{Code|TagSoup}}). If an ''empty string'' is returned, TagSoup was not found in the classpath, and the input will be treated as well-formed XML.<br />
+
|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.
 
|}
 
|}
  
Line 36: Line 39:
 
|}
 
|}
  
==html:doc==
+
==html:parser==
  
 
{| width='100%'
 
{| width='100%'
 
|-
 
|-
 
| width='120' | '''Signatures'''
 
| 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 />
+
|{{Code|'''html:parser'''() as xs:string}}<br />
 
|-
 
|-
 
| '''Summary'''
 
| '''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]].
+
|Returns the name of the applied HTML parser (currently: {{Code|TagSoup}}). If an ''empty string'' is returned, TagSoup was not found in the classpath, and the input will be treated as well-formed XML.<br />
|-
 
| '''Errors'''
 
|{{Error|parse|#Errors}} the input cannot be converted to XML.
 
 
|}
 
|}
  

Revision as of 09:34, 20 July 2022

This XQuery Module provides functions for converting HTML to XML. Conversion will only take place if TagSoup is included in the classpath (see HTML Parsing for more details).

Conventions

All functions and errors in this module are assigned to the http://basex.org/modules/html namespace, which is statically bound to the html prefix.

Functions

html:doc

Signatures html:doc($uri as xs:string?) as document-node()?
html:doc($uri as xs:string?, $options as map(*)?) as document-node()?
Summary Fetches the HTML document referred to by the given $uri, converts it to XML and returns a document node. The $options argument can be used to set TagSoup Options.
Errors parse: the input cannot be converted to XML.

html:parse

Signatures html:parse($input as xs:anyAtomicType) as document-node()
html:parse($input as xs:anyAtomicType, $options as map(*)?) as document-node()
Summary Converts the HTML document specified by $input to XML and returns a document node:
  • The input may be of type xs:string, xs:base64Binary, or xs:hexBinary.
  • If the input is passed on in its binary representation, the HTML parser will try to choose the correct encoding automatically.

The $options argument can be used to set TagSoup Options.

Errors parse: the input cannot be converted to XML.

html:parser

Signatures html:parser() as xs:string
Summary Returns the name of the applied HTML parser (currently: TagSoup). If an empty string is returned, TagSoup was not found in the classpath, and the input will be treated as well-formed XML.

Examples

Basic Example

The following query converts the specified string to an XML document node.

Query

<syntaxhighlight lang="xquery"> html:parse("<html>") </syntaxhighlight>

Result

<syntaxhighlight lang="xml"> <html xmlns="http://www.w3.org/1999/xhtml"/> </syntaxhighlight>

Specifying Options

The next query creates an XML document with namespaces:

Query

<syntaxhighlight lang="xquery"> html:parse("<a href='ok.html'/>", map { 'nons': false() }) </syntaxhighlight>

Result

<syntaxhighlight lang="xml"> <html xmlns="http://www.w3.org/1999/xhtml">

 <body>
   <a shape="rect" href="ok.html"/>
 </body>

</html> </syntaxhighlight>

Parsing Binary Input

If the input encoding is unknown, the data to be processed can be passed on in its binary representation. The HTML parser will automatically try to detect the correct encoding:

Query

<syntaxhighlight lang="xquery"> html:parse(fetch:binary("https://en.wikipedia.org")) </syntaxhighlight>

Result

<syntaxhighlight lang="xml"> <html xmlns="http://www.w3.org/1999/xhtml" class="client-nojs" dir="ltr" lang="en">

 <head>
   <title>Wikipedia, the free encyclopedia</title>
   <meta charset="UTF-8"/>
   ...

</syntaxhighlight>

Errors

Code Description
parse The input cannot be converted to XML.

Changelog

Version 9.4
Version 9.0
  • Updated: error codes updated; errors now use the module namespace

The module was introduced with Version 7.6.