From c13701ee3aa8619ac06c8358d235f207b69646cc Mon Sep 17 00:00:00 2001 From: robinsowell Date: Wed, 9 Oct 2024 12:03:22 -0400 Subject: [PATCH] Added in inline error params and alphabetized in a few cases --- docs/add-ons/email.md | 12 +++++ docs/comment/form.md | 57 +++++++++++++++--------- docs/member/edit-profile.md | 53 +++++++++++++--------- docs/member/forgot-password.md | 12 +++++ docs/member/forgot-username.md | 12 +++++ docs/member/login.md | 11 +++++ docs/member/memberlist.md | 81 ++++++++++++++++++++-------------- docs/member/registration.md | 42 ++++++++++-------- docs/member/reset-password.md | 12 +++++ 9 files changed, 196 insertions(+), 96 deletions(-) diff --git a/docs/add-ons/email.md b/docs/add-ons/email.md index 63f28efe4..733afef84 100755 --- a/docs/add-ons/email.md +++ b/docs/add-ons/email.md @@ -66,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" @@ -122,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" diff --git a/docs/comment/form.md b/docs/comment/form.md index 5c4ea7098..73b8d11c8 100755 --- a/docs/comment/form.md +++ b/docs/comment/form.md @@ -56,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" @@ -88,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" @@ -100,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" @@ -111,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] diff --git a/docs/member/edit-profile.md b/docs/member/edit-profile.md index 11996ac8c..81689ee59 100644 --- a/docs/member/edit-profile.md +++ b/docs/member/edit-profile.md @@ -23,25 +23,38 @@ This template tag allows editing a member's profile using the form that is simil {{embed:_tips/form-attributes.md}} + ### `datepicker=` -Include the datepicker javascript. This should be set to ``yes`` if there is a date type member custom field in order to output the calendar. + datepicker="no" - datepicker="yes" +Adds the datepicker to your date fields. Defaults to "yes". -### `include_assets=` +NOTE: **Note:** If you are manually constructing a date field, in order to apply the date picker you must include `rel="date-picker"`. - include_assets="yes" +### `form_class=` -Adds the Javascript and CSS that is required by custom member fields to your form. By default, these are **not** included + form_class="login" -### `datepicker=` +This parameter allows you to specify the class attribute for the <form> tag. - datepicker="no" +### `form_id=` -Adds the datepicker to your date fields. Defaults to "yes". + form_id="login" -NOTE: **Note:** If you are manually constructing a date field, in order to apply the date picker you must include `rel="date-picker"`. +This parameter allows you to specify the id attribute for the <form> tag. + +### `form_name=` + + form_name="login" + +This parameter allows you to specify a name attribute for the <form> tag. + +### `include_assets=` + + include_assets="yes" + +Adds the Javascript and CSS that is required by custom member fields to your form. By default, these are **not** included ### `include_css=` @@ -57,27 +70,23 @@ Includes jQuery automatically. Defaults to "yes". NOTE: **Note:** If you are using your own copy of jQuery you will need to load it **before** the form. -### `return=` - - return="member/registration/success" - -### `form_class=` +### `inline_errors=` - form_class="login" + inline_errors="yes" -This parameter allows you to specify the class attribute for the <form> tag. +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. -### `form_id=` +### `return=` - form_id="login" + return="member/registration/success" + +### `return_error=` -This parameter allows you to specify the id attribute for the <form> tag. + return_error="template_group/error" -### `form_name=` +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. - form_name="login" -This parameter allows you to specify a name attribute for the <form> tag. ## Form Inputs NOTE: Be sure to include the required Javascript and CSS to use the native [Password Validation](member/password-validation.md). diff --git a/docs/member/forgot-password.md b/docs/member/forgot-password.md index 707162e26..c457c88f2 100644 --- a/docs/member/forgot-password.md +++ b/docs/member/forgot-password.md @@ -39,6 +39,12 @@ Template to use for email which is sent to user. NOTE: **Note:** If no template is defined, the default [Member Profile Template](control-panel/template-manager.md#member-profile-templates) for a forgotten password will be used. +### `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. + ### `password_reset_url=` password_reset_url="member/reset-password" @@ -57,6 +63,12 @@ This parameter allows you to define where the user will be returned after succes 1. Use the standard Template_Group/Template syntax to specify where to return the user. For instance, if you want the user to be returned to the "local" Template in the "news" Template Group, you would use: return="member/forgot-password/sent" 2. Use a full URL. For example: return="" +### `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. + ## Form Inputs NOTE: Be sure to include the required Javascript and CSS to use the native [Password Validation](member/password-validation.md). diff --git a/docs/member/forgot-username.md b/docs/member/forgot-username.md index 8cf71e447..16a695561 100644 --- a/docs/member/forgot-username.md +++ b/docs/member/forgot-username.md @@ -43,6 +43,12 @@ Template to use for email which is sent to user. If no template is defined or if the template defined does not exist, the default [Member Profile Template](control-panel/template-manager.md#member-profile-templates) for a forgotten username will be used. +### `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. + ### `return=` return="member/login/forgot-username" @@ -52,6 +58,12 @@ This parameter allows you to define where the user will be returned after succes 1. Use the standard Template_Group/Template syntax to specify where to return the user. For instance, if you want the user to be returned to the "local" Template in the "news" Template Group, you would use: return="member/login/forgot-username" 2. Use a full URL. For example: return="" +### `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. + ## Form Inputs ### Email diff --git a/docs/member/login.md b/docs/member/login.md index ca8a130da..b170ac170 100644 --- a/docs/member/login.md +++ b/docs/member/login.md @@ -56,6 +56,13 @@ This parameter allows you to specify the id attribute for the <form> tag. This parameter allows you to specify a name attribute for the <form> tag. +### `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. + + ### `return=` return="site/index" @@ -65,7 +72,11 @@ This parameter allows you to define where the user will be returned after succes 1. Use the standard Template_Group/Template syntax to specify where to return the user. For instance, if you want the user to be returned to the "local" Template in the "news" Template Group, you would use: return="news/local" 2. Use a full URL. For example: return="" +### `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. ## Form Inputs diff --git a/docs/member/memberlist.md b/docs/member/memberlist.md index f8606a0e6..5d73aa98a 100644 --- a/docs/member/memberlist.md +++ b/docs/member/memberlist.md @@ -21,13 +21,42 @@ Outputs a searchable list of members, including form filters to sort and limit t {{embed:_tips/form-attributes.md}} -### `role_id=` +### `backspace=` - role_id="5" + backspace="3" -Restrict the output to members that belong to certain [role](control-panel/member-manager.md#member-roles). +The `backspace=` parameter will remove the specified number of characters, including spaces and line breaks, from the last iteration of the tag pair. + +### `error_handling="inline"` + error_handling="inline" + +This parameter allows you to use inline errors in your registration form. The errors can be displayed using the `{error:field_name}` tag where `field_name` would need to be replaced with the name of the field that has an error, as used to compose the form. + +### `form_class=` + + form_class="login" + +This parameter allows you to specify the class attribute for the search <form> tag. + +### `form_id=` + + form_id="login" + +This parameter allows you to specify the id attribute for the search <form> tag. + +### `form_name=` + + form_name="login" + +This parameter allows you to specify a name attribute for the search <form> tag. + +### `limit=` + + limit="30" + +Allows you to limit the number of members displayed. +When not set, defaults to [Member List - Rows](control-panel/settings/members.md#total-results) setting or [`memberlist_row_limit` configuration override](general/system-configuration-overrides.md#memberlist_row_limit) -NOTE: This parameter replaces `group_id` which is functionally identical and currently still supported. ### `orderby=` @@ -49,6 +78,15 @@ The "orderby" parameter sets the display order of members. The possible options When not set, defaults to [Member List - Order](control-panel/settings/members.md#order-by) setting or [`memberlist_order_by` configuration override](general/system-configuration-overrides.md#memberlist_order_by) +### `role_id=` + + role_id="5" + +Restrict the output to members that belong to certain [role](control-panel/member-manager.md#member-roles). + +NOTE: This parameter replaces `group_id` which is functionally identical and currently still supported. + + ### `sort=` sort="asc" @@ -57,41 +95,16 @@ setting or [`memberlist_order_by` configuration override](general/system-configu Set the order in which members are displayed. When not set, defaults to [Member List - Sort By](control-panel/settings/members.md#sort-by) setting or [`memberlist_sort_order` configuration override](general/system-configuration-overrides.md#memberlist_sort_order) -### `limit=` - - limit="30" - -Allows you to limit the number of members displayed. -When not set, defaults to [Member List - Rows](control-panel/settings/members.md#total-results) setting or [`memberlist_row_limit` configuration override](general/system-configuration-overrides.md#memberlist_row_limit) - ### `return=` return="member/memberlist" + +### `return_error=` -### `form_class=` - - form_class="login" - -This parameter allows you to specify the class attribute for the search <form> tag. - -### `form_id=` - - form_id="login" - -This parameter allows you to specify the id attribute for the search <form> tag. - -### `form_name=` - - form_name="login" - -This parameter allows you to specify a name attribute for the search <form> tag. - -### `backspace=` - - backspace="3" - -The `backspace=` parameter will remove the specified number of characters, including spaces and line breaks, from the last iteration of the tag pair. + 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. + ## Form Variables ### `{form_declaration}` diff --git a/docs/member/registration.md b/docs/member/registration.md index 780667659..7a01d8f43 100644 --- a/docs/member/registration.md +++ b/docs/member/registration.md @@ -23,39 +23,29 @@ NOTE: **Important:** In order for site visitors to be allowed to register for ac {{embed:_tips/form-attributes.md}} -### `return=` - - return="member/registration/success" - -### `form_class=` - - form_class="register" +### `datepicker=` - ### `primary_role=` + datepicker="no" - primary_role="7" +Adds the datepicker to your date fields. Defaults to "yes". -This parameter allows you to specify the primary role to assign the new member, overriding the default member setting. +NOTE: **Note:** If you are manually constructing a date field, in order to apply the date picker you must include `rel="date-picker"`. ### `error_handling="inline"` error_handling="inline" This parameter allows you to use inline errors in your registration form. The errors can be displayed using the `{error:field_name}` tag where `field_name` would need to be replaced with the name of the field that has an error, as used to compose the form. +### `form_class=` + + form_class="register" + ### `include_assets=` include_assets="yes" Adds the Javascript and CSS that is required by custom member fields to your form. By default, these are **not** included -### `datepicker=` - - datepicker="no" - -Adds the datepicker to your date fields. Defaults to "yes". - -NOTE: **Note:** If you are manually constructing a date field, in order to apply the date picker you must include `rel="date-picker"`. - ### `include_css=` include_css="no" @@ -70,6 +60,22 @@ Includes jQuery automatically. Defaults to "yes". NOTE: **Note:** If you are using your own copy of jQuery you will need to load it **before** the form. +### `primary_role=` + + primary_role="7" + +This parameter allows you to specify the primary role to assign the new member, overriding the default member setting. + +### `return=` + + return="member/registration/success" + +### `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. + ## Form Inputs NOTE: Be sure to include the required JavaScript and CSS to use the native [Password Validation](member/password-validation.md). diff --git a/docs/member/reset-password.md b/docs/member/reset-password.md index 68d3d0028..6eb3c3745 100644 --- a/docs/member/reset-password.md +++ b/docs/member/reset-password.md @@ -32,6 +32,12 @@ Output a reset password form that allows members accessing it via a link from a ## Parameters +### `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. + ### `return=` return="member/login/success" @@ -41,6 +47,12 @@ This parameter allows you to define where the user will be returned after succes 1. Use the standard Template_Group/Template syntax to specify where to return the user. For instance, if you want the user to be returned to the "local" Template in the "news" Template Group, you would use: return="news/local" 2. Use a full URL. For example: return="" +### `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. + ## Form Inputs NOTE: Be sure to include the required Javascript and CSS to use the native [Password Validation](member/password-validation.md).