5.3 Direction Strings Customization

The direction strings can be customized with texinfo_register_direction_string_info:

Function: texinfo_register_direction_string_info ($direction, $type, $converted_string, $string_to_convert, $context)

$direction is a direction (see Directions), $type is the type of string (see Direction Strings). The other arguments are optional. $context is ‘normal’ or ‘string’. See Init File Expansion Contexts: Normal, Preformatted, Code, String, Math. If $context is undef, the ‘normal’ context is assumed.

$converted_string is the string, already converted to HTML that is used for the specified context. If the ‘normal’ context $converted_string only is specified, the same string will be used for the ‘string’ context.

Alternatively, $string_to_convert can be specified to set the string to the corresponding Texinfo code after translation and conversion to HTML. In that case, the context is ignored, as it will be set at the time of the conversion.

$string_to_convert is ignored for special strings that do not need to be translated and cannot contain Texinfo @-commands (‘accesskey’, ‘rel’ and ‘example’). $string_to_convert is also ignored if $converted_string is set for any context.