FlexDoc/XML - XSDDoc - Parameter Tree

Specifies whether to generate the Attribute Detail section, which documents the attribute declarations specified for the given component.

In "Generate For" nested parameter group, you can select precisely for which components this section may be generated.

In "Include" nested parameter group, you can specify which kinds of attribute definitions need to be documented:

• specified in this component only
• inherited from ancestor components
• local attributes
• global attributes (specified by reference)
• wildcards
• prohibitions

• Elements
• Complex Types
• Attribute Groups

Controls which kinds of attributes should be documented, for which components, how the attribute should be sorted, how to document a particular attribute.

contentAttributes.tpl

The parameters in this group allow you to specify exactly for which components the «Attribute Detail» section must be generated.

Specify whether to generate the «Attribute Detail» section respectively for element, complex type and attribute group components.

This parameter group controls which kinds of attribute declarations will be documented.

Specify whether to document declarations of local attributes.

Possible Choices:

"all"

Include all local attributes.

Include only local attributes with anonymous type.

You may need this setting when you rely on documenting local attributes mostly through the Content Model Table Representation, see the parameter group:

Details | Component | Content Model | Table Representation | Attributes

If the attribute type is defined anonymously within the attribute declaration itself, it cannot be fully documented in such a table.

Do not document local attribute declarations.

Specify whether to document references to global attributes

Specify whether to document the declaration of an attribute wildcard.

wildcard.tpl

Specify whether to document attribute prohibitions.

Only prohibitions declared directly in this component may be documented.

DiagramKit | Show in Diagram | Attribute Prohibitions

Specify whether to document in this section the declarations of attributes inherited from other (ancestor) components.

When this parameter is selected (true), both the attributes declared directly within this component itself and those inherited from its ancestor components will be documented together. That will result in repeating of the details of the same attribute declarations across the documentation of all components that inherit those attributes.

If this parameter is unselected (false), only attributes specified directly within the declaration of this component will be documented. Any attributes inherited from other components will be documented only once along with their parent components (where they are declared). Only hyperlinks to the corresponding attribute details will lead from this component documentation (e.g. from the XML Representation Summary). That setting will produce a more compact documentation.

This parameter specifies how the attributes should be sorted.

When selected (true) the attributes will be sorted in alphabetic order of their qualified names (with letter case ignored).

When unselected (false) the attributes will follow according to some natural order determined by how and where those attributes are declared:

• In the simplest case, when all attributes are declared within the same component, that will be exactly the order of their declarations.
• When the given component (whose attributes are documented) is based on other components, some of the attributes may be inherited from them. Moreover, the ancestor components may block certain attributes declared in their own ancestors. In that case, the result attribute ordering will appear from the subsequent interpretation of all involved components.

Specifies whether to generate the Attribute Profile section, which contains the summary information about the attribute (such as its type, possible usage, default or fixed value, definition location).

Controls what exactly is included in the Attribute Profile section.

Specify whether to document the form of the attribute name (i.e. if it should be namespace-qualified or not).

All globally declared attributes have namespace-qualified names.

For locally declared attributes, their namespace qualification is specified by the 'form' attribute of the attribute component. When that attribute is absent, its default value is defined by the 'attributeFormDefault' attribute of the parent <xs:schema>.

Possible Choices:

"any"

Document the namespace-qualified form for all attribute components (both global and local ones).

"non-default only"

Document the namespace-qualified form only for locally defined attribute components with the explicitly specified 'form' attribute. (No default value of that attribute will be documented.)

"none"

Do not document the namespace-qualified form of the attribute.

Specify whether to show the attribute type information.

Specify whether to show the attribute default value.

Specify whether to show the attribute fixed value.

Specify whether to show the possible usage of the attribute.

More exactly, it is the value of the 'use' attribute found in the XSD element of the attribute declaration. For example:

<xs:attribute name="refer" type="xs:QName" use="required"/>

Specify whether to show in which component this attribute is declared.

The declaration location may be different from the current component (being documented by this Component Documentation) only when the parameter

