.\" 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.setTitle" "3kaya" "August 2014" "Kaya" "Kaya module reference" .SH "NAME" HTMLDocument::setTitle \- Sets the title of a HTML element .SH "SYNOPSIS" .B Void setTitle( \fIElementTree element, String title\fP .B ")" .SH "ARGUMENTS" .PP .B "element" The HTML element .PP .B "title" The title to set .SH "DESCRIPTION" .PP Sets the title of a HTML element. The title can be used to provide optional additional information about an element. Not all browsers will display title information, and the method of display will vary - common graphical browsers tend to display it as a tooltip when someone hovers over the element. .PP A common use is providing optional additional information about a link. .IP "" -4 url = Hyperlink("http://kayalang.org/library/latest/Prelude/putStr"); link = appendInlineElement(paragraph,url,"putStr"); setTitle(link,"API documentation for Prelude::putStr"); .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.setAttribute"(3kaya) .PP .B "HTMLDocument.setClass"(3kaya) .PP .B "HTMLDocument.setID"(3kaya) .PD 0.4v