taskjuggler 0.0.2 → 0.0.3

data/lib/reports/TaskListRE.rb

@@ -10,56 +10,48 @@
 # published by the Free Software Foundation.
 #
 
-require 'reports/ReportTableElement'
+require 'reports/TableReport'
 require 'reports/ReportTable'
 require 'TableColumnDefinition'
 require 'LogicalExpression'
 
 class TaskJuggler
 
-  # This specialization of ReportTableElement implements a task listing. It
+  # This specialization of TableReport implements a task listing. It
   # generates a list of tasks that can optionally have the allocated resources
   # nested underneath each task line.
-  class TaskListRE < ReportTableElement
+  class TaskListRE < TableReport
 
     # Create a new object and set some default values.
     def initialize(report)
       super
-      # Set the default columns for this report.
-      %w( wbs name start end effort chart ).each do |col|
-        @columns << TableColumnDefinition.new(col, defaultColumnTitle(col))
-      end
-      # Show all tasks, sorted by tree, start-up, seqno-up.
-      @hideTask = LogicalExpression.new(LogicalOperation.new(0))
-      @sortTasks = [ [ 'tree', true, -1 ],
-                     [ 'start', true, 0 ],
-                     [ 'seqno', true, -1 ] ]
-      # Show no resources, but set sorting to id-up.
-      @hideResource = LogicalExpression.new(LogicalOperation.new(1))
-      @sortResources = [ [ 'id', true, -1 ] ]
-
       @table = ReportTable.new
     end
 
     # Generate the table in the intermediate format.
     def generateIntermediateFormat
+      setReportPeriod
+
       # Prepare the task list.
       taskList = PropertyList.new(@project.tasks)
-      taskList.setSorting(@sortTasks)
-      taskList = filterTaskList(taskList, nil, @hideTask, @rollupTask)
+      taskList.setSorting(@report.get('sortTasks'))
+      taskList = filterTaskList(taskList, nil, @report.get('hideTask'),
+                                @report.get('rollupTask'))
       taskList.sort!
 
-      adjustReportPeriod(taskList, @scenarios) unless @userDefinedPeriod
-
       # Prepare the resource list.
       resourceList = PropertyList.new(@project.resources)
-      resourceList.setSorting(@sortResources)
-      resourceList = filterResourceList(resourceList, nil, @hideResource,
-          @rollupResource)
+      resourceList.setSorting(@report.get('sortResources'))
+      resourceList = filterResourceList(resourceList, nil,
+                                        @report.get('hideResource'),
+                                        @report.get('rollupResource'))
       resourceList.sort!
 
+      adjustReportPeriod(taskList, @report.get('scenarios'),
+                         @report.get('columns'))
+
       # Generate the table header.
-      @columns.each do |columnDescr|
+      @report.get('columns').each do |columnDescr|
         generateHeaderCell(columnDescr)
       end
 

data/lib/reports/TextReport.rb

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby -w
+# encoding: UTF-8
+#
+# = ReportBase.rb -- The TaskJuggler III Project Management Software
+#
+# Copyright (c) 2006, 2007, 2008, 2009 by Chris Schlaeger <cs@kde.org>
+#
+# 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 Free Software Foundation.
+#
+
+require 'reports/ReportBase'
+
+class TaskJuggler
+
+  # This is the most basic type of report. It only contains 5 RichText elements.
+  # It's got a header and footer and a central text with margin elements left
+  # and right.
+  class TextReport < ReportBase
+
+    attr_accessor :header, :left, :center, :right, :footer
+
+    def initialize(report)
+      super
+
+      @lWidth = @cWidth = @rWidth = 0
+    end
+
+    def generateIntermediateFormat
+      if a('center')
+        if a('left') && a('right')
+          @lWidth = @rWidth = 20
+          @cWidth = 60
+        elsif a('left') && !a('right')
+          @lWidth = 25
+          @cWidth = 75
+        elsif !a('left') && a('right')
+          @cWidth = 75
+          @rWidth = 25
+        else
+          @cWidth = 100
+        end
+      else
+        if a('left') && a('right')
+          @lWidth = @rWidth = 50
+        elsif a('left') && !a('right')
+          @lWidth = 100
+        elsif !a('left') && a('right')
+          @rWidth = 100
+        end
+      end
+    end
+
+    def to_html
+      html = []
+
+      html << rt_to_html('header')
+      if @lWidth > 0 || @cWidth > 0 || @rWidth > 0
+        html << (table = XMLElement.new('table', 'align' => 'center',
+                                        'cellspacing' => '1',
+                                        'cellpadding' => '2', 'width' => '100%',
+                                        'class' => 'textPageSkel'))
+        table << (tr = XMLElement.new('tr'))
+
+        %w( left center right).each do |i|
+          width = instance_variable_get('@' + i[0].chr + 'Width')
+          if width > 0
+            tr << (td = XMLElement.new('td', 'width' => "#{width}%"))
+            td << rt_to_html(i)
+          end
+        end
+
+      end
+      html << rt_to_html('footer')
+
+      html
+    end
+
+    def to_csv
+      nil
+    end
+
+  end
+
+end
+

