From: "Sławomir Grochowski" <slawomir.grochowski@gmail.com>
To: emacs-orgmode@gnu.org
Subject: [PATCH] doc/org-manual.org: Checkboxes, add checkbox states examples
Date: Mon, 6 Nov 2023 13:50:27 +0100 [thread overview]
Message-ID: <CABnDLzEaEdA7ErQzcbnp2PhMPh=DcR6owwtPcxPWf+W334jtFQ@mail.gmail.com> (raw)
[-- Attachment #1.1: Type: text/plain, Size: 262 bytes --]
Dear All,
I have added some examples to the org-manual.
Patch in attachment and also a screenshot of generated html.
Thank you for the code review. Now please help me find everything that can
be improved in this patch.
Regards,
Sławomir Grochowski
[-- Attachment #1.2: Type: text/html, Size: 404 bytes --]
[-- Attachment #2: Screenshot from 2023-11-06 13-45-26.png --]
[-- Type: image/png, Size: 132052 bytes --]
[-- Attachment #3: 0001-doc-org-manual.org-Checkboxes-add-checkbox-states-ex.patch --]
[-- Type: text/x-patch, Size: 1619 bytes --]
From ef77008df33bcc6b967e6502c40ebcd9b134a7c1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C5=82awomir=20Grochowski?= <slawomir.grochowski@gmail.com>
Date: Mon, 6 Nov 2023 13:27:06 +0100
Subject: [PATCH] doc/org-manual.org: Checkboxes, add checkbox states examples
* org-manual.org: Checkboxes, add checkbox states examples
---
doc/org-manual.org | 26 ++++++++++++++++++++++++++
1 file changed, 26 insertions(+)
diff --git a/doc/org-manual.org b/doc/org-manual.org
index 50662669e..4ab8b7915 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -4602,11 +4602,37 @@ Here is an example of a checkbox list.
- [X] talk to the neighbors
#+end_example
+A checkbox can be in one of the three states:
+1) not checked =[ ]=
+2) partially checked =[-]=
+3) checked =[X]=
+
Checkboxes work hierarchically, so if a checkbox item has children
that are checkboxes, toggling one of the children checkboxes makes the
parent checkbox reflect if none, some, or all of the children are
checked.
+If all child checkboxes are not checked, the parent checkbox is also not checked.
+#+begin_example
+- [ ] call people
+ - [ ] Peter
+ - [ ] Sarah
+#+end_example
+
+If some but not all child checkboxes are checked, the parent checkbox is partially checked.
+#+begin_example
+- [-] call people
+ - [X] Peter
+ - [ ] Sarah
+#+end_example
+
+If all child checkboxes are checked, the parent checkbox is also checked.
+#+begin_example
+- [X] call people
+ - [X] Peter
+ - [X] Sarah
+#+end_example
+
#+cindex: statistics, for checkboxes
#+cindex: checkbox statistics
#+cindex: @samp{COOKIE_DATA}, property
--
2.30.2
next reply other threads:[~2023-11-06 12:51 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-11-06 12:50 Sławomir Grochowski [this message]
2023-11-06 16:49 ` [PATCH] doc/org-manual.org: Checkboxes, add checkbox states examples 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
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='CABnDLzEaEdA7ErQzcbnp2PhMPh=DcR6owwtPcxPWf+W334jtFQ@mail.gmail.com' \
--to=slawomir.grochowski@gmail.com \
--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).