The HDR macro generates the header of a help member. As shown in Figure 6, code the HDR macro so that it follows COPY CBDZHELP and precedes all RP and TXT macro calls in the help member.

The syntax of the HDR macro is as follows:

 [label]  HDR     NAME=name[,TITLE='xxxx']
                  [,WIDTH={53|60}]
                  [,DESC='xxxxxxx']
                  [,HIGHLI={YES|NO}]
                  [,RPDLM=xy]

label

Specifies the label name that the system generates in the first instruction of the macro expansion.

NAME

Specifies the help member's CSECT name. The name can be up to 7 alphanumeric characters long, but its first character must be alphabetic (A-Z).

TITLE

Specifies the title for the assembler listing. You must enclose the title in apostrophes.

WIDTH

Specifies help panel's width. Valid values are 53 and 60. The default value is 60. (To guard against problems in the header, do not use width values other than either 53 or 60.)

DESC

Specifies a 1 to 255-character description, such as a copyright statement, that is to appear in the help member. HCD does not display this description. You must enclose the description in apostrophes.

HIGHLI

Specifies whether the first text line is highlighted (displayed with a different color). The default is NO.

YES

Indicates that the first text line (help title) is highlighted.

NO

Indicates that the first text line is at the same brightness as all subsequent text lines.

RPDLM

Specifies the reference phrase delimiters (starting and ending indicators) for a reference phrase. A reference phrase is a word or phrase in the help text that has additional help information associated with it. The specification must consist of exactly two characters, not enclosed in apostrophes, and not separated by commas or blanks. The default is <>. Specify the RPDLM parameter if you do not want the default indicators.

• The first character indicates the start of a reference phrase.
• The second character indicates the end of the reference phrase.

Note:

These characters appear as blanks on the help panel. However, the reference phrase itself appears as an input area on the help panel, allowing the user to tab the cursor to it, then press ENTER to display the help information for that phrase.

Figure 6 shows an example HDR macro. For this HDR macro, its NAME parameter specifies “CBDED15” as the help member's CSECT name, its TITLE parameter specifies the title as “HCD help member CBDED15,”, its WIDTH parameter specifies the width as 53 characters, its DESC parameter specifies the description as “X.X.X COPYRIGHT INFO”, and its HIGHLI parameter specifies “YES” for highlighting the first line of text. (Because this HDR macro has no RPDLM parameter, the reference phrase delimiters default to <>.)