Editing Documentation Building Blocks

Modifying Element Headings

Placeholders in the Element Heading tab make up the heading for a model element.

You can change the header depending on the language you require in the Element Header (Localized) tab.

Modifying a Chapter's Properties

You can modify the following properties for chapters in the Properties tab:

• Chapter faded out: Hide the whole chapter
• Heading suppressed: Suppress the chapter's heading
• Number Format: Number formatting
• Page Break Before or After: Controls the page break before or after the chapter
• Local Sort Order: Local sort order (for model element enumeration chapters only)
• Reverse Local Sort Order: Reverses the local sort order of model element enumeration chapters
• Filter *: Filter for model element enumeration chapters
• Paragraph Justification: Alignment only for information chapters
• Element Heading: Shows the structure of the heading for each element of this structure point
• Suppress Element Heading: If this option is activated, the heading of the structure point does not appear in the documentation and is displayed in square brackets in the structure tree
• Element Number Format: The element header numbering format determines whether and how this structure point (including the subtree below it) should be numbered
• Page Break Before or After Element Heading: Controls the page break before or after the structure point
• keep if empty: If this option is activated, the chapter is included even if it is empty

Assigning Paragraph Formats

You can explicitly assign paragraph format templates for documentation in MS Word format in the Features tab.

• Paragraph Format: To force a specific paragraph format for the header of this chapter, specify a Word paragraph format template for the header of the model element enumeration chapter. The format template must be defined in the template file.

• Paragraph Format for Content: Enter a Word paragraph format template. The format template must be defined in the template file.

  The paragraph format template is used for the enumerated elements of model element enumeration chapters and for the content (output text) of information chapters.

  It is a good idea to assign non-numbered paragraph format templates that are not used in the table of contents.

The content of an information chapter is normally found under the respective chapter heading. However, you can split the header and content that are on the same line using a tab by entering the Unformatted/Inline paragraph format. You can display information using tabs by defining a suitable paragraph format.

Modifying a Graphic's Graphical Properties

You can change the color labels used for a printout in the Graphical Properties tab for a figure chapter.