taskjuggler 0.2.2 → 3.0.0

data/lib/taskjuggler/reports/NikuReport.rb

@@ -176,20 +176,23 @@ EOT
                                     'name' => prj.name,
                                     'projectID' => prj.id))
         project << (resources = XMLElement.new('Resources'))
-        prj.resources.keys.sort.each do |resourceId|
-          res = prj.resources[resourceId]
+        # We iterate over all resources to ensure that all have an entry in
+        # the Clarity database for all projects. This is done to work around a
+        # limitation of Clarity with respect to filling time sheets with
+        # assigned projects.
+        @resources.keys.sort.each do |clarityRID|
           resources << (resource =
                         XMLElement.new('Resource',
-                                       'resourceID' => res.id,
+                                       'resourceID' => clarityRID,
                                        'defaultAllocation' => '0'))
           resource << (allocCurve = XMLElement.new('AllocCurve'))
+          sum = sum(prj.id, clarityRID)
           allocCurve << (XMLElement.new('Segment',
                                         'start' =>
                                         a('start').to_s(timeFormat),
                                         'finish' =>
                                         (a('end') - 1).to_s(timeFormat),
-                                        'sum' => numberFormat.format(
-                                          sum(prj.id, res.id)).to_s))
+                                        'sum' => numberFormat.format(sum).to_s))
         end
 
         # The custom information section usually contains Clarity installation

data/lib/taskjuggler/reports/Report.rb

@@ -44,6 +44,7 @@ class TaskJuggler
     # Create a new report object.
     def initialize(project, id, name, parent)
       super(project.reports, id, name, parent)
+      checkFileName(name)
       project.addReport(self)
 
       # The type specifier must be set for every report. It tells whether this
@@ -178,7 +179,7 @@ class TaskJuggler
       end
 
       html = HTMLDocument.new(:strict)
-      head = html.generateHead("TaskJuggler Report - #{@name}",
+      head = html.generateHead(@project['name'] + " - #{get('title') || @name}",
                                'description' => 'TaskJuggler Report',
                                'keywords' => 'taskjuggler, project, management')
       if a('selfcontained')
@@ -406,6 +407,14 @@ EOT
            )
     end
 
