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►
────────────────────────────────────────────────────────────────────────────
 
 :i1 [id=label] [roots=word[word...]].
 
The :i1 tag creates a first-level index entry. The text immediately
following the tag is added to the help index. This entry is also associated
with the current panel such that the panel is displayed when the user
chooses the entry. If an index label is given using the id parameter,
second-level index entries can be created by using this first-level entry.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
id         Identifies the index label. The label value can be a combination
           of letters and digits, but it must be unique (that is, no other
           first-level index entry may have the same label). The index label
           can be used in a second-level index entry to associate that entry
           with the first-level entry.
 
roots      Links the index entry to the synonyms specified by one or more
           :isyn tags. Each word value must match a word specified in the
           root parameter of an :isyn tag. One space must separate each
           word value, and the values must be enclosed in single quotation
           marks (').
 
Comments
 
You cannot have index entries in a footnote.
 
Example
 
This example uses the :i1 tag to create the first-level index entry
"Delete." The entry has the index label "delete," which is used with the
subsequent :i2 tag to create the second-level index entry "Delete, Files."
 
    :i1 id=delete.Delete
    :i2 refid=delete.Files
 
See Also
 
 :i2, :isyn
 
                                      ♦