manual/html/taskreport.html in taskjuggler-3.0.0 vs manual/html/taskreport.html in taskjuggler-3.1.0
- old
+ new
@@ -1,19 +1,19 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<!-- This file has been generated by tj3man v3.0.0 -->
+<!-- This file has been generated by tj3man v3.1.0 -->
<html lang="en" xml:lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>taskreport</title>
<meta content="text/html; charset=utf-8" http-equiv="Content-Type"/>
<meta content="The TaskJuggler Manual" name="description"/>
<meta content="taskjuggler, project, management" name="keywords"/>
</head>
<link href="css/tjmanual.css" rel="stylesheet" type="text/css"></link>
<body>
<div align="center">
- <h3 align="center">The TaskJuggler III User Manual</h3>
+ <h3 align="center">The TaskJuggler User Manual</h3>
<em align="center">Project Management beyond Gantt Chart Drawing</em>
</div>
<br/>
<hr/>
<table style="width:90%; margin-left:5%; margin-right:5%"><tr>
@@ -36,34 +36,373 @@
</colgroup>
<tr align="left">
<td class="tag">Purpose</td>
<td class="descr" colspan="2"><div>
<p>The report lists tasks and their respective values in a table. To reduce the list of included tasks, you can use the <a href="hidetask.html">hidetask</a>, <a href="rolluptask.html">rolluptask</a> or <a href="taskroot.html">taskroot</a> attributes. The order of the task can be controlled with <a href="sorttasks.html">sorttasks</a>. If the first sorting criteria is tree sorting, the parent tasks will always be included to form the tree. Tree sorting is the default. You need to change it if you do not want certain parent tasks to be included in the report.</p>
- <p>The resources that are allocated to each task can be listed as well. Use the <a href="hideresource.html">hideresource</a> attribute for this. See <a href="report.html">report</a> for a complete list of attributes and the full syntax for this keyword.</p>
+ <p>The resources that are allocated to each task can be listed as well. Use the <a href="hideresource.html">hideresource</a> attribute for this.</p>
</div></td>
</tr>
<tr align="left">
<td class="tag">Syntax</td>
- <td class="descr" colspan="2"><code>taskreport</code></td>
+ <td class="descr" colspan="2"><code>taskreport [<id>] <name> [{ <attributes> }]</code></td>
</tr>
<tr align="left">
- <td class="tag">Arguments</td>
- <td class="descr" colspan="2">none</td>
+ <td class="tag" rowspan="2">Arguments</td>
+ <td class="descr">id [<a href="The_TaskJuggler_Syntax.html#ID">ID</a>]</td>
+ <td class="descr"><div>An optional ID. If you ever want to reference this property, you must specify your own unique ID. If no ID is specified one will be automatically generated. These IDs may become visible in reports, but may change at any time. You may never rely on automatically generated IDs.</div></td>
</tr>
<tr align="left">
+ <td class="descr">name [<a href="The_TaskJuggler_Syntax.html#STRING">STRING</a>]</td>
+ <td class="descr"><div>
+ <p>The name of the report. This will be the base name for generated output files. The suffix will depend on the specified <a href="formats.html">formats</a>. It will also be used in navigation bars.</p>
+ <p>By default, report definitions do not generate any files. With more complex projects, most report definitions will be used to describe elements of composed reports. If you want to generate a file from this report, you must specify the list of <a href="formats.html">formats</a> that you want to generate. The report name will then be used as a base name to create the file. The suffix will be appended based on the generated format.</p>
+ <p>Reports have a local name space. All IDs and file names must be unique within the reports that belong to the same enclosing report. To reference a report for inclusion into another report, you need to specify the full report ID. This is composed of the report ID, prefixed by a dot-separated list of all parent report IDs.</p>
+ </div></td>
+ </tr>
+ <tr align="left">
<td class="tag">Context</td>
- <td class="descr" colspan="2"><a href="Getting_Started.html#Structure_of_a_TJP_File">Global scope</a></td>
+ <td class="descr" colspan="2">
+ <a href="accountreport.html">accountreport</a>, <a href="properties.html">properties</a>, <a href="resourcereport.html">resourcereport</a>, <a href="taskreport.html">taskreport</a>, <a href="textreport.html">textreport</a>
+ </td>
</tr>
</table></p>
+ <p><table align="center" class="table">
+ <colgroup>
+ <col width="16%"></col>
+ <col width="24%"></col>
+ <col width="20%"></col>
+ <col width="20%"></col>
+ <col width="20%"></col>
+ </colgroup>
+ <tr align="left">
+ <td class="tag" rowspan="47">Attributes</td>
+ <td class="tag">Name</td>
+ <td class="tag">Scen. spec.</td>
+ <td class="tag">Inh. fm. Global</td>
+ <td class="tag">Inh. fm. Parent</td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="accountreport.html">accountreport</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="accountroot.html">accountroot</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="balance.html">balance</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="caption.html">caption</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr">x</td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="center.html">center</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr">x</td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="columns.html">columns</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr">x</td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="currencyformat.html">currencyformat</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="end.report.html">end (report)</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr">x</td>
+ <td align="center" class="descr">x</td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="epilog.html">epilog</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr">x</td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="flags.report.html">flags (report)</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr">x</td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="footer.html">footer</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr">x</td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="formats.html">formats</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr">x</td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="header.html">header</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr">x</td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="headline.html">headline</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr">x</td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="hideaccount.html">hideaccount</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="hidejournalentry.html">hidejournalentry</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="hideresource.html">hideresource</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="hidetask.html">hidetask</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="journalattributes.html">journalattributes</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="journalmode.html">journalmode</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="left.html">left</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr">x</td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="loadunit.html">loadunit</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="numberformat.html">numberformat</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="opennodes.html">opennodes</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="period.report.html">period (report)</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="prolog.html">prolog</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr">x</td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="purge.html">purge</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="resourcereport.html">resourcereport</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="resourceroot.html">resourceroot</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="right.html">right</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr">x</td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="rollupaccount.html">rollupaccount</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="rollupresource.html">rollupresource</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="rolluptask.html">rolluptask</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="scenarios.html">scenarios</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr">x</td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="selfcontained.html">selfcontained</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr">x</td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="sortaccounts.html">sortaccounts</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="sortjournalentries.html">sortjournalentries</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="sortresources.html">sortresources</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="sorttasks.html">sorttasks</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="start.report.html">start (report)</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr">x</td>
+ <td align="center" class="descr">x</td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="taskreport.html">taskreport</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="taskroot.html">taskroot</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="textreport.html">textreport</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="timeformat.html">timeformat</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="timezone.report.html">timezone (report)</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr">x</td>
+ <td align="center" class="descr">x</td>
+ </tr>
+ <tr align="left">
+ <td align="left" class="descr"><a href="title.html">title</a></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr"></td>
+ <td align="center" class="descr">x</td>
+ </tr>
+ </table></p>
+ <div class="codeframe"><pre class="code">project "Simple Project" 2005-06-06 - 2005-06-26 {
+ timezone "America/Denver"
+}
+
+copyright "Bucks Beavis Inc."
+
+resource tux "Tux"
+
+task items "Project breakdown" {
+ start 2005-06-06
+
+ task plan "Plan work" {
+ length 3d
+ }
+
+ task implementation "Implement work" {
+ effort 5d
+ allocate tux
+ depends !plan
+ }
+
+ task acceptance "Customer acceptance" {
+ duration 5d
+ depends !implementation
+ }
+}
+
+taskreport breakdown "ProjectBreakdown.html" {
+ formats html
+ caption "This is the project breakdown"
+ headline "Project Breakdown"
+ columns name, start, end, daily
+ # Don't hide any resource, meaning show them all.
+ hideresource 0
+}
+</pre></div>
</div>
<br/>
<hr/>
<table style="width:90%; margin-left:5%; margin-right:5%"><tr>
<td style="text-align:left; width:35%;"><< <a href="taskprefix.html">taskprefix</a> <<</td>
<td style="text-align:center; width:30%;"><a href="toc.html">Table Of Contents</a></td>
<td style="text-align:right; width:35%;">>> <a href="taskroot.html">taskroot</a> >></td>
</tr></table>
<hr/>
<br/>
- <div align="center" style="font-size:10px;">Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011 by Chris Schlaeger <chris@linux.com>.<a href="http://www.taskjuggler.org">TaskJuggler</a> is a trademark of Chris Schlaeger.</div>
+ <div align="center" style="font-size:10px;">Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012 by Chris Schlaeger <chris@linux.com>.<a href="http://www.taskjuggler.org">TaskJuggler</a> is a trademark of Chris Schlaeger.</div>
</body>
</html>