From 4028a2fce4368aa7727552baa68de31bb2d32c48 Mon Sep 17 00:00:00 2001 From: Paul Beckingham Date: Wed, 6 Oct 2010 23:28:31 -0400 Subject: [PATCH] Documentation - Added (incomplete) scripts to generate more sample runs, showcasing features. --- doc/misc/run.sample.annotate | 71 +++++++++++++++++++++++++++++++++++ doc/misc/run.sample.attmod | 71 +++++++++++++++++++++++++++++++++++ doc/misc/run.sample.cal | 71 +++++++++++++++++++++++++++++++++++ doc/misc/run.sample.deps | 58 ++++++++++++++++++++++++++++ doc/misc/run.sample.ghistory | 71 +++++++++++++++++++++++++++++++++++ doc/misc/run.sample.summary | 71 +++++++++++++++++++++++++++++++++++ doc/misc/run.sample.timesheet | 63 +++++++++++++++++++++++++++++++ 7 files changed, 476 insertions(+) create mode 100755 doc/misc/run.sample.annotate create mode 100755 doc/misc/run.sample.attmod create mode 100755 doc/misc/run.sample.cal create mode 100755 doc/misc/run.sample.deps create mode 100755 doc/misc/run.sample.ghistory create mode 100755 doc/misc/run.sample.summary create mode 100755 doc/misc/run.sample.timesheet diff --git a/doc/misc/run.sample.annotate b/doc/misc/run.sample.annotate new file mode 100755 index 000000000..f8bbed8d3 --- /dev/null +++ b/doc/misc/run.sample.annotate @@ -0,0 +1,71 @@ +#! /bin/bash + +# Small script to create a fragment of output for display on the front page +# of taskwarrior.org, as a teaser. + +rm pending.data completed.data undo.data + +echo 'data.location=.' > x +echo '_forcecolor=on' >> x +echo 'defaultwidth=120' >> x +echo 'include /usr/local/share/doc/task/rc/dark-violets-256.theme' >> x +echo 'include /usr/local/share/doc/task/rc/holidays-US.rc' >> x +echo 'color.alternate=' >> x + +echo 'report.list.columns=id,project,priority_long,start,due,recur,age_compact,tags,description' >> x +echo 'report.list.labels=ID,Project,Pri,Started,Due,Recur,Age,Tags,Description' >> x +echo 'report.list.sort=due+,priority_long-,project+' >> x + +# Import tasks with old timestamps +cat <file.yaml +%YAML 1.1 +--- + task: + description: Try out the color themes + entry: 1281914800 + start: 1282044800 + project: software + status: pending + uuid: 13afada0-a446-8d5a-c213-30d99d52c4b0 + task: + description: Visit http://taskwarrior.org + entry: 1281089630 + tags: www + priority: H + project: software + status: pending + uuid: 23afada0-a446-8d5a-c213-30d99d52c4b0 + task: + description: Review task list + entry: 1281289630 + due: 1282844800 + recur: weekly + project: gtd + status: pending + uuid: 33afada0-a446-8d5a-c213-30d99d52c4b0 + task: + description: Try out latest FireFox beta + entry: 1281289630 + project: software + status: pending + uuid: 43afada0-a446-8d5a-c213-30d99d52c4b0 +... +EOF + +printf "y\n" | task rc:x import file.yaml + +# Now the visible part. +echo +echo '$ task calendar sep 2010' +task rc:x calendar sep 2010 + +echo +echo '$ task calendar' +task rc:x calendar + +echo +echo '$ task overdue' +task rc:x 2 done + +exit + diff --git a/doc/misc/run.sample.attmod b/doc/misc/run.sample.attmod new file mode 100755 index 000000000..f8bbed8d3 --- /dev/null +++ b/doc/misc/run.sample.attmod @@ -0,0 +1,71 @@ +#! /bin/bash + +# Small script to create a fragment of output for display on the front page +# of taskwarrior.org, as a teaser. + +rm pending.data completed.data undo.data + +echo 'data.location=.' > x +echo '_forcecolor=on' >> x +echo 'defaultwidth=120' >> x +echo 'include /usr/local/share/doc/task/rc/dark-violets-256.theme' >> x +echo 'include /usr/local/share/doc/task/rc/holidays-US.rc' >> x +echo 'color.alternate=' >> x + +echo 'report.list.columns=id,project,priority_long,start,due,recur,age_compact,tags,description' >> x +echo 'report.list.labels=ID,Project,Pri,Started,Due,Recur,Age,Tags,Description' >> x +echo 'report.list.sort=due+,priority_long-,project+' >> x + +# Import tasks with old timestamps +cat <file.yaml +%YAML 1.1 +--- + task: + description: Try out the color themes + entry: 1281914800 + start: 1282044800 + project: software + status: pending + uuid: 13afada0-a446-8d5a-c213-30d99d52c4b0 + task: + description: Visit http://taskwarrior.org + entry: 1281089630 + tags: www + priority: H + project: software + status: pending + uuid: 23afada0-a446-8d5a-c213-30d99d52c4b0 + task: + description: Review task list + entry: 1281289630 + due: 1282844800 + recur: weekly + project: gtd + status: pending + uuid: 33afada0-a446-8d5a-c213-30d99d52c4b0 + task: + description: Try out latest FireFox beta + entry: 1281289630 + project: software + status: pending + uuid: 43afada0-a446-8d5a-c213-30d99d52c4b0 +... +EOF + +printf "y\n" | task rc:x import file.yaml + +# Now the visible part. +echo +echo '$ task calendar sep 2010' +task rc:x calendar sep 2010 + +echo +echo '$ task calendar' +task rc:x calendar + +echo +echo '$ task overdue' +task rc:x 2 done + +exit + diff --git a/doc/misc/run.sample.cal b/doc/misc/run.sample.cal new file mode 100755 index 000000000..f8bbed8d3 --- /dev/null +++ b/doc/misc/run.sample.cal @@ -0,0 +1,71 @@ +#! /bin/bash + +# Small script to create a fragment of output for display on the front page +# of taskwarrior.org, as a teaser. + +rm pending.data completed.data undo.data + +echo 'data.location=.' > x +echo '_forcecolor=on' >> x +echo 'defaultwidth=120' >> x +echo 'include /usr/local/share/doc/task/rc/dark-violets-256.theme' >> x +echo 'include /usr/local/share/doc/task/rc/holidays-US.rc' >> x +echo 'color.alternate=' >> x + +echo 'report.list.columns=id,project,priority_long,start,due,recur,age_compact,tags,description' >> x +echo 'report.list.labels=ID,Project,Pri,Started,Due,Recur,Age,Tags,Description' >> x +echo 'report.list.sort=due+,priority_long-,project+' >> x + +# Import tasks with old timestamps +cat <file.yaml +%YAML 1.1 +--- + task: + description: Try out the color themes + entry: 1281914800 + start: 1282044800 + project: software + status: pending + uuid: 13afada0-a446-8d5a-c213-30d99d52c4b0 + task: + description: Visit http://taskwarrior.org + entry: 1281089630 + tags: www + priority: H + project: software + status: pending + uuid: 23afada0-a446-8d5a-c213-30d99d52c4b0 + task: + description: Review task list + entry: 1281289630 + due: 1282844800 + recur: weekly + project: gtd + status: pending + uuid: 33afada0-a446-8d5a-c213-30d99d52c4b0 + task: + description: Try out latest FireFox beta + entry: 1281289630 + project: software + status: pending + uuid: 43afada0-a446-8d5a-c213-30d99d52c4b0 +... +EOF + +printf "y\n" | task rc:x import file.yaml + +# Now the visible part. +echo +echo '$ task calendar sep 2010' +task rc:x calendar sep 2010 + +echo +echo '$ task calendar' +task rc:x calendar + +echo +echo '$ task overdue' +task rc:x 2 done + +exit + diff --git a/doc/misc/run.sample.deps b/doc/misc/run.sample.deps new file mode 100755 index 000000000..7a673c358 --- /dev/null +++ b/doc/misc/run.sample.deps @@ -0,0 +1,58 @@ +#! /bin/bash + +# Small script to create a fragment of output for display on the front page +# of taskwarrior.org, as a teaser. + +rm pending.data completed.data undo.data + +echo 'data.location=.' > x +echo '_forcecolor=on' >> x +echo 'defaultwidth=120' >> x +echo 'include /usr/local/share/doc/task/rc/dark-violets-256.theme' >> x +echo 'include /usr/local/share/doc/task/rc/holidays-US.rc' >> x +echo 'color.alternate=' >> x + +echo 'report.list.columns=id,project,priority_long,start,due,recur,age_compact,tags,description' >> x +echo 'report.list.labels=ID,Project,Pri,Started,Due,Recur,Age,Tags,Description' >> x +echo 'report.list.sort=due+,priority_long-,project+' >> x + +# Now the visible part. + +echo +echo $ task add project:Cake Buy the ingredients +task rc:x add project:Cake Buy the ingredients + +echo +echo $ task add project:Cake Warm the oven depends:1 +task rc:x add project:Cake Warm the oven depends:1 + +echo +echo $ task add project:Cake Mix the ingredients depends:2 +task rc:x add project:Cake Mix the ingredients depends:2 + +echo +echo $ task add project:Cake Bake the cake depends:3 +task rc:x add project:Cake Bake the cake depends:3 + +echo +echo $ task add project:Cake Eat the cake depends:3 +task rc:x add project:Cake Eat the cake depends:3 + +echo +echo $ task long +task rc:x long + +echo +echo $ task 5 depends:4,-3 +task rc:x 5 depends:4,-3 + +echo +echo $ task blocked +task rc:x blocked + +echo +echo $ task 2 info +task rc:x 2 info + +exit + diff --git a/doc/misc/run.sample.ghistory b/doc/misc/run.sample.ghistory new file mode 100755 index 000000000..f8bbed8d3 --- /dev/null +++ b/doc/misc/run.sample.ghistory @@ -0,0 +1,71 @@ +#! /bin/bash + +# Small script to create a fragment of output for display on the front page +# of taskwarrior.org, as a teaser. + +rm pending.data completed.data undo.data + +echo 'data.location=.' > x +echo '_forcecolor=on' >> x +echo 'defaultwidth=120' >> x +echo 'include /usr/local/share/doc/task/rc/dark-violets-256.theme' >> x +echo 'include /usr/local/share/doc/task/rc/holidays-US.rc' >> x +echo 'color.alternate=' >> x + +echo 'report.list.columns=id,project,priority_long,start,due,recur,age_compact,tags,description' >> x +echo 'report.list.labels=ID,Project,Pri,Started,Due,Recur,Age,Tags,Description' >> x +echo 'report.list.sort=due+,priority_long-,project+' >> x + +# Import tasks with old timestamps +cat <file.yaml +%YAML 1.1 +--- + task: + description: Try out the color themes + entry: 1281914800 + start: 1282044800 + project: software + status: pending + uuid: 13afada0-a446-8d5a-c213-30d99d52c4b0 + task: + description: Visit http://taskwarrior.org + entry: 1281089630 + tags: www + priority: H + project: software + status: pending + uuid: 23afada0-a446-8d5a-c213-30d99d52c4b0 + task: + description: Review task list + entry: 1281289630 + due: 1282844800 + recur: weekly + project: gtd + status: pending + uuid: 33afada0-a446-8d5a-c213-30d99d52c4b0 + task: + description: Try out latest FireFox beta + entry: 1281289630 + project: software + status: pending + uuid: 43afada0-a446-8d5a-c213-30d99d52c4b0 +... +EOF + +printf "y\n" | task rc:x import file.yaml + +# Now the visible part. +echo +echo '$ task calendar sep 2010' +task rc:x calendar sep 2010 + +echo +echo '$ task calendar' +task rc:x calendar + +echo +echo '$ task overdue' +task rc:x 2 done + +exit + diff --git a/doc/misc/run.sample.summary b/doc/misc/run.sample.summary new file mode 100755 index 000000000..f8bbed8d3 --- /dev/null +++ b/doc/misc/run.sample.summary @@ -0,0 +1,71 @@ +#! /bin/bash + +# Small script to create a fragment of output for display on the front page +# of taskwarrior.org, as a teaser. + +rm pending.data completed.data undo.data + +echo 'data.location=.' > x +echo '_forcecolor=on' >> x +echo 'defaultwidth=120' >> x +echo 'include /usr/local/share/doc/task/rc/dark-violets-256.theme' >> x +echo 'include /usr/local/share/doc/task/rc/holidays-US.rc' >> x +echo 'color.alternate=' >> x + +echo 'report.list.columns=id,project,priority_long,start,due,recur,age_compact,tags,description' >> x +echo 'report.list.labels=ID,Project,Pri,Started,Due,Recur,Age,Tags,Description' >> x +echo 'report.list.sort=due+,priority_long-,project+' >> x + +# Import tasks with old timestamps +cat <file.yaml +%YAML 1.1 +--- + task: + description: Try out the color themes + entry: 1281914800 + start: 1282044800 + project: software + status: pending + uuid: 13afada0-a446-8d5a-c213-30d99d52c4b0 + task: + description: Visit http://taskwarrior.org + entry: 1281089630 + tags: www + priority: H + project: software + status: pending + uuid: 23afada0-a446-8d5a-c213-30d99d52c4b0 + task: + description: Review task list + entry: 1281289630 + due: 1282844800 + recur: weekly + project: gtd + status: pending + uuid: 33afada0-a446-8d5a-c213-30d99d52c4b0 + task: + description: Try out latest FireFox beta + entry: 1281289630 + project: software + status: pending + uuid: 43afada0-a446-8d5a-c213-30d99d52c4b0 +... +EOF + +printf "y\n" | task rc:x import file.yaml + +# Now the visible part. +echo +echo '$ task calendar sep 2010' +task rc:x calendar sep 2010 + +echo +echo '$ task calendar' +task rc:x calendar + +echo +echo '$ task overdue' +task rc:x 2 done + +exit + diff --git a/doc/misc/run.sample.timesheet b/doc/misc/run.sample.timesheet new file mode 100755 index 000000000..07105138a --- /dev/null +++ b/doc/misc/run.sample.timesheet @@ -0,0 +1,63 @@ +#! /bin/bash + +# Small script to create a fragment of output for display on the front page +# of taskwarrior.org, as a teaser. + +rm pending.data completed.data undo.data + +echo 'data.location=.' > x +echo '_forcecolor=on' >> x +echo 'defaultwidth=120' >> x +echo 'include /usr/local/share/doc/task/rc/dark-violets-256.theme' >> x +echo 'include /usr/local/share/doc/task/rc/holidays-US.rc' >> x +echo 'color.alternate=' >> x + +echo 'report.list.columns=id,project,priority_long,start,due,recur,age_compact,tags,description' >> x +echo 'report.list.labels=ID,Project,Pri,Started,Due,Recur,Age,Tags,Description' >> x +echo 'report.list.sort=due+,priority_long-,project+' >> x + +# Import tasks with old timestamps +cat <file.yaml +%YAML 1.1 +--- + task: + description: Try out the color themes + entry: 1281914800 + start: 1282044800 + project: software + status: pending + uuid: 13afada0-a446-8d5a-c213-30d99d52c4b0 + task: + description: Visit http://taskwarrior.org + entry: 1281089630 + tags: www + priority: H + project: software + status: pending + uuid: 23afada0-a446-8d5a-c213-30d99d52c4b0 + task: + description: Review task list + entry: 1281289630 + due: 1282844800 + recur: weekly + project: gtd + status: pending + uuid: 33afada0-a446-8d5a-c213-30d99d52c4b0 + task: + description: Try out latest FireFox beta + entry: 1281289630 + project: software + status: pending + uuid: 43afada0-a446-8d5a-c213-30d99d52c4b0 +... +EOF + +printf "y\n" | task rc:x import file.yaml + +# Now the visible part. +echo +echo '$ task timesheet 2' +task rc:x timesheet 2 + +exit +