You are here

README.txt in Clientside Validation 6

Same filename and directory in other branches
  1. 7.2 README.txt
  2. 7 README.txt
DESCRIPTION
===========
  This module adds clientside validation for all forms and webforms using
  jquery.validate[1]. The included jquery.validate.js file is patched because we
  needed to be able to hide empty messages.

EXAMPLE
=======
  If you want to try out an example of Clientside Validation in combination with
  the form API, FAPI Validation (http://www.drupal.org/project/fapi_validation),
  and/or Vertical Tabs (D6: http://www.drupal.org/project/vertical_tabs, D7: in
  core) you can download and enable the example module from this sandbox project:
  http://drupal.org/sandbox/jelles/1193994
  or
  http://drupal.org/project/1193994/git-instructions (direct link to git
  instructions tab)

DEMO
====
  Demo's can be a little bit outdated
  Drupal 6:
    * Custom form: http://atix.be/cv6a
    * Webform: http://atix.be/cv6b
  Drupal 7:
    * Custom form: http://atix.be/cv7a
    * Webform: http://atix.be/cv7b

STATUS
======
  * Validation is added to all forms and webforms (only tested with version 3).
  * The error messages are displayed the same way as without this module, in a
    div above the form.
  * The error messages use the same css classes as drupal does out of the box,
    so you only have to theme it once.
  * Supports the following conditions: Fields that
      - are required
      - have a maximum length
      - must have one of specified extensions
      - must be one of the allowed values
      - can only contain max x elements (checkboxes, multiple selects)
      - must contain minimum x elements (checkboxes, multiple selects)
      - must be greater than a minimum value
      - must be smaller than a maximum value
      - must be a number
      - must be a decimal
      - must equal an other field
      - can not equal an other field
      - must equal a specific value
      - must be an ean number
      - must match a POSIX regex
      - must match a PCRE regex
      - must be a valid e-mail address
      - must be a valid url
      - must be alpha (FAPI validation)
      - must be alphanumeric (FAPI validation)
      - must be valid IPv4 (FAPI validation)
      - must be "alpha dash" (FAPI validation)
    Note: The FAPI validation rules come down to matching a PCRE regex
  * CCK: textfield, textarea, decimal, float, integer, file and image
  * Supports multiple forms on one page
  * Added support for Webform Validation
  * Added support for FAPI Validation
  * D7: Added support for Field Validation
  * Added support for Vertical Tabs (for D6: Vertical Tabs)
  * Supports most of CCK Date
  * Added an option to enclose the field name in quotes (defaults to nothing)
  * Added an option to validate all tabs or only the visible one (defaults to
    all tabs)
  * Added an option to specify on which forms to validate all fields (including
    those hidden) and on which forms only to validate the visible fields
    (defaults to only visible)
  * Added an option to specify on which forms to add Clientside Validation
    (defaults to all forms)
  * Added an option to specify whether or not to use the minified version of
    jquery.validate.js (defaults to not)
  * Checkboxes are working
  * Now using jquery.validate 1.8
  * Supports multi page webforms

TODO
====
  * Add settings to control position and behaviour of the error messages

USAGE
=====
  The only thing this module will do is translate validation rules defined in
  PHP to javascript counter parts, if you mark a field as required it will
  create a javascript rule that checks the field on submit. This means no real
  configuration is needed. You can however configure the prefix and suffix used
  for the field names in the error messages (e.g.: prefix:", suffix:" or
  prefix:<<, suffix:>>), whether or not to use the minified version of
  jquery.validate.js, whether or not to validate hidden fields on specific
  forms, whether or not to validate all vertical tabs or only the visible one
  and to add Clientside Validation to all forms or only to those specified.

AUTHOR
======
  The author can be contacted for paid customizations of this module as well as
  Drupal consulting and development.

File

