9.2.1 Specific formating Functions

User defined formatting functions are registered with texinfo_register_formatting_function:

Function: texinfo_register_formatting_function ($formatted, \&handler)

$formatted is a string describing the formatting function. \&handler is the user defined function reference.

To call a formatting function from user defined code, the function reference should first be retrieved using formatting_function:

Function: \&formatting_function = $converter->formatting_function ($formatted)

$formatted is a string describing the formatting function. Returns the associated formatting function reference.

It is possible to have access to the default formatting function reference. The function used is:

Function: \&default_formatting_function = $converter->default_formatting_function ($formatted)

$formatted is a string describing the formatting function. Returns the default formatting function reference.

The string that should be used to register or call each of the formatting functions and the call of the formatting functions are documented in the following sections of the manual, depending on where they are relevant.