FlexDoc/XML - XSDDoc - Parameter Tree
About XSDDoc parameters
- [.]
- Generate Details
- Details
- Fragments
- Overview Summary
- All Component Summary
- Namespace Overview
- Schema Overview
- Component Documentation
- Component Profile
- Diagram
- XML Representation Summary
- Simple Content Detail
- Lists Of Related Components
- Usage / Definition Locations
- Annotation
- Type Definition Detail
- XML Source
- Attribute Detail
- Content Element Detail
- Navigation
- Show
- Processing
- Pagination
- DiagramKit
«Details | Component Documentation | Content Element Detail» parameter group
Parameter | Name / Type / Description |
---|---|
Content Element Detail |
doc.comp.contentElements : boolean
Specify whether to generate the «Content Element Detail» section. Applies To:
|
doc.comp.contentElements.for
The parameters in this group allow you to specify exactly for which components the «Content Element Detail» section must be generated. |
|
doc.comp.contentElements.for.element : boolean doc.comp.contentElements.for.complexType : boolean doc.comp.contentElements.for.group : boolean
Specify whether to generate the «Content Element Detail» section respectively for element, complex type and element group components. |
|
doc.comp.contentElements.include
This parameter group controls which kinds of content element declarations will be documented. |
|
doc.comp.contentElements.include.local : boolean
Specify whether to document declarations of local elements |
|
doc.comp.contentElements.include.references : boolean
Specify whether to document references to global elements |
|
doc.comp.contentElements.include.wildcards : boolean
Specify whether to document the declarations of element wildcards. |
|
doc.comp.contentElements.include.inherited : boolean
Specify whether to document in this section the declarations of content elements inherited from other (ancestor) components.
When this parameter is selected (
If this parameter is unselected ( |
|
doc.comp.contentElements.sorting : boolean
This parameter specifies how the content elements should be sorted.
When selected (
When unselected (
|
|
doc.comp.contentElements.profile : boolean
Specifies whether to generate the «Element Profile» section, which contains summary information about the element (such as its type, default or fixed value, definition location). Nested Parameters:
|
|
doc.comp.contentElements.profile.form : enum {"any", "non_default", "none"}
Specify whether to document the form of the element name (i.e. if it should be namespace-qualified or not). All globally declared elements have namespace-qualified names.
For locally declared elements, their namespace qualification is specified by the Possible Choices:
|
|
doc.comp.contentElements.profile.type : boolean
Specify whether to show the element type information. |
|
doc.comp.contentElements.profile.abstract : boolean
Specify whether to document Applies To:
|
|
doc.comp.contentElements.profile.block : enum {"any", "non_default", "none"}
Specify whether to document
Note: For global elements, when Possible Choices:
|
|
doc.comp.contentElements.profile.block.value : boolean
Specify whether to show the actual value of the Notes:
|
|
doc.comp.contentElements.profile.block.meaning : boolean
Specify whether to include the text explaining the meaning of the actual |
|
doc.comp.contentElements.profile.final : enum {"any", "non_default", "none"}
Specify whether to document
Note: When Possible Choices:
|
|
doc.comp.contentElements.profile.final.value : boolean
Specify whether to show the actual value of the Notes:
|
|
doc.comp.contentElements.profile.final.meaning : boolean
Specify whether to include the text explaining the meaning of the actual |
|
doc.comp.contentElements.profile.subst : boolean
Specify whether to show the information about the substitution groups, in which this element is involved (i.e. affiliated, head or member of). This may include:
|
|
doc.comp.contentElements.profile.subst.heads : boolean
Specify whether to show the list of the substitution group heads, which this element is member of. (In other words, these are the elements that this element may substitute for.)
When See Also Parameter: |
|
doc.comp.contentElements.profile.subst.members : boolean
Specify whether to show the list of the members of the substitution group, which this element is head of. (In other words, these are the elements that may substitute for this element.)
When See Also Parameter: |
|
doc.comp.contentElements.profile.default : boolean
Specify whether to show the default value of the element simple content. By default, this parameter is switched off when “Simple Content | Default Value” parameter is selected. |
|
doc.comp.contentElements.profile.fixed : boolean
Specify whether to show the fixed value of the element simple content. By default, this parameter is switched off when “Simple Content | Fixed Value” parameter is selected. |
|
doc.comp.contentElements.profile.nillable : boolean
Specify whether to document Applies To:
|
|
doc.comp.contentElements.profile.defined : boolean
Specify whether to show in which component this content element is defined. The definition location may be different from the current component (being documented by this «Component Documentation») only when the “Content Element Detail | Include | Inherited” parameter is selected. So, some of the content elements may be those inherited from the component's ancestors. Note:
|
|
doc.comp.contentElements.annotation : boolean
Specify whether to include the element annotation (full annotation text).
The annotation text is obtained from the
<xs:documentation> elements will produce separate sections of the annotation text.
See Also:
|
|
doc.comp.contentElements.xmlRep : boolean
Specifies whether to generate the XML Representation Summary of the given content element. Note:
|
|
doc.comp.contentElements.xmlRep.for
The parameters in this group allows you to specify exactly for which elements the XML Representation Summary section must be generated. Each parameter imposes a specific condition on the element and its type. The section is generated when the conditions by all parameters in this group are satisfied. |
|
doc.comp.contentElements.xmlRep.for.element : enum {"local", "any"}
Specify the possible scope of content elements for which the XML Representation Summary may be generated. Possible Choices:
|
|
doc.comp.contentElements.xmlRep.for.type : enum {"complexType", "simpleType", "any"}
Specify the possible types of elements for which the XML Representation Summary section may be generated. Possible Choices:
|
|
doc.comp.contentElements.xmlRep.sorting : boolean
This parameter specifies the ordering of attributes shown in the XML Representation Summary.
When selected (
When unselected (
|
|
doc.comp.contentElements.xmlRep.heading : boolean
Specify whether to show the heading string: "XML Representation Summary". |
|
doc.comp.contentElements.simpleContent : boolean
Specify whether to generate the details of the element simple content. This may include:
|
|
doc.comp.contentElements.simpleContent.model : boolean
Specify whether to generate the datatype model, which shows how the element content datatype is related to the XSD basic simple types. Note:
|
|
doc.comp.contentElements.simpleContent.restrictions : boolean
Specify whether to show all actual facets that restrict a possible value allowed for for the element simple content. The list of actual facets is produced as the following. First, the initial facets are collected by all types starting from the type assigned to the element 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:
|
|
doc.comp.contentElements.simpleContent.restrictions.annotation : boolean
Specify whether to include the facet annotations. |
|
doc.comp.contentElements.simpleContent.default : boolean
Specify whether to show the default value of the element content.
The default value is provided by the
|
|
doc.comp.contentElements.simpleContent.fixed : boolean
Specify whether to show the fixed value of the element content.
The default value is provided by the
When the element is declared by reference, its fixed value can be specified either in the local
reference component (which is being documented here) or in the global (referenced) element component.
In that case, the |
|
doc.comp.contentElements.type : boolean
Specify whether to generate the details about the definition of the content element type. This section may include:
|
|
doc.comp.contentElements.type.for
The parameters in this group allows you to specify exactly for which content elements the Type Detail section must be generated. Each parameter imposes a specific condition on the element and its type. The Type Detail section is generated when the conditions by all parameters in this group are satisfied. |
|
doc.comp.contentElements.type.for.element : enum {"local", "any"}
Specify the possible scope of content elements for which the «Type Detail» section may be generated. Possible Choices:
|
|
doc.comp.contentElements.type.for.type : enum {"simpleType", "any"}
Specify for which element types the «Type Detail» section may be generated. Possible Choices:
|
|
doc.comp.contentElements.type.for.typeDecl : enum {"anonymous", "any"}
Specify the possible scope of the type declaration for which the «Type Detail» section may be generated. Possible Choices:
|
|
doc.comp.contentElements.type.annotation : boolean
Specify whether to include the element type annotation. |
|
doc.comp.contentElements.type.deriv.tree : boolean
Specify whether to generate the «Type Derivation Tree» summary, which graphically depicts how the element type was derived from the most basic types. |
|
doc.comp.contentElements.type.deriv.simpleContent : boolean
Specify whether to generate the details about the derivation of the element's simple content datatype, including all facets and (possibly) annotations. Possible Choices:
|
|
doc.comp.contentElements.type.deriv.simpleContent.facets : boolean
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 element value/content may be already shown in the Simple Content section (some facets specified later may override those specified earlier). See Also Parameter: |
|
doc.comp.contentElements.type.deriv.simpleContent.annotations : boolean
Specifies whether the datatype derivation details should include all annotations (e.g. facet annotations) |
|
doc.comp.contentElements.xml : boolean
Specifies whether to reproduce the XML source of the content element declaration. Nested Parameters:
|
|
doc.comp.contentElements.xml.box : boolean
Specifies if the reproduced XML should be enclosed in a box. |
|
doc.comp.contentElements.xml.remove.anns : boolean
Specifies whether to remove all
You may want to exclude the See Also Parameters: |