Merge pull request #883 from ExpressionEngine/feature/7.5/inline-form-errors

Inline Form Errors

Author: bryannielsen

docs/_tips/form-validation.md

@@ -0,0 +1 @@
+TIP: **Tip:** This form utilizes template [form validation and error handling](/templates/form-validation.md).  Refer to the documentation for additional parameters and variables that are available to this tag.

docs/add-ons/email.md

@@ -52,6 +52,8 @@ The contact form is created similar to a standard web form, only you **do not**
         </p>
     {/exp:email:contact_form}
 
+{{embed:_tips/form-validation.md}}
+
 ## Parameters
 
 [TOC=3]
@@ -64,6 +66,12 @@ The contact form is created similar to a standard web form, only you **do not**
 
 This allows you to set the character set of the email being sent. Use this if your form's template is using a character set other than iso-8859-1.
 
+### `inline_errors=`
+
+    inline_errors="yes"
+
+This parameter is for use with [form validation and error handling](/templates/form-validation.md) and determines the type of error reporting: inline or error template.
+
 ### `name=`
 
     name="myForm"
@@ -120,6 +128,12 @@ If used with the redirect="none" parameter, the link text can be specified by ad
 
 If the `redirect` parameter was set to value of `return`, then the user will be redirected immediately after submission of the form.
 
+### `return_error=`
+
+    return_error="template_group/error"
+
+This parameter is for use with [form validation and error handling](/templates/form-validation.md) and determines the template to return to if validation errors are detected.
+
 ### `preview=`
 
     preview="about/contact-preview"
@@ -330,7 +344,7 @@ In the above example, the Template "friend" contains the Tell-a-Friend form.
 [TOC=3]
 
 ### `allow_attachments=`
-     
+
      allow_attachments="yes"
 
 This allows you to add a file input field to your form, make sure to give your file input field the name of `attachment`. Adding this parameter automatically gives the form the `enctype='multipart/form-data'` attribute.

docs/add-ons/pro-search/examples.md

