You can create an extra structure chapter above one or more documentation chapters.
Prerequisites
At least one chapter needs to be selected within a documentation structure. If you select more than one chapter, they all need to be directly below the same chapter.
Context
The documentation structure is extended with an extra heading and/or given a sorting type for subsequent standard chapters.
Sorting occurs alphabetically according to displayed name or heading, label or stereotype property; sorting can also occur numerically for labels and stereotype properties. The evaluated label or stereotype property must be set using an appropriate filter entry. You can also reverse the sorting type.
Sorting always only affects the next level directly. This level cannot already be a model element enumeration chapter or already be sorted in another structure chapter.
It is also possible to sort according to columns in tables. Sorting occurs according to the first column with a set sorting type. The table's enumeration column cannot be sorted in this case.
Tip
As an example for the purpose of sorting options, the dependent elements should be documented starting from a class. These are incoming relationships for classes and the respective owners for relationships.
The header for both standard chapters and relationships are not shown. Sorting is not possible for the aforementioned chapters.
If a structure chapter is above the incoming relationships, then you can sort the owners of the relationships.
How to proceed
-
Select the chapter you want to create an additional structuring chapter for in the Documentation Structures view in the configuration editor.
-
Select Edit>Structure>Insert Level.
The additional structure chapter is inserted in the documentation structure. The selected chapters become subchapters in this chapter.
-
To set the properties of the extra structure chapters, select Edit>Properties.
The dialog of the same name appears.
-
To name a header, enter a header in the Name input field in the Localized Name tab in the language you require.
The document level provides the additional header.
-
To set sorting for immediately subsequent standard chapters, select the sorting type in the Properties tab.
The documentation structure is given a sorting type for immediately subsequent standard chapters (without their own sorting).
-
Confirm your changes with Apply.
The properties are modified according to the changes you made.
