Difference between revisions of "HTML Module"

From BaseX Documentation
Jump to navigation Jump to search
Line 30: Line 30:
 
* 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#TagSoup Options|TagSoup Options]]. It can be specified…<br />
+
The {{Code|$options}} argument can be used to set [[Parsers#TagSoup Options|TagSoup Options]], which can be specified…<br />
 
* as children of an {{Code|<html:options/>}} element; e.g.:
 
* as children of an {{Code|<html:options/>}} element; e.g.:
 
<pre class="brush:xml">
 
<pre class="brush:xml">

Revision as of 01:13, 3 January 2013

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 in this module are assigned to the http://basex.org/modules/html namespace, which is statically bound to the html prefix.
All errors are assigned to the http://basex.org/errors namespace, which is statically bound to the bxerr 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 item()) as document-node()
Summary Converts the HTML document specified by $input to XML, and returns a document node:
  • 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 $options argument can be used to set TagSoup Options, which can be specified…

  • as children of an <html:options/> element; e.g.:
<html:options>
  <html:key1 value='value1'/>
  ...
</html:options>
  • as map, which contains all key/value pairs:
map { "key1" := "value1", ... }
Errors BXHL0001: the input cannot be converted to XML.
Examples
  • html:parse("<html></html>") returns <html/>
  • html:parse("<a href='ok.html'/>", map { 'nons' := true() }) creates an XML document without namespaces. It returns:
<html>
  <body>
    <a shape="rect" href="ok.html"/>
  </body>
</html>
  • html:parse(fetch:content-binary("http://en.wikipedia.org")) returns an XML representation of the English Wikipedia main page. The input is passed on in its binary representation such that the HTML parser can automatically detect the correct encoding.

Errors

Code Description
BXHL0001 The input cannot be converted to XML.

Changelog

The module was introduced with Version 7.5.1.

Retrieved from "https://old.docs.basex.org/index.php?title=HTML_Module&oldid=8714"