Packaging

- Added README.1.5.0 detailing the new custom report configuration
  variables that must be added.
- Added README.1.5.0 to the distribution.
- Added new custom.html documentation.
- Added warning to task.html about the README.1.5.0 changes.
This commit is contained in:
Paul Beckingham 2009-02-15 23:26:15 -05:00
parent cc7c1819ce
commit 0219ed4fe3
4 changed files with 184 additions and 1 deletions

View file

@ -1,3 +1,3 @@
SUBDIRS = src SUBDIRS = src
EXTRA_DIST = DEVELOPERS EXTRA_DIST = DEVELOPERS README.1.5.0

15
README.1.5.0 Normal file
View file

@ -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+

152
html/custom.html Normal file
View file

@ -0,0 +1,152 @@
<!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>Custom Reports</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>
<a href="links.html">Task on the Web</a>
</div>
<div id="content">
<br />
<br />
<br />
<h2 class="title">Custom Reports</h2>
<div class="content">
<p>
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.
</p>
<p>
More importantly, you can define your own. Here are the
two necessary items in the .taskrc file that define a new
report:
</p>
<code><pre>report.mine.columns=id,project,priority,description
report.mine.sort=priority-,project+</pre></code>
<p>
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:
</p>
<code><pre>% task mine</pre></code>
<p>
A filter can also be specified like this:
</p>
<code><pre>report.mine.filter=priority:H +bug</pre></code>
<p>
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.
</p>
<p>
Here is a list of all the possible columns that may be included
in a report:
</p>
<ul>
<li>id
<li>uuid
<li>project
<li>priority
<li>entry
<li>start
<li>due
<li>age
<li>active
<li>tags
<li>description
</ul>
<p>
Custom reports will show up in the task command line usage.
</p>
</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>

View file

@ -57,6 +57,7 @@
<li><a href="versions.html">Old Versions</a> <li><a href="versions.html">Old Versions</a>
<li><a href="filter.html">Filters</a> <li><a href="filter.html">Filters</a>
<li><a href="shadow.html">Shadow Files</a> <li><a href="shadow.html">Shadow Files</a>
<li><a href="custom.html">Custom Reports</a>
</ul> </ul>
<p> <p>
@ -113,6 +114,21 @@
in the configuration file can be renamed. in the configuration file can be renamed.
</ul> </ul>
<p>
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.
</p>
<pre><code>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+</code></pre>
<p> <p>
(Find out <a href="versions.html">what was new in prior versions</a>) (Find out <a href="versions.html">what was new in prior versions</a>)
</p> </p>