diff --git a/docs/_downloads/sample-atom.txt b/docs/_downloads/sample-atom.txt index 28eb2c882..7539c8380 100755 --- a/docs/_downloads/sample-atom.txt +++ b/docs/_downloads/sample-atom.txt @@ -4,7 +4,7 @@ {exp:rss:feed channel="{master_channel_name}"} - + <![CDATA[{channel_name}]]> @@ -39,4 +39,4 @@ -{/exp:rss:feed} \ No newline at end of file +{/exp:rss:feed} diff --git a/docs/_images/cp-field-manager.png b/docs/_images/cp-field-manager.png index eafc5c5f3..c75478945 100644 Binary files a/docs/_images/cp-field-manager.png and b/docs/_images/cp-field-manager.png differ diff --git a/docs/_images/cp-template-generators.png b/docs/_images/cp-template-generators.png new file mode 100644 index 000000000..cb3b33ee1 Binary files /dev/null and b/docs/_images/cp-template-generators.png differ diff --git a/docs/_tips/form-validation.md b/docs/_tips/form-validation.md new file mode 100644 index 000000000..b6936d17c --- /dev/null +++ b/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. \ No newline at end of file diff --git a/docs/add-ons/email.md b/docs/add-ons/email.md index 3afec336c..733afef84 100755 --- a/docs/add-ons/email.md +++ b/docs/add-ons/email.md @@ -52,6 +52,8 @@ The contact form is created similar to a standard web form, only you **do not**

{/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. diff --git a/docs/add-ons/pro-search/examples.md b/docs/add-ons/pro-search/examples.md index 330935542..e69362ea1 100644 --- a/docs/add-ons/pro-search/examples.md +++ b/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 diff --git a/docs/add-ons/pro-search/filters.md b/docs/add-ons/pro-search/filters.md index a0dca61a9..9f806b694 100644 --- a/docs/add-ons/pro-search/filters.md +++ b/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 diff --git a/docs/add-ons/pro-search/tags.md b/docs/add-ons/pro-search/tags.md index d77a64782..9d111072b 100644 --- a/docs/add-ons/pro-search/tags.md +++ b/docs/add-ons/pro-search/tags.md @@ -10,18 +10,19 @@ [TOC] -**These terms are used throughout the documentation:** +**These terms are used throughout the documentation:** ``` -required: This parameter/field is required for this tag to function. -form only: This can only be set as a field in the form and not as a parameter in the tag. -param only: This parameter can only be set in the tag and not as a field in the form. -fixed value: This field cannot be edited and is set with a fixed value. -recurring only: This parameter/field only applies to recurring charges. -one-time only: This parameter/field only applies to one-time charges. -added in X.X.X: This parameter/field is only available from this version forward. -logged in: This tag is only available if the user is logged in. +required: This parameter/field is required for this tag to function. +form only: This can only be set as a field in the form and not as a parameter in the tag. +param only: This parameter can only be set in the tag and not as a field in the form. +fixed value: This field cannot be edited and is set with a fixed value. +recurring only: This parameter/field only applies to recurring charges. +one-time only: This parameter/field only applies to one-time charges. +added in X.X.X: This parameter/field is only available from this version forward. +logged in: This tag is only available if the user is logged in. ``` +NOTE: **Note:** See the [template generator](templates/generators.md) for the keyword search in ExpressionEngine 7.5+. Pro Search must be installed and a Collection created. ## {exp:pro_search:form} @@ -156,7 +157,7 @@ Short syntax for the URL tag. When used, it will automatically inherit the query ## {exp:pro_search:filters} The Filters tag works identically to the Form tag, without generating a search form. Use it to show specific search filters anywhere on your page, or to create a list of URL tags in short syntax. The following example shows a list of one-click filters based on the current search that could be used to modify the results display with javascript: - + {exp:pro_search:filters query="{segment_3}"} {exp:channel:categories channel="entries" style="linear"} {if count == 1}