FlexDoc/XML - XSDDoc - Parameter Tree

About XSDDoc parameters

«Details | Component | Content Model» parameter group

Parameter Name / Type / Description

Content Model

doc.comp.model : enum {"always", "original", "never"}

Specify whether to document the content model (i.e. possible attributes and child elements) defined by the component.

The complex content (i.e. possible attributes and child elements) can be represented in three different ways simultaneously:

  1. Diagram
  2. XML Representation Summary
  3. Table Representation
The simple content is fully documented as well with the Simple Content Detail.

Each of those representations is controlled by the corresponding nested parameter group.

Possible Choices:

"always"

Always document the component content model.
"original"
Document the content model only if it is defined within the given component.
That will exclude elements and global attributes with named (global) types.

The purpose of this setting is to reduce the size of the generated documentation by suppressing the repeating the same information across it. Since the content model of an element or attribute is totally defined by its type, one can equally view it in the details of that type (by clicking the corresponding link).

See also the parameter: Documentation Profile
"never"
Do not document component content model.
Default Value:
Derived from the values of parameter: Documentation Profile
Applies To:
All components
Nested Parameters:
Control the generation of each particular representation of the content model.
See Also Parameter Groups:

Diagram

doc.comp.model.diagram : boolean

Specify whether to generate/include a graphical diagram representation of the XSD component.

Applies To:

  • Global & Local Elements
  • Complex Types
  • Element / Attribute Groups
Additional Settings:
The generation of diagram hyperlinks can be customized in the parameter group:

Details | Fragments | Content Model | Diagram | Hyperlinks

See Also Parameter Groups: Related Templates:
diagram.tpl, DiagramKit.tpl

Generate For

doc.comp.model.diagram.for

The parameter group to specify exactly for which components the Component Diagram section must be generated.

Elements
Complex Types
Element Groups
Attribute Groups

doc.comp.model.diagram.for.element : boolean
doc.comp.model.diagram.for.complexType : boolean
doc.comp.model.diagram.for.group : boolean
doc.comp.model.diagram.for.attributeGroup : boolean

The parameters to specify whether to generate the Component Diagram for components of corresponding types.

XML Representation Summary

doc.comp.model.xmlRep : boolean

Specifies whether to generate the XML Representation Summary section.

Applies To:

All components
Nested Parameters:
Specify for which components this section must be generated
Additional Settings:
More settings for the generation of XML Representation Summary are found in the parameter group:

Details | Fragments | Content Model | XML Representation Summary

Related Template:
xmlRep.tpl

Generate For

doc.comp.model.xmlRep.for

The parameter group to specify exactly for which components the XML Representation Summary section must be generated.

Elements
Complex Types
Simple Types
Element Groups
Global Attributes
Attribute Groups

doc.comp.model.xmlRep.for.element : boolean
doc.comp.model.xmlRep.for.complexType : boolean
doc.comp.model.xmlRep.for.simpleType : boolean
doc.comp.model.xmlRep.for.group : boolean
doc.comp.model.xmlRep.for.attribute : boolean
doc.comp.model.xmlRep.for.attributeGroup : boolean

The parameters to specify whether to generate the XML Representation Summary for components of particular types.

Table Representation

doc.comp.model.tableRep : boolean

Specifies whether to generate the Table Representation of the component content model.

Additional Settings:

More settings for the generation of Table Representation are found in the parameter group:

Details | Fragments | Content Model | Table Representation

which also provides default values for some parameters in this group.
See Also Parameter Groups: Related Template:
tableRep.tpl

Attributes

doc.comp.model.tableRep.attributes : boolean

Specify whether to generate the table representation of attributes.

Applies To:

  • Elements
  • Complex Types
  • Attribute Groups
Nested Parameters:
Control what is included in the attribute table
Additional Settings:
More settings for the generation of attribute table are found in the parameter group:

Details | Fragments | Content Model | Table Representation | Attributes

which also provides default values for the parameters in this group.

Value Representation

doc.comp.model.tableRep.attributes.value : boolean

Specify whether to represent the possible value of the attribute.

The value representation will appear in the "Type / Value" column as an extension of type information.

