HTML Module

From BaseX Documentation
Revision as of 23:27, 2 January 2013 by CG (talk | contribs) (→‎Functions)
Jump to navigation Jump to search

This XQuery Module provides functions for converting HTML to XML. The input will only be converted 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:processor() as xs:string
Summary Returns the name of the applied HTML processor (currently: TagSoup or an empty string). If the function returns an empty string, TagSoup was not found in the classpath, and the input will be parsed 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. It 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(fetch:content-binary("http://en.wikipedia.org")) returns an XML representation of the English Wikipedia main page. The input is passed on 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.