Previous Next Table of Contents

4. Indexing.

SGML-Tools does not support indexing. When the publisher requires that a document be indexed, the commands must be included in the intermediate LaTeX document. See the SGML-Tools manual for instructions on how to generate LaTeX output.

Likewise, use makeindex to generate a LaTeX index file from the LaTeX .idx output file. See the makeindex manual page for details.

Include the LaTeX \index command immediately following the word that is indexed. This insures that the page number in the index and the actual page number are the same. Use one \index command per line, and indent the \index command to improve readability.

The Seagate ST02 hard drive controller is a common SCSI controller.

The Seagate ST02
 \index{Seagate ST02 hard drive controller}%
is a common SCSI
 \index{SCSI}%
controller.
Note the use of LaTeX comment (the percent sign) after the \index command. This insures that a paragraph break does not occur after the \index command.

Names of executable programs and standard data files should be indexed every time they occur. The index entry should be in monospaced type, like the word in the text. In order to prevent makeindex from alphabetizing the LaTeX \tt or \ttfamily command as part of the index entry, use the makeindex ``@'' format specifier to alphabetize only the correct indexing tag.

Use {\ttfamily mkfs} to create a new filesystem.

Use {\ttfamily mkfs} 
 \index{mkfs@{\tt mkfs}}%
to create a new filesystem.
See the makeindex manual page for further details.

Sections should be indexed as a range of pages beginning with the section heading's page number and ending immediately before the start of the next section. See the makeindex manual page for instructions on how to specify page ranges.


Previous Next Table of Contents