z/OS ISPF Dialog Tag Language Guide and Reference
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


DL (Definition List)

z/OS ISPF Dialog Tag Language Guide and Reference
SC19-3620-00

The DL tag defines a list of terms and their corresponding definitions within an information region.

Syntax

Read syntax diagramSkip visual syntax diagram
>>-<DL--+--------------------------+--+-----------------+------->
        |        .-10------------. |  |        .-NONE-. |   
        '-TSIZE=-+-'s1 s2... sn'-+-'  '-BREAK=-+-FIT--+-'   
                                               '-ALL--'     

>--+---------+--+--------+--+-----------+----------------------->
   '-COMPACT-'  '-NOSKIP-'  '-INDENT=-n-'   

>--+--------------------+--+-----------------+------------------>
   |         .-START--. |  |         .-NO--. |   
   '-FORMAT=-+-CENTER-+-'  '-DIVEND=-+-YES-+-'   
             '-END----'                          

>--+----------------+-->--</DL>--------------------------------><
   |        .-NO--. |             
   '-SPLIT=-+-YES-+-'             

Parameters

TSIZE=10 | 's1 s2... sn'
This attribute specifies the space to be allocated for the definition term. The default value is 10 characters. The minimum TSIZE value is 0 and the maximum is 40. When multiple TSIZE values are specified, a DT tag must be coded for each value. The sizes are applied to the DT tags in the order the tags are encountered in the DTL source file.
BREAK=NONE | FIT | ALL
This attribute controls the formatting of the definition terms and descriptions. If BREAK=NONE, the term is on the same line as the description, spilling into the description area if the length exceeds TSIZE. If BREAK=FIT, the description is on the line below the term if the term exceeds the TSIZE value. If BREAK=ALL, every definition is on the line below the term.
COMPACT
This attribute causes the list to format without a blank line between the items in the list. If you code DDHD and DTHD tags in a compact definition list, the list formats without a blank line between the headers and list items.
NOSKIP
This attribute causes the list to format without creating a blank line before the first line of the list.
INDENT=n
This attribute specifies that the definition list is to be indented from the current left margin.
FORMAT=START | CENTER | END
This attribute specifies the placement of the DT tag text within the space specified by TSIZE. The DL tag FORMAT setting applies to all of the DT tags within the definition list.
DIVEND=NO | YES
This attribute specifies whether a divider character is formatted following the DDHD and DD tag text. When DIVEND=YES the formatting width of the DDHD and DD text is reduced to allow space for the divider character.
SPLIT=NO | YES
This attribute controls the format of the last DT tag in a multiple DT tag group. It is used only when BREAK=ALL or when BREAK=FIT and the DT tag text length exceeds the TSIZE value. When SPLIT=YES, the text following the last DT tag in the DT group (typically one or two dashes) is placed in front of the first line of the formatted DD tag text. The DL tag SPLIT setting applies to all of the DT tag groups within the definition list.

Comments

The DL tag defines a list of terms and their corresponding definitions within an information region. You use the DT and DD tags to identify the terms that you are defining and their descriptions, respectively. You use the DTHD and the DDHD tags to define headings for the term and description columns in definition lists.

The conversion utility inserts a blank line before the definition list unless NOSKIP is specified.

If you do not specify a TSIZE value, the space allocated for the term size is 10 characters. If any term is longer than 10 characters and BREAK=NONE (the default) is specified, the term extends into the description line. If the term is still too long to fit, it wraps to the next line.

The definition description is an implied paragraph, and can contain any text items. For example, you can insert additional paragraphs in a definition description by using the paragraph (P) tag following the description paragraph. Other tags that you want to nest within the definition list (such as OL, SL, or UL) must follow the DD tag within the list.

Restrictions

  • The DL tag requires an end tag.
  • You must code the DL tag within an INFO definition. See INFO (Information Region) for a complete description of this tag.
  • If you code DDHD and DTHD tags within the definition list, they must precede the first DT tag.

Processing

Table 1. The tags you can code within a DL definition
Tag Reference Usage Required
DD DD (Definition Description) Multiple No
DDHD DDHD (Definition Description Header) Multiple No
DLDIV DLDIV (Definition List Divider) Multiple No
DT DT (Definition Term) Multiple No
DTDIV DTDIV (Definition Term Divider) Multiple No
DTHD DTHD (Definition Term Header) Multiple No
DTHDIV DTHDIV (Definition Term Header Divider) Multiple No

Examples

Here is help panel markup that contains a definition list that uses the default BREAK value of NONE, which formats the definition descriptions on the same line as the associated terms. Definition term and description headers are also included. Figure 1 shows the formatted result of the markup. Figure 2 shows how the same definition list would format with a BREAK value of FIT. Figure 3 shows how the same definition list would format with a BREAK value of ALL.
<!DOCTYPE DM SYSTEM>

<HELP NAME=dl DEPTH=22 WIDTH=60>Employee Code Help
  <AREA>
  <INFO>
    <P>The following list defines the valid employee codes.
    <DL TSIZE=11>
      <DTHD>Code
      <DDHD>Meaning
      <DT>Full-time
      <DD>Indicates that the employee works a
      regular schedule of 40 hours or more weekly.
      <DT>Part-time
      <DD>Indicates that the employee works a regular
      schedule of 20 to 40 hours weekly.
      <DT>Supplemental
      <DD>Indicates that the employee works less than
      20 hours weekly.
      No regular schedule is in place.
    </DL>
  </INFO>
  </AREA>
</HELP>
Figure 1. Definition List (BREAK=NONE)
                     Employee Code Help

 The following list defines the valid employee codes.

 Code       Meaning

 Full-time  Indicates that the employee works a regular
            schedule of 40 hours or more weekly.

 Part-time  Indicates that the employee works a regular
            schedule of 20 to 40 hours weekly.

 Supplemental Indicates that the employee works less than
            20 hours weekly. No regular schedule is in
            place.




  F1=Help        F3=Exit        F5=Exhelp      F6=Keyshelp
  F7=PrvTopic    F8=NxtTopic   F10=PrvPage    F11=NxtPage
 F12=Cancel
Figure 2. Definition List (BREAK=FIT)
                     Employee Code Help

 The following list defines the valid employee codes.

 Code       Meaning

 Full-time  Indicates that the employee works a regular
            schedule of 40 hours or more weekly.

 Part-time  Indicates that the employee works a regular
            schedule of 20 to 40 hours weekly.

 Supplemental
            Indicates that the employee works less than 20
            hours weekly. No regular schedule is in place.





  F1=Help        F3=Exit        F5=Exhelp      F6=Keyshelp
  F7=PrvTopic    F8=NxtTopic   F10=PrvPage    F11=NxtPage
 F12=Cancel
Figure 3. Definition List (BREAK=ALL)
                     Employee Code Help

 The following list defines the valid employee codes.

 Code       Meaning

 Full-time
            Indicates that the employee works a regular
            schedule of 40 hours or more weekly.

 Part-time
            Indicates that the employee works a regular
            schedule of 20 to 40 hours weekly.

 Supplemental
            Indicates that the employee works less than 20
            hours weekly. No regular schedule is in place.


  F1=Help        F3=Exit        F5=Exhelp      F6=Keyshelp
  F7=PrvTopic    F8=NxtTopic   F10=PrvPage    F11=NxtPage
 F12=Cancel

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014