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

= Support simple multi selectbox field

== Description

This plugin treats pseudo multiple select values with the ticket custom field. See below for an example. It requires Trac 1.0 or higher, since it uses the `list` format of text type. See also TracTicketsCustomFields.

Key features:

 * Provide simple multiple select values field.
 * Compared to other alternatives, this plugin is intended to be simple and light weight, easy to use.

'''Select multiple values:'''

[[Image(multiselectbox1.png, border=2)]]

'''Show selected multiple values:'''

[[Image(multiselectbox2.png, border=2)]]

'''Revert selected multiple values:'''

[[Image(multiselectbox3.png, border=2)]]

Reverting multiple select values during editing is not possible (confirmed for version 1.0.2). To use Trac's revert function, you must apply a patch included in the source distribution:

{{{#!sh
$ cd path/to/trac
$ patch -p0 < patch/support-multipleselct-for-reverthandler-trac10.patch
$ restart Trac
}}}

This plugin was inspired by MultiSelectFieldPlugin, which is a good choice, if you are looking for a more feature-rich selectbox.

== Bugs/Feature Requests

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

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

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

== Download

Download the archived source from [pypi:TracMultiSelectBoxPlugin here].

== Source

You can clone TracMultiSelectBoxPlugin from the [pypi:TracMultiSelectBoxPlugin Pypi repository].

== Installation

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

== Configuration

To use multiple select values change your `trac.ini` file as follows:

{{{#!ini
[components]
multiselectbox.filter.multiselectbox = enabled

[ticket-custom]
multiselectfield = text
multiselectfield.format = list
multiselectfield.label = my custom field
multiselectfield.multiple = true
multiselectfield.options = foo bar baz  ; each value is delimited with space
multiselectfield.size = 4               ; size attribute passed to select tag
multiselectfield.value = bar            ; default value when new ticket is created
}}}

== Author/Contributors

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