Previous Topic: Write Content-Sensitive Help Text

Next Topic: Display Environmental Information

Content-Sensitive Help Example

The following panel shows the Content Help Addition panel for an example topic.

.--------------------------------------------------------. | CA MAT ------- Content Help Addition --------------- | | COMMAND ===> | | | | Content ===> EXAMPLE | | Content Type ===> CSECT | | Help Member ===> SAMPLE | | Help Topic ===> SAMPLE | | Info Level ===> 3 (1, 2, or 3) | | | | Edit after Add ===> YES (Yes or No) | | | | Press ENTER to add; press PF3 or enter | | CANCEL to exit without adding. | '--------------------------------------------------------'

The following example shows an example of how you can use the tags described in the table in Edit Help Text to create your own Help text.

:H1 id=SAMPLE.EXAMPLE :p. Here is an example of how you use the tags to write help text. We'll start with a definition list: :p. :dl. :dt.Term1 :dd.Explanation1 :dt.Term2 :dd.Explanation2 :edl. :p. Next we'll create a bulleted list: :ul. :li.Item1 :li.Item2 :eul. :p. :xmp. This is an example. It appears e x actly as typed. :exmp. :p. :note. Here is an example of a note. The word :hp1.note:ehp1. Is highlighted. :enote. :p. :suggest. This is a suggestion. It is displayed in yellow. :esuggest. :p. :hottip. This is a tip. It includes useful information. :ehottip. :p. :warning. This is a warning. It is displayed in red. :ewarning.

The following panel shows the Help text as it displays on the screen.

CA MAT EXAMPLE HELP Command ===> Scroll ===> PAGE ------------------------------------------------- Here is an example of how you use the tags to write help text. We'll start with a definition list: Term1 Explanation1 Term2 Explanation2 Next we'll create a bulleted list: o Item1 o Item2 This is an example. It appears e x actly as type Note: Here is an example of a note. The word note is highlighted. Suggestion: This is a suggestion. It is displayed in yellow. CA MAT TIP: This is a tip. It includes useful information. WARNING: This is a warning. It is displayed in red.

The following panel shows the example listed on the Content-sensitive Help panel.

CA MAT ----------------- Content-sensitive Help ---------- ROW 1 to 11 of 245 COMMAND ===> SCROLL ===> CSR Primary commands: ADD Line commands: CE - Copy entry DE - Delete entry UE - Update entry BT - Browse help text ET - Edit help text LC Field Specific Contents Type Help Help I S LAST Member Topic L L USER ________________________________ ________ ________ ________ _ _ ________ >------------------------------------------------------------------------------ __ .OTHERWT CSECT TUCCSALL OTHER 3 D TUNUSER __ .PAGEWT CSECT TUCCSALL PAGEWT 3 D TUNUSER __ .SWAPWT CSECT TUCCSALL SWAPWT 3 D TUNUSER __ .USER CSECT TUCCSALL USER 3 D TUNUSER __ EXAMPLE CSECT SAMPLE SAMPLE 3 U TUNUSER __ IGG019AF CSECT TUCCSIGG IGG019AF 3 D TUNUSER __ IGG019AQ CSECT TUCCSIGG IGG019AQ 3 D TUNUSER __ IGG019AR CSECT TUCCSIGG IGG019AR 3 D TUNUSER __ IGG019BQ CSECT TUCCSIGG IGG019BQ 3 D TUNUSER __ IGZCIN1 CSECT TUCCSIGZ IGZCIN1 3 D TUNUSER __ IGZCLDL CSECT TUCCSIGZ IGZCLDL 3 D TUNUSER