You are here

README.txt in Simple hierarchical select 2.0.x

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

The "Simple hierarchical select" module displays selected taxonomy fields as
hierarchical selects on entity forms and as exposed filter in views.


-- REQUIREMENTS --

The module "Taxonomy" (Drupal core) needs to be enabled for SHS to work
properly.


-- INSTALLATION --

* Install as usual, see https://www.drupal.org/documentation/install/modules-themes/modules-8
  for further information.


-- CONFIGURATION --

* Create a new field ("Reference > Taxonomy term") and select
  "Simple hierarchical select" on the form display settings for the new field.

* Form display settings
  - "Allow creating new items" (disabled)
    Items may be created directly from within the widget (user needs to have
    permission to create items in the configured bundle).
  - "Allow creating new levels" (disabled)
    Users with permission to create items in the configured bundle will be
    able to create a new item as child of the currently selected item.
  - "Force selection of deepest level"
    Force users to select items from the deepest level.


-- INTERGRATION WITH OTHER MODULES --

 * Views (Drupal core)
   - You are able to use the Simple hierarchical select widget as an exposed
     filter in Views.
     Simply add a filter for your term reference field or a term reference
     filter ("Has taxonomy terms" or "Has taxonomy  terms (with depth)") in your
     view and select "Simple hierarchical select" as selection type.
 * Chosen
   To use the Chosen library (https://www.drupal.org/project/chosen) you need to
   enable "Simple hierarchical select: Chosen" (shs_chosen) and configure the
   form display of your field to use Chosen.


-- MISSING FEATURES --

* Form display settings:
  Some options are current disabled because the underlying features are not
  implemented yet. This will be done until version 8.x-1.0.


-- 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 entity forms and as exposed filter in views.
  4. -- REQUIREMENTS --
  5. The module "Taxonomy" (Drupal core) needs to be enabled for SHS to work
  6. properly.
  7. -- INSTALLATION --
  8. * Install as usual, see https://www.drupal.org/documentation/install/modules-themes/modules-8
  9. for further information.
  10. -- CONFIGURATION --
  11. * Create a new field ("Reference > Taxonomy term") and select
  12. "Simple hierarchical select" on the form display settings for the new field.
  13. * Form display settings
  14. - "Allow creating new items" (disabled)
  15. Items may be created directly from within the widget (user needs to have
  16. permission to create items in the configured bundle).
  17. - "Allow creating new levels" (disabled)
  18. Users with permission to create items in the configured bundle will be
  19. able to create a new item as child of the currently selected item.
  20. - "Force selection of deepest level"
  21. Force users to select items from the deepest level.
  22. -- INTERGRATION WITH OTHER MODULES --
  23. * Views (Drupal core)
  24. - You are able to use the Simple hierarchical select widget as an exposed
  25. filter in Views.
  26. Simply add a filter for your term reference field or a term reference
  27. filter ("Has taxonomy terms" or "Has taxonomy terms (with depth)") in your
  28. view and select "Simple hierarchical select" as selection type.
  29. * Chosen
  30. To use the Chosen library (https://www.drupal.org/project/chosen) you need to
  31. enable "Simple hierarchical select: Chosen" (shs_chosen) and configure the
  32. form display of your field to use Chosen.
  33. -- MISSING FEATURES --
  34. * Form display settings:
  35. Some options are current disabled because the underlying features are not
  36. implemented yet. This will be done until version 8.x-1.0.
  37. -- CONTACT --
  38. Current maintainers:
  39. * Stefan Borchert (stborchert) - http://drupal.org/user/36942
  40. This project has been sponsored by:
  41. * undpaul
  42. Drupal experts providing professional Drupal development services.
  43. Visit http://www.undpaul.de for more information.