Prev Next Keyword

Keyword Index and Searching

Syntax
See Also
Description
The Keyword Index
Keyword List
Escape Character
Headings
     Example
Index
     Example
Mindex
     Example
Aindex
     Excluded Words
     Root Section
     Example
Cindex
     Example

Syntax
$index one_entry$$
 $mindex multiple_entries$$
 $cindex multiple_entries$$
 $aindex automatic_mindex$$
See Also
getting started , index , contents

Description
These commands add entries to the Keyword Index and Search Index for the current section.

There can be no $ characters in one_entry , multiple_entries , or automatic_mindex . In addition, leading and trailing white space in these arguments are ignored.

The Keyword Index
The entries in the Keyword index are alphabetically ordered. There are two levels to this ordering and each index entry has a major and minor key. The major key corresponds to the overall ordering. The minor key corresponds to the ordering with in each value for the major key. You can link to the Keyword index using the _index cross reference tag .

Keyword List
Each section has an associated Keyword list. This consists of all the words that appear in index, cindex or mindex commands for that section. Words that begin with an escape character will not appear in this Keyword list. This list of Keywords is connected to the corresponding section by the OMhelp search utility and by search engines on the internet (if your web site is on the internet).

Escape Character
The current escape character is used to convey special meaning to the index, cindex, and mindex commands. These characters do not actually appear in the Keyword index or the Keyword list.

When using the cindex and mindex commands, any commas in multiple_entries must be directly preceded by an escape character.

Headings
If the index, cindex or mindex command occurs before any head commands in the a section, the corresponding links are to the entire section. If they occur after a head command and before any subhead commands, the corresponding link to the previous heading. If they occur after a subhead command the corresponding link to the previous subheading.

Example
The following command appears before any of the headings in this section: 
 
     $cindex Keyword index$$
The corresponding entries in the Keyword index are:
     Keyword
          Keyword index Keyword Index and Searching
     index
          Keyword index Keyword Index and Searching
Note that the entries above link to the entire Keyword section. Most of the examples below link to the specific subheadings with in this section.

Index
The index command specifies a single Keyword index entry that points to the current section. If there is a comma in one_entry the portion of one_entry to the left of the comma specifies the major key and the part to the right specifies the minor key. If a comma is directly preceded by the escape character, it is normal text and does not split the key into its major and minor parts.

Example
The following command appears directly after the subheading above: 
 
     $index major key$$
The corresponding entry in the Keyword index is:
     major key Keyword Index and Searching: Index.Example

The comma can be used to separate the major and minor keys. The following command appears directly after the subheading above: 
 
     $index major key, minor key$$
The corresponding entry in the Keyword index is:
     major key
          minor key Keyword Index and Searching: Index.Example

If you want the comma character to appear in an index entry, you must escape it. The escape character for this section is #. The following command appears directly after the subheading above: 
 
     $index index example for f(x#, y)$$
The corresponding entry in the Keyword index is:
     index example for f(x, y) Keyword Index and Searching: Index.Example

Mindex
This command adds an index entry for each key word in multiple_entries . The index entry has the key word as its major key and its minor key is empty.

A key word is terminated by a white space character that is not directly preceded by an escape character. If a key word begins with an escape character, it is not included in the index entries.

Example
The following command appears directly after the subheading above: 
 
     $mindex
          multiple
          major
          key# word
     $$
The corresponding entries in the Keyword index are:
     multiple Keyword Index and Searching: Mindex.Example
     major Keyword Index and Searching: Mindex.Example
     key word Keyword Index and Searching: Mindex.Example

Aindex
There are three commands that can be automatically connected to the mindex command; namely the section , head and subhead commands. If automatic_mindex contains the word "section", "head", or "subhead", the corresponding commands are connected until the next aindex command or the end of the current section. If a command is connected to the mindex command, the command argument is automatically used as the multiple_entries argument to the mindex command.

Excluded Words
The aindex command does not automatically include the following words: a, an, and, as, at, by, for, in, of, or, to .

Root Section
In the special case where an $aindex command appears in the root section section, and does not appear in the current section, the value specified in the root section is used for the current section; i.e., it replaces the default which is to not do automatic indexing for section titles, headings, or subheadings.

Example
The following command appears before any of the heading commands in this section: 
 
     $aindex head$$
The Keyword index entry corresponding the heading Aindex is:
     aindex Keyword Index and Searching: Aindex
Note that the word Aindex has been converted to lower case. In general all Keyword entries created using the $aindex command are converted to lower case. Also note that the links generated by $aindex section are to the entire section, $aindex head links to the corresponding headings, and $aindex subhead links to the corresponding subheading.

Cindex
This command adds an index entry for each key word in multiple_entries . The major key for the index entry is the Keyword. Its minor key is the entire string multiple_entries .

A key word is terminated by a white space character that is not directly preceded by an escape character. Any key word may begin with an escape character in which case the index entry with it in front is not included.

Example
The following command appears directly after the subheading above: 
 
     $cindex cindex example$$
The corresponding entries in the Keyword index are:
     cindex
          cindex example Keyword Index and Searching: Cindex.Example
     example
          cindex example Keyword Index and Searching: Cindex.Example

Input File: omh/keyword.omh