7.18.2 Customizing the formatting of index lists
There is an elaborate default index formatting in texi2html, with index
summary by letter linking to index entries grouped by letters too, with
the possibility of index pages split accross files. This system may be
completly bypassed by redefining the function reference that is called
when `@printindex' is encountered:
-- Function Reference: $index_text printindex $index_name
$INDEX_NAME is the index name appearing on the `@printindex' line.
The index formatted should be returned by this function reference.
If the default index formatting is used, there are still
possibilities to customize part of the formatting. The index entries
are sorted alphabetically. A whole index list is considered to be
composed of letter entries. A letter entry is composed by all the index
entries beginning with that letter. A letter may be a non alphabetical
character, but we call it letter here.
An index summary appears at the beginning and at the end of an index
list, and should be used to jump directly to a letter entry. Indices
lists may be split across pages, thus the different letters may appear
on different files. The number of index entries appearing on each page
is determined by a variable `$SPLIT_INDEX' if set. The default is to
split indices after 100 entries.
The formatting of all these elements is controlled by the following
_formatting of a letter in a summary_
-- Function Reference: $letter summary_letter $letter $file
This function is used to format a letter appearing in a
summary, refering to a letter entry in the index list.
$LETTER is the letter. $FILE is the file name where the letter
entry appears. More precisely, it is empty when the letter
entry is on the same page than the summary, it contains the
file name when the index page is split accross page.
$IDENTIFIER is an identifier for the target letter entry.
_formatting of a summary_
-- Function Reference: $summary index_summary
\@ALPHABETICAL_LETTERS and \@NONALPHABETICAL_LETTERS contain
the formatted summary letters, formatted with the above
_formatting of an index entry_
-- Function Reference: $entry index_entry $entry_href $entry_text
$ENTRY_HREF is a reference to the place where the index entry
appeared, $ENTRY_TEXT is the corresponding text. $SECTION_HREF
is a reference to the beginning of the sectioning element
containing the index entry, $SECTION_HEADING is the heading
of the element.
_formatting of letter entry_
-- Function Reference: $letter_entry index_letter $letter
This function formats a letter entry, consisting in all the
index entries beginning with this letter. $LETTER is the
letter, $IDENTIFIER should be used to create a target for
links (typically links from summaries), and
$INDEX_ENTRIES_TEXT is the text of the index entries
formatted as described above.
_formatting of whole index_
-- Function Reference: $index print_index $index_text $index_name
$INDEX_TEXT is the text of all the index entries grouped by
letter appearing in that page formatted as above. It is undef
if there are no entries or theindex name isn't known.
INDEX_NAME is the name of the index, the argument of
automatically generated by info2www version 188.8.131.52