From: Nick Dokos <nicholas.dokos@hp.com>
To: Carsten Dominik <carsten.dominik@gmail.com>
Cc: nicholas.dokos@hp.com, emacs-orgmode <emacs-orgmode@gnu.org>
Subject: Re: Re: keys and command name info
Date: Mon, 09 Aug 2010 10:23:32 -0400 [thread overview]
Message-ID: <15431.1281363812@gamaville.dokosmarshall.org> (raw)
In-Reply-To: Message from Carsten Dominik <carsten.dominik@gmail.com> of "Mon, 09 Aug 2010 08:43:21 +0200." <770A61DC-4063-4A72-95F2-21F4E7DE6E77@gmail.com>
Carsten Dominik <carsten.dominik@gmail.com> wrote:
> Some of the original arguments, that these names would stick
> more easily and that it would make it easy for a hacker to
> find the command name for rebinding, these do not fly, I think.
> I don't think anyone calls Org commands with M-x, and if a
> hacker needs to find a command name, `C-h b' and in particular
> `C-h k' are the perfect ways to get to the names.
>
> I have put a version of the manual as modified by Andreas here:
>
> http://orgmode.org/org-manual-with-command-names.pdf
>
> Not all the command names are in there, but quite a few are.
> I'd like to hear from more people
>
> - if they would like to have the names there (i.e. if it would
> help them finding a command)
> - if the position (first thing in the command description)
> is right, or if it would be better to have it
> - last thing in the description
> - or after the first sentence, this is how the GNUS manual
> does it.
>
> Thanks to Andreas for his work so far, and please, let me
> hear more opinions.
>
I have wished for the command names to be in the manual before but
as you say, C-h k works (although sometimes after the C-h k, I find myself
saying "Oh, that one...", whereas I could have said that with a couple
of keystrokes less if the name were in the manual :) )
As for the position, spot-checking the emacs manual shows the command
name at the end of the first sentence in the key description and right
after the key sequence in running text. Here's an example of both
instances:
,----
| `C-d'
| `<DELETE>'
| Delete next character (`delete-char'). If your keyboard has a
| <DELETE> function key (usually located in the edit keypad), Emacs
| binds it to `delete-char' as well.
|
| `<DEL>'
| `<BS>'
| Delete previous character (`delete-backward-char').
|
| `M-\'
| Delete spaces and tabs around point (`delete-horizontal-space').
|
| `M-<SPC>'
| Delete spaces and tabs around point, leaving one space
| (`just-one-space').
|
| `C-x C-o'
| Delete blank lines around the current line (`delete-blank-lines').
|
| `M-^'
| Join two lines by deleting the intervening newline, along with any
| indentation following it (`delete-indentation').
|
| The most basic delete commands are `C-d' (`delete-char') and <DEL>
| (`delete-backward-char'). `C-d' deletes the character after point, the
| ...
`----
I would vote for consistency above all.
I also think (in contrast to Andreas Burtzlaff) that this helps
newbies : I remember finding it very helpful when I first started
writing elisp. And I also remember the (momentary) annoyance I felt when
I was first reading the Org manual: I was used to the emacs manual
conventions and habits die hard!
My 2 cents,
Nick
next prev parent reply other threads:[~2010-08-09 14:23 UTC|newest]
Thread overview: 44+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-07-28 19:36 keys and command name info Andreas Röhler
2010-07-29 6:45 ` Tassilo Horn
2010-07-29 13:47 ` Andreas Röhler
2010-07-29 15:19 ` Andreas Röhler
2010-07-29 18:08 ` Tassilo Horn
2010-07-30 9:40 ` Andreas Röhler
2010-08-07 19:39 ` Carsten Dominik
2010-08-08 13:57 ` Andreas Röhler
2010-07-31 8:53 ` Bastien
2010-07-31 17:53 ` Andreas Röhler
2010-07-31 19:02 ` Thomas S. Dye
2010-08-01 9:42 ` Bastien
2010-08-01 16:40 ` Andreas Röhler
2010-08-02 6:32 ` Carsten Dominik
2010-08-08 22:26 ` Gregor Zattler
2010-08-09 6:43 ` Carsten Dominik
2010-08-09 9:37 ` Andreas Burtzlaff
2010-08-09 10:19 ` Gregor Zattler
2010-08-09 10:31 ` Carsten Dominik
2010-08-09 18:32 ` Dan Davison
2010-08-09 19:28 ` Dan Davison
2010-08-11 10:05 ` Carsten Dominik
2010-08-11 10:23 ` Andreas Röhler
2010-08-11 10:27 ` Carsten Dominik
2010-08-13 13:45 ` Andreas Röhler
2010-08-13 14:20 ` Dan Davison
2010-08-13 19:30 ` Andreas Röhler
2010-08-15 7:37 ` Carsten Dominik
2010-08-15 7:39 ` Carsten Dominik
2010-08-15 19:07 ` Andreas Röhler
2010-08-16 8:57 ` Carsten Dominik
2010-08-17 12:43 ` Andreas Röhler
2010-08-18 8:38 ` Carsten Dominik
2010-08-20 6:27 ` Andreas Röhler
2010-08-20 7:31 ` Carsten Dominik
2010-08-20 8:13 ` Andreas Röhler
2010-08-20 7:44 ` Carsten Dominik
2010-08-17 15:44 ` Andreas Röhler
2010-08-10 1:28 ` Memnon Anon
2010-08-09 14:23 ` Nick Dokos [this message]
2010-08-10 7:48 ` OT: smex.el (was Re: keys and command name info) Austin Frank
2010-08-20 11:20 ` keys and command name info Carsten Dominik
2010-08-20 11:32 ` Stefan Vollmar
2010-08-20 13:23 ` Bernt Hansen
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.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=15431.1281363812@gamaville.dokosmarshall.org \
--to=nicholas.dokos@hp.com \
--cc=carsten.dominik@gmail.com \
--cc=emacs-orgmode@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/org-mode.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).