[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH] doc/org-manual.org (Checkboxes): move section 'Checkboxes' f
From: |
Sławomir Grochowski |
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 |
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