From: Yuval Langer <yuval.langer@gmail.com>
To: emacs-orgmode@gnu.org
Subject: Suggestion: for each listed keybinding, also name the command
Date: Fri, 5 May 2023 13:51:24 +0300 [thread overview]
Message-ID: <CAK0OjG2hOJry4L4TfefkdKQp3ALX7zML_NwS=gqhD79UE7O42g@mail.gmail.com> (raw)
[-- Attachment #1: Type: text/plain, Size: 573 bytes --]
For many commands, I find it helpful to first learn their names before
learning their keybindings. The org-mode guide does not include
command names.
I want to add command names into the org-mode guide. I have attached
an example of such an addition.
The changes in the first commit might be later dropped as it
might be better to add command names only in the command lists.
This addition might not be appropriate for the org-mode guide, as it
is already covered by the org-mode manual, but I would have found it
very useful if the names of the commands were included.
[-- Attachment #2: 0001-Add-first-function-names.patch --]
[-- Type: text/x-patch, Size: 829 bytes --]
From c03d821a9726e203113d622d1581a02d32b75302 Mon Sep 17 00:00:00 2001
From: Yuval Langer <yuvallangerontheroad@proton.me>
Date: Fri, 5 May 2023 11:57:37 +0300
Subject: [PATCH 1/2] Add first function names.
---
doc/org-guide.org | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/doc/org-guide.org b/doc/org-guide.org
index 95828e4c0..3581e0a5e 100644
--- a/doc/org-guide.org
+++ b/doc/org-guide.org
@@ -141,7 +141,8 @@ See [[*Miscellaneous]] for a setup to realize this.
Outlines make it possible to hide parts of the text in the buffer.
Org uses just two commands, bound to {{{kbd(TAB)}}} and
-{{{kbd(S-TAB)}}} to change the visibility in the buffer.
+{{{kbd(S-TAB)}}} (~org-cycle~ and ~org-shifttab~) to change the
+visibility in the buffer.
#+attr_texinfo: :sep ,
- {{{kbd(TAB)}}} ::
--
2.30.2
[-- Attachment #3: 0002-Add-names-to-a-few-list-entries.patch --]
[-- Type: text/x-patch, Size: 2489 bytes --]
From 08cadefe808c00e186991feec0f66e141a720986 Mon Sep 17 00:00:00 2001
From: Yuval Langer <yuvallangerontheroad@proton.me>
Date: Fri, 5 May 2023 12:38:07 +0300
Subject: [PATCH 2/2] Add names to a few list entries.
---
doc/org-guide.org | 22 ++++++++++++----------
1 file changed, 12 insertions(+), 10 deletions(-)
diff --git a/doc/org-guide.org b/doc/org-guide.org
index 3581e0a5e..3747e2d68 100644
--- a/doc/org-guide.org
+++ b/doc/org-guide.org
@@ -145,7 +145,7 @@ Org uses just two commands, bound to {{{kbd(TAB)}}} and
visibility in the buffer.
#+attr_texinfo: :sep ,
-- {{{kbd(TAB)}}} ::
+- {{{kbd(TAB)}}} (~org-cycle~) ::
/Subtree cycling/: Rotate current subtree among the states
@@ -155,7 +155,7 @@ visibility in the buffer.
When called with a prefix argument ({{{kbd(C-u TAB)}}}), or with the
Shift key, global cycling is invoked.
-- {{{kbd(S-TAB)}}}, {{{kbd(C-u TAB)}}} ::
+- {{{kbd(S-TAB)}}} (~org-shifttab~), {{{kbd(C-u TAB)}}} ::
/Global cycling/: Rotate the entire buffer among the states
@@ -181,15 +181,17 @@ basis by adding a =STARTUP= keyword to =overview=, =content=,
The following commands jump to other headlines in the buffer.
-- {{{kbd(C-c C-n)}}} :: Next heading.
-
-- {{{kbd(C-c C-p)}}} :: Previous heading.
+- {{{kbd(C-c C-n)}}} (~org-next-visible-heading~) :: Next heading.
+- {{{kbd(C-c C-p)}}} (~org-previous-visible-heading~) :: Previous
+ heading.
-- {{{kbd(C-c C-f)}}} :: Next heading same level.
+- {{{kbd(C-c C-f)}}} (~org-backward-heading-same-level~):: Next
+ heading same level.
-- {{{kbd(C-c C-b)}}} :: Previous heading same level.
+- {{{kbd(C-c C-b)}}} (~outline-backward-same-level~) :: Previous
+ heading same level.
-- {{{kbd(C-c C-u)}}} :: Backward to higher level heading.
+- {{{kbd(C-c C-u)}}} (~outline-up-heading~) :: Backward to higher level heading.
** Structure Editing
:PROPERTIES:
@@ -197,14 +199,14 @@ The following commands jump to other headlines in the buffer.
:END:
#+attr_texinfo: :sep ,
-- {{{kbd(M-RET)}}} ::
+- {{{kbd(M-RET)}}} (~org-meta-return~) ::
Insert new heading with same level as current. If point is in
a plain list item, a new item is created (see [[Plain Lists]]). When
this command is used in the middle of a line, the line is split and
the rest of the line becomes the new headline[fn:2].
-- {{{kbd(M-S-RET)}}} ::
+- {{{kbd(M-S-RET)}}} (~org-insert-todo-heading~) ::
Insert new TODO entry with same level as current heading.
--
2.30.2
next reply other threads:[~2023-05-05 10:53 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-05-05 10:51 Yuval Langer [this message]
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
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='CAK0OjG2hOJry4L4TfefkdKQp3ALX7zML_NwS=gqhD79UE7O42g@mail.gmail.com' \
--to=yuval.langer@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).