Documentation

- Updates to the script for the new movie and revised tutorial.

doc/misc/run.193

@@ -0,0 +1,250 @@
+#! /bin/bash
+
+rm pending.data completed.data undo.data
+
+echo 'data.location=.' > x
+echo 'color=off' >> x
+echo 'color.summary.background=on gray3' >> x
+
+# Basic usage
+echo Basic usage
+task rc:x add Select a free weekend in August
+task rc:x add Select and book a venue
+task rc:x add Come up with a guest list
+task rc:x add Mail invitations
+task rc:x add Select a caterer
+task rc:x list
+task rc:x log Order a special cake
+task rc:x 4 duplicate /Mail/Design/
+task rc:x 4 duplicate /Mail/Print/
+task rc:x list
+task rc:x 3 done
+task rc:x list
+
+# Projects
+echo Projects
+task rc:x add Pay teh rent on teh 31st
+task rc:x 7 /teh/the/g
+task rc:x list
+task rc:x 7 project:home
+echo 'All' | task rc:x 1-6 project:party
+task rc:x projects
+task rc:x list project:home
+task rc:x li pro:par
+
+# Priorities
+echo Priorities
+echo 'All' | task rc:x 1-3,5 priority:H
+task rc:x list
+task rc:x 3 pri:
+
+# Tags
+echo Tags
+task rc:x list
+echo 'All' | task rc:x 3,5,6 +mall
+task rc:x long
+task rc:x list +mall
+task rc:x 3 -mall
+
+# Modifications
+echo Modifications
+echo 'Yes' | task rc:x 7 Pay rent at the end of the month
+task rc:x add music
+task rc:x 8 prepend Select some
+task rc:x 8 append for after dinner
+task rc:x list
+#task rc:x edit
+#task rc:x add Hire a band?
+#task rc:x add Hire a band\?
+#task rc:x add "Hire a band?"
+task rc:x add -- Hire a band\? +dj
+echo 'y' | task rc:x undo
+echo 'y' | task rc:x 1 delete
+echo 'y' | task rc:x undo
+
+# Info
+echo Info
+task rc:x 1 info
+task rc:x stats
+
+# Annotations
+echo Annotations
+task rc:x 1 annotate the 12th looks good
+sleep 1
+task rc:x 1 annotate or the 13th
+task rc:x list
+task rc:x 1 denotate 13th
+
+# Configuration
+echo Configuration
+task rc:x show
+echo 'y' | task rc:x config answer 42
+task rc:x show answer
+echo 'y' | task rc:x config answer
+task rc:x rc.report.list.sort=description+ list
+
+# Defaults
+echo Defaults
+echo 'y' | task rc:x config default.command list
+task rc:x
+echo 'y' | task rc:x config default.priority H
+echo 'y' | task rc:x config default.project Work
+task rc:x add New task
+task rc:x list
+echo 'y' | task rc:x undo
+echo 'y' | task rc:x config default.priority
+echo 'y' | task rc:x config default.project
+
+# Aliases
+echo Aliases
+echo 'y' | task rc:x config alias.zzz=list
+taks rc:x zzz
+
+# Color
+echo Color
+echo 'y' | task rc:x config color on
+task rc:x list
+task rc:x 1 bg:on_red
+task rc:x list
+task rc:x 1 bg:
+task rc:x color
+task rc:x color white on red
+task rc:x color legend
+#vi ~/.taskrc # include /usr/local/share/doc/task/rc/dark-blue-256.theme
+echo 'include /usr/local/share/doc/task/rc/dark-blue-256.theme' >> x
+task rc:x color legend
+task rc:x list
+#vi ~/.taskrc # include /usr/local/share/doc/task/rc/dark-red-256.theme
+sed 's/blue/red/' x >x2 && mv x2 x
+task rc:x color legend
+task rc:x list
+#vi ~/.taskrc # include /usr/local/share/doc/task/rc/dark-256.theme
+sed 's/red-//' x >x2 && mv x2 x
+task rc:x list
+task rc:x "rc.color.project.party=on rgb001" rc.color.keyword.invit=bold list
+#man task-color
+
+# Active tasks
+echo Active tasks
+task rc:x 2 start
+task rc:x list
+task rc:x active
+task rc:x 2 stop
+
+# Due dates
+echo Due dates
+task rc:x 1 due:7/31/2010
+task rc:x 1 due:2wks
+task rc:x 1 due:-2wks
+task rc:x 1 due:eom
+task rc:x 2 due:8th
+task rc:x 2 due:sunday
+task rc:x 5 due:eow
+task rc:x list
+task rc:x overdue
+task rc:x rc.dateformat.report:Y-M-DTH:N:SZ list
+
+# Calendar
+echo Calendar
+task rc:x calendar
+#vi ~/.taskrc # include /usr/local/share/doc/task/rc/holidays-US.rc
+echo 'include /usr/local/share/doc/task/rc/holidays-US.rc' >> x
+task rc:x calendar
+task rc:x cal 2010
+task rc:x rc.calendar.details:full cal
+task rc:x rc.calendar.holidays:full cal
+
+# Recurrence
+echo Recurrence
+task rc:x 7 info
+task rc:x 7 due:eom recur:monthly
+task rc:x 7
+task rc:x 7 until:eoy
+task rc:x recurring
+task rc:x add Pay taxes due:4/15/2007 recur:yearly
+task rc:x long
+printf "y\ny\n" | task rc:x 11 delete      # y, y
+task rc:x list
+
+# Shell
+echo Shell
+
+# Special tags
+echo Special tags
+
+# Waiting
+echo Waiting
+task rc:x add Look for new apartment due:eoy
+task rc:x list
+task rc:x 10 wait:12/1/2010
+task rc:x list
+task rc:x waiting
+task rc:x add Do something in a few seconds
+task rc:x 11 wait:5s
+task rc:x list
+sleep 5
+task rc:x list
+task rc:x 11 rc.confirmation:no delete
+
+# Dependencies
+echo Dependencies
+
+# Reports
+echo Reports
+task rc:x minimal
+task rc:x ls
+task rc:x list
+task rc:x long
+task rc:x all
+task rc:x completed
+task rc:x recurring
+task rc:x waiting
+task rc:x blocked
+task rc:x oldest
+task rc:x newest
+task rc:x timesheet
+task rc:x next
+
+# Custom report
+echo Custom report
+echo 'report.foo.description=My own report'     >> x
+echo 'report.foo.columns=id,entry,description'  >> x
+echo 'report.foo.labels=ID,Entered,Description' >> x
+echo 'report.foo.sort=entry+,description+'      >> x
+echo 'report.foo.filter=status:pending'         >> x
+task rc:x help | grep foo
+task rc:x show report.foo
+task rc:x foo
+
+# Charts
+echo Charts
+task rc:x history
+task rc:x history.annual
+task rc:x ghistory
+task rc:x ghistory.annual
+task rc:x rc.color.summary.background:"on gray3" summary
+
+# Advanced filters
+echo Advanced filters
+
+# Import/export
+echo Import/export
+
+# Help
+echo Help
+
+exit  # <------------------------------------
+
+task rc:x help
+man task
+man taskrc
+man task-color
+man task-tutorial
+man task-faq
+
+# Wrap up
+echo Wrap up
+task rc:x version
+
+exit
+

