Documentation

- Updated more documentation regarding 'scheduled' dates.
- Added color.scheduled to the rule.precedence.color setting.
- Added 'ready' report to the main man page.
This commit is contained in:
Paul Beckingham
2012-05-13 18:04:48 -04:00
parent 98f215b1b5
commit 52dfa8da1e
4 changed files with 13 additions and 5 deletions

View File

@@ -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 Shows a page of the most urgent tasks, sorted by urgency, which is a calculated
value. 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 .TP
.B task <filter> oldest .B task <filter> oldest
Shows the oldest tasks matching the filter. Shows the oldest tasks matching the filter.

View File

@@ -925,7 +925,7 @@ Colors the output of the merge command.
.RE .RE
.TP .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 .RS
This setting specifies the precedence of the color rules, from highest to 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 lowest. Note that the prefix 'color.' is omitted (for brevity), and that any

View File

@@ -197,6 +197,7 @@ std::string Config::_defaults =
"#color.tag.bug=yellow # Color of +bug tasks\n" "#color.tag.bug=yellow # Color of +bug tasks\n"
"#color.tag.none= # Color of tag-less tasks\n" "#color.tag.none= # Color of tag-less tasks\n"
"color.active=rgb555 on rgb410 # Color of active 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.none= # Color of priority: tasks\n"
"color.pri.H=rgb255 # Color of priority:H tasks\n" "color.pri.H=rgb255 # Color of priority:H tasks\n"
"color.pri.M=rgb250 # Color of priority:M 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.bug=yellow # Color of +bug tasks\n"
"#color.tag.none= # Color of tag-less tasks\n" "#color.tag.none= # Color of tag-less tasks\n"
"color.active=black on bright green # Color of active 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.none= # Color of priority: tasks\n"
"color.pri.H=bold white # Color of priority:H tasks\n" "color.pri.H=bold white # Color of priority:H tasks\n"
"color.pri.M=white # Color of priority:M 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" "# Here is the rule precedence order, highest to lowest.\n"
"# Note that these are just the color rule names, without the leading 'color.'\n" "# Note that these are just the color rule names, without the leading 'color.'\n"
"# and any trailing '.value'.\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" "\n"
"# Shadow file support\n" "# Shadow file support\n"
"#shadow.file=/tmp/shadow.txt # Location of shadow file\n" "#shadow.file=/tmp/shadow.txt # Location of shadow file\n"

View File

@@ -161,7 +161,7 @@ const std::string DOM::get (const std::string& name)
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
// DOM Supported References: // 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>.description
// TODO <id>.project // TODO <id>.project
// TODO <id>.priority // TODO <id>.priority
@@ -172,7 +172,7 @@ const std::string DOM::get (const std::string& name)
// TODO <id>.recur // TODO <id>.recur
// TODO <id>.depends // 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>.description
// TODO <uuid>.project // TODO <uuid>.project
// TODO <uuid>.priority // TODO <uuid>.priority
@@ -183,7 +183,7 @@ const std::string DOM::get (const std::string& name)
// TODO <uuid>.recur // TODO <uuid>.recur
// TODO <uuid>.depends // TODO <uuid>.depends
// //
// {entry,start,end,due,until,wait} // {entry,start,end,scheduled,due,until,wait}
// description // description
// project // project
// priority // priority