From 2e1f604c0923d39bbbc9314903622b92b3118830 Mon Sep 17 00:00:00 2001 From: Dieter Wilhelm Date: Mon, 23 Jan 2023 21:13:54 +0100 Subject: [PATCH] Documentation of Info providing buttons on quoted symbols (bug#60587) *etc/NEWS: Mention implementation *doc/emacs/help.texi: Describe implementation and how to switch off button creation --- doc/emacs/help.texi | 13 +++++++++++++ etc/NEWS | 11 +++++++++++ 2 files changed, 24 insertions(+) diff --git a/doc/emacs/help.texi b/doc/emacs/help.texi index 2513e6be271..02b8962c360 100644 --- a/doc/emacs/help.texi +++ b/doc/emacs/help.texi @@ -653,6 +653,19 @@ Misc Help K @var{key}}, described above, enter Info and go straight to the documentation of @var{function} or @var{key}. + In Info buffers quoted symbol names are made into buttons which show +the symbols' help documentation when typing @key{RET} or clicking +@kbd{mouse-2} or @kbd{mouse-1} on it. 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. Such quoted symbols (variables, functions and +face names) are highlighted by a distinct face and can be reached, as +the Info manual references, with @key{TAB} and @kbd{S-Tab}. + +@vindex info-make-xref-flag + If you want to prohibit the button creation for Info buffers, you +can set @code{info-make-xref-flag} to @code{nil}. + @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..c55d39baf0c 100644 --- a/etc/NEWS +++ b/etc/NEWS @@ -195,6 +195,17 @@ 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 + ++++ +*** Info-mode provides buttons on symbols showing their documentation string. +Quoted `symbols', like names of variables, functions or face names, +are made into buttons which can display the respective documentation +strings. These strings are presented in *Help* buffers in another +window. Such buttons are working independently of the regular Info +cross references and can be disabled with setting +`info-make-xref-flag' to nil. + * New Modes and Packages in Emacs 30.1 -- 2.34.1