From: Matt <matt@excalamus.com>
To: "Ihor Radchenko" <yantar92@posteo.net>
Cc: "\"Sławomir Grochowski\"" <slawomir.grochowski@gmail.com>,
emacs-orgmode <emacs-orgmode@gnu.org>
Subject: Re: [PATCH] doc/org-manual.org (Checkboxes): move section 'Checkboxes' from 'TODO Items' to 'Plain Lists'
Date: Tue, 27 Feb 2024 17:47:37 +0100 [thread overview]
Message-ID: <18deb76f2d9.cad957fe1073948.9203602429479305690@excalamus.com> (raw)
In-Reply-To: <87plwjmwhj.fsf@localhost>
---- On Mon, 26 Feb 2024 09:56:44 +0100 Ihor Radchenko wrote ---
> Ihor Radchenko yantar92@posteo.net> writes:
>
> > I do not have a strong opinion here though. If more people chime in here
> > and support re-arrangement, I will not oppose.
>
> No comments arrived within one month. Does not look like people care
> much about this. So, let's preserve the existing structure of the
> manual.
>
> Canceled.
I had responded in favor here: https://list.orgmode.org/18d4cf138a6.10fb9c6702382826.5023996590743168415@excalamus.com/
However, before moving the section we'd need to find a way to introduce properties before the checkboxes section.
The Checkboxes section is written assuming the reader knows what Properties are. The GNU documentation guidelines suggest writing as though readers have read from the beginning [fn:1] [fn:2]. That is, unless introducing a concept, only use concepts that have already been explained. Properties are introduced in Section 2.7 and Checkboxes is currently 5.6. The proposal is to move Checkboxes to 2.6.1 *before* properties are introduced. This is a problem.
[fn:1] https://www.gnu.org/prep/standards/standards.html#Documentation
[fn:2] https://www.fsf.org/licensing/gnu-press/GNU-Press-styleguide.pdf
--
Matt Trzcinski
Emacs Org contributor (ob-shell)
Learn more about Org mode at https://orgmode.org
Support Org development at https://liberapay.com/org-mode
next prev parent reply other threads:[~2024-02-27 16:48 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-25 13:05 [PATCH] doc/org-manual.org (Checkboxes): move section 'Checkboxes' from 'TODO Items' to 'Plain Lists' Sławomir Grochowski
2024-01-25 22:36 ` Ihor Radchenko
2024-02-26 8:59 ` Ihor Radchenko
2024-02-27 16:47 ` Matt [this message]
2024-02-27 23:07 ` Sławomir Grochowski
2024-02-28 12:20 ` Ihor Radchenko
2024-02-28 19:10 ` Matt
2024-03-02 12:43 ` 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=18deb76f2d9.cad957fe1073948.9203602429479305690@excalamus.com \
--to=matt@excalamus.com \
--cc=emacs-orgmode@gnu.org \
--cc=slawomir.grochowski@gmail.com \
--cc=yantar92@posteo.net \
/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).