taskjuggler 3.0.0 → 3.1.0

data/test/TestSuite/ReportGenerator/Correct/refs/FTE-1.csv

@@ -1,4 +1,4 @@
-"Name";""
+"Name";"FTE"
 "Team";1.5
 "  A";0.5
 "  B";1.0

data/test/TestSuite/Scheduler/Correct/Allocate.tjp

@@ -95,8 +95,8 @@ task inheritedAllocs "Inherited Allocations" {
 
 task allocShift "Allocation Shift" {
   effort 10d
-  allocate r3 { shift mowefr 2007-09-01 +1w },
-           r4 { shift tuthsa 2007-09-01 +1w }
+  allocate r3 { shifts mowefr 2007-09-01 +1w },
+           r4 { shifts tuthsa 2007-09-01 +1w }
   ${Fixend "2007-09-11-14:00"}
 }
 

data/test/TestSuite/Scheduler/Correct/Shift2.tjp

@@ -3,7 +3,7 @@ project "Shift2" 2010-02-06 +1w
 include "checks.tji"
 
 shift s2 "s2" {
-  replace 
+  replace
   workinghours mon - fri 8:00 - 16:00
 }
 
@@ -29,7 +29,7 @@ task "T1" {
 }
 
 resource r2 "r2" {
-  shift s2 2010-02-08 +1w
+  shifts s2 2010-02-08 +1w
 }
 
 task "T2" {
@@ -39,7 +39,7 @@ task "T2" {
 }
 
 resource r3 "r3" {
-  shift s3 2010-02-08 +1w
+  shifts s3 2010-02-08 +1w
 }
 
 task "T3" {
@@ -49,7 +49,7 @@ task "T3" {
 }
 
 resource r4 "r4" {
-  shift s4 2010-02-08 +1w
+  shifts s4 2010-02-08 +1w
 }
 
 task "T4" {

data/test/TestSuite/Syntax/Correct/Account.tjp

@@ -6,9 +6,12 @@ project simple "Simple Project" "1.0" 2007-01-01 - 2007-01-30 {
 # *** EXAMPLE: 1 +
 account project_cost "Project Costs"
 account payments "Customer Payments"{
-  credit 2007-01-08 "Customer down payment" 500.0
+  credits 2007-01-01 "Customer down payment" 500.0,
+          2007-01-14 "1st rate" 2000.0
 }
 
+balance project_cost payments
+
 resource tux "Tux" {
   rate 300
 }
@@ -19,11 +22,11 @@ resource konqui "Konqui" {
 task items "Room decoration" {
   start 2007-01-06
   # The default account for all tasks
-  account project_cost
+  chargeset project_cost
 
   task plan "Plan work and buy material" {
     # Upfront material cost
-    startcredit 500.0
+    charge 500.0 onstart
     length 2d
   }
    task remove "Remove old inventory" {
@@ -40,15 +43,25 @@ task items "Room decoration" {
   task acceptance "Presentation and customer acceptance" {
     duration 5d
     depends !implement
-    account payments
+    chargeset payments
     # Customer pays at end of acceptance
-    endcredit 2000.0
+    charge 2000.0 onend
   }
 }
 # *** EXAMPLE: 1 -
 
-# accountreport pandl "PAndL.html" {
-#   timeformat "%d-%M-%y"
-#   accumulate
-#   columns index, name, weekly
-# }
+accountreport "Account-1" {
+  formats html
+  timeformat "%d-%M-%y"
+  columns index, name, weekly
+}
+
+accountreport "Account-2" {
+  formats html
+  timeformat "%d-%M-%y"
+  columns index,
+          name,
+          weekly {
+            celltext 1 "<-query attribute='turnover'->"
+          }
+}

data/test/TestSuite/Syntax/Correct/AccountReport.tjp

@@ -0,0 +1,74 @@
+project "AccountReport" 2011-11-09 +1y {
+  currencyformat "(" ")" "," "." 0
+}
+
+account resourceCost "Resource Cost" {
+  aggregate resources
+  account teamA "Team A"
+  account teamB "Team B"
+}
+account productCost "Product Cost" {
+  aggregate tasks
+}
+account customerPayments "Customer Payments" {
+  credits 2011-12-01 "First downpayment" 80000,
+          2012-06-01 "Second downpayment" 200000
+}
+
+balance productCost customerPayments
+
+resource teamA "Team A" {
+  rate 420
+  chargeset teamA
+  resource "R1"
+  resource "R2"
+}
+resource teamB "Team B" {
+  rate 380
+  chargeset teamB
+  resource "R3"
+  resource "R4"
+}
+
+task "Products" {
+  chargeset productCost
+
+  task p1 "Product 1" {
+    effort 20m
+    allocate teamA, teamB
+  }
+  task p2 "Product 2" {
+    effort 18m
+    allocate teamA
+    priority 600
+  }
+  task p3 "Product 3" {
+    effort 6m
+    allocate teamB
+    priority 600
+  }
+  task mf "Manufacturing" {
+    depends !p1, !p2, !p3
+    duration 2w
+    charge 12000 onend
+  }
+  task "Final Payment" {
+    depends !mf
+    purge chargeset
+    chargeset customerPayments
+    charge 170000 onstart
+  }
+}
+
+accountreport "TeamBudget" {
+  formats html
+  accountroot resourceCost
+  balance -
+  columns no, name, quarterly { celltext 1 "<-query attribute='turnover'->" }
+}
+
+accountreport "ProfiAndLoss" {
+  formats html
+  columns no, name, monthly
+}
+

data/test/TestSuite/Syntax/Correct/AdoptedTasks.tjp

@@ -7,3 +7,7 @@ task t3 "T3" {
   adopt t1, t2
 }
 
+taskreport "AdoptedTasks" {
+  formats html
+  columns no, bsi, index, name
+}

data/test/TestSuite/Syntax/Correct/AlertLevels.tjp

@@ -0,0 +1,25 @@
+project "Alert Levels" 2011-11-24 +2m {
+  alertlevels green "Low" "#2AA46C",
+              blue "Guarded" "#457CC4",
+              yellow "Elevated" "#F1D821",
+              orange "High" "#F99836",
+              red "Severe" "#E43745"
+}
+
+task "Holiday Season" {
+  journalentry 2011-11-24 "All safe unless you are a turkey" {
+    alert green
+  }
+  journalentry 2011-11-27 "Strange lights appearing everywhere" {
+    alert blue
+  }
+  journalentry 2011-12-01 "Alarm bells heared" {
+    alert yellow
+  }
+  journalentry 2011-12-20 "Everybody has strange packages" {
+    alert orange
+  }
+  journalentry 2011-12-25 "Guy with red coat entered through chimney" {
+    alert red
+  }
+}

data/test/TestSuite/Syntax/Correct/Celltext.tjp

@@ -16,19 +16,19 @@ task t "Task" {
 # Just a very basic report with some standard columns
 taskreport simple "SimpleReport" {
   formats html
-  columns hierarchindex, name, start, end, weekly
+  columns bsi, name, start, end, weekly
 }
 
 # Report with custom colum title
 taskreport custom "CustomTitle" {
   formats html
-  columns hierarchindex, name { title "Work Item" }, effort
+  columns bsi, name { title "Work Item" }, effort
 }
 
 # *** EXAMPLE: 1 +
 # Report with index and task name combined in one single column
 taskreport combined "CombinedColumn" {
   formats html
-  columns name { celltext 1 "<-query attribute='wbs'-> <-query->"},
+  columns name { celltext 1 "<-query attribute='bsi'-> <-query->"},
           start, end, weekly
 }

data/test/TestSuite/Syntax/Correct/Complete.tjp

@@ -1,17 +1,20 @@
-project simple "Simple Project" "1.0" 2007-01-01 - 2007-01-30 {
+project simple "Simple Project" "1.0" 2007-01-01 +2m {
   timezone "America/Denver"
   now 2007-01-15
 }
 
 # *** EXAMPLE: 1 +
-resource tux "Tux"
 
-task t "Task" {
+task "Build house" {
   start 2007-01-06
-  effort 10d
-  allocate tux
+  duration 30d
   # This task should have been completed on Jan 15, but only
   # 20% of the task have been completed so far.
   complete 20
 }
 
+taskreport "Complete" {
+  formats html
+  columns name, end { title "Due date" }, complete, gauge, chart
+}
+

data/test/TestSuite/Syntax/Correct/Leave.tjp

@@ -0,0 +1,37 @@
+project "Annual Leave" 2011-12-19 +1y {
+  now 2012-07-01
+}
+
+leaves holiday "Christmas" 2011-12-24 +3d,
+       holiday "New Year" 2011-12-31 +3d
+
+shift s1 "Shift 1" {
+    leaves annual 2011-12-19 +3w,
+           special 2012-01-12 +1d
+}
+
+resource team "Team" {
+  leaveallowances annual 2011-12-19 20d
+  leaves holiday 2012-01-06
+
+  resource r1 "R1" {
+    leaves annual 2011-12-19 +3w,
+           special 2012-01-12 +1d
+  }
+  resource r2 "R2" {
+    leaveallowances annual 2012-06-01 -10d
+    leaves sick 2012-01-04 +2d,
+           unpaid 2012-01-10 +3d
+  }
+}
+resource r3 "R3" {
+  shift s1 2011-12-19 +3w
+  leaves sick 2012-01-04 +2d
+}
+
+task "foo"
+
+resourcereport "." {
+  formats html
+  columns name, annualleave, annualleavebalance, sickleave, specialleave, unpaidleave
+}

data/test/TestSuite/Syntax/Correct/Reports.tjp

@@ -20,7 +20,7 @@ account a2 "FooAccount 2" {
 }
 
 task t1 "FooTask1" {
-  account a4
+  chargeset a4
   task t1_1 "FooTask1_1" {
     flags flag2
     start 2000-01-01
@@ -35,8 +35,8 @@ task t2 "FooTask2" {
   flags flag1
   start 2000-01-01
   duration 1d
-  startcredit 10000.0
-  account a4
+  chargeset a4
+  charge 10000.0 onstart
 }
 
 task t3 "FooTask3" {
@@ -48,7 +48,7 @@ task t3 "FooTask3" {
 taskreport task "Report_task" {
   formats html
   balance a1 a2
-  columns hierarchindex, name { title "Task Name" }, daily, effort
+  columns bsi, name { title "Task Name" }, daily, effort
   sorttasks tree, plan.start.up, name.up
 }
 

data/test/TestSuite/Syntax/Correct/Shift.tjp

@@ -16,8 +16,8 @@ shift s1 "Shift1" {
 }
 
 resource r1 "Resource1" {
-  shift s1 2000-01-01 - 2000-01-10
-  shift s2 2000-01-11 - 2000-01-20
+  shifts s1 2000-01-01 - 2000-01-10,
+         s2 2000-01-11 - 2000-01-20
 }
 
 shift s3 "Part-time schedule 1" {
@@ -46,9 +46,9 @@ shift s5 "All-day, all-week shift" {
 # Now determine when these schedules are applicable
 resource r2 "Resource2" {
   # r2 works three days a week from January to June
-  shift s3 2005-01-01 - 2005-01-15
+  shifts s3 2005-01-01 - 2005-01-15,
   # r2 switches to two days a week
-  shift s4 2005-01-15 - 2006-01-01
+         s4 2005-01-15 - 2006-01-01
 }
 
 task t1 "Task1" {

data/test/TestSuite/Syntax/Correct/manual2example.rb

@@ -10,8 +10,8 @@
 # published by the Free Software Foundation.
 #
 
-def removeTags(fileName)
-  oFile = File.open('../../../../examples/' + fileName, 'w')
+def removeTags(fileName, destDir)
+  oFile = File.open("../../../../examples/#{destDir}/#{fileName}", 'w')
   File.open(fileName, 'r') do |iFile|
     while line = iFile.gets
       oFile.puts line unless line =~ /^# \*\*\* EXAMPLE:/
@@ -20,5 +20,6 @@ def removeTags(fileName)
   oFile.close
 end
 
-removeTags('tutorial.tjp')
+removeTags('tutorial.tjp', 'Tutorial')
+removeTags('template.tjp', 'ProjectTemplate')
 

data/test/TestSuite/Syntax/Correct/navigator.tjp

@@ -0,0 +1,31 @@
+project "Navigator Example" 2011-12-12 +1m
+
+task foo "Foo" {
+  task "Foo 1"
+  task "Foo 2"
+}
+task bar "Bar" {
+  task "Bar 1"
+  task "Bar 2"
+}
+
+
+navigator navbar
+
+textreport frame "" {
+  header -8<-
+    == My Reports ==
+    <[navigator id="navbar"]>
+  ->8-
+  footer "----"
+
+  taskreport "Foo Reports" {
+    formats html
+    taskroot foo
+  }
+  taskreport "Bar Reports" {
+    formats html
+    taskroot bar
+  }
+}
+

data/test/TestSuite/Syntax/Correct/template.tjp

@@ -0,0 +1,338 @@
+/*
+ * This file contains a project skeletton. It is part of the
+ * TaskJuggler project management tool. You can use this as a basis to
+ * start you own project file.
+ */
+project your_project_id "Your Project Title"  2011-11-11-0:00--0500 +4m {
+  # Set the default time zone for the project. If not specified, UTC
+  # is used.
+  timezone "America/New_York"
+  # Hide the clock time. Only show the date.
+  timeformat "%Y-%m-%d"
+  # Use US format for numbers
+  numberformat "-" "" "," "." 1
+  # Use US financial format for currency values. Don't show cents.
+  currencyformat "(" ")" "," "." 0
+  # Pick a day during the project that will be reported as 'today' in
+  # the project reports. If not specified, the current day will be
+  # used, but this will likely be outside of the project range, so it
+  # can't be seen in the reports.
+  now 2011-12-24
+  # The currency for all money values is the Euro.
+  currency "USD"
+
+  # You can define multiple scenarios here if you need them.
+  #scenario plan "Plan" {
+  #  scenario actual "Actual"
+  #}
+
+  # You can define your own attributes for tasks and resources. This
+  # is handy to capture additonal information about the project that
+  # is not directly impacting the project schedule but you like to
+  # keep in one place.
+  #extend task {
+  #  reference spec "Link to Wiki page"
+  #}
+  #extend resource {
+  #  text Phone "Phone"
+  #}
+}
+
+copyright "Claim your rights here"
+
+# If you have any text block that you need multiple times to describe
+# your project, you should define a macro for it. Macros can even have
+# variable segments that you can set upon calling the macro.
+#
+# macro Task [
+#   task "A ${1} task" {
+#   }
+# ]
+#
+# Can be called as
+# ${Task "big"}
+# to generate
+# task "A big task" {
+# }
+
+# You can attach flags to accounts, resources and tasks. These can be
+# used to filter out subsets of them during reporting.
+flags important, hidden
+
+# If you want to do budget planning for you project, you need to
+# define some accounts.
+account cost "Project Cost" {
+  account dev "Development"
+  account doc "Documentation"
+}
+account rev "Customer Payments"
+
+# The Profit&Loss analysis should be rev - cost accounts.
+balance cost rev
+
+# Define you public holidays here.
+vacation "New Year's Day" 2012-01-02
+vacation "Birthday of Martin Luther King, Jr." 2012-01-16
+vacation "Washington's Birthday" 2012-02-20
+vacation "Memorial Day" 2012-05-28
+vacation "Independence Day" 2012-07-04
+vacation "Labor Day" 2012-09-03
+vacation "Columbus Day" 2012-10-08
+vacation "Veterans Day" 2012-11-12
+vacation "Thanksgiving Day" 2012-11-22
+vacation "Christmas Day" 2012-12-25
+
+# The daily default rate of all resources. This can be overridden for each
+# resource. We specify this, so that we can do a good calculation of
+# the costs of the project.
+rate 400.0
+
+# This is a set of example resources.
+resource r1 "Resource 1"
+resource t1 "Team 1" {
+  managers r1
+  resource r2 "Resource 2"
+  resource r3 "Resource 3"
+}
+
+# This is a resource that does not do any work.
+resource s1 "System 1" {
+  efficiency 0.0
+  rate 600.0
+}
+
+task project "Project" {
+  task wp1 "Workpackage 1" {
+    task t1 "Task 1"
+    task t2 "Task 2"
+  }
+  task wp2 "Work package 2" {
+    depends !wp1
+    task t1 "Task 1"
+    task t2 "Task 2"
+  }
+  task deliveries "Deliveries" {
+    task "Item 1" {
+      depends !!wp1
+    }
+    task "Item 2" {
+      depends !!wp2
+    }
+  }
+}
+
+# Now the project has been specified completely. Stopping here would
+# result in a valid TaskJuggler file that could be processed and
+# scheduled. But no reports would be generated to visualize the
+# results.
+
+navigator navbar {
+  hidereport 0
+}
+
+macro TaskTip [
+  tooltip istask() -8<-
+    '''Start: ''' <-query attribute='start'->
+    '''End: ''' <-query attribute='end'->
+    ----
+    '''Resources:'''
+
+    <-query attribute='resources'->
+    ----
+    '''Precursors: '''
+
+    <-query attribute='precursors'->
+    ----
+    '''Followers: '''
+
+    <-query attribute='followers'->
+    ->8-
+]
+
+textreport frame "" {
+  header -8<-
+    == TaskJuggler Project Template ==
+    <[navigator id="navbar"]>
+  ->8-
+  footer "----"
+  textreport index "Overview" {
+    formats html
+    center '<[report id="overview"]>'
+  }
+
+  textreport "Status" {
+    formats html
+    center -8<-
+      <[report id="status.dashboard"]>
+      ----
+      <[report id="status.completed"]>
+      ----
+      <[report id="status.ongoing"]>
+      ----
+      <[report id="status.future"]>
+    ->8-
+  }
+
+  textreport wps "Work packages" {
+    textreport wp1 "Work package 1" {
+      formats html
+      center '<[report id="wp1"]>'
+    }
+
+    textreport wp2 "Work package 2" {
+      formats html
+      center '<[report id="wp2"]>'
+    }
+  }
+
+  textreport "Deliveries" {
+    formats html
+    center '<[report id="deliveries"]>'
+  }
+
+  textreport "ContactList" {
+    formats html
+    title "Contact List"
+    center '<[report id="contactList"]>'
+  }
+  textreport "ResourceGraph" {
+    formats html
+    title "Resource Graph"
+    center '<[report id="resourceGraph"]>'
+  }
+}
+
+# A traditional Gantt chart with a project overview.
+taskreport overview "" {
+  header -8<-
+    === Project Overview ===
+
+    The project is structured into 2 work packages.
+
+    # Specification
+    # <-reportlink id='frame.wps.wp1'->
+    # <-reportlink id='frame.wps.wp2'->
+    # Testing
+
+    === Original Project Plan ===
+  ->8-
+  columns bsi { title 'WBS' },
+          name, start, end, effort, cost,
+          revenue, chart { ${TaskTip} }
+  # For this report we like to have the abbreviated weekday in front
+  # of the date. %a is the tag for this.
+  timeformat "%a %Y-%m-%d"
+  loadunit days
+  hideresource 1
+  balance cost rev
+  caption 'All effort values are in man days.'
+
+  footer -8<-
+    === Staffing ===
+
+    All project phases are properly staffed. See [[ResourceGraph]] for
+    detailed resource allocations.
+
+    === Current Status ===
+
+    Some blurb about the current situation.
+  ->8-
+}
+
+# Macro to set the background color of a cell according to the alert
+# level of the task.
+macro AlertColor [
+  cellcolor plan.alert = 0 "#00D000" # green
+  cellcolor plan.alert = 1 "#D0D000" # yellow
+  cellcolor plan.alert = 2 "#D00000" # red
+]
+
+taskreport status "" {
+  columns bsi { width 50 title 'WBS' }, name { width 150 },
+          start { width 100 }, end { width 100 },
+          effort { width 100 },
+          alert { tooltip plan.journal
+                          != '' "<-query attribute='journal'->" width 150 },
+          status { width 150 }
+
+  taskreport dashboard "" {
+    headline "Project Dashboard (<-query attribute='now'->)"
+    columns name { title "Task" ${AlertColor} width 200},
+            resources { width 200 ${AlertColor}
+                        listtype bullets
+                        listitem "<-query attribute='name'->"
+                        start ${projectstart} end ${projectend} },
+            alerttrend { title "Trend" ${AlertColor} width 50 },
+            journal { width 350 ${AlertColor} }
+    journalmode status_up
+    journalattributes headline, author, date, summary, details
+    hidetask ~hasalert(0)
+    sorttasks alert.down, plan.end.up
+    period %{${now} - 1w} +1w
+  }
+  taskreport completed "" {
+    headline "Already completed tasks"
+    hidetask ~(plan.end <= ${now})
+  }
+  taskreport ongoing "" {
+    headline "Ongoing tasks"
+    hidetask ~((plan.start <= ${now}) & (plan.end > ${now}))
+  }
+  taskreport future "" {
+    headline "Future tasks"
+    hidetask ~(plan.start > ${now})
+  }
+}
+
+# A list of tasks showing the resources assigned to each task.
+taskreport wp1 "" {
+  headline "Work package 1 - Resource Allocation Report"
+  columns bsi { title 'WBS' }, name, start, end, effort { title "Work" },
+          duration, chart { ${TaskTip} scale day width 500 }
+  timeformat "%Y-%m-%d"
+  hideresource ~(isleaf() & isleaf_())
+  sortresources name.up
+  taskroot project.wp1
+}
+# A list of tasks showing the resources assigned to each task.
+taskreport wp2 "" {
+  headline "Work package 2 - Resource Allocation Report"
+  columns bsi { title 'WBS' }, name, start, end, effort { title "Work" },
+          duration, chart { ${TaskTip} scale day width 500 }
+  timeformat "%Y-%m-%d"
+  hideresource ~(isleaf() & isleaf_())
+  sortresources name.up
+  taskroot project.wp2
+}
+
+# A list of all tasks with the percentage completed for each task
+taskreport deliveries "" {
+  headline "Project Deliverables"
+  columns bsi { title 'WBS' }, name, start, end, note { width 150 }, complete,
+          chart { ${TaskTip} }
+  taskroot project.deliveries
+  hideresource 1
+}
+# A list of all employees with their contact details.
+resourcereport contactList "" {
+  headline "Contact list and duty plan"
+  columns name,
+          email { celltext 1 "[mailto:<-email-> <-email->]" },
+          managers { title "Manager" },
+          chart { scale day }
+  hideresource ~isleaf()
+  sortresources name.up
+  hidetask 1
+}
+
+# A graph showing resource allocation. It identifies whether each
+# resource is under- or over-allocated for.
+resourcereport resourceGraph "" {
+  headline "Resource Allocation Graph"
+  columns no, name, effort, rate, weekly { ${TaskTip} }
+  loadunit shortauto
+  # We only like to show leaf tasks for leaf resources.
+  hidetask ~(isleaf() & isleaf_())
+  sorttasks plan.start.up
+}
+