You are here

Home » API reference » Hierarchical Select 5.2

README.txt in Hierarchical Select 5.2

Same filename and directory in other branches
  1. 5.3 README.txt
  2. 5 README.txt
  3. 6.3 README.txt
  4. 7.3 README.txt
Description
-----------
This module defines the "hierarchical_select" form element, which is a much
enhanced way for letting the user select an option in a hierarchy. Out of the
box, this module implements the hierarchical_select hooks for the taxonomy
(which automatically includes support for the forum module), content_taxonomy
and subscriptions_taxonomy modules. It also converts hierarchical vocabularies
that are used as exposed filters in any View to a hierarchical select.

Any module that uses a select form element, of which the options are ordered
hierarchically, can take advantage of this new form element. Especially when
there's a deep hierarchy, or when there are a lot of options in each sublevel,
this form element greatly simplifies the user's search for the right option.

Hierarchical Select has the ability to save the entire lineage of a selection
or only the "deepest" selection. You can configure it to force the user to
make a selection as deep as possible in the tree, or allow the user to select
an item anywhere in the tree. Levels can be labeled, you can configure limit
the number of items that can be selected, configure a title for the dropbox,
choose a site-wide animation delay, and so on.

The Taxonomy implementation of Hierarchical Select can be configured per
vocabulary: it can be turned on/off and you can take advantage of all features
mentioned above.


Dependencies
------------
* jQuery Interface (http://drupal.org/project/jquery_interface)
  * jQuery Update (http://drupal.org/project/jquery_update)


Integrates with
---------------
* Taxonomy (Drupal core)
* Content Taxonomy (http://drupal.org/project/content_taxonomy)
* Taxonomy Subscriptions (http://drupal.org/project/subscriptions)
* Views (http://drupal.org/project/views)


Installation
------------
1) Place this module directory in your modules folder (this will usually be
"sites/all/modules/").

2) Install the modules it depends on. Don't forget to copy the jquery.js file
included in the jQuery Update module to the "misc" directory!

3) Enable the module.

4) If you want to use it for one or more of your vocabularies, go to
admin/content/taxonomy and click the "edit" link for a vocabulary. Now scroll
down and you'll find a whole range of Hierarchical Select settings. All
settings are explained there as well.

NOTE: When using a content_taxonomy CCK field, you must configure it to use
      either "Save as tag" or "Both" as "Save options". If you don't, you'll
      get a bunch of PHP errors.
      See http://drupal.org/node/207252#comment-685906.
NOTE: When using a "multiple values" content_taxonomy CCK field, you must also
      set your vocabulary to be "multiple select"!
      See http://drupal.org/node/212398.

In case of problems, don't forget to try a hard refresh in your browser!


Sponsors
--------
* Initial development:
    Paul Ektov of http://autobin.ru.
* Abstraction, to let other modules than taxonomy hook in:
    Etienne Leers of http://creditcalc.biz.
* Support for saving the term lineage:
    Paul Ektov of http://autobin.ru.
* Multiple select support:
   Marmaladesoul, http://marmaladesoul.com.
* Taxonomy Subscriptions support:
   Mr Bidster Inc.


Author
------
Wim Leers

* mail: work@wimleers.com
* website: http://wimleers.com/work

The author can be contacted for paid customizations of this module as well as
Drupal consulting and development.

File

README.txt
View source 
  1. 

  2. Description

  3. -----------

  4. This module defines the "hierarchical_select" form element, which is a much

  5. enhanced way for letting the user select an option in a hierarchy. Out of the

  6. box, this module implements the hierarchical_select hooks for the taxonomy

  7. (which automatically includes support for the forum module), content_taxonomy

  8. and subscriptions_taxonomy modules. It also converts hierarchical vocabularies

  9. that are used as exposed filters in any View to a hierarchical select.

  10. 

  11. Any module that uses a select form element, of which the options are ordered

  12. hierarchically, can take advantage of this new form element. Especially when

  13. there's a deep hierarchy, or when there are a lot of options in each sublevel,

  14. this form element greatly simplifies the user's search for the right option.

  15. 

  16. Hierarchical Select has the ability to save the entire lineage of a selection

  17. or only the "deepest" selection. You can configure it to force the user to

  18. make a selection as deep as possible in the tree, or allow the user to select

  19. an item anywhere in the tree. Levels can be labeled, you can configure limit

  20. the number of items that can be selected, configure a title for the dropbox,

  21. choose a site-wide animation delay, and so on.

  22. 

  23. The Taxonomy implementation of Hierarchical Select can be configured per

  24. vocabulary: it can be turned on/off and you can take advantage of all features

  25. mentioned above.

  26. 

  27. 

  28. Dependencies

  29. ------------

  30. * jQuery Interface (http://drupal.org/project/jquery_interface)

  31.   * jQuery Update (http://drupal.org/project/jquery_update)

  32. 

  33. 

  34. Integrates with

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

  36. * Taxonomy (Drupal core)

  37. * Content Taxonomy (http://drupal.org/project/content_taxonomy)

  38. * Taxonomy Subscriptions (http://drupal.org/project/subscriptions)

  39. * Views (http://drupal.org/project/views)

  40. 

  41. 

  42. Installation

  43. ------------

  44. 1) Place this module directory in your modules folder (this will usually be

  45. "sites/all/modules/").

  46. 

  47. 2) Install the modules it depends on. Don't forget to copy the jquery.js file

  48. included in the jQuery Update module to the "misc" directory!

  49. 

  50. 3) Enable the module.

  51. 

  52. 4) If you want to use it for one or more of your vocabularies, go to

  53. admin/content/taxonomy and click the "edit" link for a vocabulary. Now scroll

  54. down and you'll find a whole range of Hierarchical Select settings. All

  55. settings are explained there as well.

  56. 

  57. NOTE: When using a content_taxonomy CCK field, you must configure it to use

  58.       either "Save as tag" or "Both" as "Save options". If you don't, you'll

  59.       get a bunch of PHP errors.

  60.       See http://drupal.org/node/207252#comment-685906.

  61. NOTE: When using a "multiple values" content_taxonomy CCK field, you must also

  62.       set your vocabulary to be "multiple select"!

  63.       See http://drupal.org/node/212398.

  64. 

  65. In case of problems, don't forget to try a hard refresh in your browser!

  66. 

  67. 

  68. Sponsors

  69. --------

  70. * Initial development:

  71.     Paul Ektov of http://autobin.ru.

  72. * Abstraction, to let other modules than taxonomy hook in:

  73.     Etienne Leers of http://creditcalc.biz.

  74. * Support for saving the term lineage:

  75.     Paul Ektov of http://autobin.ru.

  76. * Multiple select support:

  77.    Marmaladesoul, http://marmaladesoul.com.

  78. * Taxonomy Subscriptions support:

  79.    Mr Bidster Inc.

  80. 

  81. 

  82. Author

  83. ------

  84. Wim Leers

  85. 

  86. * mail: work@wimleers.com

  87. * website: http://wimleers.com/work

  88. 

  89. The author can be contacted for paid customizations of this module as well as

  90. Drupal consulting and development.