Changes between Version 30 and Version 31 of ProjectPlanPlugin


Ignore:
Timestamp:
Sep 18, 2015, 3:00:59 PM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified

  • ProjectPlanPlugin

    v30 v31  
    55== Description
    66
    7 The !ProjectPlan plug-in provides automatic visualizations of the ticket set used in the project (filterable).
     7This plugin provides automatic visualizations of the ticket set used in the project (filterable).
    88This should overcome the problems that appear while organizing many developers or many tickets.
    9 The main contribution of this plug-in is to provide (configurable, graphical) overview of ticket types, states, owners, dates and priorities.
    10 
    11 The plug-in introduces the following ticket attributes:
     9The main contribution of this plugin is to provide (configurable, graphical) overview of ticket types, states, owners, dates and priorities.
     10
     11The plugin introduces the following ticket attributes:
    1212 * '''time to assign''': by the project plan at the latest at this date the owner of the ticket should start working on the task
    1313 * '''time to close''': by the project plan at the latest at this date the ticket should be closed
    … …  
    1818The architecture enables contributors to add their own visualizations.
    1919
    20 {{{
    21 #!html
     20{{{#!html
    2221<div style="clear:both"></div>
    2322<div style="float:right;">
    … …  
    5150</div>
    5251
    53 
    54 </div>
    55 
    56 }}}
    57 
    58   * Information about the Current Version
    59     * Features ([source:projectplanplugin/0.11/trunk/examples examples]):
    60       * works nearly out of the box
    61       * !GraphViz based MPM Network
    62       * !GraphViz based hierarchical MPM network
    63       * critical path analysis (simple workload bases)
    64       * sorted reports for delayed tickets and slack times
    65       * animated burn-down charts
    66       * time table of developers and tickets
    67       * ticket statistics
    68       * other small things
    69     * Tested Trac versions
    70       * 0.11
    71       * 0.12
    72     * Known Problems:
    73       * possible unused imports in several modules
    74       * other small things in code and documentation
     52</div>
     53}}}
     54
     55Key features ([source:projectplanplugin/0.11/trunk/examples examples]):
     56 * works nearly out of the box
     57 * !GraphViz based MPM Network
     58 * !GraphViz based hierarchical MPM network
     59 * critical path analysis (simple workload bases)
     60 * sorted reports for delayed tickets and slack times
     61 * animated burn-down charts
     62 * time table of developers and tickets
     63 * ticket statistics
     64
     65Tested on Trac versions 0.11 and 0.12.
    7566
    7667== Bugs/Feature Requests
    … …  
    8071
    8172If you have any issues, create a
    82 [http://trac-hacks.org/newticket?component=ProjectPlanPlugin&owner=anbo new ticket].
     73[/newticket?component=ProjectPlanPlugin new ticket].
    8374
    8475[[TicketQuery(component=ProjectPlanPlugin&group=type,format=progress)]]
    … …  
    10091 * XML Template Engine Genshi 0.51 or compatible (part of Trac 0.11 and later).
    10192
    102 === 1. Install the plug-in
    103  * check out the source code (you can also use export instead of checkout)
    104    {{{
    105    #!sh
     93=== 1. Install the plugin
     94 * check out the source code (you can also use export instead of checkout):
     95   {{{#!sh
    10696svn checkout http://trac-hacks.org/svn/projectplanplugin/0.11/trunk
    107    }}}
    108  * run on the shell
    109    {{{
    110    #!sh
     97}}}
     98 * run on the shell:
     99   {{{#!sh
    111100python setup.py bdist_egg
    112    }}}
    113  * deploy the created egg either globally or locally (locally is recommended at this point)
     101}}}
     102 * deploy the created egg either globally or locally; locally is recommended at this point.
    114103
    115104This plugin can be installed globally via:
    116 {{{
    117 #!sh
     105{{{#!sh
    118106easy_install http://trac-hacks.org/svn/projectplanplugin/0.11/trunk
    119107}}}
    … …  
    121109and then enabling on a per-project instance by editing `trac.ini`:
    122110
    123 {{{
    124 #!ini
     111{{{#!ini
    125112[components]
    126113projectplan.* = enabled
    … …  
    128115
    129116=== 2. Setup '''Ticket-Custom Fields'''
    130    * in your projects ''trac.ini''
    131    * For the case, you already have dependency, assign/close date ticket-custom fields
    132     * Add the field names (as long as the format is compatible) with
    133    {{{
    134    #!ini
     117
     118This can be done in your `trac.ini` file.
     119   * For the case, you already have dependency, assign/close date ticket-custom fields.
     120    * Add the field names (as long as the format is compatible) with:
     121   {{{#!ini
    135122[pp_options]
    136123custom_dependency_field = <your dependency fieldname>
    137124custom_due_assign_field = <your assign Date fieldname>
    138125custom_due_close_field = <your close Date fieldname>
    139    }}}
    140     * This lets !ProjectPlanPlugin use these configured fields
     126}}}
     127    * This lets !ProjectPlanPlugin use these configured fields.
    141128   * If you don't have corresponding dependency and date fields, they need to be added as ticket-custom fields:
    142    {{{
    143    #!ini
     129   {{{#!ini
    144130[ticket-custom]
    145131dependencies = text
    … …  
    151137due_close.label = Due to close
    152138due_close.value = DD/MM/YYYY
    153    }}}
    154 
    155 '''Note''': If a standard Trac installation is used, the plug-in should work at this point in time.
     139}}}
     140
     141'''Note''': If a standard Trac installation is used, the plugin should work at this point.
    156142
    157143=== 3. Basic !GraphViz Configuration (needed for networks)
    158144
    159   * login with administrative rights, navigate to admin (WebAdmin)
    160     * select the panel ''!ProjectPlan -> General Settings'' (on the left)
    161     * verify the settings for '''cachepath''' and '''dot_executable'''
    162   * or set the following options in the projects trac.ini
    163     {{{
    164    #!ini
     145  * Login with administrative rights, navigate to admin (WebAdmin).
     146    * Select the panel ''!ProjectPlan -> General Settings'' (on the left).
     147    * Verify the settings for '''cachepath''' and '''dot_executable'''.
     148  * or set the following options in your `trac.ini` file:
     149    {{{#!ini
    165150[pp_options]
    166151cachepath = <full path to the cache directory>
    167152dot_executable = <path to graphviz binaries>\dot.exe
    168     }}}
    169     * restart your web server for configuration reload
    170   * verify access and execution rights for the web server User
    171   * '''cachepath should be a separate directory for each project, this reduces possible cache collisions'''
     153}}}
     154    * Restart your web server for configuration reload.
     155  * Verify access and execution rights for the web server User.
     156  * '''Cachepath should be a separate directory for each project, this reduces possible cache collisions'''.
    172157
    173158=== 4. Color Setup
    174159
    175   * login with administrative rights, navigate to admin (WebAdmin)
    176   * select the panel ''!ProjectPlan -> Color Settings'' (on the left)
    177   * set HTML color codes and apply settings
     160  * Login with administrative rights, navigate to admin (WebAdmin).
     161  * Select the panel ''!ProjectPlan -> Color Settings'' (on the left).
     162  * Set HTML color codes and apply settings.
    178163
    179164=== 5. Image Setup
    180165
    181   * login with administrative Rights, navigate to Admin (WebAdmin)
    182   * select the panel ''!ProjectPlan -> Image Settings'' (on the left)
    183   * select the images, you'd like to use and apply settings
    184     * the smaller images (e.g., 16x16 pixel) can reduce the size of the graphical network representation
     166  * Login with administrative Rights, navigate to Admin (WebAdmin).
     167  * Select the panel ''!ProjectPlan -> Image Settings'' (on the left).
     168  * Select the images, you'd like to use and apply settings.
     169    * The smaller images (e.g., 16x16 pixel) can reduce the size of the graphical network representation.
    185170
    186171=== 6. Macro Arguments
    187172
    188173  * 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.
    189   * several macro parameter control the visualization, calculation and ticket filters/queries.
    190   * a list of macro parameters can be found [wiki:ProjectPlanPlugin/MacroArgs here]
     174  * Several macro parameter control the visualization, calculation and ticket filters/queries.
     175  * A list of macro parameters can be found [wiki:ProjectPlanPlugin/MacroArgs here].
    191176
    192177== Daily Usage
    193178
    194 The 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.
     179The 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.
    195180
    196181== Example
    … …  
    200185    * Use the '''!ProjectPlan''' Macro for (mpm like) network graphics with several options enabling project runtime estimation and (workload based) critical path analyses.
    201186  * Special Reports
    202     * Use special reports which show delays and slacktimes
     187    * Use special reports which show delays and slacktimes.
    203188
    204189Macro Samples:
    205190 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''
     191 1. The critical path analysis won't work with cyclic dependencies.
     192 1. Dependencies are saved in ticket-custom fields. A dependency line consists of Ticket Identifiers "#<Ticket ID>". Sample Dependencies: ''#6 and #5,#3 #4''.
    208193 
    209194{{{
    210 == Hierarchical Network ==
     195== Hierarchical Network
     196
    211197[[ProjectPlan(macroid=1,renderer=gvhierarchical)]]
    212198
    213 == Hierarchical Network with start and end times==
     199== Hierarchical Network with start and end times
     200
    214201[[ProjectPlan(macroid=1,renderer=gvhierarchical,betickets)]]
    215202
    216 == Filtered (milestone=milestone1) ==
     203== Filtered (milestone=milestone1)
     204
    217205[[ProjectPlan(macroid=filtered,renderer=gvhierarchical,filter_milestone=milestone1)]]
    218206
    219 == non-hierarchical (full network) ==
     207== non-hierarchical (full network)
     208
    220209[[ProjectPlan(renderer=gvrender,macroid=2,withbuffer)]]
    221210
    222 == Network Legends ==
     211== Network Legends
     212
    223213[[ProjectPlan(macroid=legend,renderer=gvrender,statuslegend,prioritylegend,notickets)]]
    224214
    225 == Special Reports ==
     215== Special Reports
     216
    226217[[ProjectPlan(macroid=report_buffer,renderer=report_buffer,limitlines=4)]]
    227218[[ProjectPlan(macroid=report_closing_delay,renderer=report_closing_delay,limitlines=10)]]
    … …  
    236227An [wiki:ProjectPlanPlugin/DotCompatibility overview of tested Graphviz versions] is shown [wiki:ProjectPlanPlugin/DotCompatibility here].
    237228
     229Other issues:
     230 * Possible unused imports in several modules.
     231 * Code cleanup and documentation required.
     232
    238233== Recent Changes
    239234