Changes between Version 35 and Version 36 of ProjectPlanPlugin


Ignore:
Timestamp:
Apr 13, 2022, 6:45:08 AM (2 years ago)
Author:
figaro
Comment:

Some cleanups, still needs work

Legend:

Unmodified
Added
Removed
Modified
  • ProjectPlanPlugin

    v35 v36  
    6363 * ticket statistics
    6464
     65=== Example usage
     66
     67Add ticket dependencies and close/assign Times:
     68  * Network Graphics
     69    * Use the '''!ProjectPlan''' Macro for network graphics with several options enabling project runtime estimation and (workload based) critical path analyses.
     70  * Special Reports
     71    * Use special reports which show delays and slacktimes.
     72
     73Macro Samples:
     74 1. Both networks (hierarchical and non-hierarchical) use critical path analysis. This won't work without ticket times for '''all''' tickets (either start, end, or both).
     75 1. The critical path analysis won't work with cyclic dependencies.
     76 1. Dependencies are saved in ticket-custom fields. A dependency line consists of Ticket Identifiers "#<Ticket ID>". Sample Dependencies: ''#6 and #5,#3 #4''.
     77 
     78{{{
     79== Hierarchical Network
     80
     81[[ProjectPlan(macroid=1, renderer=gvhierarchical)]]
     82
     83== Hierarchical Network with start and end times
     84
     85[[ProjectPlan(macroid=1, renderer=gvhierarchical, betickets)]]
     86
     87== Filtered (milestone=milestone1)
     88
     89[[ProjectPlan(macroid=filtered, renderer=gvhierarchical, filter_milestone=milestone1)]]
     90
     91== non-hierarchical (full network)
     92
     93[[ProjectPlan(renderer=gvrender, macroid=2, withbuffer)]]
     94
     95== Network Legends
     96
     97[[ProjectPlan(macroid=legend, renderer=gvrender, statuslegend, prioritylegend, notickets)]]
     98
     99== Special Reports
     100
     101[[ProjectPlan(macroid=report_buffer, renderer=report_buffer, limitlines=4)]]
     102[[ProjectPlan(macroid=report_closing_delay, renderer=report_closing_delay, limitlines=10)]]
     103[[ProjectPlan(macroid=report_assign_delay, renderer=report_assign_delay, limitlines=10)]]
     104}}}
     105
    65106Tested on Trac versions 0.11 and 0.12.
    66107
     
    93134 * XML Template Engine Genshi 0.51 or compatible (part of Trac 0.11 and later).
    94135
    95 === 1. Install the plugin
    96 
    97  * check out the source code (you can also use export instead of checkout):
     136=== Installation steps
     137
     138 * Check out the source code (you can also use export instead of checkout):
    98139   {{{#!sh
    99140svn checkout https://trac-hacks.org/svn/projectplanplugin/0.11/trunk
    100141}}}
    101  * run on the shell:
     142 * Run on the shell:
    102143   {{{#!sh
    103144python setup.py bdist_egg
    104145}}}
    105  * deploy the created egg either globally or locally; locally is recommended at this point.
     146 * Deploy the created egg either globally or locally; locally is recommended at this point.
    106147
    107148This plugin can be installed globally via:
     
    117158}}}
    118159
    119 === 2. Setup '''Ticket-Custom Fields'''
    120 
    121 This can be done in your `trac.ini` file.
    122    * For the case, you already have dependency, assign/close date ticket-custom fields.
     160== Configuration
     161
     162The configuration of this plugin can be done in your `trac.ini` file.
     163   * For when you already have dependencies defined, assign/close date ticket-custom fields.
    123164    * Add the field names (as long as the format is compatible) with:
    124165   {{{#!ini
     
    144185'''Note''': If a standard Trac installation is used, the plugin should work at this point.
    145186
    146 === 3. Basic !GraphViz Configuration (needed for networks)
     187=== Basic !GraphViz Configuration (needed for networks)
    147188
    148189  * Login with administrative rights, navigate to admin (WebAdmin).
     
    159200  * '''Cachepath should be a separate directory for each project, this reduces possible cache collisions'''.
    160201
    161 === 4. Color Setup
     202=== Color Setup
    162203
    163204  * Login with administrative rights, navigate to admin (WebAdmin).
     
    165206  * Set HTML color codes and apply settings.
    166207
    167 === 5. Image Setup
     208=== Image Setup
    168209
    169210  * Login with administrative Rights, navigate to Admin (WebAdmin).
     
    172213    * The smaller images, for example icons, can reduce the size of the graphical network representation.
    173214
    174 === 6. Macro Arguments
     215=== Macro Arguments
    175216
    176217  * The default settings {{{[[ProjectPlan()]]}}} produce a Hierarchical network with Version on toplevel, Milestone in Versions and Tickets as leafs in Milestones. All Tickets will be used for dependency, critical path and other calculations and visualisations.
     
    178219  * A list of macro parameters can be found [wiki:ProjectPlanPlugin/MacroArgs here].
    179220
    180 == Daily Usage
     221=== Daily Usage
    181222
    182223The cache size can grow quite big, because changes in tickets and per user/macro produce a lot of files and images. It is recommended to either periodically clear the cache manually or set up a daily cronjob to clean the cache automatically.
    183224
    184 == Example
    185 
    186 Add ticket dependencies and close/assign Times:
    187   * Network Graphics
    188     * Use the '''!ProjectPlan''' Macro for network graphics with several options enabling project runtime estimation and (workload based) critical path analyses.
    189   * Special Reports
    190     * Use special reports which show delays and slacktimes.
    191 
    192 Macro Samples:
    193  1. Both networks (hierarchical and non-hierarchical) use critical path analysis. This won't work without ticket times for '''all''' tickets (either start, end, or both).
    194  1. The critical path analysis won't work with cyclic dependencies.
    195  1. Dependencies are saved in ticket-custom fields. A dependency line consists of Ticket Identifiers "#<Ticket ID>". Sample Dependencies: ''#6 and #5,#3 #4''.
    196  
    197 {{{
    198 == Hierarchical Network
    199 
    200 [[ProjectPlan(macroid=1, renderer=gvhierarchical)]]
    201 
    202 == Hierarchical Network with start and end times
    203 
    204 [[ProjectPlan(macroid=1, renderer=gvhierarchical, betickets)]]
    205 
    206 == Filtered (milestone=milestone1)
    207 
    208 [[ProjectPlan(macroid=filtered, renderer=gvhierarchical, filter_milestone=milestone1)]]
    209 
    210 == non-hierarchical (full network)
    211 
    212 [[ProjectPlan(renderer=gvrender, macroid=2, withbuffer)]]
    213 
    214 == Network Legends
    215 
    216 [[ProjectPlan(macroid=legend, renderer=gvrender, statuslegend, prioritylegend, notickets)]]
    217 
    218 == Special Reports
    219 
    220 [[ProjectPlan(macroid=report_buffer, renderer=report_buffer, limitlines=4)]]
    221 [[ProjectPlan(macroid=report_closing_delay, renderer=report_closing_delay, limitlines=10)]]
    222 [[ProjectPlan(macroid=report_assign_delay, renderer=report_assign_delay, limitlines=10)]]
    223 }}}
    224 
    225 == Known Issues
     225=== Known Issues
    226226
    227227The plugin (in particular {{{macroid=1}}} and {{{macroid=2}}}) does not work with older version of graphviz/dot, eg {{{dot version 2.6 (Fri Jun 16 16:00:18 UTC 2006)}}}.