From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: "H. Dieter Wilhelm" Newsgroups: gmane.emacs.bugs Subject: bug#60587: Patch for adding links to symbols' help documentation Date: Fri, 20 Jan 2023 22:09:03 +0100 Message-ID: <864jskx6a8.fsf@duenenhof-wilhelm.de> References: <86y1qgr1bf.fsf@duenenhof-wilhelm.de> <86tu13qydg.fsf@duenenhof-wilhelm.de> <83h6x2u74b.fsf@gnu.org> <863588rfos.fsf@duenenhof-wilhelm.de> <83o7qw0yjy.fsf@gnu.org> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="9099"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Cc: 60587@debbugs.gnu.org, monnier@iro.umontreal.ca To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Fri Jan 20 22:10:19 2023 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1pIyeQ-0002CO-Or for geb-bug-gnu-emacs@m.gmane-mx.org; Fri, 20 Jan 2023 22:10:18 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pIyeD-0007Rh-Kc; Fri, 20 Jan 2023 16:10:05 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pIyeB-0007RQ-B8 for bug-gnu-emacs@gnu.org; Fri, 20 Jan 2023 16:10:03 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pIyeA-0002PU-Rs for bug-gnu-emacs@gnu.org; Fri, 20 Jan 2023 16:10:03 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pIyeA-0002hk-FJ for bug-gnu-emacs@gnu.org; Fri, 20 Jan 2023 16:10:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: "H. Dieter Wilhelm" Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 20 Jan 2023 21:10:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 60587 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 60587-submit@debbugs.gnu.org id=B60587.167424895810338 (code B ref 60587); Fri, 20 Jan 2023 21:10:02 +0000 Original-Received: (at 60587) by debbugs.gnu.org; 20 Jan 2023 21:09:18 +0000 Original-Received: from localhost ([127.0.0.1]:47294 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pIydR-0002gf-Td for submit@debbugs.gnu.org; Fri, 20 Jan 2023 16:09:18 -0500 Original-Received: from mout.kundenserver.de ([212.227.126.133]:55467) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pIydO-0002gQ-Vt for 60587@debbugs.gnu.org; Fri, 20 Jan 2023 16:09:16 -0500 Original-Received: from ping ([109.250.146.179]) by mrelayeu.kundenserver.de (mreue010 [212.227.15.167]) with ESMTPSA (Nemesis) id 1MeTkC-1ol1KG3LcK-00aXrm; Fri, 20 Jan 2023 22:09:04 +0100 In-Reply-To: <83o7qw0yjy.fsf@gnu.org> (Eli Zaretskii's message of "Wed, 18 Jan 2023 15:20:18 +0200") X-Provags-ID: V03:K1:Hckrq7/DXr30w9wB2akPxeZg/f4/7Tmu9AfXIw6AT19JmaaUN+Z hhWBHtOWYooNuOAyhw7K6LnPt/zPihMJPckLNKl0WAf9rTslB2IsjvaXxg0hLb/Ya2j/asx a7uC0vYKgjap2Wk5CQHfqhxJsvxihdI2dSXBQFc81Ut4b6b7Er+POnWuel7FnqaN0bv2Kdu quY9nKnqorX8rsHvBPcDw== UI-OutboundReport: notjunk:1;M01:P0:JLb+bNz85vM=;7vMzxxMC8d2KPgfre7lRYhy4lSr 6fYRbdf0e9ZFq67OpdEF+h2pg35qu1ay8Wa0fDfJitH6XTuPIruz/YIVggbewK43EpPQQo4Ws GzT1KANgo8KuJvhTfnSMMB2t/FluDcGBaQbUmuZjPA6itSLTV2BKM8JuynQ+knsFYeP24NfhE hPot0hAZJ+KWMyU8NFvPefcoG1xlQ1a8kJVNBhtMz3KLzS5LGduXjll6lE6QPUvhg8dnUv5bl V6paERol/U3Ogwl8nVwA4/F9haoqg4IdAbim+P35hKRQLNfMZo2nLL4RuWeIXaRQabzoIrlUb ElI++DieiPVAj30P41g6ZdPRLE2HXuA13dBI8ywFRS9O5NTcZFxOv/snt3FQC7NVe/PWRUu+7 SBFZIXK8j8NRH/y+k6H4YzVYHRDqnUzOv4QaVfR/yGFZMkDPXDuOO1K6zqF0D58ErPQe7hKDj a3eO6ALfTK8Xho/GJNHA9k+tGuYtRIqnH32D2/alfcYj1JrUoGzLxeSODVbeCX3a7ash86Xwy 994YdfXcHCgAg3FBoAbfLB20DP6HZrvqgo+E2eRuIT4ftpXdOpcccMNpgTD1kMGeBgWKblfyF +evbGf+NZWUiX5Ns/cx8zOlAMVQXVM26Z9SnwtQ8rSsa2un8O3uG0Vfq7SdVpJw3vUYty3gDi Z+KRyyLadTee7nPzbWQpCldT5iz77eJG8pHORVvbq4/r/3Jy5k6H5MbMo4kHtQo= X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:253799 Archived-At: --=-=-= Content-Type: text/plain Eli Zaretskii writes: > I think a good place is to mention this feature in the "Misc Help" > section. Could you please check if below formulation is better fitting? Unfortunately I also need to investigate the code anew. Yesterday I realised a regression starting with Emacs-29! `Tab' and `S-Tab' aren't working any longer for Info references. (E.g. the `Tab' keybinding is switched from `Info-next-reference' to `forward-button'..) --=-=-= Content-Type: text/x-diff Content-Disposition: inline; filename=0001-Documentation-of-Info-providing-buttons-on-quoted-sy.patch >From fa7c61466157a580b17d15f989e1b825ba4c860a Mon Sep 17 00:00:00 2001 From: Dieter Wilhelm Date: Tue, 17 Jan 2023 22:25:54 +0100 Subject: [PATCH] Documentation of Info providing buttons on quoted symbols (bug#60587) *etc/NEWS: Mention implementation *doc/emacs/help.texi: Describe implementation --- doc/emacs/help.texi | 9 +++++++++ etc/NEWS | 11 +++++++++++ 2 files changed, 20 insertions(+) diff --git a/doc/emacs/help.texi b/doc/emacs/help.texi index 2513e6be271..781b2bf1ab4 100644 --- a/doc/emacs/help.texi +++ b/doc/emacs/help.texi @@ -653,6 +653,15 @@ Misc Help K @var{key}}, described above, enter Info and go straight to the documentation of @var{function} or @var{key}. + The commands @kbd{C-h f} and @kbd{C-h v}, also described above +(@xref{Name Help}), in an Info buffer can be replaced by @kbd{Ret} or +@kbd{mouse-1} on quoted symbol names. 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 +references, with @kbd{Tab} and @kbd{S-Tab}. + @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 fc8a3ac66a0..f9ea0084cb5 100644 --- a/etc/NEWS +++ b/etc/NEWS @@ -174,6 +174,17 @@ the new argument non-nil, it will use a new buffer instead. Interactively, invoke 'eww-open-file' with a prefix argument to activate this behavior. +** 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 --=-=-= Content-Type: text/plain -- Best wishes H. Dieter Wilhelm Zwingenberg, Germany --=-=-=--