GothenburgBitFactory/taskwarrior
1
0
Fork 0
mirror of https://github.com/GothenburgBitFactory/taskwarrior.git synced 2025-06-26 10:54:26 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

- Documentation update for 1.4.0

Browse source
This commit is contained in:
Paul Beckingham 2008-07-11 01:28:35 -04:00
parent 86f5294436
commit 2b646b3fa0
13 changed files with 475 additions and 135 deletions
Download patch file Download diff file Expand all files Collapse all files

15
html/30second.html
View file

@ -7,23 +7,26 @@
</head> </head>
<body> <body>
<div id="container">
<table>
<tr>
<td>
<div id="toolbar"> <div id="toolbar">
<a href="task.html">Home</a> <a href="task.html">Home</a>
<a href="setup.html">Setup</a> <a href="setup.html">Setup</a>
<a href="30second.html">30-second Tutorial</a>
<a href="simple.html">Simple</a> <a href="simple.html">Simple</a>
<a href="advanced.html">Advanced</a> <a href="advanced.html">Advanced</a>
<a href="shell.html">Shell</a> <a href="shell.html">Shell</a>
<a href="config.html">Configuration</a> <a href="config.html">Configuration</a>
<a href="color.html">Colors</a> <a href="color.html">Colors</a>
<a href="usage.html">Usage</a> <a href="usage.html">Usage</a>
<a href="recur.html">Recurrence</a>
<a href="date.html">Date Handling</a>
<a href="troubleshooting.html">Troubleshooting</a>
<a href="versions.html">Old Versions</a>
</div> </div>
<div id="container">
<table>
<tr>
<td>
<div id="content"> <div id="content">
<br /> <br />
<br /> <br />

27
html/advanced.html
View file

@ -7,22 +7,25 @@
</head> </head>
<body> <body>
<div id="toolbar">
<a href="task.html">Home</a>
<a href="setup.html">Setup</a>
<a href="task.html#simple">Simple</a>
<a href="task.html#advanced">Advanced</a>
<a href="shell.html">Shell</a>
<a href="config.html">Configuration</a>
<a href="task.html#color">Colors</a>
<a href="usage.html">Usage</a>
</div>
<div id="container"> <div id="container">
<table> <table>
<tr> <tr>
<td> <td>
<div id="toolbar">
<a href="task.html">Home</a>
<a href="setup.html">Setup</a>
<a href="30second.html">30-second Tutorial</a>
<a href="simple.html">Simple</a>
<a href="advanced.html">Advanced</a>
<a href="shell.html">Shell</a>
<a href="config.html">Configuration</a>
<a href="color.html">Colors</a>
<a href="usage.html">Usage</a>
<a href="recur.html">Recurrence</a>
<a href="date.html">Date Handling</a>
<a href="troubleshooting.html">Troubleshooting</a>
<a href="versions.html">Old Versions</a>
</div>
<div id="content"> <div id="content">
<br /> <br />

15
html/color.html
View file

@ -7,23 +7,26 @@
</head> </head>
<body> <body>
<div id="container">
<table>
<tr>
<td>
<div id="toolbar"> <div id="toolbar">
<a href="task.html">Home</a> <a href="task.html">Home</a>
<a href="setup.html">Setup</a> <a href="setup.html">Setup</a>
<a href="30second.html">30-second Tutorial</a>
<a href="simple.html">Simple</a> <a href="simple.html">Simple</a>
<a href="advanced.html">Advanced</a> <a href="advanced.html">Advanced</a>
<a href="shell.html">Shell</a> <a href="shell.html">Shell</a>
<a href="config.html">Configuration</a> <a href="config.html">Configuration</a>
<a href="color.html">Colors</a> <a href="color.html">Colors</a>
<a href="usage.html">Usage</a> <a href="usage.html">Usage</a>
<a href="recur.html">Recurrence</a>
<a href="date.html">Date Handling</a>
<a href="troubleshooting.html">Troubleshooting</a>
<a href="versions.html">Old Versions</a>
</div> </div>
<div id="container">
<table>
<tr>
<td>
<div id="content"> <div id="content">
<br /> <br />
<br /> <br />

15
html/config.html
View file

