org-contrib/org-checklist.org

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