Next: Element Header and Footer Formatting, Up: Customizing HTML Footers, Headers and Navigation Panels [Contents][Index]
All the formatting functions take a converter object as first argument.
The overall display of navigation panels is controlled via this
function reference, format_navigation_header:
$navigation_text format_navigation_header ($converter, \@buttons, $command_name, \%element) ¶\@buttons is an array reference holding the specification of
the buttons for the navigation panel
(see Simple Navigation Panel Customization). \%element is the
element in which the navigation header is formatted. $command_name is
the associated command (sectioning command or @node). It may be undef
for special elements.
Returns the formatted navigation header and panel. The navigation
panel itself can be formatted with a
call to &{$self->formatting_function('format_navigation_panel')}.
The customization variable VERTICAL_HEAD_NAVIGATION should be relevant.
The navigation panel display is controlled via format_navigation_panel:
$navigation_text format_navigation_panel ($converter, \@buttons, $command_name, \%element, $vertical) ¶\@buttons is an array reference holding the specification of the buttons
for that navigation panel. \%element is the element in which the
navigation header is formatted. $command_name is the associated command
(sectioning command or @node). It may be undef for special
elements. $vertical is true if the navigation panel should be vertical.
Returns the formatted navigation panel in $navigation_text. The buttons
in the navigation panel can be formatted with a call to
&{$self->formatting_function('format_button')}.
The function reference format_button does the formatting of
one button:
$formatted_button format_button ($converter, $button, $source_command) ¶$button holds the specification of the button (see Buttons Display). $source_command is an optional argument, the @-command the link comes from.
Returns the formatted result in $formatted_button.
The buttons images can be formatted with format_button_icon_img
(see Basic Formatting Customization).
Customization information described in Simple Navigation Panel Customization
such as BUTTONS_TEXT, BUTTONS_NAME, BUTTONS_GOTO,
USE_ACCESSKEY,
USE_REL_REV and BUTTONS_REL can be relevant for the
formatting of a button.