From: "Sławomir Grochowski" <slawomir.grochowski@gmail.com>
To: Matt <matt@excalamus.com>, Ihor Radchenko <yantar92@posteo.net>
Cc: emacs-orgmode <emacs-orgmode@gnu.org>
Subject: Re: [PATCH] doc/org-manual.org (Checkboxes): move section 'Checkboxes' from 'TODO Items' to 'Plain Lists'
Date: Wed, 28 Feb 2024 00:07:53 +0100 [thread overview]
Message-ID: <87a5nl33qu.fsf@gmail.com> (raw)
In-Reply-To: <18deb76f2d9.cad957fe1073948.9203602429479305690@excalamus.com>
Matt <matt@excalamus.com> writes:
That's good point. Thank you Matt for links.
> 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
Let's close this thread for now. Because in the patch I uploaded, it's too
much of changes + relocation.
I think that first we need to simplify a bit, improve section '5.6
Checkboxes' - because currently it starts with a very complicated
example and its description.
And checkbox is quite simple feature.
So in a new thread I will post the changes regarding '5.6 Checkboxes'.
And then later we could consider relocating.
--
Sławomir Grochowski
next prev parent reply other threads:[~2024-02-27 23:08 UTC|newest]
Thread overview: 9+ 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
2024-02-27 23:07 ` Sławomir Grochowski [this message]
2024-02-28 12:20 ` Ihor Radchenko
2024-02-28 19:10 ` Matt
2024-03-02 12:43 ` Ihor Radchenko
2024-08-20 10:45 ` Carsten Dominik
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=87a5nl33qu.fsf@gmail.com \
--to=slawomir.grochowski@gmail.com \
--cc=emacs-orgmode@gnu.org \
--cc=matt@excalamus.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).