You are here

Home » API reference » Taxonomy Tools 8

README.txt in Taxonomy Tools 8

Same filename in this branch
  1. 8 README.txt
  2. 8 taxonomy_publisher_filter/README.txt
Same filename and directory in other branches
  1. 7 taxonomy_publisher_filter/README.txt
This module allows you to limit the taxonomy terms listed in a term reference 
form element or in a views exposed filter.

Description

Based on a status field disabled terms will be removed from the options by a
 hook_field_widget_form_alter() implementation for term reference field widgets
and by a hook_form_FORM_ID_alter() for views exposed forms.
The module allows you to enable/disable this limitation with permissions
for each vocabulary.

Dependencies

It depends on the Taxonomy Publisher module 
(now part of the Taxonomy tools project), which
attaches a status field to the taxonomy terms of the vocabularies you select.

Versions v1.0

Version 1.0 supports select and checkbox widgets 
for term reference fields.

Versions v2.0

The current version supports select, checkbox/radio and autocomplete widgets 
for term reference fields.
Provide a better administration UI and cache functionality.

How to use

download the module and place it under 'sites/all/modules/contrib' folder
with Drush use: drush dl taxonomy_publisher_filter
enable the module from the modules page: 'admin/build/modules'
enable taxonomy publisher on the vocabularies you wish to limit
enable/disable the terms in the above vocabularies configure roles 
that show see the limited list only under admin/people/permission

Custom Form

_taxonomy_publisher_filter_custom_form($vid, $settings) function is helpful to 
filter your select or checkbox/radio field in custom forms.
The function will expect a vocabulary id by default 
and will return the filtered option list.

Documentation: http://drupal.org/node/1895610

File

taxonomy_publisher_filter/README.txt
View source 
  1. This module allows you to limit the taxonomy terms listed in a term reference 

  2. form element or in a views exposed filter.

  3. 

  4. Description

  5. 

  6. Based on a status field disabled terms will be removed from the options by a

  7.  hook_field_widget_form_alter() implementation for term reference field widgets

  8. and by a hook_form_FORM_ID_alter() for views exposed forms.

  9. The module allows you to enable/disable this limitation with permissions

  10. for each vocabulary.

  11. 

  12. Dependencies

  13. 

  14. It depends on the Taxonomy Publisher module 

  15. (now part of the Taxonomy tools project), which

  16. attaches a status field to the taxonomy terms of the vocabularies you select.

  17. 

  18. Versions v1.0

  19. 

  20. Version 1.0 supports select and checkbox widgets 

  21. for term reference fields.

  22. 

  23. Versions v2.0

  24. 

  25. The current version supports select, checkbox/radio and autocomplete widgets 

  26. for term reference fields.

  27. Provide a better administration UI and cache functionality.

  28. 

  29. How to use

  30. 

  31. download the module and place it under 'sites/all/modules/contrib' folder

  32. with Drush use: drush dl taxonomy_publisher_filter

  33. enable the module from the modules page: 'admin/build/modules'

  34. enable taxonomy publisher on the vocabularies you wish to limit

  35. enable/disable the terms in the above vocabularies configure roles 

  36. that show see the limited list only under admin/people/permission

  37. 

  38. Custom Form

  39. 

  40. _taxonomy_publisher_filter_custom_form($vid, $settings) function is helpful to 

  41. filter your select or checkbox/radio field in custom forms.

  42. The function will expect a vocabulary id by default 

  43. and will return the filtered option list.

  44. 

  45. Documentation: http://drupal.org/node/1895610