Changes between Version 13 and Version 14 of MultiSelectFieldPlugin


Ignore:
Timestamp:
Nov 25, 2015, 10:55:59 AM (8 years ago)
Author:
figaro
Comment:

Cosmetic changes, rearranged paragraphs to maintain consistency

Legend:

Unmodified
Added
Removed
Modified
  • MultiSelectFieldPlugin

    v13 v14  
    55== Description
    66
    7 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.
     7This 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.
    88
    9 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.
     9The 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.
    1010
    11 The selection component itself is using http://harvesthq.github.io/chosen/ to implement multiple selection in a more user friendly way.
     11The selection component itself uses http://harvesthq.github.io/chosen/ to implement multiple selection in a more user friendly way.
    1212
    1313== Bugs/Feature Requests
    1414
    15 Existing [report:9?COMPONENT=MultiSelectFieldPlugin bugs and feature requests].
     15Existing bugs and feature requests are
     16[report:9?COMPONENT=MultiSelectFieldPlugin here].
    1617
    1718If you have any issues, create a
    18 [http://trac-hacks.org/newticket?component=MultiSelectFieldPlugin&owner=ollika new ticket].
     19[/newticket?component=MultiSelectFieldPlugin new ticket].
    1920
    2021[[TicketQuery(component=MultiSelectFieldPlugin&group=type,format=progress)]]
     
    2223== Download
    2324
    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].
     25Download the zipped source from [export:multiselectfieldplugin here].
     26
     27== Source
     28
     29Check out MultiSelectFieldPlugin from [/svn/multiselectfieldplugin here] using Subversion or easy_install etc., or [source:multiselectfieldplugin browse the source] with Trac.
     30
     31== Installation
     32
     33General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.
     34
     35== Configuration
     36
     37The 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`.
    2744
    2845== Example
    2946
    30 Install and enable plugin. Then add a new custom field to your `conf/trac.ini`.
    31 
    3247For example this will add a new field supporting multiple selection called 'environment' with some predefined values:
    3348
    34 {{{
    35 #!ini
     49{{{#!ini
    3650[ticket-custom]
    3751environment = text
     
    4559[[Image(multiselectfield.2.png)]]
    4660
    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.
    6162
    6263== Recent Changes