|The Org Mode 7 Reference Manual
by Carsten Dominik and others
Paperback (6"x9"), 282 pages
RRP £9.95 ($14.95)
Sales of this book support the Org project! Get a printed copy>>>
Every item in a plain list(45) (see section 2.7 Plain lists) can be made into a checkbox by starting it with the string ‘[ ]’. This feature is similar to TODO items (see section 5 TODO items), but is more lightweight. Checkboxes are not included into the global TODO list, so they are often great to split a task into a number of simple steps. Or you can use them in a shopping list. To toggle a checkbox, use C-c C-c, or use the mouse (thanks to Piotr Zielinski's ‘org-mouse.el’).
Here is an example of a checkbox list.
* TODO Organize party [2/4] - [-] call people [1/3] - [ ] Peter - [X] Sarah - [ ] Sam - [X] order food - [ ] think about what music to play - [X] talk to the neighbors
Checkboxes work hierarchically, so if a checkbox item has children that are checkboxes, toggling one of the children checkboxes will make the parent checkbox reflect if none, some, or all of the children are checked.
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.(46) 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
will display whatever was changed last. Set the property
to either ‘checkbox’ or ‘todo’ to resolve this issue.
If the current outline node has an
ORDERED property, checkboxes must
be checked off in sequence, and an error will be thrown if you try to check
off a box while there are unchecked boxes above it.
The following commands work with checkboxes:
- C-c C-c
- Toggle checkbox status or (with prefix arg) checkbox presence at point. With double prefix argument, set it to ‘[-]’, which is considered to be an intermediate state.
- C-c C-x C-b
Toggle checkbox status or (with prefix arg) checkbox presence at point. With
double prefix argument, set it to ‘[-]’, which is considered to be an
- If there is an active region, toggle the first checkbox in the region and set all remaining boxes to the same status as the first. With a prefix arg, add or remove the checkbox for all items in the region.
- If the cursor is in a headline, toggle checkboxes in the region between this headline and the next (so not the entire subtree).
- If there is no active region, just toggle the checkbox at point.
- Insert a new item with a checkbox. This works only if the cursor is already in a plain list item (see section 2.7 Plain lists).
- C-c C-x o
ORDEREDproperty of the entry, to toggle if checkboxes must be checked off in sequence. A property is used for this behavior because this should be local to the current entry, not inherited like a tag. However, if you would like to track the value of this property with a tag for better visibility, customize the variable
- C-c #
- Update the statistics cookie in the current outline entry. When called with a C-u prefix, update the entire file. Checkbox statistic cookies are updated automatically if you toggle checkboxes with C-c C-c and make new ones with M-S-RET. TODO statistics cookies update when changing TODO states. If you delete boxes/entries or add/change them by hand, use this command to get things back into sync. Or simply toggle any entry twice (checkboxes with C-c C-c).
|ISBN 9781906966089||The Org Mode 7 Reference Manual||See the print edition|