Creating, Searching and Replacing Specification Texts

Specification texts describe a certain aspect of a model element in the respective text definition (specification text).

Essential Specification Text Properties

A specification text describes certain aspects of a model element. The configured text definitions control which these will be respectively. Text definitions can be configured as components of the documentation.

  • Specification texts are possible for all model elements

  • Specifications belong directly to the model element

  • Specifications for other elements are shown as read-only specifications for certain elements, e.g. the specification for the called process for a call activity.

    When in the active tab of a write-protected text, you can use the Open Specification context menu command or Start>Open>Specification (F3) to open the specification text of the linked element to edit it

  • Specification texts are read-only or opened for editing, depending on the Open Documents Read-Only option

  • Text definitions can be configured per stereotype, e.g.

    • Description
    • Open issues
    • Special text definitions for certain Innovator functions
  • Requirements have the Requirements Text text definition

  • You can also display images in file attachments directly as an image instead of as a hyperlink with the Text>Hyperlink>Toggle Display command. You can change the size of the image using the Modify Image context menu command in a dialog. Images are directly outputted in the specification text when printed and upon documentation generation.

  • Configured text definitions always exist and cannot be deleted for individual model elements. They can only be empty.

  • You can search for text and replace it in specification texts

Formatted and Unformatted Specification Texts

  • You can configure text definitions as formatted using the Is Formatted Text property. You can configure a font format combination as a specification; you can set a lock in the configuration for changing the font type and size.

  • Formatted specification texts can have individual formatting for Font and Paragraph; text that can be modified can also be reset to the default font; tables from Word, for example, can also be inserted in formatted texts

  • Formatted specification texts can contain links:

    • Hyperlinks to model elements

      • You create hyperlinks to model elements simply by using drag-and-drop or via the clipboard

      • Internal model hyperlinks to elements are automatically displayed in green; external model hyperlinks are displayed in blue, as is usual

      • Hyperlinks to model elements that have since been deleted are displayed with a strikethrough

    • Hyperlinks to external targets

      • You can create hyperlinks to external targets (e.g. internet or e-mail address) on the selected text; use the mailto protocol for e-mail addresses so that the e-mail client can be opened using the address entered.

  • Unformatted specification texts can be configured in three display forms:

    • Document area (specification editor)
    • Properties area (Properties tool window)
    • Hidden (e.g. for generated texts)

Note

To make documentation more uniform, you can deactivate the Font changeable check box in the configuration of a text definition that can be formatted to prevent the font family and size from being changed by an editor. You can always use other formatting, e.g. font style and color for formatted texts.