You are here

Home » API reference » Simple hierarchical select 8

README.txt in Simple hierarchical select 8

Same filename and directory in other branches
  1. 7 README.txt
  2. 2.0.x 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. 

  2. -- SUMMARY --

  3. 

  4. The "Simple hierarchical select" module displays selected taxonomy fields as

  5. hierarchical selects on entity forms and as exposed filter in views.

  6. 

  7. 

  8. -- REQUIREMENTS --

  9. 

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

  11. properly.

  12. 

  13. 

  14. -- INSTALLATION --

  15. 

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

  17.   for further information.

  18. 

  19. 

  20. -- CONFIGURATION --

  21. 

  22. * Create a new field ("Reference > Taxonomy term") and select

  23.   "Simple hierarchical select" on the form display settings for the new field.

  24. 

  25. * Form display settings

  26.   - "Allow creating new items" (disabled)

  27.     Items may be created directly from within the widget (user needs to have

  28.     permission to create items in the configured bundle).

  29.   - "Allow creating new levels" (disabled)

  30.     Users with permission to create items in the configured bundle will be

  31.     able to create a new item as child of the currently selected item.

  32.   - "Force selection of deepest level"

  33.     Force users to select items from the deepest level.

  34. 

  35. 

  36. -- INTERGRATION WITH OTHER MODULES --

  37. 

  38.  * Views (Drupal core)

  39.    - You are able to use the Simple hierarchical select widget as an exposed

  40.      filter in Views.

  41.      Simply add a filter for your term reference field or a term reference

  42.      filter ("Has taxonomy terms" or "Has taxonomy  terms (with depth)") in your

  43.      view and select "Simple hierarchical select" as selection type.

  44.  * Chosen

  45.    To use the Chosen library (https://www.drupal.org/project/chosen) you need to

  46.    enable "Simple hierarchical select: Chosen" (shs_chosen) and configure the

  47.    form display of your field to use Chosen.

  48. 

  49. 

  50. -- MISSING FEATURES --

  51. 

  52. * Form display settings:

  53.   Some options are current disabled because the underlying features are not

  54.   implemented yet. This will be done until version 8.x-1.0.

  55. 

  56. 

  57. -- CONTACT --

  58. 

  59. Current maintainers:

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

  61. 

  62. This project has been sponsored by:

  63. * undpaul

  64.   Drupal experts providing professional Drupal development services.

  65.   Visit http://www.undpaul.de for more information.