data/lib/reports/TjpExportRE.rb

@@ -10,40 +10,35 @@
 # published by the Free Software Foundation.
 #
 
-require 'reports/ReportElement'
+require 'reports/ReportBase'
 
 class TaskJuggler
 
-  # This specialization of ReportTableElement implements an export of the
+  # This specialization of ReportBase implements an export of the
   # project data in the TJP syntax format.
-  class TjpExportRE < ReportElement
+  class TjpExportRE < ReportBase
 
-    attr_writer :resourceAttrs, :taskAttrs
     attr_reader :mainFile
 
     # Create a new object and set some default values.
-    def initialize(report, mainFile)
+    def initialize(report)
       super(report)
 
       # Indicates whether this is a full .tjp file or just an .tji include file.
-      @mainFile = mainFile
+      @mainFile = a('name')[-4, 4] != '.tji'
 
       @supportedTaskAttrs = %w( booking complete depends flags maxend
                                 maxstart minend minstart note priority
                                 responsible )
       @supportedResourceAttrs = %w( vacation workinghours )
-      @taskAttrs = %w( all )
-      @resourceAttrs = %w( all )
-      @scenarios = [ 0 ]
+      @report.set('scenarios', [ 0 ])
 
       # Show all tasks, sorted by seqno-up.
-      @hideTask =
-        LogicalExpression.new(LogicalOperation.new(0))
-      @sortTasks = [ [ 'seqno', true, -1 ] ]
+      @report.set('hideTask', LogicalExpression.new(LogicalOperation.new(0)))
+      @report.set('sortTasks', [ [ 'seqno', true, -1 ] ])
       # Show all resources, sorted by seqno-up.
-      @hideResource =
-        LogicalExpression.new(LogicalOperation.new(0))
-      @sortResources = [ [ 'seqno', true, -1 ] ]
+      @report.set('hideResource', LogicalExpression.new(LogicalOperation.new(0)))
+      @report.set('sortResources', [ [ 'seqno', true, -1 ] ])
     end
 
     # There is nothing to do here.
@@ -54,29 +49,30 @@ class TaskJuggler
     def to_tjp
       # Prepare the resource list.
       @resourceList = PropertyList.new(@project.resources)
-      @resourceList.setSorting(@sortResources)
-      @resourceList = filterResourceList(@resourceList, nil, @hideResource,
-          @rollupResource)
+      @resourceList.setSorting(a('sortResources'))
+      @resourceList = filterResourceList(@resourceList, nil, a('hideResource'),
+                                         a('rollupResource'))
       @resourceList.sort!
 
       # Prepare the task list.
       @taskList = PropertyList.new(@project.tasks)
-      @taskList.setSorting(@sortTasks)
-      @taskList = filterTaskList(@taskList, nil, @hideTask, @rollupTask)
+      @taskList.setSorting(a('sortTasks'))
+      @taskList = filterTaskList(@taskList, nil, a('hideTask'), a('rollupTask'))
       @taskList.sort!
 
       getBookings
 
       @file = ''
 
-      if @mainFile
-        generateProjectProperty
-        generateFlagDeclaration
-        generateResourceList
-        generateTaskList
-      end
-      generateTaskAttributes unless @taskAttrs.empty?
-      generateResourceAttributes unless @resourceAttrs.empty?
+      generateProjectProperty if @mainFile
+
+      generateFlagDeclaration if a('definitions').include?('flags')
+      generateProjectIDs if a('definitions').include?('projectids')
+      generateResourceList if a('definitions').include?('resources')
+      generateTaskList if a('definitions').include?('tasks')
+
+      generateTaskAttributes unless a('taskAttributes').empty?
+      generateResourceAttributes unless a('resourceAttributes').empty?
 
       @file
     end