For instance, that may be the reference to an XSD basic simple type, from which the attribute type is derived, or the list of all possible values of the attribute, which is controlled by the nested parameter: Enumerations.
Default Value:
Provided by the parameter: Details | Fragments | Content Model | Table Representation | Attributes | Value Representation
Related Template:
simpleContentRep.tpl

Enumerations

doc.comp.model.tableRep.attributes.value.enum : enum {"full", "optimal", "none"}

Specify how to represent enumerations.

Possible Choices:

"full"

Always show the full list of enumeration values.
For instance: ("extension" | "restriction" | "list" | "union")
"optimal"
As some enumerations may be very large, the inclusion of full enumeration lists everywhere can overwhelm the value representations and bloat the documentation. This setting allows you to avoid that. When it is selected, the full enumeration list is included only when it is not too large.
Precisely, no more than 150 characters in total. That is programmed in simpleContentRep.tpl template.
Otherwise, the enumeration is abbreviated like in case of "none".
"none"
Each enumeration is represented like
enumeration of xs:string
with the link to the full enumeration list in the corresponding simple type details.
Default Value:
Provided by the parameter: Details | Fragments | Content Model | Table Representation | Attributes | Value Representation | Enumerations

Required

doc.comp.model.tableRep.attributes.required : boolean

Specify whether the attribute table will include the "Required?" column.

Default Value:

Provided by the parameter: Details | Fragments | Content Model | Table Representation | Attributes | Required

Declared In

doc.comp.model.tableRep.attributes.declared : boolean

Specify whether the attribute table will include the "Declared In" column, which shows the component where each attribute/wildcard is declared.

Default Value:

Provided by the parameter: Details | Fragments | Content Model | Table Representation | Attributes | Declared In

Description

doc.comp.model.tableRep.attributes.desc : enum {"full", "first_sentence", "optimal", "none"}

Specify if the attribute table will include the "Description" column and which part of attribute descriptions will be displayed in it.

The full description text is collected from all <xs:documentation> elements found by the following path:
xs:attribute/xs:annotation/xs:documentation
where <xs:attribute> is the XSD declaration of the attribute.

If the attribute is declared by the reference to a global attribute, first, that reference is searched for the annotation. If not found, the annotation from the global attribute definition will be used then.

See also the "Descriptions" parameter group, where you can specify how annotations are processed and displayed.

Possible Choices:

"full"

Display the full description of each attribute.
"first sentence"
Display only the first sentence of the description text.
"optimal"
The goal of this setting is to minimize the repeating of full descriptions of attributes across the documentation.

Either the full description text or its first sentence can be displayed here, which is decided as follows:

  1. If the full description consists of a single sentence, it is all what will be displayed here in any case.
  2. Otherwise, if there is the full description of the attribute elsewhere, only its first sentence will be displayed here and the link to the full description added at the end.

    The full description is searched through the following locations:

    • The Component Documentation of the attribute – only in the case of the reference to a global attribute
    • The detailed documentation of the schema component, in which the attribute is declared (e.g. named complex type or attribute group, global/local element with anonymous type). The attribute full description will be searched in the Attribute Detail section or in Attribute Table of the component content model.
  3. If this attribute table is a part of the detailed documentation of the schema component, in which the attribute is declared, and the full attribute description is not found elsewhere, it will be printed here.
"none"
Do not include the "Description" column.

Default Value:

Provided by the parameter: Details | Fragments | Content Model | Table Representation | Attributes | Description
Related Template:
annotationText.tpl

Content Elements

doc.comp.model.tableRep.elements : boolean

Specify whether to generate the table representation of content element model.

Applies To:

  • Elements
  • Complex Types
  • Element Groups
Nested Parameters:
Control what is included in the content element table
Additional Settings:
More settings for the generation of attribute table are found in the parameter group:

Details | Fragments | Content Model | Table Representation | Content Elements

which also provides default values for the parameters in this group.

Value Representation

doc.comp.model.tableRep.elements.value : boolean

Specify whether to represent the possible value of the child element (in case it has simple content).

The value representation will appear in the "Type / Value" column as an extension of type information.

For instance, that may be the reference to an XSD basic simple type, from which the element type is derived, or the list of all possible values of the element, which is controlled by the nested parameter: Enumerations.
Default Value:
Provided by the parameter: Details | Fragments | Content Model | Table Representation | Content Elements | Value Representation
Related Template:
simpleContentRep.tpl

Enumerations

