You are here

Home » API reference » Improved Multi Select 8

README.txt in Improved Multi Select 8

Same filename in this branch
  1. 8 README.txt
  2. 8 modules/ims_options_widget/README.txt
Same filename and directory in other branches
  1. 6 README.txt
  2. 7.2 README.txt
  3. 7 README.txt
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Installation
 * Configuration
 * Maintainers


INTRODUCTION
------------

The Improved Multi Select module replace the default multi-select boxes with two
panel list and search. The first panel holds the options that are available, and
the second panel holds the options that have been selected. Two panels are
separated by "add" and "remove" buttons. You can select an item from the first
box, click the "add" button, and add it to the second box. Likewise, you can
select an item from the second box, click the "remove" button, and it goes back
into the unselected box. Re-Ordering buttons allow users to move items that
have been selected up and down.

A search box allows users to quickly filter the left column to find items.
Admins can decide how precise users need to be when entering searches.
Options include Exact Match, All Words, and Any Words.
For each option, admins can decide if they want to allow partial words.

Grouping allows users to drill down by category to find items. This is
especially useful when the user has a large list of items to select from.

Grouping works with search to enable cross-filtering.


REQUIREMENTS
------------

No special requirements for this module.


INSTALLATION
------------

* Install as usual, see http://drupal.org/node/70151 for further information.


CONFIGURATION
-------------

Settings can be configured at admin/config/user-interface/ims

 * Replace all multi-select lists
   - If checked, all multi-select fields will be replaced by improved
     multi-select widgets.

 * Replace multi-select lists on specific page
   - When not using the "Replace all multi-select lists" option, you can specify
     the pages on which multi-select field will be replaced by improved
     multi-select widgets. Enter one path per line.

 * Replace multi-select with specified selectors
   - When not using the "Replace all multi-select lists" option, you can specify
     element selectors for multi-select fields that will be replaced by improved
     multi-select widgets. Enter one selector per line.

 * Filter functionality
   - Allows admins to decide how precise users need to be when filtering.
     Options include Exact Match, All Words, and Any Words.
     For each option, admins can decide if they want partial words to match.

 * Allow re-ordering of selected items
   - If unchecked, "Move up" and "Move down" buttons will not be included.
     Selected items will always be in the order they appear in the original
     select field.
   - If checked, "Move up" and "Move Down" buttons will be included to change
     the order of selected items.
     Also, selected items will appear in the order they are added, instead of
     in the order of the original select field.

 * Reset filter when selecting a group
   - If checked, the search box and groups will work independently of one
     another. In this case, clicking on a group will clear the current filter.
   - If unchecked, the search box and groups can be used together for
     cross-filtering.

 * Remove required attribute
   - If checked, removes the required attribute from select elements to allow
     form submission and validation on Drupal side.
   - If unchecked causes https://www.drupal.org/project/improved_multi_select/issues/2922513

 * Button Text
   - These settings allow admins to customize the text or symbols for the
     buttons on the improved multi-select widgets.

The administration settings for this module can be configured by users with the
"administer site configuration" permission.


MAINTAINERS
-----------

Current maintainers:
* Dmitrii Varvashenia (dmitrii) - http://drupal.org/user/411965
* Reuben Turk (rooby) - http://drupal.org/user/350381

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3. 

  4.  * Introduction

  5.  * Requirements

  6.  * Installation

  7.  * Configuration

  8.  * Maintainers

  9. 

  10. 

  11. INTRODUCTION

  12. ------------

  13. 

  14. The Improved Multi Select module replace the default multi-select boxes with two

  15. panel list and search. The first panel holds the options that are available, and

  16. the second panel holds the options that have been selected. Two panels are

  17. separated by "add" and "remove" buttons. You can select an item from the first

  18. box, click the "add" button, and add it to the second box. Likewise, you can

  19. select an item from the second box, click the "remove" button, and it goes back

  20. into the unselected box. Re-Ordering buttons allow users to move items that

  21. have been selected up and down.

  22. 

  23. A search box allows users to quickly filter the left column to find items.

  24. Admins can decide how precise users need to be when entering searches.

  25. Options include Exact Match, All Words, and Any Words.

  26. For each option, admins can decide if they want to allow partial words.

  27. 

  28. Grouping allows users to drill down by category to find items. This is

  29. especially useful when the user has a large list of items to select from.

  30. 

  31. Grouping works with search to enable cross-filtering.

  32. 

  33. 

  34. REQUIREMENTS

  35. ------------

  36. 

  37. No special requirements for this module.

  38. 

  39. 

  40. INSTALLATION

  41. ------------

  42. 

  43. * Install as usual, see http://drupal.org/node/70151 for further information.

  44. 

  45. 

  46. CONFIGURATION

  47. -------------

  48. 

  49. Settings can be configured at admin/config/user-interface/ims

  50. 

  51.  * Replace all multi-select lists

  52.    - If checked, all multi-select fields will be replaced by improved

  53.      multi-select widgets.

  54. 

  55.  * Replace multi-select lists on specific page

  56.    - When not using the "Replace all multi-select lists" option, you can specify

  57.      the pages on which multi-select field will be replaced by improved

  58.      multi-select widgets. Enter one path per line.

  59. 

  60.  * Replace multi-select with specified selectors

  61.    - When not using the "Replace all multi-select lists" option, you can specify

  62.      element selectors for multi-select fields that will be replaced by improved

  63.      multi-select widgets. Enter one selector per line.

  64. 

  65.  * Filter functionality

  66.    - Allows admins to decide how precise users need to be when filtering.

  67.      Options include Exact Match, All Words, and Any Words.

  68.      For each option, admins can decide if they want partial words to match.

  69. 

  70.  * Allow re-ordering of selected items

  71.    - If unchecked, "Move up" and "Move down" buttons will not be included.

  72.      Selected items will always be in the order they appear in the original

  73.      select field.

  74.    - If checked, "Move up" and "Move Down" buttons will be included to change

  75.      the order of selected items.

  76.      Also, selected items will appear in the order they are added, instead of

  77.      in the order of the original select field.

  78. 

  79.  * Reset filter when selecting a group

  80.    - If checked, the search box and groups will work independently of one

  81.      another. In this case, clicking on a group will clear the current filter.

  82.    - If unchecked, the search box and groups can be used together for

  83.      cross-filtering.

  84. 

  85.  * Remove required attribute

  86.    - If checked, removes the required attribute from select elements to allow

  87.      form submission and validation on Drupal side.

  88.    - If unchecked causes https://www.drupal.org/project/improved_multi_select/issues/2922513

  89. 

  90.  * Button Text

  91.    - These settings allow admins to customize the text or symbols for the

  92.      buttons on the improved multi-select widgets.

  93. 

  94. The administration settings for this module can be configured by users with the

  95. "administer site configuration" permission.

  96. 

  97. 

  98. MAINTAINERS

  99. -----------

  100. 

  101. Current maintainers:

  102. * Dmitrii Varvashenia (dmitrii) - http://drupal.org/user/411965

  103. * Reuben Turk (rooby) - http://drupal.org/user/350381