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

Browse source 
- Removed unnecessary usage.html links from other pages.
- Added new sequence.html page to describe how to use ID sequences.
This commit is contained in:
Paul Beckingham 2009-05-06 23:58:21 -04:00
parent 7fea1f6a63
commit 708995093b
18 changed files with 159 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

154
html/sequence.html Normal file
View file

@ -0,0 +1,154 @@
<!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 Usage</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="recur.html">Recurrence</a>
<a href="date.html">Date Handling</a>
<a href="faq.html">FAQ</a>
<a href="versions.html">Old Versions</a>
<a href="links.html">Task on the Web</a>
</div>
<div id="content">
<br />
<br />
<br />
<h1 class="title">ID Sequences</h1>
<div class="content">
<p>
Some task commands require an ID to be specified. For example:
</p>
<pre><code>% task 3 done</code></pre>
<p>
This marks a single task as done. But if you wanted to mark
several tasks as done, you could use:
</p>
<pre><code>% task 3,4,5 done</code></pre>
<p>
Which would mark tasks 3, 4 and 5 as all done. In this example,
the three IDs are consecutive, which means you could also have
entered:
</p>
<pre><code>% task 3-5 done</code></pre>
<p>
Or in a more complex example:
</p>
<pre><code>% task 1,3-5,12 23-25 done</code></pre>
<p>
This would mark tasks 1, 3, 4, 5, 12, 23, 24 and 25 as done.
Note that this example uses two sequences, separated by a space.
</p>
<p>
You must be careful though. Task tries very carefully to do
the right thing when it interprets the command line, but must
still impose some rules so that it can unambiguously read the
command. If you use one or more sequences, then they must
appear on the command line adjacent to each other. If they
are separated by something else, then task assumes the second
and subsequent set is not a sequence. Here is an example
of this:
</p>
<pre><code>% task 3 Order part number 4-123</code></pre>
<p>
Clearly the 4-123 is a part number, and not a sequence.
Task is being asked to modify the description of task 3 to be
"Order part number 4-123". Note that the ID is separated
from the part number by something other than a sequence.
Here is a bad example that task will misinterpret:
</p>
<pre><code>% task 3 4-123 is back-ordered, try again next week</code></pre>
<p>
The intent here is that task 3 have its description modified to be
"40123 is back-ordered, try again next week", but will be
misinterpreted as tasks 3, 4, 5, 6 ... 123 will all be modified
to have the description "is back-ordered, try again next week".
The solution is to quote the whole description:
</p>
<pre><code>% task 3 "4-123 is back-ordered, try again next week"</code></pre>
</div>
<br />
<br />
<div class="content">
<p>
Copyright 2006-2009, 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>