Changes between Version 37 and Version 38 of TracJsGanttPlugin

Timestamp:

Nov 8, 2012, 9:15:50 PM (12 years ago)

Author:

Chris Nelson

Comment:

Notes about pred-succ and parent-child relations.

TracJsGanttPlugin

@@ -37 +37 @@
 || `openLevel`|| ||How many levels of task hierarchy to show open.  `1` = only top level task.  ||  `999`  ||
 || `res`|| ||Show (`1`) resource column, or do not (`0`). ||  `1`  ||
-|| `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  ||
+|| `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 or `parentchild` relation 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  ||
 || `sample`|| ||Display (`1`) sample tasks in Gantt, or do not (`0`) ||  `0`  ||
 || `schedule`|| ||Schedule algorithm: as-last-as-possible (`alap`) or as-soon-as-possible (`asap`) ||  `alap`  ||
@@ -150 +150 @@
   fields.succ = blocking
 
+  # Alternatively, configure a pred-succ relation like:
+  #    relation.pred-succ = mastertickets,source,dest
+  # This causes TracPM to query the mastertickets table rather than
+  # parse blockedby and blocking custom fields.  This can be somewhat
+  # faster.
+
+
   # To work with SubticketsPlugin for parent/child relationships, 
-  ## Ticket field to use as the data source for the parent 
+  # Ticket field to use as the data source for the parent 
   fields.parent = parents
-  
+
+  # Alternatively, configure a parent-child relation like:
+  #    relation.parent-child = subtickets,parent,child
+  # This causes TracPM to query the subtickets table rather than parse 
+  # the `parents` custom field.  This can be somewhat faster.
+  # When using SubticketsPlugin via a parent-child relation, do not 
+  # configure a parent_format (next).
+
+ 
   # To work with ChildTickets plugin parent_format, '#%s',
   # Format of ticket IDs in parent field (default: %s).
@@ -159 +174 @@
   
   # Custom fields for start and due dates
-  ## Ticket field to use as the data source for start date (default: None)
+  # Ticket field to use as the data source for start date (default: None)
   fields.start = userstart
-  ## Ticket field to use as the data source for finish date (default: None)
+  # Ticket field to use as the data source for finish date (default: None)
   fields.finish = userfinish
   
@@ -182 +197 @@
   estimate_pad = 0.0
 }}}
-   * See [#Configuration configuration details] below for explanations and more options.
+   * See [#Configurationdetails configuration details] below for explanations and more options.
    * Additionally, site-wide defaults for macro arguments may be set at [trac-jsgantt] section. More details about them see [#Arguments #Arguments section].
 {{{