From: Nicolas Goaziou <mail@nicolasgoaziou.fr>
To: Jorge <jorge13515@gmail.com>
Cc: org mode <emacs-orgmode@gnu.org>
Subject: Re: Bug: Several small documentation problems [8.3.6 (8.3.6-4-g4835be-elpaplus @ /home/jorge/.emacs.d/elpa/org-plus-contrib-20160926/)]
Date: Thu, 29 Sep 2016 22:36:53 +0200 [thread overview]
Message-ID: <87intexx22.fsf@nicolasgoaziou.fr> (raw)
In-Reply-To: <CAJR3Qncbq5fdfwV_BxOy60=C+COgp8S5dTxqspYoZF+=_PEZFQ@mail.gmail.com> (Jorge's message of "Thu, 29 Sep 2016 15:36:27 -0300")
Hello,
Jorge <jorge13515@gmail.com> writes:
> This is the first batch of documentation problems. I will report the rest
> later, because preparing this first batch already took several hours.
Those are fixed, except the points below.
> • When describing the behavior with C-u C-u, it wrongly substitutes
> "grandparent" for "parent".
I think "grandparent" is correct. In the following document
* H1
** H2
Text<--point
"H2" is the parent headline of "Text" and as a consequence, "H1" is its
grandparent.
> • [info:org#Structure editing]
> I looked at the code, and C-<RET> (org-insert-heading-respect-content) just
> calls (org-insert-heading '(4) invisible-ok), so it has the same effect as
> C-u M-<RET>. The manual could mention that C-<RET> has the same effect as
> C-u M-<RET>, to aid the user's learning process, as she would just need to
> memorize this quick fact, instead of understanding both behaviors and
> deducing they're equal). Also the manual doesn't adequately explain the
> effect of C-u M-<RET>. And the description of C-<RET> is actually wrong:
> Just like `M-<RET>', except when adding a new heading below the
> current heading, the new heading is placed after the body instead
> of before it. This command works from anywhere in the entry.
> /After the body/? Doesn't it mean /after the entry/? Besides, there are
> additional differences: that M-<RET> may create a new plain list item, while
> C-<RET> always creates a new heading, and that C-<RET> never splits the
> heading. Please rewrite the whole description.
You are right, M-RET and C-RET are confusing, and making C-u M-RET
a duplicate of C-RET is wasting some important keybinding. This was
discussed on this ML already (with Rasmus) but led nowhere so far.
In any case, it is more future-proof to not insist on the fact that
C-RET is C-u M-RET.
Thank you for this tedious, yet very important work.
Regards,
--
Nicolas Goaziou
next prev parent reply other threads:[~2016-09-29 20:36 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-09-29 18:36 Bug: Several small documentation problems [8.3.6 (8.3.6-4-g4835be-elpaplus @ /home/jorge/.emacs.d/elpa/org-plus-contrib-20160926/)] Jorge
2016-09-29 20:36 ` Nicolas Goaziou [this message]
2016-09-30 13:36 ` Jorge
2016-10-01 22:36 ` Nicolas Goaziou
2016-10-02 19:40 ` Jorge
2016-10-04 10:03 ` Nicolas Goaziou
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=87intexx22.fsf@nicolasgoaziou.fr \
--to=mail@nicolasgoaziou.fr \
--cc=emacs-orgmode@gnu.org \
--cc=jorge13515@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).