FlexDoc/XML - XSDDoc - Parameter Tree

About XSDDoc parameters

«Details | Namespace» parameter group

This group of parameters controls the content of the Namespace Overview page/block that can be generated for each namespace.

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

Generate Details | Namespace
See Also Parameter (only for SingleDoc.tpl):
Pagination | Start from new page | Namespace
Related Template:
namespace.tpl
Parameter Name / Type / Description

Namespace Profile

doc.namespace.profile : boolean

Specifies whether to generate the Namespace Profile section with brief information about the namespace.

In particular, this includes the list of the XML schemas targeting this namespace, number of components by types, etc.

Related Template:

namespaceProfile.tpl

Schema Summary

doc.namespace.schemas : boolean

Specify whether to generate the Schema Summary table that enumerates all documented XML schemas targeting this namespace.

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.namespace.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.namespace.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.namespace.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

Component Summary

doc.namespace.comps : boolean

Specify whether to generate summary tables of global components and local elements that belong to the given namespace (that is defined in all XML schemas that target this namespace).

Nested Parameters:

Specify the types of the components to be shown in the summary tables, the ordering of the components and which information must be displayed about each component.

The default values of these parameters are provided by the parameter group: Details | Fragments | Component Summary

Related Templates:
elementSummary.tpl, complexTypeSummary.tpl, simpleTypeSummary.tpl, groupSummary.tpl, attributeGroupSummary.tpl, globalAttributeSummary.tpl

Include

doc.namespace.comps.include

The parameters in this group control what type of components are included in the summary.

Elements
Local Elements
Complex Types
Simple Types
Element Groups
Attribute Groups
Global Attributes

doc.namespace.comps.include.elements : boolean
doc.namespace.comps.include.element.local : enum {"all", "complexType", "none"}
doc.namespace.comps.include.complexTypes : boolean
doc.namespace.comps.include.simpleTypes : boolean
doc.namespace.comps.include.groups : boolean
doc.namespace.comps.include.attributeGroups : boolean
doc.namespace.comps.include.attributes : boolean

Specify whether to generate component summaries for particular components types.

Default Value:

The default values of these parameters are copied dynamically from the corresponding parameters in the group: Details | Fragments | Component Summary | Include

Sorting

doc.namespace.comps.sorting : boolean

With this parameter you can specify the sorting order of components.

The parameter has the following meaning:

  • When it is selected (true), the XSD components will be sorted alphabetically by their names (ignoring letter case).

    The component name is assumed to be that under which the component appears (is referenced to) at the given documentation location. This is typically the component qualified name (which is the actual namespace prefix plus the component local name). That, however, can be changed using the parameter: Show | Namespace Prefixes

    Additionally, in the case of local elements, the component name may also include a special extension used to distinguish the equally named local elements. For more details about this, please see the parameter: Show | Element Name Extensions

  • When the parameter is unselected (false), the XSD components are not sorted. In that case they will follow in a certain "physical" order produced according to the following.

    When components come from different XML schemas, first, they will be grouped by their schemas. The ordering of those groups is determined by what XSD files have been specified initially and how they reference (e.g. import) other XSD files.

    Within a group of components that belong to the same XML schema, they will follow in the same order as they are defined in that schema.

    This allows you to control a particular ordering of components (e.g. elements) by yourself. Simply define the most important components (e.g. an XML document's root element) on the top of the XML schema. If you have several schemas to document, specify the most important of them the first. That will produce the component ordering as you wish (or something close to it).

Default Value:
Provided by the parameter: Details | Fragments | Component Summary | Sorting

Component Profile

doc.namespace.comps.profile : boolean

Specify whether to include in the summary item the Component Profile section, which shows some general information about the XSD component.

The exact content of the Component Profile is controlled by the parameter group:

Details | Fragments | Component Summary | Component Profile
Default Value:
Provided by the parameter: Details | Fragments | Component Summary | Component Profile
Related Templates:
elementProfile.tpl, typeProfile.tpl, groupProfile.tpl, attributeGroupProfile.tpl, globalAttributeProfile.tpl

Description

doc.namespace.comps.desc : enum {"full", "first_sentence", "optimal", "none"}

Specify if the component summary item should include the component description and which part of it.

The full description text is obtained from all <xs:documentation> elements found by the following path:
xs:component/xs:annotation/xs:documentation
where 'xs:component' is the particular XML element that defines the component (e.g. xs:complexType).

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 Component Documentation (or elsewhere), 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 component description.

Default Value:

Provided by the parameter: Details | Fragments | Component Summary | Description
Related Template:
annotationText.tpl

Content Model Table

doc.namespace.comps.model.tableRep : boolean

Specify if the component summary item should include the Content Model Table (i.e. possible attributes and child elements) defined by the component).

The exact content of such a representation is controlled by the parameter group:

Details | Fragments | Component Summary | Content Model Table
Default Value:
Provided by the parameter: Details | Fragments | Component Summary | Content Model Table
Applies To:
  • Elements
  • Complex Types
  • Element Groups
  • Attribute Groups
Related Template:
tableRep.tpl