Changes between Version 30 and Version 31 of TracJsGanttPlugin

Timestamp:

Jan 20, 2012, 11:01:48 PM (12 years ago)

Author:

Adrian Fritz

Comment:

Options configuration example as tested per [11160]. Makes details more explicit. Formatting.

TracJsGanttPlugin

@@ -22 +22 @@
 || `caption`|| ||Caption to place to right of tasks: None, `Caption`, `Resource`, `Duration`, `%Complete` || `Resource` ||
 || `comp`|| ||Show (`1`) percent complete column, or do not (`0`). ||  `1`  ||
-|| `colorBy`|| ||Field to use to color tasks.  Useful fields are `priority`, `owner` and `milestone` but any field can be used. || `priority` ||
+|| `colorBy`|| ||Field to use to color tasks. Useful fields are `priority`, `owner` and `milestone` but any field can be used. When colored by `priority` colors  are consistent with the colors used in Trac reports. Other coloring choices (e.g., by `milestone` or `owner`) use arbitrary, unique colors. || `priority` ||
 || `dur`|| ||Show (`1`) duration colunn, or do not (`0`). ||  `1`  ||
 || `dateDisplay`|| ||Format to display dates: `mm/dd/yyyy`, `dd/mm/yyyy`, or `yyyy-mm-dd` ||  `mm/dd/yyyy`  ||
@@ -42 +42 @@
 || `userMap`||0.8||Map (`1`) user IDs to full names, or do not (`0`). ||  `1`  ||
 
-Site-wide defaults for macro arguments may be set in the `trac-jsgantt` section of `trac.ini`.  `option.<opt>` overrides the built-in default for `<opt>` from the table above.
+Site-wide defaults for macro arguments may be set in the `[trac-jsgantt]` section of `trac.ini`. Where `option.<opt>` overrides the built-in default for `<opt>` from the table above.
 
 All other macro arguments are treated as TracQuery specification (e.g., milestone=MS1|MS2) to control which tickets are displayed.
