From: "Sławomir Grochowski" <slawomir.grochowski@gmail.com>
To: Bastien <bzg@gnu.org>
Cc: emacs-orgmode@gnu.org
Subject: Re: [PATCH] doc/org-manual.org: Checkboxes, add checkbox states examples
Date: Sat, 27 Jan 2024 21:55:08 +0100 [thread overview]
Message-ID: <CABnDLzEsUZQ4U3fd0cwMPqkY8tgYAEucYWQxER4MDO82spMumA@mail.gmail.com> (raw)
In-Reply-To: <87jzquesjn.fsf@gnu.org>
[-- Attachment #1.1: Type: text/plain, Size: 794 bytes --]
Dear All,
I noticed in my patch that I moved the description ("The ‘[2/4]’ and
‘[1/3]’ in") of an example.
And it should be just below the example.
So I'm sending a fixup! patch to fix this.
It's my first fixup! patch so I hope this is the right procedure ;)
Regards,
Sławomir Grochowski
On Mon, Nov 6, 2023 at 5:49 PM Bastien <bzg@gnu.org> wrote:
> Hi Sławomir,
>
> Sławomir Grochowski <slawomir.grochowski@gmail.com> writes:
>
> > I have added some examples to the org-manual.
> > Patch in attachment and also a screenshot of generated html.
>
> Applied, with a minor modification, using 1. instead of 1) for the
> list items.
>
> I added you as a contributor on
> https://orgmode.org/worg/contributors.html
>
> Thanks!
>
> --
> Bastien
>
[-- Attachment #1.2: Type: text/html, Size: 1402 bytes --]
[-- Attachment #2: 0001-fixup-doc-org-manual.org-Checkboxes-add-checkbox-sta.patch --]
[-- Type: text/x-patch, Size: 4497 bytes --]
From 01bbdca4a5b8a7445f8b9dceef4481ea7b4c5c75 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C5=82awomir=20Grochowski?= <slawomir.grochowski@gmail.com>
Date: Sat, 27 Jan 2024 21:16:36 +0100
Subject: [PATCH] fixup! doc/org-manual.org: Checkboxes, add checkbox states
examples
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Description of example of a checkbox list ("The ‘[2/4]’ and ‘[1/3]’...")
should be right below the example.
---
doc/org-manual.org | 60 +++++++++++++++++++++++-----------------------
1 file changed, 30 insertions(+), 30 deletions(-)
diff --git a/doc/org-manual.org b/doc/org-manual.org
index d8c7fd737..2064e1e68 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -4685,6 +4685,36 @@ Here is an example of a checkbox list.
- [X] talk to the neighbors
#+end_example
+#+cindex: statistics, for checkboxes
+#+cindex: checkbox statistics
+#+cindex: @samp{COOKIE_DATA}, property
+#+vindex: org-checkbox-hierarchical-statistics
+The =[2/4]= and =[1/3]= in the first and second line are cookies
+indicating how many checkboxes present in this entry have been checked
+off, and the total number of checkboxes present. This can give you an
+idea on how many checkboxes remain, even without opening a folded
+entry. The cookies can be placed into a headline or into (the first
+line of) a plain list item. Each cookie covers checkboxes of direct
+children structurally below the headline/item on which the cookie
+appears[fn:: Set the variable ~org-checkbox-hierarchical-statistics~
+if you want such cookies to count all checkboxes below the cookie, not
+just those belonging to direct children.]. You have to insert the
+cookie yourself by typing either =[/]= or =[%]=. With =[/]= you get
+an =n out of m= result, as in the examples above. With =[%]= you get
+information about the percentage of checkboxes checked (in the above
+example, this would be =[50%]= and =[33%]=, respectively). In a
+headline, a cookie can count either checkboxes below the heading or
+TODO states of children, and it displays whatever was changed last.
+Set the property =COOKIE_DATA= to either =checkbox= or =todo= to
+resolve this issue.
+
+#+cindex: blocking, of checkboxes
+#+cindex: checkbox blocking
+#+cindex: @samp{ORDERED}, property
+If the current outline node has an =ORDERED= property, checkboxes must
+be checked off in sequence, and an error is thrown if you try to check
+off a box while there are unchecked boxes above it.
+
A checkbox can be in one of the three states:
1. not checked =[ ]=
2. partially checked =[-]=
@@ -4716,36 +4746,6 @@ If all child checkboxes are checked, the parent checkbox is also checked.
- [X] Sarah
#+end_example
-#+cindex: statistics, for checkboxes
-#+cindex: checkbox statistics
-#+cindex: @samp{COOKIE_DATA}, property
-#+vindex: org-checkbox-hierarchical-statistics
-The =[2/4]= and =[1/3]= in the first and second line are cookies
-indicating how many checkboxes present in this entry have been checked
-off, and the total number of checkboxes present. This can give you an
-idea on how many checkboxes remain, even without opening a folded
-entry. The cookies can be placed into a headline or into (the first
-line of) a plain list item. Each cookie covers checkboxes of direct
-children structurally below the headline/item on which the cookie
-appears[fn:: Set the variable ~org-checkbox-hierarchical-statistics~
-if you want such cookies to count all checkboxes below the cookie, not
-just those belonging to direct children.]. You have to insert the
-cookie yourself by typing either =[/]= or =[%]=. With =[/]= you get
-an =n out of m= result, as in the examples above. With =[%]= you get
-information about the percentage of checkboxes checked (in the above
-example, this would be =[50%]= and =[33%]=, respectively). In a
-headline, a cookie can count either checkboxes below the heading or
-TODO states of children, and it displays whatever was changed last.
-Set the property =COOKIE_DATA= to either =checkbox= or =todo= to
-resolve this issue.
-
-#+cindex: blocking, of checkboxes
-#+cindex: checkbox blocking
-#+cindex: @samp{ORDERED}, property
-If the current outline node has an =ORDERED= property, checkboxes must
-be checked off in sequence, and an error is thrown if you try to check
-off a box while there are unchecked boxes above it.
-
The following commands work with checkboxes:
- {{{kbd(C-c C-c)}}} (~org-toggle-checkbox~) ::
--
2.30.2
next prev parent reply other threads:[~2024-01-27 20:56 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-11-06 12:50 [PATCH] doc/org-manual.org: Checkboxes, add checkbox states examples Sławomir Grochowski
2023-11-06 16:49 ` Bastien
2023-11-06 17:05 ` Ihor Radchenko
2023-11-06 17:19 ` Bastien
2023-11-07 17:30 ` Sławomir Grochowski
2023-11-07 23:36 ` Bastien Guerry
2023-11-08 6:36 ` Sławomir Grochowski
2024-01-27 20:55 ` Sławomir Grochowski [this message]
2024-01-27 22:01 ` Matt
2024-02-01 15:56 ` Ihor Radchenko
2024-02-01 15:50 ` 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=CABnDLzEsUZQ4U3fd0cwMPqkY8tgYAEucYWQxER4MDO82spMumA@mail.gmail.com \
--to=slawomir.grochowski@gmail.com \
--cc=bzg@gnu.org \
--cc=emacs-orgmode@gnu.org \
/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).