From: Tassilo Horn <tassilo@member.fsf.org>
To: emacs-orgmode@gnu.org
Subject: Re: keys and command name info
Date: Thu, 29 Jul 2010 08:45:19 +0200 [thread overview]
Message-ID: <87zkxa7pmo.fsf@member.fsf.org> (raw)
In-Reply-To: 4C5086C1.9060000@easy-emacs.de
Andreas Röhler <andreas.roehler@easy-emacs.de> writes:
Hi Andreas,
> what about delivering mnemonic command names alongside with its keys
> in org-info?
That would be good practice, and I think it's more or less standard for
emacs packages. For example, that is from Gnus:
,----[ (info "(gnus)Summary Post Commands") ]
| `S p'
| `a'
| Prepare for posting an article (`gnus-summary-post-news'). By
| default, post to the current group. If given a prefix, disable
| that. If the prefix is 1, prompt for another group instead.
|
| `S f'
| `f'
| Post a followup to the current article (`gnus-summary-followup').
`----
> 8.1. Agenda files
>
> [ ... ]
> `C-c ['
> Add current file to the list of agenda files. The file is added to
> the front of the list. If it was already in the list, it is moved
> to the front. With prefix arg, file is added/moved to the end.
>
> might be provided as
>
> 8.1. Agenda files
>
> [ ... ]
> `C-c [', org-agenda-file-to-front
> Add current file to the list of agenda files. The file is added to
> the front of the list. If it was already in the list, it is moved
> to the front. With prefix arg, file is added/moved to the end.
I'd write it in parens with the usual function markup at the end of the
first sentence, just like it's done in Gnus. The 2 Gnus entries above
have this definition:
--8<---------------cut here---------------start------------->8---
@table @kbd
@item S p
@itemx a
@kindex a (Summary)
@kindex S p (Summary)
@findex gnus-summary-post-news
@c @icon{gnus-summary-post-news}
Prepare for posting an article (@code{gnus-summary-post-news}). By
default, post to the current group. If given a prefix, disable that.
If the prefix is 1, prompt for another group instead.
@item S f
@itemx f
@kindex f (Summary)
@kindex S f (Summary)
@findex gnus-summary-followup
@c @icon{gnus-summary-followup}
Post a followup to the current article (@code{gnus-summary-followup}).
--8<---------------cut here---------------end--------------->8---
So basically, you only have to add the command name with @code{} at the
appropriate place and add an index item to the function index with
@findex{}.
> IMHO it's useful for emacs-beginners, but for hackers too, as
> remembering function names may precede remembering keys - which are to
> change individually anyway.
Exactly, and using `C-h f' you can easily switch to *Help* to lookup the
exact docstring and signature. And from *Help*, the function definition
is only one click away.
> Should you be interested, I'll consider to take action with
> texi-files.
I'd welcome such an enhancement to the docs, and I'm pretty sure nobody
will object. :-)
Bye,
Tassilo
next prev parent reply other threads:[~2010-07-29 6:45 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 [this message]
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
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=87zkxa7pmo.fsf@member.fsf.org \
--to=tassilo@member.fsf.org \
--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).