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

= Add support for a multiselection dropdown box as a custom field in a ticket

== Description

This is a plugin allowing custom fields in tickets with multiple selection mode. Predefined values must be defined for each field, from which multiple values can be selected by the user.

The data is saved as a normal custom text field with the values separated by a single space. This way the normal Trac user interface will show the values in a sensible way too. Any spaces in the options are converted to '_' by default when saving the data.

For example this will add a new field supporting multiple selection called 'environment' with some predefined values:

{{{#!ini
[ticket-custom]
environment = text
environment.format = list
environment.label = Environment
environment.multiselect = true
environment.options = Android|iPhone|iPad|Windows|Linux|MacOs
environment.order = 2
}}}

On screen this will be displayed as follows:

[[Image(multiselectfield.2.png)]]

'''Note''': Adding new selection choices is always fine. However, be careful when changing the existing options of a field when there is existing data with the old options. When you view a ticket the ui will only show currently valid options. Any old options will be cleared when the ticket is modified and the field in question has been changed.

The selection component itself uses http://harvesthq.github.io/chosen/ to implement multiple selection in a more user friendly way.

See also: TracMultiSelectBoxPlugin

== Bugs/Feature Requests

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

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

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

== Download

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

== Source

Check out MultiSelectFieldPlugin using Subversion from [/svn/multiselectfieldplugin here], or [source:multiselectfieldplugin browse the source] with Trac.

== Installation

General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.

== Configuration

The default configuration should be fine for most people, but if you need to change how the data is saved you can add these options under `[multiselectfield]` in `conf/trac.ini`:

 `simple_selection`:: Instead of the more advanced "chosen" selection box, use a standard html multiselection box. Default value: `false`.

 `data_delimiter`:: The delimiter that is used when storing the data (as the selected options are appended to a single custom text field). Space is used by default as values separated by space will be recognized by the custom text field in list mode as separate values. Note: changing this option when there is already data saved with other options value may lead to unpredictable behavior. Default value: ' '.

 `strip_whitespace`:: Defined whether whitespace in the names of the predefined selectable values is removed before saving the data (whitespace will be converted to underscores). This should be enabled when using white space as data delimiter. Note: changing this option when there is already data saved with other options value may lead to unpredictable behavior. Default value: `true`.

== Recent Changes

[[ChangeLog(multiselectfieldplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:ollika] ([https://suikki.github.io/]) [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:'''