Difference between revisions of "HTML Module"
Jump to navigation
Jump to search
James Ball (talk | contribs) m (Made link to Wikipedia HTTPS for binary example - as HTTP returns nothing) |
|||
(25 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
− | This [[Module Library|XQuery Module]] provides functions for converting HTML to XML. Conversion will only take place if | + | This [[Module Library|XQuery Module]] provides functions for converting HTML to XML. Conversion will only take place if TagSoup is included in the classpath (see [[Parsers#HTML Parser|HTML Parsing]] for more details). |
=Conventions= | =Conventions= | ||
− | All functions in this module are assigned to the | + | 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 12: | Line 11: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signatures''' |
|{{Code|'''html:parser'''() as xs:string}}<br /> | |{{Code|'''html:parser'''() as xs:string}}<br /> | ||
|- | |- | ||
Line 22: | Line 21: | ||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
− | | width=' | + | | width='120' | '''Signatures''' |
− | |{{Func|html:parse|$input as xs:anyAtomicType|document-node()}}<br />{{Func|html:parse|$input as xs:anyAtomicType, $options as | + | |{{Func|html:parse|$input as xs:anyAtomicType|document-node()}}<br />{{Func|html:parse|$input as xs:anyAtomicType, $options as map(*)?|document-node()}}<br /> |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
Line 30: | Line 29: | ||
* If the input is passed on in its binary representation, the HTML parser will try to automatically choose the correct encoding. | * 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# | + | The {{Code|$options}} argument can be used to set [[Parsers#Options|TagSoup Options]]. |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
− | |{{Error| | + | |{{Error|parse|#Errors}} the input cannot be converted to XML. |
|} | |} | ||
− | + | =Examples= | |
− | === | + | ===Basic Example=== |
The following query converts the specified string to an XML document node. | The following query converts the specified string to an XML document node. | ||
Line 55: | Line 43: | ||
;Query: | ;Query: | ||
<pre class="brush:xquery"> | <pre class="brush:xquery"> | ||
− | html:parse("< | + | html:parse("<html>") |
</pre> | </pre> | ||
Line 65: | Line 53: | ||
===Specifying Options=== | ===Specifying Options=== | ||
− | The next query creates an XML document | + | The next query creates an XML document with namespaces: |
;Query: | ;Query: | ||
<pre class="brush:xquery"> | <pre class="brush:xquery"> | ||
− | html:parse("<a href='ok.html'/>", map { 'nons' : | + | html:parse("<a href='ok.html'/>", map { 'nons': false() }) |
</pre> | </pre> | ||
;Result: | ;Result: | ||
<pre class="brush:xml"> | <pre class="brush:xml"> | ||
− | <html> | + | <html xmlns="http://www.w3.org/1999/xhtml"> |
<body> | <body> | ||
<a shape="rect" href="ok.html"/> | <a shape="rect" href="ok.html"/> | ||
Line 81: | Line 69: | ||
</pre> | </pre> | ||
− | ===Parsing | + | ===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: | ;Query: | ||
<pre class="brush:xquery"> | <pre class="brush:xquery"> | ||
− | html:parse(fetch: | + | html:parse(fetch:binary("https://en.wikipedia.org")) |
</pre> | </pre> | ||
Line 101: | Line 90: | ||
=Errors= | =Errors= | ||
− | {| | + | {| class="wikitable" width="100%" |
− | ! width=" | + | ! width="110"|Code |
− | + | |Description | |
|- | |- | ||
− | |{{Code| | + | |{{Code|parse}} |
|The input cannot be converted to XML. | |The input cannot be converted to XML. | ||
|} | |} | ||
Line 111: | Line 100: | ||
=Changelog= | =Changelog= | ||
− | + | ;Version 9.0 | |
+ | |||
+ | * Updated: error codes updated; errors now use the module namespace | ||
− | + | The module was introduced with Version 7.6. |
Revision as of 13:31, 28 June 2019
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(*)?) 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("https://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 updated; errors now use the module namespace
The module was introduced with Version 7.6.