FlexDoc/XML - XSDDoc - Parameter Tree

This parameter group allows you to adjust at once the appearance of all Schema Summary sections found across the documentation. Specifically, it provides the default values for the following parameter groups:

• Details | Overview | Schema Summary
• Details | Namespace | Schema Summary

schemaSummary.tpl

Specify how the Schema Summary is sorted.

The parameter has the following meaning:

• When it is selected (true), the XML schemas will be sorted alphabetically by their file names (ignoring letter case).
• When the parameter is unselected (false), the XML schemas will follow in a certain "physical" order determined by how the initial XML schemas (to be documented) have been specified as well as how these schemas import other XML schemas.

  For more information about this, see also the parameter group: Generate Details | For schemas

Provided by the parameter: Generate Details | Sorting | Schemas

Specify whether the schema summary item should include the Schema Profile section, which shows some general information about the XML schema.

Nested Parameters:

Control what exactly is included in the Schema Profile section.

These parameters are similar to those found in the parameter group: Detail | Schema Overview | Schema Profile

schemaProfile.tpl

Specify whether to include the XML schema description and which part of it.

"full"

Include the full description.

Include only the first sentence of the description text.

Include the first sentence of the description text. If that is not the whole text and the full description is included in the Schema Overview, the link to it will be added at the end.

That will immediately indicate that there is more text and provide a quick link to it.

This parameter group allows you to adjust at once the appearance of all Component Summary aections found across the documentation. Specifically, it provides the default values for the following parameter groups:

• Details | All Components
• Details | Namespace | Component Summary
• Details | Schema | Component Summary

elementSummary.tpl, complexTypeSummary.tpl, simpleTypeSummary.tpl, groupSummary.tpl, attributeGroupSummary.tpl, globalAttributeSummary.tpl

The parameters in this group control what type of components are included in the summary.

Normally, that would be the same as for what component types the Component Documentation is generated. Hence, the default values of these parameters are copied from the corresponding parameters in "Generate Details" group.

Specify whether to generate component summaries for particular components types.

Normally, that would be the same as for what component types the «Component Documentation» is generated. Hence, the default values of these parameters are copied from the corresponding parameters:

Generate Details | Components |

• Elements
  • Local Elements
• Complex Types
• Simple Types
• Element Groups
• Attribute Groups
• Global Attributes

With this parameter you can specify the sorting order of components.

The parameter has the following meaning:

• When it is selected (true), the XSD components will be sorted alphabetically by their names (ignoring letter case).

  The component name is assumed to be that under which the component appears (is referenced to) at the given documentation location. This is typically the component qualified name (which is the actual namespace prefix plus the component local name). That, however, can be changed using the parameter: Show | Namespace Prefixes

  Additionally, in the case of local elements, the component name may also include a special extension used to distinguish the equally named local elements. For more details about this, please see the parameter: Show | Element Name Extensions

• When the parameter is unselected (false), the XSD components are not sorted. In that case they will follow in a certain "physical" order produced according to the following.

  When components come from different XML schemas, first, they will be grouped by their schemas. The ordering of those groups is determined by what XSD files have been specified initially and how they reference (e.g. import) other XSD files.

  Within a group of components that belong to the same XML schema, they will follow in the same order as they are defined in that schema.

  This allows you to control a particular ordering of components (e.g. elements) by yourself. Simply define the most important components (e.g. an XML document's root element) on the top of the XML schema. If you have several schemas to document, specify the most important of them the first. That will produce the component ordering as you wish (or something close to it).

Provided by the parameter: Generate Details | Sorting | Components

Specify if the component summary item should include the Component Profile section, which shows some general information about the XSD component.

Nested Parameters:

Control what exactly is included in the Component Profile section.
These parameters are similar to those found in the parameter group: Detail | Component | Component Profile

elementProfile.tpl, typeProfile.tpl, groupProfile.tpl, attributeGroupProfile.tpl, globalAttributeProfile.tpl

Specify if the component summary item should include the component description and which part of it.

"full"

Include the full description.

Include only the first sentence of the description text.

Include the first sentence of the description text. If that is not the whole text and the full description is included in the Component Documentation (or elsewhere), the link to it will be added at the end.

That will immediately indicate that there is more text and provide a quick link to it.

Do not include the component description.

Related Template:

annotationText.tpl

Specify if the component summary item should include the Content Model Table (i.e. possible attributes and child elements) defined by the component).

Applies To:

• Elements
• Complex Types
• Element Groups
• Attribute Groups

Control what is included in the Content Model Table.

These parameters are similar to those found in the parameter group: Details | Fragments | Content Model | Table Representation

tableRep.tpl

This group of parameters includes settings for the generation of various representations of the content model (i.e. possible attributes and child elements) defined by an XSD component.

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

1. Diagram
2. XML Representation Summary
3. Table Representation

Applies To:

