FlexDoc/XML - XSDDoc - Parameter Tree

About XSDDoc parameters

«Details | Component | Reference Locations» parameter group

Parameter Name / Type / Description
Reference Locations doc.comp.refs : boolean

Specifies whether to generate the Reference Locations report for global components.

It shows where and how the given component is used within this XML schema (where the component is defined) and within other XML schemas included in the documentation.

Applies To:
  • Global Elements
  • Complex / Simple Types
  • Element / Attribute Groups
  • Global Attributes
Related Template:
typeRefs.tpl

Generate For

doc.comp.refs.for

The parameters in this group allow you to select exactly for which components the Reference Locations section must be generated.

Elements
Complex Types
Simple Types
Element Groups
Attribute Groups
Global Attributes

doc.comp.refs.for.elements : boolean
doc.comp.refs.for.complexType : boolean
doc.comp.refs.for.simpleType : boolean
doc.comp.refs.for.group : boolean
doc.comp.refs.for.attribute : boolean
doc.comp.refs.for.attributeGroup : boolean

Specifies whether to generate the Reference Locations report for particular global component types.

List Layout

doc.comp.refs.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 rather difficult to read, especially 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 may fit better.

"optimal"
This choice allows 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.)