From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: "Robert J. Chassell" Newsgroups: gmane.emacs.devel Subject: Re: rcirc manual Date: Sat, 14 Jan 2006 12:20:30 +0000 (UTC) Message-ID: References: <87ek3hgunn.fsf@killalla.dreaming> Reply-To: bob@rattlesnake.com NNTP-Posting-Host: main.gmane.org X-Trace: sea.gmane.org 1137243461 9648 80.91.229.2 (14 Jan 2006 12:57:41 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Sat, 14 Jan 2006 12:57:41 +0000 (UTC) Cc: emacs-devel@gnu.org, karl@freefriends.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sat Jan 14 13:57:36 2006 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by ciao.gmane.org with esmtp (Exim 4.43) id 1ExkyB-0003vx-Jj for ged-emacs-devel@m.gmane.org; Sat, 14 Jan 2006 13:57:26 +0100 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1Exl0L-0004wJ-A3 for ged-emacs-devel@m.gmane.org; Sat, 14 Jan 2006 07:59:37 -0500 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1ExkQy-00079G-9c for emacs-devel@gnu.org; Sat, 14 Jan 2006 07:23:05 -0500 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1ExkQu-00078k-3o for emacs-devel@gnu.org; Sat, 14 Jan 2006 07:23:00 -0500 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1ExkQs-00078M-69 for emacs-devel@gnu.org; Sat, 14 Jan 2006 07:22:58 -0500 Original-Received: from [69.168.108.225] (helo=rattlesnake.com) by monty-python.gnu.org with esmtp (Exim 4.34) id 1ExkTu-0005OZ-MW; Sat, 14 Jan 2006 07:26:06 -0500 Original-Received: by rattlesnake.com via sendmail from stdin id (Debian Smail3.2.0.115) Sat, 14 Jan 2006 12:20:30 +0000 (UTC) Original-To: Eli Zaretskii In-reply-to: (message from Eli Zaretskii on Sat, 14 Jan 2006 10:51:19 +0200) 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:49071 Archived-At: > @key{TAB} is typeset to show an image of a key on a keyboard. I > think it is not the right markup in this case, because this manual > does not talk about keys, it talks about typing a TAB. Use the `@kbd' command for characters of input to be typed by users. ... Use the `@key' command for the conventional name for a key on a keyboard ... Bob, I know what the Texinfo manual says about this issue, I just think it's not 100% clear what it means in practice. For example, you could use either @kbd{M-@key{x}} or @kbd{M-x} (since `x' ``describes a key by name''), but the Texinfo manual doesn't touch this dilemma. My keyboard has a key labelled "Tab" but conventionally, its input can be sent either by pressing that key or by pressing C-i. So it seems to be that in the question of the rcirc manual, @kbd{TAB} makes most sense. ... @key is appropriate when talking about keys on the keyboard, like in the Emacs manual chapter which explains the Backspace/Delete/DEL issue ... Yes, I agree. I think the effect of @key is not what you want; in particular @kbd{M-@key{x}} looks ugly. I just tested the example, @kbd{C-x @key{ESC}}, in Texinfo. (No one that I know would write @kbd{M-@key{x}}. Instead, he or she would write either @kbd{M-x} or @key{M-x}.) For @kbd{C-x @key{ESC}}, both the Info and the DVI outputs look fine to me. I particularly like this output since it tells me, perhaps wrongly, that I am supposed to press the key and not C-[. ... if the text is something like "press the TAB key", then @key{TAB} is the right markup, but if the text says "you can use TAB for completion", I'd use @kbd{TAB}. Yes. I agree. Of course, everyone must check lest someone say "press the TAB key" when he or she really means "you can use TAB ...", but that is a different issue. -- Robert J. Chassell bob@rattlesnake.com GnuPG Key ID: 004B4AC8 http://www.rattlesnake.com http://www.teak.cc