--- Begin Message ---
|
Subject: |
Info Files Showing "see" or "*note" when using @ref in source |
|
Date: |
Fri, 16 Oct 2020 23:02:02 +0200 |
Dear Compeers,
I have the following references using @ref to Node Names
> > @* * @ref{Modifier-Keys}
> > @* * @ref{Key-Mnemonics}
But I have noticed that the output is as follows even though @ref
is not supposed to generate the "see" string when loading the info
file.
> > * see Modifier-Keys
> > * see Key-Mnemonics
Have read tne Emacs Documentation and found Info-hide-note-references.
It did not make any difference what value I used (t, nil, other). One
either gets "see" or "*note".
However for @ref one should not get anything precceding the reference name.
--- End Message ---
--- Begin Message ---
|
Subject: |
Re: bug#44043: Info Files Showing "see" or "*note" when using @ref in source |
|
Date: |
Sat, 17 Oct 2020 14:48:32 +0300 |
> From: Christopher Dimech <dimech@gmx.com>
> Cc: 44043@debbugs.gnu.org
> Date: Sat, 17 Oct 2020 12:47:17 +0200
>
> The Emacs Manual does not mention hide so did not try it. Now
> that I have, the problem is resolved. The Emacs Manual needs
> to be updated as the option is not described. It only describes
> "t" and "nil". Here are the sections concerned:
>
> 1.5 Invisible text in Emacs Info
> 1.7 Following Cross-References
> 2.6 Emacs Info-mode Variables
You mean, the Info mode manual, not the Emacs manual.
I fixed the last one of these 3 sections, as only it includes the full
description of the variable, and the other two only discuss limited
effects of the variable.
> Using M-x describe-variable <Ret> Info-hide-note-references,
> although if would help with an improved documentation.
Indeed, the doc string of a variable is the recommended place to look
first for the details of the variable. The manual could provide some
background and more elaborate info, but it could also completely
ignore the variable (we don't document every variable and every
function in our manuals).
With that, I'm closing this bug report. Thanks.
--- End Message ---