You are here

Home » API reference » Conditional Fields 5

README.txt in Conditional Fields 5

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


Author:
-------
Gregorio Magini (peterpoe) <gmagini@gmail.com>
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 'trigger' 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:
-------------
- CCK / content.module -> http://drupal.org/project/cck
- Fieldgroups / fieldgroups.module (included in CCK) -> Not required, but if enabled you can also set groups as controlled fields.


Installation:
-------------
- Copy the unpacked folder "conditional_fields" in drupal/sites/all
- Go to the modules administration page (admin/build/modules) and activate it (it"s in the CCK package)


Usage:
------
Once the module is activated, a new set of options will appear in the field editing form, from where you can select which of the allowed values available will make the field "controlled". If no value is selected, the field will be shown as usual.
There is a "Conditional fields" tab in the content type admin page with the following options:
- Use javascript: If checked, controlled fields will be dinamically toggled in the node editing form through javascript.
- Administrators see all fields: If checked, users with 'administer conditional fields' permission will see all controlled fields of a node, even if the weren't triggered.
- Orphaned controlled fields settings: These settings control the visibility (on node view) and editability (on node edit) of controlled fields when the controlling fields are not visible (e.g.: set to 'Hidden' in the fields display settings) or not editable (e.g.: by an acces control module).
- Reset: If checked, all conditional fields configurations for this content type will be reset (though the fields themselves will remain untouched).

Limitations:
------------
- Each field or group can be controlled from only one field (though a field can control any number of fields and groups). This is a bug, and will be corrected in later develpment.
- If the controlling field is in a group, it can only control fields form within the same group.
- Currently works only with checkbox, select, and radio controlling fields (though controlled field can be of any type).


To Do:
------
Bug: multiple controlling fields on the same field don"t work
Bug: when exporting/importing conditional fields, some trigger values are not saved
Bug: some required fields are not correctly handled (e.g.: fields in groups, date)
Feature: tune performance (using more static variables, adding cache)
Feature: views integration
Feature: port to drupal 6 (when cck is ported)
Feature: add confirmation step to the reset option in conditional field administration page
Test: test with pgsql
Test: test different types of cck field for compatibility

File

README.txt
View source 
  1. 

  2. Conditional Fields:

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

  4. A Drupal 5 module

  5. 

  6. 

  7. Author:

  8. -------

  9. Gregorio Magini (peterpoe) 

  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 'trigger' 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. - CCK / content.module -> http://drupal.org/project/cck

  28. - Fieldgroups / fieldgroups.module (included in CCK) -> Not required, but if enabled you can also set groups as controlled fields.

  29. 

  30. 

  31. Installation:

  32. -------------

  33. - Copy the unpacked folder "conditional_fields" in drupal/sites/all

  34. - Go to the modules administration page (admin/build/modules) and activate it (it"s in the CCK package)

  35. 

  36. 

  37. Usage:

  38. ------

  39. Once the module is activated, a new set of options will appear in the field editing form, from where you can select which of the allowed values available will make the field "controlled". If no value is selected, the field will be shown as usual.

  40. There is a "Conditional fields" tab in the content type admin page with the following options:

  41. - Use javascript: If checked, controlled fields will be dinamically toggled in the node editing form through javascript.

  42. - Administrators see all fields: If checked, users with 'administer conditional fields' permission will see all controlled fields of a node, even if the weren't triggered.

  43. - Orphaned controlled fields settings: These settings control the visibility (on node view) and editability (on node edit) of controlled fields when the controlling fields are not visible (e.g.: set to 'Hidden' in the fields display settings) or not editable (e.g.: by an acces control module).

  44. - Reset: If checked, all conditional fields configurations for this content type will be reset (though the fields themselves will remain untouched).

  45. 

  46. Limitations:

  47. ------------

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

  49. - If the controlling field is in a group, it can only control fields form within the same group.

  50. - Currently works only with checkbox, select, and radio controlling fields (though controlled field can be of any type).

  51. 

  52. 

  53. To Do:

  54. ------

  55. Bug: multiple controlling fields on the same field don"t work

  56. Bug: when exporting/importing conditional fields, some trigger values are not saved

  57. Bug: some required fields are not correctly handled (e.g.: fields in groups, date)

  58. Feature: tune performance (using more static variables, adding cache)

  59. Feature: views integration

  60. Feature: port to drupal 6 (when cck is ported)

  61. Feature: add confirmation step to the reset option in conditional field administration page

  62. Test: test with pgsql

  63. Test: test different types of cck field for compatibility