Skip to content

Commit c13701e

Browse files
committed
Added in inline error params and alphabetized in a few cases
1 parent 3565bdd commit c13701e

File tree

9 files changed

+196
-96
lines changed

9 files changed

+196
-96
lines changed

docs/add-ons/email.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,12 @@ The contact form is created similar to a standard web form, only you **do not**
6666

6767
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.
6868

69+
### `inline_errors=`
70+
71+
inline_errors="yes"
72+
73+
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.
74+
6975
### `name=`
7076

7177
name="myForm"
@@ -122,6 +128,12 @@ If used with the redirect="none" parameter, the link text can be specified by ad
122128

123129
If the `redirect` parameter was set to value of `return`, then the user will be redirected immediately after submission of the form.
124130

131+
### `return_error=`
132+
133+
return_error="template_group/error"
134+
135+
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.
136+
125137
### `preview=`
126138

127139
preview="about/contact-preview"

docs/comment/form.md

Lines changed: 35 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -56,28 +56,6 @@ TIP: **Tip:** Notice the variables in the "value" form fields? These allow us to
5656

5757
{{embed:_tips/form-attributes.md}}
5858

59-
#### `entry_id=`
60-
61-
entry_id="24"
62-
63-
You can hard code the comment form tag to display a comment form for a specific channel entry by its entry ID.
64-
65-
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.
66-
67-
#### `preview=`
68-
69-
preview="channel/preview"
70-
71-
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.
72-
73-
#### `url_title=`
74-
75-
url_title="my_wedding"
76-
77-
You can hard code the comment for tag to display a comment form for a specific channel entry by its URL title.
78-
79-
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.
80-
8159
#### `channel=`
8260

8361
channel="news"
@@ -88,6 +66,14 @@ If you link to your comment form page using the entry's URL Title, then you are
8866

8967
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.
9068

69+
#### `entry_id=`
70+
71+
entry_id="24"
72+
73+
You can hard code the comment form tag to display a comment form for a specific channel entry by its entry ID.
74+
75+
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.
76+
9177
#### `form_class=`
9278

9379
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
10086

10187
With this parameter, you can specify the css id you want the form to have. The default value is 'comment_form'
10288

89+
90+
#### `inline_errors=`
91+
92+
inline_errors="yes"
93+
94+
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.
95+
96+
#### `preview=`
97+
98+
preview="channel/preview"
99+
100+
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.
101+
103102
#### `return=`
104103

105104
return="template_group/template/url_title"
@@ -111,6 +110,20 @@ This parameter allows you to define where the user will be returned after submit
111110

112111
If this parameter is not defined, they will be returned to the form page.
113112

113+
#### `return_error=`
114+
115+
return_error="template_group/error"
116+
117+
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.
118+
119+
#### `url_title=`
120+
121+
url_title="my_wedding"
122+
123+
You can hard code the comment for tag to display a comment form for a specific channel entry by its URL title.
124+
125+
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.
126+
114127
### Conditionals
115128

116129
[TOC=4]

docs/member/edit-profile.md

Lines changed: 31 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -23,25 +23,38 @@ This template tag allows editing a member's profile using the form that is simil
2323

2424
{{embed:_tips/form-attributes.md}}
2525

26+
2627
### `datepicker=`
2728

28-
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.
29+
datepicker="no"
2930

30-
datepicker="yes"
31+
Adds the datepicker to your date fields. Defaults to "yes".
3132

32-
### `include_assets=`
33+
NOTE: **Note:** If you are manually constructing a date field, in order to apply the date picker you must include `rel="date-picker"`.
3334

34-
include_assets="yes"
35+
### `form_class=`
3536

36-
Adds the Javascript and CSS that is required by custom member fields to your form. By default, these are **not** included
37+
form_class="login"
3738

38-
### `datepicker=`
39+
This parameter allows you to specify the class attribute for the <form> tag.
3940

40-
datepicker="no"
41+
### `form_id=`
4142

42-
Adds the datepicker to your date fields. Defaults to "yes".
43+
form_id="login"
4344

44-
NOTE: **Note:** If you are manually constructing a date field, in order to apply the date picker you must include `rel="date-picker"`.
45+
This parameter allows you to specify the id attribute for the <form> tag.
46+
47+
### `form_name=`
48+
49+
form_name="login"
50+
51+
This parameter allows you to specify a name attribute for the <form> tag.
52+
53+
### `include_assets=`
54+
55+
include_assets="yes"
56+
57+
Adds the Javascript and CSS that is required by custom member fields to your form. By default, these are **not** included
4558

4659
### `include_css=`
4760

@@ -57,27 +70,23 @@ Includes jQuery automatically. Defaults to "yes".
5770

5871
NOTE: **Note:** If you are using your own copy of jQuery you will need to load it **before** the form.
5972

60-
### `return=`
61-
62-
return="member/registration/success"
63-
64-
### `form_class=`
73+
### `inline_errors=`
6574

66-
form_class="login"
75+
inline_errors="yes"
6776

68-
This parameter allows you to specify the class attribute for the <form> tag.
77+
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.
6978

70-
### `form_id=`
79+
### `return=`
7180

72-
form_id="login"
81+
return="member/registration/success"
82+
83+
### `return_error=`
7384

74-
This parameter allows you to specify the id attribute for the <form> tag.
85+
return_error="template_group/error"
7586

76-
### `form_name=`
87+
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.
7788

78-
form_name="login"
7989

80-
This parameter allows you to specify a name attribute for the <form> tag.
8190

