HP 3000 Manuals

Setting, Changing, and Using Help Attributes [ HP RPG/XL Utilities-Part 3 SIGEDITOR ] MPE/iX 5.0 Documentation


HP RPG/XL Utilities-Part 3 SIGEDITOR

Setting, Changing, and Using Help Attributes 

Each help area has a set of attributes associated with it.  These are:

 *  The name of the help form to be displayed.

 *  The row and column numbers of the help area's corners.

 *  Information that tells RSI how to handle the help area at runtime.

You set help area attributes during the help area creation process.  The
help area attribute specification screen is illustrated in figure 3-2.
__________________________________________________________________________________
|                                                                                |
|             RPG Screen Interface - Help Area Attribute Specification           |
|          Form File:  RSID002F                                  Form:  FORM     |
|                                                                                |
|     ---------------------------------------------------------------------------|
|                                                                                |
|          Help Form Name:                                                       |
|                                                                                |
|          Upper Left Row:                           Upper Left Column:          |
|                                                                                |
|          Lower Right Row:                          Lower Right Column:         |
|                                                                                |
|                        Suppress Selection Indicator:                           |
|                                                                                |
|                             Boundary Indicator:                                |
|                                                                                |
|     ---------------------------------------------------------------------------|
|                                                                                |
|                                                                    ABANDON     |
|                                                                                |
__________________________________________________________________________________

          Figure 3-2.  Help Area Attribute Specification Screen 

You can change the attributes using the change attribute operation.  The
help area list specification screen used in the change attribute
operation is illustrated in figure 3-3.
______________________________________________________________________________________
|                                                                                    |
|        RPG Screen Interface - Help Area List Specification                         |
|     Form File:  RSID002F                                  Form:  FORM              |
|                                                                                    |
|     ---------------------------------------------------------------------------    |
|                                                                                    |
|                            Upr Left    Lower Rt    Indicators                      |
|          ID      Form      Row  Col    Row  Col    SS  BI                          |
|                                                                                    |
|          10    NAMADD10      4   17      9   64        N                           |
|          20     ZIPCOD10     10   17      11   37           N                      |
|          30    PHONUM10     10   40     11   63        N                           |
|                                                                                    |
|                                                                                    |
|                                                                                    |
|                                                                                    |
|     ---------------------------------------------------------------------------    |
|                                                                                    |
|                List Entry ID:   20     New List Entry ID:                          |
|                                                                                    |
|      CHANGE    DELETE     CHANGE  SHOW ALL    SCROLL     SCROLL   ABANDON      HELP|
|      ATTRIB     AREA        ID     AREAS      FORWARD     BACK    ALL CHGS     MENU|
|                                                                                    |
______________________________________________________________________________________

          Figure 3-3.  Help Area List Specification Screen 

The following sections explain each help area attribute in detail.

List Entry ID 

The list entry ID is a number that identifies a specific help area during
the help area update/delete process.  The numbers are regenerated each
time help area update/delete is initiated.

Help Form Name 

The help form name is the name of the first appplication form containing
help text to be displayed when this help area is selected.  The help form
name must be eight characters long, begin with an alpha character, and
end with two digits from 00 to 99.

Help Form Families 

Help forms can be grouped into "families." A family of help forms share
the same first six characters of their names, but the last two numeric
characters vary (for example, HELPFM01, HELPFM02, HELPFM03, etc.).  Help
form families are used during roll key processing, which is described
later in this chapter.

Upper Row 

This is the upper row of the help area border.

The upper row cannot be less than the start line of the application form.
It must be in the range of 01 to 24.  The only exception is in the case
of the "NULL HELP AREA" (see roll key processing).  When a "NULL HELP
AREA" is created all row and column attributes must be zero (0).

Left Column 

This is the left column of the help area border.

The left column must be in the range of 01 to 80, except in the case of a
"NULL HELP AREA" when it must be zero (0).


NOTE Where the upper row number and the left column number meet is where the upper left corner of the help area is defined.
Lower Row This is the lower row of the help area border. The lower row must be in the range of 01 to 24, except in the case of a NULL HELP AREA when it must be zero (0). The lower right row number cannot be less than the upper left row number. Right Column This is the right column in the help area border. The number of the right column must be in the range from 01 to 80, except in the case of a null help area when the boundary must be zero (0). The lower right column number cannot be less than the upper left column number.
NOTE Where the lower row number and the right column number meet is where the lower right corner of the help area border is defined.
Suppress Selection Indicator The suppress selection indicator hides help areas at runtime. It must be blank or in the range 01 to 99. The default is blank. When an application form that contains help areas is displayed, only the help area definitions in which the suppress selection indicator is blank or set off (in the RPG program) are added to the global help area list. Additionally, help areas in the global help area list are deleted from the list if the suppress selection indicator is set on when a new application form is displayed. See "Runtime Global Help Area List Management" for more discussion of the global help area list. Boundary Indicator The boundary indicator creates borders in the help area list, in addition to the first and last entries. These boundaries are used in roll key processing, which is described below. Using one or more boundary indicators divides the help area list into several smaller sublists. The boundary indicator is "Y" (yes is always a border), "N" (no is never a border), or is in the range of 01 to 99 (a boundary when the indicator is on in the RPG program). The default is "N."


MPE/iX 5.0 Documentation