1.7.6 Display User Defined HELP Text

If the HELP key or the HELP function key is pressed at any time while executing a user written LANSA process or function and the screen cursor is NOT on the same line as a message then user written HELP text associated with the process, function, or fields used by the function can be reviewed.

If the user is a LANSA developer, then both user written technical and user HELP text will be displayed. Otherwise, only user written user HELP text will be displayed.

Exactly what level of HELP text is displayed depends upon what the user was doing, and where the screen cursor was, when the HELP key was pressed. For instance:

• If the process main menu was on the screen then the HELP text associated with the process will be displayed initially.

• If a function screen format (resulting from an RDML DISPLAY or REQUEST command) was on the screen and the cursor was within the boundaries of a field on the screen, then the HELP text associated with the field will be displayed initially. The phrase "within the boundaries" means within the field itself or anywhere on its associated label, description or column headings.

• If a function screen format was on the screen and the cursor was not within the boundaries of a field, then the HELP text associated with the function will be displayed initially.

To illustrate this point, the following screen format shows what the screen would look like after the user has pressed the HELP function key while displaying a process main menu called CUSTOMERS.

CUSTOMERS                   Work with Customers                                                                                               Enter number of function required or place cursor on same line                                                                                _  1. Input new customer details                                          2. Review or change existing customer details                          3. Review customer credit ratings                                      4. Purge old customer details                                                                                                               ....................................................................  :CUSTOMERS                   Work with Customers                    :  :                                                                   :  : This is the customer control system's main menu. By working from  :  : this menu you can perform just about any action you wish on any   :  : customer that is recorded in the system.                          :  :                                                                   :  : The sort of things that you can do include .....                  :  :                                                                   :  :  - Enter details of a new customer into the system                :  :  - Review or change just about any detail of an existing customer :  :  - Review or change the credit rating of a customer               :  :  - Purge customers who have not ordered any stock within the      :  :                                                                   :  :                                                                   :  :F2=Ex HELP  F3=Exit  F12=Cancel  F11=Index  F14=Messages           :  :...................................................................:

Note: The user defined process level HELP text overlays the lower portion of the process menu in a "window". The advantage of the window over a full screen presentation is that it visually reminds the user what he/she was doing when the HELP function key was used.

While the HELP text window is on display you can only work with the facilities available within in it, these include:

• Invoke the extended HELP facility. Use the function keyed identified as "Ex HELP". Normally this function key is only available when reviewing the HELP text associated with a field. If used, the HELP text associated with the current process or function will be displayed.

• Exit from the HELP facility and return to what was being done when the HELP key was first used. To do this use the function key identified as "Exit".

• Cancel what is being done at the moment and return to what was being done previously. To do this use the function key identified as "Cancel".

• Cause the current process's HELP Index to be displayed. To do this use the function key identified as "Index".

If the "Contents" function key was used on this display, a new window would overlay the lower portion of the screen.

CUSTOMERS                   Work with Customers                                                                                             Enter number of function required or place cursor on same line                                                                              _  1. Input new customer details                                         2. Review or change existing customer details                         3. Review customer credit ratings                                     4. Purge old customer details                                                                                                             ..................................................................   :HELP_TABLE                   Table of Contents                    :  :Enter number of desired topic or put cursor on same line and press:  :enter.                                                            :  : __ 1. Process - Work with Customers                              :  :    2. Function - Input new customer details                      :  :    3. Function - Review or change existing customer details      :  :    4. Function - Review customer credit ratings                  :  :    5. Function - Purge old customer details                      :  :    6. Field - Customer number                                    :  :    7. Field - Customer full name                                 :  :    8. Field - Customer search name                               :  :                                                                  :  :                                                                  :  : F2=Ex HELP  F3=Exit  F12=Cancel  F11=Index  F14=Messages         :  :..................................................................

Working from this table of contents, you may elect to:

• Review the HELP text associated with the current process.

• Review the HELP text associated with any of the functions defined within the current process.

• Review the HELP text associated with any field used by the function if a function was in use when the HELP function key was used.