FlexDoc/XML - XSDDoc - Parameter Tree

About XSDDoc parameters

«Details | Overview» parameter group

This group of parameters controls the content of the Overview Summary page/block.

Whether the Overview Summary is actually generated is controlled by the parameter:

Generate Details | Overview

See Also Parameter (only for SingleDoc.tpl):

Pagination | Start from new page | Overview

Related Template:

overview.tpl

Parameter	Name / Type / Description
Description	`doc.overview.desc : string` Specify whether the Overview Summary page/block will include the description for the whole documentation. The description itself is specified with the parameter group: Literal Input \| General Description Here you can just enabled/disabled that description without changing anything about its source/content. Related Template: text.tpl
Namespace Summary	`doc.overview.namespaces : boolean` Specify whether to generate the *Namespace Summary* section. This section enumerates all documented namespaces (i.e. those targeted by at least one of the documented XML schemas) along with the brief information about each namespace. Nested Parameter: Specify how the namespace summary should be sorted Related Template: namespaceSummary.tpl
Sorting	`doc.overview.namespaces.sorting : boolean` This parameter specifies how the Namespace Summary is sorted. The parameter has the following meaning: When it is selected (`true`), the namespaces will be sorted alphabetically by their URIs (ignoring letter case). When the parameter is unselected (`false`), the namespaces will not be sorted anyhow. In that case, the ordering of namespaces will be defined by how the initial XML schemas (to be documented) have been specified as well as how these schemas import other XML schemas. For more information about this, see also the parameter group: Generate Details \| For schemas Default Value: Provided by the parameter: Generate Details \| Sorting \| Namespaces
Schema Summary	`doc.overview.schemas : boolean` Specify whether to generate the *Schema Summary* table that enumerates all documented XML schemas along with the brief details about each of them. Nested Parameters: Specify how the schema summary should be sorted and which details are to be shown about each XML schema. The default values of these parameters are provided by the parameter group: Details \| Fragments \| Schema Summary Related Template: schemaSummary.tpl
Sorting	`doc.overview.schemas.sorting : boolean` Specify how the Schema Summary is sorted. The parameter has the following meaning: When it is selected (`true`), the XML schemas will be sorted alphabetically by their file names (ignoring letter case). When the parameter is unselected (`false`), the XML schemas will follow in a certain "physical" order determined by how the initial XML schemas (to be documented) have been specified as well as how these schemas import other XML schemas. For more information about this, see also the parameter group: Generate Details \| For schemas Default Value: Provided by the parameter: Details \| Fragments \| Schema Summary \| Sorting
Schema Profile	`doc.overview.schemas.profile : boolean` Specify whether the schema summary item should include the *Schema Profile* section, which shows some general information about the XML schema. Nested Parameters: Control what exactly is included in the «Schema Profile» section. Default Value: The default values of this and nested parameters are copied dynamically from the value of the parameter group: Details \| Fragments \| Schema Summary \| Schema Profile Related Template: schemaProfile.tpl
Description	`doc.overview.schemas.desc : enum {"full", "first_sentence", "optimal", "none"}` Specify whether to include the XML schema description and which part of it. The full description text is obtained from all `<xs:documentation>` elements found by the following path: `xs:schema/xs:annotation/xs:documentation` See also the "Descriptions \| XSD Annotations" parameter group, where you can specify how annotations are processed and displayed. Possible Choices: "full" Include the full description. "first sentence" Include only the first sentence of the description text. "optimal" Include the first sentence of the description text. If that is not the whole text and the full description is included in the Schema Overview, the link to it will be added at the end. That will immediately indicate that there is more text and provide a quick link to it. "none" Do not include the description. Default Value: Provided by the parameter: Details \| Fragments \| Schema Summary \| Description Related Template: annotationText.tpl