You are here

README.txt in Simple hierarchical select 7

Same filename and directory in other branches
  1. 8 README.txt
  2. 2.0.x README.txt
-- SUMMARY --

The Simple hierarchical select module displays selected taxonomy fields as
hierarchical selects on node creation/edit forms and as exposed filter in views.


-- REQUIREMENTS --

Taxonomy module (Drupal core) needs to be enabled.


-- INSTALLATION --

* Install as usual, see http://drupal.org/documentation/install/modules-themes/modules-7
  for further information.


-- CONFIGURATION --

* Create a new field (type "Term reference") and select
  "Simple hierarchical select" as widget type.

* Field settings
  - "Allow creating new terms"
    Terms may be created directly from within the dropdowns (user needs to have
    permission to create terms in the vocabulary).
  - "Allow creating new levels"
    If selected users with permission to create terms in the vocabulary will be
    able to create a new term as child of the currently selected term.
  - "Force selection of deepest level"
    Force users to select terms from the deepest level.

* Views (exposed filter)
  - add a new filter using the field set-up as "Simple hierarchical select" or
    use "Content: Has taxonomy terms (with depth; Simple hierarchical select)"
    as a new filter
  - use "Simple hierarchical select" as selection type
  - select "Expose this filter to visitors, to allow them to change it"
  - enjoy :)


-- INTEGRATION WITH OTHER MODULES --

* Chosen (http://drupal.org/project/chosen)
  - If you have installed the module "Chosen" (>= 7.x-2.x) all elements of
    "Simple hierarchical select" are modified, so the user can search for items
    within the list. See http://drupal.org/project/chosen for more information.
  - If you have configured "Chosen" to apply always but do not want to apply it
    to the dropdowns created by "Simple hierarchical select" you may use the
    following CSS selector in the "Chosen" configuration:
    <code>select:visible:not(.shs-select)</code>
  - Apart from that you can select whether to use chosen on a per-field base by
    setting the option "Output this field with Chosen" in the field
    configuration.
    - "let chosen decide"
      The field is modified by Chosen if it matches the Chosen configuration.
    - "always"
      The field is always modified by Chosen.
    - "never"
      The field is not modified by Chosen even if it matches the Chosen
      configuration.

* High-performance JavaScript callback handler (http://drupal.org/project/js)
  - If you have lots of terms and a huge hierarchy you could increase the
    performance of "Simple hierarchical select" by installing "JS". It routes
    all javascript callbacks needed by "Simple hierarchical select" through a
    custom handler to avoid loading of all Drupal functions and speed up
    loading.

* Entity reference (https://www.drupal.org/project/entityreference)
  - "Simple hierarchical select" works out of the box with simple entity
    reference fields. In case you use Views as entity selection mode for your
    field there may be some problems, though.
    Your reference view needs at least one filter for the vocabulary. Otherwise
    "Simple hierarchical select" has no chance to retrieve the list of possible
    options to display.
    More complex reference views may cause "Simple hierarchical select" to fail,
    so its best to keep it as simple as possible.


-- CONTACT --

Current maintainers:
* Stefan Borchert (stborchert) - http://drupal.org/user/36942

This project has been sponsored by:
* undpaul
  Drupal experts providing professional Drupal development services.
  Visit http://www.undpaul.de for more information.

File

README.txt
View source
  1. -- SUMMARY --
  2. The Simple hierarchical select module displays selected taxonomy fields as
  3. hierarchical selects on node creation/edit forms and as exposed filter in views.
  4. -- REQUIREMENTS --
  5. Taxonomy module (Drupal core) needs to be enabled.
  6. -- INSTALLATION --
  7. * Install as usual, see http://drupal.org/documentation/install/modules-themes/modules-7
  8. for further information.
  9. -- CONFIGURATION --
  10. * Create a new field (type "Term reference") and select
  11. "Simple hierarchical select" as widget type.
  12. * Field settings
  13. - "Allow creating new terms"
  14. Terms may be created directly from within the dropdowns (user needs to have
  15. permission to create terms in the vocabulary).
  16. - "Allow creating new levels"
  17. If selected users with permission to create terms in the vocabulary will be
  18. able to create a new term as child of the currently selected term.
  19. - "Force selection of deepest level"
  20. Force users to select terms from the deepest level.
  21. * Views (exposed filter)
  22. - add a new filter using the field set-up as "Simple hierarchical select" or
  23. use "Content: Has taxonomy terms (with depth; Simple hierarchical select)"
  24. as a new filter
  25. - use "Simple hierarchical select" as selection type
  26. - select "Expose this filter to visitors, to allow them to change it"
  27. - enjoy :)
  28. -- INTEGRATION WITH OTHER MODULES --
  29. * Chosen (http://drupal.org/project/chosen)
  30. - If you have installed the module "Chosen" (>= 7.x-2.x) all elements of
  31. "Simple hierarchical select" are modified, so the user can search for items
  32. within the list. See http://drupal.org/project/chosen for more information.
  33. - If you have configured "Chosen" to apply always but do not want to apply it
  34. to the dropdowns created by "Simple hierarchical select" you may use the
  35. following CSS selector in the "Chosen" configuration:
  36. select:visible:not(.shs-select)
  37. - Apart from that you can select whether to use chosen on a per-field base by
  38. setting the option "Output this field with Chosen" in the field
  39. configuration.
  40. - "let chosen decide"
  41. The field is modified by Chosen if it matches the Chosen configuration.
  42. - "always"
  43. The field is always modified by Chosen.
  44. - "never"
  45. The field is not modified by Chosen even if it matches the Chosen
  46. configuration.
  47. * High-performance JavaScript callback handler (http://drupal.org/project/js)
  48. - If you have lots of terms and a huge hierarchy you could increase the
  49. performance of "Simple hierarchical select" by installing "JS". It routes
  50. all javascript callbacks needed by "Simple hierarchical select" through a
  51. custom handler to avoid loading of all Drupal functions and speed up
  52. loading.
  53. * Entity reference (https://www.drupal.org/project/entityreference)
  54. - "Simple hierarchical select" works out of the box with simple entity
  55. reference fields. In case you use Views as entity selection mode for your
  56. field there may be some problems, though.
  57. Your reference view needs at least one filter for the vocabulary. Otherwise
  58. "Simple hierarchical select" has no chance to retrieve the list of possible
  59. options to display.
  60. More complex reference views may cause "Simple hierarchical select" to fail,
  61. so its best to keep it as simple as possible.
  62. -- CONTACT --
  63. Current maintainers:
  64. * Stefan Borchert (stborchert) - http://drupal.org/user/36942
  65. This project has been sponsored by:
  66. * undpaul
  67. Drupal experts providing professional Drupal development services.
  68. Visit http://www.undpaul.de for more information.