emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Ihor Radchenko <yantar92@posteo.net>
To: Yuval Langer <yuval.langer@gmail.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: Suggestion: for each listed keybinding, also name the command
Date: Wed, 10 May 2023 11:30:42 +0000	[thread overview]
Message-ID: <87v8h0a0f1.fsf@localhost> (raw)
In-Reply-To: <CAK0OjG3n80L0PUbjiJjXGH_3wk8rQcsZmtUahOWUawQkLryEWA@mail.gmail.com>

Yuval Langer <yuval.langer@gmail.com> writes:

> I have:
>
> - Added all the obvious commands to the `- {{{kbd(…)}}} ::` lines.

Thanks, but after your patch the manual does not compile.
Did you try to generate the guide via "make docs" after the patch?

> - Left several of these lines without a command where I've the manual
> do the same.

May you please list these?

> -- {{{kbd(S-TAB)}}}, {{{kbd(C-u TAB)}}} ::
> +- {{{kbd(S-TAB)}}} (~org-global-cycle~), {{{kbd(C-u TAB)}}} ::

Why nothing for C-u TAB?

> -- {{{kbd(C-c C-l)}}} (with point on existing link) ::
> +- {{{kbd(C-c C-l)}}} (with point on existing link) (~org-insert-link~) ::

This is inconsistent with other similar cases, where the key binding is
followed by some text. You added command name right after the key
binding, not after the text.
  
> -- {{{kbd(C-c C-c)}}} ::
> +- {{{kbd(C-c C-c)}}} (~org-toggle-checkbox~), {{{kbd(C-u C-c C-c)}}} ::

Why nothing for C-u ... ?
  
> -- {{{kbd(C-c / m)}}} or {{{kbd(C-c \)}}} ::
> +- {{{kbd(C-c / m)}}} or {{{kbd(C-c \)}}} (~org-match-sparse-tree~) ::

What about C-c / ?
  
>  #+attr_texinfo: :sep or
> -- {{{kbd(C-c [)}}} ::
> +- {{{kbd(C-c [)}}} (~org-agenda-file-to-front~) ::

Please, pay attention to :sep list attribute (see 13.14.9 Plain lists in
Tex info export). You need to change it here because "or" separator no
longer works as the command name contains "..or..". This change makes
the compilation fail.

Basically, you need to change the separator to, say, ";" and alter the
following list items accordingly. 

>    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 a prefix argument, file is added/moved to the
>    end.
>  
> -- {{{kbd(C-c ])}}} ::
> +- {{{kbd(C-c ])}}} (~org-remove-file~) ::

Same here.
  
> -- {{{kbd(r)}}}, {{{kbd(g)}}} ::
> +- {{{kbd(r)}}} (~org-agenda-redo~), {{{kbd(g)}}} ::

Why nothing for "g"?

>  #+attr_texinfo: :sep ,
> -- {{{kbd(C-c C-e t a)}}}, {{{kbd(C-c C-e t u)}}} ::
> +- {{{kbd(C-c C-e t a)}}} (~org-ascii-export-to-ascii~), {{{kbd(C-c C-e t u)}}} ::

What about C-c C-e t u?

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>


      reply	other threads:[~2023-05-10 11:28 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-05-05 10:51 Suggestion: for each listed keybinding, also name the command Yuval Langer
2023-05-05 11:01 ` [POLL] Add command names to key bindings in Org Guide? (was: Suggestion: for each listed keybinding, also name the command) Ihor Radchenko
2023-05-05 13:45   ` [POLL] Add command names to key bindings in Org Guide? Esteban Ordóñez
2023-05-05 13:59     ` Ihor Radchenko
2023-05-06  5:26   ` [POLL] Add command names to key bindings in Org Guide? (was: Suggestion: for each listed keybinding, also name the command) Adham Omran
2023-05-06 11:40     ` Corwin Brust
2023-05-06  6:25   ` Jens Neuhalfen
2023-07-19  9:53   ` Ihor Radchenko
2023-05-07 13:49 ` Suggestion: for each listed keybinding, also name the command Yuval Langer
2023-05-10 11:30   ` Ihor Radchenko [this message]

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=87v8h0a0f1.fsf@localhost \
    --to=yantar92@posteo.net \
    --cc=emacs-orgmode@gnu.org \
    --cc=yuval.langer@gmail.com \
    /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).