@ -7,23 +7,26 @@
</head> </head>
<body> <body>
<div id="container">
<table>
<tr>
<td>
<div id="toolbar"> <div id="toolbar">
<a href="task.html">Home</a> <a href="task.html">Home</a>
<a href="setup.html">Setup</a> <a href="setup.html">Setup</a>
<a href="30second.html">30-second Tutorial</a>
<a href="simple.html">Simple</a> <a href="simple.html">Simple</a>
<a href="advanced.html">Advanced</a> <a href="advanced.html">Advanced</a>
<a href="shell.html">Shell</a> <a href="shell.html">Shell</a>
<a href="config.html">Configuration</a> <a href="config.html">Configuration</a>
<a href="color.html">Colors</a> <a href="color.html">Colors</a>
<a href="usage.html">Usage</a> <a href="usage.html">Usage</a>
<a href="recur.html">Recurrence</a>
<a href="date.html">Date Handling</a>
<a href="troubleshooting.html">Troubleshooting</a>
<a href="versions.html">Old Versions</a>
</div> </div>
<div id="container">
<table>
<tr>
<td>
<div id="content"> <div id="content">
<br /> <br />
<br /> <br />

160
html/date.html Normal file
View file

@ -0,0 +1,160 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Task 1.4.0</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rel="stylesheet" href="task.css" type="text/css" />
</head>
<body>
<div id="container">
<table>
<tr>
<td>
<div id="toolbar">
<a href="task.html">Home</a>
<a href="setup.html">Setup</a>
<a href="30second.html">30-second Tutorial</a>
<a href="simple.html">Simple</a>
<a href="advanced.html">Advanced</a>
<a href="shell.html">Shell</a>
<a href="config.html">Configuration</a>
<a href="color.html">Colors</a>
<a href="usage.html">Usage</a>
<a href="recur.html">Recurrence</a>
<a href="date.html">Date Handling</a>
<a href="troubleshooting.html">Troubleshooting</a>
<a href="versions.html">Old Versions</a>
</div>
<div id="content">
<br />
<br />
<br />
<h2 class="title">Date Handling</h2>
<div class="content">
<p>
Task reads dates from the command line, and displays dates in the reports.
</p>
<p>
In order to do this in a flexible way, task obeys a configuration variable that
determines the expected and desired date format. See the
<a href="config.html">Configuring Task</a> page for details.
</p>
<p>
In addition to exactly specifying the date, such as:
</p>
<pre><code>% task ... due:7/10/2008</code></pre>
<p>
task supports a flexible variety of alternatives. For example:
</p>
<pre><code>% task ... due:today</code></pre>
<p>
Similarly:
</p>
<pre><code>% task ... due:yesterday
% task ... due:tomorrow</code></pre>
<p>
Here are some other forms that are accepted. The day number, followed by an
ordinal:
</p>
<pre><code>% task ... due:23rd</code></pre>
<p>
End of month:
</p>
<pre><code>% task ... due:eom</code></pre>
<p>
End of year:
</p>
<pre><code>% task ... due:eoy</code></pre>
<p>
End of week (Friday):
</p>
<pre><code>% task ... due:eow</code></pre>
<p>
Next Friday:
</p>
<pre><code>% task ... due:Friday</code></pre>
<p>
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:
</p>
<pre><code>% task ... due:fri</code></pre>
</div>
<br />
<br />
<div class="content">
<p>
Copyright 2006-2008, P. Beckingham. All rights reserved.
</p>
</div>
</div>
</td>
<td align="right" valign="top" width="200px">
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<script type="text/javascript"><!--
google_ad_client = "pub-9709799404235424";
/* Task Main */
google_ad_slot = "8660617875";
google_ad_width = 120;
google_ad_height = 600;
//-->
</script>
<script type="text/javascript"
src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
</script>
</td>
</tr>
</table>
</div>
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
var pageTracker = _gat._getTracker("UA-4737637-1");
pageTracker._initData();
pageTracker._trackPageview();
</script>
</body>
</html>

126
html/recur.html
View file

