taskjuggler 0.0.4 → 0.0.5

data/manual/Getting_Started

@@ -34,15 +34,15 @@ that are used on some operating systems.
 === Structure of a TJP File ===
 
 Each TaskJuggler project consists of one or more text files. There is
-always a main project file that may [[include.properties include]] other
+always a main project file that may [[include.properties|include]] other
 files. The main file name should have a ''''.tjp'''' suffix, the
 included files must have a ''''.tji'''' suffix.
 
-Every project must start with a [[project project header]]. The
+Every project must start with a [[project|project header]]. 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 [[account
-accounts]], [[resource resources]], [[task tasks]] and [[report
+followed by any number of project properties such as [[account|
+accounts]], [[resource|resources]], [[task|tasks]] and [[report|
 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
@@ -50,13 +50,13 @@ 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.
 
-* [[macro macros]]
+* [[macro|macros]]
 * [[flags]]
-* [[account accounts]]
-* [[shift shifts]]
-* [[vacation vacations]]
-* [[resource resources]]
-* [[task tasks]]
-* [[report reports]]
-* [[export exports]]
+* [[account|accounts]]
+* [[shift|shifts]]
+* [[vacation|vacations]]
+* [[resource|resources]]
+* [[task|tasks]]
+* [[report|reports]]
+* [[export|exports]]
 

data/manual/Rich_Text_Attributes

@@ -80,7 +80,17 @@ form, ''''.html'''' is appended to the first word in the reference to
 create the URL.
 
  [[item]]
- [[item An item]]
+ [[item|An item]]
+
+Images can be added with a similar syntax.
+
+ [[image.jpg]]
+ [[image.jpg|alt=An image]]
+
+This first version will be replaced with the file ''''image.jpg''''
+when the output format supports this. Otherwise a blank space will be
+inserted. The second version inserts the text ''''An image'''' if the
+output format does not support images.
 
 In some situations, it is desirable to not interpret certain markup
 sequences and reproduce the text verbatim. Such text must be enclosed
@@ -133,6 +143,8 @@ report period and the property set from the referencing report.
 ----
 '''Inline Generator''' ''''query''''
 
+Paramters:
+
 * ''''family'''' : Specifies whether a ''''task'''' or a ''''resource''''
 should be queried.
 

data/manual/TaskJuggler_2x_Migration

@@ -41,8 +41,8 @@ replaced with [[taskattributes]] and [[resourceattributes]].
 
 * Shifts and limits for allocations have been deprecated. The concept
 was bogus and not compatible with bookings. The functionality is
-now provided by [[shifts.task shifts]] and [[limits.task limits]] on the
-task level. Limits for a task can be [[limit.resources selectively
+now provided by [[shifts.task|shifts]] and [[limits.task|limits]] on the
+task level. Limits for a task can be [[resources.limit|selectively
 applied]] to certain resources.
 
 * Support for reading and writing XML files is no longer available.
@@ -52,7 +52,7 @@ it. There is nothing in the TJ3 design that would prevent this
 feature from being added again, but there are no plans for this right
 now.
 
-* The format for [[report reports]] has been changed considerably.
+* The format for [[report|reports]] 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
 definition can be used to generated multiple output [[formats]]. The
@@ -64,4 +64,42 @@ format.
 optional. If you don't need to reference a property, you can omit the
 ID. TaskJuggler will automatically assign an ID then.
 
+=== Using TaskJuggler 2.x and TaskJuggler 3.x in parallel ===
+
+While TaskJuggler 3.x has many new features over TaskJuggler 2.x like
+the much improved HTML reports, many 2.x users will miss the
+graphical user interface.
+
+To ease the migration, you can continue to use the TaskJuggler 2.x
+front-end while using TaskJuggler 3.x for report generation. This is
+possible because TaskJuggler 3.x can read-in the TaskJuggler 2.x
+export files. Export files are fully scheduled projects that include
+start and end dates for all tasks and bookings for resource
+allocations. 
+
+To export all tasks and resources into a TJP file that can be read by
+TaskJuggler 3.x include the following export report definition in your
+TaskJuggler 2.x project plan. The necessary patches to support this
+only made it into TaskJuggler 2.x after the 2.4.3 release. So be sure
+to use a recent version from the Git repository to try this.
+
+ export "FullProject.tjp" {
+   taskattributes all
+   resourceattributes all
+   hideresource 0
+ }
+
+The resulting ''''FullProject.tjp'''' file is a valid self-contained
+project file that can be read with TaskJuggler 2.x or TaskJuggler
+3.x. The file does not contain any report definitions. To generate
+reports with TaskJuggler 3.x you need to create an additional file
+that contains the TaskJugler 3.x report definitions.
+
+Let's assume the file is called ''''tj3reports.tji''''. Start
+TaskJuggler 3.x with the following command:
+
+ tj3 FullProject.tjp tj3reports.tji
+
+Now you have generated TaskJuggler 3.x reports from you TaskJuggler
+2.x project.
 

data/manual/TaskJuggler_Internals

@@ -0,0 +1,87 @@
+== TaskJuggler Internals ==
+
+This chapter contains information that you don't need to know to use
+TaskJuggler. It describes internal algorithms that are provided for
+the curious.
+
+=== How the Scheduler works ===
+
+The scheduler needs to determine the start and end date for all tasks
+that don't have such dates yet. Additionally, it allocates resources
+to tasks.  All events such as start of a task, or allocation of a
+resource can only happen aligned with the [[timingresolution|timing
+resolution]]. The smallest possible allocation period is
+called a time slot. The duration of the slot  can be determined by the
+user. Possible values are 5, 10, 15, 30 and 60 minutes. Internally,
+all events are stored as UTC time.
+
+TaskJuggler keeps a scoreboard for each time slot for each leaf
+resource. This explains why the project duration and number of
+allocated resources determines the memory usage of the scheduler.
+
+During the scheduling process, tasks can have 3 different states.
+
+# ''''Not ready for scheduling'''': The task is missing a start or
+end date that depends on another task's date that hasn't been
+determined yet.
+
+# ''''Ready for scheduling'''': The task has at least a start or end
+date but one of them is still missing or resources have not yet been
+assigned for all time slots.
+
+# ''''Scheduling completed'''': The task has a start and end date and
+resources have been assigned for all time slots.
+
+The goal of the scheduler is to transfer all tasks in the completed
+state. Until this goal has been reached, at least one tasks needs to
+be in the ready state. If that's not the case, the project schedule
+cannot be determined and an error is raised. In case there are more
+than one task in the ready state, we need to have a well defined
+priority of the tasks. This is necessary since those ready tasks may
+compete for the same resource for the same time slot.
+
+The priority can be directly influenced by the user with the
+[[priority]] attribute. In case two tasks have the same priority, an
+additional measure is used. This measure is called path criticalness. The
+path criticalness is calculated for each leaf task. The path
+criticalness is a measure for how important the task is to keep the
+overall project duration (start of first task to end of last task) to
+a minimum.
+
+To determine the path criticalness, we first need to determine the
+resource criticalness. This is a measure for how likely the tasks
+that have this resource in their allocation list will actually get
+the resource. A resource criticalness larger than 1.0 means that
+statistically, at least one tasks will not get enough of this
+resource. This is just a statistical measure based on the total
+requested allocations and the number of available work time.
+
+Once we have determined the criticalness of all allocated resources,
+we can calculate the criticalness of each individual task. This
+really only matters for effort based tasks. These really need their
+allocations. For length and duration tasks, the allocations are
+optional. The user can still influence the allocation to length and
+duration tasks by adjusting the priority appropriately. The
+criticalness of a task is defined as the average of the criticalness
+of the resources allocated to this task.
+
+We also assign a criticalness to milestones. Based on their priority
+a criticalness between 0 and 2.0 is assigned.
+
+The final step is now the computation of the path criticalness for
+each effort-based leaf task. For each possible chain of task (path)
+that is going through a task, the sum of the criticalness values of
+the tasks of the path is computed. The largest sum is the path
+criticalness of that task.
+
+This heuristic will favor allocations to task with critical resources
+and long dependency chains. As a result, the critical paths of the
+project are tried to be kept short.
+
+This heuristic is certainly not perfect but has shown good results
+with fairly short computation overhead. The scheduling process is not
+an optimization process. It does not evaluate alternatives and it
+does not search for local extremes in a solution space.
+
+
+

data/manual/The_TaskJuggler_Syntax

@@ -77,8 +77,7 @@ a dotted line) and ends with ''''->8-''''. The start mark must be
 immediately followed by a line break. The indentation of the first
 line must be repeated for all following lines of the string and is not
 included in the resulting strings. The terminating cut mark must only
-be preceeded by white spaces by may not be indented more than the
-first line indentation.
+be preceded by white spaces in that line.
 
  -8<-
    This is a

data/manual/Tutorial

@@ -54,7 +54,7 @@ Because each culture has its own way of specifying dates and numbers,
 the format for these are configurable.  Use the [[timeformat]]
 attribute to specify the default format for dates. This format is used
 for reports, it does not affect the way you specify dates in the
-project files. Here you always need to use the [[date ISO standardized
+project files. Here you always need to use the [[date|ISO standardized
 notation]].
 
 <[example file="tutorial" tag="formats"]>
@@ -124,7 +124,7 @@ does not do any resource assignments to tasks.
 Use the [[vacation]] attribute to define a global vacation. Global
 vacations must have a name and a date or date range. This is slightly
 different from vacations of individual resources. They are defined
-with the [[vacation.resource vacation attribute for resources]] where
+with the [[vacation.resource|vacation attribute for resources]] where
 the name is optional. The vacation name is purely for documentation
 purposes.
 
@@ -163,7 +163,7 @@ We will see further down, how we can make use of these flags.
 The use of our resources will create costs. For a profit and loss
 analysis, we need to balance the costs against the customer payments.
 In order not to get lost with all the various amounts, we declare 3
-[[account accounts]] to credit the amounts to. We create one account
+[[account|accounts]] to credit the amounts to. We create one account
 for the development costs, one for the documentation costs, and one
 for the customer payments.
 
@@ -194,7 +194,7 @@ project.
 
 <[example file="tutorial" tag="resources"]>
 
-This snippet of the example shows the use of the [[resource
+This snippet of the example shows the use of the [[resource|
 resource property]]. Just like accounts, resources always have an ID
 and a Name. These IDs also need to be unique within their property
 class.  Names are strings and as such enclosed in double quotes. As
@@ -227,8 +227,8 @@ end date is not included in the interval. So Klaus Müller's vacation
 ends exactly at 0:00:00 on February 4th, 2002.
 
 Peter Murphy only works 6.4 hours a day. So we use the
-[[limits.resource limits]] attribute to limit his daily working hours.
-We could also define exact working hours using the [[shift shift
+[[limits.resource|limits]] attribute to limit his daily working hours.
+We could also define exact working hours using the [[shift|shift
 property]], but we ignore this for now.
 
 Note that we have attached the flag team after the declaration of the
@@ -243,7 +243,7 @@ Let's focus on the real work now. The project should solve a problem:
 the creation of an accounting software. Because the job is quite
 complicated, we break it down into several subtasks. We need to do a
 specification, develop the software, test the software, and write a
-manual. Using the [[task task property]], thiis would look as follows:
+manual. Using the [[task|task property]], thiis would look as follows:
 
 <[example file="tutorial" tag="task1"]>
 
@@ -354,7 +354,7 @@ the AcSo scope that contains the spec tasks. For a change, we
 
 <[example file="tutorial" tag="gui"]>
 
-TaskJuggler can schedule your project for two different [[scenario
+TaskJuggler can schedule your project for two different [[scenario|
 scenarios]]. We have called the first scenario ''''plan'''' scenario
 and the second ''''delayed'''' scenario. Many of the reports allow you
 to put the values of both scenarios side by side to each other, so you
@@ -473,7 +473,7 @@ more generic report, you can use the [[textreport]].
 
 A ''''textreport'''' does not directly present the data in form of a
 task or resource list. It just consists of text building blocks that
-are described by [[Rich_Text_Attributes Rich Text]]. There can be a
+are described by [[Rich_Text_Attributes|Rich Text]]. There can be a
 building block at the top and bottom, as well as three columns in
 the center. The column are called ''''left'''', ''''center'''' and
 ''''right''''.
@@ -557,7 +557,7 @@ The ''''taskreport'''' can contain more than just the table. It is
 not as flexible as the ''''textreport'''', but still has support for
 a header and footer. Let's look at the header first. We not only
 like to put a headline here, but several paragraphs of text. The
-[[header]] attribute is a [[Rich_Text_Attributes Rich Text]]
+[[header]] attribute is a [[Rich_Text_Attributes|Rich Text]]
 attribute just like [[center]]. We could enclose it in single or
 double quotes again. But for Strings that span multiple lines and
 potentially include single or double quotes as well, scissor-marks or

data/test/TestSuite/CSV-Reports/celltext.tjp

@@ -3,6 +3,6 @@ include "project-1.tji"
 
 taskreport csv "." {
   formats csv
-  columns wbs, name { celltext "$${name} ($${id})" }
+  columns wbs, name { celltext 1 "<-query-> (<-query attribute='id'->)" }
 }
 

data/test/TestSuite/HTML-Reports/TimeSheet.html

@@ -0,0 +1,79 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!-- This file has been generated by taskjuggler3 v0.0.3-->
+<html lang="en" xml:lang="en" xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+  <title>TaskJuggler Report - TimeSheet</title>
+  <link href="css/tjreport.css" rel="stylesheet" type="text/css"/>
+ </head>
+ <body>
+  <script src="scripts/wz_tooltip.js" type="text/javascript"></script>
+  <noscript><div style="text-align:center; color:#FF0000">This page requires Javascript for full functionality. Please enable it
+in your browser settings!
+</div></noscript>
+  <div style="margin: 35px 5% 25px 5%; ">
+   <table align="center" border="0" cellpadding="0" cellspacing="2" class="tjtable" summary="Report Table"><tbody>
+     <tr><td><table align="center" cellpadding="2" cellspacing="1" class="tabback" width="100%"><tbody>
+         <tr class="tabhead" style="height:19px; font-size:15px;">
+          <td class="tabcell" rowspan="2"><div class="headercelldiv" style="text-align:center; padding-left:5px; padding-right:5px; font-weight:bold; ">Name</div></td>
+          <td class="tabcell" rowspan="2"><div class="headercelldiv" style="text-align:center; padding-left:5px; padding-right:5px; font-weight:bold; ">Id</div></td>
+          <td class="tabcell" rowspan="2"><div class="headercelldiv" style="text-align:center; padding-left:5px; padding-right:5px; font-weight:bold; ">Alert</div></td>
+          <td class="tabcell" rowspan="2"><div class="headercelldiv" style="text-align:center; padding-left:5px; padding-right:5px; font-weight:bold; ">Alert Message</div></td>
+         </tr>
+         <tr class="tabhead" style="height:19px; font-size:15px;"/>
+         <tr class="tabline" style="font-size:12px; ">
+          <td class="taskcell1"><div class="celldiv" style="text-align:left; ">
+            <img align="top" src="icons/task.png" style="margin-right:3px;margin-bottom:2px"/>Task 3</div></td>
+          <td class="taskcell1"><div class="celldiv" style="text-align:left; ">t2.t3</div></td>
+          <td class="taskcell1"><div class="celldiv" style="text-align:left; color:#C00000; ">
+            <img align="top" src="icons/flag-red.png" style="margin-right:3px;margin-bottom:2px"/>Red</div></td>
+          <td class="taskcell1"><div class="celldiv" style="text-align:left; "><span class="alertmessage">
+             <h1 class="alertmessage" id="I_need_more_time">I need more time</h1>
+             <p class="alertmessage">
+              <i>Reported on 2009-12-07</i> <i>by R2</i>
+             </p>
+             <p class="alertmessage">This takes longer than expected</p>
+             <p class="alertmessage">To finish on time, I need help. Get this r1 guy to help me out here.</p>
+             <ul><li>I want to have fun too!</li></ul>
+            </span></div></td>
+         </tr>
+         <tr class="tabline" style="font-size:12px; ">
+          <td class="taskcell2"><div class="celldiv" style="text-align:left; ">
+            <img align="top" src="icons/task.png" style="margin-right:3px;margin-bottom:2px"/>Task 1</div></td>
+          <td class="taskcell2"><div class="celldiv" style="text-align:left; ">t1</div></td>
+          <td class="taskcell2"><div class="celldiv" style="text-align:left; color:#008000; ">
+            <img align="top" src="icons/flag-green.png" style="margin-right:3px;margin-bottom:2px"/>Green</div></td>
+          <td class="taskcell2"><div class="celldiv" style="text-align:left; "><span class="alertmessage">
+             <h1 class="alertmessage" id="All_work_done">All work done</h1>
+             <p class="alertmessage">
+              <i>Reported on 2009-12-07</i> <i>by R1</i>
+             </p>
+             <p class="alertmessage">I had good fun!</p>
+             <p class="alertmessage">This task went smoothly and I got three things done:</p>
+             <ul>
+              <li>Have fun</li>
+              <li>Be on time</li>
+              <li>Get things done</li>
+             </ul>
+            </span></div></td>
+         </tr>
+         <tr class="tabline" style="font-size:12px; ">
+          <td class="taskcell1"><div class="celldiv" style="text-align:left; ">
+            <img align="top" src="icons/task.png" style="margin-right:3px;margin-bottom:2px"/>Task 4</div></td>
+          <td class="taskcell1"><div class="celldiv" style="text-align:left; ">t2.t4</div></td>
+          <td class="taskcell1"><div class="celldiv" style="text-align:left; color:#008000; ">
+            <img align="top" src="icons/flag-green.png" style="margin-right:3px;margin-bottom:2px"/>Green</div></td>
+          <td class="taskcell1"><div class="celldiv" style="text-align:left; "><span class="alertmessage">
+             <h1 class="alertmessage" id="All_things_fine">All things fine</h1>
+             <p class="alertmessage">
+              <i>Reported on 2009-12-07</i> <i>by R3</i>
+             </p>
+            </span></div></td>
+         </tr>
+        </tbody></table></td></tr>
+     <tr style="font-size:10px;"><td style="padding-left:1px; padding-right:1px;"/></tr>
+    </tbody></table>
+   <div class="copyright">Project: test Version: 1.0 - Created on 2009-12-10 22:43:58 with <a href="http://www.taskjuggler.org">TaskJuggler III</a> v0.0.3</div>
+  </div>
+ </body>
+</html>

data/test/TestSuite/HTML-Reports/reference.html

@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!-- This file has been generated by taskjuggler3 v0.0.3-->
+<html lang="en" xml:lang="en" xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+  <title>TaskJuggler Report - reference</title>
+  <link href="css/tjreport.css" rel="stylesheet" type="text/css"/>
+ </head>
+ <body>
+  <script src="scripts/wz_tooltip.js" type="text/javascript"></script>
+  <noscript><div style="text-align:center; color:#FF0000">This page requires Javascript for full functionality. Please enable it
+in your browser settings!
+</div></noscript>
+  <div style="margin: 35px 5% 25px 5%; ">
+   <table align="center" border="0" cellpadding="0" cellspacing="2" class="tjtable" summary="Report Table"><tbody>
+     <tr><td><table align="center" cellpadding="2" cellspacing="1" class="tabback" width="100%"><tbody>
+         <tr class="tabhead" style="height:19px; font-size:15px;">
+          <td class="tabcell" rowspan="2"><div class="headercelldiv" style="text-align:center; padding-left:5px; padding-right:5px; font-weight:bold; ">Name</div></td>
+          <td class="tabcell" rowspan="2"><div class="headercelldiv" style="text-align:center; padding-left:5px; padding-right:5px; font-weight:bold; ">URL</div></td>
+          <td class="tabcell" rowspan="2"><div class="headercelldiv" style="text-align:center; padding-left:5px; padding-right:5px; font-weight:bold; ">Start</div></td>
+         </tr>
+         <tr class="tabhead" style="height:19px; font-size:15px;"/>
+         <tr class="tabline" style="font-size:12px; ">
+          <td class="taskcell1"><div class="celldiv" style="text-align:left; font-weight:bold; ">
+            <img align="top" src="icons/taskgroup.png" style="margin-right:3px;margin-bottom:2px"/>A A A</div></td>
+          <td class="taskcell1"><div class="celldiv" style="text-align:center; font-weight:bold; "></div></td>
+          <td class="taskcell1"><div class="celldiv" style="text-align:left; font-weight:bold; ">2008-02-28</div></td>
+         </tr>
+         <tr class="tabline" style="font-size:12px; ">
+          <td class="taskcell2"><div class="celldiv" style="text-align:left; padding-left:11px; ">
+            <img align="top" src="icons/task.png" style="margin-right:3px;margin-bottom:2px"/>
+            <span><a href="http://www.taskjuggler.org">B B B</a></span>
+           </div></td>
+          <td class="taskcell2"><div class="celldiv" style="text-align:center; "><span><a href="http://www.taskjuggler.org">foo</a></span></div></td>
+          <td class="taskcell2"><div class="celldiv" style="text-align:left; ">2008-02-28</div></td>
+         </tr>
+         <tr class="tabline" style="font-size:12px; ">
+          <td class="taskcell1"><div class="celldiv" style="text-align:left; ">
+            <img align="top" src="icons/task.png" style="margin-right:3px;margin-bottom:2px"/>
+            <span><a href="http://www.kde.org">C C C</a></span>
+           </div></td>
+          <td class="taskcell1"><div class="celldiv" style="text-align:center; "><span><a href="http://www.kde.org">http://www.kde.org</a></span></div></td>
+          <td class="taskcell1"><div class="celldiv" style="text-align:left; ">2008-02-28</div></td>
+         </tr>
+        </tbody></table></td></tr>
+     <tr style="font-size:10px;"><td style="padding-left:1px; padding-right:1px;"/></tr>
+    </tbody></table>
+   <div class="copyright">Project: Test Version: 1.0 - Created on 2009-12-03 11:10:19 with <a href="http://www.taskjuggler.org">TaskJuggler III</a> v0.0.3</div>
+  </div>
+ </body>
+</html>