.\" This man page is automatically generated using
.\" kayadoc2man from the Kaya development tools and the -xmldocs compile 
.\" option. Editing it directly is not encouraged.
.\" It is under the same license as the source .k file that it was
.\" generated from.
.TH "HTMLDocument.readFromString" "3kaya" "August 2014" "Kaya" "Kaya module reference"
.SH "NAME"
HTMLDocument::readFromString \- Convert a String to HTML
.SH "SYNOPSIS"
.B Void readFromString(
\fIElementTree location, String input, WhiteList safety, Doctype doctype\fP
.B ")"
.SH "ARGUMENTS"
.PP
.B "location"
The location in the document to append the converted String
.PP
.B "input"
The String to convert
.PP
.B "safety"
The allowed elements and attributes
.PP
.B "doctype"
The document type of the input string. This is independent of the document type of the document and controls certain aspects of parsing - for example, if the doctype is
\fBHTML4Strict \fP
, the end tags for
\fBp \fP
or
\fBtd \fP
elements may be omitted, and the code will be case-insensitive.
.SH "DESCRIPTION"
.PP
Convert a String to HTML. An Exception will be thrown if the parser cannot construct an unambiguous tree from the string, and it is considerably less forgiving than the parsers in most web browsers. (On the other hand, it's a bit more forgiving in places than a strict XML parser, especially if the
\fBHTML4Strict \fP
doctype is used). As usual, parsing with XHTML strictness will be quicker.
.PP
Read the
.B "HTMLDocument.WhiteList"(3kaya)
documentation for important information on safety when converting these Strings
.PP
If you need to read poor-quality HTML, you can use the
\fBTagSoup \fP
setting for the doctype parameter, but this will be somewhat slower - if you're writing the HTML yourself it's much more efficient to write good quality code in the first place. This parsing model rarely throws an Exception (though it is still possible on very poor code)
.IP "" -4
 str = "<p>This is a <strong>crucial</strong> paragraph</p>";
 readFromString(parent,str,AllElements(Safe),HTML4Strict);
.SH "AUTHORS"
Kaya standard library by Edwin Brady, Chris Morris and others (kaya@kayalang.org). For further information see http://kayalang.org/
.SH LICENSE
The Kaya standard library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License (version 2.1 or any later version) as published by the Free Software Foundation.
.SH "RELATED"
.PD 0
.PP
.B "HTMLDocument.Doctype"(3kaya)
.PP
.B "HTMLDocument.WhiteList"(3kaya)
.PP
.B "HTMLDocument.readFromTemplate"(3kaya)
.PP
.B "HTMLDocument.string"(3kaya)
.PD 0.4v