Skip to content

Commit ee6d925

Browse files
authored
Merge pull request #895 from ExpressionEngine/7.dev
Version 7.5.0
2 parents c6ff526 + 5931626 commit ee6d925

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+1064
-290
lines changed

docs/_downloads/sample-atom.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
{exp:rss:feed channel="{master_channel_name}"}
55

66
<?xml version="1.0" encoding="{encoding}"?>
7-
<feed xmlns="https://www.w3.org/2005/Atom" xml:lang="{channel_language}">
7+
<feed xmlns="http://www.w3.org/2005/Atom" xml:lang="{channel_language}">
88

99
<title type="text"><![CDATA[{channel_name}]]></title>
1010
<subtitle type="text"><![CDATA[{channel_name} - {channel_description}]]></subtitle>
@@ -39,4 +39,4 @@
3939

4040
</feed>
4141

42-
{/exp:rss:feed}
42+
{/exp:rss:feed}

docs/_images/cp-field-manager.png

-75.4 KB
Loading
148 KB
Loading

docs/_tips/form-validation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
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

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ The contact form is created similar to a standard web form, only you **do not**
5252
</p>
5353
{/exp:email:contact_form}
5454

55+
{{embed:_tips/form-validation.md}}
56+
5557
## Parameters
5658

5759
[TOC=3]
@@ -64,6 +66,12 @@ The contact form is created similar to a standard web form, only you **do not**
6466

6567
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.
6668

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+
6775
### `name=`
6876

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

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

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+
123137
### `preview=`
124138

125139
preview="about/contact-preview"
@@ -330,7 +344,7 @@ In the above example, the Template "friend" contains the Tell-a-Friend form.
330344
[TOC=3]
331345

332346
### `allow_attachments=`
333-
347+
334348
allow_attachments="yes"
335349

336350
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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@ Below is a list of radio buttons, one for each letter of the alphabet. Selecting
280280

281281
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.
282282

283-
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.
283+
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.
284284

285285
{exp:pro_search:form query="{segment_3}"}
286286
{exp:low_options:service_options}
@@ -503,7 +503,7 @@ Below are two lists of tags. You can select multiple tags per list. Entries that
503503

504504
## Other & Native
505505

506-
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).
506+
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).
507507

508508
### Orderby and sort in one go
509509

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ The automatic `keywords:mode` uses operators in keywords for any/all/exact match
9595

9696
### Singulars & Plurals
9797

98-
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):
98+
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):
9999

100100
```
101101
$config['pro_search_inflection_rules'][lang] = array(
@@ -110,7 +110,7 @@ $config['pro_search_inflection_rules'][lang] = array(
110110

111111
### Stems
112112

113-
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):
113+
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):
114114

115115
```
116116
$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
154154
NOTE: **Note:** Use two separate fields instead of a single one for better performance.
155155

