.\" 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.writeTo" "3kaya" "August 2014" "Kaya" "Kaya module reference"
.SH "NAME"
HTMLDocument::writeTo \- Print a HTML document with a specified output function
.SH "SYNOPSIS"
.B Void writeTo(
\fIHTMLDocument doc, Void(String) output, UnicodeFormat uform=LiteralUTF8\fP
.B ")"
.SH "ARGUMENTS"
.PP
.B "doc"
The HTML document
.PP
.B "output"
A function that outputs the strings given to it (using
\fBPrelude::putStr@() \fP
is equivalent to
.B "HTMLDocument.write"(3kaya)
)
.PP
.B "uform"
The mode for handling multibyte UTF-8 characters.
\fBLiteralUTF8 \fP
will give a smaller String, readable in Unicode-aware applications.
\fBNumericReference \fP
will give a larger String, especially if multibyte characters are very common in the text, but will work better if the String will later be edited in non-Unicode applications. This argument is optional, and defaults to the recommended
\fBLiteralUTF8 \fP
, but you may wish to use
\fBNumericReference \fP
if the output is not Unicode-aware, for example.
.SH "DESCRIPTION"
.PP
Print a HTML document with a specified output function. This is considerably more efficient than
\fBoutput(string(doc)); \fP
.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 "ElementTreeData.UnicodeFormat"(3kaya)
.PP
.B "HTMLDocument.HTMLDocument"(3kaya)
.PP
.B "HTMLDocument.string"(3kaya)
.PP
.B "HTMLDocument.write"(3kaya)
.PD 0.4v