Changes between Version 9 and Version 10 of MultiSelectFieldPlugin

Timestamp:

Nov 1, 2015, 12:05:06 PM (8 years ago)

Author:

Olli Kallioinen

Comment:

--

MultiSelectFieldPlugin

@@ -7 +7 @@
 Plugin allowing custom fields in tickets supporting 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 text field with the values separated by '|'.
+The data is saved as a normal custom text field with the values separated by a single space (this way the normal trac ui will show the values in a sensible way too). Any spaces in the options is converted to '_' by default when saving the data.
 
 The selection component itself is using http://harvesthq.github.io/chosen/ to implement multiple selection in a more user friendly way.
@@ -23 +23 @@
 == Download
 
-Download the zipped source from [download:multiselectfieldplugin here].
-
-== Source
-
-You can check out MultiSelectFieldPlugin from [http://trac-hacks.org/svn/multiselectfieldplugin here] using Subversion, or [source:multiselectfieldplugin browse the source] with Trac.
+Check out the [http://trac-hacks.org/svn/multiselectfieldplugin plugin] using Subversion or easy_install etc.
+ or [source:multiselectfieldplugin browse the source] with Trac. 
+ or Download the [download:multiselectfieldplugin zipped source].
 
 == Example
 
-Install and enable plugin. Then add a new custom field to your `conf/trac.ini`, for example:
+Install and enable plugin. Then add a new custom field to your `conf/trac.ini`.
+
+For example this will add a new field supporting multiple selection called 'environment' with some predefined values:
+
 {{{
 #!ini
@@ -43 +44 @@
 }}}
 
-This will add a new field supporting multiple selection called 'environment' with some predefined values.
-
 [[Image(multiselectfield.2.png)]]
 
-== TODO
+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.
 
- * Graphics are glitching a bit with the remove 'x' button.
- * Behaviour when removing predefined option that is in use in existing tickets is not well defined or tested.
+== Plugin config
+
+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`:
+
+`data_delimiter` (default value: ' ')
+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. 
+
+`option_strip_whitespace` (default value: true)
+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 options when there is already data saved with other options value is probably not a good idea.
 
 == Recent Changes