Changes between Version 29 and Version 30 of ProjectPlanPlugin


Ignore:
Timestamp:
Mar 11, 2015, 2:06:36 PM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes, tagged with license

Legend:

Unmodified
Added
Removed
Modified

  • ProjectPlanPlugin

    v29 v30  
    11[[PageOutline(2-5,Contents,pullout)]]
    22
    3 = Project Plan Plugin =
    4 
    5 == Description ==
     3= Project Plan with automatic visualizations of the tickets
     4
     5== Description
    66
    77The !ProjectPlan plug-in provides automatic visualizations of the ticket set used in the project (filterable).
    … …  
    99The main contribution of this plug-in is to provide (configurable, graphical) overview of ticket types, states, owners, dates and priorities.
    1010
    11 
    12 The plug-in introduces three ticket attributes:
    13  * ''time to assign'': by the project plan at the latest at this date the owner of the ticket should start working on the task
    14  * ''time to close'': by the project plan at the latest at this date the ticket should be closed
    15  * ''dependencies'': tickets that have to be closed before the current ticket
     11The plug-in introduces the following ticket attributes:
     12 * '''time to assign''': by the project plan at the latest at this date the owner of the ticket should start working on the task
     13 * '''time to close''': by the project plan at the latest at this date the ticket should be closed
     14 * '''dependencies''': tickets that have to be closed before the current ticket
     15
    1616These attributes are used to draw, e.g. networks of tickets representing the suggested (topological) order of the tickets.
    1717Furthermore, it is a development base for several representations.
    … …  
    7474      * other small things in code and documentation
    7575
    76 == Software Requirements ==
    77 
    78  * Python 2.5 or 2.6 with Python Standard Library
    79  * a recent !GraphViz Package ( for compatibility issues visit [wiki:ProjectPlanPlugin/DotCompatibility here] )
    80  * XML Template Engine Genshi 0.51 or compatible (it is part of Trac 0.11 or later)
    81 
    82 == Basic Setup ==
    83 
    84 === 1. Install the plug-in ===
     76== Bugs/Feature Requests
     77
     78Existing bugs and feature requests for ProjectPlanPlugin are
     79[report:9?COMPONENT=ProjectPlanPlugin here].
     80
     81If you have any issues, create a
     82[http://trac-hacks.org/newticket?component=ProjectPlanPlugin&owner=anbo new ticket].
     83
     84[[TicketQuery(component=ProjectPlanPlugin&group=type,format=progress)]]
     85
     86== Download
     87
     88Download the zipped source from [download:projectplanplugin here].
     89
     90== Source
     91
     92You can check out ProjectPlanPlugin from [http://trac-hacks.org/svn/projectplanplugin here] using Subversion, or [source:projectplanplugin browse the source] with Trac.
     93
     94== Installation
     95
     96=== Dependencies
     97
     98 * Python 2.5 or 2.6 with Python Standard Library.
     99 * Recent !GraphViz Package, for compatibility issues visit [wiki:ProjectPlanPlugin/DotCompatibility here].
     100 * XML Template Engine Genshi 0.51 or compatible (part of Trac 0.11 and later).
     101
     102=== 1. Install the plug-in
    85103 * check out the source code (you can also use export instead of checkout)
    86104   {{{
    … …  
    95113 * deploy the created egg either globally or locally (locally is recommended at this point)
    96114
    97 This plugin can be installed globally via 
     115This plugin can be installed globally via:
    98116{{{
    99117#!sh
    100118easy_install http://trac-hacks.org/svn/projectplanplugin/0.11/trunk
    101 }}}
    102 and then enabling on a per-project instance by editing {{{trac.ini}}}:
     119}}}
     120
     121and then enabling on a per-project instance by editing `trac.ini`:
     122
    103123{{{
    104124#!ini
    … …  
    107127}}}
    108128
    109 
    110 === 2. Setup '''Ticket-Custom Fields''' ===
     129=== 2. Setup '''Ticket-Custom Fields'''
    111130   * in your projects ''trac.ini''
    112131   * For the case, you already have dependency, assign/close date ticket-custom fields
    … …  
    120139   }}}
    121140    * This lets !ProjectPlanPlugin use these configured fields
    122    * If you don't have corresponding dependency and date fields, they need to be added as ticket-custom fields
     141   * If you don't have corresponding dependency and date fields, they need to be added as ticket-custom fields:
    123142   {{{
    124143   #!ini
    … …  
    134153   }}}
    135154
    136 '''Note: If a standard Trac installation is used, the plug-in should work at this point in time.'''
    137 
    138 === 3. Basic !GraphViz Configuration (needed for networks) ===
     155'''Note''': If a standard Trac installation is used, the plug-in should work at this point in time.
     156
     157=== 3. Basic !GraphViz Configuration (needed for networks)
    139158
    140159  * login with administrative rights, navigate to admin (WebAdmin)
    … …  
    152171  * '''cachepath should be a separate directory for each project, this reduces possible cache collisions'''
    153172
    154 
    155 === 4. Color Setup ===
     173=== 4. Color Setup
    156174
    157175  * login with administrative rights, navigate to admin (WebAdmin)
    … …  
    159177  * set HTML color codes and apply settings
    160178
    161 === 5. Image Setup ===
     179=== 5. Image Setup
    162180
    163181  * login with administrative Rights, navigate to Admin (WebAdmin)
    … …  
    166184    * the smaller images (e.g., 16x16 pixel) can reduce the size of the graphical network representation
    167185
    168 === 6. Macro Arguments ===
     186=== 6. Macro Arguments
    169187
    170188  * The default settings {{{[[ProjectPlan()]]}}} produce a Hirarchical MPM-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.
    … …  
    172190  * a list of macro parameters can be found [wiki:ProjectPlanPlugin/MacroArgs here]
    173191
    174 == Daily Usage ==
    175 
    176  * The cache size can grow quite big because changes in tickets and per user/macro produce a lot of files and images
    177    * it is recommended to either wipe the cache in intervals or setup a daily cronjob to for cache cleaning
    178 
    179 == Example ==
    180 
    181 Add ticket dependencies and close/assign Times. [[BR]]
     192== Daily Usage
     193
     194The 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 wipe the cache manually or set up a daily cronjob to clean the cache automatically.
     195
     196== Example
     197
     198Add ticket dependencies and close/assign Times:
    182199  * Network Graphics
    183200    * Use the '''!ProjectPlan''' Macro for (mpm like) network graphics with several options enabling project runtime estimation and (workload based) critical path analyses.
    184201  * Special Reports
    185202    * Use special reports which show delays and slacktimes
    186   * ...
    187203
    188204Macro Samples:
    189   1. Both networks (hierarchical and non-hierarchical) use critical path analysis.
    190   This won't work without ticket times for '''all''' tickets (either start, end, or both).
    191   2. The critical path analysis won't work with cyclic dependencies
    192   3. Dependencies are saved in ticket-custom fields. A dependency line consists of Ticket Identifiers "#<Ticket ID>".
    193     * Sample Dependencies: ''#6 and #5,#3 #4''
     205 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).
     206 1. The critical path analysis won't work with cyclic dependencies
     207 1. Dependencies are saved in ticket-custom fields. A dependency line consists of Ticket Identifiers "#<Ticket ID>". Sample Dependencies: ''#6 and #5,#3 #4''
    194208 
    195209{{{
    196     == hierarchical Network ==
    197     [[ProjectPlan(macroid=1,renderer=gvhierarchical)]]
    198    
    199     == hierarchical Network with start and end times==
    200     [[ProjectPlan(macroid=1,renderer=gvhierarchical,betickets)]]
    201    
    202     == filtered (milestone=milestone1) ==
    203     [[ProjectPlan(macroid=filtered,renderer=gvhierarchical,filter_milestone=milestone1)]]
    204    
    205     == non-hierarchical (full network) ==
    206     [[ProjectPlan(renderer=gvrender,macroid=2,withbuffer)]]
    207    
    208     == Network Legends ==
    209     [[ProjectPlan(macroid=legend,renderer=gvrender,statuslegend,prioritylegend,notickets)]]
    210    
    211     == Special Reports ==
    212     [[ProjectPlan(macroid=report_buffer,renderer=report_buffer,limitlines=4)]]
    213     [[ProjectPlan(macroid=report_closing_delay,renderer=report_closing_delay,limitlines=10)]]
    214     [[ProjectPlan(macroid=report_assign_delay,renderer=report_assign_delay,limitlines=10)]]
    215 }}}
    216 
    217 == Devel ==
    218 
    219 [wiki:ProjectPlanPlugin_devel Development]
    220 
    221 == Known Incompatibilities ==
    222 
    223 The plugin (in particular {{{macroid=1}}} and {{{macroid=2}}}) does not work with older version of graphviz/dot, e.g. {{{dot version 2.6 (Fri Jun 16 16:00:18 UTC 2006)}}}.
    224 Please update to a newer version of graphviz, e.g. to {{{dot - Graphviz version 2.20.2 (Wed Jan 27 16:49:48 UTC 2010)}}}.
     210== Hierarchical Network ==
     211[[ProjectPlan(macroid=1,renderer=gvhierarchical)]]
     212
     213== Hierarchical Network with start and end times==
     214[[ProjectPlan(macroid=1,renderer=gvhierarchical,betickets)]]
     215
     216== Filtered (milestone=milestone1) ==
     217[[ProjectPlan(macroid=filtered,renderer=gvhierarchical,filter_milestone=milestone1)]]
     218
     219== non-hierarchical (full network) ==
     220[[ProjectPlan(renderer=gvrender,macroid=2,withbuffer)]]
     221
     222== Network Legends ==
     223[[ProjectPlan(macroid=legend,renderer=gvrender,statuslegend,prioritylegend,notickets)]]
     224
     225== Special Reports ==
     226[[ProjectPlan(macroid=report_buffer,renderer=report_buffer,limitlines=4)]]
     227[[ProjectPlan(macroid=report_closing_delay,renderer=report_closing_delay,limitlines=10)]]
     228[[ProjectPlan(macroid=report_assign_delay,renderer=report_assign_delay,limitlines=10)]]
     229}}}
     230
     231== Known Issues
     232
     233The 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)}}}.
     234Please update to a newer version of graphviz, eg to {{{dot - Graphviz version 2.20.2 (Wed Jan 27 16:49:48 UTC 2010)}}}.
    225235To check the version type {{{graphviz -V}}}.
    226 An [wiki:ProjectPlanPlugin/DotCompatibility overview of tested graphviz versions] is shown [wiki:ProjectPlanPlugin/DotCompatibility here].
    227 
    228 == Bugs/Feature Requests ==
    229 
    230 Existing bugs and feature requests for ProjectPlanPlugin are
    231 [report:9?COMPONENT=ProjectPlanPlugin here].
    232 
    233 If you have any issues, create a
    234 [http://trac-hacks.org/newticket?component=ProjectPlanPlugin&owner=anbo new ticket].
    235 
    236 == Download ==
    237 
    238 Download the zipped source from [download:projectplanplugin here].
    239 
    240 == Source ==
    241 
    242 You can check out ProjectPlanPlugin from [http://trac-hacks.org/svn/projectplanplugin here] using Subversion, or [source:projectplanplugin browse the source] with Trac.
    243 
    244 == Recent Changes ==
     236An [wiki:ProjectPlanPlugin/DotCompatibility overview of tested Graphviz versions] is shown [wiki:ProjectPlanPlugin/DotCompatibility here].
     237
     238== Recent Changes
    245239
    246240[[ChangeLog(projectplanplugin, 3)]]
    247241
    248 == Author/Contributors ==
     242== Author/Contributors
    249243
    250244'''Author:''' [wiki:makadev], [wiki:anbo]  [[BR]]
    251 '''Maintainer:''' anbo [[BR]]
     245'''Maintainer:''' [[Maintainer]] [[BR]]
    252246'''Contributors:'''