Important Notice

The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.

                                                      ◄Up► ◄Next► ◄Previous►
────────────────────────────────────────────────────────────────────────────
 
 :parml [tsize=width] [compact] [break={ all | fit | none }.
 
The :parml tag starts a parameter list. A parameter list is a two-column
list. For each row in the list, the left column contains a word or phrase
and the right column contains one or more lines of description. In the help
source file, the parameter list starts with the :parml tag, and ends with
the :eparml tag, and contain one or more pairs of :pt and :pd tags.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
tsize      Specifies the width (in characters) of the left column. The
           width value must be an integer. If this parameter is not
           specified, the default width is 10 characters.
 
compact    Removes blank lines from between rows in the list. If this
           parameter is not specified, the list has one blank line between
           each row.
 
break      Specifies whether the text in the right column of a row starts on
           a new line (that is, a line different from the start of the
           left-column text). It can be one of the following values:
 
           Value  Meaning
           ─────────────────────────────────────────────────────────────────
           all    Right-column text in all rows starts on a new line.
 
           fit    Right-column text starts on a new line only if the
                  left-column text exceeds the width of the left column.
 
           none   Right-column text always starts on the same line as the
                  left-column text. If the left-column text does not fit the
                  left column, the right-column text starts immediately
                  after the left-column text, separated by a space.
 
           The default value is all.
 
Comments
 
Although the width of the left column is specified in characters, the actual
width of the column depends on the average character width of the font used
to display the text. For example, specifying a width of 10 characters does
not guarantee that the letter M repeated 10 times will fit in the column.
 
A parameter list is similar to a definition list (created using the :dl
tag).
 
Example
 
This example uses the :parml tag to create a parameter list:
 
    :parml compact tsize=20.
    :pt.Tree
    :pd.Plant life in forest
    :pt.Orange
    :pd.Fruit on tree
    :pt.Cow
    :pd.Animal on farm
    :eparml.
 
When displayed, the parameter list looks like this:
 
    Tree
            Plant life in forest
    Orange
            Fruit on tree
    Cow
            Animal on farm
 
See Also
 
 :dl, :eparml, :pd, :pt
 
                                      ♦