Difference between revisions of "HTML Module"
m (Text replacement - "'''Signatures'''" to "'''Signature'''") |
|||
| Line 11: | Line 11: | ||
{| width='100%' | {| width='100%' | ||
|- valign="top" | |- valign="top" | ||
| − | | width='120' | ''' | + | | width='120' | '''Signature''' |
|<pre>html:doc( | |<pre>html:doc( | ||
$uri as xs:string? | $uri as xs:string? | ||
| Line 28: | Line 28: | ||
{| width='100%' | {| width='100%' | ||
|- valign="top" | |- valign="top" | ||
| − | | width='120' | ''' | + | | width='120' | '''Signature''' |
|<pre>html:parse( | |<pre>html:parse( | ||
$input as xs:anyAtomicType | $input as xs:anyAtomicType | ||
| Line 49: | Line 49: | ||
{| width='100%' | {| width='100%' | ||
|- valign="top" | |- valign="top" | ||
| − | | width='120' | ''' | + | | width='120' | '''Signature''' |
|{{Code|'''html:parser'''() as xs:string}}<br/> | |{{Code|'''html:parser'''() as xs:string}}<br/> | ||
|- valign="top" | |- valign="top" | ||
Revision as of 15:01, 9 March 2023
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).
Contents
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
| Signature | 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
| Signature | 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 |
| Errors | parse: the input cannot be converted to XML.
|
html:parser
| Signature | 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
- Added:
html:doc
- Version 9.0
- Updated: error codes updated; errors now use the module namespace
The module was introduced with Version 7.6.
