24 | | Check out the [http://trac-hacks.org/svn/multiselectfieldplugin plugin] using Subversion or easy_install etc. |
25 | | or [source:multiselectfieldplugin browse the source] with Trac. |
26 | | or Download the [download:multiselectfieldplugin zipped source]. |
| 25 | Download the zipped source from [export:multiselectfieldplugin here]. |
| 26 | |
| 27 | == Source |
| 28 | |
| 29 | Check out MultiSelectFieldPlugin from [/svn/multiselectfieldplugin here] using Subversion or easy_install etc., or [source:multiselectfieldplugin browse the source] with Trac. |
| 30 | |
| 31 | == Installation |
| 32 | |
| 33 | General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page. |
| 34 | |
| 35 | == Configuration |
| 36 | |
| 37 | 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`: |
| 38 | |
| 39 | `simple_selection`:: Instead of the more advanced "chosen" selection box, use a standard html multiselection box. Default value: `false`. |
| 40 | |
| 41 | `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: ' '. |
| 42 | |
| 43 | `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`. |
47 | | 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. |
48 | | |
49 | | == Plugin config |
50 | | |
51 | | The default config 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`: |
52 | | |
53 | | `simple_selection` (default value: false)[[BR]] |
54 | | Instead of the more advanced "chosen" selection box, use a standard html multiselection box. |
55 | | |
56 | | `data_delimiter` (default value: ' ')[[BR]] |
57 | | 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 is probably not a good idea. |
58 | | |
59 | | `strip_whitespace` (default value: true)[[BR]] |
60 | | 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 is probably not a good idea. |
| 61 | '''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. |