7.5.2 Layout of a Parameter Form Help Section



When help is requested from a parameter form that is displayed by menu, the category and subjects searched by showtext are almost the same as those when form searches for help sections in a customized helpfile for a formfile.

Within a parameter form, menu calls showtext, when accessing the default param helpfile, with the categories and subjects in the order listed in Table 7-5. For each entry, the corresponding help text is displayed if the help section is found and the criterion for that help section are met. This sequence is interrupted if the operator types "q".

Table 7-5: Category and Subjects called with default helpfile

Category Subject Help Section Display

param add A parameter form can only be in add mode. The section hat matches this category is displayed from the default parameter form helpfile.

param data_type The default helpfile is searched for the help section regarding the data entry field's data type. This help section describes what type of information is valid in the current data entry field.

param The generic help section for parameter forms is displayed.

The default param helpfile distributed with C/Base has the following help sections:

1 param add

1 param

Within a parameter form, menu calls showtext, when accessing a customized helpfile, with the categories and subjects in the order listed in Table 7-6. For each entry, the corresponding help text is displayed if the help section is found and the criterion for that help section are met. This sequence is interrupted if the operator types "q".

Table 7-6: Category and Subjects called with customized helpfile

Category Subject

Help Section Display

paramname add Display the help section relative to the current mode of the parameter form. The section name consists of both the parameter form name and the word add. A parameter form can only be in add mode.

paramname field_name Since a parameter form is always in add mode, the cursor is positioned in one of the data entry fields. The parameter form's name and current field name are passed to showtext for a search in the helpfile for the corresponding help section.

paramname The help section for the current menu's parameter form name is displayed.

param The general help section for param is searched first in the customized helpfile. If not found, the corresponding help section in the default helpfile for parameter forms is displayed.