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, 28 Jan 2023 09:51:22 +0200 Message-ID: <83fsbvayh1.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> <831qnomh6l.fsf@gnu.org> <86wn5anw04.fsf@duenenhof-wilhelm.de> <83cz71eg4y.fsf@gnu.org> <86edrfobzb.fsf@duenenhof-wilhelm.de> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="36471"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 60587@debbugs.gnu.org, monnier@iro.umontreal.ca, juri@linkov.net To: "H. Dieter Wilhelm" Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat Jan 28 08:52: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 1pLg0Y-0009KD-Rm for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 28 Jan 2023 08:52:18 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pLg0N-0002sb-74; Sat, 28 Jan 2023 02:52:07 -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 1pLg0I-0002g6-ON for bug-gnu-emacs@gnu.org; Sat, 28 Jan 2023 02:52: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 1pLg0I-0005Ef-8A for bug-gnu-emacs@gnu.org; Sat, 28 Jan 2023 02:52:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pLg0H-0007sL-U8 for bug-gnu-emacs@gnu.org; Sat, 28 Jan 2023 02:52:01 -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, 28 Jan 2023 07:52:01 +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.167489230330250 (code B ref 60587); Sat, 28 Jan 2023 07:52:01 +0000 Original-Received: (at 60587) by debbugs.gnu.org; 28 Jan 2023 07:51:43 +0000 Original-Received: from localhost ([127.0.0.1]:39432 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pLfzy-0007rp-VS for submit@debbugs.gnu.org; Sat, 28 Jan 2023 02:51:43 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:41268) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pLfzw-0007rb-MN for 60587@debbugs.gnu.org; Sat, 28 Jan 2023 02:51:42 -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 1pLfzr-0005Aa-6X; Sat, 28 Jan 2023 02:51:35 -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=1O47bUMtMwCjgYQBiZlrBae3bLRm6g9kk7DxEaWgRiE=; b=BWOhYwXtIWrd nmlYgSSmyEe2eSXjFFswY7bnusGOutpkQMoc7FxUbrkkCpTpevlbzxkC4RpH5diUVSieMQ+38AMuG yQnvWqj5dmNKLhrCsVepqQx1wUrILLKwWZIoUkUM+Cod4HkIyaML0Ag30rFUo2fakqTNIspzSkDPO kudaBTEqIzjCsilISx6LJ1g0wX5Wj083dZ97KUx9Lw7ESOv0Q+cRkztsz+JY7HqOLauOu+wsv1267 RGjEGrZEg3TkFdzjklnQsvmWxmHpywapvGbFuUyxnj9brbnbx48OzAg0Nj2O5ddWGu+4MG6XQ8jbY A/Du//t4ya2WM5lod8nTfw==; 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 1pLfzq-0003Hz-Kb; Sat, 28 Jan 2023 02:51:34 -0500 In-Reply-To: <86edrfobzb.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:254291 Archived-At: > From: "H. Dieter Wilhelm" > Cc: Juri Linkov , monnier@iro.umontreal.ca, > 60587@debbugs.gnu.org > Date: Fri, 27 Jan 2023 23:21:12 +0100 > > Eli Zaretskii writes: > > >> + 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}. > > > > This is fine, but please try to reword to not use the passive tense so > > much. > > What do you think about the following formulation, is it already a > better "mix"? > > Info makes quoted symbol names 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. 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}. Yes, much better, thanks. > Drew reminded me that it should be better to write solely @kbd{mouse-2} > and / or possibly explaining `mouse-1-click-follows-link'. I'm curious > about your opinion. I'd just say "click the mouse (@pxref{Mouse References})", since the cross-referenced node already explains all of these subtleties, and does it better.