From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.bugs Subject: bug#60587: Patch for adding links to symbols' help documentation Date: Wed, 25 Jan 2023 22:24:24 +0000 Message-ID: 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> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="14668"; mail-complaints-to="usenet@ciao.gmane.io" Cc: "60587@debbugs.gnu.org" <60587@debbugs.gnu.org>, "monnier@iro.umontreal.ca" To: "H. Dieter Wilhelm" , Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Wed Jan 25 23:25:44 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 1pKoD9-0003a5-9D for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 25 Jan 2023 23:25:43 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pKoCg-0000hO-7j; Wed, 25 Jan 2023 17:25:16 -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 1pKoCU-0000h1-TG for bug-gnu-emacs@gnu.org; Wed, 25 Jan 2023 17:25:04 -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 1pKoCU-00073s-E0 for bug-gnu-emacs@gnu.org; Wed, 25 Jan 2023 17:25:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pKoCU-0007kE-95 for bug-gnu-emacs@gnu.org; Wed, 25 Jan 2023 17:25:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 25 Jan 2023 22:25: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.167468547529731 (code B ref 60587); Wed, 25 Jan 2023 22:25:02 +0000 Original-Received: (at 60587) by debbugs.gnu.org; 25 Jan 2023 22:24:35 +0000 Original-Received: from localhost ([127.0.0.1]:60154 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pKoC2-0007jT-HS for submit@debbugs.gnu.org; Wed, 25 Jan 2023 17:24:35 -0500 Original-Received: from mx0b-00069f02.pphosted.com ([205.220.177.32]:24542) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pKoBw-0007jE-56 for 60587@debbugs.gnu.org; Wed, 25 Jan 2023 17:24:32 -0500 Original-Received: from pps.filterd (m0246631.ppops.net [127.0.0.1]) by mx0b-00069f02.pphosted.com (8.17.1.19/8.17.1.19) with ESMTP id 30PM3omo014936; Wed, 25 Jan 2023 22:24:27 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.com; h=from : to : cc : subject : date : message-id : references : in-reply-to : content-type : content-transfer-encoding : mime-version; s=corp-2022-7-12; bh=buWC7e45kNxjEitlNEne4nBys/T2eRtmes6TsTcYTkg=; b=Wwea8TOBx+FueOJO4v7G3+uW4JjxbrsclNi3jJ4H0siejEAVjkiqSpjdnjSDYOMocKkP WWhq/kMSlhoBg0GdS/mk0agv/lPMRp/3X//MadqhgAqi6lrUeKuxbU7JD+FxWuwIBGH8 94QxyNlkPli6+o1o5l1aVb+pIRN/2Pe3prWmlSF+nCQzUZ37ocyFKJyf340F2VWawW39 eN3xoRmH7onWDYsFu86fxxsbUq6HBIgXbxTa3eC3Sx1GuOirXplA2NMb7ZdfGMBLeSPL DNJA/v121dWCpwemE6tYFNABUxpLEfruGm5tCCsWPSFcHHTh5hrHBrPIeafFBOfow5xo fw== Original-Received: from iadpaimrmta03.imrmtpd1.prodappiadaev1.oraclevcn.com (iadpaimrmta03.appoci.oracle.com [130.35.103.27]) by mx0b-00069f02.pphosted.com (PPS) with ESMTPS id 3n86u318xk-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Wed, 25 Jan 2023 22:24:27 +0000 Original-Received: from pps.filterd (iadpaimrmta03.imrmtpd1.prodappiadaev1.oraclevcn.com [127.0.0.1]) by iadpaimrmta03.imrmtpd1.prodappiadaev1.oraclevcn.com (8.17.1.5/8.17.1.5) with ESMTP id 30PL2bYs009131; Wed, 25 Jan 2023 22:24:26 GMT Original-Received: from nam11-dm6-obe.outbound.protection.outlook.com (mail-dm6nam11lp2175.outbound.protection.outlook.com [104.47.57.175]) by iadpaimrmta03.imrmtpd1.prodappiadaev1.oraclevcn.com (PPS) with ESMTPS id 3n86g7htu0-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Wed, 25 Jan 2023 22:24:26 +0000 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=ddTZOlaIC/2Pp3f1vpYUymOcBSHsurjWhq9ZzufFNp70mtXJtlkIB9TYfJRZ1oRCrdTEqRBQVgPzwGcWOSE0XEnFh+jgAWNHTmBe+r2cd5AIbyJnlgYonzkRqvRIr+JOUaVxczz3zphVreJoipTebpA/2jo7gehCTJdfnnl2WEc+ckNzGgm/Ffk9SJp6eKw6zw5sd62j4X0sV3Icxa4UUFXaaXABhBBN+Ahb+9H7/KlMZ2SEAHlj1mi32UvS58c69nZIzVjlNEAqlnpjARaD9wSxY50oBpBqj1D6IFOTunxQnIZ5tr3BRsN8NhbgdAZb2dsPUVVj9y8bB2kY48JiHA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=buWC7e45kNxjEitlNEne4nBys/T2eRtmes6TsTcYTkg=; b=dRXOF5Oh1e3xCqgMeT/8K/XWu67IRTtaUnXyZIZgoa4L6p+Yoalbs2m1pxPbM+8WP2HKMMoLKIobNRLzR1oprORRlUBQ9R/n3mUnoeEHQ7heA7EXcZuGy1TVVckhidtK2Lq9QxeNaF098GdW2KmURW3rSkMlFt+eB1XQXd3OcIHgxhyhR/z8SGoPJP6BnyAjkOz5m0NEjKeuXHRFTFaQ466wZzW4DWHLZngoJB4K4yyefOHrYq57thOW+OUS01gfReGQ/6KFAAP6VjSP4oMTqadvRwkkZ3i+naQDWUwSaxkmJwvk4koPWBjc0vWqi1kZar8wCXIO2K3YnUbV89FpIw== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=oracle.com; dmarc=pass action=none header.from=oracle.com; dkim=pass header.d=oracle.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.onmicrosoft.com; s=selector2-oracle-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=buWC7e45kNxjEitlNEne4nBys/T2eRtmes6TsTcYTkg=; b=EHE/3BbVpo6aXoa0JVOBm+sPz6YDh1bq8CnVKVW636laa6a9E5OFJ4RZMG9ZF6oV1vxe24XNpnLdeKo9zgQbNKPo8uyU4lMSrSRDvw4nkXbwdBq5Nd9blg2ucw3CGENP5GJycE2GYeXLKjuOZGeM45yGch7O2RHgnSS8ObaQtV4= Original-Received: from SJ0PR10MB5488.namprd10.prod.outlook.com (2603:10b6:a03:37e::19) by DS0PR10MB7454.namprd10.prod.outlook.com (2603:10b6:8:163::11) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6043.20; Wed, 25 Jan 2023 22:24:24 +0000 Original-Received: from SJ0PR10MB5488.namprd10.prod.outlook.com ([fe80::7c3c:e53d:5276:ef29]) by SJ0PR10MB5488.namprd10.prod.outlook.com ([fe80::7c3c:e53d:5276:ef29%7]) with mapi id 15.20.6043.020; Wed, 25 Jan 2023 22:24:24 +0000 Thread-Topic: [External] : bug#60587: Patch for adding links to symbols' help documentation Thread-Index: AQHZMQRkjmD88QgLb0u4gJ1ypofq7q6vq/pg In-Reply-To: <86wn5anw04.fsf@duenenhof-wilhelm.de> Accept-Language: en-US Content-Language: en-US x-ms-publictraffictype: Email x-ms-traffictypediagnostic: SJ0PR10MB5488:EE_|DS0PR10MB7454:EE_ x-ms-office365-filtering-correlation-id: 62a022f3-ba15-4866-ed20-08daff22ea01 x-ms-exchange-senderadcheck: 1 x-ms-exchange-antispam-relay: 0 x-microsoft-antispam: BCL:0; x-microsoft-antispam-message-info: p9+OWxfbglhLvAP2Uysf8zlxQQeB7BWS/A8o13ksDgvDl7KdYKdKPHpdabnqbafkWfECfr6t0tvctwXg6Ll6/6ba2ghLBBe5lU4z5g741Ts0znBdkkEvgCHdg/aJ5TJKpiD6jfIpXKBirl+ZSemz4q2/3n5Xtgwq1Yh1jiK4ulKULgM1Y0ix64d387q7TvMeDp7qFNzoAMW+T+DEUY6+4eK2SRgwkiCSA72r25FR5bxQkAAELW1Fxz6CXivaMxIL4Pi8rYp/TRNsdPadB4F1mS7JCzcOL2Dyv78fp5FJY6K7379IcNHKyR4pTLZlGfLhzzWQdfYaoZpnqVwDfKKhUHRzosI44ubzJl7+qfFy0lMtoLyvvfP0JYYeGQBYde5L2zLRkqKI10ZyMSDMdgIvaUKLs07CYRH37gRh7ytEbv8JPtTsZQSsyC3w/Mzd5kEYr9k6HEFYDTjUTDyQgevLZ3K3b2AUqckeHSCGFaspN1RjhT1dop+2zHL8+iUvFTQKS5sN11nixcOA1pMjnZHN03x9p/FvmauMjZcCyYqkyaTJFkjT/ngnbIHSI5+PAtrqT060qh2AYlh7PWYM0vQE7rVf2apLBOdXn0iUUoSSpyJ0szgfUVRPwCqoBeL7voaBXoQYxyAs/RfMSwKTfN3pWuWKP66zwoljRtA+kU7MjW/Prn/vGebP2qlhxAgRTOMXRWyeOar3yxzBaYKb+wk9RQ== x-forefront-antispam-report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:SJ0PR10MB5488.namprd10.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230025)(366004)(39860400002)(396003)(376002)(346002)(136003)(451199018)(2906002)(38100700002)(44832011)(122000001)(26005)(6506007)(186003)(478600001)(76116006)(38070700005)(55016003)(4326008)(66946007)(64756008)(8676002)(66556008)(66446008)(66476007)(71200400001)(33656002)(41300700001)(52536014)(9686003)(8936002)(7696005)(86362001)(316002)(110136005)(54906003)(5660300002); DIR:OUT; SFP:1101; x-ms-exchange-antispam-messagedata-chunkcount: 1 x-ms-exchange-antispam-messagedata-0: DfE4ec0dHzOdlu7FJKWh8Te8tcXrC/7oP2gXtA8dJP9NUyEtC3Gyz2qrMUBQLgvPQHJkhp+QZ+4EUka/zNeKN0Iy5d5//WRzPstmNFdKR0SfR6zEhqArnlmFQzihKg5jyKljp/QNRsYkP9/Yq4bsC7Yt8i9gmY4MwMdG2kZ2jVQnymZXTU88GgGlqyjG7O8JblscwP8r7tp1SBjfikVLIa9nhLrsFZBx/Y7s3nJHJ5qJT0K5croGch7dHLkeNaS8eBzuh65KRyZazumKUocip6iUFSm9GPfHRAqrm5XnG+qKtUExKelWMuHCxsT7AEaynLQ1Vwl0LcRA2hSIQWY7bA7D8VQZ3VXI1H1fDEzIfxsaDr90nWsQS5d6sxDvjUynPaZedtATqdSapD1R59yH78fkg/JbF7uujz8dbvB27YefI69Z7wxsdDKZ16jb968lgoUZX5hWjFMCtDWAUlX8p1hfqY4ZU6V8B9S0LQRo7ojFj6VT0YwkpYHLtJLM8RSz4tD84tsScRzfP0OoGOiZvrYpyhXvH58nj33d9QGVF6ZPL4WPwBKSuqSC1EZLXHVSeER+Rte/FhTyGgmJLGK8z/SptckWPa32MIWK5+49iUTKh6SllvEiLpGF86kLi6kSZu8su3DCZzFvMhnrFeDXFML9LX9PtaD3f3JtockuPclMNrS57tMXjPidO30cbCIUi2AYtBebqCRv9Loo/QvtTJ628Dob3HLSsG/fMRaC6YQWg1d7CfIDnqUdiR 16e435DbY1/zm6wpeazd17w9o4GKLABtewSQbBqmCQfK+uUgpyXDdy3egJDOgryaU3X8x8yxzqs9RM+CLtZLOtd/Mx1s7Ws2AM X-MS-Exchange-AntiSpam-ExternalHop-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-ExternalHop-MessageData-0: xcndjK2g0xmaTFOiV/QvvHPJ67ubwRy9/Yd0r0TwWT9EUAtceTSBQ/Ae6C6gkxRQSx6l2701G2xRBSe4uxrHUYLNrDETHNbmxcOdH+YwTQESBzfvnUghpaeOE0TfV4f/SDJfwMbVAphGJdu5TdlMw+Gw9HUWdTxon3PKA0dHBfbwuu8ZSeexJ1nZbDe1RTj7WM7xF5mdZNvnP3WvzBnDUfZIFJHmZNGFI2n305z7Abmy2oXlDTNxKgQAzXkRmUdvT3ommLOiKenhqaTw8vNJsLeGr21adMN5O8gekwiQ9ybKphh55sg9HnZm2NEhW/5mq4j/HI0rfmiH9Sfqt68l9tLJdyrpJpLqD+HW//os+QNV69Fgq6hsqqxNvPG+PwXNATTh14gLu8j53EjmSNg1vj874c0sRV0cDXHSj079lr7YwQN1iXOgCLdcUtpS9uZhJ6aUAvaNT4twFmH8GGPNjIyYWrwKDjYKLiP27/KWMU+U/xI4hZirESILwPJVm9AN0KC/gIgEzYIJLqJTZI9jUufB8i3vyet39xshfb/M5+9Kl8Lbms85bK35G9EiAjJhozrVtG9TmFXzyTBUmYAn8fyxCaOcjoT3cbouH6rwzPZP0YNYzz9TnbTFUWBTMPhL9//5Hed+fO7pxL9GElMcm0RmyU7aO8Q/9ef4+SnYcjqHqTS9DATlzaL77zyQS1pH5RXi5USC8UO2U1OjF5hMMmxbzFR+KtsCP0a81+8sjXB+3W CnxTxI5DDF+3tIYY9bN6LDfaGTuLBf5oE0LQ7lxUO5LG4pWDRl0qb7ZILpZIU1MEr/L59g+6JHwUwt393b05zgKOU9SPr1S6gl X-OriginatorOrg: oracle.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-AuthSource: SJ0PR10MB5488.namprd10.prod.outlook.com X-MS-Exchange-CrossTenant-Network-Message-Id: 62a022f3-ba15-4866-ed20-08daff22ea01 X-MS-Exchange-CrossTenant-originalarrivaltime: 25 Jan 2023 22:24:24.5687 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 4e2c6054-71cb-48f1-bd6c-3a9705aca71b X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-CrossTenant-userprincipalname: Je8vQtrZ4wilwXzNxcxpGzRprXtWsYxW9efzh3CN3L7pU3gU2SQOu36khOF/7azsWmWW2PyO3lPVdL9brMn2aA== X-MS-Exchange-Transport-CrossTenantHeadersStamped: DS0PR10MB7454 X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.219,Aquarius:18.0.930,Hydra:6.0.562,FMLib:17.11.122.1 definitions=2023-01-25_13,2023-01-25_01,2022-06-22_01 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 bulkscore=0 spamscore=0 phishscore=0 suspectscore=0 malwarescore=0 adultscore=0 mlxlogscore=999 mlxscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2212070000 definitions=main-2301250199 X-Proofpoint-GUID: YZQfls0KKbR-CjN8Pzd27-X5rteHnUec X-Proofpoint-ORIG-GUID: YZQfls0KKbR-CjN8Pzd27-X5rteHnUec 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:254157 Archived-At: Some quick minor feedback - 1. + :type '(choice (const :tag "Create links" t) + (const :tag "Do not link" nil)) is better as just :type 'boolean, and say in the doc which Boolean value means which behavior. 2. +;; Toggle on or off the linking to help documents +(when info-make-xref-flag + (add-hook 'Info-selection-hook 'info-make-xrefs)) Instead of putting it on the hook when loading the code, add/remove it in a :set function. E.g. (untested): :set (lambda (sym defs) (custom-set-default sym defs) (let ((fun (if info-make-xref-flag #'add-hook #'remove-hook))) (funcall fun 'Info-selection-hook 'info-make-xrefs))) 3. Maybe add a toggle command for the option, so users can switch the behavior anytime, on the fly. 4. Or instead of having an option, maybe just have a minor mode. 5. Face `info-color' should be named something like `info-symbol-help-link'. 6. "clicking @kbd{mouse-2} or @kbd{mouse-1} on it" can't be right, I think. At least that doesn't express what `mouse-1-follows-link' does/means. 7. Again, I think it's unhelpful to call these links "buttons". Especially since Info docs call Info links "links". That these links show their destination in another window isn't a reason to call them something different (and with no definition of the additional term "button").