GNU bug report logs - #8900
24.0.50; please index mentioned coding systems in Emacs manual

Previous Next

Full log

Message #24 received at 8900 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Lars Magne Ingebrigtsen <larsi <at> gnus.org>
Cc: drew.adams <at> oracle.com, 8900 <at> debbugs.gnu.org
Subject: Re: bug#8900: 24.0.50;
	please index mentioned coding systems in Emacs manual
Date: Fri, 01 Jul 2011 20:45:08 +0300

> From: Lars Magne Ingebrigtsen <larsi <at> gnus.org>
> Date: Fri, 01 Jul 2011 16:28:28 +0200
> Cc: 8900 <at> debbugs.gnu.org
> 
> "Drew Adams" <drew.adams <at> oracle.com> writes:
> 
> > Some particular coding systems are mentioned in the Emacs manual,
> > presumably because they are important or instructive.  Please
> > consider adding these terms to the manual's index.
> >
> > `no-conversion', `raw-text', `emacs-internal',
> > `iso-latin-1-unix', `iso-latin-1-dos', `iso-latin-1-mac',
> > `undecided-unix', `undecided-dos', `undecided-mac'.
> 
> Some of these were already in the index, but I've added the remaining
> ones now.

FWIW, I think you put the additional index entries in wrong places.
The index entry should be near the text that describes the concept or
the symbol, not merely mentions it.

For example, this:

  +@cindex @code{iso-latin-1}, coding system
     These variant coding systems are omitted from the
   @code{list-coding-systems} display for brevity, since they are entirely
   predictable.  For example, the coding system @code{iso-latin-1} has

is wrong, because the text does not describe the iso-latin-1 encoding
in any way.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.