branch master updated: * doc/texi2any_api.texi (Simple Navigation Panel Customization): the boolean set by button formatting function specifies that a delimiter is desired before the button. Also update the description of the functions arguments.

[Patrice Dumas]

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 31bda6735c * doc/texi2any_api.texi (Simple Navigation Panel 
Customization): the boolean set by button formatting function specifies that a 
delimiter is desired before the button.  Also update the description of the 
functions arguments.
31bda6735c is described below

commit 31bda6735c99b3be48fda6eaa435e6736bc55924
Author: Patrice Dumas <pertusus@free.fr>
AuthorDate: Wed Aug 28 11:07:11 2024 +0200

    * doc/texi2any_api.texi (Simple Navigation Panel Customization): the
    boolean set by button formatting function specifies that a delimiter
    is desired before the button.  Also update the description of the
    functions arguments.
---
 ChangeLog             |  7 +++++++
 doc/texi2any_api.texi | 25 +++++++++++++------------
 2 files changed, 20 insertions(+), 12 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index cea2e614e9..67d0a5042e 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2024-08-28  Patrice Dumas  <pertusus@free.fr>
+
+       * doc/texi2any_api.texi (Simple Navigation Panel Customization): the
+       boolean set by button formatting function specifies that a delimiter
+       is desired before the button.  Also update the description of the
+       functions arguments.
+
 2024-08-26  Patrice Dumas  <pertusus@free.fr>
 
        * tp/texi2any.pl (%converter_format_expanded_region_name)
diff --git a/doc/texi2any_api.texi b/doc/texi2any_api.texi
index 5904623cbd..7696263448 100644
--- a/doc/texi2any_api.texi
+++ b/doc/texi2any_api.texi
@@ -1196,26 +1196,27 @@ and the @code{description} for a more detailed 
description (@pxref{Direction
 Strings}).
 
 @item function reference
-The function is called with one boolean argument, true if the
-navigation panel should be vertical.  Should return the formatted
-button text.
+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 scalar reference
 The scalar value is printed.
 
 @item array reference of length 2
 Here, the first array item should be a an output unit direction.
-A link to the output unit associated with the output unit direction
-is generated.  The text of the link depends on the second array item.
+The text of the link depends on the second array item.
 
 @table @emph
 @item reference to a text string
-In that case, the corresponding text is used.
+A link to the output unit associated with the output unit direction
+is generated with the corresponding text used for the text link.
 
 @item reference to a function
-The functions is called with two arguments, the converter object and the
-output unit direction and should return two scalars, the link href and text and
-a boolean set if a delimiter is needed after that button.
+The functions 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.
 
 @c This buttons specification is not used anywhere in code nor
 @c tests, it is certainly not worth maintaining in the long run.
@@ -1240,6 +1241,9 @@ based on the name of the node associated with the next 
section output unit.
 
 @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.
+
 @vindex USE_ACCESSKEY
 @anchor{Accesskey and @code{rel} Navigation}
 @cindex @code{accesskey} navigation
@@ -1255,9 +1259,6 @@ the @code{rel} attribute is used in navigation.  In that 
case the
 @code{rel} direction string is used for the @code{rel}
 attribute (@pxref{Direction Strings}).
 
-Leading space buttons mixed with directions not found may be omitted
-of the navigation panel output.
-
 
 @node User Defined Functions
 @chapter User Defined Functions