@ -7,23 +7,26 @@
</head> </head>
<body> <body>
<div id="container">
<table>
<tr>
<td>
<div id="toolbar"> <div id="toolbar">
<a href="task.html">Home</a> <a href="task.html">Home</a>
<a href="setup.html">Setup</a> <a href="setup.html">Setup</a>
<a href="30second.html">30-second Tutorial</a>
<a href="simple.html">Simple</a> <a href="simple.html">Simple</a>
<a href="advanced.html">Advanced</a> <a href="advanced.html">Advanced</a>
<a href="shell.html">Shell</a> <a href="shell.html">Shell</a>
<a href="config.html">Configuration</a> <a href="config.html">Configuration</a>
<a href="color.html">Colors</a> <a href="color.html">Colors</a>
<a href="usage.html">Usage</a> <a href="usage.html">Usage</a>
<a href="recur.html">Recurrence</a>
<a href="date.html">Date Handling</a>
<a href="troubleshooting.html">Troubleshooting</a>
<a href="versions.html">Old Versions</a>
</div> </div>
<div id="container">
<table>
<tr>
<td>
<div id="content"> <div id="content">
<br /> <br />
<br /> <br />
@ -31,12 +34,121 @@
<h2 class="title">Recurring Tasks</h2> <h2 class="title">Recurring Tasks</h2>
<div class="content"> <div class="content">
<p> <p>
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:
</p> </p>
<p> <p>
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.
</p> </p>
</div>
<p>
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:
</p>
<pre><code>% task Pay rent due:7/1/2008 recur:monthly</code></pre>
<p>
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.
</p>
<pre><code>% 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</code></pre>
<p>
Task creates any overdue tasks, then creates one additional due task. These
new task instances are then completed or deleted as you normally would.
</p>
<p>
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:
</p>
<pre><code>% task TPS report due:thursday recur:weekly until:8/31/2008</code></pre>
<p>
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.
</p>
<h4>Deletion</h4>
<p>
When a recurring task is deleted, you will be asked if you would also like to
delete all recurring task instances:
</p>
<pre><code>% 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</code></pre>
<h4>Recurrence Periods</h4>
<p>
In the above examples, the recurrence period was specified as "monthly" and
"weekly". Task supports several ways of specifying this:
</p>
<table>
<tr>
<th class="table_h">Period</th>
<th class="table_h">Meaning</th>
</tr>
<tr>
<td class="table_d">daily, day, 1d, 2d ...</td>
<td class="table_d">Every day, or a number of days</td>
</tr>
<tr>
<td class="table_d">weekly, 1w, 2w ...</td>
<td class="table_d">Every week, or a number of weeks</td>
</tr>
<tr>
<td class="table_d">biweekly, fortnight</td>
<td class="table_d">Every two weeks</td>
</tr>
<tr>
<td class="table_d">monthly, 1m, 2m ...</td>
<td class="table_d">Every month, or a number of months</td>
</tr>
<tr>
<td class="table_d">bimonthly</td>
<td class="table_d">Every two months</td>
</tr>
<tr>
<td class="table_d">quarterly, 1q, 2q ...</td>
<td class="table_d">Every three months, a quarter, or a number of quarters</td>
</tr>
<tr>
<td class="table_d">semiannual</td>
<td class="table_d">Every six months</td>
</tr>
<tr>
<td class="table_d">annual, yearly, 1y, 2y ...</td>
<td class="table_d">Every year, or a number of years</td>
</tr>
<tr>
<td class="table_d">biannual, biyearly, 2y</td>
<td class="table_d">Every two-years</td>
</tr>
</table>
</div>
<br /> <br />
<br /> <br />

23
html/setup.html
View file

@ -7,23 +7,26 @@
</head> </head>
<body> <body>
<div id="container">
<table>
<tr>
<td>
<div id="toolbar"> <div id="toolbar">
<a href="task.html">Home</a> <a href="task.html">Home</a>
<a href="setup.html">Setup</a> <a href="setup.html">Setup</a>
<a href="30second.html">30-second Tutorial</a>
<a href="simple.html">Simple</a> <a href="simple.html">Simple</a>
<a href="advanced.html">Advanced</a> <a href="advanced.html">Advanced</a>
<a href="shell.html">Shell</a> <a href="shell.html">Shell</a>
<a href="config.html">Configuration</a> <a href="config.html">Configuration</a>
<a href="color.html">Colors</a> <a href="color.html">Colors</a>
<a href="usage.html">Usage</a> <a href="usage.html">Usage</a>
<a href="recur.html">Recurrence</a>
<a href="date.html">Date Handling</a>
<a href="troubleshooting.html">Troubleshooting</a>
<a href="versions.html">Old Versions</a>
</div> </div>
<div id="container">
<table>
<tr>
<td>
<div id="content"> <div id="content">
<br /> <br />
<br /> <br />
@ -36,10 +39,10 @@
</p> </p>
<pre><code>% ls <pre><code>% ls
task-1.3.0.tar.gz task-1.4.0.tar.gz
% gunzip task-1.3.0.tar.gz % gunzip task-1.4.0.tar.gz
% tar xf task-1.3.0.tar % tar xf task-1.4.0.tar
% cd task-1.3.0 % cd task-1.4.0
% ./configure % ./configure
... ...
% make % make

15
html/shell.html
View file

