Skip to content

Update Documentation for Attribute Pass-Through forms #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: stability-old
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/add-ons/consent.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ Consent Forms allow the visitor to grant or withdraw consent to one or more Cons

## Parameters

The Consent Form Tag will create an HTML form and include within its opening tag the minimum attributes necessary for it to work. If you need additional attributes to be specified, The Simple Search Form Tag allows you to specify these attributes as additional parameters within the tag itself. See the entry for [pass_through_attributes](#pass_through_attributes) in the parameter listing for more information.

[TOC=3]

### `consent=`
Expand All @@ -64,6 +66,16 @@ Specify the HTML `class=` attribute.

Specify the HTML `id=` attribute.

### `pass through attributes`

data-automobile_type="buick" role="search" name="some name"

You can include in your tag a parameter with a name identical to any valid [HTML Form}(https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form) attribute, any [HTML Global Attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes), or the [ARIA Search role attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/Search_role).

If you assign a value to your parameter the value will be assigned to the attribute in the completed Form tag. To include an attribute which does not take a value (e.g. `novalidate`) you need to define a null value for the parameter (i.e. `novalidate=""`).

If you specify a parameter with a name that is the same as an attribute already being set by Consent Form, the parameter value you enter will be ignored.

### `return=`

return='site/consent'
Expand Down
13 changes: 13 additions & 0 deletions docs/add-ons/email.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,9 @@ The contact form is created similar to a standard web form, only you **do not**

## Parameters

The Email Contact Form Tag will create an HTML form and include within its opening tag the minimum attributes necessary for it to work. If you need additional attributes to be specified, The Simple Search Form Tag allows you to specify these attributes as additional parameters within the tag itself. See the entry for [pass_through_attributes](#pass_through_attributes) in the parameter listing for more information.


[TOC=3]

### `charset=`
Expand All @@ -68,6 +71,16 @@ This allows you to set the character set of the email being sent. Use this if yo

This allows you to set a name= attribute for the form. Keep in mind that name= is deprecated in XHTML.

### `pass through attributes`

data-automobile_type="buick" role="search" name="some name"

You can include in your tag a parameter with a name identical to any valid [HTML Form}(https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form) attribute, any [HTML Global Attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes), or the [ARIA Search role attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/Search_role).

If you assign a value to your parameter the value will be assigned to the attribute in the completed Form tag. To include an attribute which does not take a value (e.g. `novalidate`) you need to define a null value for the parameter (i.e. `novalidate=""`).

If you specify a parameter with a name that is the same as an attribute already being set by the Email Contact Form tag, the parameter value you enter will be ignored.

### `recipients=`

This optional parameter allows you to specify an email address to receive the email:
Expand Down
12 changes: 12 additions & 0 deletions docs/add-ons/search/advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,8 @@ The search results are displayed on the page you specify as the [result_page=](#

## Parameters

The Advanced Search Form Tag will create an HTML form and include within its opening tag the minimum attributes necessary for it to work. If you need additional attributes to be specified, The Advanced Search Form Tag allows you to specify these attributes as additional parameters within the tag itself. See the entry for [pass_through_attributes](#pass_throug_attributes) in the parameter listing for more information.

[TOC=3]

### `category=`
Expand Down Expand Up @@ -177,6 +179,16 @@ Specify the name attribute for the <form> tag, which will allow you to spe

You may specify a particular Template to display in the case when there are no results. This takes a standard "Template_Group/Template" as input.

### `pass through attributes`

data-automobile_type="buick" role="search" name="some name"

You can include in your tag a parameter with a name identical to any valid [HTML Form}(https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form) attribute, any [HTML Global Attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes), or the [ARIA Search role attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/Search_role).

If you assign a value to your parameter the value will be assigned to the attribute in the completed Form tag. To include an attribute which does not take a value (e.g. `novalidate`) you need to define a null value for the parameter (i.e. `novalidate=""`).

If you specify a parameter with a name that is the same as an attribute already being set by the Advanced Search Form tag, the parameter value you enter will be ignored.

### `result_page=`

result_page="news/searches"
Expand Down
13 changes: 13 additions & 0 deletions docs/add-ons/search/simple.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,9 @@ Besides specifying whether future entries are included in the search using the [

## Parameters

The Simple Search Form Tag will create an HTML form and include within its opening tag the minimum attributes necessary for it to work. If you need additional attributes to be specified, The Simple Search Form Tag allows you to specify these attributes as additional parameters within the tag itself. See the entry for [pass_through_attributes](#pass_through_attributes) in the parameter listing for more information.


### `name=`

name="search_form"
Expand All @@ -85,6 +88,16 @@ Specify the name attribute for the <form> tag, which will allow you to spe

You may specify a particular Template to display in the case when there are no results. This takes a standard "Template_Group/Template" as input.

### `pass through attributes`

data-automobile_type="buick" role="search" name="some name"

You can include in your tag a parameter with a name identical to any valid [HTML Form}(https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form) attribute, any [HTML Global Attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes), or the [ARIA Search role attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/Search_role).

If you assign a value to your parameter the value will be assigned to the attribute in the completed Form tag. To include an attribute which does not take a value (e.g. `novalidate`) you need to define a null value for the parameter (i.e. `novalidate=""`).

If you specify a parameter with a name that is the same as an attribute already being set by the Simple Search Form tag, the parameter value you enter will be ignored.

### `result_page=`

result_page="news/searches"
Expand Down
14 changes: 13 additions & 1 deletion docs/channels/channel-form/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,9 @@ By default, validation errors will be displayed using the User Message Template.

[TOC=3 hide]

The Following parameters are available for the `{exp:channel:form}`:
The Channel Form tag will create an HTML form and include within its opening tag the minimum attributes necessary for it to work. If you need additional attributes to be specified, Channel Form allows you to specify these attributes as additional parameters within the tag itself. See the entry for [pass_through_attributes](#pass_through_attributes) in the parameter listing for more information.

The following parameters are available for the `{exp:channel:form}`:

### `allow_comments=`

Expand Down Expand Up @@ -157,6 +159,16 @@ Output your results in JSON format, instead of performing a redirect.

In order to allow logged out users to use the entry form, you must specify a member_id which will be used as the author of the entry.

### `pass through attributes`

data-automobile_type="buick" role="search" name="some name"

You can include in your tag a parameter with a name identical to any valid [HTML Form}(https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form) attribute, any [HTML Global Attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes), or the [ARIA Search role attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/Search_role).

If you assign a value to your parameter the value will be assigned to the attribute in the completed Form tag. To include an attribute which does not take a value (e.g. `novalidate`) you need to define a null value for the parameter (i.e. `novalidate=""`).

If you specify a parameter with a name that is the same as an attribute already being set by the Channel Form tag, the parameter value you enter will be ignored.

### `require_entry=`

require_entry="yes"
Expand Down
13 changes: 13 additions & 0 deletions docs/member/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,8 @@ Here is how you might use the tag:

### Parameters

The Login Form Tag will create an HTML form and include within its opening tag the minimum attributes necessary for it to work. If you need additional attributes to be specified, The Simple Search Form Tag allows you to specify these attributes as additional parameters within the tag itself. See the entry for [pass_through_attributes](#pass_through_attributes) in the parameter listing for more information.

[TOC=4]

#### `action=`
Expand All @@ -98,6 +100,17 @@ 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.

### `pass through attributes`

data-automobile_type="buick" role="search" name="some name"

You can include in your tag a parameter with a name identical to any valid [HTML Form}(https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form) attribute, any [HTML Global Attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes), or the [ARIA Search role attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/Search_role).

If you assign a value to your parameter the value will be assigned to the attribute in the completed Form tag. To include an attribute which does not take a value (e.g. `novalidate`) you need to define a null value for the parameter (i.e. `novalidate=""`).

If you specify a parameter with a name that is the same as an attribute already being set by the Login Form tag, the parameter value you enter will be ignored.


#### `return=`

return="site/index"
Expand Down