bug-texinfo
[Top][All Lists]
Advanced

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

organization of the documentation of customization variables


From: Patrice Dumas
Subject: organization of the documentation of customization variables
Date: Sat, 16 Mar 2024 15:53:45 +0100

Hello,

In a recent thread, on help-texinfo, Eli raised valid concerns on the
documentation of customization variables of texi2any, see for example:
https://lists.gnu.org/archive/html/help-texinfo/2024-03/msg00014.html

The current situation is that in the main Texinfo manual most of the
customization variables are simply presented in a list, like a
reference, not in a way that makes it easy to use them, as a tutorial
with logical groupings and background information.  In the texi2any_api
manual, the customization variables are presented in a more pedagogical
manner, but, for now, only for some variables, and the explanation of
the variables use appear in sections that may also cover some advanced
way of customizating texi2any HTML output that require knowledge of
Perl.

I think that we should decide on how the customization variables
documentation should be organized.  I think that we should keep some
reference lists in the main Texinfo manual.  But I also think that we
should make a choice regarding a pedagogical/tutorial-oriented
documentation of the customization variable, with two options (there may
be more, please add some if you have ideas):
1) document customization variables in the texi2any_api manual even
   though it will be mixed with more advanced customization which
   requires perl code
2) add sections presenting customization of texi2any output with
   customization variables in the main Texinfo manual presented in a
   tutorial fashion and remove the corresponding existing documentation
   from the texi2any_api manual.

What do you think?

-- 
Pat



reply via email to

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