[[PageOutline(2-5,Contents,pullout)]]

= Categorizing ticket fields in Trac

== Description

This plugin's purpose is to categorize ticket fields.

This plugin can help in the following situations:
* Your ticket has a lot of fields and need to be compartimentalised for usability purposes.
* The fields of your ticket that are available varies under different conditions.
* Some fields of a ticket should only be visible to an authorized user (not implemented).

'''Ticket view'''

[[Image(ticket-view.PNG, border=2)]]

'''Ticket edit'''

[[Image(ticket-edit.PNG, border=2)]]

== !Bugs/Feature Requests

Existing bugs and feature requests for CatagorizedFieldsPlugin are 
[report:9?COMPONENT=CatagorizedFieldsPlugin here].

If you have any issues, create a 
[/newticket?component=CatagorizedFieldsPlugin new ticket].

[[TicketQuery(component=CatagorizedFieldsPlugin&group=type,format=progress)]]

== Download

Download the zipped source from [export:catagorizedfieldsplugin here].

== Source

You can check out CatagorizedFieldsPlugin from [/svn/catagorizedfieldsplugin here] using Subversion, or [source:catagorizedfieldsplugin browse the source] with Trac.

== Installation

1. Install the plugin just like any other, see [TracPlugins#InstallingaTracplugin TracPlugins] for general instructions.
2. Edit your `trac.ini` file:
 1. Enable the plugin:
{{{#!ini
[components]
catagorizedfields.catagorizedfields = enabled
}}}
 2. Create a {{{[catagorized-fields]}}} section, and add the categories, for example:
{{{#!ini
[catagorized-fields]
# declare a catagory in syntax "(catagory_id) = (catagory_display_name)"
cat1 = catagory_one

# specify the hide condition in syntax "(catagory_id).hide_when_(condition-field) = (field-value1)[, (field-value2), ..]"
cat1.hide_when_status = new, closed

# the order of category: the smaller the index, the closer the category is to the top
cat1.index = 1
}}}
 3. In {{{[ticket-custom]}}} section, specify your fields with category property:
{{{#!ini
[ticket-custom]
custom_field1 = text

# declare one field with catagory in syntax "(field_id).catagory = (catagory_id)"
custom_field1.catagory = cat1

# the order of field: the smaller the index, the closer the field is to the top
custom_field1.index = 1
}}}

== Recent Changes

[[ChangeLog(catagorizedfieldsplugin, 3)]]

== !Author/Contributors

'''Author:''' [wiki:cauly] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:'''