<idx>

Index entry

Defines an entry to appear in the keyword index.

Syntax. 

   <idx>text<\idx>

Or:

   <idx|text|

Or:

   <idx>text<sort>sort key<\idx>

Where:

The keyword index is displayed by choosing Keyword from the Search menu in a general help dialog. (The keyword index is not available in quick help dialogs.) When the index entry is chosen in the Keyword Index dialog, the topics that contain the index entry are listed. Choosing one of the listed topics displays that topic. The Keyword Index dialog remains available for further keyword index access.

Either the <idx> start and end tags or the short form can be used.

The <sort> element changes the sort order for a keyword index entry. Specifically, the <sort> element is used within the <idx> element to request that the keyword appear at the location indicated by the sort key string. No end tag for <sort> is required.

Examples.  The following markup shows the definition of some simple index entries. The index entries are indented to make the source text easier to read.

             <idx|keyboard|

             <idx|disk drive|

             <idx|screen, LCD|



   An HP Portable Vectra CS PC has a full

   size keyboard, built-in disk drives and

   a detachable LCD screen.

The following example displays "+" in the keyword index, but it appears where "plus" would appear.

   <idx>+<sort>plus<\idx>