Function prototype:

Use with:

where hookname is ixkeycharenthook.

The index key character entity hook handles a subset of the problem addressed by the index head to key hook. It allows the user to customize the strings used to replace symbols in index headings.

oid is the oid of the desired character entity reference entity name.

The hook function must return a character string to use in the index key in place of the character entity. If an empty string is returned, it means to ignore this entity for sorting purposes. To have default character entity mapping done for an entity, the hook should return the results of the ixkey_charent function.

This is useful when the character entity mapping that Arbortext Editor does based on the configuration files in the Arbortext-path/lib/ixlang directory of the installation tree is not sufficient. For example, your mapping may need to be conditional on the context of an entity's use.