texinfo-commits
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

branch master updated: * doc/texi2any_api.texi (Advanced Navigation Pane


From: Patrice Dumas
Subject: branch master updated: * doc/texi2any_api.texi (Advanced Navigation Panel Buttons Specification, Customizing HTML Footers@comma{} Headers and Navigation Panels): move "Advanced Navigation Panel Buttons Specification" node to "Customizing HTML Footers@comma{} Headers and Navigation Panels".
Date: Thu, 16 Jan 2025 17:22:53 -0500

This is an automated email from the git hooks/post-receive script.

pertusus pushed a commit to branch master
in repository texinfo.

The following commit(s) were added to refs/heads/master by this push:
     new fe8697638c * doc/texi2any_api.texi (Advanced Navigation Panel Buttons 
Specification, Customizing HTML Footers@comma{} Headers and Navigation Panels): 
move "Advanced Navigation Panel Buttons Specification" node to "Customizing 
HTML Footers@comma{} Headers and Navigation Panels".
fe8697638c is described below

commit fe8697638ca3133ffe9b93a122c07af19ed2083f
Author: Patrice Dumas <pertusus@free.fr>
AuthorDate: Thu Jan 16 23:22:59 2025 +0100

    * doc/texi2any_api.texi (Advanced Navigation Panel Buttons
    Specification, Customizing HTML Footers@comma{} Headers and Navigation
    Panels): move "Advanced Navigation Panel Buttons Specification" node
    to "Customizing HTML Footers@comma{} Headers and Navigation Panels".
---
 ChangeLog             |   7 +++
 doc/texi2any_api.texi | 126 +++++++++++++++++++++++++++-----------------------
 tp/TODO               |  15 ------
 3 files changed, 76 insertions(+), 72 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 689d2b998c..b7613c6253 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2025-01-16  Patrice Dumas  <pertusus@free.fr>
+
+       * doc/texi2any_api.texi (Advanced Navigation Panel Buttons
+       Specification, Customizing HTML Footers@comma{} Headers and Navigation
+       Panels): move "Advanced Navigation Panel Buttons Specification" node
+       to "Customizing HTML Footers@comma{} Headers and Navigation Panels".
+
 2025-01-16  Patrice Dumas  <pertusus@free.fr>
 
        * doc/texi2any_api.texi (Simple Navigation Panel Customization):
diff --git a/doc/texi2any_api.texi b/doc/texi2any_api.texi
index 605f219c83..4791d24f12 100644
--- a/doc/texi2any_api.texi
+++ b/doc/texi2any_api.texi
@@ -1389,59 +1389,9 @@ texinfo_set_from_init_file('SECTION_BUTTONS', 
\@@modified_buttons_list);
 
 @end example
 
-@node Advanced Navigation Panel Buttons Specification
-@subsection Advanced Navigation Panel Buttons Specification
-
-The meaning of the array item values is the following:
-
-@anchor{Buttons Display}
-
-@table @emph
-@item string with a text direction
-If icons are not used, button is the @code{text} direction string.
-If icons are used, the button is an image whose file is determined by
-the value associated with the output unit direction in the @code{ACTIVE_ICONS}
-variable hash.  The button name is given as HTML attribute to have a textual
-description of the icon.  The button name corresponds to the
-@code{button} direction string in @emph{string} context.
-
-@item string with an output unit direction
-If icons are not used, the button is a link to the corresponding
-output unit whose text is the @code{text} direction string
-(@pxref{Direction Strings}), surrounded by @samp{[} and
-@samp{]}.
-
-@vindex ACTIVE_ICONS
-@vindex PASSIVE_ICONS
-@cindex Icons, in navigation buttons
-If icons are used, the button is an image whose file is determined by
-the value associated with the output unit direction in the
-@code{ACTIVE_ICONS} variable hash if the link leads to an output unit, or in 
the
-@code{PASSIVE_ICONS} variable hash if there is no output unit to link to.  If
-there is a link to the output unit, the icon links to that output unit.  The
-button name and button description are given as HTML attributes to
-have a textual description of the icon.  The corresponding strings
-correspond to the @code{button} direction string for the button name
-and the @code{description} for a more detailed description (@pxref{Direction
-Strings}).
-
-@item function reference
-The functions is called with one arguments, the converter object.
-The function should return two scalars, the button text and
-a boolean set if a delimiter is desired before the button.
-
-@item array reference of length 2
-Here, the first array item should be a an output unit direction,
-and the second array item a reference to a function.
-The function is called with three arguments, the converter object, the
-output unit direction and the source Texinfo tree element (possibly undef).
-The function should return two scalars, the button text and
-a boolean set if a delimiter is desired before the button.
-
-@end table
-
-No delimiter is printed before the first button.  Leading space buttons
-mixed with directions not found may be omitted of the navigation panel output.
+This concludes the simple navigation headers customization.  More advanced
+possibilities for customization are described later on (@pxref{Customizing HTML
+Footers@comma{} Headers and Navigation Panels}).
 
 
 @node User Defined Functions
@@ -4630,10 +4580,12 @@ unrelated to the headings and ``footings'' produced in 
@TeX{} output;
 
 In the event that your needs are not met by setting customization variables
 (@pxref{Customization of Navigation and Headers,,, texinfo, Texinfo}) and
-changing the navigation buttons (@pxref{Simple Navigation Panel
-Customization}), you can completely control the formatting of navigation panels
-by redefining function references.  @xref{Registering Specific Formating
-Functions} for information on how to register the function references.
+changing the navigation buttons using directions names
+(@pxref{Simple Navigation Panel Customization}), you can use more advanced
+navigation buttons formatting specifications.  You can also completely control
+the formatting of navigation panels by redefining function references.
+@xref{Registering Specific Formating Functions} for information on how to
+register the function references.
 
 In a nutshell, element header and footer formatting function determines
 the button directions list to use and calls navigation header formatting.  The
@@ -4644,6 +4596,66 @@ formatting.
 All the formatting functions take a converter object as first argument.
 
 
+@node Advanced Navigation Panel Buttons Specification
+@section Advanced Navigation Panel Buttons Specification
+
+The button specification for simple headers customizations is a direction name
+string (@pxref{Simple Navigation Panel Customization}).  This is not the only
+way to specify how navigation panel buttons should be formatted.  Other
+possibilities involve functions that may be specified for more control
+other the buttons formatting.  The detailed description of the different
+possibilities for the array item values is the following:
+
+@anchor{Buttons Display}
+
+@table @emph
+@item string with a text direction
+If icons are not used, button is the @code{text} direction string.
+If icons are used, the button is an image whose file is determined by
+the value associated with the output unit direction in the @code{ACTIVE_ICONS}
+variable hash.  The button name is given as HTML attribute to have a textual
+description of the icon.  The button name corresponds to the
+@code{button} direction string in @emph{string} context.
+
+@item string with an output unit direction
+If icons are not used, the button is a link to the corresponding
+output unit whose text is the @code{text} direction string
+(@pxref{Direction Strings}), surrounded by @samp{[} and
+@samp{]}.
+
+@vindex ACTIVE_ICONS
+@vindex PASSIVE_ICONS
+@cindex Icons, in navigation buttons
+If icons are used, the button is an image whose file is determined by
+the value associated with the output unit direction in the
+@code{ACTIVE_ICONS} variable hash if the link leads to an output unit, or in 
the
+@code{PASSIVE_ICONS} variable hash if there is no output unit to link to.  If
+there is a link to the output unit, the icon links to that output unit.  The
+button name and button description are given as HTML attributes to
+have a textual description of the icon.  The corresponding strings
+correspond to the @code{button} direction string for the button name
+and the @code{description} for a more detailed description (@pxref{Direction
+Strings}).
+
+@item function reference
+The functions is called with one arguments, the converter object.
+The function should return two scalars, the button text and
+a boolean set if a delimiter is desired before the button.
+
+@item array reference of length 2
+Here, the first array item should be a an output unit direction,
+and the second array item a reference to a function.
+The function is called with three arguments, the converter object, the
+output unit direction and the source Texinfo tree element (possibly undef).
+The function should return two scalars, the button text and
+a boolean set if a delimiter is desired before the button.
+
+@end table
+
+No delimiter is printed before the first button.  Leading space buttons
+mixed with directions not found may be omitted of the navigation panel output.
+
+
 @node Navigation Panel Button Formatting
 @section Navigation Panel Button Formatting
 
diff --git a/tp/TODO b/tp/TODO
index f5f4b94424..2a54908521 100644
--- a/tp/TODO
+++ b/tp/TODO
@@ -24,21 +24,6 @@ htmlxrefinclude dir/*.conf
 Add an higher level HTML customization API for buttons:
 https://lists.gnu.org/archive/html/bug-texinfo/2025-01/msg00047.html
 
-Missing texi2any_api information (!!! Wait for the addition
- of the higher level HTML customization API for buttons described just above!!!
-* some information on how to practically modify buttons formatting
-  in "Simple Navigation Panel Customization".  For example
-    tp/t/init/t2h_buttons.pm
-    tp/t/init/redefined_buttons.pm
-    tp/t/init/t2h_singular.init (singular_banner)
-    tp/t/init/button_replacement_for_special_unit_direction.pm
-* some information on what to use in user-defined buttons formatting
-  functions that would link heavily to "Target Tree Element Link"
-  and a bit to "Navigation Panel Button Formatting" for direction_string,
-  $converter->global_direction_unit and from_element_direction.  For example
-    tp/t/init/t2h_singular.init (singular_banner)
-    tp/t/init/redefined_buttons.pm
-
 Show example of use of document API, for global_commands_information,
 for example, or global_information... ?
 



reply via email to

[Prev in Thread] Current Thread [Next in Thread]