.\" 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 "KayaDoc.htmliseContents" "3kaya" "August 2014" "Kaya" "Kaya module reference"
.SH "NAME"
KayaDoc::htmliseContents \- Convert the contents of a (e.g.) <prose> section to HTML
.SH "SYNOPSIS"
.B Void htmliseContents(
\fIElementTree tree, ElementTree addto, String(String, Int, EntryType) linkto\fP
.B ")"
.SH "ARGUMENTS"
.PP
.B "tree"
A section of API documentation, most usually either a
\fBprose \fP
,
\fBitem \fP
or
\fBexample \fP
element.
.PP
.B "addto"
A HTML element to add the documentation to
.PP
.B "linkto"
A URL generation function that given a name, an index number (for disambiguation of overloaded functions), and an
.B "KayaDoc.EntryType"(3kaya)
returns the URL at which documentation for that function / type / module may be found. The name of a function may include the module it is in (e.g.
\fBKayaDoc::readDoc \fP
) or may not, in which case the current module should be assumed.
.SH "DESCRIPTION"
.PP
Convert a section of API documentation to HTML. This may be useful for working with summary documentation.
.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 "KayaDoc.describeDataHTML"(3kaya)
.PP
.B "KayaDoc.describeExceptionHTML"(3kaya)
.PP
.B "KayaDoc.describeFunctionHTML"(3kaya)
.PD 0.4v