Overview of the Model Element Enumeration Chapter

Model Element Enumeration Chapters

Model enumeration chapters ( icon) provide a set of dependent model elements for a model element, e.g. all attributes for a class. This sort of chapter can contain further standard chapters, extra structure chapters or references to building blocks.

A model element enumeration chapter consists of a heading which a model element heading is generated for each dependent model element and typically contains the name of this element. You can convert these model element headings into bullet point list entries upon documentation creation.

Model element enumeration chapters are shown in both the Documentation Structures column and in the middle area in the configuration editor.

Model Element Enumeration Chapters at the Top-Most Level

The following chapters can be found along with others at the top-most level of the model structure:

Recursive Elements: All model elements of this type selected, irrelevant of their position in the model structure.
Profiles: All profiles for the model. You can use this chapter for creating documentation for the model configuration.
System Models: All system models for this model. You can use this chapter as a starting point for creating a documentation structure which works independently from the current selection.
Namespace Tree: The hierarchy of the namespaces in this model. This is a starting node in a hierarchically-structured documentation of model contents
Hierarchy Tree: The hierarchy of the classifiers and packages in this model. This is a starting node in a hierarchically-structured documentation of model contents

Frequently Recurring Model Element Enumeration Chapters

The following model element enumeration chapters can be used on many different levels in the documentation structure:

Element: The model element itself.
Container: The model element's parent element.
Referencing Container: All model elements including a reference to this model element.
Model: The model which this element belongs to.
All Labels: All labels for this model element. The default label value is used if no value is set. Use the effective value subchapter to output the label's value.
All Labels Used: All labels of this model element which a value is set for. Labels with default values are suppressed. Use the effective value subchapter to output the label's value.
Set Labels*: All set label values of this model element. Label values with the default value are suppressed. Use the value subchapter to output the label value.
All Specifications: All specifications for this model element. The default text is output if no text is set. Use the effective value subchapter to output the specification's contents with resolved variables and formatting.
All Specifications Used: All specifications of this model element which a text is set for. Default texts are suppressed. Use the effective value subchapter to output the specification's contents with resolved variables and formatting.
Set Specifications*: All set specifications of this model element. Default texts are suppressed. Use the resolved value subchapter to output the specification's content with resolved variables or use value to output the contents with variables. Use the Formatted Value subchapter to output formatted text.
All Stereotype Properties: All stereotype properties for this model element. The default text is output if no value is set. Use the effective value subchapter to output the stereotype property's value.
All Stereotype Properties Used: All stereotype properties of this model element which a value is set for. Default texts are suppressed. Use the effective value subchapter to output the stereotype property's value.
Set Stereotype Properties*: All set stereotype property values of this model element. Stereotype property values with the default value are suppressed. Use the Value subchapter to output the value for the stereotype properties.
Client in Dependency: The outgoing dependency relationships.
Dependent Elements: The incoming dependency relationships.

* Only enumeration values are available when configuring the Details tool window (Details configuration) with this docu chapter.