From 52dfa8da1eb92443a7dc34d1f3d8c1e3337c580c Mon Sep 17 00:00:00 2001
From: Paul Beckingham <paul@beckingham.net>
Date: Sun, 13 May 2012 18:04:48 -0400
Subject: [PATCH] Documentation

- Updated more documentation regarding 'scheduled' dates.
- Added color.scheduled to the rule.precedence.color setting.
- Added 'ready' report to the main man page.
---
 doc/man/task.1.in   | 6 ++++++
 doc/man/taskrc.5.in | 2 +-
 src/Config.cpp      | 4 +++-
 src/DOM.cpp         | 6 +++---
 4 files changed, 13 insertions(+), 5 deletions(-)

diff --git a/doc/man/task.1.in b/doc/man/task.1.in
index d5fbd996a..e95e28d65 100644
--- a/doc/man/task.1.in
+++ b/doc/man/task.1.in
@@ -251,6 +251,12 @@ Shows the newest tasks matching the filter.
 Shows a page of the most urgent tasks, sorted by urgency, which is a calculated
 value.
 
+.TP
+.B task <filter> ready
+Shows a page of the most urgent ready tasks, sorted by urgency.  A ready task is
+one that is either unscheduled, or has a scheduled date that is past and has no
+wait date.
+
 .TP
 .B task <filter> oldest
 Shows the oldest tasks matching the filter.
diff --git a/doc/man/taskrc.5.in b/doc/man/taskrc.5.in
index d21755513..e862a3c45 100644
--- a/doc/man/taskrc.5.in
+++ b/doc/man/taskrc.5.in
@@ -925,7 +925,7 @@ Colors the output of the merge command.
 .RE
 
 .TP
-.B rule.precedence.color=due.today,active,blocked,overdue,due,keyword,project,tag,recurring,pri,tagged,completed,deleted
+.B rule.precedence.color=due.today,active,blocked,overdue,due,scheduled,keyword,project,tag,recurring,pri,tagged,completed,deleted
 .RS
 This setting specifies the precedence of the color rules, from highest to
 lowest.  Note that the prefix 'color.' is omitted (for brevity), and that any
diff --git a/src/Config.cpp b/src/Config.cpp
index 38e6d6616..d3edd151e 100644
--- a/src/Config.cpp
+++ b/src/Config.cpp
@@ -197,6 +197,7 @@ std::string Config::_defaults =
   "#color.tag.bug=yellow                          # Color of +bug tasks\n"
   "#color.tag.none=                               # Color of tag-less tasks\n"
   "color.active=rgb555 on rgb410                  # Color of active tasks\n"
+  "color.scheduled=rgb444 on rgb410               # Color of scheduled tasks\n"
   "color.pri.none=                                # Color of priority:  tasks\n"
   "color.pri.H=rgb255                             # Color of priority:H tasks\n"
   "color.pri.M=rgb250                             # Color of priority:M tasks\n"
@@ -248,6 +249,7 @@ std::string Config::_defaults =
   "#color.tag.bug=yellow                          # Color of +bug tasks\n"
   "#color.tag.none=                               # Color of tag-less tasks\n"
   "color.active=black on bright green             # Color of active tasks\n"
+  "color.scheduled=black on green                 # Color of scheduled tasks\n"
   "color.pri.none=                                # Color of priority:  tasks\n"
   "color.pri.H=bold white                         # Color of priority:H tasks\n"
   "color.pri.M=white                              # Color of priority:M tasks\n"
@@ -261,7 +263,7 @@ std::string Config::_defaults =
   "# Here is the rule precedence order, highest to lowest.\n"
   "# Note that these are just the color rule names, without the leading 'color.'\n"
   "#      and any trailing '.value'.\n"
-  "rule.precedence.color=due.today,active,blocked,overdue,due,keyword,project,tag,recurring,pri,tagged,completed,deleted\n"
+  "rule.precedence.color=due.today,active,blocked,overdue,due,scheduled,keyword,project,tag,recurring,pri,tagged,completed,deleted\n"
   "\n"
   "# Shadow file support\n"
   "#shadow.file=/tmp/shadow.txt                   # Location of shadow file\n"
diff --git a/src/DOM.cpp b/src/DOM.cpp
index 4ed68ea29..c9778fadc 100644
--- a/src/DOM.cpp
+++ b/src/DOM.cpp
@@ -161,7 +161,7 @@ const std::string DOM::get (const std::string& name)
 ////////////////////////////////////////////////////////////////////////////////
 // DOM Supported References:
 //
-//   TODO <id>.{entry,start,end,due,until,wait}
+//   TODO <id>.{entry,start,end,scheduled,due,until,wait}
 //   TODO <id>.description
 //   TODO <id>.project
 //   TODO <id>.priority
@@ -172,7 +172,7 @@ const std::string DOM::get (const std::string& name)
 //   TODO <id>.recur
 //   TODO <id>.depends
 //
-//   TODO <uuid>.{entry,start,end,due,until,wait}
+//   TODO <uuid>.{entry,start,end,scheduled,due,until,wait}
 //   TODO <uuid>.description
 //   TODO <uuid>.project
 //   TODO <uuid>.priority
@@ -183,7 +183,7 @@ const std::string DOM::get (const std::string& name)
 //   TODO <uuid>.recur
 //   TODO <uuid>.depends
 //
-//   {entry,start,end,due,until,wait}
+//   {entry,start,end,scheduled,due,until,wait}
 //   description
 //   project
 //   priority