unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
Cc: karl@freefriends.org, emacs-devel@gnu.org, bojohan+news@dd.chalmers.se
Subject: Re: drew.adams@oracle.com: bug in read-kbd-macro
Date: Wed, 27 Sep 2006 06:33:44 +0300	[thread overview]
Message-ID: <ubqp2rnjb.fsf@gnu.org> (raw)
In-Reply-To: <EIENLHALHGIMHGDOLMIMCEKBCLAA.drew.adams@oracle.com>

> From: "Drew Adams" <drew.adams@oracle.com>
> Cc: <bojohan+news@dd.chalmers.se>, <emacs-devel@gnu.org>,
>         <karl@freefriends.org>
> Date: Tue, 26 Sep 2006 17:18:37 -0700
> 
> The UI notation is not the same as the manual notation.

What is ``the UI notation''?

> You, I think, are speaking of consistency within the manual.

Yes.

>     > 2. It's useful to have the same notation for both online
>     and printed manual, in general.
>     
>     Given how @key is typeset in the printed version, this is
>     clearly impossible, except in the graphics session of Emacs,
>     and then only if we hide the text of the Info file and show
>     some image in its stead.
> 
> No; it is possible.  Just do the opposite: bring the printed
> version into line with the online version, even the non-graphic
> (i.e. console) version, by using `next' for both.

I think this is silly.  The printed version is more powerful than a
plain text version, and there's no need to go to the lowest common
denominator just for consistency's sake.  It's good enough that the
two are sufficiently similar.

Btw, @var causes its argument to be typeset in italics in the printed
version, but in the Info version it produces UPPERCASE.  Would you
suggest to typeset it in upper-case in the printed manual as well, for
consistency's sake?  It's absurd, I think.

> I explained (in the part that you omitted) that separation by
> spaces (e.g. `p r i o r' vs `prior') is an alternative convention
> for a key sequence, which disambiguates the two just as well

The problem is not how to show sequence of keys, the problem is how to
prevent the user from erroneously interpreting "Type `FOO'" as meaning
that she should type those literal characters.  It's about possible
reader's confusion, not about our notation.

  reply	other threads:[~2006-09-27  3:33 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2006-09-25  3:18 drew.adams@oracle.com: bug in read-kbd-macro Richard Stallman
2006-09-25 19:55 ` Chong Yidong
2006-09-25 22:43   ` Drew Adams
2006-09-25 23:16     ` Chong Yidong
2006-09-26  0:20       ` Drew Adams
2006-09-26 14:13     ` Johan Bockgård
2006-09-26 15:02       ` Drew Adams
2006-09-26 20:35         ` Eli Zaretskii
2006-09-27  0:18           ` Drew Adams
2006-09-27  3:33             ` Eli Zaretskii [this message]
2006-09-27  6:22               ` Drew Adams
2006-09-27 18:10                 ` Eli Zaretskii
2006-09-27 18:51                   ` Miles Bader
2006-09-27 19:06                     ` David Kastrup
2006-09-27 20:31                       ` Kim F. Storm
2006-09-26 15:41     ` Richard Stallman
2006-09-26  1:02   ` Richard Stallman

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

  List information: https://www.gnu.org/software/emacs/

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

  git send-email \
    --in-reply-to=ubqp2rnjb.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=bojohan+news@dd.chalmers.se \
    --cc=emacs-devel@gnu.org \
    --cc=karl@freefriends.org \
    /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 public inbox

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

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).