Changes between Version 1 and Version 2 of TicketFieldFilterPlugin

Timestamp:

Jul 30, 2016, 8:05:44 AM (8 years ago)

Author:

Cinc-th

Comment:

--

TicketFieldFilterPlugin

@@ -1 @@
-[[PageOutline(2-5,Contents,pullout)]]
+ [[PageOutline(2-5,Contents,pullout)]]
 
 = Filter ticket fields depending on ticket type and user permissions
@@ -9 +9 @@
 Configuration is done in the admin section.
 
+See also CondFieldsGenshiPlugin, CondFieldsPlugin, DynamicFieldsPlugin
 == !Bugs/Feature Requests
 
@@ -27 +28 @@
 You can check out TicketFieldFilterPlugin from [/svn/ticketfieldfilterplugin here] using Subversion, or [source:ticketfieldfilterplugin browse the source] with Trac.
 
-== Installation
+== Installation/Configuration
 
 General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.
+
+Enable the plugin in your trac.ini file:
+
+{{{#!ini
+[components]
+ticketfieldfilter.* = enabled
+}}}
+
+=== Configuration
+Note that configuration can be changed using an admin page in the ''Ticket'' section.
+
+For each ticket type you may set:
+* Which fields to show at all
+* If a shown field is read only. Read only fields don't show up in the ''Modify'' section.
+* A permission for a field. If the user doesn't have the necessary permission, the field is removed.
+
+Note that permissions only apply to fields which are enabled at all for the ticket type.
+
+Each entry in ''trac.ini'' starts with the ticket type.
+{{{#!ini
+[ticket-field-filter]
+<type>.fields = component, cc, type, ...
+<type>.readonly = component, cc, ...
+<type>.permission = component: PERM_1 | TICKET_CREATE, cc: PERM_2, ...
+}}}
+Leaving the entry {{{<type>.fields}}} empty disables all fields for the ticket type. Removing the entry completely enables all fields. Another way is to specify ''+'':
+
+{{{#!ini
+[ticket-field-filter]
+# enable all fields for ticket type 'defect'
+defect.fields = +
+}}}
+
+Note that the following fields can't be removed from the ticket page:
+
+{{{time, changetime, attachment}}}
+
+If the permission entry is missing or left empty no permission check takes place.
+
+You may specify a list of fields which are always shown:
+
+{{{#!ini
+[ticket-field-filter]
+required_fields = summary, reporter, owner, description, status, type, cc
+}}}
+
+Default is: {{{summary, reporter, owner, description, status}}}.
 
 == Recent Changes