taskjuggler 3.0.0 → 3.1.0

data/examples/ProjectTemplate/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
+}
+

data/examples/ToDo-List/todolist.tjp

@@ -0,0 +1,84 @@
+project "My TODO List" 2011-01-01 +5y {
+  # The now date is only set to keep the reports constant. In a real
+  # list you would _not_ set a now date.
+  now 2011-12-20
+}
+
+task "Arrents" {
+  priority 5
+
+  task "By some milk" {
+    end 2011-12-13
+    complete 100
+    priority 7
+  }
+  task "Pickup Jacket from dry cleaner" {
+    end 2011-12-18
+    complete 0
+    note "Smith Dry Cleaners"
+  }
+  task "Buy present for wife" {
+    end 2011-12-23
+    note "Have a good idea first"
+    journalentry 2011-12-10 "Maybe a ring?"
+    journalentry 2011-12-14 "Too expensive. Some book?"
+  }
+}
+task "Long term projects" {
+  priority 3
+
+  task "Buy new car" {
+    end 2011-05-11
+    complete 100
+    priority 6
+  }
+  task "Build boat" {
+    end 2013-04-01
+    complete 42
+  }
+}
+
+macro cellcol [
+  cellcolor (plan.end < ${now}) & (plan.gauge = "behind schedule") "#FF0000"
+  cellcolor plan.gauge = "behind schedule" "#FFFF00"
+]
+
+navigator navbar
+
+textreport frame "" {
+  formats html
+  header -8<-
+    == My ToDo List for ${today} ==
+    <[navigator id="navbar"]>
+  ->8-
+  footer "----"
+
+  columns name,
+          end { title "Due Date" ${cellcol} },
+          complete,
+          priority,
+          note,
+          journal { celltext 1 ""
+                    tooltip 1 "<-query attribute='journal'->"
+                    width 70 }
+
+  taskreport "TODOs due today" {
+    hidetask (plan.complete >= 100) | (plan.end > %{${now} +1d})
+    journalattributes date, headline, summary, details
+  }
+  taskreport "TODOs due within a week" {
+    hidetask (plan.complete >= 100) | (plan.end > %{${now} +1w})
+    journalattributes date, headline, summary, details
+  }
+  taskreport "All open TODOs" {
+    hidetask plan.complete >= 100
+    journalattributes date, headline, summary, details
+  }
+
+  taskreport "Completed TODOs" {
+    hidetask plan.complete < 100
+  }
+
+  purge formats
+}
+

data/examples/{tutorial.tjp → Tutorial/tutorial.tjp}

@@ -260,7 +260,7 @@ task AcSo "Accounting Software" {
 
     task prev "Technology Preview" {
       depends !!software.backend
-      startcredit 31000.0
+      charge 31000.0 onstart
       note "All '''major''' features should be usable."
     }
 
@@ -371,8 +371,8 @@ taskreport overview "" {
 
     === Original Project Plan ===
   ->8-
-  columns hierarchindex,
-          name, start, end, effort, duration, cost,
+  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.
@@ -405,7 +405,7 @@ macro AlertColor [
 ]
 
 taskreport status "" {
-  columns wbs { width 50 }, name { width 150 },
+  columns bsi { width 50 title 'WBS' }, name { width 150 },
           start { width 100 }, end { width 100 },
           effort { width 100 },
           alert { tooltip plan.journal
@@ -421,7 +421,9 @@ taskreport status "" {
                         listitem "<-query attribute='name'->"
                         start ${projectstart} end ${projectend} },
             alerttrend { title "Trend" ${AlertColor} width 50 },
-            journalmessages { width 350 ${AlertColor} }
+            journal { width 350 ${AlertColor} }
+    journalmode status_up
+    journalattributes headline, author, date, summary, details
     hidetask ~hasalert(0)
     sorttasks alert.down, delayed.end.up
     period %{${now} - 1w} +1w
@@ -444,7 +446,7 @@ taskreport status "" {
 taskreport development "" {
   scenarios delayed
   headline "Development - Resource Allocation Report"
-  columns hierarchindex, name, start, end, effort { title "Work" },
+  columns bsi { title 'WBS' }, name, start, end, effort { title "Work" },
           duration, chart { ${TaskTip} scale day width 500 }
   timeformat "%Y-%m-%d"
   hideresource ~(isleaf() & isleaf_())
@@ -454,7 +456,7 @@ taskreport development "" {
 # A list of all tasks with the percentage completed for each task
 taskreport deliveries "" {
   headline "Project Deliverables"
-  columns hierarchindex, name, start, end, note { width 150 }, complete,
+  columns bsi { title 'WBS' }, name, start, end, note { width 150 }, complete,
           chart { ${TaskTip} }
   taskroot AcSo.deliveries
   hideresource 1