Enabling access to your custom help file

About this task

To make these instructions easier to follow, they assume that there is a fictional project called AutomobileProject that has a profile called Auto2009 with a New Term stereotype called Stereotype_Auto2009. These profile and stereotype names are for illustrative purposes only; they are not provided in the product.

Note: These instructions assume you have created your custom help file and your map file.

To enable access to your custom help file:

Procedure

  1. For the profile or its stereotype for the project on which you want to provide custom help, set the Model::Stereotype::CustomHelpURL and CustomHelpMapFile properties as follows:
    1. Open the Features window for the profile or its New Term stereotype. On the IBM® Rational® Rhapsody® browser, double‑click the profile name or stereotype name (for example, profile Auto2009 or stereotype Stereotype_Auto2009).
    2. On the Properties tab, select All from the View drop‑down arrow (the label changes to View All).
    3. Locate Model::Stereotype::CustomHelpMapFile. Type the path to your help map file.
      Note: You can specify an environment variable as part of the URL (for example, $DODAF_HLP_ROOT\dodaf_help.map).
    4. Locate Model::Stereotype::CustomHelpURL. Type the path to your help file. You can specify an environment variable as part of the URL (for example, $DODAF_HLP_ROOT\dodaf_help.htm).
    5. Click OK.
  2. Create an element using the New Term stereotype. Right‑click a package in your project and select Add New > Auto2009 > Stereotype_Auto2009. Notice that these choices are located at the bottom of the pop‑up menu.
  3. Double‑click the stereotype created in the previous step (for example, stereotype_auto2009_0) and press F1.

Feedback