Contents Up << >>

HTML options

htmlBrowseButtons Allows generation of Contents, Up, browse back and browse forward buttons on each HTML page except title page. Specify none, text or bitmap. If you specify bitmap, make sure that the files contents.gif, up.gif, back.gif and forward.gif are in the directory where the HTML files will reside: samples are given in the docs directory.
truncateFilenames If true, uses .htm suffix instead of .html, and truncates filenames within HTML documents.
htmlIndex If true, specifies generation of an .htx index file for an HTML document. This file can be used in wxHelp version 2 or other programs. The file consists of a number of lines, each line with three fields separated by bar characters: the indexed phrase, the file, and a label in the file.
htmlWorkshopFiles If true, specifies generation of .hpp, .hhc and .hhk files which can be used to create both MS HTML Help and wxHTML Help files. wxHTML Help is the HTML help facility that can be used by wxWidgets 2 applications (see the wxWidgets manual and the wxWidgets HTML sample).
upperCaseNames If true, filenames in links are in upper case. By default filenames are in lower case.
backgroundColour Specifies the RGB background colour for the document, e.g. 255;255;255 for white. The default is white.
backgroundImage Specifies the RGB background image for the document, e.g. tile.gif.
textColour Specifies the RGB text colour for the document, e.g. 0;0;0 for black.
linkColour Specifies the RGB link colour for the document, e.g. 0;0;255 for blue.
followedLinkColour Specifies the RGB followed link colour for the document, e.g. 0;0;255 for blue.
combineSubSections If true (or yes), switches off the generation of separate HTML files below section level. This can reduce the number of HTML files substantially. A subsection contents list is inserted before the first subsection.
htmlFaceName A string specifying the overall font face, such as ""Arial, Lucida, Helvetica".