all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: "Drew Adams" <drew.adams@oracle.com>
Cc: 3516@emacsbugs.donarmstrong.com
Subject: bug#3516: 23.0.94; function key names in Info
Date: Thu, 11 Jun 2009 06:42:20 -0400	[thread overview]
Message-ID: <E1MEhjg-0003cL-6A@fencepost.gnu.org> (raw)
In-Reply-To: <AA12955E7AC541C6AC6B04BDAB154319@us.oracle.com> (drew.adams@oracle.com)

> From: "Drew Adams" <drew.adams@oracle.com>
> Date: Wed, 10 Jun 2009 15:33:50 -0700
> 
> > > We see things like <F1>, <F2>, <RET>, and <ESC> without single
> > > quotes. Similarly, in other parts of the manual.
> > >  
> > > Shouldn't those be `<f1>', `<f2>', `<RET>', and `<ESC>'?
> > >  
> > > We use `C-x <RET>' here, and we use `C-x', but not `<RET>'. 
> > > Likewise, we use `<ESC>C-h' (which should be `<ESC> C-h', BTW),
> > > but not `<ESC>'.
> > >  
> > > The notation used does not seem consistent.
> > > Why write "(`C-h' or <F1>)", instead of "(`C-h' or `<F1>')"?
> > 
> > Please show here the Texinfo sources, not just the text from the Info
> > manual.  I'm not saying that all you report is necessarily correct,
> > but it could be: ESC and RET are both characters and keys.  In the
> > character context, ESC and RET are correct, while in the key context,
> > `<ESC>' and `<SPC>' are correct (the latter comes from @key, and I
> > don't remember now whether @key produces the quotes in addition to
> > <..>).
> 
> I don't have the Texinfo sources.
> 
> I'm just an Emacs user reporting what seems to be an Emacs bug - in Info.

You are more than "just a user", Drew, let's be honest.

Anyway, at least provide these quotes with context.  Grepping through
Info files for "<SPC>" and the likes is no fun.  Since you already
look at the surrounding text, pasting it into the bug report should
be easy.

> For my part, I was referring to (or trying to refer to) passages that talk about
> keys, not characters. To me, key sequences should be wrapped in `...', even when
> they have <...>. To me, the key sequence should be written `<SPC>' even if the
> character is written SPC.

We use <ESC> and such likes for keyboard keys that are labeled with
more than a single character.  The issue here is to prevent confusion
on the reader's part between a single key labeled "ESC" and a sequence
of 3 keys E, S, C.

When a key is labeled with a single character, this confusion cannot
happen, so <..> is not used in that case, because it would just make
the reading harder with no good reason.

Likewise, key sequences such as C-k are not single keys, you actually
use 2 or more keys to type them.  So <..> is inappropriate in that
context as well.

Thus, single keys and key sequences get different markup.





  reply	other threads:[~2009-06-11 10:42 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-06-09 16:11 bug#3516: 23.0.94; function key names in Info Drew Adams
2009-06-10 22:23 ` Eli Zaretskii
2009-06-10 22:33   ` Drew Adams
2009-06-11 10:42     ` Eli Zaretskii [this message]
2009-06-11 15:33       ` Drew Adams
2011-07-12 12:47 ` Lars Magne Ingebrigtsen
2011-07-12 16:00   ` Eli Zaretskii
2011-07-12 16:38     ` Drew Adams
2011-07-12 17:15       ` Eli Zaretskii
2011-07-12 20:04         ` Drew Adams
2011-07-12 20:30           ` Eli Zaretskii
2011-07-12 21:03             ` Drew Adams
2011-07-13  3:00               ` Eli Zaretskii

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=E1MEhjg-0003cL-6A@fencepost.gnu.org \
    --to=eliz@gnu.org \
    --cc=3516@emacsbugs.donarmstrong.com \
    --cc=drew.adams@oracle.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.