Difference between revisions of "HTML Module"
Jump to navigation
Jump to search
| Line 3: | Line 3: | ||
=Conventions= | =Conventions= | ||
| − | All functions 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/> | + | {{Mark|Updated with Version 9.0}}: |
| − | + | ||
| + | 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/> | ||
=Functions= | =Functions= | ||
| Line 33: | Line 34: | ||
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
| − | |{{Error| | + | |{{Error|parse|#Errors}} the input cannot be converted to XML. |
|} | |} | ||
| Line 90: | Line 91: | ||
=Errors= | =Errors= | ||
| + | |||
| + | {{Mark|Updated with Version 9.0}}: | ||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
| Line 95: | Line 98: | ||
|Description | |Description | ||
|- | |- | ||
| − | |{{Code| | + | |{{Code|parse}} |
|The input cannot be converted to XML. | |The input cannot be converted to XML. | ||
|} | |} | ||
=Changelog= | =Changelog= | ||
| + | |||
| + | ;Version 9.0 | ||
| + | |||
| + | * Updated: error codes updates; errors now use the module namespace | ||
The module was introduced with Version 7.6. | The module was introduced with Version 7.6. | ||
Revision as of 13:25, 21 November 2017
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: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. |
html:parse
| Signatures | html:parse($input as xs:anyAtomicType) as document-node()html:parse($input as xs:anyAtomicType, $options as map(xs:string, item())) 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.
|
Examples
Basic Example
The following query converts the specified string to an XML document node.
- Query
html:parse("<html>")
- Result
<html xmlns="http://www.w3.org/1999/xhtml"/>
Specifying Options
The next query creates an XML document with namespaces:
- Query
html:parse("<a href='ok.html'/>", map { 'nons': false() })
- Result
<html xmlns="http://www.w3.org/1999/xhtml">
<body>
<a shape="rect" href="ok.html"/>
</body>
</html>
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
html:parse(fetch:binary("http://en.wikipedia.org"))
- Result
<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"/>
...
Errors
| Code | Description |
|---|---|
parse
|
The input cannot be converted to XML. |
Changelog
- Version 9.0
- Updated: error codes updates; errors now use the module namespace
The module was introduced with Version 7.6.
