Changes between Version 1 and Version 2 of QueuesPlugin

Timestamp:

Jan 3, 2011, 11:48:10 PM (13 years ago)

Author:

Rob Guttman

Comment:

--

QueuesPlugin

@@ -7 +7 @@
 This plugin converts one or more reports into ticket 'queues'.  A ticket queue allows you to drag-and-drop tickets in your desired order.  Ticket positions in a queue get maintained in a custom field.
 
-The motivation for this plugin is for when you want to organize a queue of tickets in the order you intend to tackle the work.  Tickets could either use the milestone field as the 'bucket' or use a separate (custom) field.  An example may be helpful.
+The motivation for this plugin is for when you want to organize a queue of tickets in the order you intend to tackle the work.  Tickets could either use the milestone field as the 'bucket' or use a separate (custom) field.  See the [wiki:QueuesPlugin#Examples examples below] for more details.
+
+
+== Configuration ==
+ 1. Install the plugin (after downloading and unzipping):
+    {{{
+    cd queuesplugin/0.12
+    sudo python setup.py bdist_egg
+    sudo cp dist/TracQueues*.egg /your/trac/location/plugins/
+    }}}
+
+    See [http://trac.edgewall.org/wiki/TracPlugins TracPlugins] for more installation details and options.  You'll likely need to restart Trac's web server after installation.
+
+ 2. Enable the plugin:
+    {{{
+    [components]
+    queues.* = enabled
+    }}}
+
+    You can alternatively use the Trac Web Admin GUI to enable any or all rules.
+
+ 3. Create a custom field to contain the position information - example {{{trac.ini}}} config:
+    {{{
+    [ticket-custom]
+    position = text
+    }}}
+
+ 4. Create/modify reports to be used as ticket queues whose first column's name must match the (custom) field created in step 3 above:
+     * Can contain uppercase characters (which will get converted to lowercase)
+     * Can use spaces (which will get removed)
+
+ 5. Tell the queues plugin which reports to convert to queues - example {{{trac.ini}}} config:
+    {{{
+    [queues]
+    reports = 9, 10
+    }}}
+
+See the [wiki:QueuesPlugin#Examples examples below] for more detailed configuration examples and capabilities.
+
 
 == Bugs/Feature Requests ==