doc.comp.model.tableRep.elements.value.enum : enum {"full", "optimal", "none"}

Specify how to represent enumerations.

Possible Choices:

"full"

Always show the full list of enumeration values.
For instance: ("extension" | "restriction" | "list" | "union")
"optimal"
As some enumerations may be very large, the inclusion of full enumeration lists everywhere can overwhelm the value representations and bloat the documentation. This setting allows you to avoid that. When it is selected, the full enumeration list is included only when it is not too large.
Precisely, no more than 150 characters in total. That is programmed in simpleContentRep.tpl template.
Otherwise, the enumeration is abbreviated like in case of "none".
"none"
Each enumeration is represented like
enumeration of xs:string
with the link to the full enumeration list in the corresponding simple type details.
Default Value:
Provided by the parameter: Details | Fragments | Content Model | Table Representation | Content Elements | Value Representation | Enumerations

Required

doc.comp.model.tableRep.elements.required : boolean

Specify whether the content element table will include the "Required?" column.

Default Value:

Provided by the parameter: Details | Fragments | Content Model | Table Representation | Content Elements | Required

Nillable

doc.comp.model.tableRep.elements.nillable : boolean

Specify whether the content element table will include the "Nillable?" column.

Default Value:

Provided by the parameter: Details | Fragments | Content Model | Table Representation | Content Elements | Nillable

Declared In

doc.comp.model.tableRep.elements.declared : boolean

Specify whether the content element table will include the "Declared In" column, which shows the component where each content element/wildcard/compositor is declared.

Default Value:

Provided by the parameter: Details | Fragments | Content Model | Table Representation | Content Elements | Declared In

Description

doc.comp.model.tableRep.elements.desc : enum {"full", "first_sentence", "optimal", "none"}

Specify if the content element table will include the "Description" column and which part of element descriptions will be displayed in it.

The full description text is collected from all <xs:documentation> elements found by the following path:
xs:element/xs:annotation/xs:documentation
where <xs:element> is the XSD declaration of the child element.

If the child element is declared by the reference to a global element, first, that reference is searched for the annotation. If not found, the annotation from the global element definition will be used then.

See also the "Descriptions" parameter group, where you can specify how annotations are processed and displayed.

Possible Choices:

"full"

Display the full description of each element.
"first sentence"
Display only the first sentence of the description text.
"optimal"
The goal of this setting is to minimize the repeating of full descriptions of elements across the documentation.

Either the full description text or its first sentence can be displayed here, which is decided as follows:

  1. If the full description consists of a single sentence, it is all what will be displayed here in any case.
  2. Otherwise, if there is the full description of the element elsewhere, only its first sentence will be displayed here and the link to the full description added at the end.

    The full description is searched through the following locations:

    • The Component Documentation of the element – only in the case of the reference to a global element
    • The detailed documentation of the schema component, in which the child element is declared (e.g. named complex type or model group, global/local element with anonymous type). The element full description will be searched in the Content Element Detail section or in Table Representation of the component content model.
  3. If this content element table is a part of the detailed documentation of the schema component, in which the child element is declared, and the full description of that element is not found elsewhere, it will be printed here.
"none"
Do not include the "Description" column.

Default Value:

Provided by the parameter: Details | Fragments | Content Model | Table Representation | Content Elements | Description
Related Template:
annotationText.tpl

Simple Content Detail

doc.comp.model.simpleContent : boolean

Specifies whether to generate the Simple Content Detail of the component content model.

Applies To:

  • Elements with simple content model.
  • Attributes. The attribute value is a particular instance of simple content.
  • Complex Types with simple content model.
  • Simple Types. The simple content is exactly what a particular simple type defines.
Nested Parameters:
Control the generation of specific details about simple content.

See Also Parameter Groups:

Related Template:
simpleContentDetail.tpl

Representation

doc.comp.model.simpleContent.rep : boolean

Specify whether to show the Simple Content Representation.

Simple Content Representation briefly shows how the datatype is related to the XSD basic simple types, their lists or unions.
Default Value:
Provided by the parameter: Details | Fragments | Content Model | Simple Content Detail | Representation
Related Template:
simpleContentRep.tpl

Enumerations

doc.comp.model.simpleContent.rep.enum : enum {"full", "optimal", "none"}

Specify how to represent enumerations.

