Various chapter types can exist in a documentation structure.
Types of Chapters
Various chapter types can be used in a documentation structure.
-
Standard chapter
-
Information chapter (
icon) -
Model element enumeration chapter (
icon)
-
-
Extra structuring chapter (for extra headers and sorting settings)
-
Documentation building blocks (
icon) and references to documentation building blocks
It is also possible to show model element enumeration chapters' contents in table form.
Note
A short description about the chapter and the possible filters is shown on the first page of the properties dialog for the assigned chapters.
Information Chapters
Information chapters are documentation structure leaf nodes. They contain information about a model element, e.g. the person who last edited it. Such a chapter consists of a heading and contents; it is possible to suppress the heading if you so wish.
Information chapters are only shown in the list of assigned standard chapters in the middle section in the configuration editor. They are not shown in the list of documentation structures in the left-hand area so that things are easier to read.
There are some information chapters which have a special meaning:
-
Table of contents, index and table of figures
-
Verification chapter (
icon) -
Figures chapter
Model Element Enumeration Chapters
Model enumeration chapters 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.
Note
The basic recursive chapter evaluations make sure that information is not repeated, e.g. for activities accessed multiple times. Chapter evaluation recursion is canceled if an element in the evaluation path is already evaluated for precisely this chapter.
An element which is in multiple subpaths is only evaluated fully for the first time it occurs at the highest level. Only the header of the element chapter is shown for each evaluation at a lower level. All chapters contained are not evaluated.
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.
Extra Structure Chapters
Extra structuring chapters are a structuring elements which enable you to insert extra headers in the documentation and a sorting type for immediately subsequent standard chapters.
Documentation Building Blocks and References to Documentation Building Blocks
Documentation building blocks are used for reusing subtrees in a documentation structure. You can use references to insert them at suitable points in the documentation structure.
The references are shown in the left-hand and middle areas in the configuration editor. If you select a reference in the left-hand area, the building block is shown in the middle area.
If the documentation building block is selected in the left-hand area in the Documentation view, the respective reference is shown in the right-hand area.
Related Topics
This chapter contains the topics:
