From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.devel Subject: Re: rcirc manual Date: Sat, 14 Jan 2006 10:51:19 +0200 Message-ID: References: <87ek3hgunn.fsf@killalla.dreaming> Reply-To: Eli Zaretskii NNTP-Posting-Host: main.gmane.org X-Trace: sea.gmane.org 1137230025 8246 80.91.229.2 (14 Jan 2006 09:13:45 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Sat, 14 Jan 2006 09:13:45 +0000 (UTC) Cc: karl@freefriends.org, emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sat Jan 14 10:13:43 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 1ExhTc-0000vD-84 for ged-emacs-devel@m.gmane.org; Sat, 14 Jan 2006 10:13:36 +0100 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1ExhVm-0004kf-Cf for ged-emacs-devel@m.gmane.org; Sat, 14 Jan 2006 04:15:50 -0500 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1ExhAO-0004vP-FI for emacs-devel@gnu.org; Sat, 14 Jan 2006 03:53:44 -0500 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1ExhAM-0004uI-8a for emacs-devel@gnu.org; Sat, 14 Jan 2006 03:53:43 -0500 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1ExhAK-0004sx-CO for emacs-devel@gnu.org; Sat, 14 Jan 2006 03:53:41 -0500 Original-Received: from [192.114.186.66] (helo=romy.inter.net.il) by monty-python.gnu.org with esmtp (Exim 4.34) id 1ExhDS-0001oQ-60 for emacs-devel@gnu.org; Sat, 14 Jan 2006 03:56:54 -0500 Original-Received: from HOME-C4E4A596F7 (IGLD-80-230-201-225.inter.net.il [80.230.201.225]) by romy.inter.net.il (MOS 3.7.3-GA) with ESMTP id DJG08314 (AUTH halo1); Sat, 14 Jan 2006 10:51:14 +0200 (IST) Original-To: bob@rattlesnake.com In-reply-to: (bob@rattlesnake.com) 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:49068 Archived-At: > Date: Fri, 13 Jan 2006 22:16:23 +0000 (UTC) > From: "Robert J. Chassell" > > @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. > > >From the Texinfo Manual: 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. Over the years, I formed a personal opinion about this, based on the way @key typesets its argument in print, and that opinion was what I wrote: @key is appropriate when talking about keys on the keyboard, like in the Emacs manual chapter which explains the Backspace/Delete/DEL issue or in the "Inserting Text" section that explains the basics. Everywhere else, with rare exceptions, I think the effect of @key is not what you want; in particular @kbd{M-@key{x}} looks ugly. So, in the situation like the one which led to this discussion, 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}.