unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: "Drew Adams" <drew.adams@oracle.com>
To: "'Eli Zaretskii'" <eliz@gnu.org>
Cc: cyd@stupidchicken.com, david@harpegolden.net,
	emacs-devel@gnu.org, angelo.graziosi@alice.it
Subject: RE: angle-bracket notation for keys   (was: Selection changes)
Date: Sat, 17 Jul 2010 22:42:26 -0700	[thread overview]
Message-ID: <8F4BFF7C861A4C829E17005E14A14690@us.oracle.com> (raw)
In-Reply-To: <83fwzhebgg.fsf@gnu.org>

> > > '<...-insertchar>' is very ugly and... unattractive!
> 
> <FOO> is what makeinfo produces from @key{FOO}.  The purpose of @key
> is to distinguish between a single keypress and typing the keys F, O,
> and O in that order.  In the printed manual, @key produces a picture
> of a key with a label.
> 
> If you want to suggest a change in what @key produces in the on-line
> Info manual, this isn't the right forum.  You need to write to
> bug-texinfo@gnu.org.

I believe this was all discussed in those old threads, and I really do not wish
to reopen the discussion - that wasn't my purpose, as I said.  If others want to
pursue it, fine - I've already summarized what I think about it.  If there's
another tour around the block I'll sit this one out.

To be clear, however, I'm not really concerned about what appears in the printed
manual.  My concern (really, my _only_ concern wrt this question) is the UI and
online doc (Info).  I made that clear before, as well.

And I have nothing to say about the tools we use to create Info or the printed
manual.

My point was only about how Emacs talks about itself when you use it: help,
messages, Info.  The format we use is unnecessarily ugly and noisy.  A better
notation is possible (more than one, no doubt).  That's all.

Whether moving to such a better notation would be difficult in terms of tools
used I cannot say.  I'm not interested in pursuing such tool changes, myself.
If others want to do that, and if bug-texinfo@gnu.org is the place to do it, be
my guest.

To repeat, however, it is not only, or even primarily, about the manual, even
the online one (Info).  The UI is not created by makeinfo, AFAIK.  We've decided
to use angle brackets for named keys throughout the UI.  The Lisp functions that
we've written intentionally return the angle-bracket syntax: `<mouse-2>' vs
`mouse-2'.  That's not the fault of makeinfo.  See the old threads for info
about some of those functions.

The result gets an `A' for consistency, but an `<<F>>' for readability, IMO.
FWIW, I use Emacs 20 quite often (testing libraries etc.), and even though its
use of key notation is inconsistent (`<F1>' and `TAB') it is far better than the
consistent interface of Emacs 22+ - easier on the eyes and brain (parsing).
Fewer unnecessary brackets gives you a welcome break.

You know the tired joke about LISP meaning Lots of Irritating, Superfluous
Parentheses.  Well, they aren't superfluous, but our angle brackets surely are.




  reply	other threads:[~2010-07-18  5:42 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-07-16  1:00 Selection changes Angelo Graziosi
2010-07-16  9:33 ` David De La Harpe Golden
2010-07-17 23:49   ` Angelo Graziosi
2010-07-18  1:54     ` angle-bracket notation for keys (was: Selection changes) Drew Adams
2010-07-18  2:07       ` angle-bracket notation for keys Miles Bader
2010-07-18  3:05       ` angle-bracket notation for keys (was: Selection changes) Eli Zaretskii
2010-07-18  5:42         ` Drew Adams [this message]
2010-07-18 17:21           ` Eli Zaretskii
2010-07-18 19:15             ` Drew Adams
2010-07-18 22:05               ` angle-bracket notation for keys Harald Hanche-Olsen
2010-07-18  9:51       ` Angelo Graziosi
2010-07-18 19:28     ` Selection changes David De La Harpe Golden
2010-07-18 22:39       ` Angelo Graziosi
2010-07-16 12:14 ` Angelo Graziosi

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=8F4BFF7C861A4C829E17005E14A14690@us.oracle.com \
    --to=drew.adams@oracle.com \
    --cc=angelo.graziosi@alice.it \
    --cc=cyd@stupidchicken.com \
    --cc=david@harpegolden.net \
    --cc=eliz@gnu.org \
    --cc=emacs-devel@gnu.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).