@@ -88,8 +84,9 @@ class TaskJuggler
                "\"#{@project['version']}\" #{@project['start']} - " +
                "#{@project['end']} {\n"
       generateCustomAttributeDeclarations('resource', @project.resources,
-                                          @resourceAttrs)
-      generateCustomAttributeDeclarations('task', @project.tasks, @taskAttrs)
+                                          a('resourceAttributes'))
+      generateCustomAttributeDeclarations('task', @project.tasks,
+                                          a('taskAttributes'))
       @file << "}\n\n"
     end
 
@@ -107,8 +104,7 @@ class TaskJuggler
       # taskAttributes list.
       @file << '  extend ' + tag + "{\n"
         propertySet.eachAttributeDefinition do |ad|
-          next unless ad.userDefined &&
-                      (attributes.include?(ad.id) || attributes.include?('all'))
+          next unless ad.userDefined && attributes.include?(ad.id)
 
           @file << "    #{ad.objClass.tjpId} #{ad.id} \"#{ad.name}\"\n"
         end
@@ -121,7 +117,7 @@ class TaskJuggler
       properties = @resourceList + @taskList
 
       properties.each do |property|
-        @scenarios.each do |scenarioIdx|
+        a('scenarios').each do |scenarioIdx|
           property['flags', scenarioIdx].each do |flag|
             flags << flag unless flags.include?(flag)
           end
@@ -133,6 +129,19 @@ class TaskJuggler
       end
     end
 
+    def generateProjectIDs
+      # Compile a list of all projectIDs from the tasks in the taskList.
+      projectIDs = []
+      a('scenarios').each do |scenarioIdx|
+        @taskList.each do |task|
+          pid = task['projectid', scenarioIdx]
+          projectIDs << pid unless projectIDs.include?(pid)
+        end
+      end
+
+      @file << "projectids #{projectIDs.join(', ')}\n\n"
+    end
+
     def generateResourceList
       # The resource definitions are generated recursively. So we only need to
       # start it for the top-level resources.
@@ -181,8 +190,8 @@ class TaskJuggler
 
       @file << ' ' * indent + "task #{task.id} \"#{task.name}\" {\n"
 
-      if @taskAttrs.include?('depends') || @taskAttrs.include?('all')
-        @scenarios.each do |scenarioIdx|
+      if a('taskAttributes').include?('depends')
+        a('scenarios').each do |scenarioIdx|
           generateTaskDependency(scenarioIdx, task, 'depends', indent + 2)
           generateTaskDependency(scenarioIdx, task, 'precedes', indent + 2)
         end
@@ -208,7 +217,7 @@ class TaskJuggler
 
       # For leaf tasks we put some attributes right here.
       if isLeafTask
-        @scenarios.each do |scenarioIdx|
+        a('scenarios').each do |scenarioIdx|
           generateAttribute(task, 'start', indent + 2, scenarioIdx)
           unless task['milestone', scenarioIdx]
             generateAttribute(task, 'end', indent + 2, scenarioIdx)
@@ -231,7 +240,7 @@ class TaskJuggler
 
     # Generate 'depends' or 'precedes' attributes for a task.
     def generateTaskDependency(scenarioIdx, task, tag, indent)
-      return unless @taskAttrs.include?('depends') || !@taskAttrs.include?('all')
+      return unless a('taskAttributes').include?('depends')
 
       taskDeps = task[tag, scenarioIdx]
       unless taskDeps.empty?
@@ -261,11 +270,10 @@ class TaskJuggler
           attr = resource.getAttr(id)
           next if (!@supportedResourceAttrs.include?(id) &&
                    ! attrDef.userDefined) ||
-                  (!@resourceAttrs.include?('all') &&
-                   !@resourceAttrs.include?(id))
+                   !a('resourceAttributes').include?(id)
 
           if attrDef.scenarioSpecific
-            @scenarios.each do |scenarioIdx|
+            a('scenarios').each do |scenarioIdx|
               generateAttribute(resource, id, 2, scenarioIdx)
             end
           else
@@ -289,10 +297,10 @@ class TaskJuggler
           attr = task.getAttr(id)
           next if (!@supportedTaskAttrs.include?(id) &&
                    ! attrDef.userDefined) ||
-                  (!@taskAttrs.include?('all') && !@taskAttrs.include?(id))
+                  !a('taskAttributes').include?(id)
 
           if attrDef.scenarioSpecific
