FlexDoc/XML - XSDDoc - Parameter Tree

About XSDDoc parameters

«Details | Fragments» parameter group

This parameter group allows you to control at once the appearance of similar fragments found in different main documentation blocks. This includes: Actually, those particular fragments are controlled by their own parameters. But the parameters in this group provide the default values to them. Thereby, you don't need to repeat the same type of settings across all related parameters in the whole parameter tree.

Parameter Name / Type / Description

Schema Summary

doc.frgm.schemas

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

Sorting

doc.frgm.schemas.sorting : boolean

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 “Show | Namespace Prefixes” parameter.

    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 “Show | Element Name Extensions” parameter.

  • 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).

Default Value:
Copied dynamically from the value of the parameter: Generate Details | Sorting | Schemas

Annotation

doc.frgm.schemas.annotation : enum {"first_sentence", "full", "none"}

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

The full annotation text is obtained from all <xs:documentation> elements found by the following path:

xs:schema/xs:annotation/xs:documentation
Multiple <xs:documentation> elements produce multiple sections of the annotation text.

Possible Choices:

"first sentence"
Include only the first sentence of the annotation text.
"full"
Include the full annotation.
"none"
Do not include annotation.
See Also:
Processing | Annotations” parameter group, where you can specify how annotations are processed and displayed.

Schema Profile

doc.frgm.schemas.profile : boolean

Specifies whether to generate the «Schema Profile» section, which shows the general summary information about the component.

Nested Parameters:

Control what is included in the Schema Profile section. These parameters are similar to those found in “Detail | Schema Overview | Schema Profile” parameter group.

Component Summary

doc.frgm.comps

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

Generate For

doc.frgm.comps.for

The parameters in this group control for what component types the component summary is generated.

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

doc.frgm.comps.for.elements : boolean
doc.frgm.comps.for.element.local : enum {"all", "complexType", "none"}
doc.frgm.comps.for.complexTypes : boolean
doc.frgm.comps.for.simpleTypes : boolean
doc.frgm.comps.for.groups : boolean
doc.frgm.comps.for.attributeGroups : boolean
doc.frgm.comps.for.attributes : boolean

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:

Sorting

doc.frgm.comps.sorting : boolean

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 “Show | Namespace Prefixes” parameter.

    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 “Show | Element Name Extensions” parameter.

  • 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).

Default Value:
Copied dynamically from the value of the parameter: Generate Details | Sorting | Components

Annotation

doc.frgm.comps.annotation : enum {"first_sentence", "full", "none"}

Specify whether to include in the summary item the XSD component annotation and which part of it.

The full annotation text is obtained from all <xs:documentation> elements found by the following path:

xs:component/xs:annotation/xs:documentation
where 'xs:component' is the particular XML element that defines the component (e.g. xs:complexType). Multiple <xs:documentation> elements produce different sections of the annotation text.

Possible Choices:

"first sentence"
Include only the first sentence of the annotation text.
"full"
Include the full annotation.
"none"
Do not include annotation.
See Also:
Processing | Annotations” parameter group, where you can specify how annotations are processed and displayed.

Component Profile

doc.frgm.comps.profile : boolean

Specify whether to include in the summary item the «Component Profile» section, which shows some general information about the XSD component.

Nested Parameters:

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

Related Component Lists

doc.frgm.comps.lists : boolean

Specify whether to generate various summary lists of other XML schema components related to the given one.

Nested Parameters:

Control the generation of particular component lists and their appearance.

Content Attributes

doc.frgm.comps.lists.contentAttributes : boolean

Specifies whether to generate the list of «Content Model Attributes».

This list shows all elements declared in the Content Model of the given component. These are the same attributes as shown in the component's XML Representation Summary (or in the component diagram).

Applies To:

  • Global & Local Elements
  • Complex Types
  • Attribute Groups

Show Type/Value Info

doc.frgm.comps.lists.contentAttributes.value : boolean

Specify whether to show the sumary informaton about the attribute's data type and possible values.

When true (selected), the attribute list will look the same as in the component's XML Representation Summary.

When false (unselected), only attribute names will be listed.

Include Wildcards

doc.frgm.comps.lists.contentAttributes.wildcards : boolean

Specifies whether the list of Content Model Attributes should include attribute wildcards.

Content Elements

doc.frgm.comps.lists.contentElements : boolean

Specifies whether to generate the list of «Content Model Elements».

This list shows all elements declared in the Content Model of the given component. These are the same elements as shown in the Complex Content Model of the component's XML Representation Summary (or in the component diagram). However, unlike in the model representation, the elements in this list are ordered alphabetically, never repeat and hyper-linked directly to the corresponding Element Documentations.

Applies To:

  • Global & Local Elements
  • Complex Types
  • Element Groups

List Layout

doc.frgm.comps.lists.contentElements.layout : enum {"flow", "one_column", "two_columns", "optimal"}

This parameter controls how the list items are displayed.

Possible Choices:

"flow"
The list items will appear as a comma delimited text flow within a single paragraph.

This layout produces a very compact representation of the list. However, it may be difficult to read, particularly when some items contain spaces.

"one column"
The list will be printed in a single column: each item on a separate line.

This layout suits best for the lists containing long strings (particularly with spaces).

"two columns"
The list items will be arranged in a two-column table.

This representation suits more for the lists, whose items include strings with spaces.

However, when the list contains long strings, the two-column table may stretch far beyond the visible (printable) page width. In that case, the one-column layout suits better.

Also, the two-column layout may be not very good for big lists made of short word items (because it will occupy too much space). In that case the flow layout may fit better.

"optimal"
This choice allows for the list layout to be selected automatically during the generation so as to represent each particular list in both the most dense and readable form. (This is programmed in templates.)

Include Wildcards

doc.frgm.comps.lists.contentElements.wildcards : boolean

Specifies whether the list of Content Model Elements should include element wildcards.