taskjuggler 3.0.0 → 3.1.0

data/manual/Reporting_Bugs

@@ -1,4 +1,4 @@
-=== Reporting Bugs and Sending Feedback ===
+=== Reporting Bugs and Feature Requests ===
 
 All official releases of TaskJuggler are meant to be stable releases
 unless explicitly noted differently. But our test suite is still very
@@ -10,7 +10,7 @@ find a bug, please follow this procedure:
 feature.
 
 * Check the [http://www.taskjuggler.org TaskJuggler web page] and the
-[http://www.taskjuggler.org/forum.php discussion groups]. You should
+[http://www.taskjuggler.org/contact.html discussion groups]. You should
 also search the [https://github.com/taskjuggler/TaskJuggler/issues
 issue tracker] if the problem has been reported before. If so, it's
 quite likely that there is already a workaround or fix available. 
@@ -25,11 +25,21 @@ following command to store the messages into a file.
 
  tj3 yourproject.tjp 2> error_message
 
-* Enter a detailed description of the problem into the issue tracker
-and don't forget to attach your test project.
+* Enter a detailed description of the problem into the
+[https://github.com/taskjuggler/TaskJuggler/issues?state=open issue
+tracker] and don't forget to attach your test project and the error
+log. You can paste that into the input field.
 
-* Not attaching a test case will severely limit our abilities to help
-you. Please make sure you provide meaningful descriptions and a small
-but complete test project.  Not providing this information usually
-triggers requests or leads to bug reports being ignored.
+* Not attaching a test project will severely limit our abilities to help
+you. In 95% of the reported bugs we need a test case to find and fix
+the problem. Please make sure you provide meaningful descriptions and a small
+but complete test project.  Not providing this information with the
+first bug report means we have to follow up with you or the bug report
+is being ignored.
 
+* Please open a new issue for each bug. Don't include multiple
+problems in one bug report. This usually leads to one bug being fixed
+and the rest of the problems to be ignored.
+
+* If you have a feature request, please open a new issue and set the
+"Feature" label.

data/manual/Rich_Text_Attributes

@@ -67,6 +67,19 @@ start at the start of the line.
 The monospace format is not part of the original MediaWiki markup, but
 we found it useful to have for this manual.
 
+Text can be colored when enclosed in ''''fcol'''' tags.
+
+ This is a <fcol:green>green</fcol> word.
+
+The following colors are supported: black, maroon, green, olive, navy,
+purple, teal, silver, gray, red, lime, yellow, blue, fuchsia, aqua and
+white.
+
+Alternatively, a hash sign followed by a 3 or 6 digit hexadecimal
+number can be used as well. The hexadecimal number specifies the
+values for the red, green and blue component of the color (i. e.,
+#FFF for white).
+
 Links to external documents are possible as well. In the first form,
 the URL will appear in the readable text as well. In the second form,
 the text after the URL will be visible but the link will be available
@@ -145,7 +158,7 @@ The navigator generator inserts the referenced navigator.
 
 Paramters:
 
-* ''''id'''' : ID of a defined [[report]]
+* ''''id'''' : ID of a defined report
 
 The report generator inserts the referenced report as a new block
 of this text. The referenced report inherits some context such as the
@@ -155,10 +168,10 @@ report period and the property set from the referencing report.
 
 Paramters:
 
-* ''''id'''' : ID of a defined [[report]]
+* ''''id'''' : ID of a defined report
 
 * ''''attributes'''': A set of attributes that override the original
-attributes of the referenced report. All [[report|report attributes]]
+attributes of the referenced report. All report attributes
 are supported. Since the value of attributes already must be enclosed
 by single or double quotes, all single or double quotes contained in
 the string must be escaped with backslashes. This feature enables

data/manual/Software

@@ -25,9 +25,9 @@ project file is called ''''tutorial.tjp'''' you can process it by typing
 You will see an output similar to the one below.
 
   > tj3 tutorial.tjp
-  TaskJuggler III v0.0.6 - A Project Management Software
+  TaskJuggler v3.0.0 - A Project Management Software
   
-  Copyright (c) 2006, 2007, 2008, 2009, 2010 by Chris Schlaeger <cs(a)kde.org>
+  Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011 by Chris Schlaeger
   
   This program is free software; you can redistribute it and/or modify it under
   the terms of version 2 of the GNU General Public License as published by the

data/manual/TaskJuggler_2x_Migration

@@ -49,9 +49,9 @@ been deprecated. Function names need to be all lower case now. Some
 functions have been removed as all attributes can now be accessed by
 scenario.attribute_id notation.
 
-* The format for [[report|reports]] has been changed considerably.
+* The format for report has been changed considerably.
 The old format was not very flexible and had some design flaws.
-TaskJuggler III now supports report nesting and composition. A report
+TaskJuggler 3.x now supports report nesting and composition. A report
 definition can be used to generated multiple output [[formats]]. The
 name of a report must now be specified without the file name
 extension. It will be automatically added depending on the output

data/manual/The_TaskJuggler_Syntax

@@ -33,6 +33,16 @@ options separated by a vertical bar.
 
  keyword ( foo | bar | foobar )
 
+Some keywords take one or more arguments. These are known as list
+attributes. The arguments are comma separated. The tree dots in the
+syntax description mean that the sequence before the dots can be
+repeated if needed. Inheritable list attributes will append the new
+list values to the inherited list. Use can use the [[purge]]
+attribute to clear the list before assigning new values to the list
+attribute.
+
+ keyword arg1 [, arg2 ... ]
+
 Variable arguments are further described in the ''Arguments'' section of
 the keyword syntax table. The name is listed immediately followed by
 the type of the variable argument. The supported types and their

data/manual/Tutorial

@@ -7,9 +7,9 @@ will walk you step by step through your first project. You create the
 project plan for a made-up accounting software project. This project
 demonstrates some of the commonly used features of TaskJuggler. The
 complete example can be downloaded
-[http://www.taskjuggler.org/tj3/examples/tutorial.tjp here]. The
+[http://www.taskjuggler.org/tj3/examples/Tutorial/tutorial.tjp here]. The
 resulting reports can be found
-[http://www.taskjuggler.org/tj3/examples/Overview.html
+[http://www.taskjuggler.org/tj3/examples/Tutorial/Overview.html
 here].
 
 === Starting the project ===

data/manual/html/Day_To_Day_Juggling.html

@@ -1,6 +1,6 @@
 <?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>Day_To_Day_Juggling</title>
@@ -9,7 +9,7 @@
  <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/>
@@ -115,15 +115,19 @@
     <p class="manual">We also would like to point out that introducing status reporting and time sheets is usually a big change for every staff. Don't underestimate the psychological impact and the training requirements. We also recommend to test the described process with a small group of employees first to get familiar with the process and to adapt it to your needs. Don't rush a deployment! You usually only have one chance to roll-out such a new process.</p>
     <h3 class="manual" id="The_reporting_and_tracking_cycle">7.5.1 The reporting and tracking cycle</h3>
     <p class="manual">In this description, we assume that you are using a weekly reporting cycle. TaskJuggler does support arbitrary cycles, but we highly recommend the described weekly cycle.</p>
-    <ol><li>
-      <b>Time sheets</b>: Every project contributor needs to fill out a <a href="timesheet.html">time sheet</a> once a week. To simplify this task as much as possible, a template will be send out by email. The template already lists all tasks that were planned for this week to work on with the respective effort values and end dates. It also provides sections for textual status reports. The contributor needs to review and complete the time sheet and has to send it back via email. TaskJuggler validates the submission and returns an email with either an error message or a nicely formatted version of the time sheet.</li></ol>
-    <ol><li>All time sheets must be submitted by a certain deadline, e. g. midnight on Sunday. TaskJuggler will then compile a summary report and sent it out to a list of interested parties. It will also detect missing time sheets and will send out a reminder to those contributors that have not submitted their report.</li></ol>
-    <ol><li>On Monday the project managers need to review the time sheets and update the plan accordingly. TaskJuggler can compile a list changes compared to the plan. This makes it easy to update the plan according to the actual progress that was made. The closer the actuals match the plan the less work this is. The project managers now generate bookings for the last week and add them to the database with previous bookings. Doing so, will prevent changes to the plan to affect the past. Only the future will be modified.</li></ol>
-    <ol><li>Once the plan has been updated, managers will receive their status sheet templates per email. Each manager will get the information for the tasks that they are <a href="responsible.html">responsible</a> for. To consolidate the information for the next manager in the reporting chain they can moderate the reports in three ways. Consolidated manager reports are called dashboard reports.</li></ol>
-    <ol><ol><li>A status report for a task can be removed from the dashboard.</li></ol></ol>
-    <ol><ol><li>A status report for a task can be corrected or updated.</li></ol></ol>
-    <ol><ol><li>All reports for sub tasks of a task can be summarized by creating a new status for that task. This will remove all reports for sub tasks of that particular tasks from the dashboard.</li></ol></ol>
-    <ol><li>Managers than need to send back the edited status report via email. Like with time sheets, TaskJuggler will check them and return either an error message or a plain text version of the dashboard report of the manager.</li></ol>
+    <ol>
+     <li>
+      <b>Time sheets</b>: Every project contributor needs to fill out a <a href="timesheet.html">time sheet</a> once a week. To simplify this task as much as possible, a template will be send out by email. The template already lists all tasks that were planned for this week to work on with the respective effort values and end dates. It also provides sections for textual status reports. The contributor needs to review and complete the time sheet and has to send it back via email. TaskJuggler validates the submission and returns an email with either an error message or a nicely formatted version of the time sheet.</li>
+     <li>All time sheets must be submitted by a certain deadline, e. g. midnight on Sunday. TaskJuggler will then compile a summary report and sent it out to a list of interested parties. It will also detect missing time sheets and will send out a reminder to those contributors that have not submitted their report.</li>
+     <li>On Monday the project managers need to review the time sheets and update the plan accordingly. TaskJuggler can compile a list changes compared to the plan. This makes it easy to update the plan according to the actual progress that was made. The closer the actuals match the plan the less work this is. The project managers now generate bookings for the last week and add them to the database with previous bookings. Doing so, will prevent changes to the plan to affect the past. Only the future will be modified.</li>
+     <li>Once the plan has been updated, managers will receive their status sheet templates per email. Each manager will get the information for the tasks that they are <a href="responsible.html">responsible</a> for. To consolidate the information for the next manager in the reporting chain they can moderate the reports in three ways. Consolidated manager reports are called dashboard reports.</li>
+     <ol>
+      <li>A status report for a task can be removed from the dashboard.</li>
+      <li>A status report for a task can be corrected or updated.</li>
+      <li>All reports for sub tasks of a task can be summarized by creating a new status for that task. This will remove all reports for sub tasks of that particular tasks from the dashboard.</li>
+     </ol>
+     <li>Managers than need to send back the edited status report via email. Like with time sheets, TaskJuggler will check them and return either an error message or a plain text version of the dashboard report of the manager.</li>
+    </ol>
     <p class="manual">In addition to the plain text versions of the time sheet summaries and the dashboards, TaskJuggler provides support for publishing them as HTML pages from a web server.</p>
     <h2 class="manual" id="Implementing_the_status_tracking_system">7.6 Implementing the status tracking system</h2>
     <h3 class="manual" id="Prerequesites">7.6.1 Prerequesites</h3>
@@ -354,6 +358,6 @@ include</a> this file at the end of your project header section.</p>
    </tr></table>
   <hr/>
   <br/>
-  <div align="center" style="font-size:10px;">Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011 by Chris Schlaeger &lt;chris@linux.com&gt;.<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 &lt;chris@linux.com&gt;.<a href="http://www.taskjuggler.org">TaskJuggler</a> is a trademark of Chris Schlaeger.</div>
  </body>
 </html>

data/manual/html/Getting_Started.html

@@ -1,6 +1,6 @@
 <?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>Getting_Started</title>
@@ -9,7 +9,7 @@
  <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/>
@@ -25,7 +25,7 @@
     <h1 class="manual" id="Getting_Started">3 Getting Started</h1>
     <h2 class="manual" id="Basics">3.1 Basics</h2>
     <p class="manual">TaskJuggler uses one or more text files to describe a project. The main project should be placed in a file with the .tjp extension. This main project may include other files. Such included files must have file names with a <code class="manual">.tji</code> extension.</p>
-    <p class="manual">The graphical user interface from the 2.x version has not been ported to TaskJuggler III yet. So all work with TaskJuggler needs to be done in your favorite text editor and in a command shell.</p>
+    <p class="manual">The graphical user interface from the 2.x version has not been ported to TaskJuggler 3.x yet. So all work with TaskJuggler needs to be done in your favorite text editor and in a command shell.</p>
     <p class="manual">The commandline version of TaskJuggler works like a compiler. You provide the source files, it computes the contents and creates the output files. Let's say you have a project file called <code class="manual">AcSo.tjp</code>. It contains the tasks of your project and their dependencies. To schedule the project and create report files you have to ask TaskJuggler to process it.</p>
     <div class="manual" codesection="1"><pre class="manual" codesection="1">tj3 AcSo.tjp
 </pre></div>
@@ -34,8 +34,7 @@
     <h2 class="manual" id="Structure_of_a_TJP_File">3.2 Structure of a TJP File</h2>
     <p class="manual">Each TaskJuggler project consists of one or more text files. There is always a main project file that may <a href="include.properties.html">include</a> other files. The main file name should have a <code class="manual">.tjp</code> suffix, the included files must have a <code class="manual">.tji</code> suffix.</p>
     <p class="manual">Every project must start with a <a href="project.html">project header</a>. The project header must be in the main project file. All other elements may be put into include files. The project header must then be followed by any number of project properties such as <a href="account.html">
-accounts</a>, <a href="resource.html">resources</a>, <a href="task.html">tasks</a> and <a href="report.html">
-reports</a>. Each project must have at least one task defined and should have at least one report. Properties don't have to be listed in a particular order, but may have interdependencies that require such an order. If you want to assign a resource to work on a task, this resource needs to be defined first. It is therefor recommended to define them in the following sequence.</p>
+accounts</a>, <a href="resource.html">resources</a>, <a href="task.html">tasks</a> and reports. Each project must have at least one task defined and should have at least one report. Properties don't have to be listed in a particular order, but may have interdependencies that require such an order. If you want to assign a resource to work on a task, this resource needs to be defined first. It is therefor recommended to define them in the following sequence.</p>
     <ul>
      <li><a href="macro.html">macros</a></li>
      <li><a href="flags.html">flags</a></li>
@@ -44,7 +43,10 @@ reports</a>. Each project must have at least one task defined and should have at
      <li><a href="vacation.html">vacations</a></li>
      <li><a href="resource.html">resources</a></li>
      <li><a href="task.html">tasks</a></li>
-     <li><a href="report.html">reports</a></li>
+     <li><a href="accountreport.html">accountreports</a></li>
+     <li><a href="resourcereport.html">resourcereports</a></li>
+     <li><a href="taskreport.html">taskreports</a></li>
+     <li><a href="textreport.html">textreports</a></li>
      <li><a href="export.html">exports</a></li>
     </ul>
    </div></div>
@@ -57,6 +59,6 @@ reports</a>. Each project must have at least one task defined and should have at
    </tr></table>
   <hr/>
   <br/>
-  <div align="center" style="font-size:10px;">Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011 by Chris Schlaeger &lt;chris@linux.com&gt;.<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 &lt;chris@linux.com&gt;.<a href="http://www.taskjuggler.org">TaskJuggler</a> is a trademark of Chris Schlaeger.</div>
  </body>
 </html>

data/manual/html/How_To_Contribute.html

@@ -1,6 +1,6 @@
 <?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>How_To_Contribute</title>
@@ -9,7 +9,7 @@
  <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/>
@@ -50,18 +50,26 @@ rake gem
     <div class="manual" codesection="1"><pre class="manual" codesection="1">git add FILENAME
 </pre></div>
     <p class="manual">If you think you are done, you can commit your changes to your local repository.</p>
-    <div class="manual" codesection="1"><pre class="manual" codesection="1">git commit -a
+    <div class="manual" codesection="1"><pre class="manual" codesection="1">git commit -a -s
 </pre></div>
-    <p class="manual">And then push it into your forked github repository.</p>
+    <p class="manual">The -s parameter is very important. We will only accept signed-off patches. By signing off on your patches you confirm that you wrote the code and have the right to pass it on as a patch. See <a href="http://gerrit.googlecode.com/svn/documentation/2.0/user-signedoffby.html" target="_top">this document</a> for more information!</p>
+    <p class="manual">Please include a meaningful commit message. The first line (header line) should be prefixed by <code class="manual">Fix:</code> for bug fixes or <code class="manual">New:</code> for new features. This is used to automatically generate the change log from one release to another. So a bug that has been introduced after the last release and is fixed before the next release does not need to be included in the changelog. For those cases, don't use any prefix.</p>
+    <p class="manual">After the header line leave a blank line and include one or more paragraphs with more detailed information about the patch. This information will also be included in the the change log if the header line has a prefix.</p>
+    <p class="manual">If you fix a bug that was reported by somebody else, please also include a reported-by line:</p>
+    <div class="manual" codesection="1"><pre class="manual" codesection="1">Reported-by: whoever-reported-the-bug
+</pre></div>
+    <p class="manual">Then push it into your forked github repository.</p>
     <div class="manual" codesection="1"><pre class="manual" codesection="1">git push
 </pre></div>
     <p class="manual">The final step is to send us a <a href="http://help.github.com/pull-requests/" target="_top">pull request</a> for your changes.</p>
     <h3 class="manual" id="Contributing_to_the_User_Manual">2.8.4 Contributing to the User Manual</h3>
     <p class="manual">The user manual is currently a rough port of the 2.x manual. It contains many inaccuracies and does not provide much more than a tutorial and a syntax reference. Any help to turn this into a real user manual is greatly appreciated.</p>
     <p class="manual">The manual is composed from 3 different sources.</p>
-    <ol><li>The sources for normal pages are in MediaWiki format and can be found in the <code class="manual">manual</code> directory of the source distribution.</li></ol>
-    <ol><li>The information in the syntax reference is extracted from the TJP parser source code. It can be found in the file <code class="manual">lib/TjpSyntaxRules.rb</code>. You can ignore all but the <code class="manual">doc(...)</code>, <code class="manual">arg(...)</code> and <code class="manual">example(...)</code> sections.</li></ol>
-    <ol><li>The TJP examples are in the <code class="manual">test/TestSuite/Syntax/Correct</code> directory.</li></ol>
+    <ol>
+     <li>The sources for normal pages are in MediaWiki format and can be found in the <code class="manual">manual</code> directory of the source distribution.</li>
+     <li>The information in the syntax reference is extracted from the TJP parser source code. It can be found in the file <code class="manual">lib/TjpSyntaxRules.rb</code>. You can ignore all but the <code class="manual">doc(...)</code>, <code class="manual">arg(...)</code> and <code class="manual">example(...)</code> sections.</li>
+     <li>The TJP examples are in the <code class="manual">test/TestSuite/Syntax/Correct</code> directory.</li>
+    </ol>
     <p class="manual">The following commands build the HTML files for the manual in the <code class="manual">data/manual</code> directory.</p>
     <div class="manual" codesection="1"><pre class="manual" codesection="1">cd lib
 ruby UserManual.rb 
@@ -69,8 +77,8 @@ ruby UserManual.rb
     <h3 class="manual" id="Contributing_to_the_Test_Suite">2.8.5 Contributing to the Test Suite</h3>
     <p class="manual">The test suite can be found in the <code class="manual">test</code> and <code class="manual">spec</code> directories. It contains unit and system tests but is very rudimentary at the moment. Adding more system tests to the test/CSV-Report directory is probably the best place to start. Originally, TaskJuggler used classic Ruby unit tests, but a migration to <a href="http://rspec.info/|RSpec-2" target="_top">http://rspec.info/|RSpec-2</a> is in the works now. New tests should be written as RSpec tests unless they require infrastructure only available in the <code class="manual">test</code> directory.</p>
     <h3 class="manual" id="Contributing_to_the_Ruby_code">2.8.6 Contributing to the Ruby code</h3>
-    <p class="manual">For the first stable TaskJuggler III release we should have all 2.x features supported. The few things that break backwards compatibility should be documented in the <a href="TaskJuggler_2x_Migration.html">TaskJuggler_2x_Migration</a> section.</p>
-    <p class="manual">In general, patches are very welcome. Please follow the coding style and naming conventions used in the existing code. Larger changes should be preceded by a discussion in the <a href="http://www.taskjuggler.org/forum.php" target="_top">TaskJuggler Developer Forum</a>.</p>
+    <p class="manual">For the first stable TaskJuggler release we have most 2.x features supported. The few things that break backwards compatibility are documented in the <a href="TaskJuggler_2x_Migration.html">TaskJuggler_2x_Migration</a> section.</p>
+    <p class="manual">In general, patches are very welcome. Please follow the coding style and naming conventions used in the existing code. Larger changes should be preceded by a discussion in the <a href="http://www.taskjuggler.org/contact.html" target="_top">TaskJuggler Developer Forum</a>.</p>
     <h3 class="manual" id="Some_final_words_to_Contributors">2.8.7 Some final words to Contributors</h3>
     <p class="manual">We do welcome all contributions, but please understand that we reserve the right to reject any contribution that does not follow the above guidelines or otherwise conflicts with the goals of the TaskJuggler team. It is a good idea to contact the team prior to making any larger efforts.</p>
    </div></div>
@@ -83,6 +91,6 @@ ruby UserManual.rb
    </tr></table>
   <hr/>
   <br/>
-  <div align="center" style="font-size:10px;">Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011 by Chris Schlaeger &lt;chris@linux.com&gt;.<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 &lt;chris@linux.com&gt;.<a href="http://www.taskjuggler.org">TaskJuggler</a> is a trademark of Chris Schlaeger.</div>
  </body>
 </html>

data/manual/html/Installation.html

@@ -1,6 +1,6 @@
 <?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>Installation</title>
@@ -9,7 +9,7 @@
  <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/>
@@ -23,8 +23,7 @@
   <br/>
   <div style="width:90%; margin-left:5%; margin-right:5%"><div class="manual">
     <h1 class="manual" id="Installation">2 Installation</h1>
-    <p class="manual">TaskJuggler III is written in <a href="http://www.ruby-lang.org" target="_top">Ruby</a>. It should run on any platform that Ruby is available on. It uses the standard Ruby mechanism for distribution, a package format called <a href="http://docs.rubygems.org" target="_top">RubyGems</a>.</p>
-    <p class="manual">TaskJuggler III is still under development. There is no stable version yet. You are welcome to try it. Some users are already using it successfully for their purposes, but it might not yet be right for you.</p>
+    <p class="manual">TaskJuggler 3.x is written in <a href="http://www.ruby-lang.org" target="_top">Ruby</a>. It should run on any platform that Ruby is available on. It uses the standard Ruby mechanism for distribution, a package format called <a href="http://docs.rubygems.org" target="_top">RubyGems</a>.</p>
     <h2 class="manual" id="Requirements">2.1 Requirements</h2>
     <p class="manual">Ruby applications are platform independent. There is no need to compile anything. But TaskJuggler has a very small set of dependencies that you have to take care of first. Please make sure you have the minimum required version installed.</p>
     <h3 class="manual" id="Supported_Operating_Systems">2.1.1 Supported Operating Systems</h3>
@@ -39,10 +38,10 @@
     <p class="manual">If you are interested in becoming the maintainer for any of the currently unmaintained (and untested) OSes, please contact us via the developer mailing list.</p>
     <h3 class="manual" id="Other_required_Software">2.1.2 Other required Software</h3>
     <ul><li>
-      <b>Ruby:</b> TaskJuggler III is written in Ruby. You need a Ruby runtime environment to run it. This can be downloaded from <a href="http://www.ruby-lang.org/en/downloads/" target="_top">here</a>. Most Linux distributions usually have Ruby already included. So does MacOS X Leopard. For Windows, there is a one-click installer available. The recommended Ruby version to make full use of TaskJuggler is 1.9.2. Ruby 1.9.1 contains some bugs that prevent the multi-core support to work. For users that are not interested in multi-core support, the web server, the time sheet infrastructure and daemon Ruby 1.8.7 is still ok to use. On Windows you need at least Ruby 1.9.2.</li></ul>
+      <b>Ruby:</b> TaskJuggler 3.x is written in Ruby. You need a Ruby runtime environment to run it. This can be downloaded from <a href="http://www.ruby-lang.org/en/downloads/" target="_top">here</a>. Most Linux distributions usually have Ruby already included. So does MacOS X Leopard. For Windows, there is a one-click installer available. The recommended Ruby version to make full use of TaskJuggler is 1.9.2. Ruby 1.9.1 contains some bugs that prevent the multi-core support to work. For users that are not interested in multi-core support, the web server, the time sheet infrastructure and daemon Ruby 1.8.7 is still ok to use. On Windows you need at least Ruby 1.9.2.</li></ul>
     <p class="manual">See below for instructions on how to use the latest and greates Ruby version in parallel with your distribution Ruby.</p>
     <ul><li>
-      <b>RubyGems:</b> If it did not come with your OS or the Ruby installation, see <a href="http://docs.rubygems.org" target="_top">here</a> how to get and install it.</li></ul>
+      <b>RubyGems:</b> If it did not come with your OS or the Ruby installation, see <a href="http://docs.rubygems.org" target="_top">here</a> how to get and install it. RubyGems is a cross-platform package manager. It will download and install all other required software packages automatically when you install TaskJuggler. These packages are called Ruby gems.</li></ul>
     <p class="manual">Other versions of Ruby (Rubinius, JRuby, etc.) may work but have not been tested.</p>
     <h2 class="manual" id="Installation_Steps_for_Users">2.2 Installation Steps for Users</h2>
     <h3 class="manual" id="The_easy_way">2.2.1 The easy way</h3>
@@ -75,7 +74,7 @@
     <div class="manual" codesection="1"><pre class="manual" codesection="1"> tj3 --version
 </pre></div>
     <h3 class="manual" id="The_manual_way">2.2.2 The manual way</h3>
-    <p class="manual">If the easy way doesn't work for you, you need to download and install the packages manually. Download TaskJuggler III gem file from the <a href="http://rubygems.org/gems/taskjuggler" target="_top">RubyGems.org</a> site.</p>
+    <p class="manual">If the easy way doesn't work for you, you need to download and install the packages manually. Download TaskJuggler gem file from the <a href="http://rubygems.org/gems/taskjuggler" target="_top">RubyGems.org</a> site.</p>
     <p class="manual">A gem package is an operating system and architecture independent archive file for Ruby programs. You can install it on any system that has Ruby and RubyGems installed. Normally, you should be logged-in as root or administrator to run the following installation command. Replace the X.X.X with the actual version that you have downloaded.</p>
     <div class="manual" codesection="1"><pre class="manual" codesection="1">gem install pkg/taskjuggler-X.X.X.gem 
 </pre></div>
@@ -84,15 +83,19 @@
     <div class="manual" codesection="1"><pre class="manual" codesection="1">PATH=${PATH}:/var/lib/gems/1.8/bin/
 </pre></div>
     <p class="manual">Windows and MacOS platforms may require similar steps.</p>
-    <h2 class="manual" id="Update_from_older_TaskJuggler_III_versions">2.3 Update from older TaskJuggler III versions</h2>
+    <h2 class="manual" id="Update_from_older_TaskJuggler_3x_versions">2.3 Update from older TaskJuggler 3.x versions</h2>
     <p class="manual">Updates work just like the installation.</p>
     <div class="manual" codesection="1"><pre class="manual" codesection="1">gem update taskjuggler
 </pre></div>
     <p class="manual">For downloaded or self-built packages use the following command:</p>
     <div class="manual" codesection="1"><pre class="manual" codesection="1">gem update pkg/taskjuggler-X.X.X.gem
 </pre></div>
-    <h2 class="manual" id="Installation_Steps_for_Developers">2.4 Installation Steps for Developers</h2>
-    <p class="manual">The following description is for users that want to learn more about TaskJuggler or want to make improvements. TaskJuggler is <a href="http://en.wikipedia.org/wiki/Open_source" target="_top">Open Source</a> software and you are encouraged to read and modify the source code.</p>
+    <h2 class="manual" id="Installing_TaskJuggler_from_the_Git_Repository">2.4 Installing TaskJuggler from the Git Repository</h2>
+    <p class="manual">The following description is for developers and users that want to learn more about TaskJuggler or want to make improvements. TaskJuggler is <a href="http://en.wikipedia.org/wiki/Open_source" target="_top">Open Source</a> software and you are encouraged to read and modify the source code.</p>
+    <p class="manual">Before you download the source code, make sure you have all the necessary dependencies installed. You should have Ruby 1.9.2 or later and you need to have the following gems installed</p>
+    <div class="manual" codesection="1"><pre class="manual" codesection="1">gem install rake mail rspec term-ansicolor rcov
+</pre></div>
+    <p class="manual">rcov is optional, but you must have the other gems and their dependencies installed.</p>
     <p class="manual">To get the source code, the recommended way it to check out the latest code from the developer repository. To do this, you need to have <a href="http://www.kernel.org/pub/software/scm/git/docs/" target="_top">git</a> installed.</p>
     <p class="manual">Then checkout the source code with the following command</p>
     <div class="manual" codesection="1"><pre class="manual" codesection="1">git clone http://www.taskjuggler.org/git-repos/taskjuggler3.git
@@ -107,7 +110,7 @@
     <div class="manual" codesection="1"><pre class="manual" codesection="1"># Make sure the shell finds the TaskJuggler programs
 export PATH=${PATH}:${TASKJUGGLER_DIR}/bin
 </pre></div>
-    <h2 class="manual" id="Quickly_switching_between_various_TaskJuggler_III_versions">2.5 Quickly switching between various TaskJuggler III versions</h2>
+    <h2 class="manual" id="Quickly_switching_between_various_TaskJuggler_3x_versions">2.5 Quickly switching between various TaskJuggler 3.x versions</h2>
     <p class="manual">One of the benefits of using TaskJuggler from the Git repository is the ability to get the latest bug fixes. If a bug was reported, it is usually fixed fairly quickly, but it can take several weeks before the next official release happens. The following commands must all be executed from within the checked-out Git directory.</p>
     <div class="manual" codesection="1"><pre class="manual" codesection="1">git pull
 </pre></div>
@@ -121,7 +124,7 @@ export PATH=${PATH}:${TASKJUGGLER_DIR}/bin
     <div class="manual" codesection="1"><pre class="manual" codesection="1">git tag
 </pre></div>
     <p class="manual">provides you with a list of all tags.</p>
-    <p class="manual">TaskJuggler III is written in Ruby. There is no make or build process needed. Every code change is effective immediately. The tutorial, the manual and some other parts do require a build step.</p>
+    <p class="manual">TaskJuggler 3.x is written in Ruby. There is no make or build process needed. Every code change is effective immediately. The tutorial, the manual and some other parts do require a build step.</p>
     <div class="manual" codesection="1"><pre class="manual" codesection="1">rake release
 </pre></div>
     <p class="manual">will do it all and even create installable gem files again.</p>
@@ -140,8 +143,8 @@ export PATH=${PATH}:${TASKJUGGLER_DIR}/bin
     <p class="manual">If all goes well, you can install it now. This requires root permission, so you need to enter the root password. All executables will be installed into <code class="manual">/usr/local/bin</code>.</p>
     <div class="manual" codesection="1"><pre class="manual" codesection="1"> sudo make install
 </pre></div>
-    <p class="manual">As a final step, you need to install the <code class="manual">mail</code> gem.</p>
-    <div class="manual" codesection="1"><pre class="manual" codesection="1"> sudo gem19 install mail
+    <p class="manual">As a final step, you need to install the <code class="manual">mail</code> and <code class="manual">term-ansicolor</code> gems.</p>
+    <div class="manual" codesection="1"><pre class="manual" codesection="1"> sudo gem19 install mail term-ansicolor
 </pre></div>
     <p class="manual">If you don't want to use TaskJuggler from the git repository, you can install the TaskJuggler gem as well.</p>
     <div class="manual" codesection="1"><pre class="manual" codesection="1"> sudo gem19 install taskjuggler
@@ -188,6 +191,6 @@ augroup END
    </tr></table>
   <hr/>
   <br/>
-  <div align="center" style="font-size:10px;">Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011 by Chris Schlaeger &lt;chris@linux.com&gt;.<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 &lt;chris@linux.com&gt;.<a href="http://www.taskjuggler.org">TaskJuggler</a> is a trademark of Chris Schlaeger.</div>
  </body>
 </html>

data/manual/html/Intro.html

@@ -1,6 +1,6 @@
 <?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>Intro</title>
@@ -9,7 +9,7 @@
  <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/>
@@ -28,50 +28,66 @@
     <p class="manual">TaskJuggler is an Open Source tool for serious project managers. It covers the complete spectrum of project management tasks from the first idea to the completion of the project without enforcing certain work flows or methodologies. It assists you during project scoping, resource assignment, cost and revenue planning, risk and communication management, status tracking and reporting.</p>
     <p class="manual">TaskJuggler provides an optimizing scheduler that computes your project time lines and resource assignments based on the project outline and the constrains that you have provided. The built-in resource balancer and constrains checker offload you from having to worry about irrelevant details and ring the alarm if the project gets out of hand. The flexible "as many details as necessary"-approach allows you to still plan your project as you go, making it also ideal for new management strategies such as Extreme Programming and Agile Project Management.</p>
     <p class="manual">If you are about to build a skyscraper or just want to put together your colleague's shift plan for the next month, TaskJuggler is the right tool for you. If you just want to draw nice looking Gantt charts to impress your boss or your investors, TaskJuggler might not be right for you. It can certainly produce nice looking Gantt charts and other reports, but it takes some effort to master its power. For those that are willing to invest a few hours to get started with the software it will become a companion you don't want to miss anymore.</p>
-    <p class="manual">TaskJuggler is a commandline tool that you use from a <a href="http://en.wikipedia.org/wiki/Shell_(computing)" target="_top">shell</a>. This means that to enter your project data you will use one of the most versatile and powerful tools there is: your favorite <a href="http://en.wikipedia.org/wiki/Text_editor" target="_top">text editor</a>. To get a first impression, you can look at this <a href="http://www.taskjuggler.org/tj3/examples/tutorial.tjp" target="_top">project file</a>. The project description is fairly intuitive, but very powerful as well. The <a href="Tutorial.html">Tutorial</a> will explain this file line by line. Please look at the <a href="http://www.taskjuggler.org/tj3/examples/Overview.html" target="_top">resulting reports</a> that visualize the project.</p>
+    <p class="manual">TaskJuggler is a commandline tool that you use from a <a href="http://en.wikipedia.org/wiki/Shell_(computing)" target="_top">shell</a>. This means that to enter your project data you will use one of the most versatile and powerful tools there is: your favorite <a href="http://en.wikipedia.org/wiki/Text_editor" target="_top">text editor</a>. To get a first impression, you can look at this <a href="http://www.taskjuggler.org/tj3/examples/Tutorial/tutorial.tjp" target="_top">project file</a>. The project description is fairly intuitive, but very powerful as well. The <a href="Tutorial.html">Tutorial</a> will explain this file line by line. Please look at the <a href="http://www.taskjuggler.org/tj3/examples/Overview.html" target="_top">resulting reports</a> that visualize the project.</p>
     <h2 class="manual" id="License_and_Copyright">1.2 License and Copyright</h2>
     <p class="manual">This program is free software; you can redistribute it and/or modify it under the terms of <a href="http://www.gnu.org/licenses/old-licenses/gpl-2.0.html" target="_top">version 2 of the GNU General Public License</a> as published by the Free Software Foundation. You accept the terms of this license by distributing or using this software.</p>
     <p class="manual">This manual is Copyright (c) 2006, 2007, 2008, 2009, 2010 Chris Schlaeger.</p>
     <p class="manual">Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".</p>
     <p class="manual">The HTML reports use icons from the <a href="http://www.kde.org/people/credits/" target="_top">KDE Icon Team</a>. The icons are licensed under the <a href="http://www.fsf.org/licenses/lgpl.html" target="_top">GNU Lesser General Public License</a>.</p>
-    <p class="manual">The HTML reports use Java Script code from <a href="http://www.walterzorn.com" target="_top">Walter Zorn</a>. The code is licensed under the <a href="http://www.fsf.org/licenses/lgpl.html" target="_top">GNU Lesser General Public License</a>.</p>
+    <p class="manual">The HTML reports use Java Script code from <a href="http://www.walterzorn.de/en/tooltip/tooltip_e.htm" target="_top">Walter Zorn</a>. The code is licensed under the <a href="http://www.fsf.org/licenses/lgpl.html" target="_top">GNU Lesser General Public License</a>.</p>
+    <p class="manual">TaskJuggler does require other software components to operate. These components include the Ruby runtime system, operating system libraries and other components installed as Ruby gems. We have used great care to ensure that all dependencies are compatible with the TaskJuggler license and are being used as required by those licenses. But use cases may vary and you should check those licenses yourself to ensure that you use those components in accordance with their licenses.</p>
     <h2 class="manual" id="Features_and_Highlights">1.3 Features and Highlights</h2>
+    <h3 class="manual" id="Basic_Properties">1.3.1 Basic Properties</h3>
     <ul>
      <li>Manages tasks, resources and accounts of your project</li>
+     <li>Powerful to-do list management</li>
+     <li>Detailed reference manual</li>
+     <li>Simple installation</li>
+     <li>Runs on all Linux, Unix, Windows, MacOS and several other operating systems</li>
+     <li>Full integration with Vim text editor</li>
+    </ul>
+    <h3 class="manual" id="Advanced_Scheduling">1.3.2 Advanced Scheduling</h3>
+    <ul>
      <li>Automatic resource leveling and tasks conflict resolution</li>
-     <li>Comprehensive and flexible reports so you can find the information you need when you need it</li>
-     <li>Project tracking and status reporting with dashboard support</li>
-     <li>Time and status sheet reporting infrastructure</li>
      <li>Unlimited number of scenarios (baselines) of the same project for what-if analysis</li>
-     <li>Projects can be combined to larger projects</li>
-     <li>Project breakdown and management team support</li>
-     <li>Multiple project managers can work on the same project</li>
-     <li>Flexible working hours and vacation handling</li>
+     <li>Flexible working hours and leave management</li>
      <li>Support for shift working</li>
      <li>Multiple time zone support</li>
+    </ul>
+    <h3 class="manual" id="Accounting">1.3.3 Accounting</h3>
+    <ul>
      <li>Tasks may have initial costs, finishing costs</li>
-     <li>Resources may have running costs</li>
-     <li>Unlimited number of scenarios (baselines) of same project for what-if analysis</li>
+     <li>Resources may have usage based costs</li>
+     <li>Task and/or resource base cost models</li>
      <li>Support for profit/loss analysis</li>
-     <li>HTML reports for Web publishing</li>
-     <li>CSV data export for exchange with popular office software</li>
-     <li>iCalendar export for data exchange with calendar applications</li>
-     <li>Project description syntax with macro support</li>
-     <li>Built-in web server for dynamic and interactive reports</li>
-     <li>Powerful and flexible filtering functions to provide the right amount of detail to the right audience</li>
-     <li>Server based time sheet system for status and actual collection</li>
-     <li>Powerful project description syntax with macro support</li>
+    </ul>
+    <h3 class="manual" id="Reporting">1.3.4 Reporting</h3>
+    <ul>
+     <li>Comprehensive and flexible reports so you can find the information you need when you need it</li>
+     <li>Powerful filtering functions to provide the right amount of detail to the right audience</li>
+     <li>Time and status sheet reporting infrastructure</li>
+     <li>Project tracking and status reporting with dashboard support</li>
+    </ul>
+    <h3 class="manual" id="Scaling_and_Enterprise_Features">1.3.5 Scaling and Enterprise Features</h3>
+    <ul>
+     <li>Projects can be combined to larger projects</li>
      <li>Support for central resource allocation database</li>
+     <li>Manages roles and complex reporting lines</li>
+     <li>Powerful project description language with macro support</li>
      <li>Scales well on multi-core or multi-CPU systems</li>
-     <li>Full integration with Vim text editor</li>
-     <li>Runs on all Linux, Unix, Windows, MacOS and several other operating systems</li>
-     <li>Simple installation</li>
-     <li>Detailed reference manual</li>
-     <li>Support for project management teams and revision control</li>
+     <li>Support for project management teams and revision control systems</li>
+    </ul>
+    <h3 class="manual" id="Web_Publishing_and_Groupware_Functions">1.3.6 Web Publishing and Groupware Functions</h3>
+    <ul>
+     <li>HTML reports for web publishing</li>
+     <li>CSV data export for exchange with popular office software</li>
+     <li>iCalendar export for data exchange with calendar and productivity applications</li>
+     <li>Built-in web server for dynamic and interactive reports</li>
+     <li>Server based time sheet system for status and actual work reporting</li>
     </ul>
     <h2 class="manual" id="TaskJuggler_on_the_Web">1.4 TaskJuggler on the Web</h2>
     <p class="manual">The official TaskJuggler web site can be found at <a href="http://www.taskjuggler.org" target="_top">http://www.taskjuggler.org</a>.</p>
-    <p class="manual">Since the developers are mostly busy project managers themselves, we have created a <a href="http://www.taskjuggler.org/forum.php" target="_top">forum</a> for users to help each other.</p>
+    <p class="manual">Since the developers are mostly busy project managers themselves, we have created a <a href="http://www.taskjuggler.org/contact.html" target="_top">forum</a> for users to help each other.</p>
    </div></div>
   <br/>
   <hr/>
@@ -82,6 +98,6 @@
    </tr></table>
   <hr/>
   <br/>
-  <div align="center" style="font-size:10px;">Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011 by Chris Schlaeger &lt;chris@linux.com&gt;.<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 &lt;chris@linux.com&gt;.<a href="http://www.taskjuggler.org">TaskJuggler</a> is a trademark of Chris Schlaeger.</div>
  </body>
 </html>