@ -7,23 +7,26 @@
</head> </head>
<body> <body>
<div id="container">
<table>
<tr>
<td>
<div id="toolbar"> <div id="toolbar">
<a href="task.html">Home</a> <a href="task.html">Home</a>
<a href="setup.html">Setup</a> <a href="setup.html">Setup</a>
<a href="30second.html">30-second Tutorial</a>
<a href="simple.html">Simple</a> <a href="simple.html">Simple</a>
<a href="advanced.html">Advanced</a> <a href="advanced.html">Advanced</a>
<a href="shell.html">Shell</a> <a href="shell.html">Shell</a>
<a href="config.html">Configuration</a> <a href="config.html">Configuration</a>
<a href="color.html">Colors</a> <a href="color.html">Colors</a>
<a href="usage.html">Usage</a> <a href="usage.html">Usage</a>
<a href="recur.html">Recurrence</a>
<a href="date.html">Date Handling</a>
<a href="troubleshooting.html">Troubleshooting</a>
<a href="versions.html">Old Versions</a>
</div> </div>
<div id="container">
<table>
<tr>
<td>
<div id="content"> <div id="content">
<br /> <br />
<br /> <br />

15
html/simple.html
View file

@ -7,23 +7,26 @@
</head> </head>
<body> <body>
<div id="container">
<table>
<tr>
<td>
<div id="toolbar"> <div id="toolbar">
<a href="task.html">Home</a> <a href="task.html">Home</a>
<a href="setup.html">Setup</a> <a href="setup.html">Setup</a>
<a href="30second.html">30-second Tutorial</a>
<a href="simple.html">Simple</a> <a href="simple.html">Simple</a>
<a href="advanced.html">Advanced</a> <a href="advanced.html">Advanced</a>
<a href="shell.html">Shell</a> <a href="shell.html">Shell</a>
<a href="config.html">Configuration</a> <a href="config.html">Configuration</a>
<a href="color.html">Colors</a> <a href="color.html">Colors</a>
<a href="usage.html">Usage</a> <a href="usage.html">Usage</a>
<a href="recur.html">Recurrence</a>
<a href="date.html">Date Handling</a>
<a href="troubleshooting.html">Troubleshooting</a>
<a href="versions.html">Old Versions</a>
</div> </div>
<div id="container">
<table>
<tr>
<td>
<div id="content"> <div id="content">
<br /> <br />
<br /> <br />

44
html/task.html
View file

@ -7,37 +7,38 @@
</head> </head>
<body> <body>
<div id="container">
<table>
<tr>
<td>
<div id="toolbar"> <div id="toolbar">
<a href="task.html">Home</a> <a href="task.html">Home</a>
<a href="setup.html">Setup</a> <a href="setup.html">Setup</a>
<a href="30second.html">30-second Tutorial</a>
<a href="simple.html">Simple</a> <a href="simple.html">Simple</a>
<a href="advanced.html">Advanced</a> <a href="advanced.html">Advanced</a>
<a href="shell.html">Shell</a> <a href="shell.html">Shell</a>
<a href="config.html">Configuration</a> <a href="config.html">Configuration</a>
<a href="color.html">Colors</a> <a href="color.html">Colors</a>
<a href="usage.html">Usage</a> <a href="usage.html">Usage</a>
<a href="recur.html">Recurrence</a>
<a href="date.html">Date Handling</a>
<a href="troubleshooting.html">Troubleshooting</a>
<a href="versions.html">Old Versions</a>
</div> </div>
<div id="container">
<table>
<tr>
<td>
<div id="content"> <div id="content">
<br /> <br />
<br /> <br />
<br /> <br />
<h1 class="title">Task Home Page</h1> <h1 class="title">Task</h1>
<p> <p>
Here you will find information on how to acquire, build, configure, Task is an open source, command-line, TODO list manager.
use and become proficient with the task program.
</p> </p>
<p> <p>
Alternatively, watch the Here you will find information on how to acquire, build, configure,
<a href="http://www.youtube.com/watch?v=D2Kn4DMOVSw">task movie</a> use and become proficient with the task program.
which illustrates many of task's features.
</p> </p>
<ul> <ul>
@ -45,13 +46,28 @@
<li><a href="30second.html">30-second Tutorial</a> <li><a href="30second.html">30-second Tutorial</a>
<li><a href="simple.html">Simple Usage</a> <li><a href="simple.html">Simple Usage</a>
<li><a href="advanced.html">Advanced Usage</a> <li><a href="advanced.html">Advanced Usage</a>
<li><a href="recur.html">Recurring Tasks</a>
<li><a href="shell.html">Interacting with the Shell</a> <li><a href="shell.html">Interacting with the Shell</a>
<li><a href="config.html">Configuring Task</a> <li><a href="config.html">Configuring Task</a>
<li><a href="color.html">Color</a> <li><a href="color.html">Color</a>
<li><a href="usage.html">Task Command Usage</a> <li><a href="usage.html">Task Command Usage</a>
<li><a href="recur.html">Recurring Tasks</a>
<li><a href="date.html">Date Handling</a>
<li><a href="troubleshooting.html">Troubleshooting</a>
<li><a href="versions.html">Old Versions</a>
<li>Filters (coming soon)
</ul> </ul>
<p>
More documents are being written, and will be added here.
</p>
<p>
Alternatively, watch the
<a href="http://www.youtube.com/watch?v=D2Kn4DMOVSw">task movie</a>
which illustrates many of task's features.
</p>
<br /> <br />
<h2 class="title">Get the Latest Source Release <h2 class="title">Get the Latest Source Release
<a href="http://www.beckingham.net/task-1.4.0.tar.gz">task-1.4.0.tar.gz</a> <a href="http://www.beckingham.net/task-1.4.0.tar.gz">task-1.4.0.tar.gz</a>
@ -60,7 +76,7 @@
<div class="content"> <div class="content">
<h4>New in version 1.4.0 (7/10/2008)</h4> <h4>New in version 1.4.0 (7/10/2008)</h4>
<ul> <ul>
<li>Added new recurring tasks feature <li>Added new <a href="recur.html">recurring tasks</a> feature
<li>Added "task undelete" feature to restore a (very) recently deleted <li>Added "task undelete" feature to restore a (very) recently deleted
task task
<li>Added averages to the "task history" report <li>Added averages to the "task history" report

