From: "Andreas Röhler" <andreas.roehler@easy-emacs.de>
To: Carsten Dominik <dominik@uva.nl>
Cc: emacs-orgmode <emacs-orgmode@gnu.org>,
Carsten Dominik <carsten.dominik@gmail.com>
Subject: Re: Re: keys and command name info
Date: Sun, 15 Aug 2010 21:07:51 +0200 [thread overview]
Message-ID: <4C683B07.6090206@easy-emacs.de> (raw)
In-Reply-To: <86490E4E-6B55-4596-82A9-1BDD1079B1F0@uva.nl>
Am 15.08.2010 09:39, schrieb Carsten Dominik:
>
> On Aug 15, 2010, at 9:37 AM, Carsten Dominik wrote:
>
>>
>> On Aug 13, 2010, at 9:30 PM, Andreas Röhler wrote:
>>
>>> Am 11.08.2010 12:05, schrieb Carsten Dominik:
>>>>
>>>> On Aug 9, 2010, at 9:28 PM, Dan Davison wrote:
>>>>
>>>>> Dan Davison <davison@stats.ox.ac.uk> writes:
>>>>>
>>>>>> Gregor Zattler <telegraph@gmx.net> writes:
>>>>>>
>>>>>>> Hi Andreas, org-mode developers,
>>>>>>> * Andreas Burtzlaff <andy13@gmx.net> [09. Aug. 2010]:
>>>>>>>> Carsten Dominik <carsten.dominik@gmail.com> writes:
>>>>>>>>> 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)
>>>>>>
>>>>>> I would like the command names in the manual.
>>>>>>
>>>>>> - Emacs-lisp has a lovely tradition of naming functions *very*
>>>>>> descriptively and not being afraid to use long names in the interests
>>>>>> of accuracy. It's a shame to lose all that by displaying only key
>>>>>> sequences. It's a linguistic world of its own and I like being
>>>>>> exposed
>>>>>> to it.
>>>>>> - While one can do C-h k, that's not the same as the way one
>>>>>> learns the
>>>>>> function names by skimming the manual
>>>>>
>>>>> Also, it does not add length to the HTML version of the manual,
>>>>> because
>>>>> the key sequences are already on a line of their own. And the same is
>>>>> true for a certain proportion of the pdf entries (when the key
>>>>> sequence
>>>>> is long, then it seems to go on its own line).
>>>>>
>>>>>
>>>>>>
>>>>>>>>> - 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.
>>>>>>
>>>>>> I definitely would want them out on a line of their own with the key
>>>>>> sequence. I liked the right-aligned model.
>>>>>>
>>>>>> Or if not right-aligned, is it possible not to have the comma?
>>>>>> Maybe a
>>>>>> different font?
>>>>
>>>> I also like the position on the key line best. So if there is a
>>>> more-or-less
>>>> general agreement that we should get the names in, this would be my
>>>> preferred
>>>> location as well. I knot that this is different from what the emacs
>>>> and gnus manuals do - but I still think that a solution like this would
>>>> be better.
>>>>
>>>> Andreas, can you be bothered to rework the patch?
>>>>
>>>> Unfortunately I have no idea if/how the right-aligned model could be
>>>> made to
>>>> work. So I think the safest way to do this would be to introduce the
>>>> macro,
>>>> and we can then work on the macro to get the formatting right, and also
>>>> to do the
>>>> key and function index stuff fully automatically.
>>>>
>>>> Here is my proposal for now:
>>>>
>>>> @macro orgcmd{key,command}
>>>> @kindex \key\
>>>> @findex \command\
>>>> @item \key\ @ @ @ @ @ @ @ @ @ @ @r{(}\command\@r{)}
>>>> @end macro
>>>>
>>>> And then define keys/commands like this:
>>>>
>>>> @table @kbd
>>>> .....
>>>> @orgcmd{@key{TAB}, org-cycle}
>>>> Here follows the description of the command
>>>> ....
>>>> @end table
>>>>
>>>> - Carsten
>>>>
>>>>
>>> [ ... ]
>>>
>>> Hi Carsten,
>>>
>>> attached a sreenshot, how it comes out for C-c C-b.
>>> Doesn't look ok for me, as back-tick and quote are uncommon that way.
>>
>> Hi Andreas, you are correct, this does not look right.
>> Seems like we will have to make the table ins @asis and
>> then have the macro apply the formatting. Sigh... :)
>
> If you do insert all the macro calls with the command names, I will take
> care of the formatting.
>
> - Carsten
>
Hi,
will do that.
Let us check nonetheless a working example first.
While trying to put @asis at the right place, I get error messages and
it refuses to compile.
Could you re-write the example for me?
Sorry being that stupid :-)
Andreas
next prev parent reply other threads:[~2010-08-15 20:28 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 [this message]
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=4C683B07.6090206@easy-emacs.de \
--to=andreas.roehler@easy-emacs.de \
--cc=carsten.dominik@gmail.com \
--cc=dominik@uva.nl \
--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).