unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Xue Fuqiao <xfq.free@gmail.com>
Cc: emacs-devel@gnu.org
Subject: Index entry for Object Replacement Character
Date: Tue, 05 Nov 2013 19:59:10 +0200	[thread overview]
Message-ID: <83txfq7ms1.fsf@gnu.org> (raw)

I don't understand why you added an index entry for this.  Can you
explain?

Here's my take on this: Index entries exist to make it easier for the
reader to find the description/discussion of a subject.  In this case,
the subject of the text where the Object Replacement Character is
reordering of display properties in bidirectional text.  The fact that
the Emacs implementation treats text covered by a display property as
if it were a single character with the bidirectional properties of
u+FFFC is an implementation detail, mentioned by the way for those who
are interested enough to look up that character.  The text does not
explain anything about that character, and doesn't say why it was
chosen for this role.  The character is mentioned once, and that's it.

Therefore, I find it hard to believe that any reader will thing about
this character's name as a good string to try at the prompt of the
Info's 'i' command.  Likewise, I see no reason why someone who wants
to know about this character will look for its description in the ELisp
manual.  So having this index entry there is not useful.

More generally, not every term you see in a manual deserves an index
entry.  It only does deserve an entry if (a) the term is described and
explained at that place, and (b) there's a high probability that
readers will think about the phrase you put in an index entry when
they are looking for the subject described at that place.



             reply	other threads:[~2013-11-05 17:59 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-11-05 17:59 Eli Zaretskii [this message]
2013-11-06 14:22 ` Index entry for Object Replacement Character Xue Fuqiao
2013-11-07  6:27   ` Thien-Thi Nguyen
2013-11-07 15:56     ` Eli Zaretskii
2013-11-08  7:55       ` Thien-Thi Nguyen
2013-11-08  8:35         ` Eli Zaretskii
2013-11-08  7:50     ` Xue Fuqiao
2013-11-08 11:32       ` Thien-Thi Nguyen
2013-11-08 14:03         ` Eli Zaretskii
2013-11-08 19:35           ` Thien-Thi Nguyen

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=83txfq7ms1.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=emacs-devel@gnu.org \
    --cc=xfq.free@gmail.com \
    /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).