emacs-orgmode
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH] doc/org-manual.org (Checkboxes): move section 'Checkboxes' f


From: Matt
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
User-agent: Zoho Mail

 ---- 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





reply via email to

[Prev in Thread] Current Thread [Next in Thread]