From 01bbdca4a5b8a7445f8b9dceef4481ea7b4c5c75 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C5=82awomir=20Grochowski?= 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