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: Fri, 27 Jan 2023 23:13:36 +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> <86h6wboe2v.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="13461"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Eli Zaretskii , "60587@debbugs.gnu.org" <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 28 00:14:26 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 1pLXvM-0003JV-Dn for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 28 Jan 2023 00:14:24 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pLXv5-0005RX-Mc; Fri, 27 Jan 2023 18:14: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 1pLXv3-0005RH-Vm for bug-gnu-emacs@gnu.org; Fri, 27 Jan 2023 18:14:05 -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 1pLXv0-00071c-HG for bug-gnu-emacs@gnu.org; Fri, 27 Jan 2023 18:14:05 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pLXv0-0002LH-C1 for bug-gnu-emacs@gnu.org; Fri, 27 Jan 2023 18:14: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: Fri, 27 Jan 2023 23:14: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.16748612238969 (code B ref 60587); Fri, 27 Jan 2023 23:14:02 +0000 Original-Received: (at 60587) by debbugs.gnu.org; 27 Jan 2023 23:13:43 +0000 Original-Received: from localhost ([127.0.0.1]:38866 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pLXuh-0002Ka-C4 for submit@debbugs.gnu.org; Fri, 27 Jan 2023 18:13:43 -0500 Original-Received: from mx0b-00069f02.pphosted.com ([205.220.177.32]:29096) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pLXuf-0002KT-F1 for 60587@debbugs.gnu.org; Fri, 27 Jan 2023 18:13:42 -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 30RNDego006744; Fri, 27 Jan 2023 23:13:40 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=kFptQCQIBLccjcu43vJVwMBvVynL0d24vIRV8Gx3OSs=; b=ksn3kPTuHRD3XhBo3GAJy50E77J4PM2dUdr1sy87eh7wjMkHNOy+FJXIZ9+96FcgDBFa BC7A6amO9pAu1dQbf42kaR5ISx54mtfhIVqeTulSlmF/8bIKyLurSh+dsYx/28tDiHJb 4+BEhjVRWLjKQKoS6V8MgYNCO3Pal+jWKrUT7vwtvGtOQcCwpzzXstDNE5vSIO0yfm68 +JaYwXb3M+UvFPBeQKavb7mU7yd2chNnM5NFXGv+zvjmeDW3jM74CISS122d17BXxI/P qMeMTfOC2iFj62Eyl/u29jKxHO01a7KF9jz0oL/0/anokA3ZJGO66XitOdIYhrf5mAqt 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 3n86u36005-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Fri, 27 Jan 2023 23:13:40 +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 30RMY0cK023990; Fri, 27 Jan 2023 23:13:40 GMT Original-Received: from nam10-mw2-obe.outbound.protection.outlook.com (mail-mw2nam10lp2105.outbound.protection.outlook.com [104.47.55.105]) by iadpaimrmta03.imrmtpd1.prodappiadaev1.oraclevcn.com (PPS) with ESMTPS id 3n86ga7cyq-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Fri, 27 Jan 2023 23:13:39 +0000 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=LxjREoBi29IV1ra4Dhy+GUgqvTxRxaBIdUlp42h0TOI7UvZEWsjdRBXmOh49m11uKzUl8ZDdxESIwuJgHb46Ht/oOcLacelQrUzfgLXHptMr8592xy8rCIk4wlJNrTsqekU333MOMHFF6YfvAFdsfkL9lrTZIUBRZ4ycVw1XsgeBhNFtoykoDTKxHio7D0rFouM1wx8tiMsCxOXmQQHs/IemH3+StfOIhjO1QUB1nJQgigvb4zLuaadn65szmn6Wy19EsLa1nFn/Ewi5Q/FXtGyz8vSGpHyvpe9lopwBWLJ08yyZjJy/iqRrnVikdsnMz4KqTsp6N2OUBw9oHVSOIA== 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=kFptQCQIBLccjcu43vJVwMBvVynL0d24vIRV8Gx3OSs=; b=Mu0V10jMZ77uL/7bEOo4nIhUol/bLaUnQ3GmrMli9++xHP6zYrz/e6ILH12YlFApKUsi5gg+zRhjCP94O9ALN0CjGtP/PPuqJMzF8t5jOsuXuZ8ShoTTfGsjP+u2TjX3LfInVRsplezamSHxyGMhnQbluTBYRMCbI+tgG2lCpDFO8GDTqKH6wqTHTTzOyB6yKJImONEjujHTJdeFRmfdYZ+qYKIWffV8AUuHyGGHFIbyrHJgyEDhL7oOo0th3QfwthcMbIBxbG2WUs9upit1wb3/631opKHc4+eTn5CXZbu8/0K251e8kaSL4t4i/AnT9+a9b6v9hDyxP9A4imKwRA== 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=kFptQCQIBLccjcu43vJVwMBvVynL0d24vIRV8Gx3OSs=; b=WtUZxmiKtTQMy7eScrDi7HEEvy+yJotI38PjIuvI8gHyyhGUfMoKrsq+OOy4sHQYa4sDkYEFXO4zCl3esU7pHzMzJLEWkppyk88xTnoytgxFGUeR/XuOSsniYY3fGej4sMJikFj0Iofj8rvuadTrIbfzQxbLzUYH5lUO4Te+3U8= Original-Received: from SJ0PR10MB5488.namprd10.prod.outlook.com (2603:10b6:a03:37e::19) by DS7PR10MB5024.namprd10.prod.outlook.com (2603:10b6:5:3a4::10) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6064.13; Fri, 27 Jan 2023 23:13:36 +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%8]) with mapi id 15.20.6064.013; Fri, 27 Jan 2023 23:13:36 +0000 Thread-Topic: [External] : bug#60587: Patch for adding links to symbols' help documentation Thread-Index: AQHZMpdgGBbX0JVMrUmQ69eme3Hrrq6y4kbg In-Reply-To: <86h6wboe2v.fsf@duenenhof-wilhelm.de> Accept-Language: en-US Content-Language: en-US x-ms-publictraffictype: Email x-ms-traffictypediagnostic: SJ0PR10MB5488:EE_|DS7PR10MB5024:EE_ x-ms-office365-filtering-correlation-id: 90fafb00-3e08-4740-fd42-08db00bc1e12 x-ms-exchange-senderadcheck: 1 x-ms-exchange-antispam-relay: 0 x-microsoft-antispam: BCL:0; x-microsoft-antispam-message-info: 5S4Bz8NbNXbWVd/7CyPr/JhqwTwCaSAY3UXI+oZFoezugc3Y5GjzfEDlaTKNUBnWkQuPZMQe/TaDh0EDhPNwncmZi04h5BNB/aPx0dq+LIC6GAukoZk0uUP+0VzzcynobDnvMrE/4Dz46Mdz5giqE9BW5au0d/rMEIIGvujamDTC9c0/RYldwdn2z4pwUzPc/JbEAz6PbxdQ08zMiPyw0fKYlGn2JPzASnUSvbQcSJPRbwMFEUwBbGFT0nua2pRoc6yWquYVD7MYlna0u1XuhXeh1US7lKZwqbWuT9/p2KBA3FeVHRlWlE0eMtuCKbxXUdtNhQ14ZB2fP4EFWMjqyC1BVJF32CSsyLj8C5jcYk7Aovy78WaVckjd111iabtp9+4DgfdJ2gJ4M0MOQciwE+7mdZMMF9sjpbC8Ngy09yW+v7dyMBZjM+EKGjHW/bCvK2bla+xCT46KY6PS4SGOPUDLTMI7jSeb234lpTU4eqtpKPg3LDeXv6gPyRXZWeciWcCns+5uvDsrgL04Os3TLUMiBYtcg5vHNn2QAzFZu8C9UWBoCv3hbNUut/Vc76SH41hQ61i3PZaohfIqdQ7g/cyX7dWRsYOI6EV6QU/LThrrAJrpKxVY3a9i6d8rKyMIvwJVbjadLxlHWZyMWRb1lCspKh+QMulelq23tbFzKDt3IFfAG7CQ7N5gvI7VubaUwwJg6QMLFlWg3AkiFNp5ow== 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)(376002)(346002)(136003)(39860400002)(396003)(451199018)(2906002)(86362001)(33656002)(26005)(66446008)(4326008)(9686003)(8676002)(186003)(66556008)(76116006)(66946007)(71200400001)(66476007)(6916009)(7696005)(64756008)(316002)(54906003)(6506007)(478600001)(38100700002)(44832011)(5660300002)(38070700005)(41300700001)(122000001)(8936002)(52536014)(55016003); DIR:OUT; SFP:1101; x-ms-exchange-antispam-messagedata-chunkcount: 1 x-ms-exchange-antispam-messagedata-0: 8mJpe9UsDWTCpNbCdY5iS2CkofxSLMWjNn2kq3EShFO6t88NpUrg2N2rOZ54AcPLVW5JZ7qztkZVo7L8Om3fvRYFc8E+yz15pj5H9RixU9+zpwgpcv2Ct+aTyvpAbEfImvvADQAonXFd4zXv7H/Y20uFwT+NJih3SAo0onglr3K2BfyZdnx6uNJMULjvtSZPXYsYwcLCk/Qwt3qx7jPseRVg735ucw8XzNPHwpaZiLeoNs3IF0LI7wUL4LN9sE03zxuuUa0Jt8leubIUh4GZFQ2bgCgN0sPx1tlSQjDM2RPqjtupkoZh+f3IXkHTs54fm4/JPxOk+88LpXzlIPerHIcyo6+Z7z8jtk/zjvDKAKjSuhSIQHocwQWhpVRyJFFECdMcTi2r+sCueBVKBqxoQnRWiJbWGGXRA584DI5lubcLh50HRwIx1PLBGVuYUg8gq9LvODbZxYZwPhbq8BCHp2oDAtU82FVBjhcmK/GWeiCstEY3Nl+UuQWFulNTtfDTkh7YItTv4YVCKHcaCfahDGE9LGCS1vspgd7I6OmUulil2BFYG0ufLWbwabSfgoK9RBAaqi5FTmVdQtO/Kds541LFKsg3hTAw6ecLx+oYXQjLEza4qO/VNtIQRkkmxmIAl6Z189OCQ9DruAl5eRQHZyvQgqib3DU7bjO1layNHgY2vNEbq+lNrL61aSWF0tsKvlmJuT0e1ZyGpjYuHHLLInrhJSOcfj6OezOswmTNwVK/04pDIn4ZZAvwPd LZxD8BXQt7nmXhQT/G4kggF8yUcLRMHzM51w2Z9dnrK6GyjFstSQrr8yZDHU3P3aILabfbK0RGBAhWmSSAoy5DKx4GSUnGIt75 X-MS-Exchange-AntiSpam-ExternalHop-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-ExternalHop-MessageData-0: GzYS6OcJ/Ph3EcPYTtJOaU13cmLE/vtn8bl7oilbAG2/BeecIZSh3uc5L8uw3ZJq9Xkf2B/A/Zm8kxc6Id2GPiaY9BZ5NPz/TZ6pzUvzcr/Qzraz3dB0w+Xe43amp1zjLceGTZdxoTWpaZsxiaUBdlmlnELviboRqNcU4vDmABhtdUuX/lBSNvbgpEY9v6zWJev/TPiAsjPnA8dvp7O0842SVwQWVDes533rbFLyutpzP0xfwnX4sK2oiUMc0b682yFibcJgVXdCil9jV9DeC/HW9yD9uKIxPhCsbppax4jhzXIlUhZweF1LxjSzvS6HHXteKv/wiB3XU+fWPLjfxd1Z+3hoa0nSOh+umD546tdfHFa9DiLYC3+pXA67caBX103QyVSKxmzymNleZEBAVharYPxRXL8FOT9D3dHhI75ScNKLUxsHdbo8/Rd6gdxtWsNIu85ZA4VPRsN+7CLN8QAkfXcMV1n+AJ1gszQklpcxiaZS4XCXYqBc5Rkq5oNl+JXxQYcQhEvGqdizA2VOAxr+uo+kOVUlzDFqKoL00W7leZNQHShxsJBR0eTbyA2Qghsgit4wv0t6qUvJhqhdCBTVSE3HD17yT/Rf6KDpNcK+Km8uLsRvQSpfwfA06z/yeUUUAEO83GluG9oHKSFFWNwy7Qp/Uh6dyeAramdvqGQipCIq106rHT0gxwhFbjwRcUizwX6o4TDHQQE1ZKZaIsAYOJx2mB7ZcU8Gaym0xhF/S7 QB9Qn9ln4pbAgA9s95CyG7eucfiqICAcesE5XHH1wZVN16J0NA3DBiseOslOKsB7sclE/lC8oGnkap1bmMd61NeLiGCeCF8qGH 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: 90fafb00-3e08-4740-fd42-08db00bc1e12 X-MS-Exchange-CrossTenant-originalarrivaltime: 27 Jan 2023 23:13:36.1157 (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: SfUaQW7pQWStM7FosDBcRoex7XcGUBMrS32mPX4cGK5buISTK5bDFelZNYIjr8ws692UZxHwF0XJkP13vohztQ== X-MS-Exchange-Transport-CrossTenantHeadersStamped: DS7PR10MB5024 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-27_14,2023-01-27_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-2301270214 X-Proofpoint-GUID: JJnPrw4WlqNSQso8uuvK4nq4PS_a2V9E X-Proofpoint-ORIG-GUID: JJnPrw4WlqNSQso8uuvK4nq4PS_a2V9E 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:254281 Archived-At: > > 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. >=20 > The doc string says now: >=20 > "True (`t') means Emacs creates symbol link buttons in Info. > Setting this variable to `nil' inhibits the creation of buttons > on quoted symbols to their help strings. Please see the function > `info-make-xrefs' for further details." Is the defcustom now :type 'boolean? > > 3. Maybe add a toggle command for the option, so users can switch the > > behavior anytime, on the fly. >=20 > Like this?... > > > 4. Or instead of having an option, maybe just have > > a minor mode. >=20 > That's also a nice idea. (Maybe for later.) See Stefan's reply... > > 5. Face `info-color' should be named something like > > `info-symbol-help-link'. >=20 > You're right, `info-color' is too minimalist and not describing what the > object represents. >=20 > (I dropped it completely because I realised an additional face is > redundant since Info distinguishes (slightly) quoted symbols from the > text, anyway.) I think it's _good_ to have a separate face for this. That gives users the choice: * Have the same appearance for both kinds of link. * Have the two kinds of link (Info, *Help*) look different. When you provide two faces, users can always customize them to look the same, if they like. Otherwise, they don't have that possibility. > > 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. >=20 > Do you mean that I should just say mouse-2, because > `mouse-1-click-follows-link' regulates it anyhow? (E.g. I realised that > Emacs changes my documentation string for the tooltips >=20 > 'help-echo (purecopy "mouse-2, RET: describe this variable")) >=20 > from mouse-2 to mouse-1!) Whatever Emacs expects. Yes, I think that's what to do - but someone may correct me. > > 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"). >=20 > To make the confusion complete: Info documentations > calls (Info) links also cross-references. ;-) >=20 > (info "(info)Help-Xref")