Changes between Version 5 and Version 6 of TracSlimTimerPlugin


Ignore:
Timestamp:
Apr 27, 2007, 8:17:55 AM (8 years ago)
Author:
tst
Comment:

Added some installation instructions

Legend:

Unmodified
Added
Removed
Modified
  • TracSlimTimerPlugin

    v5 v6  
    11= Trac and !SlimTimer integration =
     2[[TOC]]
    23
    34== Description ==
     
    1516=== Synchronisation ===
    1617
    17 When a trac ticket enters the ''assigned'' state (i.e. it is ''accepted'' by someone), !TracSlimTimer creates a corresponding task in SlimTimer. The ID of the SlimTimer task is then recorded with the trac ticket (as a custom field).
     18When a trac ticket enters the '''assigned''' state (i.e. it is ''accepted'' by someone), !TracSlimTimer creates a corresponding task in !SlimTimer. The ID of the !SlimTimer task is then recorded with the trac ticket (as a custom field).
    1819
    1920The operation is shown below.
     
    3031More generally, synchronisation occurs when:
    3132
    32  * a ticket is assigned. Note that it is not just sufficient to put a name in the "assigned to" field. The assigned person also needs to ''accept'' the ticket before it enters the assigned state. Until then the ticket is in the "new" state.
     33 * a ticket is assigned. Note that it is not just sufficient to put a name in the "assigned to" field. The assigned person also needs to '''accept''' the ticket before it enters the assigned state. Until then the ticket is in the "new" state.
    3334 * a ticket is closed.
    3435 * a ticket is reopened.
     
    5455=== Reporting ===
    5556
    56 The second function of !TracSlimTimer is to collect all the SlimTimer data for the configured users and record it in a separate data store. This provides a backup of the SlimTimer data and allows reporting for a whole group of users.
     57The second function of !TracSlimTimer is to collect all the !SlimTimer data for the configured users and record it in a separate data store. This provides a backup of the !SlimTimer data and allows reporting for a whole group of users.
    5758
    5859The operation is shown below.
     
    7172Not all users will require this function and it is possible to operate !TracSlimTimer without a database.
    7273
    73 == Supported versions ==
     74== Supported Versions ==
    7475
    7576This plugin will currently only work with trac 0.10. This is because:
     
    8182
    8283== Installation ==
     84
     85Most of all read [http://trac.edgewall.org/wiki/TracPlugins TracPlugins]. Also, if you get stuck [http://trac.edgewall.org/wiki/TracDev/PluginDevelopment PluginDevelopment] is very useful.
     86
     87 1. Install the plugin. If you want to run it from source you might use something like,
     88
     89{{{
     90/opt/trac/0.10.3/install/bin/python setup.py develop -md /var/trac/0.10.3/var/trac/plugins
     91}}}
     92
     93Otherwise you can can make the egg and use easy_install. e.g.
     94
     95{{{
     96/opt/trac/0.10.3/install/bin/python setup.py bdist_egg
     97}}}
     98
     99Then run `/opt/trac/0.10.3/install/bin/easy_install <egg>` where `<egg>` is whatever got dumped in your `dist` directory.
     100
     101You might have some trouble with dependencies. If you do check below under dependencies.
     102
     103 2. Enable the plugin in trac.ini. For example, in `/var/trac/0.10.3/var/trac/conf/trac.ini.` you should add `tracslimtimer.* = enabled` under `[components]`, e.g.
     104
     105{{{
     106...
     107[components]
     108...
     109tracslimtimer.* = enabled
     110}}}
     111
     112 3. Upgrade (setup) the environment for the plugin by running trac-admin, e.g.
     113
     114{{{
     115/opt/trac/0.10.3/install/bin/trac-admin /var/trac/0.10.3/var/trac upgrade
     116}}}
     117
     118This adds the slimtimer_id custom ticket field. If you skip this step you'll probably get an error in the error.log (see below for more information on troubleshooting).
     119
     120{{{
     121[Tue Apr 24 12:50:34 2007] [error] [client 10.0.10.177] PythonHandler trac.web.modpython_frontend: TracError: The Trac Environment needs to be upgraded. Run trac-admin /var/trac/0.10.3/var/trac upgrade", referer: ...
     122}}}
     123
     124 4. Restart the trac server, e.g.
     125
     126{{{
     127/opt/trac/0.10.3/install/etc/init.d/httpd restart
     128}}}
     129
     130== Developers Guide ==
     131
     132== Troubleshooting ==
     133
     134== Dependencies ==
    83135
    84136== Bugs/Feature Requests ==