Creating your custom help file

Your custom help file must be in HTML format. (Example help file name: myhelp.htm.)

About this task

If you plan to share the custom help file with team members, place it in a shared location on a network. You identify this file and its location in the Model::Stereotype::CustomHelpURL property.

The map file for your custom help file must contain one or more IBM® Rational® Rhapsody® resource IDs for which the custom help is provided. A resource ID corresponds to a particular GUID element in the product. For example, for the Attributes tab, the resource ID is 161328.

To find a resource ID:

Procedure

  1. Add the following line to the [General] section of the rhapsody.ini file and save your changes:

    ShowActiveWindowHelpID=TRUE


    This means that now when you press F1 to open the Rational Rhapsody help file, a window with a resource ID displays, as shown in the next step.
  2. Press F1 for a GUID element that you plan to associate with a New Term stereotype (for example, if your New Term stereotype is applicable to a class, the Attributes tab of the Features window).
  3. Add the resource ID number to your help map file. Each number must be on its own line. The following figure shows the contents of a map file called myhelp.map. (Another example of a help map file name: myhelp.txt.)
    Note: For testing purposes, include the resource IDs shown in the following figure in your map file. You can delete these IDs later.
    Map file listing resource ID numbers
    Note: You might find it useful to add the name of the element next to the resource ID number (for example, 161328 Attributes tab).
  4. If you plan to share the custom help file with team members, place the help map file in a shared location on a network. You identify this file and its location in the Model::Stereotype::CustomHelpMapFile property.
    Note: When your map file is complete, to ensure that help topics appear instead of resource ID numbers when you press F1, you can comment out the ShowActiveWindowHelpID=TRUE line in the rhapsody.ini file (for example, insert a semicolon or pound sign in front of the line) or you can delete the line.

Feedback