FlexDoc/XML - XSDDoc - Parameter Tree

«Literal Input» parameter group

This parameter group concentrates in a single place all primary parameters, through which you can pass into the generated documentation all sorts of custom texts (besides anything found in the XML schema files). In particular:

Various titles and labels
The general description for entire documentation put on the Overview page
A text put at the page bottom

This image shows which template parameters are responsible for which titles and texts (click to view in full size):

Parameter	Name / Type / Description
Documentation Title	`lit.docTitle : text` Specify the overall title for the whole documentation. In particular: In case of framed HTML documentation, that will be the title of the Overview Summary page. In the case of single-file HTML/RTF documentation, that will be the documentation boilerplate text. The title text may be formatted with some HTML tags. See also: Using HTML markup in annotations Directly Affected Parameters: Literal Input \| Header Title See Also Parameters: Details \| Overview Related Template: title-page.tpl, overview.tpl
General Description	`lit.description` With this parameter group you can add a description for the whole documentation, which will appear in the Overview Summary page/block. You can either specify the entire overview description text as the value of the nested parameter: Literal Input \| General Description \| Text Such a text may include some HTML markup tags (as in Javadoc comments). Or you can prepare the overview description text in a separate XHTML file and specify only its pathname in the nested parameter: Literal Input \| General Description \| File The precise content of the Overview Summary page/block is controlled by the parameter group: Details \| Overview where the whole overview description can be just enabled/disabled with the parameter: Details \| Overview \| Description without changing anything about its source/content, which is specified here. Related Template: overview.tpl
Text	`lit.description.text : text` Here, you can specify the entire overview description text of any length. You can use some HTML tags to format the text so as to include lists, tables, images etc. See also: Using HTML markup in annotations
File	`lit.description.file : File` Specify the pathname of a separate XHTML file that contains the overview description text. XHTML is ordinary HTML well-formed enough to be XML at the same time. All XML elements that represent HTML tags must have the namespace: `http://www.w3.org/1999/xhtml` You can use some CSS stylesheets in it, which will be picked by the generator and inserted in the generated documentation as well. See also: Using HTML markup in annotations That is how it is done as shown on the screenshot. The prepared overview text file is this: `{flexdoc-xml}/XSDDoc/demo/overview.xhtml` Note that although that pathname looks like an absolute one, it is stored in generator.config relatively to its location. So, everything is movable to anywhere, which is particularly important in case of Docker. You can equally specify the same `overview.xhtml` file on the command-line using -p option: `-p:lit.description.file C:\flexdoc-xml\XSDDoc\demo\overview.xhtml` In that case, the `overview.xhtml` pathname must be absolute. Related Template: text.tpl, xhtmlHeadContent.tpl
Window Title	`lit.windowTitle : string` Specify the browser title for the documentation: In case of HTML output, this will be the main part of the HTML browser window title. In the case of RTF output format, the text specified with this parameter will appear on page footers.
Header Title	`lit.headerTitle : text` Specify the title placed on the left of the page header, as shown on this screenshot: Unlike the documentation title, which appear only on the Overview Summary page, the header title will be visible on every detail page. So, you can use it to indicate what your documentation is about. The title text may be formatted with some HTML tags. See also: Using HTML markup in annotations Default Value: Provided by the parameter: Literal Input \| Documentation Title See Also Parameters: Navigation \| Detail Frame \| Header Related Template: nav-top.tpl
Header Text	`lit.headerText : text` Specify an additional text placed on the right of the page header (see on the screenshot above). You can use this text to indicate some extra information (like the version number of the system your documentation describes). The header text may be formatted with some HTML tags. See also: Using HTML markup in annotations Directly Affected Parameters: Navigation \| Overview Frame \| Title See Also Parameter: Navigation \| Detail Frame \| Header Related Template: nav-bottom.tpl
Bottom Text	`lit.bottomText : text` Specify the text to be placed at the bottom of each detail page/file, below the lower navigation bar (in case of framed HTML documentation) the end of the document (in case of single-file documentation) The bottom text may include some HTML tags in order to format it. See also: Using HTML markup in annotations See Also Parameter: Show \| About (footer) Related Template: nav-bottom.tpl