Possible Choices:

"full"

Always show the full list of enumeration values.
For instance: ("extension" | "restriction" | "list" | "union")
"optimal"
As some enumerations may be very large, the inclusion of full enumeration lists everywhere can overwhelm the value representations and bloat the documentation. This setting allows you to avoid that. When it is selected, the full enumeration list is included only when it is not too large.
Precisely, no more than 150 characters in total. That is programmed in simpleContentRep.tpl template.
Otherwise, the enumeration is abbreviated like in case of "none".
"none"
Each enumeration is represented like
enumeration of xs:string
with the link to the full enumeration list in the corresponding simple type details.
Default Value:
Provided by the parameter: Details | Fragments | Content Model | Simple Content Detail | Representation | Enumerations

Restrictions

doc.comp.model.simpleContent.restrictions : enum {"full", "optimal", "none"}

Specify whether to show the details of the union(s), list(s) and restrictions (actual facets) along with their descriptions found in the corresponding XML schema annotations.

The list of actual facets is produced as follows.

First, the initial facets are collected by all types starting from the lowest one (which is either this component itself, when it is a type, or the type directly assigned to this component, when it is an element or attribute) throughout the chain of all its ancestor types (both global and anonymous) until the top ancestor passed or a derivation by list or union reached.

Further, the produced sequence of facets is filtered so as the facets collected earliest (that is defined in lower descendant types) remain and those overridden by them are removed. In particular:

  1. All xs:pattern facets will remain, because a value allowed for the given simple content must match all of them.
  2. The xs:enumeration facets will remain those that are defined in the same type, which is nearest to the given component.
  3. All other facets will override the same facets defined in the ancestor types.
Possible Choices:

"full"

Always show all restrictions (facets).
"optimal"
The goal of this setting is to minimize the repeating of voluminous restrictions across the documentation. That concerns only enumeration values and patterns.

When this setting is selected, the restriction is always included only when it is not too long.

For a long restriction:

  1. If the corresponding facets are defined within the same component, for which this restriction detail is generated, such a restriction is always included. That will be the restriction/facet's main documentation.
  2. Otherwise, the restriction's main documentation is looked for. If it exists somewhere in the documentation, the link to it is inserted. If not, the full restriction is inserted here anyway.
"none"
Do not show restriction details
Nested Parameter:
Specifies whether to show the descriptions of facets, lists and unions.
Default Value:
Provided by the parameter: Details | Fragments | Content Model | Simple Content Detail | Restrictions
Related Template:
facet.tpl

Descriptions

doc.comp.model.simpleContent.restrictions.desc : enum {"full", "first_sentence", "optimal", "none"}

Specify if the Simple Content Detail should include the descriptions of lists, unions, restritions and facets.

The full description text is obtained from all <xs:documentation> elements found by the following path:
(xs:facet | restriction | xs:list | xs:union)/xs:annotation/xs:documentation
where 'xs:facet' is one of the elements:
  • xs:enumeration
  • xs:fractionDigits
  • xs:length
  • xs:maxExclusive
  • xs:maxInclusive
  • xs:maxLength
  • xs:minExclusive
  • xs:minInclusive
  • xs:minLength
  • xs:pattern
  • xs:totalDigits
  • xs:whiteSpace
Multiple <xs:documentation> elements produce different sections of the description text. How descriptions are processed and displayed can be customized in the "Descriptions" parameter group.
Possible Choices:

"full"

Always include full descriptions.
"first sentence"
Include only the first sentence of the description text.
"optimal"
The goal of this setting is to minimize the repeating of full descriptions across the documentation.

Either the full description text or its first sentence will be inserted here, which is decided as follows.

If the full description consists of a single sentence, it is all what will be inserted here anyway.

For multi-sentence descriptions:

  1. If the corresponding facet/restriction/list/union is defined within the same component, for which this restriction detail is generated, then the full description is always included.
  2. Otherwise, the facet/restriction/list/union's full description is looked for elsewhere in the documentation. If it exists, only the first sentence of the description is printed here followed by the link to the full description. If not, the full description is inserted here anyway.
"none"
Do not include the restriction descriptions.
Default Value:
Provided by the parameter: Details | Fragments | Content Model | Simple Content Detail | Restrictions | Descriptions
Related Template:
annotation.tpl