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: Wed, 18 Jan 2023 15:20:18 +0200 Message-ID: <83o7qw0yjy.fsf@gnu.org> References: <86y1qgr1bf.fsf@duenenhof-wilhelm.de> <86tu13qydg.fsf@duenenhof-wilhelm.de> <83h6x2u74b.fsf@gnu.org> <863588rfos.fsf@duenenhof-wilhelm.de> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="31966"; 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 Wed Jan 18 14:21:22 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 1pI8NV-00083W-TH for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 18 Jan 2023 14:21:21 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pI8NE-0001c4-Hu; Wed, 18 Jan 2023 08:21: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 1pI8ND-0001bt-0O for bug-gnu-emacs@gnu.org; Wed, 18 Jan 2023 08:21: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 1pI8NC-0007NX-Ot for bug-gnu-emacs@gnu.org; Wed, 18 Jan 2023 08:21:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pI8NC-0002e8-KG for bug-gnu-emacs@gnu.org; Wed, 18 Jan 2023 08:21: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: Wed, 18 Jan 2023 13:21: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.167404801510105 (code B ref 60587); Wed, 18 Jan 2023 13:21:02 +0000 Original-Received: (at 60587) by debbugs.gnu.org; 18 Jan 2023 13:20:15 +0000 Original-Received: from localhost ([127.0.0.1]:39830 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pI8MR-0002cu-E8 for submit@debbugs.gnu.org; Wed, 18 Jan 2023 08:20:15 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:35138) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pI8MP-0002cc-Rj for 60587@debbugs.gnu.org; Wed, 18 Jan 2023 08:20:14 -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 1pI8MI-0007AK-1h; Wed, 18 Jan 2023 08:20:07 -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=06Eihm7W4m5UDm5tQJoR1Azhi+aEgpRVTqTFWtBNu+I=; b=hy8vCD1JLMRE ejKqXyaYkgLmIPjYSYX00h6tICdNsI3WIhidJ/x4FF8rpW1nsaSXT+azBNz5sRt/DO9kMGc5R1Mj6 zUTbldn+ADXvnv3Fg2rqeKfc/ezJjHd3ZwoyEyvmZy8BYoR99md5+rM7WXnLX90zAawB/r1Holn0Z 980V4exn4zOBhDGfld62LgII1Tg/e0o4Q+eFPZw10Fhhmosn5xtbL08C9VeFxKM2HW68x82EIA0di UvASw0aef8c7uVa96OBRgIM2J0iDmQVWMa2jZHG25z/v4xB3Dug8TG1ae6elvE9/DSr7ru1LSnWqV OOfjKZ/tcz1Eh8gdg0GRcA==; 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 1pI8MG-0007SS-PR; Wed, 18 Jan 2023 08:20:05 -0500 In-Reply-To: <863588rfos.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:253631 Archived-At: > From: "H. Dieter Wilhelm" > Cc: Stefan Monnier , 60587@debbugs.gnu.org > Date: Tue, 17 Jan 2023 22:53:23 +0100 > > Eli Zaretskii writes: > > Finally, this needs additions to the user manual and NEWS. > > Do you think about Emacs' Info manual? My feeling is that it could be > fitting to explain the additional linking capability here: > > (info "(info) Help-Xref"). No, the info.info manual is not what I had in mind. I meant the Emacs manual. I think a good place is to mention this feature in the "Misc Help" section. > +*** Info viewer provides now links from symbols to their help documentation. > +Links from quoted `symbol' names, like names of variables, functions > +and faces, are pointing to their *Help* documentation. If you want to > +disable such links - in addition to the regular Info cross references > +- you can set the variable `info-make-xref-flag' to nil. First, please leave 2 spaces between sentences, and use "--" for a dash. More importantly, "pointing to help documentation" is confusing: what exactly is "help documentation" here, and how does an Info manual "point" there. I think you should instead say that these symbols are made into buttons that can be used to display the documentation strings of the functions/variables. Or something to that effect. Thanks.