FlexDoc/XML - XSDDoc - Parameter Tree

About XSDDoc parameters

«Details | Component Documentation | Lists Of Related Components» parameter group

Parameter Name / Type / Description
Lists Of Related Components doc.comp.lists : boolean

Specify whether to generate various summary lists of other XML schema components that are related to the given one (being documented in this «Component Documentation»).

Nested Parameters:

Control the generation of particular component lists and their appearance.

List Layout

doc.comp.lists.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.)

Content Elements

doc.comp.lists.contentElements : boolean

Specify whether to generate the «List of Content Elements».

Applies To:

Global & Local Elements, Complex Types, Element Groups

Containing Elements

doc.comp.lists.containingElements : boolean

Specify whether to generate the «List of Containing Elements».

Applies To:

Global & Local Elements

Substitutable Elements

doc.comp.lists.substitutableElements : boolean

Specify whether to generate the «Lists of Substitutable Elements».

Applies To:

Global Elements
See Also Parameter:
Details | Component Documentation | Component Profile | Subst.Gr | List of group heads

Substituting Elements

doc.comp.lists.substitutingElements : boolean

Specify whether to generate the «Lists of Substituting Elements».

Applies To:

Global Elements
See Also Parameter:
Details | Component Documentation | Component Profile | Subst.Gr | List of group members

Children By Substitutions

doc.comp.lists.childrenBySubst : boolean

Specify whether to generate the «Lists of Possible Children By Substitutions».

Applies To:

Global & Local Elements

Parents By Substitutions

doc.comp.lists.parentsBySubst : boolean

Specify whether to generate the «Lists of Possible Parents By Substitutions».

Applies To:

Global Elements

Direct Subtypes

doc.comp.lists.directSubtypes : boolean

Specify whether to generate the «List of Direct Subtypes».

Applies To:

Simple Types, Complex Types

Indirect Subtypes

doc.comp.lists.indirectSubtypes : boolean

Specify whether to generate the «List of Indirect Subtypes».

Applies To:

Simple Types, Complex Types

All Based Elements

doc.comp.lists.basedElements : boolean

Specify whether to generate the «List of All Based Elements».

Applies To:

Simple Types, Complex Types

All Based Attributes

doc.comp.lists.basedAttributes : boolean

Specify whether to generate the «List of All Based Attributes».

Applies To:

Simple Types