doc/misc/script-193.txt

@@ -22,7 +22,7 @@ http://taskwarrior.org                   Hello, and welcome to this task version
 
                                          Let's get started.  We're planning a party, and there is a
                                          lot of work to do, so let's capture these tasks.
-task add Select a good day in August     First decide 'when'.
+task add Select a free weekend in August First decide 'when'.
 task add Select and book a venue         Then decide 'where'.
 task add Come up with a guest list       Then decide 'who'.
 task add Mail invitations                Let's send out nice invitations.
@@ -183,6 +183,11 @@ task undo                                Let's just revert those changes, to cle
 task config default.priority
 task config default.project
 
+---------------------------------------- Aliases ---------------------------------------------------
+
+task config alias.zzz=list               You can create aliases to effectively rename task commands.
+task zzz
+
 ---------------------------------------- Color -----------------------------------------------------
 
 task config color on                     All the examples so far have been shown with color turned
@@ -210,17 +215,20 @@ task color legend                        Or samples of all the active color sett
 
                                          A blue theme.
 
-vi ~/.taskrc # include /usr/local/share/doc/task/rc/dark-blue-256.theme
+# include /usr/local/share/doc/task/rc/dark-blue-256.theme
+vi ~/.taskrc
 task color legend
 task list
                                          A red theme.
 
