.config/taskwarrior/hooks/task.shift-recurrence/README.md

   1 Taskwarrior Shift All Recurrence Attributes Hook
   2 ------------------------------------------------
   3
   4 This is a hook for TaskWarrior (http://www.taskwarrior.org),
   5 which allow your recurrent tasks to inherit ``wait``, ``scheduled``
   6 and ``until`` attributes from the parent.
   7
   8 Install
   9 -------
  10
  11 Note: This hook has been rewritten to leverage taskpirate, for greater hook efficiency.
  12 Please see https://github.com/tbabej/taskpirate for instructions. Don't worry, it's straightforward.
  13
  14 ```
  15 git clone https://github.com/tbabej/taskwarrior-shift-all-recurrence-hook.git
  16 cp taskwarrior-shift-all-recurrence-hook/on-* ~/.task/hooks/
  17 ```
  18
  19 This hook leverages tasklib, so you need to install that too:
  20
  21 ```
  22 pip install tasklib
  23 ```
  24
  25 Use case
  26 --------
  27
  28 Consider you have a periodic task, which is valid only for the certain day,
  29 e.g. on every Sunday you go running.
  30
  31 ```
  32 $ task add due:sunday recur:weekly
  33 ```
  34
  35 However, TaskWarrior will display the task right away, and you want to
  36 showing up only during the weekend, so that it does not distract your task
  37 list during the work week.
  38
  39 If you try to add the recurrence again, this time with ``wait`` attribute,
  40 to hide the task until it is not relevant for you:
  41
  42 ```
  43 $ task add due:sunday recur:weekly wait:saturday
  44 ```
  45
  46 You will find out that TaskWarrior does not let tasks generated by this
  47 recurrence inherit the ``wait`` attribute, in the same manner as it does
  48 with the ``due`` attribute.
  49
  50 This hook solves that.