From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: "Stephen J. Turnbull" Newsgroups: gmane.emacs.devel Subject: Re: Emacs manual: correct @code to @kbd Date: Wed, 10 Jun 2009 11:39:34 +0900 Message-ID: <87iqj4errt.fsf@uwakimon.sk.tsukuba.ac.jp> References: NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=iso-8859-1 Content-Transfer-Encoding: quoted-printable X-Trace: ger.gmane.org 1244601559 2518 80.91.229.12 (10 Jun 2009 02:39:19 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Wed, 10 Jun 2009 02:39:19 +0000 (UTC) Cc: Eli Zaretskii , emacs-devel@gnu.org To: "Aaron S. Hawley" Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Wed Jun 10 04:39:15 2009 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by lo.gmane.org with esmtp (Exim 4.50) id 1MEDid-00077V-4L for ged-emacs-devel@m.gmane.org; Wed, 10 Jun 2009 04:39:15 +0200 Original-Received: from localhost ([127.0.0.1]:45460 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1MEDic-0003MK-SK for ged-emacs-devel@m.gmane.org; Tue, 09 Jun 2009 22:39:14 -0400 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1MEDgX-0001Wg-7Z for emacs-devel@gnu.org; Tue, 09 Jun 2009 22:37:05 -0400 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1MEDgS-0001SA-Ih for emacs-devel@gnu.org; Tue, 09 Jun 2009 22:37:04 -0400 Original-Received: from [199.232.76.173] (port=42028 helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1MEDgS-0001Rw-D1 for emacs-devel@gnu.org; Tue, 09 Jun 2009 22:37:00 -0400 Original-Received: from mtps02.sk.tsukuba.ac.jp ([130.158.97.224]:54941) by monty-python.gnu.org with esmtp (Exim 4.60) (envelope-from ) id 1MEDgO-0004gW-FV; Tue, 09 Jun 2009 22:36:57 -0400 Original-Received: from uwakimon.sk.tsukuba.ac.jp (uwakimon.sk.tsukuba.ac.jp [130.158.99.156]) by mtps02.sk.tsukuba.ac.jp (Postfix) with ESMTP id F19C9820F; Wed, 10 Jun 2009 11:36:46 +0900 (JST) Original-Received: by uwakimon.sk.tsukuba.ac.jp (Postfix, from userid 1000) id EC4931A2679; Wed, 10 Jun 2009 11:39:34 +0900 (JST) In-Reply-To: X-Mailer: VM 8.0.12-devo-585 under 21.5 (beta28) "fuki" 83e35df20028+ XEmacs Lucid (x86_64-unknown-linux) X-detected-operating-system: by monty-python.gnu.org: GNU/Linux 2.6, seldom 2.4 (older, 4) X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:111406 Archived-At: Aaron S. Hawley writes: > On Mon, Jun 8, 2009 at 11:01 PM, Eli Zaretskii wrote: > > > > However, some of your corrections are wrong. =A0For example, this: > > > >> --- doc/emacs/custom.texi =A0 =A0 4 Jun 2009 03:13:28 -0000 =A0 =A0 = =A0 1.22 > >> +++ doc/emacs/custom.texi =A0 =A0 8 Jun 2009 18:49:57 -0000 > >> @@ -1706,7 +1706,7 @@ > >> =A0@end example > >> > >> =A0 =A0When the key sequence includes function keys or mouse button e= vents, > >> -or non-@acronym{ASCII} characters such as @code{C-=3D} or @code{H-a}, > >> +or non-@acronym{ASCII} characters such as @kbd{C-=3D} or @kbd{H-a}, > > > > Since this talks about _characters_, not keystrokes, @kdb is > > inappropriate here, I think. >=20 > Maybe, but the @code isn't appropriate since neither characters nor > "key sequence" are source code. This is the old discussion (cf. http://www.jwz.org/doc/lemacs.html, ignore the politics and focus on the discussion of how the Lemacs event model broke "calc" between Jamie and Dave Gillespie) of whether input characters are characters or events. Emacs takes the position that they are characters and encodes non-character events differently. My personal take is that @kbd means "console input", and the spelling is a legacy of the time when console input was restricted to typing on the keyboard. Cf. the usage of "key sequence" above. @kbd then may be used to mark any literal keystroke (including chords). There's a special convention that keystrokes that resolve to characters may be replaced by the characters in order to make documentation shorter and more readable. So I like @kbd above. The word "characters" is wrong. Actually it's probably an abbreviation of "keyboard input that corresponds to non-ASCII characters", but that's still wrong in a Unicode world, `C-=3D' and `H-a' are not characters. (Granted, in Emacs Lisp characters and integers are the same type in the implementation, but you do have `char-int-p'.)