-            @scenarios.each do |scenarioIdx|
+            a('scenarios').each do |scenarioIdx|
               # Some attributes need special treatment.
               case id
               when 'depends'
@@ -313,11 +321,9 @@ class TaskJuggler
     end
 
     def generateAttribute(property, attrId, indent, scenarioIdx = nil)
-      if scenarioIdx.nil?
-        return if property.getAttr(attrId).nil?
-      else
-        return if property[attrId, scenarioIdx].nil?
-      end
+      val = scenarioIdx.nil? ? property.getAttr(attrId) :
+                               property[attrId, scenarioIdx]
+      return if val.nil? || (val.is_a?(Array) && val.empty?)
 
       generateAttributeText(property.getAttr(attrId, scenarioIdx).to_tjp,
                             indent, scenarioIdx)
@@ -337,9 +343,8 @@ class TaskJuggler
     # report.
     def getBookings
       @bookings = {}
-      if @taskAttrs.include?('booking') ||
-         @taskAttrs.include?('all')
-        @scenarios.each do |scenarioIdx|
+      if a('taskAttributes').include?('booking')
+        a('scenarios').each do |scenarioIdx|
           @bookings[scenarioIdx] = {}
           @resourceList.each do |resource|
             # Get the bookings for this resource hashed by task.

data/lib/taskjuggler3.rb

@@ -44,6 +44,10 @@ def processArguments(argv)
           'Generate reports despite scheduling errors') do
     @forceReports = true
   end
+  opts.on('-o', '--output-dir <directory>', String,
+          'Directory the reports should go into') do |arg|
+    @outputDir = arg + '/'
+  end
   opts.on('-c N', Integer, 'Maximum number of CPU cores to use') do |arg|
     @maxCpuCores = arg
   end
@@ -88,6 +92,7 @@ end
 def main
   @maxCpuCores = 1
   @forceReports = false
+  @outputDir = ''
 
   errors = false
   tj = TaskJuggler.new(files = processArguments(ARGV))
@@ -97,7 +102,7 @@ def main
     errors = true
     exit 1 unless @forceReports
   end
-  exit 1 if !tj.generateReports || errors
+  exit 1 if !tj.generateReports(@outputDir) || errors
 
 end
 

data/manual/Getting_Started

@@ -22,7 +22,7 @@ to ask TaskJuggler to process it.
 
 TaskJuggler will try to schedule all tasks with the specified
 conditions and generate the reports that were requested with the
-[[htmltaskreport]], [[htmlresourcereport]] or other report properties
+[[taskreport]], [[resourcereport]] or other report properties
 in the input file. The report files will be generated in the current
 directory or relative to it.
 
@@ -34,7 +34,7 @@ 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]] 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.
 
@@ -42,9 +42,9 @@ 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]] and [[task tasks]]. Each project
-must have at least one task defined and should have at least one
-[[reports report]].  Properties don't have to be listed in a
+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
 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
@@ -57,5 +57,56 @@ define them in the following sequence.
 * [[vacation vacations]]
 * [[resource resources]]
 * [[task tasks]]
-* [[reports]]
+* [[report reports]]
+* [[export exports]]
+
+=== Types of variable Syntax Elements ===
+
+==== ABSOLUTE_ID ====
+
+An absolute identifier is composed of identifiers that are
+concatenated by dots, e. g. ''''foo.bar''''. It is used to reference
+a TaskJuggler property that lives in a hierarchical name space.
+Accounts, Tasks, Reports are examples for such hierarchical name
+spaces. To reference the sub-task ''''bar'''' of task ''''foo'''' the
+absolute ID ''''foo.bar'''' is used.
+
+==== ID ====
+
+An identifier is composed of the letters ''''a'''' to ''''z'''',
+''''A'''' to ''''Z'''', the underscore and the digits ''''0'''' to
+''''9''''. There are no limits for the number of characters, but it
+may not begin with a digit.
+
+==== INTEGER ====
+
+An integer is any natural number, e. g. ''''0'''', ''''1'''',
+''''2'''' and so on.
+
+==== STRING ====
+
+Strings are character sequences that are enclosed by special
+character marks. There are three different marks supported. For
+short strings that fit on one lines, you can either use single or
+double quotes.
+
+ 'This is a single quoted string.'
+ "This is a double quoted string."
+
+Single quoted strings may contain double quotes and vice versa.
+
+For multi-line strings cut mark strings are recommended. A
+cut-mark-string starts with ''''-8<-'''' (scissor on 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.
+
+ -8<-
+   This is a
+   multi-line
+   string.
+   ->8-
+
 

