org-contrib/org-checklist.org

   1 #+TITLE:   org-checklist.el --- org functions for checklist handling
   2 #+OPTIONS: ^:{} author:nil
   3 #+STARTUP: odd
   4
   5 * General
   6
   7   =org-checklist= provides two actions which can be triggered when a task is
   8   marked done. These are:
   9
  10   1) Clearing the state of all checkboxes in the task.
  11
  12   2) Creating, and optionally printing, a file containing a copy of the task
  13      with all items in the checked state removed.
  14
  15 * How to use it
  16
  17 ** Quick example
  18
  19    Load =org-checklist= as described in the [[* Loading it][next section]]. You will then need to
  20    create a recurring task.
  21
  22 : * Morning routine
  23 :   SCHEDULED: <2009-02-19 Thu 08:00 +1d>
  24 :   - [ ] Shower
  25 :   - [ ] Brush teeth
  26 :   - [ ] Get dressed
  27 :   - [ ] Eat breakfast
  28 :   - [ ] Check email
  29
  30    Then add the property =RESET_CHECKBOXES= with a value of =t=. When the item
  31    is marked done,
  32
  33 ** Loading it
  34
  35    =org-checklist= requires =a2ps=.
  36
  37    Ensure the org contrib directory is in =load-path= and add =(require
  38    'org-checklist)= to your =.emacs=.
  39
  40 ** Configurable options
  41
  42    =org-checklist= has four main configurable options:
  43
  44    - =org-checklist-time-format= :: the format of the timestamp added to the
  45      export file. See =format-time-string= for valid % escapes.
  46
  47    - =org-checklist-export-function= :: org export function to use to create the
  48      printable version of the export file. Any of the org export functions will
  49      work. The default is =org-export-as-ascii=.
  50
  51    - =org-checklist-export-params= :: parameters for the export function. See
  52      the docs for the exporter you are using for useful values.
  53
  54    - =org-checklist-a2ps-params= :: parameters for a2ps-print. If you choose to
  55      print the exported file, these parameters will be used in place of a2ps-switches.
  56
  57 * Credits
  58
  59   =org-checklist= was written by James TD Smith