* [PATCH] doc/org-manual.org: Checkboxes, add checkbox states examples
@ 2023-11-06 12:50 Sławomir Grochowski
2023-11-06 16:49 ` Bastien
0 siblings, 1 reply; 7+ messages in thread
From: Sławomir Grochowski @ 2023-11-06 12:50 UTC (permalink / raw)
To: emacs-orgmode
[-- 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
^ permalink raw reply related [flat|nested] 7+ messages in thread
* Re: [PATCH] doc/org-manual.org: Checkboxes, add checkbox states examples
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-07 17:30 ` Sławomir Grochowski
0 siblings, 2 replies; 7+ messages in thread
From: Bastien @ 2023-11-06 16:49 UTC (permalink / raw)
To: Sławomir Grochowski; +Cc: emacs-orgmode
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
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH] doc/org-manual.org: Checkboxes, add checkbox states examples
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
1 sibling, 1 reply; 7+ messages in thread
From: Ihor Radchenko @ 2023-11-06 17:05 UTC (permalink / raw)
To: Bastien; +Cc: Sławomir Grochowski, emacs-orgmode
Bastien <bzg@gnu.org> writes:
> I added you as a contributor on
> https://orgmode.org/worg/contributors.html
I think that you added him second time :)
@@ 260,6 260,7 @@ within GNU Emacs:
...
+- Slawomir Grochowski
- Sławomir Grochowski
...
--
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH] doc/org-manual.org: Checkboxes, add checkbox states examples
2023-11-06 17:05 ` Ihor Radchenko
@ 2023-11-06 17:19 ` Bastien
0 siblings, 0 replies; 7+ messages in thread
From: Bastien @ 2023-11-06 17:19 UTC (permalink / raw)
To: Ihor Radchenko; +Cc: Sławomir Grochowski, emacs-orgmode
Ihor Radchenko <yantar92@posteo.net> writes:
> Bastien <bzg@gnu.org> writes:
>
>> I added you as a contributor on
>> https://orgmode.org/worg/contributors.html
>
> I think that you added him second time :)
Ahah, good catch!
> @@ 260,6 260,7 @@ within GNU Emacs:
> ...
> +- Slawomir Grochowski
> - Sławomir Grochowski
I fixed this by keeping the second occurrence with "ł"...
--
Bastien
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH] doc/org-manual.org: Checkboxes, add checkbox states examples
2023-11-06 16:49 ` Bastien
2023-11-06 17:05 ` Ihor Radchenko
@ 2023-11-07 17:30 ` Sławomir Grochowski
2023-11-07 23:36 ` Bastien Guerry
1 sibling, 1 reply; 7+ messages in thread
From: Sławomir Grochowski @ 2023-11-07 17:30 UTC (permalink / raw)
To: Bastien; +Cc: emacs-orgmode
[-- Attachment #1: Type: text/plain, Size: 775 bytes --]
> Applied, with a minor modification, using 1. instead of 1) for the
> list items.
When will you merge the patch?
https://git.savannah.gnu.org/cgit/emacs/org-mode.git/
And when update will be visible on site
https://orgmode.org/org.html#Checkboxes ?
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 #2: Type: text/html, Size: 1462 bytes --]
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH] doc/org-manual.org: Checkboxes, add checkbox states examples
2023-11-07 17:30 ` Sławomir Grochowski
@ 2023-11-07 23:36 ` Bastien Guerry
2023-11-08 6:36 ` Sławomir Grochowski
0 siblings, 1 reply; 7+ messages in thread
From: Bastien Guerry @ 2023-11-07 23:36 UTC (permalink / raw)
To: Sławomir Grochowski; +Cc: emacs-orgmode
Sławomir Grochowski <slawomir.grochowski@gmail.com> writes:
>> Applied, with a minor modification, using 1. instead of 1) for the
>> list items.
>
> When will you merge the patch? https://git.savannah.gnu.org/cgit/
> emacs/org-mode.git/
Done now.
> And when update will be visible on site https://orgmode.org/org.html#
> Checkboxes ?
When we release the main branch as a new stable version of Org, so not
so soon.
Best,
--
Bastien Guerry
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH] doc/org-manual.org: Checkboxes, add checkbox states examples
2023-11-07 23:36 ` Bastien Guerry
@ 2023-11-08 6:36 ` Sławomir Grochowski
0 siblings, 0 replies; 7+ messages in thread
From: Sławomir Grochowski @ 2023-11-08 6:36 UTC (permalink / raw)
To: Bastien Guerry; +Cc: emacs-orgmode
[-- Attachment #1: Type: text/plain, Size: 704 bytes --]
Awesome!
Thank you Bastien.
I'm planning to add some examples with checkbox cookie data.
Regards,
Sławomir Grochowski
On Wed, Nov 8, 2023 at 12:37 AM Bastien Guerry <bzg@gnu.org> wrote:
> Sławomir Grochowski <slawomir.grochowski@gmail.com> writes:
>
> >> Applied, with a minor modification, using 1. instead of 1) for the
> >> list items.
> >
> > When will you merge the patch? https://git.savannah.gnu.org/cgit/
> > emacs/org-mode.git/
>
> Done now.
>
> > And when update will be visible on site https://orgmode.org/org.html#
> > Checkboxes ?
>
> When we release the main branch as a new stable version of Org, so not
> so soon.
>
> Best,
>
> --
> Bastien Guerry
>
[-- Attachment #2: Type: text/html, Size: 1333 bytes --]
^ permalink raw reply [flat|nested] 7+ messages in thread
end of thread, other threads:[~2023-11-08 6:37 UTC | newest]
Thread overview: 7+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
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
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).