mirror of
https://github.com/GothenburgBitFactory/taskwarrior.git
synced 2025-06-26 10:54:26 +02:00
- Documentation reorganization - not yet complete
This commit is contained in:
Paul Beckingham
parent
9fcd5b1801
commit
fe03f91744
11 changed files with 1859 additions and 1061 deletions
352
html/simple.html
Normal file
352
html/simple.html
Normal file
|
|
@ -0,0 +1,352 @@
|
|||
<!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="toolbar">
|
||||
<a href="task.html">Home</a>
|
||||
<a href="setup.html">Setup</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>
|
||||
</div>
|
||||
|
||||
<div id="container">
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
<div id="content">
|
||||
<br />
|
||||
<br />
|
||||
<br />
|
||||
<h2 class="title"><a name="simple">Simple Usage</a></h2>
|
||||
<div class="content">
|
||||
<p>
|
||||
Let us begin by adding some tasks:
|
||||
</p>
|
||||
|
||||
<pre><code>% task add Book plane ticket
|
||||
% task add Rent a tux
|
||||
% task add Reserve a rental car
|
||||
% task add Reserve a hotel room</code></pre>
|
||||
|
||||
<p>
|
||||
That's it. You'll notice immediately that task has a very
|
||||
minimalist interface. Let us take a look at those tasks:
|
||||
</p>
|
||||
|
||||
<pre><code>% task ls
|
||||
|
||||
ID Project Pri Description
|
||||
1 Book plane ticket
|
||||
2 Rent a tux
|
||||
3 Reserve a rental car
|
||||
4 Send John a birthday card</code></pre>
|
||||
|
||||
<p>
|
||||
The 'ls' command provides the most minimal list of tasks. Each
|
||||
task has been given an id number, and you can see that there are no
|
||||
projects or priorities assigned. Wait a minute - I own a tux, I
|
||||
don't need to rent one. Let us delete task 2:
|
||||
</p>
|
||||
|
||||
<pre><code>% task 2 delete
|
||||
Permanently delete task? (y/n) y</code></pre>
|
||||
|
||||
<p>
|
||||
Task wants you to confirm deletions. To remove the confirmation,
|
||||
edit your .taskrc file and change the line:
|
||||
</p>
|
||||
|
||||
<pre><code>confirmation=yes</code></pre>
|
||||
|
||||
<p>
|
||||
to have a value of "no".
|
||||
</p>
|
||||
|
||||
<p>
|
||||
While the use of projects and priorities are not essential to
|
||||
benefitting from task, they can be very useful when the list of
|
||||
tasks grows large. Let's assign a project to these tasks:
|
||||
</p>
|
||||
|
||||
<pre><code>% task 1 project:Wedding
|
||||
% task 3 project:Wedding
|
||||
% task 4 project:Family
|
||||
% task ls
|
||||
|
||||
ID Project Pri Description
|
||||
3 Family Send John a birthday card
|
||||
2 Wedding Reserve a rental car
|
||||
1 Wedding Book plane ticket</code></pre>
|
||||
|
||||
<p>
|
||||
Notice that the id numbers have changed. When tasks get deleted,
|
||||
or have their attributes changed (project, for example), the ids are
|
||||
prone to change. But the id numbers will remain valid until the
|
||||
next 'ls' command is run. You should only use the ids from the most
|
||||
recent 'ls' command. The ids change, because task is always trying
|
||||
to use small numbers so that it is easy for you to enter them
|
||||
correctly. Now that projects are assigned, we can look at just the
|
||||
Wedding project tasks:
|
||||
</p>
|
||||
|
||||
<p>
|
||||
Subprojects are supported. If you have a project "Wedding", you can
|
||||
specify that a task is a subproject "Transport" of "Wedding" by
|
||||
assigning the project "Wedding.Transport". Let's do this:
|
||||
</p>
|
||||
|
||||
<pre><code>% task 2 project:Wedding.Transport
|
||||
% task ls
|
||||
|
||||
ID Project Pri Description
|
||||
3 Family Send John a birthday card
|
||||
2 Wedding.Transport Reserve a rental car
|
||||
1 Wedding Book plane ticket</code></pre>
|
||||
|
||||
<p>
|
||||
Task matches the leftmost part of the project when searching, so
|
||||
projects may be abbreviated:
|
||||
</p>
|
||||
|
||||
<pre><code>% task ls project:Wedding.Tra
|
||||
|
||||
ID Project Pri Description
|
||||
2 Wedding.Transport Reserve a rental car</code></pre>
|
||||
|
||||
<p>
|
||||
This way of matching projects can be used to see all tasks under
|
||||
the "Wedding" project and all subprojects:
|
||||
</p>
|
||||
|
||||
<pre><code>% task ls project:Wedding
|
||||
|
||||
ID Project Pri Description
|
||||
2 Wedding.Transport Reserve a rental car
|
||||
1 Wedding Book plane ticket</code></pre>
|
||||
|
||||
<p>
|
||||
Let's reassign 2 back to the "Wedding" project:
|
||||
</p>
|
||||
|
||||
<pre><code>% task 2 project:Wedding</code></pre>
|
||||
|
||||
<p>
|
||||
Now that projects are assigned, we can look at just the
|
||||
Wedding project tasks:
|
||||
</p>
|
||||
|
||||
<pre><code>% task ls project:Wedding
|
||||
|
||||
ID Project Pri Description
|
||||
1 Wedding Book plane ticket
|
||||
2 Wedding Reserve a rental car</code></pre>
|
||||
|
||||
<p>
|
||||
Any command arguments after the 'ls' are used for filtering the
|
||||
output. We could also have requested:
|
||||
</p>
|
||||
|
||||
<pre><code>% task ls ticket plane
|
||||
|
||||
ID Project Pri Description
|
||||
1 Wedding Book plane ticket</code></pre>
|
||||
|
||||
<p>
|
||||
Now let's prioritize. Priorities can be H, M or L (High, Medium,
|
||||
Low).
|
||||
</p>
|
||||
|
||||
<pre><code>% task ls
|
||||
|
||||
ID Project Pri Description
|
||||
3 Family Send John a birthday card
|
||||
2 Wedding Reserve a rental car
|
||||
1 Wedding Book plane ticket
|
||||
|
||||
% task 1 priority:H
|
||||
% task 2 prior:M
|
||||
% task 3 pr:H
|
||||
Ambiguous attribute 'pr' - could be either of project, priority
|
||||
% task 3 pri:H
|
||||
% task ls
|
||||
|
||||
ID Project Pri Description
|
||||
3 Family H Send John a birthday card
|
||||
1 Wedding H Book plane ticket
|
||||
2 Wedding M Reserve a rental car</code></pre>
|
||||
|
||||
<p>
|
||||
Notice that task supports the abbreviation of words such as
|
||||
priority, project. Priority can be abbreviated to pri, but not pr,
|
||||
because it is ambiguous. Now that tasks have been prioritized, you
|
||||
can see that the tasks are being sorted by priority, with the
|
||||
highest priority tasks at the top.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
These attributes can all be provided when the task is added, instead
|
||||
of applying them afterwards, as shown. The following command shows
|
||||
how to set all the attributes at once:
|
||||
</p>
|
||||
|
||||
<pre><code>% task add project:Wedding priority:H Book plane ticket<code></pre>
|
||||
|
||||
<p>
|
||||
The 'ls' command provides the least information for each task. The
|
||||
'list' command provides more:
|
||||
</p>
|
||||
|
||||
<pre><code>% task list
|
||||
|
||||
ID Project Pri Due Active Age Description
|
||||
3 Family H 4 mins Send John a birthday card
|
||||
1 Wedding H 5 mins Book plane ticket
|
||||
2 Wedding M 5 mins Reserve a rental car</code></pre>
|
||||
|
||||
<p>
|
||||
Notice that a task can have a due date, and can be active. The
|
||||
task lists are sorted by due date, then priority. Let's add due
|
||||
dates:
|
||||
</p>
|
||||
|
||||
<pre><code>% task 3 due:6/25/2008
|
||||
% task 1 due:7/31/2008
|
||||
% task list
|
||||
|
||||
ID Project Pri Due Active Age Description
|
||||
3 Family H 6/25/2008 6 mins Send John a birthday card
|
||||
1 Wedding H 7/31/2008 7 mins Book plane ticket
|
||||
2 Wedding M 7 mins Reserve a rental car</code></pre>
|
||||
|
||||
<p>
|
||||
If today's date is 6/23/2008, then task 3 is due in 2 days. It will
|
||||
be colored yellow if your terminal supports color. To change this
|
||||
color, edit your .taskrc file, and change the line to one of these
|
||||
alternatives:
|
||||
</p>
|
||||
|
||||
<pre><code>color.due=red
|
||||
color.due=on_blue
|
||||
color.due=red on_blue
|
||||
color.due=bold_red on_blue</code></pre>
|
||||
|
||||
<p>
|
||||
Where color is one of the following:
|
||||
</p>
|
||||
|
||||
<pre><code>black
|
||||
blue
|
||||
red
|
||||
green
|
||||
cyan
|
||||
magenta
|
||||
yellow
|
||||
white</code></pre>
|
||||
|
||||
<p>
|
||||
All colors are specified in this way. Take a look in .taskrc for
|
||||
all the other color rules that you control.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
Tagging tasks is a good way to group them, aside from specifying a
|
||||
project. To add a tag to a task:
|
||||
</p>
|
||||
|
||||
<pre><code>% task <id> +tag<code></pre>
|
||||
|
||||
<p>
|
||||
The plus sign indicates that this is a tag. Any number of tags may
|
||||
be applied to a task, and then used for searching. Tags are just
|
||||
single words that are labels.
|
||||
</p>
|
||||
|
||||
<pre><code>% task list
|
||||
|
||||
ID Project Pri Due Active Age Description
|
||||
3 Family H 6/25/2008 8 mins Send John a birthday card
|
||||
1 Wedding H 7/31/2008 9 mins Book plane ticket
|
||||
2 Wedding M 9 mins Reserve a rental car
|
||||
|
||||
% task 1 +phone
|
||||
% task 2 +phone
|
||||
% task 3 +shopping
|
||||
% task 3 +john
|
||||
|
||||
% task list +phone
|
||||
|
||||
ID Project Pri Due Active Age Description
|
||||
1 Wedding H 7/31/2008 9 mins Book plane ticket
|
||||
2 Wedding M 9 mins Reserve a rental car</code></pre>
|
||||
|
||||
<p>
|
||||
To remove a tag from a task, use the minus sign:
|
||||
</p>
|
||||
|
||||
<pre><code>% task 3 -john</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>
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue