From: "H. Dieter Wilhelm" <dieter@duenenhof-wilhelm.de>
To: Drew Adams <drew.adams@oracle.com>
Cc: Eli Zaretskii <eliz@gnu.org>,
"60587@debbugs.gnu.org" <60587@debbugs.gnu.org>,
"monnier@iro.umontreal.ca" <monnier@iro.umontreal.ca>
Subject: bug#60587: Patch for adding links to symbols' help documentation
Date: Fri, 27 Jan 2023 22:35:52 +0100 [thread overview]
Message-ID: <86h6wboe2v.fsf@duenenhof-wilhelm.de> (raw)
In-Reply-To: <SJ0PR10MB5488158A958BDCEC06A4AF8CF3CE9@SJ0PR10MB5488.namprd10.prod.outlook.com> (Drew Adams's message of "Wed, 25 Jan 2023 22:24:24 +0000")
Hi Drew
Thank you for your ideas!
Drew Adams <drew.adams@oracle.com> writes:
> 1.
> + :type '(choice (const :tag "Create links" t)
> + (const :tag "Do not link" nil))
>
> is better as just :type 'boolean, and say in the
> doc which Boolean value means which behavior.
The doc string says now:
"True (`t') means Emacs creates symbol link buttons in Info.
Setting this variable to `nil' inhibits the creation of buttons
on quoted symbols to their help strings. Please see the function
`info-make-xrefs' for further details."
> 2.
> +;; Toggle on or off the linking to help documents
> +(when info-make-xref-flag
> + (add-hook 'Info-selection-hook 'info-make-xrefs))
Yes, the above is rather crude.
> Instead of putting it on the hook when loading the
> code, add/remove it in a :set function. E.g.
> (untested):
>
> :set (lambda (sym defs)
> (custom-set-default sym defs)
> (let ((fun (if info-make-xref-flag
> #'add-hook
> #'remove-hook)))
> (funcall fun 'Info-selection-hook
> 'info-make-xrefs)))
It works nicely and I put this setter in `info-make-xref-flag'. :-)
> 3. Maybe add a toggle command for the option, so users can switch the
> behavior anytime, on the fly.
Like this?
;; TODO: add this toggle in info documentation and NEWS
;; TODO: remove and create buttons in current info buffer
(defun info-toggle-make-xrefs ()
"Toggle creating Info buttons."
(interactive)
(if (memq 'info-make-xrefs Info-selection-hook)
(remove-hook 'Info-selection-hook 'info-make-xrefs)
(add-hook 'Info-selection-hook 'info-make-xrefs)
(message "Create Info link buttons to symbol names.")))
> 4. Or instead of having an option, maybe just have
> a minor mode.
That's also a nice idea. (Maybe for later.)
> 5. Face `info-color' should be named something like
> `info-symbol-help-link'.
You're right, `info-color' is too minimalist and not describing what the
object represents.
(I dropped it completely because I realised an additional face is
redundant since Info distinguishes (slightly) quoted symbols from the
text, anyway.)
> 6. "clicking @kbd{mouse-2} or @kbd{mouse-1} on it"
> can't be right, I think. At least that doesn't
> express what `mouse-1-follows-link' does/means.
Do you mean that I should just say mouse-2, because
`mouse-1-click-follows-link' regulates it anyhow? (E.g. I realised that
Emacs changes my documentation string for the tooltips
'help-echo (purecopy "mouse-2, RET: describe this variable"))
from mouse-2 to mouse-1!)
> 7. Again, I think it's unhelpful to call these
> links "buttons". Especially since Info docs call
> Info links "links". That these links show their
> destination in another window isn't a reason to
> call them something different (and with no
> definition of the additional term "button").
To make the confusion complete: Info documentations calls (Info) links
also cross-references. ;-)
(info "(info)Help-Xref")
Thanks again
Dieter
--
Best wishes
H. Dieter Wilhelm
Zwingenberg, Germany
next prev parent reply other threads:[~2023-01-27 21:35 UTC|newest]
Thread overview: 58+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-01-05 23:47 bug#60587: 30.0.50; Info pages are lacking links from symbol names to the symbol's help documentation H. Dieter Wilhelm
2023-01-06 19:03 ` bug#60587: Patch for adding links to symbols' " H. Dieter Wilhelm
2023-01-07 7:38 ` Eli Zaretskii
2023-01-08 20:06 ` H. Dieter Wilhelm
2023-01-09 12:46 ` Eli Zaretskii
2023-01-09 14:25 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-01-09 20:01 ` H. Dieter Wilhelm
2023-01-13 23:33 ` H. Dieter Wilhelm
2023-01-14 7:12 ` Eli Zaretskii
2023-01-15 12:48 ` H. Dieter Wilhelm
2023-01-17 21:53 ` H. Dieter Wilhelm
2023-01-18 13:20 ` Eli Zaretskii
2023-01-20 21:09 ` H. Dieter Wilhelm
2023-01-20 21:59 ` Drew Adams
2023-01-20 23:32 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-01-22 13:00 ` H. Dieter Wilhelm
2023-01-21 8:21 ` Eli Zaretskii
2023-01-21 20:27 ` H. Dieter Wilhelm
2023-01-22 6:00 ` Eli Zaretskii
2023-01-22 22:09 ` Drew Adams
2023-01-23 12:14 ` Eli Zaretskii
2023-01-23 16:16 ` Drew Adams
2023-01-25 21:29 ` H. Dieter Wilhelm
2023-01-25 22:24 ` Drew Adams
2023-01-26 10:29 ` Ihor Radchenko
2023-01-26 15:06 ` Drew Adams
2023-01-26 15:12 ` Ihor Radchenko
2023-01-26 15:23 ` Drew Adams
2023-01-27 21:35 ` H. Dieter Wilhelm [this message]
2023-01-27 22:12 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-01-27 23:09 ` Drew Adams
2023-01-27 23:13 ` Drew Adams
2023-01-28 8:11 ` Eli Zaretskii
2023-01-28 17:30 ` Drew Adams
2023-02-01 22:09 ` H. Dieter Wilhelm
2023-02-02 2:30 ` Drew Adams
2023-02-05 0:48 ` H. Dieter Wilhelm
2023-02-05 3:54 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-02-05 13:54 ` H. Dieter Wilhelm
2023-02-06 21:04 ` H. Dieter Wilhelm
2023-02-12 11:04 ` H. Dieter Wilhelm
2023-02-14 20:56 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-02-15 22:18 ` H. Dieter Wilhelm
2023-02-16 3:08 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-02-20 23:53 ` H. Dieter Wilhelm
2023-02-21 2:12 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-03-01 21:45 ` H. Dieter Wilhelm
2023-03-11 8:32 ` Eli Zaretskii
2023-03-11 9:16 ` H. Dieter Wilhelm
2023-02-15 5:17 ` Richard Stallman
2023-02-15 9:53 ` Gregory Heytings
2023-02-15 13:42 ` Gregory Heytings
2023-01-26 10:37 ` Eli Zaretskii
2023-01-27 7:45 ` Juri Linkov
2023-01-27 8:11 ` Eli Zaretskii
2023-01-27 22:21 ` H. Dieter Wilhelm
2023-01-28 7:51 ` Eli Zaretskii
2023-02-01 21:26 ` H. Dieter Wilhelm
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=86h6wboe2v.fsf@duenenhof-wilhelm.de \
--to=dieter@duenenhof-wilhelm.de \
--cc=60587@debbugs.gnu.org \
--cc=drew.adams@oracle.com \
--cc=eliz@gnu.org \
--cc=monnier@iro.umontreal.ca \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).