Overview of the Information Chapter

Information Chapters

Information chapters ( icon) are leaf nodes in the documentation structure. 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)
• Figure chapter (image)

Frequently Recurring Information Chapters

• Created By, Date Created, Last Modified By, Date Modified: Information relating to the creator and last modifier and the corresponding dates.

• History: information summarizing who created and last modified the model and the corresponding dates.

• Name of the Model: The name of the model which contains the model element. This is not the Innovator model directly in the repository.

• Name of the Namespace: The name of the predecessor in the model hierarchy.

• Namespace: The path of the model element's predecessor in the model hierarchy, starting with the repository name. '::' is used as a separator.

• Qualified Name: The path of the model element in the model hierarchy, starting with the repository name. '::' is used as a separator. This is the namespace extended with the name of the model element.

• URI: URI of the model element. This chapter enables jump targets to be integrated into the documentation.

• UUID: The model element's unique identification.

• Label Information, Stereotype Property Information: All label values or stereotype property values of this model element in the form Name: Value. If no value is set, the default value is used.

• Stereotype Property Value: The value of the stereotype property as specified by the Filter Pattern property of this chapter. If no value is set, the default value is used.

• Resolved Specification: The value of the specification as specified by the Filter Pattern property of this chapter. If no value is set, the default value is used.

• Label Value: The value of the label specified by the Filter Pattern property. If no value is set, the default value is used.

• Verification: Verification messages relating to this model element. The verification routine to be called needs to be shown in the documentation chapter's Verification property.

• Icon: The stereotype icon for the model element.

• Image: The graphic for a diagram.

Chapters at the Top-Most Level

There are various chapters at the top-most level of the documentation structure which are of particular significance. These chapters can only be created once and cannot be moved into building blocks or extra structure chapters.

• Table of Contents: Chapter showing the documentation content. It needs to be at the very start or very end of the documentation.

• Index: Chapter showing the documentation index.

• Table of figures: List of figures in the document.

• Table of tables: List of tables in the documentation.