Creating hyperlinks

IBM® Rational® Rhapsody® supports both internal hyperlinks, which point to Rational Rhapsody model elements, and external hyperlinks, which point to a URL or file.

About this task

In addition, you can:

You can create hyperlinks inside the description of an element, or with the Rational Rhapsody browser.

A typical use for the Description tab of the Features window is to enter a description for whatever Rational Rhapsody element you currently have open. For example, if you have the Features window open for a class, you can enter a detailed description for the class on the Description tab. You can do the same on the Description tab for an attribute, an event, a package, and so on.

Note: Hyperlinks created in the Description are not model elements and can not be viewed in the browser nor accessed by the API.

Procedure

To create hyperlinks inside the description of an element:

  1. Open the Features window for the element.
  2. On the Description tab, right-click in the open field and select Hyperlink.
    Note: If you want to replace pre‑existing text with a hyperlink, select the text before right-clicking.
  3. On the Hyperlink window, specify the hyperlink text and target.
    • The Text to display group specifies the text for the hyperlink. The possible values are as follows:
      • Free text displays the specified text as the hyperlink text.
      • Target name displays the full path of the target as the hyperlink text.
      • Target label displays the label of the target as the hyperlink text. This option is available only for internal hyperlinks that have labels.
      • Tag value displays the value for the tag. This value is available only when you select a tag as the hyperlink target. For an example that uses this field, see Using tag values in hyperlinks.
    • The Link target group specifies the target file, web page, or model element. You can specify the target by typing the target in the text field, using the list to select the model element in the model, or clicking the Ellipses button Ellipsis button to open a new window so you can navigate to the target file.
      Note: You can include a relative path in the hyperlink target. If you use a relative path, the base directory is the one where the
      <Project name>.rpy file is located.
  4. Click OK.
    The hyperlink is displayed on the Description tab as blue, underlined text. This type of hyperlink is not displayed in the browser.

Feedback