.\" 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.substring" "3kaya" "August 2014" "Kaya" "Kaya module reference"
.SH "NAME"
HTMLDocument::substring \- Converts a part of the document to string form
.SH "SYNOPSIS"
.B String substring(
\fIElementTree tree, UnicodeFormat uform=LiteralUTF8, Doctype doctype=HTML4Strict\fP
.B ")"
.SH "ARGUMENTS"
.PP
.B "tree"
An element from the document body (it may be the document body itself)
.PP
.B "uform"
The method for displaying multibyte Unicode characters. This argument is optional, with a default of
\fBLiteralUTF8 \fP
.PP
.B "doctype"
The document type declaration to assume for conversion. This need not be the same as the doctype used for the HTMLDocument, if this element tree is part of a HTMLDocument. This argument is optional, with a default of
\fBHTML4Strict \fP

.SH "DESCRIPTION"
.PP
Convert a part of the document (or a fragment of HTML unconnected to the document) into String form. This can be used as an easy way of giving HTML source examples:
.IP "" -4
 p = addParagraph(parent,"An image: ");
 img = addImage(p,ImageData("example.png","an example",Unspecified));
 p2 = addParagraph(parent,"HTML code for the image: "+substring(img));
.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 "ElementTreeData.UnicodeFormat"(3kaya)
.PP
.B "HTMLDocument.string"(3kaya)
.PD 0.4v