Changes between Version 1 and Version 2 of BlackMagicTicketTweaksPlugin

Timestamp:

Jan 22, 2008, 5:15:50 AM (16 years ago)

Author:

Stephen Hansen

Comment:

--

BlackMagicTicketTweaksPlugin

@@ -29 +29 @@
 [http://trac-hacks.org/newticket?component=BlackMagicTicketTweaksPlugin&owner=ixokai new ticket].
 
-== Download ==
 
-Download the zipped source from [download:blackmagictickettweaksplugin here].
+== Installation and Configuration ==
 
-== Source ==
+=== Prerequisites ===
 
-You can check out BlackMagicTicketTweaksPlugin from [http://trac-hacks.org/svn/blackmagictickettweaksplugin here] using Subversion, or [source:blackmagictickettweaksplugin browse the source] with Trac.
+You probably need to install Genshi from the trunk before this will work (>=0.5dev), at least until 0.11 comes out final. 
+
+=== Download ===
+
+ * Download the zipped source from [download:blackmagictickettweaksplugin here].
+ * You can check out BlackMagicTicketTweaksPlugin from [http://trac-hacks.org/svn/blackmagictickettweaksplugin here] using Subversion, or [blackmagictickettweaksplugin browse the source] with Trac.
+
+=== Installation ===
+
+The easiest way to install the BlackMagicTicketTweaksPlugin is to simply point easy_install at the t-h.o SVN repository, a la:
+
+{{{
+ easy_install http://trac-hacks.org/svn/blackmagictickettweaksplugin/0.11
+}}}
+
+Alternatively, you may download the source and go into the 0.11 directory and then run:
+
+{{{
+ python setup.py install
+}}}
+
+After you have installed the BlackMagicTicketTweaksPlugin, you must enable it. You can do so in the Administration panel of Trac, or in trac.ini by adding:
+
+{{{
+[components]
+blackmagic.* = enabled
+}}}
+
+=== Configuration ===
+
+Any fields that you would like to tweak with this plugin must be listed in the ''tweaks'' option of the [blackmagictickettweaks] section in your TracIni. This list is comma-separated and lower case. For example:
+
+{{{
+[blackmagictickettweaks]
+tweaks = cc, priority, severity
+}}}
+
+Next you must specify all the actions that you want performed on those fields. You may have as many actions as you'd like.
+
+The actions are specified as ''<field>.<action> = <value>''
+
+{{{
+[blackmagictickettweaks]
+tweaks = priority
+priority.permission = TRAC_ADMIN
+}}}
+
+The following actions are supported at this time:
+
+ disable::
+  * If True, the field will be present and its value shown but it won't be editable.
+ hide::
+  *  If True, the field will be completely removed and so not settable and invisible.
+ label::
+  * The label for the field will be renamed to this value. Not terribly useful for the custom fields, but it lets you adjust the default fields names.
+ notice::
+  * Adds a small notice under the field; useful for little notes about the field.
+ tip::
+  * If the mouse hovers over the field, a pretty little tooltip (javascript required) will pop up offering some explanation.
+ permission::
+  * A comma-separated list of permissions that the user must have at least one of to edit this field. If they do not, the field will be disabled (as above). This allows per-field permissions.
+
+You may create new permissions in Trac for use above (or anywhere you'd like, really) by specifying the ''permission'' option, as in:
+
+{{{
+[blackmagictickettweaks]
+permissions = TICKET_CHG_PRIORITY, TICKET_CHG_CC
+}}}
 
 == Example ==