data/manual/How_To_Contribute

@@ -127,8 +127,7 @@ create the patch or patch-set.
 
 This will generate a number of files starting with 5-digit file names.
 You then need to attach these files to a posting in the
-[http://www.taskjuggler.org/FUDforum2/index.php?t=thread&frm_id=5
-TaskJuggler Developer Forum].
+[http://www.taskjuggler.org/forum.php TaskJuggler Developer Forum].
 
 ==== Contributing to the User Manual ====
 
@@ -172,8 +171,7 @@ should be documented in the [[TaskJuggler_2x_Migration]] section.
 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
-[http://www.taskjuggler.org/FUDforum2/index.php?t=thread&frm_id=5
-TaskJuggler Developer Forum].
+[http://www.taskjuggler.org/forum.php TaskJuggler Developer Forum].
 
 ==== Some final words to Contributors ====
 

data/manual/Intro

@@ -50,7 +50,7 @@ first impression, you can look at this
 [http://www.taskjuggler.org/tj3/examples/tutorial.tjp project file]. The
 project description is fairly intuitive, but very powerful as well.
 The [[Tutorial]] will explain this file line by line. Please look at
-the [http://www.taskjuggler.org/tj3/examples/ProjectPlanOverview.html
+the [http://www.taskjuggler.org/tj3/examples/Overview.html
 resulting reports] that visualize the project.
 
 
@@ -97,6 +97,6 @@ The official TaskJuggler web site can be found at
 [http://www.taskjuggler.org].
 
 Since the developers are mostly busy project managers themselves, we
-have created a [http://www.taskjuggler.org/FUDforum2 forum] for users
+have created a [http://www.taskjuggler.org/forum.php forum] for users
 to help each other.
 

data/manual/Reporting_Bugs

@@ -10,7 +10,10 @@ find a bug, please follow this procedure:
 feature.
 
 * Check the [http://www.taskjuggler.org TaskJuggler web page] and the
-[http://www.taskjuggler.org/FUDforum2 Discussion Forum].
+[http://www.taskjuggler.org/forum.php discussion groups]. In
+particular, you should check the
+[http://groups.google.com/group/taskjuggler-bugs/topics existing bug
+reports].
 
 * Possibly the bug was already found
 and a patch or workaround exists.
@@ -18,8 +21,12 @@ and a patch or workaround exists.
 * Try to create a test project that is as small as possible but still
 reproduces the bug.
 
+* If TaskJuggler has crashed you will usually get some debug output. This
+may not make any sense to you but it is vital information to analyze
+the bug. Please include it completely in your bug report.
+
 * Send the test project and a detailed description of the problem to
-the [http://www.taskjuggler.org/FUDforum2 TaskJuggler Developer
+the [http://www.taskjuggler.org/forum.php TaskJuggler Developer
 Forum].  Not sending a test project is the most common mistake when
 reporting bugs. This usually triggers requests or leads to bug reports
 being ignored.

data/manual/Rich_Text_Attributes

@@ -88,3 +88,44 @@ in nowiki tags.
 
  <nowiki> This is not '''bold''' text. </nowiki>
 
+==== Block and Inline Generators ====
+
+Block and inline generators are a very powerful extension that allow
+you to insert arbitrarily complex content. Block generators create a
+text block whereas inline generators generate an element that fits
+inside a text paragraph.
+
+Block generators use the following syntax:
+
+ <[generator_name parameter1="value1" ... ]>
+
+Inline generators have a very similar syntax:
+
+ <-generator_name parameter1="value1" ... ->
+
+Each generator is identified by a name. See the following list for
+supported generators and their functionality. Generators can have one or
+more optional parameters. Some parameters are mandatory, other are
+optional. The value of a parameter must be enclosed in single or
+double quotes. Since your rich text content must already be enclosed
+by double or single quotes, make sure you don't use the same quoting
+marks for the parameter value. Alternatively you can put a backslash
+in front of the quote mark to escape it.
+
+'''Block Generator''' ''''navigator''''
+
+Parameters:
+
+* id : ID of a defined [[navigator]]
+
+''The navigator generator inserts the referenced navigator.''
+
+'''Block Generator''' ''''report''''
+
+Paramters:
+
+* 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
+report period and the property set from the referencing report.''