From 963e018503b7e1703480c527d48c2b119842f8f0 Mon Sep 17 00:00:00 2001 From: Dieter Wilhelm Date: Wed, 1 Feb 2023 22:01:19 +0100 Subject: [PATCH] Documentation of Info providing buttons on quoted symbols (bug#60587) * doc/emacs/help.texi * etc/NEWS --- doc/emacs/help.texi | 15 +++++++++++++++ etc/NEWS | 10 ++++++++++ 2 files changed, 25 insertions(+) diff --git a/doc/emacs/help.texi b/doc/emacs/help.texi index 2513e6be271..8aeb4068319 100644 --- a/doc/emacs/help.texi +++ b/doc/emacs/help.texi @@ -653,6 +653,21 @@ Misc Help K @var{key}}, described above, enter Info and go straight to the documentation of @var{function} or @var{key}. +@vindex info-button-mode + The minor mode @code{info-button-mode} makes quoted symbol names +into buttons which show the symbols' documentation string when typing +@key{RET} or clicking the mouse (@pxref{Mouse References}). For +example, the quoted name @code{info-other-window} is made into a +button which shows the function's documentation string in another +window, in the @file{*Help*} buffer. Info highlights such quoted +symbols (variables, functions and face names) by a distinct face and +these can be reached, as regular Info manual references, with +@key{TAB} and @kbd{S-Tab}. + + If you want to remove these buttons, you can toggle the mode with +typing @kbd{M-x info-button-mode} or deactivating it with +@code{(info-button-mode -1)} in Emacs' initialisation file. + @kindex C-h S @findex info-lookup-symbol When editing a program, if you have an Info version of the manual diff --git a/etc/NEWS b/etc/NEWS index 5b8ab06086c..96637797358 100644 --- a/etc/NEWS +++ b/etc/NEWS @@ -195,6 +195,16 @@ This command adds a docstring comment to the current defun. If a comment already exists, point is only moved to the comment. It is bound to 'C-c C-d' in 'go-ts-mode'. +** Info + ++++ +*** New minor mode 'info-button-mode' +This mode provides buttons on symbols showing their documentation +string in *Help* buffers (in another window) when typing `RET' or +clicking `mouse-2'. These buttons are working independently of the +regular Info cross references and can be toggled with `M-x +info-button-mode' or disabled with `(info-button-mode -1)'. + * New Modes and Packages in Emacs 30.1 -- 2.34.1