FlexDoc/XML - XSDDoc - Parameter Tree

«Details | Component | Related Components» parameter group

Parameter	Name / Type / Description
Related Components	`doc.comp.related : 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.related.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.related.contentElements : boolean` Specifies whether to generate the *List of Content Elements. This list shows all elements declared in the Element Content Model* of the given component. These are the same elements as shown in the 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's Component Documentations. Applies To: Global & Local Elements Complex Types Element Groups Related Template: contentElementList.tpl
Containing Elements	`doc.comp.related.containingElements : boolean` Specifies whether to generate the List of Containing Elements. This list is generated for: Global & Local Elements: It appears under the heading "Included in content model of elements". The list shows all elements whose content model explicitly includes the given element. Global Attributes: It appears under the heading "Available in elements". The list shows all elements whose content model explicitly includes the given attribute. Here, "explicitly" means that element/attribute wildcards are not taken into account. Related Template: elementList.tpl
Substitutable Elements	`doc.comp.related.substitutableElements : boolean` Specifies whether to generate the list of elements this element may substitute for (that is, the given element may be used anywhere instead of the elements in the list). This list will appear under the heading "Substitutes for elements". Applies To: Global Elements See Also Parameter: Details \| Component \| Component Profile \| Subst.Gr \| List of group heads Related Template: elementList.tpl
Substituting Elements	`doc.comp.related.substitutingElements : boolean` Specifies whether to generate the list of elements that may substitute for the given element. Typically, these are the members of the substitution group headed by the given element. Note that the head of a substitution group may be a member of other substitution group (with a different head) and so on. Thereby, the subsitution groups may form an hierarchy. So, the list of substituting elements may potentially include all members of the subsitution group hierarchy attached to the given element. However, that is not always the case. Some of those members may be abstract or blocked from substitutions by the setting of `block` attribute (specified in the given element or intemediate heads). Such members will be excluded from the list. The list will appear under the heading "Can be substituted with elements". Applies To: Global Elements See Also Parameters: Details \| Component \| Component Profile \| Subst.Gr \| List of group members DiagramKit \| Show in Diagram \| Substitution Groups Related Template: elementList.tpl
Children By Substitutions	`doc.comp.related.childrenBySubst : boolean` Specifies whether to generate the list of all known elements that may be included in the given element by substitutions. In particular, the list shows all members of the substitution groups whose head elements are declared in the content model of the given element component. The list will appear under the heading "May contain elements by substitutions". Applies To: Global & Local Elements Related Template: elementList.tpl
Parents By Substitutions	`doc.comp.related.parentsBySubst : boolean` Specifies whether to generate the list of all known elements that may include the given element by substitutions. In particular, the list shows all elements whose content models include the head element of a substitution group which the given element is member of. The list will appear under the heading "May be included in elements by substitutions". Applies To: Global Elements Related Template: elementList.tpl
Direct Subtypes	`doc.comp.related.directSubtypes : boolean` Specifies whether to generate the *List of Direct Subtypes. This list is generated for each Simple/Complex Type Component. It shows all other type components that are directly derived from the given type component. A type is considered to be directly derived* from the given type, when its definition contains an explicit reference to the given type. Applies To: Simple/Complex Types Related Template: typeRelatedComps.tpl
Indirect Subtypes	`doc.comp.related.indirectSubtypes : boolean` Specifies whether to generate the *List of Indirect Subtypes. This list is generated for each Simple/Complex Type Component. It shows all other type components that are indirectly derived from the given type component. A type is considered to be indirectly derived* from the given type, when its definition contains no explicit references to the given type but a reference to a certain third type that is directly or indirectly derived from the given type). Applies To: Simple/Complex Types Related Template: typeRelatedComps.tpl
All Based Elements	`doc.comp.related.basedElements : boolean` Specifies whether to generate the *List of All Based Elements. This list is generated for each Simple/Complex Type Component. It shows all elements whose type is either the given type itself or directly/indirectly derived from the given type. Applies To:* Simple/Complex Types Related Template: typeRelatedComps.tpl
All Based Attributes	`doc.comp.related.basedAttributes : boolean` Specifies whether to generate the *List of All Based Attributes. This list is generated for each Simple Type Component. It shows all attributes (defined both globally and locally) whose type is either the given type itself or directly/indirectly derived from the given type. Applies To:* Simple Types Related Template: typeRelatedComps.tpl