Using the Dynamic Help

Dynamic Help (or context-sensitive help) is available on many elements in the IDE.

Display the help window in the IDE and view Dynamic Help.

  1. From the main menu, choose Help>Dynamic Help or press the F1 key.
  2. A Dynamic Help window appears in the IDE:
    IDE Help window

    If your cursor was on a keyword in an editor when you pressed F1, context-sensitive help for that keyword will be displayed.

    If not, the Help window will appear as it does in the previous screen capture; you can then locate the items you want using the following options at the top of the window:

    • Contents — displays a clickable table of contents of the entire documentation set.

    • Search — displays a search field in which you can enter any topic and search for it in the documentation.

    • Related Topics — if a topic is selected in the Help window, clicking this button will display a list of other topics that are related to it.

    • Bookmarks — allows you to navigate to bookmarks you have previously created.

    • Index — displays a clickable index for the entire documentation set.

  3. When the Help window is open, click on any keyword (highlighted in blue) in a model file that is open in the editor to display help for it. In the following example, the user has clicked the range keyword in the model file. By clicking range in the Help panel, the documentation for the range keyword will be displayed.
    Help for keyword in model file

To see Help on popup windows:

  • Click on the Help icon Help icon. A Dynamic Help window will appear next to the popup window with Help for that window.

    Note:

    In the IDE, not all windows that display a Help icon Help icon will display Help contents.

To see Help on the Settings editor:

  • When editing a settings (.ops) file, click on the Tooltip icon Tooltip icon on Settings editor. A tooltip will appear for that line item:

    Tooltip Help displayed on the Settings editor