-vi ~/.taskrc # include /usr/local/share/doc/task/rc/dark-red-256.theme
+# include /usr/local/share/doc/task/rc/dark-red-256.theme
+vi ~/.taskrc
 task color legend
 task list
                                          A general dark theme.
 
-vi ~/.taskrc # include /usr/local/share/doc/task/rc/dark-256.theme
+# include /usr/local/share/doc/task/rc/dark-256.theme
+vi ~/.taskrc
 task list
 
                                          Here is a color rule that specifies a dark blue
@@ -235,23 +243,66 @@ man task-color                           There is a man page with a writeup of a
 
 ---------------------------------------- Active tasks ----------------------------------------------
 
-  start/stop
+task 2 start                             I'm selecting a venue, so let's indicate that task 2 is
-  active
+task list                                active by starting it.  See how active tasks are affected
+                                         by the color rules.
+
+task active                              There is an active report that shows only active tasks, and
+task 2 stop                              you can mark any active task as inactive, by stopping it.
 
 ---------------------------------------- Due dates -------------------------------------------------
 
-  due dates - relative
+task 1 due:7/31/2010                     Due dates can be specified as dates...
+task 1 due:2wks                          as some distance into the future...
+task 1 due:-2wks                         or past...
+task 1 due:eom                           or by mnemonic (end of month)...
+task 2 due:8th                           or by ordinal...
+task 2 due:sunday                        or by day...
+task 5 due:eow                           
+task list                                Some of these dates are in the past, so now you see there
+task overdue                             are overdue tasks.  Due dates have different colors for
+                                         due, imminent, today and overdue values.
+
+task rc.dateformat.report:Y-M-DTH:N:SZ list
+                                         You can also choose the format - for input and output.
 
 ---------------------------------------- Calendar --------------------------------------------------
 
-  calendar
+task calendar                            When tasks have due dates, you can see them on the calendar.
-  holidays
+
-  calendar + report
+vi ~/.taskrc
+# include /usr/local/share/doc/task/rc/holidays-US.rc
+task calendar
+                                         Task comes with sample holiday files.  You can create your
+                                         own, or use one of the samples to show holidays on the
+                                         calendar.
+
+task cal 2010                            You can see the whole year.
+task rc.calendar.details:full cal        You can see the tasks with due dates also.
+task rc.calendar.holidays:full cal       And you can see the holidays.
 
 ---------------------------------------- Recurrence ------------------------------------------------
 
-  recurring task
+task 7 info                              Remember the task we added to pay the rent?  We're going to
-  task recurring
+task 7 due:eom recur:monthly             need to do that every month.  Recurring tasks allow us to
+task 7                                   set up a single task that keeps coming back, jsut as you'd
+                                         expect.
+
+task 7 until:eoy                         You can also limit the extent of the recurrence.  Let's make
+                                         sure the task doesn't recur after the lease ends.
+
+task recurring                           And there is a recurring report that shows you only the
+                                         recurring tasks.
+
+                                         To illustrate a point, let's set up a recurring annual task
+                                         as a reminder to pay taxes, and put the due date in the past.
+                                         This will cause task to fill in the gaps, and create a series
+                                         of severely overdue tasks.
+task add Pay taxes due:4/15/2007 recur:yearly
+task long
+
+task 11 delete    # y y                  Deletions to recurring tasks can be escalated to include all
+task list                                the recurrences of a task.
 
 ---------------------------------------- Shell -----------------------------------------------------
 