@@ -62 +62 @@
 {{{
   [TracPM]
-  # To work with Timing and Estimation for percent complete
-  ## Ticket field to use as the data source for estimated work (default: None)
+  # To work with TimingAndEstimationPlugin for percent complete, define ticket fields to use as the data source for:
   fields.estimate = estimatedhours
-  ## Ticket field to use as the data source for completed work (default: None)
   fields.worked = totalhours
+
   # Each unit in estimate is 1/8 of a day
   days_per_estimate = 0.125
-  # To work with Master Tickets for dependencies
-  ## Ticket field to use as the data source for predecessor list
+
+  # To work with MasterTicketsPlugin for dependencies, define ticket fields to use as the data source for predecessor (pred) and successor (succ).
   fields.pred = blockedby
-  ## Ticket field to use as the data source for successor list
   fields.succ = blocking
-  # To work with Subtickets for parent/child relationships
-  ## Ticket field to use as the data source for the parent parent_format', '%s', Format of ticket IDs in parent field (default: None).
+
+  # To work with SubticketsPlugin for parent/child relationships, 
+  ## Ticket field to use as the data source for the parent 
   fields.parent = parents
-  #
-  # To work with ChildTickets plugin
-  # parent_format = #%s
-  #
+  
+  # To work with ChildTickets plugin parent_format', '%s', Format of ticket IDs in parent field (default: None).
+  parent_format = %s
+  
   # Custom fields for start and due dates
   ## Ticket field to use as the data source for start date (default: None)
@@ -86 +85 @@
   ## Ticket field to use as the data source for finish date (default: None)
   fields.finish = userfinish
-  #
+  
   # Format for ''start'' and ''finish'' date strings (default: '%Y-%m-%d')
   date_format = %Y-%m-%d
-  #
+  
   # Ticket type for milestone-like tickets (default: 'milestone')
-  milestone_type = milestone
-  #
+  #milestone_type = milestone
+  
   # Ticket field to use as the data source for the percent complete column (default: None).
-  # fields.percent =
-  # 
+  fields.percent = complete
+   
   # Hours represented by each unit of estimated work (default: 1).
-  # hours_per_estimate = 1
-  # 
+  hours_per_estimate = 1
+   
   # Default work for an unestimated task, same units as estimate  (default: 4.0).
-  # default_estimate = 4.0
-  # 
+  default_estimate = 4.0
+   
   # How much work may be remaining when a task goes over estimate, same units as estimate (default: 0.0)..
-  # estimate_pad = 0.0
+  estimate_pad = 0.0
 }}}
    * See [#Configuration configuration details] below for explanations and more options.
- 1. Restart web server on command line:
+   * Additionally, site-wide defaults for macro arguments may be set at [trac-jsgantt] section. More details about them see [#Arguments #Arguments section].
+{{{
+  [trac-jsgantt]
+  option.formats = day|week|month|quarter
+  option.format = month
+  ## How and which 'columns' to show
+  option.lwidth = 300
+  option.res = 0
+  option.dur = 0
+  option.comp = 0
+  option.startDate = 0
+  option.endDate = 1
+  option.dateDisplay = yyyy-mm-dd
+  ## How and what to show on Gantt graph
+  option.showdep = 1
+  option.expandClosedTickets = 1
+  option.schedule = asap
+  option.openLevel = 0
+  option.colorBy = priority
+  option.userMap = 0
+  option.omitMilestone = 0
+  option.caption = Resource
+  option.hoursPerDay = 8.0
+}}}
+ 1. '''Restart''' web server on command line:
 {{{
 #!sh
@@ -116 +139 @@
 !TracJsGanttPlugin is intended to be flexible enough to get data from various plugins by configuring the field names for those plugins in `trac.ini`.  It is known to work with TimingAndEstimationPlugin (for estimated and total hours), MasterTicketsPlugin (for FS dependencies), and SubticketsPlugin for parent/child relationships. Custom fields for start and finish date are also supported.
 
-Tasks are colored based on ticket attributes.  When colored by priority colors  are consistent with the colors used in Trac reports.  Other coloring choices (e.g., by milestone or owner) use arbitrary, unique colors.
-
 All of the `fields.*` items name custom fields which may contain data for the Gantt.
 
-When `estimate` and `worked` are both configured, the plugin attempts to display (100 * worked/estimate) as the percent complete.  The example works with TimingAndEstimationPlugin.  Alternatively, if `percent` is configured, the plugin attempts to display it as the percent complete (it should be a number from 0 to 100).  If none of those are configured, all tasks will be marked as 0% complete.
+ * When `fields.estimate` and `fields.worked` are both configured, the plugin attempts to display (100 * `fields.worked`/`fields.estimate`) as the percent complete.  The example works with TimingAndEstimationPlugin.  Alternatively, if `percent` is configured, the plugin attempts to display it as the percent complete (it should be a number from 0 to 100).  If none of those are configured, all tasks will be marked as 0% complete.
 
-When `pred` and `succ` are configured the plugin uses them to determine the task dependencies.  The example works with MasterTicketsPlugin.  If these fields are not configured, no dependencies are shown.
+ * When `fields.pred` and `fields.succ` are configured the plugin uses them to determine the task dependencies. The example works with MasterTicketsPlugin.  If these fields are not configured, no dependencies are shown.
 
-When `parent` is configured, it is the field which holds the parent ticket number.  The example works with Subtickets.  If this field is not configured, no parent/child relationship will be displayed.  If it is configured, the Gantt can be collapsed by the user to show or hide subtasks.  (`parent_format` determines the format of the content of the `parent` field.  Use "%s" (default) for SubticketsPlugin, "#%s" for ChildTicketsPlugin.)
+ * When `fields.parent` is configured, it is the field which holds the parent ticket number.  The example works with SubticketsPlugin.  If this field is not configured, no parent/child relationship will be displayed.  If it is configured, the Gantt can be collapsed by the user to show or hide subtasks.  (`parent_format` determines the format of the content of the `parent` field.  Use "%s" (default) for SubticketsPlugin, or "#%s" for ChildTicketsPlugin.)
 
-When `start` and `finish` are configured, the plugin uses them to set task start and finish dates.  The `date_format` field is a Python `strptime()` format specifier which describes the contents of `start` and `finish`.  If these fields are not configured, all tasks end today and have a 1-day duration.
+ * When `fields.start` and `fields.finish` are configured, the plugin uses them to set task start and finish dates.  The `date_format` field is a Python `strptime()` format specifier which describes the contents of `fields.start` and `fields.finish`.  If these fields are not configured, all tasks end today and have a 1-day duration.
 
-When `estimate` and `finish` are both configured (and `start` is not configured or not on the ticket), the plugin attempts to determine the start of the task from  `finish` and `estimate` as `start = finish - estimate` with consideration for weekends and hours per day.
+ * When `fields.estimate` and `fields.finish` are both configured (and `fields.start` is not configured or not on the ticket), the plugin attempts to determine the start of the task from  `fields.finish` and `fields.estimate` as `start = fields.finish - fields.estimate` with consideration for weekends and hours per day.
 
-The `milestone_type` may be used to have a custom ticket type show up as milestones on the chart.  If this field is not specified, only Trac milestones are displayed as milestones.
+ * The `milestone_type` may be used to have a custom ticket type show up as milestones on the chart.  If this field is not specified, only Trac milestones are displayed as milestones.
 
 == Bugs/Feature Requests == 
@@ -140 +161 @@
 === Known issues ===
 
+ * None
 
 === Planned enhancements ===