From 2b646b3fa02860d058c21ba09be0a63d75b1436b Mon Sep 17 00:00:00 2001 From: Paul Beckingham Date: Fri, 11 Jul 2008 01:28:35 -0400 Subject: [PATCH] - Documentation update for 1.4.0 --- html/30second.html | 27 ++++--- html/advanced.html | 27 ++++--- html/color.html | 27 ++++--- html/config.html | 27 ++++--- html/date.html | 160 ++++++++++++++++++++++++++++++++++++++ html/recur.html | 138 ++++++++++++++++++++++++++++---- html/setup.html | 35 +++++---- html/shell.html | 27 ++++--- html/simple.html | 27 ++++--- html/task.html | 56 ++++++++----- html/troubleshooting.html | 16 +++- html/usage.html | 27 ++++--- html/versions.html | 16 +++- 13 files changed, 475 insertions(+), 135 deletions(-) create mode 100644 html/date.html diff --git a/html/30second.html b/html/30second.html index fe67fc899..3d2cb4c46 100644 --- a/html/30second.html +++ b/html/30second.html @@ -7,22 +7,25 @@ -
- Home - Setup - Simple - Advanced - Shell - Configuration - Colors - Usage -
-
-
+

diff --git a/html/advanced.html b/html/advanced.html index 5cf5afc39..f48d0dc23 100644 --- a/html/advanced.html +++ b/html/advanced.html @@ -7,22 +7,25 @@ - -
-
+

diff --git a/html/color.html b/html/color.html index 6e2f63b47..fffa71b41 100644 --- a/html/color.html +++ b/html/color.html @@ -7,22 +7,25 @@ - -
-
+

diff --git a/html/config.html b/html/config.html index 4bd2a11fb..731fa6668 100644 --- a/html/config.html +++ b/html/config.html @@ -7,22 +7,25 @@ - -
-
+

diff --git a/html/date.html b/html/date.html new file mode 100644 index 000000000..4f9f143ce --- /dev/null +++ b/html/date.html @@ -0,0 +1,160 @@ + + + + Task 1.4.0 + + + + + +
+ + + + + + +
+ + +
+
+
+
+

Date Handling

+
+

+ Task reads dates from the command line, and displays dates in the reports. +

+ +

+ In order to do this in a flexible way, task obeys a configuration variable that + determines the expected and desired date format. See the + Configuring Task page for details. +

+ +

+ In addition to exactly specifying the date, such as: +

+ + 
% task ... due:7/10/2008
+ +

+ task supports a flexible variety of alternatives. For example: +

+ + 
% task ... due:today
+ +

+ Similarly: +

+ + 
% task ... due:yesterday
+% task ... due:tomorrow
+ +

+ Here are some other forms that are accepted. The day number, followed by an + ordinal: +

+ + 
% task ... due:23rd
+ +

+ End of month: +

+ + 
% task ... due:eom
+ +

+ End of year: +

+ + 
% task ... due:eoy
+ +

+ End of week (Friday): +

+ + 
% task ... due:eow
+ +

+ Next Friday: +

+ + 
% task ... due:Friday
+ +

+ Note that next Friday means seven days from now if today is Friday, otherwise + it means the next occurring Friday. Most of these forms may be specified using + abbreviations, provided they are unique. For example: +

+ + 
% task ... due:fri
+ + +
+ + +
+
+
+

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

+
+ +
+ 		+
+
+
+
+
+
+
+
+
+
+ + + +
+ +
+ + + + + + + diff --git a/html/recur.html b/html/recur.html index d035b7f5e..2a894022a 100644 --- a/html/recur.html +++ b/html/recur.html @@ -7,22 +7,25 @@ - -
-
+

@@ -31,12 +34,121 @@

Recurring Tasks

+ Task supports recurring tasks, which is a task that keeps falling due, on a + regular schedule. An example of this may be "pay rent". Here is how + recurring tasks work in task:

+ Ordinarily, a task is a single item that is entered in the pending state, and + remains so until it is either completed or deleted. This is an example of a + single instance task.

-
+

+ A recurring task is different. When a recurring task is entered, it remains + hidden from view, but acts as a root task for a task instances that are + generated on a regular basis. Consider the example: +