+    def checkFileName(name)
+      if name =~ /[\\?%*:|"<>]/
+        error('invalid_file_name',
+              'File names may not contain any of the following characters: ' +
+              '\?%*:|\"<>')
+      end
+    end
+
   end
 
 end

data/lib/taskjuggler/reports/ReportTableCell.rb

@@ -356,7 +356,7 @@ class TaskJuggler
         title = ''
       end
       trigger['onclick'] = "TagToTip('ID#{trigger.object_id}', " +
-                           "TITLE, '#{title}')"
+                           "TITLE, '#{title.gsub(/'/, ''')}')"
       trigger['style'] = trigger['style'] ? trigger['style'] : 'cursor:help; '
       hook << (ltDiv = XMLElement.new('div',
                                       'class' => 'tj_tooltip_box',

data/lib/taskjuggler/reports/ResourceListRE.rb

@@ -38,11 +38,11 @@ class TaskJuggler
       # Prepare the resource list.
       resourceList = PropertyList.new(@project.resources)
       resourceList.setSorting(@report.get('sortResources'))
+      resourceList.query = @report.project.reportContexts.last.query
       resourceList = filterResourceList(resourceList, nil,
                                         @report.get('hideResource'),
                                         @report.get('rollupResource'),
                                         @report.get('openNodes'))
-      resourceList.query = @report.project.reportContexts.last.query
       resourceList.sort!
 
       # Prepare the task list. Don't filter it yet! It would break the

data/lib/taskjuggler/reports/TableReport.rb

@@ -509,7 +509,7 @@ class TaskJuggler
           end
           column.cell2.text = t.send(name2Func).to_s
           # TODO: The width should be taken from some data structure.
-          column.cell2.width = 20
+          column.cell2.width = 28
           # Off-duty cells will have a different color than working time cells.
           unless @project.hasWorkingTime(iv)
             column.cell2.category = 'tabhead_offduty'

data/lib/taskjuggler/reports/TaskListRE.rb

@@ -38,10 +38,10 @@ class TaskJuggler
       # Prepare the task list.
       taskList = PropertyList.new(@project.tasks)
       taskList.setSorting(@report.get('sortTasks'))
+      taskList.query = @report.project.reportContexts.last.query
       taskList = filterTaskList(taskList, nil, @report.get('hideTask'),
                                 @report.get('rollupTask'),
                                 @report.get('openNodes'))
-      taskList.query = @report.project.reportContexts.last.query
       taskList.sort!
 
       # Prepare the resource list. Don't filter it yet! It would break the

data/lib/taskjuggler/reports/TjpExportRE.rb

@@ -26,7 +26,7 @@ class TaskJuggler
       @supportedTaskAttrs = %w( booking complete depends flags maxend
                                 maxstart minend minstart note priority
                                 projectid responsible )
-      @supportedResourceAttrs = %w( booking flags vacation workinghours )
+      @supportedResourceAttrs = %w( booking flags shifts vacation workinghours )
     end
 
     def generateIntermediateFormat
@@ -57,6 +57,9 @@ class TaskJuggler
 
       generateFlagDeclaration if a('definitions').include?('flags')
       generateProjectIDs if a('definitions').include?('projectids')
+
+      generateShiftList if a('definitions').include?('shifts')
+
       generateResourceList if a('definitions').include?('resources')
       generateTaskList if a('definitions').include?('tasks')
 
@@ -72,6 +75,11 @@ class TaskJuggler
       @file << "project #{@project['projectid']} \"#{@project['name']}\" " +
                "\"#{@project['version']}\" #{@project['start']} - " +
                "#{@project['end']} {\n"
+      # Add timingresolution attribute if it's not the default value.
+      if @project['scheduleGranularity'] != 3600
+        generateAttributeText("timingresolution " +
+                              "#{@project['scheduleGranularity'] / 60}min", 2)
+      end
       generateAttributeText("timezone \"#{@project['timezone']}\"", 2)
       generateCustomAttributeDeclarations('resource', @project.resources,
                                           a('resourceAttributes'))
@@ -146,6 +154,28 @@ class TaskJuggler
       @file << "projectids #{projectIDs.join(', ')}\n\n" unless projectIDs.empty?
     end
 
+    def generateShiftList
+      @project.shifts.each do |shift|
+        generateShift(shift, 0) unless shift.parent
+      end
+    end
+
+    def generateShift(shift, indent)
+      @file << ' ' * indent + "shift #{shift.id} " +
+               "#{quotedString(shift.name)} {\n"
+
+      a('scenarios').each do |scenarioIdx|
+        generateAttribute(shift, 'workinghours', indent + 2, scenarioIdx)
+      end
+
+      # Call this method recursively for all children.
+      shift.children.each do |subshift|
+        generateShift(subshift, indent + 2)
+      end
+
+      @file << ' ' * indent + "}\n"
+    end
+
     def generateResourceList
       # The resource definitions are generated recursively. So we only need to
       # start it for the top-level resources.

data/manual/Installation

@@ -63,6 +63,8 @@ been tested.
 
 ==== The easy way ====
 
+===== System Wide Installation =====
+
 TaskJuggler is a commandline tool. It does not (yet) have a graphical
 user interface. To use it, you need to know how to open a command
 or terminal window. In this manual, we refer to it as your shell. The
@@ -70,14 +72,55 @@ following paragraphs describe the commands you need to type into your
 [http://en.wikipedia.org/wiki/Shell_(computing) shell].
 
 On systems that already have Ruby and the gem package manager
-installed you can simply type the following command into your shell
-or command window:
+installed you can simply type the following command as root or admin
+user into your shell or command window:
 
   gem install taskjuggler
 
 This will download and install the latest version from the
 [http://rubygems.org/gems/taskjuggler RubyGems.org] site.
 
+===== Installation into a local Directory =====
+
+If you don't want to install TaskJuggler for all users on the system,
+you can also install it into your home or data directory. This does
+not require root or admin permissions.
+
+The following steps are describe the installation on a Linux system
+with the bash shell. You may have to use slightly different commands
+on a different operating system.
+
+Create a new directory ''''taskjuggler'''' in your $HOME directory for
+the installation to go into.
+
+  mkdir taskjuggler
+
+Install the gem and all dependencies.
+
+  gem install --install-dir taskjuggler taskjuggler-X.X.X.gem
+
+If you must use a proxy to access the Internet, you need to set a
+shell environment variable so ''''gem'''' can find and use it. The
+setting below needs to be adapted to your local environment. Check
+with your admin or IT department if needed.
+
+  export HTTP_PROXY=http://%USER%:%PASSWORD%@%SERVER%:%PORT%
+
+Configure your ''''PATH'''' variable to find the taskjuggler programs.
+
+  export PATH="${PATH}:${HOME}/taskjuggler/bin"
+
+Configure gem to find the installed files.
+
+  export GEM_HOME=${HOME}/taskjuggler
+
+The last two settings should also be added to your .profile file to
+make them permanent.
+
+That's it. You now should be run TaskJuggler.
+
+  tj3 --version
+
 ==== The manual way ====
 
 If the easy way doesn't work for you, you need to download and install
@@ -158,11 +201,6 @@ from source put the following code in your ''''.profile'''' file.
 This is for users of the bash shell. Adapt it accordingly if you use
 another shell. 
 
- # To use TaskJuggler directly from the source. This must point to
- # the directory where you have put the TaskJuggler source files.
- TASKJUGGLER_DIR=${HOME}/src/taskjuggler3
- # Make sure Ruby finds the program files
- export RUBYLIB=${TASKJUGGLER_DIR}/lib
  # Make sure the shell finds the TaskJuggler programs
  export PATH=${PATH}:${TASKJUGGLER_DIR}/bin
 
@@ -257,6 +295,14 @@ install the TaskJuggler gem as well.
 
   sudo gem19 install taskjuggler
 
+The TaskJuggler front-end scripts always use the ''''ruby''''
+interpreter that's the first in the PATH. You need to set a link in
+your local ''''bin'''' directory to point to your ''''ruby19''''
+executable as ''''ruby''''. Make sure your ''''${HOME}/bin''''
+directory is the first directory in the ''''PATH''''.
+
+  ln -s /usr/local/bin/ruby19 ${HOME}/bin/ruby
+
 That's it. You now have the latest Ruby installed and are ready to
 use TaskJuggler.
 

data/manual/Intro

@@ -5,21 +5,22 @@
 TaskJuggler is a modern and powerful project management tool. Its new
 approach to project planning and tracking is far superior to the
 commonly used Gantt chart editing tools. It has already been
-successfully used in many projects and scales easily to projects with
+successfully used in many projects and scales to projects with
 hundreds of resources and thousands of tasks.
 
 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. It assists you during
-project scoping, resource assignment, cost and revenue planning, risk
-and communication management.
+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.
 
 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 consistency checker offload you from having to
+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. Its flexible "as many details as necessary"-approach
+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.
@@ -28,22 +29,14 @@ 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 takes some effort to master its power, but it
-will become a companion you don't want to miss anymore.
-
-=== About TaskJuggler III ===
-
-TaskJuggler III is the completely re-implemented version of the TaskJuggler
-2.x series. We have not yet released a stable version. It already is
-mostly stable and each official release is installed by more than a
-1000 users.  The code base is still in active development and the
-quality and reliability may change daily. You are welcome to try it
-and play with it, but be sure to independently check all results.
+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.
 
 TaskJuggler is a commandline tool that you use from a
-[http://en.wikipedia.org/wiki/Shell_(computing) shell]. This does not
-mean that you don't get fancy looking Gantt-charts. It just means
-that for entering your project data you will use one of the most
+[http://en.wikipedia.org/wiki/Shell_(computing) shell]. This means
+that to enter your project data you will use one of the most
 versatile and powerful tools there is: your favorite
 [http://en.wikipedia.org/wiki/Text_editor text editor]. To get a
 first impression, you can look at this
@@ -84,22 +77,37 @@ License].
 
 === Features and Highlights ===
 
-* Manages tasks, resources, costs and revenue in one package
+* Manages tasks, resources and accounts of your project
 * Automatic resource leveling and tasks conflict resolution
+* Comprehensive and flexible reports so you can find the information you need when you need it
+* Project tracking and status reporting with dashboard support
+* Time and status sheet reporting infrastructure
+* Unlimited number of scenarios (baselines) of the same project for what-if analysis
+* Projects can be combined to larger projects
+* Project breakdown and management team support
+* Multiple project managers can work on the same project
 * Flexible working hours and vacation handling
-* Multiple timezone support
 * Support for shift working
-* Project tracking and status reporting
-* Server based time sheet system for status and actual collection
+* Multiple time zone support
+* Tasks may have initial costs, finishing costs
+* Resources may have running costs
 * Unlimited number of scenarios (baselines) of same project for what-if
 analysis
-* CSV data export for exchange with popular office software
 * Support for profit/loss analysis
-* Built-in web server for dynamically generated reports
-* Project breakdown and management team support
+* HTML reports for Web publishing
+* CSV data export for exchange with popular office software
+* iCalendar export for data exchange with calendar applications
+* Project description syntax with macro support
+* Built-in web server for dynamic and interactive reports
 * Powerful and flexible filtering functions to provide the right
 amount of detail to the right audience
-* Project description syntax with macro support
+* Server based time sheet system for status and actual collection
+* Powerful project description syntax with macro support
+* Support for central resource allocation database
+* Scales well on multi-core or multi-CPU systems
+* Full integration with Vim text editor
+* Runs on all Linux, Unix, Windows, MacOS and several other operating systems
+* Simple installation
 * Detailed reference manual
 * Support for project management teams and revision control
 

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 v0.2.2 -->
+<!-- This file has been generated by tj3man v3.0.0 -->
 <html lang="en" xml:lang="en" xmlns="http://www.w3.org/1999/xhtml">
  <head>
   <title>Day_To_Day_Juggling</title>

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 v0.2.2 -->
+<!-- This file has been generated by tj3man v3.0.0 -->
 <html lang="en" xml:lang="en" xmlns="http://www.w3.org/1999/xhtml">
  <head>
   <title>Getting_Started</title>

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 v0.2.2 -->
+<!-- This file has been generated by tj3man v3.0.0 -->
 <html lang="en" xml:lang="en" xmlns="http://www.w3.org/1999/xhtml">
  <head>
   <title>How_To_Contribute</title>

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 v0.2.2 -->
+<!-- This file has been generated by tj3man v3.0.0 -->
 <html lang="en" xml:lang="en" xmlns="http://www.w3.org/1999/xhtml">
  <head>
   <title>Installation</title>
@@ -46,11 +46,34 @@
     <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>
+    <h4 class="manual" id="System_Wide_Installation">2.2.1.1 System Wide Installation</h4>
     <p class="manual">TaskJuggler is a commandline tool. It does not (yet) have a graphical user interface. To use it, you need to know how to open a command or terminal window. In this manual, we refer to it as your shell. The following paragraphs describe the commands you need to type into your <a href="http://en.wikipedia.org/wiki/Shell_(computing)" target="_top">shell</a>.</p>
-    <p class="manual">On systems that already have Ruby and the gem package manager installed you can simply type the following command into your shell or command window:</p>
+    <p class="manual">On systems that already have Ruby and the gem package manager installed you can simply type the following command as root or admin user into your shell or command window:</p>
     <div class="manual" codesection="1"><pre class="manual" codesection="1"> gem install taskjuggler
 </pre></div>
     <p class="manual">This will download and install the latest version from the <a href="http://rubygems.org/gems/taskjuggler" target="_top">RubyGems.org</a> site.</p>
+    <h4 class="manual" id="Installation_into_a_local_Directory">2.2.1.2 Installation into a local Directory</h4>
+    <p class="manual">If you don't want to install TaskJuggler for all users on the system, you can also install it into your home or data directory. This does not require root or admin permissions.</p>
+    <p class="manual">The following steps are describe the installation on a Linux system with the bash shell. You may have to use slightly different commands on a different operating system.</p>
+    <p class="manual">Create a new directory <code class="manual">taskjuggler</code> in your $HOME directory for the installation to go into.</p>
+    <div class="manual" codesection="1"><pre class="manual" codesection="1"> mkdir taskjuggler
+</pre></div>
+    <p class="manual">Install the gem and all dependencies.</p>
+    <div class="manual" codesection="1"><pre class="manual" codesection="1"> gem install --install-dir taskjuggler taskjuggler-X.X.X.gem
+</pre></div>
+    <p class="manual">If you must use a proxy to access the Internet, you need to set a shell environment variable so <code class="manual">gem</code> can find and use it. The setting below needs to be adapted to your local environment. Check with your admin or IT department if needed.</p>
+    <div class="manual" codesection="1"><pre class="manual" codesection="1"> export HTTP_PROXY=http://%USER%:%PASSWORD%@%SERVER%:%PORT%
+</pre></div>
+    <p class="manual">Configure your <code class="manual">PATH</code> variable to find the taskjuggler programs.</p>
+    <div class="manual" codesection="1"><pre class="manual" codesection="1"> export PATH="${PATH}:${HOME}/taskjuggler/bin"
+</pre></div>
+    <p class="manual">Configure gem to find the installed files.</p>
+    <div class="manual" codesection="1"><pre class="manual" codesection="1"> export GEM_HOME=${HOME}/taskjuggler
+</pre></div>
+    <p class="manual">The last two settings should also be added to your .profile file to make them permanent.</p>
+    <p class="manual">That's it. You now should be run TaskJuggler.</p>
+    <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">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>
@@ -81,12 +104,7 @@
     <div class="manual" codesection="1"><pre class="manual" codesection="1">cd taskjuggler3; rake gem
 </pre></div>
     <p class="manual">If you plan to modify the TaskJuggler files, creating and installing the gem file for every test run is not very comfortable. To run tj3 from source put the following code in your <code class="manual">.profile</code> file. This is for users of the bash shell. Adapt it accordingly if you use another shell.</p>
-    <div class="manual" codesection="1"><pre class="manual" codesection="1"># To use TaskJuggler directly from the source. This must point to
-# the directory where you have put the TaskJuggler source files.
-TASKJUGGLER_DIR=${HOME}/src/taskjuggler3
-# Make sure Ruby finds the program files
-export RUBYLIB=${TASKJUGGLER_DIR}/lib
-# Make sure the shell finds the TaskJuggler programs
+    <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>
@@ -127,6 +145,9 @@ export PATH=${PATH}:${TASKJUGGLER_DIR}/bin
 </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
+</pre></div>
+    <p class="manual">The TaskJuggler front-end scripts always use the <code class="manual">ruby</code> interpreter that's the first in the PATH. You need to set a link in your local <code class="manual">bin</code> directory to point to your <code class="manual">ruby19</code> executable as <code class="manual">ruby</code>. Make sure your <code class="manual">${HOME}/bin</code> directory is the first directory in the <code class="manual">PATH</code>.</p>
+    <div class="manual" codesection="1"><pre class="manual" codesection="1"> ln -s /usr/local/bin/ruby19 ${HOME}/bin/ruby
 </pre></div>
     <p class="manual">That's it. You now have the latest Ruby installed and are ready to use TaskJuggler.</p>
     <h2 class="manual" id="Installing_the_Vim_Support">2.7 Installing the Vim Support</h2>