GNU bug report logs - #24827
24.5; Elisp manual: add index entries for syntax highlighting

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 24827 in the body.
You can then email your comments to 24827 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

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

From: Drew Adams <drew.adams <at> oracle.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 24.5; Elisp manual: add index entries for syntax highlighting
Date: Sun, 30 Oct 2016 09:48:32 -0700 (PDT)

While trying to help someone find information about using font-locking,
I said to use `i' in the Elisp manual.  I expected that the common
terminology "syntax highlighting" would get them to the manual sections
about font-locking.

There is apparently no index entry that includes "highlight", and in
particular no index entries for "syntax highlighting", "highlighting
syntax", etc.

Please consider adding such entries.  Someone new to Emacs will likely
think in terms of syntax highlighting and may not be familiar with the
Emacsism "font-locking".

In GNU Emacs 24.5.1 (i686-pc-mingw32)
 of 2015-04-11 on LEG570
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --prefix=/c/usr --host=i686-pc-mingw32'

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 24827 <at> debbugs.gnu.org
Subject: Re: bug#24827: 24.5;
 Elisp manual: add index entries for syntax highlighting
Date: Sun, 30 Oct 2016 19:08:24 +0200

> Date: Sun, 30 Oct 2016 09:48:32 -0700 (PDT)
> From: Drew Adams <drew.adams <at> oracle.com>
> 
> There is apparently no index entry that includes "highlight", and in
> particular no index entries for "syntax highlighting", "highlighting
> syntax", etc.

There is such an index entry in the Emacs user manual.

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

From: Drew Adams <drew.adams <at> oracle.com>
To: Eli Zaretskii <eliz <at> gnu.org>, Drew Adams <drew.adams <at> oracle.com>
Cc: 24827 <at> debbugs.gnu.org
Subject: RE: bug#24827: 24.5;	Elisp manual: add index entries for syntax
 highlighting
Date: Sun, 30 Oct 2016 10:13:35 -0700 (PDT)

> > There is apparently no index entry that includes "highlight", and
> > in particular no index entries for "syntax highlighting",
> > "highlighting syntax", etc.
> 
> There is such an index entry in the Emacs user manual.

Great.  That's a good start.  Please consider adding it to
the Elisp manual as well.

Some (maybe most) users who want to implement or customize
syntax highlighting will go directly to the Elisp manual,
expecting (correctly) that this is done using Elisp.

And in fact one of the most relevant nodes for this topic
is `Customizing Keywords'.  "Customizing" is a human task -
this is a case where the Elisp manual (correctly) includes
some guide-like information.

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

From: Stefan Kangas <stefan <at> marxist.se>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 24827 <at> debbugs.gnu.org, Eli Zaretskii <eliz <at> gnu.org>
Subject: Re: bug#24827: 24.5;
 Elisp manual: add index entries for syntax highlighting
Date: Fri, 17 Jan 2020 00:05:12 +0100

close 24827 28.1
thanks

Drew Adams <drew.adams <at> oracle.com> writes:

>> > There is apparently no index entry that includes "highlight", and
>> > in particular no index entries for "syntax highlighting",
>> > "highlighting syntax", etc.
>> 
>> There is such an index entry in the Emacs user manual.
>
> Great.  That's a good start.  Please consider adding it to
> the Elisp manual as well.

I've now done that on the master branch in commit 025d6ac1d9.
Closing this bug.

Best regards,
Stefan Kangas

Previous Next

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