README.txt
View source
  1. DESCRIPTION
  2. ===========
  3. This module adds clientside validation for all forms and webforms using
  4. jquery.validate[1]. The included jquery.validate.js file is patched because we
  5. needed to be able to hide empty messages.
  6. EXAMPLE
  7. =======
  8. If you want to try out an example of Clientside Validation in combination with
  9. the form API, FAPI Validation (http://www.drupal.org/project/fapi_validation),
  10. and/or Vertical Tabs (D6: http://www.drupal.org/project/vertical_tabs, D7: in
  11. core) you can download and enable the example module from this sandbox project:
  12. http://drupal.org/sandbox/jelles/1193994
  13. or
  14. http://drupal.org/project/1193994/git-instructions (direct link to git
  15. instructions tab)
  16. DEMO
  17. ====
  18. Demo's can be a little bit outdated
  19. Drupal 6:
  20. * Custom form: http://atix.be/cv6a
  21. * Webform: http://atix.be/cv6b
  22. Drupal 7:
  23. * Custom form: http://atix.be/cv7a
  24. * Webform: http://atix.be/cv7b
  25. STATUS
  26. ======
  27. * Validation is added to all forms and webforms (only tested with version 3).
  28. * The error messages are displayed the same way as without this module, in a
  29. div above the form.
  30. * The error messages use the same css classes as drupal does out of the box,
  31. so you only have to theme it once.
  32. * Supports the following conditions: Fields that
  33. - are required
  34. - have a maximum length
  35. - must have one of specified extensions
  36. - must be one of the allowed values
  37. - can only contain max x elements (checkboxes, multiple selects)
  38. - must contain minimum x elements (checkboxes, multiple selects)
  39. - must be greater than a minimum value
  40. - must be smaller than a maximum value
  41. - must be a number
  42. - must be a decimal
  43. - must equal an other field
  44. - can not equal an other field
  45. - must equal a specific value
  46. - must be an ean number
  47. - must match a POSIX regex
  48. - must match a PCRE regex
  49. - must be a valid e-mail address
  50. - must be a valid url
  51. - must be alpha (FAPI validation)
  52. - must be alphanumeric (FAPI validation)
  53. - must be valid IPv4 (FAPI validation)
  54. - must be "alpha dash" (FAPI validation)
  55. Note: The FAPI validation rules come down to matching a PCRE regex
  56. * CCK: textfield, textarea, decimal, float, integer, file and image
  57. * Supports multiple forms on one page
  58. * Added support for Webform Validation
  59. * Added support for FAPI Validation
  60. * D7: Added support for Field Validation
  61. * Added support for Vertical Tabs (for D6: Vertical Tabs)
  62. * Supports most of CCK Date
  63. * Added an option to enclose the field name in quotes (defaults to nothing)
  64. * Added an option to validate all tabs or only the visible one (defaults to
  65. all tabs)
  66. * Added an option to specify on which forms to validate all fields (including
  67. those hidden) and on which forms only to validate the visible fields
  68. (defaults to only visible)
  69. * Added an option to specify on which forms to add Clientside Validation
  70. (defaults to all forms)
  71. * Added an option to specify whether or not to use the minified version of
  72. jquery.validate.js (defaults to not)
  73. * Checkboxes are working
  74. * Now using jquery.validate 1.8
  75. * Supports multi page webforms
  76. TODO
  77. ====
  78. * Add settings to control position and behaviour of the error messages
  79. USAGE
  80. =====
  81. The only thing this module will do is translate validation rules defined in
  82. PHP to javascript counter parts, if you mark a field as required it will
  83. create a javascript rule that checks the field on submit. This means no real
  84. configuration is needed. You can however configure the prefix and suffix used
  85. for the field names in the error messages (e.g.: prefix:", suffix:" or
  86. prefix:<<, suffix:>>), whether or not to use the minified version of
  87. jquery.validate.js, whether or not to validate hidden fields on specific
  88. forms, whether or not to validate all vertical tabs or only the visible one
  89. and to add Clientside Validation to all forms or only to those specified.
  90. AUTHOR
  91. ======
  92. The author can be contacted for paid customizations of this module as well as
  93. Drupal consulting and development.