The KeyIcons file

This file is used to display icons next to each entry in an index based on the keyword list for that entry. The file must be named "keyicons.txt", and it must exist in the "icons" subdirectory to enable keyword icons. All lines of this file are evaluated for each entry in the index file.

The format of the KeyIcons file is as follows:

Each line of the file consists of the following, in order:
1. name (described below)
2. One or more tab characters
3. keyword search expression
4. One or more tab characters
5. alternate text (optional)
Any line that does not contain at least one tab character is considered a comment line (this includes blank lines).

The keyword search expression is evaluated using the keyword list from the indexed item. If the expression is true, then one of two things can happen:

If name is the name of an icon file (filename.gif) that exists in the "icons" subdirectory, then the icon will appear next to the corresponding entry in the index. Then name will be added to the keyword list as if it had existed as a keyword in the HTML file being indexed. Any subsequent search expression that tests for name will be true.
If name begins with a colon (:name), then name is an "implied keyword". The leading colon will be removed, and name will be added to the keyword list. Any subsequent search expression that tests for name will be true.

All hidden keywords are converted to non-hidden keywords before executing the search expression (i.e. no hidden keywords should appear in the seach expression).

The alternate text is optional, and acts as a ToolTip (a little yellow text box) in Internet Explorer and Netscape Navigator 4.0+ when the user hovers the mouse over the graphic. It can be used to provide a short description of the icon. The text should be short because it is replicated each time the icon appears in an index.

Example:

   :dog        Lassie|Benji|Goofy|Pluto
   cat.gif     animal&(Moris|Felix)      Cat
   dog.gif     animal&dog                Dog
   animal.gif  animal&!dog&!cat.gif