bug-texinfo
[Top][All Lists]
Advanced

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

allow : in node names is an implemented feature, not an idea that won't


From: Patrice Dumas
Subject: allow : in node names is an implemented feature, not an idea that won't be implemented
Date: Mon, 15 Aug 2022 11:52:53 +0200

Hello,

In the TODO file, there is

* Ideas that will not be implemented:

- Allow : in node names for info files, for names such as
  `class::method'.  Likewise index entries.  A quoting mechanism
  with DEL characters was implemented, but it is simpler to avoid :
  altogether in node names and support : in index entries by changing
  the interpretation of index nodes slightly.  See
  https://lists.gnu.org/archive/html/bug-gnu-emacs/2019-01/msg00235.html

I think that it is wrong to put that entry in "ideas that will not be
implemented", since it has been implemented in texi2any and in the
standalone info reader.  Also it seems to me to be a much needed feature
for Info.  It is required by pod2texi output, or any perl package
documentation.  It is in particular needed for the Texinfo modules
documentation (that is actually generated by pod2texi) and consequently
by the HTML customization API which refers a lot to the Texinfo modules
documentation.

I would suggest simply removing this entry from the TODO file as it is
done.  The part on index entries could be kept until the bug referred to
is closed.

In addition, in my opinion, INFO_SPECIAL_CHARS_QUOTE should be set in
the default case.  The resulting node names are not usable, so it does
not matter if they have ^? appearing here and there.  It could even be
considered a good thing as it points that either the manual or the
reader should be fixed.

I also think that it should be reported to the Emacs developpers that it
should be implemented in the Emacs Info reader, if it is not already
done.  I can do a bug report, but I do not use Emacs myself.  A test
info file can be obtained from the Texinfo development source:

 cd doc/tp_api
 make info

The resulting tp_api.info file uses extensively node name quoting.

Anybody willing to report the issue to Emacs Info reader developpers?

-- 
Pat



reply via email to

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