FlexDoc/XML - XSDDoc - Parameter Tree

About XSDDoc parameters

«Details | Component | Content Model» parameter group

Parameter Name / Type / Description

Content Model

doc.comp.model

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

The component content model can be represented in three different ways simultaneously:

  1. Diagram
  2. XML Representation Summary
  3. Table Representation
Each of those representations is controlled by the corresponding nested parameter group.

Applies To:

All components
See Also Parameter Groups:

Diagram

doc.comp.model.diagram

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

Applies To:

  • Elements
  • Complex Types
  • Element Groups
  • 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

doc.comp.model.diagram.for.element : enum {"all", "anonymous_type", "none"}

Specify whether to generate the Component Diagram section for element components.

Possible Choices:

"all"

Generate the Component Diagram for all elements.
"with anonymous type only"
Generate the Component Diagram only for elements with anonymous type.
You may need this setting when you have an enormous number of XSD components to document and want to reduce any duplications to minimum.

If an element has a named type, then everything related to the element content model is already documented by that type.

"with complex type only"
Generate the Component Diagram only for elements with complex type.
"none"
Do not generate the Component Diagram for elements.

Complex Types
Element Groups
Attribute Groups

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

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

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:
Details |
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: Show Enumeration.
Default Value:
Provided by the parameter: Details | Fragments | Content Model | Table Representation | Attributes | Value Representation
Related Template:
simpleContentRep.tpl

Show Enumeration

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

Specify whether the value representation may include the enumeration of all possible attribute values.

You may want to disable this setting when the list of possible values is very large and better to be documented only once by the coppersponding named simple type where it is defined.
Default Value:
Provided by the parameter: Details | Fragments | Content Model | Table Representation | Attributes | Value Representation | Show Enumeration

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 | XSD Annotations" 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 Table Representation 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: Show Enumeration.
Default Value:
Provided by the parameter: Details | Fragments | Content Model | Table Representation | Content Elements | Value Representation
Related Template:
simpleContentRep.tpl

Show Enumeration

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

Specify whether the value representation may include the enumeration of all possible values of the element.

You may want to disable this setting when the list of possible values is very large and better to be documented only once by the coppersponding named type where it is defined.
Default Value:
Provided by the parameter: Details | Fragments | Content Model | Table Representation | Content Elements | Value Representation | Show Enumeration

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 | XSD Annotations" 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.
Nested Parameter:
Controls whether to show the descriptions of compositors.

Default Value:

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