FlexDoc/XML - XSDDoc - Parameter Tree

About XSDDoc parameters

«Details | Component | Type Definition Detail» parameter group

Parameter Name / Type / Description
Type Definition Detail doc.comp.type : boolean

Specify whether to generate the details about the definition of the type associated with (or represented by) the given component.

This section may include:

  1. The "Type Derivation Tree" summary, which graphically depicts how this type was derived from the most basic types.
  2. The type annotation (which is generated in the case of an element or attribute component).
  3. In the case of a simple type (or a complex type with simple content), this section may also include all details about how the datatype was derived including all facets and annotations to them. With the nested "Simple Content Derivation" parameter, you can specify whether to document in that way the entire type derivation tree produced by all known XML schema components involved.
Applies To:
  • Elements
  • Global Attributes
  • Simple Types
  • Complex Types
Nested Parameters:
In the nested parameter group "Generate For", you can specify exactly for which components this section should be generated.

Other parameters control the section content.

Generate For

doc.comp.type.for

The parameters in this group allows you to specify exactly for which components the "Type Definition Detail" section must be generated.

Elements With Types

doc.comp.type.for.element.type : enum {"anonymous", "any", "none"}

Specify when the "Type Definition Detail" section should be generated for element components.

Possible Choices:

"anonymous"

The type details will be generated only in the case of an anonymous type. (The anonymous type is the one that is defined directly within the definition of the element component.)

This is the default setting because the (non-anonymous) global types are supposed to be documented separately.

"any"
The definition of any element type (both global and anonymous) will be documented along with the element component.
"none"
Do not document the element type definition.
Applies To:
Elements

Attributes With Types

doc.comp.type.for.attribute.type : enum {"anonymous", "any", "none"}

Specify when the "Type Definition Detail" section should be generated for global attribute components.

Possible Choices:

"anonymous"

The type details will be generated only in the case of an anonymous type. (The anonymous type is the one that is defined directly within the definition of the attribute component.)

This is the default setting because the (non-anonymous) global types are supposed to be documented separately.

"any"
The definition of any attribute type (both global and anonymous) will be documented along with the attribute component.
"none"
Do not document the attribute type definition.
Applies To:
Global Attributes

Global Types

doc.comp.type.for.type : boolean

Specify whether to generate the "Type Definition Detail" for a global type component.

Applies To:

Simple/Complex Types
  • Simple Types
  • Complex Types

Type Derivation Tree

doc.comp.type.deriv.tree : boolean

Specify whether to generate the Type Derivation Tree summary, which graphically depicts how this type was derived from the most basic types.

Related Template:
typeDerivationTree.tpl

Description

doc.comp.type.desc : boolean

Specify whether to include the type description.

Applies To:

  • Elements
  • Global Attributes
In the case of a simple/complex type component, the type description is already present in the component's Description section.
See Also Parameter Group:
Descriptions, where you can specify how annotations are processed and displayed.
Related Template:
annotation.tpl

Simple Content Derivation

doc.comp.type.deriv.simpleContent : enum {"local", "full", "none"}

Specify whether to generate the details about the derivation of the simple content datatype described by this type (including all facets and annotations).

Possible Choices:

"local definition only"

Document the simple content derivation specified only within the definition of the given component itself (i.e. the one being documented in this Component Documentation).
"full"
Document the entire simple content derivation tree produced from all known XML schema components involved.
"none"
Do not document the derivation of simple content.
Applies To:
  • Simple Types
  • Complex Types (with simple content only)
Nested Parameters:
Specify if certain features should be included in the type derivation details (e.g. full facet details, additional annotations)
Related Template:
simpleContentDerivation.tpl

Facets

doc.comp.type.deriv.simpleContent.facets : enum {"full", "optimal", "none"}

Specify whether to show facets specified in each derivation step.

You may want to disable documenting every facet specified during the type derivation because all actual facets that restrict the component value/content may be already shown in the «Simple Content Detail» / «Attribute Value Detail» section (some facets specified later may override those specified earlier). See parameters:
Details | Component |
  • Content Model | Simple Content Detail | Restrictions
  • Attribute Details | Attribute Value Detail | Restrictions
  • Content Element Details | Content Model | Simple Content Detail | Restrictions
Possible Choices:

"full"

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

When this setting is selected:

  • The facet is always shown only when it is not too long.
  • For a long facet. First, the facet's main documentation is looked for somewhere. If it exists somewhere in the «Simple Content Detail» / «Attribute Value Detail» section of this or other component, the link to it is inserted. If not, the full facet will be shown here anyway.
"none"
Do not show restriction details
Related Template:
facet.tpl

Descriptions

doc.comp.type.deriv.simpleContent.desc : enum {"full", "first_sentence", "optimal", "none"}

Specifies whether the datatype derivation details should include all descriptions.

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:

  1. If the full description consists of a single sentence, it is all what will be inserted here anyway.
  2. For multi-sentence descriptions, the facet/restriction/list/union's full description is looked for somewhere in the «Simple Content Detail» / «Attribute Value Detail» section of this or other component. 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 descriptions.
Related Template:
annotation.tpl