Changes between Version 3 and Version 4 of MultiProductPlugin

Timestamp:

Feb 2, 2016, 6:20:20 PM (8 years ago)

Author:

figaro

Comment:

Embellished description

MultiProductPlugin

@@ -1 @@
-= Multi-Product Plugin
+[[PageOutline(2-5,Contents,pullout)]]
 
-MultiProductPlugin is a plug-in for the Trac that adds basic multiple product support by allowing per-product components and versions.
+= Add basic multiple product support
+
+== Description
+
+This is a plugin for Trac that adds basic multiple product support by allowing per-product components and versions.
 
 This plugin was written in response for a need for a sub-components field in the ticketing system.
 
 For more information, see https://github.com/trac-hacks/trac-multiproduct
+
+== Installation and Usage
+
+Because a patch must be applied to Trac before using this plugin, Trac must be installed with the following commands instead of through the operating system's package manager:
+
+{{{#!sh
+$ svn export http://svn.edgewall.org/repos/trac/tags/trac-VERSION trac
+$ svn export https://www.matbooth.co.uk/svn/trunk/multiproduct/patches/ patches
+$ cd trac/
+$ patch -p0 <../patches/depselect_support_trac-VERSION.patch
+$ python ./setup.py install
+}}}
+
+Where `VERSION` is your version of Trac. Currently supported versions are 0.11.4, 0.11.5 and 0.11.6.
+
+Now install the Multi-Product plugin:
+
+{{{#!sh
+$ easy_install -Z https://www.matbooth.co.uk/svn/trunk/multiproduct/
+}}}
+
+When the plugin is enabled in your `trac.ini` file it is also recommended that you disable the admin plugins for the component and version fields, since MultiProduct is really a replacement for these fields:
+
+{{{#!ini
+[components]
+multiproduct.* = enabled
+trac.ticket.admin.componentadminpanel = disabled
+trac.ticket.admin.versionadminpanel = disabled
+}}}
+
+The Trac environment will ask to be upgraded:
+
+{{{#!sh
+$ trac-admin /path/to/trac/environment upgrade
+}}}
+
+Once configured, Trac administrators will find a new ticket system admin panel for each of the fields added by the plugin.