Changes between Version 30 and Version 31 of TracJsGanttPlugin


Ignore:
Timestamp:
Jan 21, 2012, 12:01:48 AM (3 years ago)
Author:
AdrianFritz
Comment:

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

Legend:

Unmodified
Added
Removed
Modified
  • TracJsGanttPlugin

    v30 v31  
    2222|| `caption`|| ||Caption to place to right of tasks: None, `Caption`, `Resource`, `Duration`, `%Complete` || `Resource` ||
    2323|| `comp`|| ||Show (`1`) percent complete column, or do not (`0`). ||  `1`  ||
    24 || `colorBy`|| ||Field to use to color tasks.  Useful fields are `priority`, `owner` and `milestone` but any field can be used. || `priority` ||
     24|| `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` ||
    2525|| `dur`|| ||Show (`1`) duration colunn, or do not (`0`). ||  `1`  ||
    2626|| `dateDisplay`|| ||Format to display dates: `mm/dd/yyyy`, `dd/mm/yyyy`, or `yyyy-mm-dd` ||  `mm/dd/yyyy`  ||
     
    4242|| `userMap`||0.8||Map (`1`) user IDs to full names, or do not (`0`). ||  `1`  ||
    4343
    44 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.
     44Site-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.
    4545
    4646All other macro arguments are treated as TracQuery specification (e.g., milestone=MS1|MS2) to control which tickets are displayed.
     
    6262{{{
    6363  [TracPM]
    64   # To work with Timing and Estimation for percent complete
    65   ## Ticket field to use as the data source for estimated work (default: None)
     64  # To work with TimingAndEstimationPlugin for percent complete, define ticket fields to use as the data source for:
    6665  fields.estimate = estimatedhours
    67   ## Ticket field to use as the data source for completed work (default: None)
    6866  fields.worked = totalhours
     67
    6968  # Each unit in estimate is 1/8 of a day
    7069  days_per_estimate = 0.125
    71   # To work with Master Tickets for dependencies
    72   ## Ticket field to use as the data source for predecessor list
     70
     71  # To work with MasterTicketsPlugin for dependencies, define ticket fields to use as the data source for predecessor (pred) and successor (succ).
    7372  fields.pred = blockedby
    74   ## Ticket field to use as the data source for successor list
    7573  fields.succ = blocking
    76   # To work with Subtickets for parent/child relationships
    77   ## Ticket field to use as the data source for the parent parent_format', '%s', Format of ticket IDs in parent field (default: None).
     74
     75  # To work with SubticketsPlugin for parent/child relationships,
     76  ## Ticket field to use as the data source for the parent
    7877  fields.parent = parents
    79   #
    80   # To work with ChildTickets plugin
    81   # parent_format = #%s
    82   #
     78 
     79  # To work with ChildTickets plugin parent_format', '%s', Format of ticket IDs in parent field (default: None).
     80  parent_format = %s
     81 
    8382  # Custom fields for start and due dates
    8483  ## Ticket field to use as the data source for start date (default: None)
     
    8685  ## Ticket field to use as the data source for finish date (default: None)
    8786  fields.finish = userfinish
    88   #
     87 
    8988  # Format for ''start'' and ''finish'' date strings (default: '%Y-%m-%d')
    9089  date_format = %Y-%m-%d
    91   #
     90 
    9291  # Ticket type for milestone-like tickets (default: 'milestone')
    93   milestone_type = milestone
    94   #
     92  #milestone_type = milestone
     93 
    9594  # Ticket field to use as the data source for the percent complete column (default: None).
    96   # fields.percent =
    97   #
     95  fields.percent = complete
     96 
    9897  # Hours represented by each unit of estimated work (default: 1).
    99   # hours_per_estimate = 1
    100   #
     98  hours_per_estimate = 1
     99 
    101100  # Default work for an unestimated task, same units as estimate  (default: 4.0).
    102   # default_estimate = 4.0
    103   #
     101  default_estimate = 4.0
     102 
    104103  # How much work may be remaining when a task goes over estimate, same units as estimate (default: 0.0)..
    105   # estimate_pad = 0.0
     104  estimate_pad = 0.0
    106105}}}
    107106   * See [#Configuration configuration details] below for explanations and more options.
    108  1. Restart web server on command line:
     107   * Additionally, site-wide defaults for macro arguments may be set at [trac-jsgantt] section. More details about them see [#Arguments #Arguments section].
     108{{{
     109  [trac-jsgantt]
     110  option.formats = day|week|month|quarter
     111  option.format = month
     112  ## How and which 'columns' to show
     113  option.lwidth = 300
     114  option.res = 0
     115  option.dur = 0
     116  option.comp = 0
     117  option.startDate = 0
     118  option.endDate = 1
     119  option.dateDisplay = yyyy-mm-dd
     120  ## How and what to show on Gantt graph
     121  option.showdep = 1
     122  option.expandClosedTickets = 1
     123  option.schedule = asap
     124  option.openLevel = 0
     125  option.colorBy = priority
     126  option.userMap = 0
     127  option.omitMilestone = 0
     128  option.caption = Resource
     129  option.hoursPerDay = 8.0
     130}}}
     131 1. '''Restart''' web server on command line:
    109132{{{
    110133#!sh
     
    116139!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.
    117140
    118 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.
    119 
    120141All of the `fields.*` items name custom fields which may contain data for the Gantt.
    121142
    122 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.
     143 * 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.
    123144
    124 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.
     145 * 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.
    125146
    126 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.)
     147 * 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.)
    127148
    128 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.
     149 * 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.
    129150
    130 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.
     151 * 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.
    131152
    132 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.
     153 * 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.
    133154
    134155== Bugs/Feature Requests ==
     
    140161=== Known issues ===
    141162
     163 * None
    142164
    143165=== Planned enhancements ===