LSE$CLIHELP.HLB  —  DEFINE  PLACEHOLDER  Parameters
 placeholder-name
    Specifies the name of the placeholder being defined. A placeholder
    name must be unique within a language and can be a quoted string.
    To redefine an existing placeholder, you must first delete it
    using the DELETE PLACEHOLDER command.

 placeholder body
    Is the body of the placeholder being defined. The interpretation
    of the placeholder body depends on the type of placeholder. LSE
    displays the body of a terminal placeholder when you attempt to
    expand the placeholder. Note that displaying this text does not
    replace the terminal placeholder and its delimiters.

    The body of a nonterminal placeholder is the text of the
    placeholder expansion; when a nonterminal placeholder is expanded,
    the placeholder name and enclosing delimiters are replaced with
    the text of the placeholder body.

    A nonterminal placeholder can have more than one quoted string in
    each body line. For the expansion of the placeholder, you can set
    the indentation of each string by using the /INDENTATION qualifier
    and its associated keywords.

    Each quoted string in the body line of a nonterminal placeholder
    can take the qualifier and keywords described in the following
    section.

    Nonterminal Body Qualifier

    /INDENTATION=(keyword1 [,integer1, keyword2])

    keyword1

    You can specify any of the following options for keyword1:

    Option      Description

    EXPAND      Indents the string to the column of the first
                character of the nonterminal placeholder being
                expanded. This is the default value if the first body
                line is not a null string.

    CURRENT     Indents the string to the indentation of the line
                containing the placeholder or token. This is the
                default value if the first body line is a null string.

    PREVIOUS    Indents the string to the indentation of the line
                before the line containing the placeholder or token.

    FIXED       Indents the string to the specified column.

    integer1

    You can specify any integer for the integer1 option. The default
    is 0. The integer is added to the column position as specified by
    keyword1 and adjusts the indentation by that number of columns.
    The integer can be negative. When the value for keyword1 is FIXED,
    integer1 specifies the column position at which to put body text;
    it must be positive.

    keyword2

    You can specify any of the following options for keyword2:

    Option    Description

    TAB       Specifies that integer1 should be interpreted as
              specifying an adjustment in terms of tab increments
              rather than columns. Integer1 is multiplied by the
              tab increment for the buffer before it is added to the
              column specified by keyword1.

    SPACE     Specifies that integer1 should be interpreted as
              specifying an adjustment in terms of spaces. This is
              the default.

    Note that you cannot specify keyword2 when keyword1 has a FIXED
    value.

    If there is more than one quoted string in a body line, a comma
    must separate the strings. For FORTRAN, if the body line is inside
    of a comment or there is a tab in the body lines, the /INDENTATION
    qualifier and associated keywords do not take effect for the first
    quoted string for each body line.

    For more information about the use of the /INDENTATION qualifier,
    see the examples for the EXPAND command.

    Each line of the body of a menu placeholder represents one option
    in the menu. An option can be a string of text, a placeholder
    name, or a token name. If the option is a string of text, it
    must appear in quotes. If the option is a placeholder name or a
    token name and does not appear in quotes, that placeholder name or
    token name appears in uppercase letters in the menu display. For
    a placeholder name or token name to appear in lowercase letters
    in a menu, you must enter the placeholder name or token name as a
    lowercase quoted string.

    Each line in the body of a menu placeholder may take one or more
    of the following qualifiers:

    Menu Body Qualifiers  Default

    /DESCRIPTION=string
    /[NO]LIST             /NOLIST
    /PLACEHOLDER
    /TOKEN

    /DESCRIPTION=string

    Specifies a description string that is displayed in the right-
    hand column of the menu. If this qualifier is omitted, then LSE
    gets the description string from the corresponding definition if
    the line has either the /TOKEN or the /PLACEHOLDER qualifier. If
    neither /TOKEN nor /PLACEHOLDER is specified, then the line is a
    literal string and the value of the /DESCRIPTION string defaults
    to the empty string.

    /LIST
    /NOLIST (D)

    Specifies whether the delimiters for the placeholder should be
    list delimiters or not. Use this qualifier only in conjunction
    with the /PLACEHOLDER qualifier.

    /PLACEHOLDER

    Specifies that the name or string is the name of a placeholder in
    the language. This qualifier is mutually exclusive with the /TOKEN
    qualifier.

    /TOKEN

    Specifies that the name or string is the name of a token in
    the language. This qualifier is mutually exclusive with the
    /PLACEHOLDER and /[NO]LIST qualifiers.
Close Help