6.13 Generation of external files for index entries

Within the document, @printindex commands are expanded as explained in Customizing the formatting of index lists. In case you want to do something special with index entries, outside of the document, you should first set the variable $IDX_SUMMARY true. After that some function reference will be called for each non empty index. For each index there are 3 function references, one called for initialization, one called for each index entry and the last one called for finalization.

Function Reference: index_summary_file_begin $index_name $is_printed

$index_name is the two letters name for the index. This function is called for each index appearing in the document, before index_summary_file_entry. $is_printed is true if there is a @printindex for that index.

Function Reference: index_summary_file_entry $index_name $entry_text $entry_reference $formatted_entry $texi_entry $entry_element_reference $entry_element_header $is_printed

This function is called for each entry of an index. index_name is the name of the index. $entry_text is the entry in plain text, $formatted_entry is the index entry formatted, $texi_entry is the entry with texinfo commands. $entry_reference is the reference placed at the index entry place, in the form ‘file#id’. $entry_element_header is the formatted header of the element containing the index entry. entry_element_header is the reference to the beginning of the element containing the index entry, in the form ‘file#id’. $is_printed is true if there is a @printindex for that index.

Function Reference: index_summary_file_end $index_name $is_printed

$index_name is the two letters name for the index. This function is called for each index appearing in the document, after index_summary_file_entry. $is_printed is true if there is a @printindex for that index.

Doku-Base