All components

This parameter group includes settings for a graphical diagram representation of the component content model.

Applies To:

• Elements
• Complex Types
• Element Groups
• Attribute Groups

Control how to direct hyperlinks from the diagram image.

• Details | Component |
  • Content Model | Diagram
  • Content Element Details | Content Model | Diagram
• DiagramKit

diagram.tpl, DiagramKit.tpl

This parameter group controls how the diagram hyperlinks will be generated. The current implementation limits it to the following possibilities:

1. The depiction of a global attribute (specified by reference) can be hyperlinked either to the attribute's global documentation or to its local documentation (that is of the reference) found in the Attribute Detail section or in the Attribute Table (see Table Representation).

   That is controlled by the "Global Attributes" parameter of this group.

   When neither local nor global documentation is found, the hyperlink will go to the location where the global attribute is defined within the XML schema source. See the parameter: Details | Schema | XML Source

2. The depiction of a local attribute or attribute prohibition can be hyperlinked only to the corresponding local documentation in Attribute Detail section or in the Attribute Table (see Table Representation).

   If not found, the hyperlink will go to the definition's location within the XML schema source.

3. The depiction of a global element (specified by reference) can be hyperlinked only to the element's global documentation.

   If not found, the hyperlink will go to the location where the global element is defined within the XML schema source (see the parameter: Details | Schema | XML Source).

4. The depiction of a local elements can be hyperlinked either to the global documentation related to this element component; see parameter:

   Generate Details | Components | Elements | Local Elements

   Or to its local documentation found in the Content Element Detail section or in the Content Element Table (see Table Representation).

   That is controlled by the "Local Elements" parameter in this group.

   When neither local nor global documentation is found, the hyperlink will go to the definition's location within the XML schema source. See the parameter: Details | Schema | XML Source

Specify how to hyperlink the depictions of global attributes:

"global documentation"

The hyperlink will be generated to the attribute's global documentation; see the parameter: Generate Details | Components | Global Attributes

If that documentation is not found, the hyperlink goes to the local documentation (of the attribute's reference definition) in the Attrbute Detail section or in the Attribute Table (see Table Representation).

At last, if that is also not found, the hyperlink is directed to the definition of the global attribute within the XML schema source. See the parameter: Details | Schema | XML Source

In this case, the local documentation found in the Attrbute Detail section or Attribute Table will be the first priority; then the attribute's global documentation; at last, the location within the XML schema source.

Specify how to hyperlink the depictions of local elements:

"global documentation"

The hyperlink will be generated to the global documentation related to this element component; see the parameter:

Generate Details | Components | Elements | Local Elements

If that documentation is not found, the hyperlink goes to the local documentation (of the element's reference definition) in the Content Element Detail section or in the Content Element Table (see Table Representation).

At last, if that is also not found, the hyperlink will be directed to the definition of this element within the XML schema source. See the parameter: Details | Schema | XML Source

In this case, the local documentation found in Content Element Detail section or Content Element Table will be the first priority; then the element's global documentation; at last, the location within the XML schema source.

Specify whether to generate hyperlinks from the compositors (choice / sequence / all) depicted on the diagram to their definitions within the XML schema source.

See Also Parameter:

Details | Schema | XML Source

This parameter group includes settings for the XML Representation Summary of the component content model.

Applies To:

All components

Details | Component |

• Content Model | XML Representation Summary
• Content Element Details | Content Model | XML Representation Summary

xmlRep.tpl

Specify the ordering of attributes shown in the XML Representation Summary.

When selected (true) the attributes will be sorted in alphabetical 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 represented) 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.

This parameter group includes settings for the Table Representation of the component content model.

Affected Parameters Groups:

Details |

• Fragments | Component Summary | Content Model Table
• Component |
  • Content Model | Table Representation
  • Content Element Details | Content Model | Table Representation

tableRep.tpl

Specify whether to generate the table representation of attributes.

Applies To:

• Elements
• Complex Types
• Attribute Groups

Control what is included in the attribute table

Specify the ordering of attributes shown in the attribute table.

When selected (true) the attributes will be sorted in alphabetical 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 represented) 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.

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.

simpleContentRep.tpl

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

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

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

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

"full"

Display the full description of each attribute.

Display only the first sentence of the description text.

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.

Do not include the "Description" column.

Related Template:

annotationText.tpl

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

Applies To:

• Elements
• Complex Types
• Element Groups

Control what is included in the content element table

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.

simpleContentRep.tpl

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

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

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

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

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

"full"

Display the full description of each element.

Display only the first sentence of the description text.

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.

Do not include the "Description" column.

Nested Parameter:

Controls whether to show the descriptions of compositors.

annotationText.tpl

Specify whether to include the descriptions of compositors.

Since compositors (choice / sequence / all) are also shown in the table representation of the content element model, their descriptions can be included as well.

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