---

16.2 Element Header and Footer Formatting ¶

All the formatting functions take a converter object as first argument.

By default, the function associated with format_element_header formats the header and navigation panel of a tree unit element.

Function Reference: $formatted_header format_element_header ($converter, $command_name, \%element, \%tree_unit_element) ¶

\%element is the element in which the navigation header is formatted (sectioning command, @node or special element). $command_name is the associated command name. It may be undef for special elements. \%tree_unit_element is the associated tree unit element (see Texinfo Tree Elements in User Defined Functions).

Returns the formatted navigation header and panel.

In the default code, the function reference select a buttons list (see Simple Navigation Panel Customization). The navigation header can then be formatted with a call to &{$self->formatting_function('format_navigation_header')}. It is also possible to format directly the navigation panel, depending on customization variables values and location in file.

Similarly, the function associated with format_element_footer formats the footer and navigation panel of a tree unit element.

Function Reference: $formatted_footer format_element_footer ($converter, $tree_unit_type, \%tree_unit_element, $content, $command) ¶

\%tree_unit_element is the tree unit element element in which the navigation footer is formatted. $tree_unit_type is the associated type. $content is the formatted element content. $command is an optional argument, the @-command associated with the \%tree_unit_element.

Returns the formatted navigation footer and panel.

In the default code, the function reference select a buttons list (see Simple Navigation Panel Customization). The navigation header can then be formatted with a call to &{$self->formatting_function('format_navigation_header')}.

Many customization variables may be interesting for the footer formatting, such as SPLIT, HEADERS, DEFAULT_RULE, BIG_RULE, WORDS_IN_PAGE or PROGRAM_NAME_IN_FOOTER.