The KeyIcons file

This optional file is used to display icons next to each entry in an index based on the file information for that entry. The file is normally located in the icons directory, and is named "keyicons.txt". The name can be changed by using the KeyIconsFile configuration option. 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. query search expression
4. One or more tab characters
5. tooltip text (optional)
Any line that does not contain at least one tab character is considered a comment line (this includes blank lines).

The query search expression is evaluated using the file information 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). If an indexed item does not have any keywords, then no icons will be displayed regardless of the query search expression.

The tooltip text is optional, and is displayed 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. See the toolTips configuration option for more information.

Example:

   :dog        Lassie|Benji|Goofy|Pluto
   cat.gif     animal&(Moris|Felix)      Cat
   dog.gif     animal&dog                Dog
   animal.gif  animal&!dog&!cat.gif
   bigset.gif  count>100                 Over 100 slides

Table of Contents