taskjuggler 3.2.0 → 3.3.0

data/lib/taskjuggler/reports/Report.rb

@@ -20,7 +20,7 @@ require 'taskjuggler/reports/TaskListRE'
 require 'taskjuggler/reports/ResourceListRE'
 require 'taskjuggler/reports/TraceReport'
 require 'taskjuggler/reports/TagFile'
-require 'taskjuggler/reports/TjpExportRE'
+require 'taskjuggler/reports/ExportRE'
 require 'taskjuggler/reports/StatusSheetReport'
 require 'taskjuggler/reports/TimeSheetReport'
 require 'taskjuggler/reports/NikuReport'
@@ -95,6 +95,8 @@ class TaskJuggler
           generateNiku
         when :tjp
           generateTJP
+        when :mspxml
+          generateMspXml
         else
           raise 'Unknown report output format #{format}.'
         end
@@ -118,7 +120,7 @@ class TaskJuggler
       when :accountreport
         @content = AccountListRE.new(self)
       when :export
-        @content = TjpExportRE.new(self)
+        @content = ExportRE.new(self)
       when :iCal
         @content = ICalReport.new(self)
       when :niku
@@ -280,7 +282,7 @@ EOT
       end
     end
 
-    # Generate time sheet drafts.
+    # Generate the report in TJP format.
     def generateTJP
       unless @content.respond_to?('to_tjp')
         warning('tjp_not_supported',
@@ -304,6 +306,29 @@ EOT
       end
     end
 
+    # Generate the report in Microsoft Project XML format.
+    def generateMspXml
+      unless @content.respond_to?('to_mspxml')
+        warning('mspxml_not_supported',
+                "Microsoft Project XML format is not supported for " +
+                "report #{@id} of type #{@typeSpec}.")
+        return nil
+      end
+
+      begin
+        fileName = '.'
+        if @name == '.'
+          $stdout.write(@content.to_mspxml)
+        else
+          fileName = (@name[0] == '/' ? '' : @project.outputDir) + @name + '.xml'
+          fileName.untaint
+          File.open(fileName, 'w') { |f| f.write(@content.to_mspxml) }
+        end
+      rescue IOError, SystemCallError
+        error('write_mspxml', "Cannot write to file #{fileName}.\n#{$!}")
+      end
+    end
+
     # Generate Niku report
     def generateNiku
       unless @content.respond_to?('to_niku')
@@ -323,7 +348,7 @@ EOT
       end
     end
 
-    # Generate Niku report
+    # Generate the report in iCal format.
     def generateICal
       unless @content.respond_to?('to_iCal')
         warning('ical_not_supported',

data/lib/taskjuggler/reports/ReportBase.rb

@@ -38,14 +38,6 @@ class TaskJuggler
       end
     end
 
-    def to_html
-      raise 'This function must be overriden by derived classes.'
-    end
-
-    def to_csv
-      raise 'This function must be overriden by derived classes.'
-    end
-
     # Take the complete account list and remove all accounts that are matching
     # the hide expression, the rollup Expression or are not a descendent of
     # accountroot.

data/lib/taskjuggler/reports/TableReport.rb

@@ -307,10 +307,19 @@ class TaskJuggler
         rStart -= margin
         rEnd += margin
 
+        # This could cause rStart to be larger than rEnd.
+        rStart = origStart if doNotAdjustStart
+        rEnd = origEnd if doNotAdjustEnd
+
+        # Ensure that we have a valid interval. If not, go back to the
+        # original interval dates.
+        if rStart >= rEnd
+          rStart = origStart
+          rEnd = origEnd
+        end
+
         # Save the adjusted dates to the columns Hash.
-        @columns[columnDef] = TableReportColumn.new(
-          doNotAdjustStart ? origStart : rStart,
-          doNotAdjustEnd ? origEnd : rEnd)
+        @columns[columnDef] = TableReportColumn.new(rStart, rEnd)
       end
     end
 
@@ -328,6 +337,7 @@ class TaskJuggler
         # table.
         gantt = GanttChart.new(a('now'),
                                a('weekStartsMonday'), self)
+
         gantt.generateByScale(rStart, rEnd, columnDef.scale)
         # The header consists of 2 lines separated by a 1 pixel boundary.
         gantt.header.height = @table.headerLineHeight * 2 + 1

data/lib/taskjuggler/reports/TaskListRE.rb

@@ -42,6 +42,7 @@ class TaskJuggler
                                 @report.get('rollupTask'),
                                 @report.get('openNodes'))
       taskList.sort!
+      taskList.checkForDuplicates(@report.sourceFileInfo)
 
       # Prepare the resource list. Don't filter it yet! It would break the
       # *_() LogicalFunctions.

data/lib/taskjuggler/reports/TjpExportRE.rb

@@ -480,7 +480,7 @@ class TaskJuggler
     end
 
     def quotedString(str)
-      if str[-1] == ?\n
+      if str.include?("\n")
         "-8<-\n#{str}\n->8-"
       else
         escaped = str.gsub("\"", '\"')

data/manual/Rich_Text_Attributes

@@ -225,8 +225,8 @@ requested attribute is scenario specific.
 
 * ''''end'''' : The end date of the report period of the current report.
 
-* ''''loadunit'''' : The [[loadunit]] that should be used in case the
-requested attribute is an effort or duration value.
+* ''''loadunit'''' : The [[loadunit]] that should be used in
+case the requested attribute is an effort or duration value.
 
 * ''''timeformat'''' : The [[timeformat]] used to format date attributes.
 

data/manual/Tutorial

@@ -9,11 +9,15 @@ demonstrates most of the commonly used features of TaskJuggler. It
 also includes some of the more advanced concepts that you may or may
 not need for your projects. Don't get scared by them. You can use
 them once you are more familiar with TaskJuggler and your projects
-grow larger. The complete tutorial example can be downloaded
-[http://www.taskjuggler.org/tj3/examples/Tutorial/tutorial.tjp here].
-You can use any plain text editor to view and modify it.  The
-resulting reports can be found
-[http://www.taskjuggler.org/tj3/examples/Tutorial/Overview.html here].
+grow larger. The complete tutorial example comes with your
+TaskJuggler software installation. You can use the following command
+to find the base directory of the example projects.
+
+  ruby19 -e "puts Gem::Specification.find_by_name('taskjuggler').gem_dir"
+
+The file for the tutorial project is called
+''''examples/Tutorial/tutorial.tjp''''. You can use any plain text
+editor to view and modify it.
 
 === Starting the project ===
 
@@ -591,12 +595,12 @@ syntax uses, but also like to include the weekday. To change the date
 format, the [[timeformat]] attribute can be used.
 
 The project will last a few weeks. The most convenient unit to list
-efforts in is man or resource days. The [[loadunit]] attribute tells
-TaskJuggler to list the load of each task or resource in man days.
-Since this will just be a number without a unit, it is advisable to
-include a small hint for the reader that these values are indeed man
-or resource days. The caption of the table is a convenient place to
-put this information by using the [[caption]] attribute.
+efforts in is man or resource days. The [[loadunit]] attribute
+tells TaskJuggler to list the load of each task or resource in man
+days.  Since this will just be a number without a unit, it is
+advisable to include a small hint for the reader that these values are
+indeed man or resource days. The caption of the table is a convenient
+place to put this information by using the [[caption]] attribute.
 
 <[example file="tutorial" tag="overview3"]>
 

data/manual/html/Day_To_Day_Juggling.html

@@ -1,5 +1,5 @@
 <!DOCTYPE>
-<!-- This file has been generated by tj3man v3.2.0 -->
+<!-- This file has been generated by tj3man v3.3.0 -->
 <html lang="en" xml:lang="en">
  <head>
   <title>Day_To_Day_Juggling</title>

data/manual/html/Getting_Started.html

@@ -1,5 +1,5 @@
 <!DOCTYPE>
-<!-- This file has been generated by tj3man v3.2.0 -->
+<!-- This file has been generated by tj3man v3.3.0 -->
 <html lang="en" xml:lang="en">
  <head>
   <title>Getting_Started</title>

data/manual/html/How_To_Contribute.html

@@ -1,5 +1,5 @@
 <!DOCTYPE>
-<!-- This file has been generated by tj3man v3.2.0 -->
+<!-- This file has been generated by tj3man v3.3.0 -->
 <html lang="en" xml:lang="en">
  <head>
   <title>How_To_Contribute</title>

data/manual/html/Installation.html

@@ -1,5 +1,5 @@
 <!DOCTYPE>
-<!-- This file has been generated by tj3man v3.2.0 -->
+<!-- This file has been generated by tj3man v3.3.0 -->
 <html lang="en" xml:lang="en">
  <head>
   <title>Installation</title>

data/manual/html/Intro.html

@@ -1,5 +1,5 @@
 <!DOCTYPE>
-<!-- This file has been generated by tj3man v3.2.0 -->
+<!-- This file has been generated by tj3man v3.3.0 -->
 <html lang="en" xml:lang="en">
  <head>
   <title>Intro</title>

data/manual/html/Reporting_Bugs.html

@@ -1,5 +1,5 @@
 <!DOCTYPE>
-<!-- This file has been generated by tj3man v3.2.0 -->
+<!-- This file has been generated by tj3man v3.3.0 -->
 <html lang="en" xml:lang="en">
  <head>
   <title>Reporting_Bugs</title>

data/manual/html/Rich_Text_Attributes.html

@@ -1,5 +1,5 @@
 <!DOCTYPE>
-<!-- This file has been generated by tj3man v3.2.0 -->
+<!-- This file has been generated by tj3man v3.3.0 -->
 <html lang="en" xml:lang="en">
  <head>
   <title>Rich_Text_Attributes</title>

data/manual/html/Software.html

@@ -1,5 +1,5 @@
 <!DOCTYPE>
-<!-- This file has been generated by tj3man v3.2.0 -->
+<!-- This file has been generated by tj3man v3.3.0 -->
 <html lang="en" xml:lang="en">
  <head>
   <title>Software</title>

data/manual/html/TaskJuggler_2x_Migration.html

@@ -1,5 +1,5 @@
 <!DOCTYPE>
-<!-- This file has been generated by tj3man v3.2.0 -->
+<!-- This file has been generated by tj3man v3.3.0 -->
 <html lang="en" xml:lang="en">
  <head>
   <title>TaskJuggler_2x_Migration</title>

data/manual/html/TaskJuggler_Internals.html

@@ -1,5 +1,5 @@
 <!DOCTYPE>
-<!-- This file has been generated by tj3man v3.2.0 -->
+<!-- This file has been generated by tj3man v3.3.0 -->
 <html lang="en" xml:lang="en">
  <head>
   <title>TaskJuggler_Internals</title>

data/manual/html/The_TaskJuggler_Syntax.html

@@ -1,5 +1,5 @@
 <!DOCTYPE>
-<!-- This file has been generated by tj3man v3.2.0 -->
+<!-- This file has been generated by tj3man v3.3.0 -->
 <html lang="en" xml:lang="en">
  <head>
   <title>The_TaskJuggler_Syntax</title>

data/manual/html/Tutorial.html

@@ -1,5 +1,5 @@
 <!DOCTYPE>
-<!-- This file has been generated by tj3man v3.2.0 -->
+<!-- This file has been generated by tj3man v3.3.0 -->
 <html lang="en" xml:lang="en">
  <head>
   <title>Tutorial</title>
@@ -23,7 +23,10 @@
   <br/>
   <div style="width:90%; margin-left:5%; margin-right:5%"><div class="manual">
     <h1 class="manual" id="The_Tutorial_Your_first_Project">4 The Tutorial: Your first Project</h1>
-    <p class="manual">We have mentioned already that TaskJuggler uses plain text files that capture the known parts of the project. As you will see now, the syntax of these files is easy to understand and very intuitive. This chapter 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 most of the commonly used features of TaskJuggler. It also includes some of the more advanced concepts that you may or may not need for your projects. Don't get scared by them. You can use them once you are more familiar with TaskJuggler and your projects grow larger. The complete tutorial example can be downloaded <a href="http://www.taskjuggler.org/tj3/examples/Tutorial/tutorial.tjp" target="_top">here</a>. You can use any plain text editor to view and modify it. The resulting reports can be found <a href="http://www.taskjuggler.org/tj3/examples/Tutorial/Overview.html" target="_top">here</a>.</p>
+    <p class="manual">We have mentioned already that TaskJuggler uses plain text files that capture the known parts of the project. As you will see now, the syntax of these files is easy to understand and very intuitive. This chapter 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 most of the commonly used features of TaskJuggler. It also includes some of the more advanced concepts that you may or may not need for your projects. Don't get scared by them. You can use them once you are more familiar with TaskJuggler and your projects grow larger. The complete tutorial example comes with your TaskJuggler software installation. You can use the following command to find the base directory of the example projects.</p>
+    <div class="manual" codesection="1"><pre class="manual" codesection="1"> ruby19 -e "puts Gem::Specification.find_by_name('taskjuggler').gem_dir"
+</pre></div>
+    <p class="manual">The file for the tutorial project is called <code class="manual">examples/Tutorial/tutorial.tjp</code>. You can use any plain text editor to view and modify it.</p>
     <h2 class="manual" id="Starting_the_project">4.1 Starting the project</h2>
     <p class="manual">Every TaskJuggler project file must start with the <a href="project.html">project</a> property. It tells TaskJuggler the name of your project and a start and end date. The start and end dates don't need to be exact, but must fit all tasks of the project. It is the time interval the TaskJuggler scheduler will use to fit the tasks in. So, make it large enough for all your tasks to fit in. But don't make it too large, because this will result in longer scheduling times and higher memory consumption.</p>
     <div class="codeframe"><pre class="code">project acso "Accounting Software"  2002-01-16 +4m {

data/manual/html/account.html

@@ -1,5 +1,5 @@
 <!DOCTYPE>
-<!-- This file has been generated by tj3man v3.2.0 -->
+<!-- This file has been generated by tj3man v3.3.0 -->
 <html lang="en" xml:lang="en">
  <head>
   <title>account</title>

data/manual/html/account.task.html

@@ -1,5 +1,5 @@
 <!DOCTYPE>
-<!-- This file has been generated by tj3man v3.2.0 -->
+<!-- This file has been generated by tj3man v3.3.0 -->
 <html lang="en" xml:lang="en">
  <head>
   <title>account.task</title>

data/manual/html/accountprefix.html

@@ -1,5 +1,5 @@
 <!DOCTYPE>
-<!-- This file has been generated by tj3man v3.2.0 -->
+<!-- This file has been generated by tj3man v3.3.0 -->
 <html lang="en" xml:lang="en">
  <head>
   <title>accountprefix</title>

data/manual/html/accountreport.html

@@ -1,5 +1,5 @@
 <!DOCTYPE>
-<!-- This file has been generated by tj3man v3.2.0 -->
+<!-- This file has been generated by tj3man v3.3.0 -->
 <html lang="en" xml:lang="en">
  <head>
   <title>accountreport</title>
@@ -65,7 +65,7 @@
      <tr align="left">
       <td class="tag">Context</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>, <a href="tracereport.html">tracereport</a>
+       <a href="accountreport.html">accountreport</a>, <a href="export.html">export</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>, <a href="tracereport.html">tracereport</a>
       </td>
      </tr>
     </table></p>
@@ -78,7 +78,7 @@
       <col width="20%"></col>
      </colgroup>
      <tr align="left">
-      <td class="tag" rowspan="50">Attributes</td>
+      <td class="tag" rowspan="51">Attributes</td>
       <td class="tag">Name</td>
       <td class="tag">Scen. spec.</td>
       <td class="tag">Inh. fm. Global</td>
@@ -138,6 +138,12 @@
       <td align="center" class="descr"></td>
       <td align="center" class="descr">x</td>
      </tr>
+     <tr align="left">
+      <td align="left" class="descr"><a href="export.html">export</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="flags.report.html">flags (report)</a></td>
       <td align="center" class="descr"></td>

data/manual/html/accountroot.html

@@ -1,5 +1,5 @@
 <!DOCTYPE>
-<!-- This file has been generated by tj3man v3.2.0 -->
+<!-- This file has been generated by tj3man v3.3.0 -->
 <html lang="en" xml:lang="en">
  <head>
   <title>accountroot</title>

data/manual/html/active.html

@@ -1,5 +1,5 @@
 <!DOCTYPE>
-<!-- This file has been generated by tj3man v3.2.0 -->
+<!-- This file has been generated by tj3man v3.3.0 -->
 <html lang="en" xml:lang="en">
  <head>
   <title>active</title>

data/manual/html/adopt.task.html

@@ -1,5 +1,5 @@
 <!DOCTYPE>
-<!-- This file has been generated by tj3man v3.2.0 -->
+<!-- This file has been generated by tj3man v3.3.0 -->
 <html lang="en" xml:lang="en">
  <head>
   <title>adopt.task</title>
@@ -38,8 +38,8 @@
      <tr align="left">
       <td class="tag">Purpose</td>
       <td class="descr" colspan="2"><div>
-        <p>Add a previously defined task to the sub-tasks of this task. This can be used to create virtual sub projects that contain of task trees that were defined as sub tasks of other tasks. Adopted tasks don't inherit anything from their step parents. However, the adopting task is scheduled to fit all adopted childs as well.</p>
-        <p>A top-level tasks must never include the same task more than once.</p>
+        <p>Add a previously defined task and its sub-tasks to this task. This can be used to create virtual projects that contain task (sub-)trees that are originally defined in another task context. Adopted tasks don't inherit anything from their step parents. However, the adopting task is scheduled to fit all adopted sub-tasks.</p>
+        <p>A top-level task and all its sub-tasks must never contain the same task more than once. All reports must use appropriate filters by setting <a href="taskroot.html">taskroot</a>, <a href="hidetask.html">hidetask</a> or <a href="rolluptask.html">rolluptask</a> to ensure that no tasks are contained more than once in the report.</p>
        </div></td>
      </tr>
      <tr align="left">

data/manual/html/aggregate.html

@@ -1,5 +1,5 @@
 <!DOCTYPE>
-<!-- This file has been generated by tj3man v3.2.0 -->
+<!-- This file has been generated by tj3man v3.3.0 -->
 <html lang="en" xml:lang="en">
  <head>
   <title>aggregate</title>

data/manual/html/alert.html

@@ -1,5 +1,5 @@
 <!DOCTYPE>
-<!-- This file has been generated by tj3man v3.2.0 -->
+<!-- This file has been generated by tj3man v3.3.0 -->
 <html lang="en" xml:lang="en">
  <head>
   <title>alert</title>

data/manual/html/alertlevels.html

@@ -1,5 +1,5 @@
 <!DOCTYPE>
-<!-- This file has been generated by tj3man v3.2.0 -->
+<!-- This file has been generated by tj3man v3.3.0 -->
 <html lang="en" xml:lang="en">
  <head>
   <title>alertlevels</title>

data/manual/html/allocate.html

@@ -1,5 +1,5 @@
 <!DOCTYPE>
-<!-- This file has been generated by tj3man v3.2.0 -->
+<!-- This file has been generated by tj3man v3.3.0 -->
 <html lang="en" xml:lang="en">
  <head>
   <title>allocate</title>
@@ -36,7 +36,10 @@
      </colgroup>
      <tr align="left">
       <td class="tag">Purpose</td>
-      <td class="descr" colspan="2"><div>Specify which resources should be allocated to the task. The attributes provide numerous ways to control which resource is used and when exactly it will be assigned to the task. Shifts and limits can be used to restrict the allocation to certain time intervals or to limit them to a certain maximum per time period. The purge statement can be used to remove inherited allocations or flags.</div></td>
+      <td class="descr" colspan="2"><div>
+        <p>Specify which resources should be allocated to the task. The attributes provide numerous ways to control which resource is used and when exactly it will be assigned to the task. Shifts and limits can be used to restrict the allocation to certain time intervals or to limit them to a certain maximum per time period. The purge statement can be used to remove inherited allocations or flags.</p>
+        <p>For effort-based tasks the task duration is clipped to only extend from the begining of the first allocation to the end of the last allocation. This is done to optimize for an overall minimum project duration as dependent tasks can potentially use the unallocated, clipped slots.</p>
+       </div></td>
      </tr>
      <tr align="left">
       <td class="tag">Syntax</td>

data/manual/html/alphabet.html

@@ -1,5 +1,5 @@
 <!DOCTYPE>
-<!-- This file has been generated by tj3man v3.2.0 -->
+<!-- This file has been generated by tj3man v3.3.0 -->
 <html lang="en" xml:lang="en">
  <head>
   <title>TaskJuggler Syntax Reference Navigator</title>

data/manual/html/alternative.html

@@ -1,5 +1,5 @@
 <!DOCTYPE>
-<!-- This file has been generated by tj3man v3.2.0 -->
+<!-- This file has been generated by tj3man v3.3.0 -->
 <html lang="en" xml:lang="en">
  <head>
   <title>alternative</title>