Indexing

LATEX2HTML automatically produces an Index consisting of the arguments to all index commands encountered, if there are any. A hyperlink is created to that point in the text where the index command occurred.

More sophisticated indexing is available by loading the makeidx package. Most of the features described in [, Appendix A] become available. This includes:
\begin{htmllist}\htmlitemmark{RedBall}%
\index{index!styled entries}%
\item
[st...
...t on the following character,
when appropriate, else is ignored.
\end{htmllist}


Furthermore, the printable part of an index entry can contain HTML anchors; that is, hyperlinks and/or \label{...}s. This allows index entries to contain cross-links to other entries, for example, as well as allowing index-entries to be the target of hyperlinks from elsewhere within the document.

The next sectionglossind describes how this feature is used within this manual to create a Glossary, containing a short description of all file-names, configuration-variables and application software mentioned within the manual, integrated with the Index. All occurrences of the technical names can be easily found, starting from any other.

When a single item is indexed many times, it is sufficient to have a label command appearing within the printable portion of the first instance of an \index{...} command for that item, within a single document segment.


If the index-entries are in different segments of a segmented document, it is sufficient to have the \index{...@...\label{...}} appearing within that segment, in which the item is indexed, whose indexing information is loaded earliest via a \internal[index]{...} command. When in doubt, include one \index{...@...\label{...}} per segment in which the item is indexed.

For cross-links to work effectively within segmented documents, the indexing command \index{...@...\label{...}} must occur earlier in the same segment than any use of \index{...@...\htmlref{...}{...}} intended to create a link to that label. If the label occurs in a different segment, then a \internal[index]{...} command for that segment, may be needed at the beginning of the segment with the htmlref . When this is done incorrectly, the resulting link will be to the segment where the indexed item occurred, rather than staying within the Index.



Since use of section-names, as the text for hyperlinks, can lead to a very long and cumbersome Index, especially when single items have been indexed many times, a further feature is provided to obtain a more compact Index.


Use of the command-line option short_index causes a codified representation of the sectioning to be used, rather than the full section-name. The differences are as follows.

These features can also be obtained by setting the variable $SHORT_INDEX to have value `1', in a configuration or initialisation file; provided, of course, that the document loads the makeidx package.



Subsections