156156
### Variables
157-
The Distance filter also makes this variable available in the [Results tag](/add-ons/pro-search/tags#results-tag):
157+
The Distance filter also makes this variable available in the [Results tag](/add-ons/pro-search/tags.md#exppro_searchresults):
158158

159159
#### `{pro_search_distance}`
160160
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
163163

164164
## Field Search
165165

166-
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.
166+
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.
167167

168168
### Parameters
169169

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

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,19 @@
1010

1111
[TOC]
1212

13-
**These terms are used throughout the documentation:**
13+
**These terms are used throughout the documentation:**
1414
```
15-
required: This parameter/field is required for this tag to function.
16-
form only: This can only be set as a field in the form and not as a parameter in the tag.
17-
param only: This parameter can only be set in the tag and not as a field in the form.
18-
fixed value: This field cannot be edited and is set with a fixed value.
19-
recurring only: This parameter/field only applies to recurring charges.
20-
one-time only: This parameter/field only applies to one-time charges.
21-
added in X.X.X: This parameter/field is only available from this version forward.
22-
logged in: This tag is only available if the user is logged in.
15+
required: This parameter/field is required for this tag to function.
16+
form only: This can only be set as a field in the form and not as a parameter in the tag.
17+
param only: This parameter can only be set in the tag and not as a field in the form.
18+
fixed value: This field cannot be edited and is set with a fixed value.
19+
recurring only: This parameter/field only applies to recurring charges.
20+
one-time only: This parameter/field only applies to one-time charges.
21+
added in X.X.X: This parameter/field is only available from this version forward.
22+
logged in: This tag is only available if the user is logged in.
2323
```
2424

25+
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.
2526

2627
## {exp:pro_search:form}
2728

@@ -156,7 +157,7 @@ Short syntax for the URL tag. When used, it will automatically inherit the query
156157
## {exp:pro_search:filters}
157158

158159
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:
159-
160+
160161
{exp:pro_search:filters query="{segment_3}"}
161162
{exp:channel:categories channel="entries" style="linear"}
162163
{if count == 1}<ul>{/if}
@@ -316,7 +317,7 @@ Alternative syntax for the native {if no_results}{/if} conditional.
316317
#### `group_id=`
317318

318319
Limit shortcuts by given group ID
319-
320+
320321
{exp:pro_search:shortcuts group_id="1"}
321322
{if count == 1}<ul>{/if}
322323
<li><a href="{path="search/{shortcut_name}"}">{shortcut_label}</a></li>
@@ -402,7 +403,7 @@ Group ID the shortcut needs to be saved to. **Required**.
402403
<button type="submit">Save</button>
403404
</fieldset>
404405
{/exp:pro_search:save}
405-
406+
406407
#### `form_attribute=`
407408

408409
Specifies any html attribute you want the form to have. For example: `form_id="search"` will add `id="search"` to the form tag, while `form_class="searchform"` will add `class="searchform"` to the tag.
@@ -437,7 +438,7 @@ The encoded search query to inherit. Not needed when [not encoding queries](http
437438

438439
#### `reset=`
439440

440-
Set to "yes" to stop this tag from inheriting the current query.
441+
Set to "yes" to stop this tag from inheriting the current query.
441442

442443
{exp:pro_search:url reset="yes"}
443444

@@ -464,7 +465,7 @@ Use this single tag to output a single given parameter value outside of the Form
464465
{exp:pro_search:param get="item_size"}
465466

466467
You can also use it as a paired loop to output multi-valued parameters.
467-
468+
468469
{exp:pro_search:param:loop get="category" as="cat_id" query="{segment_3}"}
469470
{cat_id}
470471
{/exp:pro_search:param:loop}
@@ -500,7 +501,7 @@ Use this tag to display a list of popular keywords. The Search Log must be enabl
500501
#### `limit=`
501502

502503
Maximum number of keywords to display. Defaults to 10.
503-
504+
504505
{exp:pro_search:popular limit="10"}
505506
{if count == 1}<ul>{/if}
506507
<li>{keywords}: {search_count}</li>
@@ -624,7 +625,7 @@ Maximum number of suggestions to return. Defaults to 5.
624625
The method used for getting the suggestions, either `levenshtein` or `soundex`. Defaults to Levenshtein.
625626

626627
{exp:pro_search:suggestions method="soundex"}
627-
628+
628629
NOTE: **Note:** Using Soundex for generating suggestions is only effective for languages with a latin-based alphabet. The Levenshtein method works regardless of alphabet type.
629630

630631
#### `query=`

docs/add-ons/structure/overview.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,6 @@ Structure is a powerful add-on that lets you create pages, generate navigation,
1313

1414
It forgoes the default template_group/template setup and creates “static” and “listing” pages that are all editable through a tree sitemap view. With Structure enabled, traditional page style content and multiple entry pages can live within the same area.
1515

16+
Structure provides a [Template Generator](templates/generators.md) that demonstrates how to integrate Structure template tags with your site.
17+
1618
NOTE:**Note:** Documentation for Structure is still being migrated. Until this is complete, please reference the [Structure documentation on EEHarbor's website](https://eeharbor.com/structure/documentation).

docs/channels/channel-form/overview.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ The Channel Form makes it possible to add and edit channel entries from outside
2626

2727
## Basic Usage
2828

29-
TIP: Please visit the [Examples](channels/channel-form/examples.md) page to see a variety of implementations.
29+
TIP: You can view the [Examples](channels/channel-form/examples.md) page to see a variety of implementations.
30+
The Channel Form [Template Generator](templates/generators.md) can also help create a functional template that demonstrates the parameters and variables documented below.
3031

3132
The first thing you will need is a `{exp:channel:form}` tag pair, along with a few [parameters](#parameters) to determine where to submit the entry:
3233

0 commit comments

Comments
 (0)