@@ -280,7 +280,7 @@ Below is a list of radio buttons, one for each letter of the alphabet. Selecting
 
 Below is a list of checkboxes based on a custom channel field of the Checkboxes type. You can select multiple options from this list. Entries will be shown that have any of the selected options checked. Uses [Low Options](https://github.com/EEHarbor/low_options) to generate field options.
 
-Adding `contains_words="parameter_name"` to the Results tag will ensure that the selected items are not contained within other words, like appending `\W` to the values. 
+Adding `contains_words="parameter_name"` to the Results tag will ensure that the selected items are not contained within other words, like appending `\W` to the values.
 
     {exp:pro_search:form query="{segment_3}"}
       {exp:low_options:service_options}
@@ -503,7 +503,7 @@ Below are two lists of tags. You can select multiple tags per list. Entries that
 
 ## Other & Native
 
-In addition to what all the [filters](/add-ons/pro-search/filters.md) bring to the party, you can also filter by native ExpressionEngine parameters, as well as some [little extras](/add-ons/pro-search/tags.md#results-tag).
+In addition to what all the [filters](/add-ons/pro-search/filters.md) bring to the party, you can also filter by native ExpressionEngine parameters, as well as some [little extras](/add-ons/pro-search/tags.md#exppro_searchresults).
 
 ### Orderby and sort in one go
 

docs/add-ons/pro-search/filters.md

@@ -95,7 +95,7 @@ The automatic `keywords:mode` uses operators in keywords for any/all/exact match
 
 ### Singulars & Plurals
 
-Pro Search supports singular and plural matching of keywords [inflections](http://en.wikipedia.org/wiki/Inflection). To enable this, both the `keywords:inflect` and the `keywords:lang` parameters must be set. Pro Search supports English inflections natively and you can add support for other languages by adding inflection rules to your [Config file](/general/system_configuration_overrides.md):
+Pro Search supports singular and plural matching of keywords [inflections](http://en.wikipedia.org/wiki/Inflection). To enable this, both the `keywords:inflect` and the `keywords:lang` parameters must be set. Pro Search supports English inflections natively and you can add support for other languages by adding inflection rules to your [Config file](/general/system-configuration-overrides.md):
 
 ```
 $config['pro_search_inflection_rules'][lang] = array(
@@ -110,7 +110,7 @@ $config['pro_search_inflection_rules'][lang] = array(
 
 ### Stems
 
-Pro Search supports matching of keywords by their stem [stemming](http://en.wikipedia.org/wiki/Stemming). To enable this, both the `keywords:stem` and the `keywords:lang` parameters must be set. English stemming is supported natively, using a [Porter stemmer](http://tartarus.org/martin/PorterStemmer/) class, and you can add support for other languages by adding this to your [Config file](/general/system_configuration_overrides.md):
+Pro Search supports matching of keywords by their stem [stemming](http://en.wikipedia.org/wiki/Stemming). To enable this, both the `keywords:stem` and the `keywords:lang` parameters must be set. English stemming is supported natively, using a [Porter stemmer](http://tartarus.org/martin/PorterStemmer/) class, and you can add support for other languages by adding this to your [Config file](/general/system-configuration-overrides.md):
 
 ```
 $config['pro_search_stemmers'][lang] = array(
@@ -154,7 +154,7 @@ You can use the Distance filter to limit results by a given maximum distance. Th
 NOTE: **Note:** Use two separate fields instead of a single one for better performance.
 
 ### Variables
-The Distance filter also makes this variable available in the [Results tag](/add-ons/pro-search/tags#results-tag):
+The Distance filter also makes this variable available in the [Results tag](/add-ons/pro-search/tags.md#exppro_searchresults):
 
 #### `{pro_search_distance}`
     The calculated distance in the given unit for this entry.
@@ -163,7 +163,7 @@ NOTE: **Note:** Using the Distance filter will return the search results ordered
 
 ## Field Search
 
-You can use the native `search:field_name` parameter to target specific fields. Additionally, Pro Search can target the entry’s ***title***, ***url_title***, ***status***, target [Grid](/fieldtypes/grid.md) columns, use multiple values for [numeric matching](/channel/channel_entries.md#numeric-matching) (in combination with the `gt`, `gte`, `lt` and `lte` params), and use ***starts / ends with*** matching.
+You can use the native `search:field_name` parameter to target specific fields. Additionally, Pro Search can target the entry’s ***title***, ***url_title***, ***status***, target [Grid](/fieldtypes/grid.md) columns, use multiple values for [numeric matching](/channels/entries.md#numeric-matching) (in combination with the `gt`, `gte`, `lt` and `lte` params), and use ***starts / ends with*** matching.
 
 ### Parameters
 

docs/channels/entries.md

@@ -893,7 +893,7 @@ The "count" out of the current entries being displayed. If five entries are bein
       <a href="{cp_edit_entry_url}">Edit Entry</a>
     {/if}
 
-The URL of the entry form in the control panel where this entry can be edited. It is recommended you wrap this variable in an `{if logged_in}` conditional to hide your control panel's URL from regular site visitors. If you are running a membership-based site, hide it behind an appropriate `logged_in_primary_role_id` conditional or use [exp:member:has_role](/member/member-roles-tags.html#expmemberhas_role). For example, to hide this link from everyone but Super Admins:
+The URL of the entry form in the control panel where this entry can be edited. It is recommended you wrap this variable in an `{if logged_in}` conditional to hide your control panel's URL from regular site visitors. If you are running a membership-based site, hide it behind an appropriate `logged_in_primary_role_id` conditional or use [exp:member:has_role](/member/member-roles-tags.md#expmemberhas_role). For example, to hide this link from everyone but Super Admins:
 
     {if logged_in_primary_role_id == 1}
       <a href="{cp_edit_entry_url}">Edit Entry</a>

docs/comment/form.md

@@ -35,7 +35,7 @@ The comment submission form is created very similar to a standard web form, only
 
       <input type="submit" name="submit" value="Submit" />
       <input type="submit" name="preview" value="Preview" />
-      
+
       {!-- required to prevent EE from outputting form if commenting is disabled or expired --}
 	  {if comments_disabled}Comments on this entry are currently disabled.{/if}
       {if comments_expired}Commenting on this entry has expired.{/if}
@@ -46,6 +46,8 @@ This form should be placed on a "single-entry" type page such as a comments page
 
 TIP: **Tip:** Notice the variables in the "value" form fields? These allow us to show the user's information in the form automatically if they click the "remember personal info" option.
 
+{{embed:_tips/form-validation.md}}
+
 ## Comment Form Tag
 
 ### Parameters
@@ -54,28 +56,6 @@ TIP: **Tip:** Notice the variables in the "value" form fields? These allow us to
 
 {{embed:_tips/form-attributes.md}}
 
-#### `entry_id=`
-
-    entry_id="24"
-
-You can hard code the comment form tag to display a comment form for a specific channel entry by its entry ID.
-
-NOTE: **Note:** This parameter takes precedence over any entry specified dynamically in the URL, so when using this parameter you will want to make sure it is clear to the user which entry the displayed comment form belongs to.
-
-#### `preview=`
-
-    preview="channel/preview"
-
-This is a **required** parameter if you are using comment previews indicating which template should be used for comment previews. Like other "path" variables in ExpressionEngine you will use the Template Group/Template name. More on previewing can be found in the [Comment Previewing](#comment-previewing) section.
-
-#### `url_title=`
-
-    url_title="my_wedding"
-
-You can hard code the comment for tag to display a comment form for a specific channel entry by its URL title.
-
-NOTE: **Note:** This parameter takes precedence over any entry specified dynamically in the URL, so when using this parameter you will want to make sure it is clear to the user which entry the displayed comment form belongs to.
-
 #### `channel=`
 
     channel="news"
@@ -86,6 +66,14 @@ If you link to your comment form page using the entry's URL Title, then you are
 
 Because you can have the same URL Title in different channels, using this parameter will ensure that the comment submitted will be associated with the correct entry. Without this parameter, it is possible that the comment could be associated with an entry in a different channel that happens to have the same URL Title.
 
+#### `entry_id=`
+
+    entry_id="24"
+
+You can hard code the comment form tag to display a comment form for a specific channel entry by its entry ID.
+
+NOTE: **Note:** This parameter takes precedence over any entry specified dynamically in the URL, so when using this parameter you will want to make sure it is clear to the user which entry the displayed comment form belongs to.
+
 #### `form_class=`
 
     form_class="news_comment_form"
@@ -98,6 +86,19 @@ With this parameter, you can specify the css class you want the form to have, en
 
 With this parameter, you can specify the css id you want the form to have. The default value is 'comment_form'
 
+
+#### `inline_errors=`
+
+    inline_errors="yes"
+
+This parameter is for use with [form validation and error handling](/templates/form-validation.md) and determines the type of error reporting: inline or error template.
+
+#### `preview=`
+
+    preview="channel/preview"
+
+This is a **required** parameter if you are using comment previews indicating which template should be used for comment previews. Like other "path" variables in ExpressionEngine you will use the Template Group/Template name. More on previewing can be found in the [Comment Previewing](#comment-previewing) section.
+
 #### `return=`
 
     return="template_group/template/url_title"
@@ -109,6 +110,20 @@ This parameter allows you to define where the user will be returned after submit
 
 If this parameter is not defined, they will be returned to the form page.
 
+#### `return_error=`
+
+    return_error="template_group/error"
+
+This parameter is for use with [form validation and error handling](/templates/form-validation.md) and determines the template to return to if validation errors are detected.
+
+#### `url_title=`
+
+    url_title="my_wedding"
+
+You can hard code the comment for tag to display a comment form for a specific channel entry by its URL title.
+
+NOTE: **Note:** This parameter takes precedence over any entry specified dynamically in the URL, so when using this parameter you will want to make sure it is clear to the user which entry the displayed comment form belongs to.
+
 ### Conditionals
 
 [TOC=4]
@@ -227,11 +242,11 @@ A request for an edit will return a response array. In the case of an error, an
 
 ### Editing Permissions
 
-By using the [{if editable}](/comment/entries.html#if-editable) conditional in the Comment Entries tag, you can output a link, instructions or a form if the viewing member has permission to edit the comment, and by using the {if can_moderate_comment} you can display whatever is appropriate if the viewing member has permission to moderate (close) the comment.
+By using the [{if editable}](/comment/entries.md#if-editable) conditional in the Comment Entries tag, you can output a link, instructions or a form if the viewing member has permission to edit the comment, and by using the {if can_moderate_comment} you can display whatever is appropriate if the viewing member has permission to moderate (close) the comment.
 
 For members without administrative access, in order to edit a comment they must be logged in, the author of the comment, and the editing time limit must not have expired. If a member has a role with permission to edit the comments of any entry, that member will have edit permissions regardless of the editing time limit.
 
-Comment moderators may close the comment. The edit time limit does not apply to moderators. 
+Comment moderators may close the comment. The edit time limit does not apply to moderators.
 
 Superadmins will always have {editable} and {can_moderate_comment} permissions on any comment.
 

docs/control-panel/utilities/data-operations.md

@@ -59,7 +59,7 @@ Run this utility to convert all files stored in the database from sites previous
 
 It is recommended that you make sure all installed add-ons are compatible with ExpressionEngine 7 and newer, and that you have made a backup of your database before running the utility.
 
-After the update operation is completed, visit `Content & Design Settings` to disable [Compatibility Mode](control-panel/file-manager/file-manager.html#compatibility-mode) for File Manager.
+After the update operation is completed, visit `Content & Design Settings` to disable [Compatibility Mode](control-panel/file-manager/file-manager.md#compatibility-mode) for File Manager.
 
 ## Manage Statistics
 

docs/development/addon-development-overview.md

@@ -11,7 +11,7 @@
 
 With custom add-ons you can add new fieldtypes, features, template tags, and much more to ExpressionEngine. Here we are going to look at different parts of an add-on, and how to define just what our add-on is going to do.
 
-TIP: In this section, we're explaining the parts of an add-on. No need to memorize everything though, the [CLI](cli/intro.html) will generate all the pieces we need based on what functions we want our add-on to have.
+TIP: In this section, we're explaining the parts of an add-on. No need to memorize everything though, the [CLI](cli/intro.md) will generate all the pieces we need based on what functions we want our add-on to have.
 
 [TOC]
 
@@ -32,7 +32,7 @@ Here are some ideas of what you can accomplish with a custom add-on:
 These are just a few ideas of what you can do with custom add-ons. The possibilities are almost endless.
 
 ## Getting Started
-Getting started making an add-on is incredibly easy with the CLI. To begin making an add-on, simply use the [`make:addon` command](/cli/built-in-commands/make-addon.md) from the [CLI](/cli/intro.html).
+Getting started making an add-on is incredibly easy with the CLI. To begin making an add-on, simply use the [`make:addon` command](/cli/built-in-commands/make-addon.md) from the [CLI](/cli/intro.md).
 
 TIP: If you are working with an existing add-on, we recommend you start with [Modernizing add-ons](development/modernizing-existing-add-ons.md)