[no subject]

[Patrice Dumas]

branch: master
commit eb4fa7d25a3eea4796e42e86da17669388e5a8d3
Author: Patrice Dumas <pertusus@free.fr>
AuthorDate: Wed Nov 2 08:56:01 2022 +0100

    * doc/texi2any_api.texi (Simple Navigation Panel Customization):
    describe ACTIVE_ICONS and PASSIVE_ICONS more explicitely.
---
 ChangeLog                  |  5 +++++
 doc/texi2any_api.texi      | 18 ++++++++++++++++--
 tp/Texinfo/Common.pm       |  6 ++++--
 tp/Texinfo/Convert/HTML.pm |  1 -
 4 files changed, 25 insertions(+), 5 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 6e8a0786e1..9835759fe6 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2022-11-02  Patrice Dumas  <pertusus@free.fr>
+
+       * doc/texi2any_api.texi (Simple Navigation Panel Customization):
+       describe ACTIVE_ICONS and PASSIVE_ICONS more explicitely.
+
 2022-11-02  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 fc0bd539be..78e0afc8b5 100644
--- a/doc/texi2any_api.texi
+++ b/doc/texi2any_api.texi
@@ -1077,6 +1077,20 @@ The customization variables
 may be used to change the navigation panel formatting.
 @xref{HTML Customization Variables,,, texinfo, Texinfo}.
 
+Setting @code{ICONS} is necessary but not sufficient to get icons for direction
+buttons since no button image is specified in the default case.
+The @code{ACTIVE_ICONS} and @code{PASSIVE_ICONS} customization
+variables need to be set in addition:
+
+@vtable @code
+@item ACTIVE_ICONS
+@itemx PASSIVE_ICONS
+Hash references with element directions as key (@pxref{Directions}) and button
+image icons as values.  @code{ACTIVE_ICONS} is used for directions actually
+linking to an element, and @code{PASSIVE_ICONS} are used if there is no
+element to link to.  The button images are interpreted as URLs.
+@end vtable
+
 @cindex Navigation panel button specification
 @cindex Button specification, navigation panel
 
@@ -1703,7 +1717,7 @@ as keys and with array references as values.  The array 
references contain
 information on each of the file licences, with content
 @enumerate
 @item licence name
-@item license url
+@item license URL
 @item file name or source of file
 @end enumerate
 
@@ -2117,7 +2131,7 @@ The Texinfo tree element corresponding to the argument.
 @item url
 Similar with monospacetext.  The difference is that UTF-8 encoding is always
 used for the conversion of accented and special insertion @@-commands to plain
-text.  This is best for percent encoding of url, which should always be
+text.  This is best for percent encoding of URLs, which should always be
 produced from UTF-8 encoded strings.
 
 @end table
diff --git a/tp/Texinfo/Common.pm b/tp/Texinfo/Common.pm
index 59c2e6d0e3..7e107c06fc 100644
--- a/tp/Texinfo/Common.pm
+++ b/tp/Texinfo/Common.pm
@@ -431,14 +431,16 @@ our @variable_string_settables = (
 'XREF_USE_NODE_NAME_ARG',
 );
 
-# Not strings.  Documented in the texi2any_api manual
+# Not strings.
 my @variable_other_settables = (
+  # Documented in the texi2any_api manual
   'LINKS_BUTTONS', 'TOP_BUTTONS', 'SECTION_BUTTONS',
   'CHAPTER_FOOTER_BUTTONS', 'SECTION_FOOTER_BUTTONS',
   'NODE_FOOTER_BUTTONS',
   'MISC_BUTTONS', 'CHAPTER_BUTTONS',
   'ACTIVE_ICONS', 'PASSIVE_ICONS',
-  # set from command line
+  # set from command line.
+  # TODO not documented.
   'CSS_FILES',            # --css-include
   'CSS_REFS',             # --css-ref
   'EXPANDED_FORMATS',     # --if*
diff --git a/tp/Texinfo/Convert/HTML.pm b/tp/Texinfo/Convert/HTML.pm
index 3e94febe60..5d55d2665c 100644
--- a/tp/Texinfo/Convert/HTML.pm
+++ b/tp/Texinfo/Convert/HTML.pm
@@ -3566,7 +3566,6 @@ sub _default_format_button($$;$)
         and defined($self->get_conf('ACTIVE_ICONS')->{$button})
         and $self->get_conf('ACTIVE_ICONS')->{$button} ne '') {
       my $button_name_string = $self->direction_string($button, 'button', 
'string');
-      # FIXME button_name used in string context
       $active = &{$self->formatting_function('format_button_icon_img')}($self,
                         $button_name_string, 
$self->get_conf('ACTIVE_ICONS')->{' '});
     } else {