(texi2html.info)Button specifications

---

Next: Panel formatting function Prev: General purpose variables Up: Navigation panel

---

Enter node , (file) or (file)node

6.3.2 Specifying the buttons formatting
---------------------------------------

Several arrays and hashes enable a precise control on the buttons and
their display.  The following arrays determine the buttons present in
navigation panels:

`@SECTION_BUTTONS'
     This array is used for the navigation panel buttons present at the
     begining of sectioning elements. If split at node or section they
     are also used at the page footer, and in the case of section
     navigation at the page header.

`@SECTION_FOOTER_BUTTONS'
`@NODE_FOOTER_BUTTONS'
     This array is used for the navigation panel buttons present at the
     footer of pages when split at node or at section.

     If `$WORDS_IN_PAGE' is set and the output is split at nodes, these
     buttons are only present if there are more than `$WORDS_IN_PAGE'
     words in the sectioning element text. This counting is very rough
     and include punctuation marks, html elements, numbers.  The
     default is to include the buttons after 300 words.

`@CHAPTER_BUTTONS'
     This array is used for the buttons appearing at the page footer if
     split at chapter, and at the page header if split at chapter and
     there is no section navigation.

`@MISC_BUTTONS'
     These buttons appear at the beginning of special and sections and
     at the end of these section pages if the output is split.

`@LINKS_BUTTONS'
     These are used for `<link>' elements if they are output in the
     headers.

   The array specify the buttons displayed in navigation panels, and
how the button is displayed.  Each element is associated with a button
of the navigation panel from left to right.  The signification of the
array element value is the following:

_reference on a function_
     The function is called with argument a boolean true if the
     navigation panel should be vertical. Should return the formatted
     button text.

_reference on a scalar_
     The scalar value is printed. For some possibly usefull scalars,
     Note: Elements hashes.

_reference on an array_
     In this case the first array element should be a reference on text
     and the second element an element label. In that case a link to the
     element associated with the element label with the scalar value
     text is generated.

     For example if the buttons array element is
          [ 'Next', \$Texi2HTML::NODE{Next} ]

     The button will be a link to the next section with text `$Texi2HTML::NODE{Next}'.

_element label_
     If icons are not used, the button is a link to the corresponding
     element which text is defined by the value associated with the
     element label in the `%NAVIGATION_TEXT' hash, surrounded by `['
     and `]'. If the element label is ` ', there is no `[' and `]'.
     The element of the `%NAVIGATION_TEXT' hash are defined
     dynamically, in the `init_out' function reference (Note: Output
     initialization).

     If icons are used, the button is an image with file determined by
     the value associated with the element label in the `%ACTIVE_ICONS'
     hash if the the link really leads to an element, or in the `%PASSIVE_ICONS'
     hash if there is no element to link to. Of course if there is a
     link to the element the icon links to that element. The button
     name and the button description are used in HTML attributes to
     have a textual description of the icon. The corresponding strings
     are in `%BUTTONS_NAME'  for the button name and  `%NAVIGATION_TEXT'
     for the description.

   If `$USE_ACCESSKEY' is set, the `accesskey' attribute is used in
navigation. In that case the `%BUTTONS_ACCESSKEY' hash is used for the
access key.

   Similarly, if If `$USE_REL_REV' is set, the `rel' attribute is used
in navigation. In that case the `%BUTTONS_REL' hash is used for the rel
attribute.