ixkeymarkuphook
ixkeymarkuphook
Function prototype:
hook (oid)
Synopsis
Use with:
add_hook(hookname, func[, prepend])
remove_hook(hookname, func)
where hookname is ixkeymarkuphook.
Normally, elements and pseudo-tags inside index headings do not affect sorting. (However, if they have generated text in the context of the preliminary index, the generated text does affect sorting.
The index key markup hook allows the user to have markup affect the conversion of an index heading to an index key. Again, this is a subset of the index heading to key conversion process that can be handled by the index head to key hook.
Argument
oid is the oid of a start tag.
The hook function must return a character string to use in the index key in place of the markup. If an empty string is returned, it means to ignore this markup for sorting purposes.