unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Stefan Kangas <stefan@marxist.se>
Cc: 50467@debbugs.gnu.org
Subject: bug#50467: Could :properties have index entries in the elisp manual?
Date: Fri, 10 Sep 2021 10:14:00 +0300	[thread overview]
Message-ID: <83y284j41z.fsf@gnu.org> (raw)
In-Reply-To: <CADwFkm=T6w8c5jt5Xj0THZL=oLB-ZA2jpOxPh6dvs=Pb6DV_NA@mail.gmail.com> (message from Stefan Kangas on Fri, 10 Sep 2021 09:00:00 +0200)

> From: Stefan Kangas <stefan@marxist.se>
> 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 <eliz@gnu.org> 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.





  reply	other threads:[~2021-09-10  7:14 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-08  1:52 bug#50467: Could :properties have index entries in the elisp manual? Stefan Kangas
2021-09-08  5:51 ` Lars Ingebrigtsen
2021-09-08  6:31 ` Eli Zaretskii
2021-09-08 15:55   ` bug#50467: [External] : " Drew Adams
2021-09-10  6:54   ` Stefan Kangas
2021-09-10  7:00   ` Stefan Kangas
2021-09-10  7:14     ` Eli Zaretskii [this message]
2022-08-25 14:26       ` Lars Ingebrigtsen

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=83y284j41z.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=50467@debbugs.gnu.org \
    --cc=stefan@marxist.se \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).