You are here

Home » API reference » Conditional Fields 6

README.txt in Conditional Fields 6

Same filename and directory in other branches
  1. 5 README.txt
  2. 6.2 README.txt
  3. 7.3 README.txt
Conditional Fields:
--------------------
A Drupal module


Author:
--------------------
Gregorio Magini (peterpoe) <gmagini@gmail.com> - http://www.wikirandom.org
Initially inspired by the Explainfield module -> http://drupal.org/project/explainfield


Short Description:
--------------------
Content fields and groups visibility based on the values of user defined "controlling" fields.


Description:
--------------------
Conditional Fields allows you to assign fields with allowed values as "controlling fields" for other fields and groups. When a field or group is "controlled", it will only be available for editing and displayed if the selected values of the controlling field match the "trigger values" assigned to it.
When editing a node, the controlled fields are dynamically shown and hidden with javascript.
You can, for example, make a custom "article teaser" field that is shown only if a "Has teaser" checkbox is checked.


Dependencies:
--------------------
- Drupal core: 6.x or 5.x (note that the 5.x branch of Conditional Fields is very outdated, while the 6.x branch is actively maintained).
- CCK / content.module > http://drupal.org/project/cck
- OPTIONAL: Fieldgroups (included in CCK) > If enabled you can also set groups as controlled fields


Installation:
--------------------
- Copy the unpacked folder "conditional_fields" in your modules folder (usually [base_path]/sites/all/module).
- Go to the modules administration page (admin/build/modules) and activate the module (you will find it in the "CCK" package)
- Assign the "Administer conditional fields" permission to the desired user roles.


Usage:
--------------------
Read the Conditional Fields handbook:
http://drupal.org/node/475488


Limitations:
--------------------
- Each field or group can be controlled from only one field (though a field can control any number of fields and groups). This will be corrected in later development.
- If the controlling field is in a group, it can only control or be controlled only by fields that are in the same group.
- Conditional Fields, for now, supports only core CCK fields and widgets (checkbox, select, and radio) as controlling fields. Fields from other modules might work, but probably won't. There are confirmed incompatibilities with many non-core CCK modules (Date, Multigroup, Content Taxonomy, etc). 


To Do:
--------------------
Any help is welcome!
--------------------
Check the issue queue of this module for more information:
http://drupal.org/project/issues/conditional_fields

These are the top priority future features:
- Extend compatibility with non-core CCK modules
- Negate conditions (so that a field can be triggered when some allowed values are *not* selected)
- Allow multiple controlling fields on the same field
- Views integration
- Allow nested conditional fields

File

README.txt
View source 
  1. 

  2. Conditional Fields:

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

  4. A Drupal module

  5. 

  6. 

  7. Author:

  8. --------------------

  9. Gregorio Magini (peterpoe)  - http://www.wikirandom.org

  10. Initially inspired by the Explainfield module -> http://drupal.org/project/explainfield

  11. 

  12. 

  13. Short Description:

  14. --------------------

  15. Content fields and groups visibility based on the values of user defined "controlling" fields.

  16. 

  17. 

  18. Description:

  19. --------------------

  20. Conditional Fields allows you to assign fields with allowed values as "controlling fields" for other fields and groups. When a field or group is "controlled", it will only be available for editing and displayed if the selected values of the controlling field match the "trigger values" assigned to it.

  21. When editing a node, the controlled fields are dynamically shown and hidden with javascript.

  22. You can, for example, make a custom "article teaser" field that is shown only if a "Has teaser" checkbox is checked.

  23. 

  24. 

  25. Dependencies:

  26. --------------------

  27. - Drupal core: 6.x or 5.x (note that the 5.x branch of Conditional Fields is very outdated, while the 6.x branch is actively maintained).

  28. - CCK / content.module > http://drupal.org/project/cck

  29. - OPTIONAL: Fieldgroups (included in CCK) > If enabled you can also set groups as controlled fields

  30. 

  31. 

  32. Installation:

  33. --------------------

  34. - Copy the unpacked folder "conditional_fields" in your modules folder (usually [base_path]/sites/all/module).

  35. - Go to the modules administration page (admin/build/modules) and activate the module (you will find it in the "CCK" package)

  36. - Assign the "Administer conditional fields" permission to the desired user roles.

  37. 

  38. 

  39. Usage:

  40. --------------------

  41. Read the Conditional Fields handbook:

  42. http://drupal.org/node/475488

  43. 

  44. 

  45. Limitations:

  46. --------------------

  47. - Each field or group can be controlled from only one field (though a field can control any number of fields and groups). This will be corrected in later development.

  48. - If the controlling field is in a group, it can only control or be controlled only by fields that are in the same group.

  49. - Conditional Fields, for now, supports only core CCK fields and widgets (checkbox, select, and radio) as controlling fields. Fields from other modules might work, but probably won't. There are confirmed incompatibilities with many non-core CCK modules (Date, Multigroup, Content Taxonomy, etc). 

  50. 

  51. 

  52. To Do:

  53. --------------------

  54. Any help is welcome!

  55. --------------------

  56. Check the issue queue of this module for more information:

  57. http://drupal.org/project/issues/conditional_fields

  58. 

  59. These are the top priority future features:

  60. - Extend compatibility with non-core CCK modules

  61. - Negate conditions (so that a field can be triggered when some allowed values are *not* selected)

  62. - Allow multiple controlling fields on the same field

  63. - Views integration

  64. - Allow nested conditional fields