FlexDoc/XML - XSDDoc - Parameter Tree
About XSDDoc parameters
«Navigation» parameter group
This group of parameter controls the generation of the frameset and various navigation lists used in Framed HTML Documentation.
Parameter | Name / Type / Description |
---|---|
nav.overviewFrame : boolean
Specify whether to generate the «Overview Frame», which contains the primary navigation lists (such as the lists of namespaces and XML schemas that have been documented). This might be more important for big XML schema projects (with multiple schemas/namespaces). For a small XML schema or when you generate some specialized documentation, you may find that the «Overview Frame» is redundant. |
|
nav.overviewFrame.title : string
Specify the title to be placed at the top of the «Overview Frame». Note: The text specified with this parameter may contain HTML tags, which will be rendered with the corresponding formatting. Check also that “Render embedded HTML” option of the destination HTML output format is set for this! (It can be specified in the generator dialog.) Default Value:
|
|
nav.listFrame : enum {"allcomps", "namespace", "schema"}
This parameter allows you to customize the initial content of the «List Frame», which is used to display one of the second-levelnavigation pages associated with a particular selection in the «Overview Frame». Possible Choices:
|
|
nav.listFrame.toc : boolean
Specify whether to generate the Table of Contents box at the top of on each navigation page. This box includes the links to all list groups, which allow you to quickly jump to any group, particularly when there are lots of items. |
|
nav.listFrame.allcomps : boolean
Specify whether to generate the «All Components» navigation page. Nested Parameters:
|
|
nav.listFrame.allcomps.linkTo : enum {"details", "xml_source"}
With this parameter you can choose the destination of the component hyperlinks. Possible Choices:
|
|
nav.listFrame.allcomps.sorting : boolean
With this parameter you can specify the sorting order of components (within each component type group). The exact meaning of this parameter is the same as of “Generate Details | Sorting | Components” parameter, from which it also inherits its default value. |
|
Elements |
nav.listFrame.allcomps.elements : boolean nav.listFrame.allcomps.element.local : enum {"all", "complexType", "none"} nav.listFrame.allcomps.complexTypes : boolean nav.listFrame.allcomps.simpleTypes : boolean nav.listFrame.allcomps.groups : boolean nav.listFrame.allcomps.attributes : boolean nav.listFrame.allcomps.attributeGroups : boolean
Specify whether to include in the list the components of particular types. Note:
|
nav.listFrame.namespace : boolean
Specify whether to generate «Namespace» navigation pages. Nested Parameters:
|
|
nav.listFrame.namespace.linkTo : enum {"details", "xml_source"}
With this parameter you can choose the destination of the component hyperlinks. For details, see parameter: All Components | Link To |
|
nav.listFrame.namespace.sorting : boolean
With this parameter you can specify the sorting order of components (within each component type group). The exact meaning of this parameter is the same as of “Generate Details | Sorting | Components” parameter, from which it also inherits its default value. |
|
nav.listFrame.namespace.schemas : boolean
Specify whether all documented XML schemas targeting the given namespace must be listed in the namespace navigation frame. |
|
Elements |
nav.listFrame.namespace.elements : boolean nav.listFrame.namespace.element.local : enum {"all", "complexType", "none"} nav.listFrame.namespace.complexTypes : boolean nav.listFrame.namespace.simpleTypes : boolean nav.listFrame.namespace.groups : boolean nav.listFrame.namespace.attributes : boolean nav.listFrame.namespace.attributeGroups : boolean
Specify whether to include in the list the components of particular types. Note:
|
nav.listFrame.schema : boolean
Specify whether to generate «Schema» navigation pages. Nested Parameters:
|
|
nav.detailFrame : enum {"overview", "allcomps", "namespace", "schema"}
This parameter allows you to customize the initial content of the «Detail Frame», which is used to display the actual documentation content. Possible Choices:
|