branch master updated: * doc/texi2any_api.texi (Customizing Footnotes@comma{} Tables of Contents and About, Special Element Body Formatting Functions): merge 'Common Customization of Special Elements' in 'Customizing Footnotes@comma{} Tables of Contents and About'.

[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 b0224e93b8 * doc/texi2any_api.texi (Customizing Footnotes@comma{} 
Tables of Contents and About, Special Element Body Formatting Functions): merge 
'Common Customization of Special Elements' in 'Customizing Footnotes@comma{} 
Tables of Contents and About'.
b0224e93b8 is described below

commit b0224e93b8573bf11090c47b6e00ff580e96afe7
Author: Patrice Dumas <pertusus@free.fr>
AuthorDate: Thu Nov 10 08:28:33 2022 +0100

    * doc/texi2any_api.texi (Customizing Footnotes@comma{} Tables of
    Contents and About, Special Element Body Formatting Functions):
    merge 'Common Customization of Special Elements' in 'Customizing
    Footnotes@comma{} Tables of Contents and About'.
---
 ChangeLog             |   7 +++
 doc/texi2any_api.texi | 150 +++++++++++++++++++++++++-------------------------
 2 files changed, 83 insertions(+), 74 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 3cf0501023..792be4c55d 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2022-11-10  Patrice Dumas  <pertusus@free.fr>
+
+       * doc/texi2any_api.texi (Customizing Footnotes@comma{} Tables of
+       Contents and About, Special Element Body Formatting Functions):
+       merge 'Common Customization of Special Elements' in 'Customizing
+       Footnotes@comma{} Tables of Contents and About'.
+
 2022-11-09  Patrice Dumas  <pertusus@free.fr>
 
        * tp/Texinfo/Convert/HTML.pm (_convert_printindex_command): put
diff --git a/doc/texi2any_api.texi b/doc/texi2any_api.texi
index d1a027b0ec..5ca208dde5 100644
--- a/doc/texi2any_api.texi
+++ b/doc/texi2any_api.texi
@@ -3382,13 +3382,15 @@ Return the total number of element units associated 
with the file.
 @end deftypefun
 
 
-@node Common Customization of Special Elements
-@chapter Common Customization of Special Elements
+@node Customizing Footnotes@comma{} Tables of Contents and About
+@chapter Customizing Footnotes, Tables of Contents and About
 
-Some customization is relevant for all the special elements
-(@pxref{Output Element Units}).  The formatting of special elements bodies
-is also handled the same for all the special elements formatted as separate
-elements (@pxref{Output Element Units}).
+Some customization is specific for the different cases, especially when
+the formatting is not done in a separate document unit (@pxref{Output Element 
Units}),
+but some customization is relevant for all the special elements.
+The formatting of special elements bodies
+is handled the same for all the special elements, when formatted as separate
+elements.
 To specify a special element in those contexts, the special elements varieties
 are used, as described in
 @ref{Special Elements Varieties}.
@@ -3468,74 +3470,6 @@ for @samp{heading_tree}.
 @end deftypefun
 
 
-@node Special Element Body Formatting Functions
-@section Special Element Body Formatting Functions
-
-To register body formating user defined functions for special element
-(@pxref{Output Element Units}), the special elements varieties are used, as
-described in @ref{Special Elements Varieties}.
-Special element body formatting user defined functions are registered with
-@code{texinfo_register_formatting_special_element_body}:
-
-@defun texinfo_register_formatting_special_element_body 
($special_element_variety, @
-                            \@ampchar{}handler)
-@var{$special_element_variety} is the element variety
-(@pxref{Special Elements Varieties}).  @var{\&handler} is the user defined
-function reference.
-@end defun
-
-The call of the user defined functions is:
-@deftypefn {Function Reference} @var{$text} special_element_body 
(@var{$converter}, @
-                                @var{$special_element_variety}, 
@var{\%element})
-@var{$converter} is a converter object. @var{$special_element_variety} is the
-element variety.  @var{\%element} is the Texinfo element.
-
-The @var{$text} returned is the formatted special element body.
-@end deftypefn
-
-To call a special element body formatting function from user defined code, the
-function reference should first be retrieved using
-@code{special_element_body_formatting}:
-
-@deftypefun {@var{\&special_element_body_formatting} =} 
@var{$converter}->special_element_body_formatting @
-                                              (@var{$special_element_variety})
-@var{$special_element_variety} is the special element variety.  Returns the
-conversion function reference for @var{$variety}, or @samp{undef} if there is 
none,
-which should not happen for the special elements described in this manual.
-@end deftypefun
-
-For example:
-@example
-@group
-my $footnotes_element_body
- = &@{$converter->special_element_body_formatting('footnotes')@}(
-                                   $converter, 'footnotes', $element);
-@end group
-@end example
-
-It is possible to have access to the default conversion function reference.
-The function used is:
-
-@deftypefun {@var{\&default_special_element_body_formatting} =} @
-               @var{$converter}->defaults_special_element_body_formatting @
-                                               (@var{$special_element_variety})
-@var{$special_element_variety} is the special element variety.  Returns the
-default conversion function reference for @var{$special_element_variety}, or
-@code{undef} if there is none, which should not happen for the special elements
-described in this manual.
-@end deftypefun
-
-@xref{Customizing Footnotes} for more on footnotes
-formatting.  @xref{Contents and Short Table of Contents Customization}
-for more on the @code{contents} and @code{shortcontents} formatting.
-@xref{About Element Customization} for more on the @code{about} special
-element body formatting.
-
-
-@node Customizing Footnotes@comma{} Tables of Contents and About
-@chapter Customizing Footnotes, Tables of Contents and About
-
-
 @node Customizing Footnotes
 @section Customizing Footnotes
 
@@ -3731,6 +3665,74 @@ formatting of the about element, the @code{about} 
special element body reference
 function may be overridden (@pxref{Special Element Body Formatting Functions}).
 
 
+@node Special Element Body Formatting Functions
+@section Special Element Body Formatting Functions
+
+In addition to the formatting possibilities available with the default
+special element formatting presented previously, it is also possible
+to control completely how a separate special element is formatted.
+
+To register body formating user defined functions for special element
+(@pxref{Output Element Units}), the special elements varieties are used, as
+described in @ref{Special Elements Varieties}.
+Special element body formatting user defined functions are registered with
+@code{texinfo_register_formatting_special_element_body}:
+
+@defun texinfo_register_formatting_special_element_body 
($special_element_variety, @
+                            \@ampchar{}handler)
+@var{$special_element_variety} is the element variety
+(@pxref{Special Elements Varieties}).  @var{\&handler} is the user defined
+function reference.
+@end defun
+
+The call of the user defined functions is:
+@deftypefn {Function Reference} @var{$text} special_element_body 
(@var{$converter}, @
+                                @var{$special_element_variety}, 
@var{\%element})
+@var{$converter} is a converter object. @var{$special_element_variety} is the
+element variety.  @var{\%element} is the Texinfo element.
+
+The @var{$text} returned is the formatted special element body.
+@end deftypefn
+
+To call a special element body formatting function from user defined code, the
+function reference should first be retrieved using
+@code{special_element_body_formatting}:
+
+@deftypefun {@var{\&special_element_body_formatting} =} 
@var{$converter}->special_element_body_formatting @
+                                              (@var{$special_element_variety})
+@var{$special_element_variety} is the special element variety.  Returns the
+conversion function reference for @var{$variety}, or @samp{undef} if there is 
none,
+which should not happen for the special elements described in this manual.
+@end deftypefun
+
+For example:
+@example
+@group
+my $footnotes_element_body
+ = &@{$converter->special_element_body_formatting('footnotes')@}(
+                                   $converter, 'footnotes', $element);
+@end group
+@end example
+
+It is possible to have access to the default conversion function reference.
+The function used is:
+
+@deftypefun {@var{\&default_special_element_body_formatting} =} @
+               @var{$converter}->defaults_special_element_body_formatting @
+                                               (@var{$special_element_variety})
+@var{$special_element_variety} is the special element variety.  Returns the
+default conversion function reference for @var{$special_element_variety}, or
+@code{undef} if there is none, which should not happen for the special elements
+described in this manual.
+@end deftypefun
+
+@xref{Customizing Footnotes} for more on footnotes
+formatting.  @xref{Contents and Short Table of Contents Customization}
+for more on the @code{contents} and @code{shortcontents} formatting.
+@xref{About Element Customization} for more on the @code{about} special
+element body formatting.
+
+
 @node Customizing HTML Footers@comma{} Headers and Navigation Panels
 @chapter Customizing HTML Footers, Headers and Navigation Panels