16
html/troubleshooting.html
View file

@ -8,10 +8,24 @@
<body> <body>
<div id="container"> <div id="container">
<table> <table>
<tr> <tr>
<td> <td>
<div id="toolbar">
<a href="task.html">Home</a>
<a href="setup.html">Setup</a>
<a href="30second.html">30-second Tutorial</a>
<a href="simple.html">Simple</a>
<a href="advanced.html">Advanced</a>
<a href="shell.html">Shell</a>
<a href="config.html">Configuration</a>
<a href="color.html">Colors</a>
<a href="usage.html">Usage</a>
<a href="recur.html">Recurrence</a>
<a href="date.html">Date Handling</a>
<a href="troubleshooting.html">Troubleshooting</a>
<a href="versions.html">Old Versions</a>
</div>
<div id="content"> <div id="content">
<br /> <br />

15
html/usage.html
View file

@ -7,23 +7,26 @@
</head> </head>
<body> <body>
<div id="container">
<table>
<tr>
<td>
<div id="toolbar"> <div id="toolbar">
<a href="task.html">Home</a> <a href="task.html">Home</a>
<a href="setup.html">Setup</a> <a href="setup.html">Setup</a>
<a href="30second.html">30-second Tutorial</a>
<a href="simple.html">Simple</a> <a href="simple.html">Simple</a>
<a href="advanced.html">Advanced</a> <a href="advanced.html">Advanced</a>
<a href="shell.html">Shell</a> <a href="shell.html">Shell</a>
<a href="config.html">Configuration</a> <a href="config.html">Configuration</a>
<a href="color.html">Colors</a> <a href="color.html">Colors</a>
<a href="usage.html">Usage</a> <a href="usage.html">Usage</a>
<a href="recur.html">Recurrence</a>
<a href="date.html">Date Handling</a>
<a href="troubleshooting.html">Troubleshooting</a>
<a href="versions.html">Old Versions</a>
</div> </div>
<div id="container">
<table>
<tr>
<td>
<div id="content"> <div id="content">
<br /> <br />
<br /> <br />

16
html/versions.html
View file

@ -8,10 +8,24 @@
<body> <body>
<div id="container"> <div id="container">
<table> <table>
<tr> <tr>
<td> <td>
<div id="toolbar">
<a href="task.html">Home</a>
<a href="setup.html">Setup</a>
<a href="30second.html">30-second Tutorial</a>
<a href="simple.html">Simple</a>
<a href="advanced.html">Advanced</a>
<a href="shell.html">Shell</a>
<a href="config.html">Configuration</a>
<a href="color.html">Colors</a>
<a href="usage.html">Usage</a>
<a href="recur.html">Recurrence</a>
<a href="date.html">Date Handling</a>
<a href="troubleshooting.html">Troubleshooting</a>
<a href="versions.html">Old Versions</a>
</div>
<div id="content"> <div id="content">
<br /> <br />