* bug#44043: Info Files Showing "see" or "*note" when using @ref in source
@ 2020-10-16 21:02 Christopher Dimech
2020-10-17 4:19 ` Richard Stallman
2020-10-17 7:26 ` Eli Zaretskii
0 siblings, 2 replies; 8+ messages in thread
From: Christopher Dimech @ 2020-10-16 21:02 UTC (permalink / raw)
To: 44043
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.
^ permalink raw reply [flat|nested] 8+ messages in thread* bug#44043: Info Files Showing "see" or "*note" when using @ref in source
2020-10-16 21:02 bug#44043: Info Files Showing "see" or "*note" when using @ref in source Christopher Dimech
@ 2020-10-17 4:19 ` Richard Stallman
2020-10-17 8:29 ` Eli Zaretskii
2020-10-17 7:26 ` Eli Zaretskii
1 sibling, 1 reply; 8+ messages in thread
From: Richard Stallman @ 2020-10-17 4:19 UTC (permalink / raw)
To: Christopher Dimech; +Cc: 44043
[[[ To any NSA and FBI agents reading my email: please consider ]]]
[[[ whether defending the US Constitution against all enemies, ]]]
[[[ foreign or domestic, requires you to follow Snowden's example. ]]]
It may be necessary to report this to bug-texinfo.
However, I don't know how much people are maintaining Texinfo now.
Would you like to help do that?
--
Dr Richard Stallman
Chief GNUisance of the GNU Project (https://gnu.org)
Founder, Free Software Foundation (https://fsf.org)
Internet Hall-of-Famer (https://internethalloffame.org)
^ permalink raw reply [flat|nested] 8+ messages in thread
* bug#44043: Info Files Showing "see" or "*note" when using @ref in source
2020-10-16 21:02 bug#44043: Info Files Showing "see" or "*note" when using @ref in source Christopher Dimech
2020-10-17 4:19 ` Richard Stallman
@ 2020-10-17 7:26 ` Eli Zaretskii
2020-10-17 10:47 ` Christopher Dimech
1 sibling, 1 reply; 8+ messages in thread
From: Eli Zaretskii @ 2020-10-17 7:26 UTC (permalink / raw)
To: Christopher Dimech; +Cc: 44043
> Date: Fri, 16 Oct 2020 23:02:02 +0200
> Sensitivity: Normal
>
> 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.
I cannot reproduce the problem: setting Info-hide-note-references to
the value 'hide removes the "*note" part and doesn't replace it with
"see".
Did you try the value 'hide?
^ permalink raw reply [flat|nested] 8+ messages in thread* bug#44043: Info Files Showing "see" or "*note" when using @ref in source
2020-10-17 7:26 ` Eli Zaretskii
@ 2020-10-17 10:47 ` Christopher Dimech
2020-10-17 11:48 ` Eli Zaretskii
0 siblings, 1 reply; 8+ messages in thread
From: Christopher Dimech @ 2020-10-17 10:47 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: 44043
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
Using M-x describe-variable <Ret> Info-hide-note-references,
although if would help with an improved documentation. I can
send an update to the documentation myself as I am currently
doing some documentation work in ELisp myself, and can have
a look at the manual.
Regards
Christopher
---------------------
Christopher Dimech
> Sent: Saturday, October 17, 2020 at 9:26 AM
> From: "Eli Zaretskii" <eliz@gnu.org>
> To: "Christopher Dimech" <dimech@gmx.com>
> Cc: 44043@debbugs.gnu.org
> Subject: Re: bug#44043: Info Files Showing "see" or "*note" when using @ref in source
>
> > Date: Fri, 16 Oct 2020 23:02:02 +0200
> > Sensitivity: Normal
> >
> > 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.
>
> I cannot reproduce the problem: setting Info-hide-note-references to
> the value 'hide removes the "*note" part and doesn't replace it with
> "see".
>
> Did you try the value 'hide?
>
^ permalink raw reply [flat|nested] 8+ messages in thread* bug#44043: Info Files Showing "see" or "*note" when using @ref in source
2020-10-17 10:47 ` Christopher Dimech
@ 2020-10-17 11:48 ` Eli Zaretskii
2020-10-17 12:40 ` Christopher Dimech
0 siblings, 1 reply; 8+ messages in thread
From: Eli Zaretskii @ 2020-10-17 11:48 UTC (permalink / raw)
To: Christopher Dimech; +Cc: 44043-done
> 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.
^ permalink raw reply [flat|nested] 8+ messages in thread
* bug#44043: Info Files Showing "see" or "*note" when using @ref in source
2020-10-17 11:48 ` Eli Zaretskii
@ 2020-10-17 12:40 ` Christopher Dimech
2020-10-17 12:53 ` Eli Zaretskii
0 siblings, 1 reply; 8+ messages in thread
From: Christopher Dimech @ 2020-10-17 12:40 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: 44043-done
Yes, in the manual it can ignore the variable and not document every single
thing, but when a defaulted variable changes the output of what is expected
from the official texinfo behaviour, some documentation is required, as it
was. Simply involved a little update, and a bit more clarity in description.
Regards
Christopher
---------------------
Christopher Dimech
Administrator - Naiad Informatics - GNU Project (Geocomputation)
- Geophysical Simulation
- Geological Subsurface Mapping
- Disaster Preparedness and Mitigation
- Natural Resource Exploration and Production
- Free Software Advocacy
> Sent: Saturday, October 17, 2020 at 1:48 PM
> From: "Eli Zaretskii" <eliz@gnu.org>
> To: "Christopher Dimech" <dimech@gmx.com>
> Cc: 44043-done@debbugs.gnu.org
> Subject: Re: bug#44043: Info Files Showing "see" or "*note" when using @ref in source
>
> > 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.
>
^ permalink raw reply [flat|nested] 8+ messages in thread
* bug#44043: Info Files Showing "see" or "*note" when using @ref in source
2020-10-17 12:40 ` Christopher Dimech
@ 2020-10-17 12:53 ` Eli Zaretskii
0 siblings, 0 replies; 8+ messages in thread
From: Eli Zaretskii @ 2020-10-17 12:53 UTC (permalink / raw)
To: Christopher Dimech; +Cc: 44043
> From: Christopher Dimech <dimech@gmx.com>
> Cc: 44043-done@debbugs.gnu.org
> Date: Sat, 17 Oct 2020 14:40:11 +0200
>
> Yes, in the manual it can ignore the variable and not document every single
> thing, but when a defaulted variable changes the output of what is expected
> from the official texinfo behaviour, some documentation is required, as it
> was. Simply involved a little update, and a bit more clarity in description.
I did clarify the manual.
^ permalink raw reply [flat|nested] 8+ messages in thread
end of thread, other threads:[~2020-10-17 12:53 UTC | newest]
Thread overview: 8+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2020-10-16 21:02 bug#44043: Info Files Showing "see" or "*note" when using @ref in source Christopher Dimech
2020-10-17 4:19 ` Richard Stallman
2020-10-17 8:29 ` Eli Zaretskii
2020-10-17 7:26 ` Eli Zaretskii
2020-10-17 10:47 ` Christopher Dimech
2020-10-17 11:48 ` Eli Zaretskii
2020-10-17 12:40 ` Christopher Dimech
2020-10-17 12:53 ` Eli Zaretskii
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).