PLDIV (Parameter List Divider)

The Parameter List Divider tag creates a blank or visible divider within the text portion of a parameter list.

Syntax


>>-<PLDIV--+-----------------+--+--------------+---------------->
           |       .-NONE--. |  |      .-YES-. |   
           '-TYPE=-+-SOLID-+-'  '-GAP=-+-NO--+-'   
                   +-DASH--+                       
                   '-TEXT--'                       

>--+---------------+--+--------------------+-------------------->
   |         .-1-. |  '-FORMAT=-+-START--+-'   
   '-GUTTER=-+-n-+-'            +-CENTER-+     
                                '-END----'     

>-->--+--------------+--+----------+---------------------------><
      '-divider-text-'  '-</PLDIV>-'

Parameters

TYPE=NONE | SOLID | DASH | TEXT: This attribute specifies the type of parameter list divider line.
The default value is NONE, which produces a blank line. You must specify SOLID, DASH, or TEXT to produce a visible divider line. When the GRAPHIC invocation option is specified, SOLID produces a solid line for host display and DASH produces a dashed line. When NOGRAPHIC is specified or the panel is displayed in GUI mode, both SOLID and DASH produce a dashed line.
GAP=YES | NO: When GAP=NO, the divider line completely crosses from one side of the text area to the other. When GAP=YES, a 1-character gap remains at each end of the divider line.
GUTTER=1 | n: This attribute specifies the total width of the parm list divider. If the GUTTER value is an even number, the conversion utility increases the number by 1 so that the divider is centered within the defined width.
The minimum GUTTER value, and the default, is 1.
FORMAT=START | CENTER | END: This attribute specifies the position of the divider text within the width of the divider line.
divider-text: This is the text of the area divider line.

Comments

The PLDIV tag creates a blank or solid divider within the text portion of an application panel. A horizontally formatted visible divider is created when you specify the TYPE attribute value as SOLID or DASH. When the GRAPHIC invocation option is specified, SOLID produces a solid line for host display and DASH produces a dashed line. When NOGRAPHIC is specified or the panel is displayed in GUI mode, both SOLID and DASH produce a dashed line.

The divider line can be formatted with descriptive text. When this feature is used, the FORMAT attribute must be specified. If FORMAT is not specified, the tag text is ignored. You control the text padding with the TYPE attribute. If TYPE=TEXT, the divider-text is padded with blanks. When TYPE=SOLID or TYPE=DASH, the divider-text is padded with the specified character.

Restrictions

You must code the PLDIV tag within a PARML tag definition.

Processing

Table 1. Tags you can code within a PLDIV definition
Tag	Reference	Usage	Required
HP	HP (Highlighted Phrase)	Multiple	No

Examples

Here is an example that uses the PLDIV tag. Figure 1 shows the formatted result.

<!DOCTYPE DM SYSTEM>

<HELP NAME=pldiv DEPTH=22 WIDTH=60>Part Number Code Help
<AREA>
<INFO>
  <P>Valid part numbers consist of a three-digit
  number followed by a 2-character suffix.
  <DIVIDER>
  <PARML TSIZE=6 compact>
    <PLDIV TYPE=solid>
    <PT>123
    <PD>The first three digits represent
    the lot number of the part.
    <PLDIV TYPE=solid>
    <PT>AA
    <PD>The 2-character suffix represents the
    department the part originated from.
    The valid suffixes are:
      <PARML BREAK=none COMPACT SKIP>
        <PT>TO
        <PD>Tools
        <PT>EL
        <PD>Electrical
        <PT>ME
        <PD>Mechanical
      </PARML>
  </PARML>
</INFO>
</AREA>
</HELP>

Figure 1. Parameter list divider

                   Part Number Code Help

 Valid part numbers consist of a three-digit number
 followed by a 2-character suffix.

 ----------------------------------------------------------
 123
       The first three digits represent the lot number of
       the part.
 ----------------------------------------------------------
 AA
       The 2-character suffix represents the department the
       part originated from. The valid suffixes are:

       TO        Tools
       EL        Electrical
       ME        Mechanical