PARML (Parameter List)

Parameters

TSIZE=10 | S1 S2... Sn

This attribute defines the space allocated for the parameter term. The default is 10 characters. The minimum TSIZE value is 0 and the maximum is 40.

When multiple TSIZE values are specified, a PT tag must be coded for each value. The sizes are applied to the PT tags in the order the tags are encountered in the DTL source file.

BREAK=ALL | FIT | NONE

This attribute controls the formatting of the parameter terms and descriptions. If BREAK=ALL (the default), every description is on the line below the term. If BREAK=FIT, the description is on the line below the term if the term is longer than the TSIZE value. If BREAK=NONE, the term is on the same line as the description, spilling into the description area if the length exceeds the TSIZE value.

COMPACT

This attribute causes the conversion utility to format the list without a blank line between the items.

SKIP

This attribute causes a blank line to be formatted before the first parameter term when COMPACT is also specified.

INDENT=n

This attribute specifies that the parameter list be indented from the current left margin.

FORMAT=START | CENTER | END

This attribute specifies the placement of the PT tag text within the space specified by TSIZE. The PARML tag FORMAT setting applies to all of the PT tags within the parameter list.

DIVEND=NO | YES

This attribute specifies whether a divider character is formatted following the PD tag text. When DIVEND=YES, the formatting width of the PD text is reduced to allow space for the divider character.

SPLIT=NO | YES

This attribute controls the format of the last PT tag in a multiple PT tag group. It is used only when BREAK=ALL or when BREAK=FIT and the PT tag text length exceeds the TSIZE value. When SPLIT=YES, the text following the last PT tag in the PT group (typically one or two dashes) is placed in front of the first line of the formatted PD tag text. The SPLIT setting on a PARML tag applies to all of the PT tag groups within the parameter list.

Comments

The PARML tag defines a parameter list within an information region.

Parameter lists are similar to definition lists. They involve three tags: PARML (parameter list) and a matching end tag, PT (parameter term), and PD (parameter description). As in definition lists, the term tag defines a term, and the definition tag defines the description associated with the term. The PD tag must immediately follow the PT tag that it is associated with.

Parameter lists can occur anywhere in an information region; you can nest them within other lists, and you can nest other lists within parameter lists.

Restrictions

• The PARML tag requires an end tag.
• You must code the PARML tag within an INFO definition. See INFO (Information Region) for a complete description of this tag.

Processing