From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#60587: Patch for adding links to symbols' help documentation Date: Sat, 21 Jan 2023 10:21:22 +0200 Message-ID: <831qnomh6l.fsf@gnu.org> References: <86y1qgr1bf.fsf@duenenhof-wilhelm.de> <86tu13qydg.fsf@duenenhof-wilhelm.de> <83h6x2u74b.fsf@gnu.org> <863588rfos.fsf@duenenhof-wilhelm.de> <83o7qw0yjy.fsf@gnu.org> <864jskx6a8.fsf@duenenhof-wilhelm.de> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="6636"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 60587@debbugs.gnu.org, monnier@iro.umontreal.ca To: "H. Dieter Wilhelm" Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat Jan 21 09:22: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 1pJ98k-0001ZJ-Ga for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 21 Jan 2023 09:22:18 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pJ98W-0006nr-3b; Sat, 21 Jan 2023 03:22:04 -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 1pJ98U-0006nT-Mh for bug-gnu-emacs@gnu.org; Sat, 21 Jan 2023 03:22:02 -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 1pJ98U-0008He-ED for bug-gnu-emacs@gnu.org; Sat, 21 Jan 2023 03:22:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pJ98U-0002cS-5o for bug-gnu-emacs@gnu.org; Sat, 21 Jan 2023 03:22:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 21 Jan 2023 08:22: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.167428930610046 (code B ref 60587); Sat, 21 Jan 2023 08:22:02 +0000 Original-Received: (at 60587) by debbugs.gnu.org; 21 Jan 2023 08:21:46 +0000 Original-Received: from localhost ([127.0.0.1]:47990 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pJ98D-0002by-OU for submit@debbugs.gnu.org; Sat, 21 Jan 2023 03:21:46 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:49390) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pJ98C-0002bm-BT for 60587@debbugs.gnu.org; Sat, 21 Jan 2023 03:21:44 -0500 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pJ97q-0008ER-4n; Sat, 21 Jan 2023 03:21:38 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=uRJ6TUVy6wj8PiOmp/CC6RDU5Y4DohJr7CCKBMEzNmU=; b=KGa8ItsDTkag Ni5XYGmfrGPJzIS61H62BOAMnK087zo3jG3bTW1DczusKtAGdfCpIRa1QB1MKHd/7O1/EnOVbkLXD ue5CZd5orOEJTe9UawoQxhZZaItMzZm+1ZcYt2HmNSOFb3GezUlT+ZF9lqhD+Ar4KxTGStYPXGLTG D6ZGvgkNXtaRjY5qDpUcW0xpGna2gAd9xMNYhvVOVN780aweJxA+g602wg2zDu4l175jrBfkG5ZBR s0NpmkoRMWuBvshKvYv4oKtwVsDpmG9EngzV7uweDaeqFCbxCibBKrFm+MJWAuwV3SiQNKTb56Muz txEY+QMIS3lNI3WY37B8uA==; Original-Received: from [87.69.77.57] (helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pJ97o-00061g-Up; Sat, 21 Jan 2023 03:21:21 -0500 In-Reply-To: <864jskx6a8.fsf@duenenhof-wilhelm.de> (dieter@duenenhof-wilhelm.de) 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:253838 Archived-At: > From: "H. Dieter Wilhelm" > Cc: monnier@iro.umontreal.ca, 60587@debbugs.gnu.org > Date: Fri, 20 Jan 2023 22:09:03 +0100 > > 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? Yes, but it "needs some work", see below. > 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'..) So I guess you will be submitting a new patch soon? > --- 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}. I think the first sentence should be rewritten as describing a separate feature, not "the same as" something else. Just say that symbols are converted into buttons that lead to their doc strings. Also, the option which controls this should be mentioned and indexed. > +** 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. This is OK. Thanks.