fixup! doc/org-manual.org: Checkboxes, add checkbox states examples

Description of example of a checkbox list ("The ‘[2/4]’ and ‘[1/3]’...")
should be right below the example.
This commit is contained in:
Sławomir Grochowski 2024-01-27 21:16:36 +01:00 committed by Ihor Radchenko
parent 055ed4a2f6
commit 614d534a9d
No known key found for this signature in database
GPG Key ID: 6470762A7DA11D8B
1 changed files with 30 additions and 30 deletions

View File

@ -4688,6 +4688,36 @@ Here is an example of a checkbox list.
- [X] talk to the neighbors - [X] talk to the neighbors
#+end_example #+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: A checkbox can be in one of the three states:
1. not checked =[ ]= 1. not checked =[ ]=
2. partially checked =[-]= 2. partially checked =[-]=
@ -4719,36 +4749,6 @@ If all child checkboxes are checked, the parent checkbox is also checked.
- [X] Sarah - [X] Sarah
#+end_example #+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: The following commands work with checkboxes:
- {{{kbd(C-c C-c)}}} (~org-toggle-checkbox~) :: - {{{kbd(C-c C-c)}}} (~org-toggle-checkbox~) ::