@@ -263,7 +314,23 @@ man task-color                           There is a man page with a writeup of a
 
 ---------------------------------------- Waiting ---------------------------------------------------
 
-  task wait: / task waiting
+task add Look for new apartment due:eoy  When you have a task with a due date that is far out into
+task list                                the future, you may want to hide that task for a while.
+
+task 10 wait:12/1/2010                   You can provide a wait date for a task, and it will remain
+task list                                hidden until that date.  It will no longer be cluttering
+task waiting                             your task list, but it is still there, and visible using
+                                         the 'waiting' report.  When the wait date comes, the task
+                                         will just pop back into the list.
+
+
+task add Do something in a few seconds   To illustrate this, let's set up a task with a very short
+task 11 wait:5s                          wait time of five seconds.
+
+task list                                It's gone.
+sleep 5
+task list                                And it's back.
+task 11 rc.confirmation:no delete        And now it's deleted.
 
 ---------------------------------------- Dependencies ----------------------------------------------
 
@@ -271,18 +338,21 @@ man task-color                           There is a man page with a writeup of a
 
 ---------------------------------------- Reports ---------------------------------------------------
 
-  minimal
+task minimal                             Task has a good many reports.  There is the bare minimum.
-  ls
+task ls                                  The simple.
-  list
+task list                                The standard.
-  long
+task long                                The kitchen sink.
-  all
+task all                                 The packrat.
-  completed
+task completed                           Nostalgia.
-  overdue
+task recurring                           Groundhog day.
-  recurring
+task waiting                             Secrets.
-  blocked
+task blocked                             Wedged.
-  oldest/newest
+task oldest                              Ancient history.
-  minimal
+task newest                              Contemporary.
-  next
+task timesheet                           Corporate.
+task next                                And "what should I work on next?"  This one can be useful
+                                         because it pulls a few of the highest priority tasks from
+                                         all the projects.  It's the report we should all be using.
 
 ---------------------------------------- Custom Report ---------------------------------------------
 
@@ -293,27 +363,29 @@ man task-color                           There is a man page with a writeup of a
                                          and the description.  I can specify the labels for those
                                          columns, the sort order of the report, and I can filter.
 
-  cat >> ~/.taskrc
+cat >> ~/.taskrc
-  report.foo.description=My own report
+report.foo.description=My own report
-  report.foo.columns=id,entry,description
+report.foo.columns=id,entry,description
-  report.foo.labels=ID,Entered,Description
+report.foo.labels=ID,Entered,Description
-  report.foo.sort=entry+,description+
+report.foo.sort=entry+,description+
-  report.foo.filter=status:pending
+report.foo.filter=status:pending
 
-  task help | grep foo                   Custom reports also show up on the help output.
+task help | grep foo                     Custom reports also show up on the help output.
 
-  task show report.foo                   You can inspect the configuration.
+task show report.foo                     I can inspect the configuration.
 
-  task foo                               And they can be run just like the other reports.
+task foo                                 And they can be run just like the other reports.
 
 ---------------------------------------- Charts ----------------------------------------------------
 
-  history
+task history                             The history report gives monthly totals of task added,
-  history.annual
+task history.annual                      completed and deleted.  There is also an annual version.
-  ghistory
+
-  ghistory.annual
+task ghistory                            There is a graphical monthly...
-  timesheet
+task ghistory.annual                     and annual version.
-  summary
+
+task summary                             There is a project summary report that shows progress in
+                                         all the projects.
 
 ---------------------------------------- Advanced Filters ------------------------------------------