Using Additional Features › Perform Administrative Functions › Update a Content-Sensitive Help Entry › Write Content-Sensitive Help Text

Write Content-Sensitive Help Text

Before you begin writing Help, you need to understand the following features of the Help processor:

• An :H1 tag is added automatically to the selected member of hilevel.UTRHELP. This tag has an associated ID= attribute. The ID= attribute contains the Help topic member and the name of the content. You must not change this ID= attribute or CA Mainframe Application Tuner will not be able to locate the Help text.
• A :p. tag is added automatically to the line after the :H1 tag. This tag acts as a separator between the header and the Help text.

Type your Help text below the :p. tag. See the table in Edit Help Text for information about using markup tags to format your text.

CA Mainframe Application Tuner automatically adds one space between each continuous word or character string, regardless of the actual number of spaces or line breaks. If you need to display text exactly as typed, use the example tag, :xmp.

When you are finished writing the Help for the topic, press End to return to the Content-sensitive Help panel.

Command ===>                                                     Scroll ===>
****** ***************************** Top of Data *******************
=NOTE= **********************************************************
=NOTE= * Please do not change the :H1 tag line. It is required
=NOTE= * for proper help processing.
=NOTE= **********************************************************
000001 :H1 id=ABCDE.ABCDE
000002 :p.

''''''
''''''

The tags that are available for writing content-sensitive Help are described next.

:H1

creates a heading and is followed by an ID= attribute, which is automatically filled in with the same value that is specified in the Topic field of the Content-sensitive Help panel

Do not change this value. CA Mainframe Application Tuner relies on this value to find the correct Help text.

This value is followed by a period, followed by the title that is to appear in the Help panel. The value that you specify in the Content field of the Content-sensitive Help panel is used automatically as the title. To change the title, overtype this value.

:p.

Creates a blank line between paragraphs.

:dl.

Creates a definition list and must also be used with the :dt. (topic) and :dd. (description) tags and followed with the :edl. (end definition list) ta.

:ul.

Creates a bulleted list and must also be used with :li. (list item) tags and must be followed by the :eul. (end unordered list) tag.

:hp1.

Highlights text following the tag and must be followed with the :ehp1. tag after the text that you want highlighted.

:xmp.

Creates text that shows an example and must be followed by the :exmp. tag following the example text.

Text displays exactly as typed, including spaces.

:note.

Creates a note and must be followed by the :enote. tag.

:suggest.

Creates a suggestion and the text within is highlighted in yellow.

The suggestion text must be followed by the :esuggest. tag.

:hottip.

Creates a tip where the tip heading is highlighted in yellow, the text is highlighted in white and must be followed with a :ehottip. tag.

:warning.

Creates a warning where the text is highlighted in red and the warning text must be followed by the :ewarning. Tag.