Changes between Version 26 and Version 27 of TracJsGanttPlugin


Ignore:
Timestamp:
Nov 5, 2011, 4:27:03 AM (3 years ago)
Author:
AdrianFritz
Comment:

Organize options alphabetically, more example options in configuration file. Formatting.

Legend:

Unmodified
Added
Removed
Modified
  • TracJsGanttPlugin

    v26 v27  
    1919The chart display can be controlled with a number of macro arguments:
    2020
    21 ||Argument      ||Version       ||Description   ||Default
    22 || `formats`||||What to display in the format control.  A pipe-separated list of `minute`, `hour`, `day`, `week`, `month`, and `quarter` (though `minute` may not be very useful). ||`day|week|month|quarter`||
    23 || `format`|| ||Initial display format, one of those listed in `formats` || First format ||
    24 || `sample`|| ||Display sample tasks (1) or not (0) || 0 ||
    25 || `res`|| ||Show resource column (1) or not (0) || 1 ||
    26 || `dur`|| ||Show duration colunn (1) or not (0) || 1 ||
    27 || `comp`|| ||Show percent complete column (1) or not (0) || 1 ||
    28 || `caption`|| ||Caption to place to right of tasks: None, Caption, Resource, Duration, %Complete || Resource ||
    29 || `startDate`|| ||Show start date column (1) or not (0) || 1 ||
    30 || `endDate`|| ||Show end date column (1) or not (0) || 1 ||
    31 || `dateDisplay`|| ||Date display format: 'mm/dd/yyyy', 'dd/mm/yyyy', or 'yyyy-mm-dd' || 'mm/dd/yyyy' ||
    32 || `openLevel`|| ||Number of levels of tasks to show.  1 = only top level task.  || 999 ||
    33 || `expandClosedTickets`||0.9||Show children of closed tickets (1) or collapse the subtree (0).|| 1 ||
    34 || `colorBy`|| ||Field to use to choose task colors.  Each unique value of the field will have a different color task.  Other likely useful values are owner and milestone but any field can be used. || priority ||
    35 || `root`|| ||When using something like Subtickets plugin to maintain a tree of tickets and subtickets, you may create a Gantt showing a ticket and all of its descendants with `root=<ticket#>`.  The macro uses the configured `parent` field to find all descendant tasks and build an `id=` argument for Trac's native query handler.[[br]][[br]]Multiple roots may be provided like `root=1|12|32`.[[br]][[br]]When used in a ticket description or comment, `root=self` will display the current ticket's descendants.|| ||
    36 || `goal`|| 0.9 ||When using something like MasterTickets plugin to maintain ticket dependencies, you may create a Gantt showing a ticket and all of its predecessors with `goal=<ticket#>`.  The macro uses the configured `succ` field to find all predecessor tasks and build an `id=` argument for Trac's native query handler.[[br]][[br]]Multiple goals may be provided like `goal=1|12|32`.[[br]][[br]]When used in a ticket description or comment, `goal=self` will display the current ticket's predecessors.|| ||
    37 || `lwidth`|| ||The width, in pixels, of the table of task names, etc. on the left of the Gantt. || ||
    38 || `showdep`||||Show dependencies (1) or not (0)||1||
    39 || `userMap`||0.8||Map user IDs to full names (1) or not (0).||1||
    40 || `omitMilestones`||0.8||Show milestones for displayed tickets (0) or only those specified by `milestone=` (1)||0||
     21||'''Argument'''  ||'''Version'''  ||'''Description'''  ||'''Default'''
     22|| `caption`|| ||Caption to place to right of tasks: None, `Caption`, `Resource`, `Duration`, `%Complete` || `Resource` ||
     23|| `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` ||
     25|| `dur`|| ||Show (`1`) duration colunn, or do not (`0`). ||  `1`  ||
     26|| `dateDisplay`|| ||Format to display dates: `mm/dd/yyyy`, `dd/mm/yyyy`, or `yyyy-mm-dd` ||  `mm/dd/yyyy`  ||
     27|| `endDate`|| ||Show (`1`) end date column, or do not (`0`). ||  `1`  ||
     28|| `expandClosedTickets`||0.9||Show (`1`) children of closed tickets in the task hierarchy or collapse the subtree (`0`). ||  `1`  ||
     29|| `format`|| ||Initial display format, one of those listed in `formats` ||  `day`  ||
     30|| `formats`||||Formats to show for Gantt chart.  A pipe-separated list of `minute`, `hour`, `day`, `week`, `month`, and `quarter`. || `day|week|month|quarter` ||
     31|| `goal`|| 0.9 ||Ticket(s) to show predecessors of. When using something like MasterTicketsPlugin to maintain ticket dependencies, you may create a Gantt showing a ticket and all of its predecessors with `goal=<ticket#>`.  The macro uses the configured `succ` field to find all predecessor tasks and build an `id=` argument for Trac's native query handler.[[br]][[br]]Multiple goals may be provided like `goal=1|12|32`.[[br]][[br]]When used in a ticket description or comment, `goal=self` will display the current ticket's predecessors.||  None ||
     32|| `hoursPerDay`|| ||Hours worked per day ||  `8.0`  ||
     33|| `lwidth`|| ||Width (in pixels) of left table (The one contains task names, etc. on the left of the Gantt chart.) ||  None  ||
     34|| `omitMilestones`||0.8||Show milestones for displayed tickets (`0`) or only those specified by `milestone=` (`1`). ||  `0`  ||
     35|| `openLevel`|| ||How many levels of task hierarchy to show open.  `1` = only top level task.  ||  `999`  ||
     36|| `res`|| ||Show (`1`) resource column, or do not (`0`). ||  `1`  ||
     37|| `root`|| ||Ticket(s) to show descendants of. When using something like Subtickets plugin to maintain a tree of tickets and subtickets, you may create a Gantt showing a ticket and all of its descendants with `root=<ticket#>`.  The macro uses the configured `parent` field to find all descendant tasks and build an `id=` argument for Trac's native query handler.[[br]][[br]]Multiple roots may be provided like `root=1|12|32`.[[br]][[br]]When used in a ticket description or comment, `root=self` will display the current ticket's descendants.||  None  ||
     38|| `sample`|| ||Display (`1`) sample tasks in Gantt, or do not (`0`) ||  `0`  ||
     39|| `schedule`|| ||Schedule algorithm: as-last-as-possible (`alap`) or as-soon-as-possible (`asap`) ||  `alap`  ||
     40|| `showdep`|| ||Show (`1`) dependencies in Gantt, or do not (`0`). ||  `1`  ||
     41|| `startDate`|| ||Show (`1`) start date column, or do not (`0`). ||  `1`  ||
     42|| `userMap`||0.8||Map (`1`) user IDs to full names, or do not (`0`). ||  `1`  ||
    4143
    4244Site-wide defaults for macro arguments may be set in `trac.ini`.  `option.<opt>` overrides the built-in default for `<opt>` from the table above.
    4345
    4446All other macro arguments are treated as TracQuery specification (e.g., milestone=MS1|MS2) to control which tickets are displayed.
     47
    4548
    4649== Installation ==
     
    4952 1. '''Install''' globally with:
    5053{{{
    51   sudo easy_install http://trac-hacks.org/svn/tracjsganttplugin/0.11/
     54  sudo easy_install https://trac-hacks.org/svn/tracjsganttplugin/0.11/
    5255}}}
    5356 1. '''Enable''' the plugin by updating TracIni file (..../trac.ini) as follows:
     
    6063  [trac-jsgantt]
    6164  # To work with Timing and Estimation for percent complete
     65  ## Ticket field to use as the data source for estimated work (default: None)
    6266  fields.estimate = estimatedhours
     67  ## Ticket field to use as the data source for completed work (default: None)
    6368  fields.worked = totalhours
    6469  # Each unit in estimate is 1/8 of a day
    6570  days_per_estimate = 0.125
    6671  # To work with Master Tickets for dependencies
     72  ## Ticket field to use as the data source for predecessor list
    6773  fields.pred = blockedby
     74  ## Ticket field to use as the data source for successor list
    6875  fields.succ = blocking
    6976  # 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).
    7078  fields.parent = parents
    7179  #
     
    7482  #
    7583  # Custom fields for start and due dates
     84  ## Ticket field to use as the data source for start date (default: None)
    7685  fields.start = userstart
     86  ## Ticket field to use as the data source for finish date (default: None)
    7787  fields.finish = userfinish
    7888  #
     89  # Format for ''start'' and ''finish'' date strings (default: '%Y-%m-%d')
    7990  date_format = %Y-%m-%d
     91  #
     92  # Ticket type for milestone-like tickets (default: 'milestone')
    8093  milestone_type = milestone
     94  #
     95  # Ticket field to use as the data source for the percent complete column (default: None).
     96  # fields.percent =
     97  #
     98  # Hours represented by each unit of estimated work (default: 1).
     99  # hours_per_estimate = 1
     100  #
     101  # Default work for an unestimated task, same units as estimate  (default: 4.0).
     102  # default_estimate = 4.0
     103  #
     104  # How much work may be remaining when a task goes over estimate, same units as estimate (default: 0.0)..
     105  # estimate_pad = 0.0
    81106}}}
    82107   * See [#Configuration configuration details] below for explanations and more options.