Adding Images in the Documentation

You can add images to the documentation.

Supported image formats are .png, .jpg, .jpeg, .bmp, .tif, .tiff, and .rgb.

Images are handled as external resources. For more about external resource handling, see Managing External Resources.

Note: The commands Update, Apply, and Export are not available for pictures.

This task shows you how to:

Before you begin: You must be editing the documentation layer of a model, either the Information section or the Revisions section. This task is part of editing those sections, see Edit the Information Section or the Revisions Section Using the Text Editor.

Use an Image Available as a Resource

You can use an image already available as a resource.

  1. In the Documentation Editor, from the toolbar, click Insert Image .
    The Select Resource dialog box appears.
  2. In the Select Resource dialog box, do the following:
    1. Browse the tree and select the image to be added to the diagram.
      The path to the selected image appears in the lower part of the dialog box.
    2. Click OK.
    The selected image is added in the documentation.

Use an Image Not Yet Available as a Resource

You can use an image not yet available as a resource. By doing that, you also import it as a resource.

  1. In the Documentation Editor, from the toolbar, click Insert Image .
    The Select Resource dialog box appears.
  2. In the Select Resource dialog box, do the following:
    1. Browse the tree and select the folder where the image should be imported as a resource.

      The default folder is the library of the activated class.

      Tip: You can add a new folder in the browsed location by clicking Add Folder.

      The path to the selected folder appears in the lower part of the dialog box.
    2. Click Import Resources and browse for the image.
      An Import Resources dialog box appears.
    3. Select the image you want to import and click Open to validate your selection.
      • The image appears as a resource in the tree in the dialog box.
      • The path to the resource appears in the lower part of the dialog box.
    4. Click OK.
    • The selected image is added in the diagram.
    • The image file is imported as an external resource.