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#50467: Could :properties have index entries in the elisp manual? Date: Fri, 10 Sep 2021 10:14:00 +0300 Message-ID: <83y284j41z.fsf@gnu.org> References: <83k0jro9wm.fsf@gnu.org> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="22404"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 50467@debbugs.gnu.org To: Stefan Kangas Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Fri Sep 10 09:16:50 2021 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 1mOamI-0005dZ-In for geb-bug-gnu-emacs@m.gmane-mx.org; Fri, 10 Sep 2021 09:16:50 +0200 Original-Received: from localhost ([::1]:54850 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mOamH-0005JV-EL for geb-bug-gnu-emacs@m.gmane-mx.org; Fri, 10 Sep 2021 03:16:49 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:58634) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mOakY-00044g-9U for bug-gnu-emacs@gnu.org; Fri, 10 Sep 2021 03:15:06 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:53502) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mOakY-0003Jn-14 for bug-gnu-emacs@gnu.org; Fri, 10 Sep 2021 03:15:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1mOakX-0002ZD-RY for bug-gnu-emacs@gnu.org; Fri, 10 Sep 2021 03:15:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 10 Sep 2021 07:15:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 50467 X-GNU-PR-Package: emacs Original-Received: via spool by 50467-submit@debbugs.gnu.org id=B50467.16312580819826 (code B ref 50467); Fri, 10 Sep 2021 07:15:01 +0000 Original-Received: (at 50467) by debbugs.gnu.org; 10 Sep 2021 07:14:41 +0000 Original-Received: from localhost ([127.0.0.1]:36815 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mOakC-0002YQ-C2 for submit@debbugs.gnu.org; Fri, 10 Sep 2021 03:14:41 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:41436) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mOajw-0002Xv-W6 for 50467@debbugs.gnu.org; Fri, 10 Sep 2021 03:14:39 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:35082) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mOajr-0002iH-Jn; Fri, 10 Sep 2021 03:14:19 -0400 Original-Received: from 84.94.185.95.cable.012.net.il ([84.94.185.95]:1038 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 1mOajr-0003yH-61; Fri, 10 Sep 2021 03:14:19 -0400 In-Reply-To: (message from Stefan Kangas on Fri, 10 Sep 2021 09:00:00 +0200) 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" Xref: news.gmane.io gmane.emacs.bugs:213973 Archived-At: > From: Stefan Kangas > Date: Fri, 10 Sep 2021 09:00:00 +0200 > Cc: 50467@debbugs.gnu.org > > [Sorry, I missed replying to these below points so I'll do that here.] > > Eli Zaretskii writes: > > > One problem here is that use of the colon character in index entries > > should be avoided, as some Info readers could get confused by that > > (the colon is a special character in Info file format). > > How important is this consideration? In other words, how serious of a > breakage are we risking? For example, if it is just that the index > entries won't work in other info readers, that seems acceptable to me. It is serious enough that the Texinfo manual advises against it. Which in practice means we should use it sparingly, only for very important attributes that aren't readily accessible otherwise. > > Also, most of the keywords are, or should be, found by using their > > "family name". For example, for faces we have "face attributes" in > > the index. > > This is the workflow that I wanted to avoid. For example, I might not > know which section ":align-to" belongs to, which means that the > fastest way for me to find out is to search the entire manual. Where the "family name" is not obvious, and the attribute is important or popular, it is indeed justified to have a separate index entry. I agree that :align-to is one such example, so it's okay to add it. One other consideration is that Info-index uses substring matches, so having an index entry :foo runs the risk of its turning up in searches for "foo", which could be undesirable if "foo" is a general enough word, like "weight" or similar.