diff --git a/Makefile.am b/Makefile.am index fb05a3a4a..549946a75 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,3 +1,3 @@ SUBDIRS = src -EXTRA_DIST = DEVELOPERS +EXTRA_DIST = DEVELOPERS README.1.5.0 diff --git a/README.1.5.0 b/README.1.5.0 new file mode 100644 index 000000000..23dc8bd5d --- /dev/null +++ b/README.1.5.0 @@ -0,0 +1,15 @@ +Task 1.5.0 has a custom reports feature. Three of the existing task reports +are no longer implemented in task, and need to be added as custom reports. +Simply copy the following six lines into your existing .taskrc file. + +New task users need not do this - task will create an initial .taskrc file +on first startup. + + +report.long.columns=id,project,priority,entry,start,due,age,tags,description +report.long.sort=due+,priority-,project+ +report.list.columns=id,project,priority,due,active,age,description +report.list.sort=due+,priority-,project+ +report.ls.columns=id,project,priority,description +report.ls.sort=priority-,project+ + diff --git a/html/custom.html b/html/custom.html new file mode 100644 index 000000000..7a970e58e --- /dev/null +++ b/html/custom.html @@ -0,0 +1,152 @@ + + + + Custom Reports + + + + + +
+ + + + + + +
+ + +
+
+
+
+

Custom Reports

+
+

+ Task allows you to customize reports, to a limited degree. + The "list", "long", and "ls" reports are all now custom + reports, whereas in previous releases of task they were not + mutable. This means they can be modified, renamed, or deleted. +

+ +

+ More importantly, you can define your own. Here are the + two necessary items in the .taskrc file that define a new + report: +

+ + 
report.mine.columns=id,project,priority,description
+report.mine.sort=priority-,project+
 + +

+ This defines a report, called "mine", that has four columns: + id, project, priority and description. It will be sorted on + two columns: by descending priority then ascending project. + Because this report is called "mine", it can be run with the + command: +

+ + 
% task mine
 + +

+ A filter can also be specified like this: +

+ + 
report.mine.filter=priority:H +bug
 + +

+ This adds a filter so that only tasks with priority "H" and + with the "bug" tag are included in the report. This filter + definition is optional. +

+ +

+ Here is a list of all the possible columns that may be included + in a report: +

+ +
    +
  • id +
  • uuid +
  • project +
  • priority +
  • entry +
  • start +
  • due +
  • age +
  • active +
  • tags +
  • description +
+ +

+ Custom reports will show up in the task command line usage. +

+ +
+ +
+
+
+

+ Copyright 2006-2009, P. Beckingham. All rights reserved. +

+
+ +
+ 		+
+
+
+
+
+
+
+
+
+
+ + + +
+ +
+ + + + + + + diff --git a/html/task.html b/html/task.html index 7e6e77a03..696a0a6b5 100644 --- a/html/task.html +++ b/html/task.html @@ -57,6 +57,7 @@
  • Old Versions
  • Filters
  • Shadow Files +
  • Custom Reports

    @@ -113,6 +114,21 @@ in the configuration file can be renamed. +

    + Note that users of task prior to version 1.5.0 will need to add + the following six lines to their .taskrc file. See also the + README.1.5.0 file in the distribution for more details. +

    + + 
    report.long.columns=id,project,priority,entry,start,due,age,tags,description
+report.long.sort=due+,priority-,project+
+
+report.list.columns=id,project,priority,due,active,age,description
+report.list.sort=due+,priority-,project+
+
+report.ls.columns=id,project,priority,description
+report.ls.sort=priority-,project+
    +

    (Find out what was new in prior versions)