Identifies synonyms and word variations for the help keywords.
Syntax
┌───────────────┬───────────────┬───────────────┬───────────────┐ │Tag │Element │Attributes │End │ ├───────────────┼───────────────┼───────────────┼───────────────┤ │:isyn. │Index synonyms │root= │ │ └───────────────┴───────────────┴───────────────┴───────────────┘
Attributes
root=
To establish a link, specify the same word as specified in the roots= attribute of the primary index tag. Then add a period, repeat the root word, and add the list of synonyms and variations, separated by blanks. For example, assume that the value specified for the roots= attribute of the primary index tag is "copy." The entry for the index-synonym tag could be:
:isyn root=copy.copy copying duplicate duplicating
The words entered in the synonym list enable the user to search for terms that may not be in the Index list, and still receive the appropriate help. Lowercase and uppercase characters are treated the same.
Description
:isyn. begins a list of synonyms or variations of a word specified by a primary index tag. The compiler uses this list to build a table that serves as a link to the primary index tags. Synonyms determine the topic entries displayed when the user enters words for a search of the index. The compiler matches the entered words with words in the table and links to the topics to be displayed.
The index-synonym tag can be placed within any window that contains related index entries identified by the index tag. The synonyms defined in a window can relate to many topics, and thus to many windows.
Synonyms defined with this tag do not appear in the index.
Conditions
A root word can contain only alphabetic and numeric characters.
Example
:h1 id=copy03.Help for Copying:isyn root=copy.copy copying duplicate duplicating :isyn root=folder.folder folders document documents :i1 roots='copy folder'.Copying a document :p.When copying a file from the current directory to a new directory, specify the following: :ul. :li.The file name :li.The target directory :li.The new file name and extension :eul.
Output
The index-synonym tag creates the following synonym table:
Root word
The roots= attribute points to the root words, "copy" and "folder," and the list of associated synonyms. If the user searches for "copy" or "folder," the words will be displayed because of the matches between the roots= attribute of the primary index tag and the root= attribute of the index-synonym tag. However, a search for the synonym "duplicate" returns "Copying a document" as an index choice.