Reference phrases

The RP (reference phrase) tag allows you to highlight words or phrases on panels to indicate that additional help information is available. When a help panel with reference phrases is displayed, the cursor is positioned in the first reference phrase. When an application panel containing reference phrases is displayed, the cursor is positioned to the first reference phrase or panel input field, unless the cursor setting has been specified by the application. The reference phrase is an input-capable field so that the user can tab to successive reference phrases on the panel. The reference phrase text is refreshed whenever the panel is displayed.

When the user places the cursor on a reference phrase and requests help, the reference phrase panel or message is displayed. Reference phrase help panels themselves can also contain reference phrases. When a user cancels a reference phrase help, the panel from which the user requested the reference phrase help is displayed again. All other help facilities, such as KEYSHELP and EXHELP, are available from a reference phrase help panel.

The RP tag requires a matching end tag to indicate the end of the reference phrase text.

This markup example shows the use of the RP tag.

<!DOCTYPE DM SYSTEM>

<HELP NAME=frenchl depth=12>Help for Masters Degree in French Literature
<area>
<info>
<p>
The Masters in French Literature (MFL) Program is also available
to students interested in
<rp help=liteve>evening studies.</rp>
<p>
Please consult your program advisers for details before registering for
a class.
</info>
</area>
</help>

<help name=liteve depth=13>Help for Evening Studies
<area>
<info>
<p>
Evening Studies offered by the French Literature
graduate program are available to students
interested in part-time and full-time studies.
All core courses and many electives are offered
in the evening on a rotating basis.  Please
consult your program advisers for details before
registering for a class.
</info>
</area>
</help>

Here is the formatted result:

Figure 1. Reference phrase example

   Help for Masters Degree in French Literature

 The Masters in French Literature (MFL) Program
 is also available to students interested in
 evening studies.

 Please consult your program advisers for details
 before registering for a class.

  F1=Help         F3=Exit         F5=Exhelp
  F6=Keyshelp     F7=PrvTopic     F8=NxtTopic
 F10=PrvPage     F11=NxtPage     F12=Cancel

Accordingly, when the user selects the reference phrase evening studies, the help panel specified by the HELP attribute (help=liteve) is displayed.

Figure 2. Reference phrase example of help attribute

             Help for Evening Studies

 Evening Studies offered by the French Literature
 graduate program are available to students
 interested in part-time and full-time studies.
 All core courses and many electives are offered
 in the evening on a rotating basis.  Please
 consult your program advisers for details before
 registering for a class.

  F1=Help         F3=Exit         F5=Exhelp
  F6=Keyshelp     F7=PrvTopic     F8=NxtTopic
 F10=PrvPage     F11=NxtPage     F12=Cancel

The help-panel-name attribute specifies the name of the help panel to be displayed if the reference phrase is selected.