8291
## Form Inputs
8392
NOTE: Be sure to include the required Javascript and CSS to use the native [Password Validation](member/password-validation.md).

docs/member/forgot-password.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,12 @@ Template to use for email which is sent to user.
3939

4040
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.
4141

42+
### `inline_errors=`
43+
44+
inline_errors="yes"
45+
46+
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.
47+
4248
### `password_reset_url=`
4349

4450
password_reset_url="member/reset-password"
@@ -57,6 +63,12 @@ This parameter allows you to define where the user will be returned after succes
5763
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"
5864
2. Use a full URL. For example: return="<https://example.com/member/forgot-password/sent.html>"
5965

66+
### `return_error=`
67+
68+
return_error="template_group/error"
69+
70+
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.
71+
6072

6173
## Form Inputs
6274
NOTE: Be sure to include the required Javascript and CSS to use the native [Password Validation](member/password-validation.md).

docs/member/forgot-username.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,12 @@ Template to use for email which is sent to user.
4343

4444
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.
4545

46+
### `inline_errors=`
47+
48+
inline_errors="yes"
49+
50+
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.
51+
4652
### `return=`
4753

4854
return="member/login/forgot-username"
@@ -52,6 +58,12 @@ This parameter allows you to define where the user will be returned after succes
5258
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"
5359
2. Use a full URL. For example: return="<https://example.com/member/login/forgot-username.html>"
5460

61+
### `return_error=`
62+
63+
return_error="template_group/error"
64+
65+
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.
66+
5567
## Form Inputs
5668

5769
### Email

docs/member/login.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,13 @@ This parameter allows you to specify the id attribute for the &lt;form&gt; tag.
5656

5757
This parameter allows you to specify a name attribute for the &lt;form&gt; tag.
5858

59+
### `inline_errors=`
60+
61+
inline_errors="yes"
62+
63+
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.
64+
65+
5966
### `return=`
6067

6168
return="site/index"
@@ -65,7 +72,11 @@ This parameter allows you to define where the user will be returned after succes
6572
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"
6673
2. Use a full URL. For example: return="<https://example.com/return.html>"
6774

75+
### `return_error=`
76+
77+
return_error="template_group/error"
6878

79+
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.
6980

7081
## Form Inputs
7182

docs/member/memberlist.md

Lines changed: 47 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,42 @@ Outputs a searchable list of members, including form filters to sort and limit t
2121

2222
{{embed:_tips/form-attributes.md}}
2323

24-
### `role_id=`
24+
### `backspace=`
2525

26-
role_id="5"
26+
backspace="3"
2727

28-
Restrict the output to members that belong to certain [role](control-panel/member-manager.md#member-roles).
28+
The `backspace=` parameter will remove the specified number of characters, including spaces and line breaks, from the last iteration of the tag pair.
29+
30+
### `error_handling="inline"`
31+
error_handling="inline"
32+
33+
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.
34+
35+
### `form_class=`
36+
37+
form_class="login"
38+
39+
This parameter allows you to specify the class attribute for the search &lt;form&gt; tag.
40+
41+
### `form_id=`
42+
43+
form_id="login"
44+
45+
This parameter allows you to specify the id attribute for the search &lt;form&gt; tag.
46+
47+
### `form_name=`
48+
49+
form_name="login"
50+
51+
This parameter allows you to specify a name attribute for the search &lt;form&gt; tag.
52+
53+
### `limit=`
54+
55+
limit="30"
56+
57+
Allows you to limit the number of members displayed.
58+
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)
2959

30-
NOTE: This parameter replaces `group_id` which is functionally identical and currently still supported.
3160

3261
### `orderby=`
3362

@@ -49,6 +78,15 @@ The "orderby" parameter sets the display order of members. The possible options
4978
When not set, defaults to [Member List - Order](control-panel/settings/members.md#order-by)
5079
setting or [`memberlist_order_by` configuration override](general/system-configuration-overrides.md#memberlist_order_by)
5180

81+
### `role_id=`
82+
83+
role_id="5"
84+
85+
Restrict the output to members that belong to certain [role](control-panel/member-manager.md#member-roles).
86+
87+
NOTE: This parameter replaces `group_id` which is functionally identical and currently still supported.
88+
89+
5290
### `sort=`
5391

5492
sort="asc"
@@ -57,41 +95,16 @@ setting or [`memberlist_order_by` configuration override](general/system-configu
5795
Set the order in which members are displayed.
5896
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)
5997

60-
### `limit=`
61-
62-
limit="30"
63-
64-
Allows you to limit the number of members displayed.
65-
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)
66-
6798
### `return=`
6899

69100
return="member/memberlist"
101+
102+
### `return_error=`
70103

71-
### `form_class=`
72-
73-
form_class="login"
74-
75-
This parameter allows you to specify the class attribute for the search &lt;form&gt; tag.
76-
77-
### `form_id=`
78-
79-
form_id="login"
80-
81-
This parameter allows you to specify the id attribute for the search &lt;form&gt; tag.
82-
83-
### `form_name=`
84-
85-
form_name="login"
86-
87-
This parameter allows you to specify a name attribute for the search &lt;form&gt; tag.
88-
89-
### `backspace=`
90-
91-
backspace="3"
92-
93-
The `backspace=` parameter will remove the specified number of characters, including spaces and line breaks, from the last iteration of the tag pair.
104+
return_error="template_group/error"
94105

106+
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.
107+
95108
## Form Variables
96109

97110
### `{form_declaration}`

0 commit comments

Comments
 (0)