The HELPDEF tag defines default values
for help panels.
Syntax
>>-<HELPDEF--ID=helpdef-id--+----------------------------+------>
'-HELP=-+-hhelp-panel-name-+-'
'-%varname---------'
>--+----------------+--+----------------+--+---------+---------->
'-WIDTH=-+-n---+-' '-DEPTH=-+-n---+-' '-CCSID=n-'
'-FIT-' '-FIT-'
>--+-------------------------------------------+---------------->
'-KEYLIST=key-list-name-| KEYLIST options |-'
>--+-----------+--+-----------------------+--------------------->
'-EXPAND=xy-' '-WINTITLE=window-title-'
>--+----------------------------+--+---------------------+------>
'-APPTITLE=application-title-' | .-NO--. |
'-MERGESAREA=-+-YES-+-'
>--+--------------------------+--+-----------------------+------>
'-IMAPNAME=-+-image-name-+-' '-IMAPROW=-+-n--------+-'
'-%varname---' '-%varname-'
>--+-----------------------+-->--+------------+----------------><
'-IMAPCOL=-+-n--------+-' '-</HELPDEF>-'
'-%varname-'
KEYLIST options
|--+-----------------------+--+-----------------------+---------|
| .-PRIVATE-. | '-APPLID=application-id-'
'-KEYLTYPE=-+-SHARED--+-'
Parameters
- ID=helpdef-id
- This
is the ID of the help panel default definition. The ID is used as
the identifier of this set of default definitions on the HELP tag.
The helpdef-id must follow the standard naming convention
described in Rules for variable names.
- HELP=hhelp-panel-name | %varname
- This
attribute specifies the default name of a defined help for help panel.
It identifies the help text that is associated with help processing.
The hhelp-panel-name must follow the standard naming convention
described in Rules for variable names.
- WIDTH=n | FIT
- This
attribute specifies a default width value for a help panel that refers
to this help default.
- DEPTH=n | FIT
- This
attribute specifies a default depth value for a help panel that refers
to this help default.
- CCSID=n
- CCSID
specifies the coded-character-set identifier as defined by the Character Data Representation Architecture. CCSID
should be entered as a five-position numeric value. For more information
on using the CCSID attribute, refer to the z/OS ISPF Dialog Developer's Guide and Reference.
- KEYLIST=key-list-name
- This
attribute specifies the name of the key mapping list associated with
the help panel. If you do not specify a key-list-name in
a HELP definition, the ISPF-provided key list (ISPHELP) is used. For
information about defining key mapping list, see KEYL (Key List). For information on the ISPF-provided
key list, refer to the z/OS ISPF User's Guide Vol I.
- KEYLTYPE=PRIVATE |
SHARED
- This
attribute is used to add the SHARED keyword to the KEYLIST parameter
of the )PANEL statement. For information about the )PANEL statement,
refer to the z/OS ISPF Dialog Developer's Guide and Reference.
- APPLID=application-id
- This
attribute is used to add the application ID to the )PANEL statement.
The application-id overrides the KEYLAPPL invocation option
value.
- EXPAND=xy
- This
attribute adds the EXPAND(xy) attribute to the )BODY section of the
panel. If only one character is provided, the second character is
set to the same value. If the EXPAND attribute is present with no
value specified, the conversion utility uses a character from the
range of low-order hex values available for panel attributes. This
removes an available character from possible use as a panel attribute
and may cause panel formatting errors.
- WINTITLE=window-title
- This
attribute is used to add a title on the pop-up window border. The
attribute value is placed in the ISPF ZWINTTL variable. The maximum
length of the window-title is the panel width minus 1.
- APPTITLE=application-title
- This
attribute is used to add a title on the GUI window border. The attribute
value is placed in the ISPF ZAPPTTL variable. The maximum length of
the application-title text is the panel width minus 1.
- MERGESAREA= NO |
YES
- This
attribute controls an additional formatting step for panels with a
single scrollable area. If the entire contents of the scrollable
area fit within a standard 24-line panel (allowing 4 lines for the
function keys display), the scrollable area content is moved into
the panel body.
- IMAPNAME=image-name | %varname
- This
attribute specifies the name of an image to be placed on the panel
when it is displayed in GUI mode. The image-name is
not used when the panel is displayed in host mode.
The image-name must
follow the standard naming convention described in Rules for variable names.
- IMAPROW=n | %varname
- This
attribute specifies the row number for positioning the image. Image
position uses an origin based on 0. Therefore, the minimum row value
is 0 and the maximum is 59. (The actual maximum depends on the value
set for the DEPTH attribute.) If a variable name is used, the application
must set the variable to a valid value before the panel is displayed.
The value specified should be within the actual panel depth for the
image to be visible when the panel is displayed.
- IMAPCOL=n | %varname
- This
attribute specifies the column number for positioning the image. Image
position uses an origin based on 0. Therefore, the minimum column
value is 0 and the maximum is 155. (The actual maximum depends on
the value set for the WIDTH attribute.) If a variable name is used,
the application must set the variable to a valid value before the
panel is displayed. The value specified should be within the actual
panel width for the image to be visible when the panel is displayed.
Comments
The
HELPDEF tag defines default values for help panels. When a HELP panel
tag refers to a help panel default, the values specified by the associated
HELPDEF tag are used for the help panel unless overridden by values
specified in the HELP tag definition.
The HELP tag can override
any of the HELPDEF values by specifying that value within its own
definition. Therefore, it is possible for a HELP tag to select certain
default values from the help panel default and override others.
See HELP (Help Panel) for more information.
You can
code multiple HELPDEF definitions in a single application. Each help
default must have a unique helpdef-id.
Restrictions
- You cannot code the HELPDEF tag within any other tag definition.
- You must code the HELPDEF tag before you code any HELP tag that
refers to it.
Examples
Here is
a source file example where the HELPDEF definition defines default
DEPTH and WIDTH values. The help panels
"help15" and
"help16" both
reference the help default.
"help15" uses both default values
and
"help16" uses only the default WIDTH value, and overrides
the default DEPTH value by specifying its own DEPTH value. The help
panel
"help17" does not reference the help default, and defines
its own DEPTH and WIDTH values.
<!DOCTYPE DM SYSTEM>
<HELPDEF ID=helpdef1 DEPTH=10 WIDTH=40>
<HELP NAME=help15 HELPDEF=helpdef1>Help for This
⋮
</HELP>
<HELP NAME=help16 HELPDEF=helpdef1 DEPTH=15>Help for That
⋮
</HELP>
<HELP NAME=help17 DEPTH=15 WIDTH=25>Help for the Other
⋮
</HELP>