From 15d3d8c1d4741369b0ee1761082d0ed1670ad571 Mon Sep 17 00:00:00 2001 From: sparky672 Date: Tue, 12 Jul 2016 13:48:15 -0500 Subject: [PATCH 1/2] Update reference.md Clarified this section to reflect many questions on StackOverflow. It's a common mistake to leave out or duplicate the `name` attribute. It's also a common misconception that an `id` is needed at all for this plugin to work. Nowhere in the documentation is it explicitly stated that `name` attribute must be unique... only implied. My proposed changes spells these items out more clearly. The most important markup requirements are moved to the very top of this section in a paragraph preceded by the word "Mandated". Removed the triple single quotes from the word "required" as this just seems like we're talking about the `required` rule. And to eliminate any confusion, anything that has no effect on the operation of the plugin is confined to a paragraph preceded by the word "Optionally". --- pages/reference.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/pages/reference.md b/pages/reference.md index 052c448..485d14e 100644 --- a/pages/reference.md +++ b/pages/reference.md @@ -10,14 +10,15 @@ To achieve this, it is important that the plugin is actually deployed on website The plugin can never replace serverside validation and doesn't intend to do so. Having both in place gives you the necessary security for your application, as well as improved usability. # Markup recommendations -Each input has a label associated with it: The for-attribute of the label refers to the id-attribute of the input. +Mandated: A 'name' attribute is required for all input elements needing validation, and the plugin will not work without this. A 'name' attribute must also be unique to the form, as this is how the plugin keeps track of all input elements. + +Optionally: Each input can have a label associated with it, where the 'for' attribute of the label refers to the 'id' attribute of the input. It's also a common practice to have 'id' and 'name' attributes with the same value, although keep in mind that since this plugin does not use the 'id' attribute, this is not mandatory. + ```html Firstname ``` -The name attribute is '''required''' for input elements, the validation plugin doesn't work without it. Usually name and id attributes should have the same value. - # Methods A validation method implements the logic to validate any element. Provided are a set of default validation methods, such as required. Apart from required itself and equalTo, all validation methods declare an element valid when it has no value at all. That way an email field is optional unless required is specified. You can specify an element input to contain a valid email address, or nothing at all. Use jQuery.validator.addMethod to implement custom methods. From 9dbfacf34bd7daf0bb2c1bbbc364049c372ab38b Mon Sep 17 00:00:00 2001 From: sparky672 Date: Tue, 12 Jul 2016 14:42:43 -0500 Subject: [PATCH 2/2] Update reference.md --- pages/reference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/reference.md b/pages/reference.md index 485d14e..57a5e42 100644 --- a/pages/reference.md +++ b/pages/reference.md @@ -10,7 +10,7 @@ To achieve this, it is important that the plugin is actually deployed on website The plugin can never replace serverside validation and doesn't intend to do so. Having both in place gives you the necessary security for your application, as well as improved usability. # Markup recommendations -Mandated: A 'name' attribute is required for all input elements needing validation, and the plugin will not work without this. A 'name' attribute must also be unique to the form, as this is how the plugin keeps track of all input elements. +Mandated: A 'name' attribute is required for all input elements needing validation, and the plugin will not work without this. A 'name' attribute must also be unique to the form, as this is how the plugin keeps track of all input elements. However, each group of radio or checkbox elements will share the same 'name' since the value of this grouping represents a single piece of the form data. Optionally: Each input can have a label associated with it, where the 'for' attribute of the label refers to the 'id' attribute of the input. It's also a common practice to have 'id' and 'name' attributes with the same value, although keep in mind that since this plugin does not use the 'id' attribute, this is not mandatory.