+ + 
% task Pay rent due:7/1/2008 recur:monthly
+ +

+ If today's date is 7/10, for example, then that due date is in the past, and + you might expect there to be an already overdue task for 7/1/2008, and another + due on 8/1/2008. This means that from that root, task has created two + instances with different due dates. +

+ + 
% task list
+
+ID Project Pri Due         Active Age   Description
+1              7/1/2008           1 min Pay rent
+2              8/1/2008           1 min Pay rent
+
+2 tasks
+ +

+ Task creates any overdue tasks, then creates one additional due task. These + new task instances are then completed or deleted as you normally would. +

+ +

+ In the example above, a new task instance is created every month, and this will + repeat indefinitely. Task also supports an end date. Suppose you are taking + every Friday off work for the summer. You'll need to submit your TPS report on + Thursdays instead: +

+ + 
% task TPS report due:thursday recur:weekly until:8/31/2008
+ +

+ This create a weekly recurring task that expires on 8/31/2008. What this means + is that after all those task instances have been created, then completed or + deleted, the root task will expire and disappear. Task will tell you what it + is doing when this happens. +

+ +

Deletion

+

+ When a recurring task is deleted, you will be asked if you would also like to + delete all recurring task instances: +

+ + 
% task del 1
+Permanently delete task? (y/n) y
+This is a recurring task.  Do you want to delete all pending
+recurrences of this same task? (y/n) y
+ +

Recurrence Periods

+

+ In the above examples, the recurrence period was specified as "monthly" and + "weekly". Task supports several ways of specifying this: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PeriodMeaning
daily, day, 1d, 2d ...Every day, or a number of days
weekly, 1w, 2w ...Every week, or a number of weeks
biweekly, fortnightEvery two weeks
monthly, 1m, 2m ...Every month, or a number of months
bimonthlyEvery two months
quarterly, 1q, 2q ...Every three months, a quarter, or a number of quarters
semiannualEvery six months
annual, yearly, 1y, 2y ...Every year, or a number of years
biannual, biyearly, 2yEvery two-years
+


diff --git a/html/setup.html b/html/setup.html index da15729b5..ea05c9609 100644 --- a/html/setup.html +++ b/html/setup.html @@ -7,22 +7,25 @@ - -
-
+

@@ -36,10 +39,10 @@ 

% ls
-task-1.3.0.tar.gz
-% gunzip task-1.3.0.tar.gz
-% tar xf task-1.3.0.tar
-% cd task-1.3.0
+task-1.4.0.tar.gz
+% gunzip task-1.4.0.tar.gz
+% tar xf task-1.4.0.tar
+% cd task-1.4.0
 % ./configure
 ...
 % make
diff --git a/html/shell.html b/html/shell.html
index a380d00f6..e9015e5ab 100644
--- a/html/shell.html
+++ b/html/shell.html
@@ -7,22 +7,25 @@
   
 
   
-    
-
     

-
       

         

           
+            
 
             

               

diff --git a/html/simple.html b/html/simple.html
index b9e6e1765..d986998a9 100644
--- a/html/simple.html
+++ b/html/simple.html
@@ -7,22 +7,25 @@
   
 
   
-    
-
     

-
       

         

           
+            
 
             

               

diff --git a/html/task.html b/html/task.html
index 1ed2baa39..57135fe47 100644
--- a/html/task.html
+++ b/html/task.html
@@ -7,37 +7,38 @@
   
 
   
-    
-
     

-
       

         

           
+            
 
             

               

               

               

-              
Task Home Page

+              
Task

               

-                Here you will find information on how to acquire, build, configure,
-                use and become proficient with the task program.
+                Task is an open source, command-line, TODO list manager.
               

 
               

-                Alternatively, watch the
-                task movie
-                which illustrates many of task's features.
+                Here you will find information on how to acquire, build, configure,
+                use and become proficient with the task program.
               

 
               
 
+              

+                More documents are being written, and will be added here.
+              

+
+              

+                Alternatively, watch the
+                task movie
+                which illustrates many of task's features.
+              

+
               

               
Get the Latest Source Release
                 task-1.4.0.tar.gz
@@ -60,7 +76,7 @@
               

                 
New in version 1.4.0 (7/10/2008)