Details | Component | Attribute Detail | Include | Inherited

Specify whether to include the full description of the attribute.

annotation.tpl

Specifies whether to generate the Attribute Value Detail.

Nested Parameters:

Control the generation of specific details about simple content.

See Also Parameter Groups:

• Details |
  • Fragments | Content Model | Simple Content Detail
  • Component |
    • Content Model | Simple Content Detail
    • Content Element Details | Content Model | Simple Content Detail

simpleContentDetail.tpl

Specify whether to show the Simple Content Representation.

Provided by the parameter: Details | Fragments | Content Model | Simple Content Detail | Representation

simpleContentRep.tpl

Specify how to represent enumerations.

Possible Choices:

"full"

Always show the full list of enumeration values.

For instance: ("extension" | "restriction" | "list" | "union")

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

Each enumeration is represented like

enumeration of xs:string

with the link to the full enumeration list in the corresponding simple type details.

Provided by the parameter: Details | Fragments | Content Model | Simple Content Detail | Representation | Enumerations

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.

"full"

Always show all restrictions (facets).

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.

Do not show restriction details

Specifies whether to show the descriptions of facets, lists and unions.

Provided by the parameter: Details | Fragments | Content Model | Simple Content Detail | Restrictions

facet.tpl

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

"full"

Always include full descriptions.

Include only the first sentence of the description text.

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.

Do not include the restriction descriptions.

Provided by the parameter: Details | Fragments | Content Model | Simple Content Detail | Restrictions | Descriptions

annotation.tpl

Specify whether to generate the details about the definition of the attribute type.

This section may include:

1. The Type Derivation Tree summary, which graphically depicts how the type was derived from the most basic types.
2. The type annotation.
3. The type derivation details, which include all facets and annotations to them. With the nested "Simple Content Derivation" parameter, you can specify whether to document the entire datatype derivation tree produced from all known XML schema components involved.

In the nested parameter group "Generate For", you can specify exactly for which attributes this section should be generated.

Other parameters control the section content.

The parameters in this group allows you to specify exactly for which attributes the «Type Detail» section must be generated.

Each parameter imposes a specific condition on the attribute and its type. The «Type Detail» section is generated when the conditions by all parameters in this group are satisfied.

Specify the possible scope of attributes for which the Type Detail section may be generated.

Possible Choices:

"local only"

The type details may be generated only for locally defined attributes.

This is the default setting because the global attributes (with their types) are supposed to be documented separately.

"any"

The type details may be generated regardless of the attribute scope.

Specify the possible scope of the attribute type declaration for which the «Type Detail» section may be generated.

Possible Choices:

"anonymous"

The type details may 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 type details should be generated for any attribute type (regardless of its declaration scope).

Specify whether to include the attribute type description.

annotation.tpl

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

typeDerivationTree.tpl

Specify whether to generate the details about the derivation of the attribute datatype, including all facets and (possibly) annotations.

Possible Choices:

"local definition only"

Document the datatype derivation specified only within the definition of this attribute (i.e. within the XSD <xs:attribute> element defining this attribute).

"full"

Document the entire datatype derivation tree produced from all known XML schema components involved.

"none"

Do not document the datatype derivation.

Specify if certain features should be included in the type derivation details (e.g. full facet details, additional annotations)

simpleContentDerivation.tpl

Specify whether to show facets specified in each derivation step.

"full"

Show all facets

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.

Do not show restriction details

facet.tpl

Specifies whether the datatype derivation details should include all descriptions.

"full"

Always include full descriptions.

Include only the first sentence of the description text.

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.

Do not include the descriptions.

annotation.tpl

Specifies whether to reproduce the XML source of the attribute declaration.

Controls how the reproduced XML source will look and what it should include.

nodeSource.tpl, sourceNote.tpl

Specifies if the reproduced XML should be enclosed in a box.

Specifies whether to remove all <xs:annotation> elements from the reproduced XML source fragment.

• Details | Component | Description
• Descriptions | HTML Markup