Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
beca8fb
Change namespace in sample Atom feed to HTTP
jake-penguins May 2, 2023
ec67406
{exp:channel:field} tag
intoeetive Oct 11, 2023
71d482c
Fix Fluid Field hooks info
intoeetive Dec 5, 2023
69c8bf5
further modifications suggested by @litzinger
intoeetive Dec 12, 2023
125ed73
Document fluid field group changes from EE PR 4030
bryannielsen Jun 18, 2024
7e19d0e
Added docs for cp menu cloning
robinsowell Jul 3, 2024
bccfc72
Add missing div to exp:channel:field example
bryannielsen Jul 8, 2024
faa84fe
Add a note about it being supported in the channel entries loop as a …
matthewjohns0n Aug 23, 2024
01caa1a
Update email.md
nep Aug 30, 2024
023d09a
Update date-variable-formatting.md
nep Sep 4, 2024
60b7253
Add documentation for form validation in templates
bryannielsen Sep 10, 2024
3565bdd
Resolve warnings for missing links in documentation
bryannielsen Sep 10, 2024
832e205
Add documentation for Template Generators feature
bryannielsen Oct 7, 2024
b8a5a99
mention that the documentation and comments are optional and a setting
bakin1999 Oct 8, 2024
8db42e5
Merge branch '7.dev' into feature/7.x/fluid-field-hooks-update
matthewjohns0n Oct 8, 2024
58bdeb3
Update notes.md
matthewjohns0n Oct 8, 2024
be45dd4
Update template-generator.md
matthewjohns0n Oct 8, 2024
98a698f
Update template-generator.md
matthewjohns0n Oct 8, 2024
8e444eb
Update generators.md
matthewjohns0n Oct 8, 2024
c13701e
Added in inline error params and alphabetized in a few cases
robinsowell Oct 9, 2024
f853b06
Merge pull request #891 from ExpressionEngine/feature/7.5/inline-erro…
bryannielsen Oct 9, 2024
45e1b9b
Merge pull request #878 from ExpressionEngine/feature/7.5/notes-usabl…
bryannielsen Oct 9, 2024
497d101
Merge pull request #748 from ExpressionEngine/feature/7.x/exp-channel…
bryannielsen Oct 9, 2024
5e8d1df
Merge pull request #778 from ExpressionEngine/feature/7.x/fluid-field…
bryannielsen Oct 9, 2024
b874737
Revert "Fix Fluid Field hooks info"
bryannielsen Oct 9, 2024
48e512c
Merge pull request #892 from ExpressionEngine/revert-778-feature/7.x/…
bryannielsen Oct 9, 2024
73b9c62
Merge pull request #866 from ExpressionEngine/feature/7.x/fluid-field…
bryannielsen Oct 9, 2024
dce3e18
Merge pull request #874 from ExpressionEngine/feature/7.5/menu-cloning
bryannielsen Oct 9, 2024
9adb438
Merge pull request #883 from ExpressionEngine/feature/7.5/inline-form…
bryannielsen Oct 9, 2024
40829b2
Merge pull request #890 from ExpressionEngine/feature/7.5/template-ge…
bryannielsen Oct 9, 2024
900e533
Fix broken link
bryannielsen Oct 9, 2024
1e75cfd
Added a link to template generator detail page from template manager
robinsowell Oct 14, 2024
8d8302b
Added info on tag copying
robinsowell Oct 14, 2024
ee76a3d
Release 7.5.0
bryannielsen Oct 14, 2024
45fa492
Small updates to shortname tag copying
bryannielsen Oct 14, 2024
442033c
Merge pull request #893 from ExpressionEngine/7.5/added-copy-tags-info
bryannielsen Oct 14, 2024
317505b
Add line about enhancements for copy shortname functionality
bryannielsen Oct 14, 2024
578a43c
Merge pull request #882 from nep/patch-4
bryannielsen Oct 14, 2024
12ea976
Merge pull request #880 from nep/patch-3
bryannielsen Oct 14, 2024
5f9646e
Rough draft template generator 'note'
robinsowell Sep 10, 2024
efe625b
Fixed note format and added structure note re template generators
robinsowell Oct 8, 2024
9d720e0
Merge pull request #642 from jake-penguins/7.dev
bryannielsen Oct 14, 2024
0fbac7a
Update cross-references to template generators
bryannielsen Oct 14, 2024
1e6a0bd
Merge pull request #884 from ExpressionEngine/feature/7.5/note-genera…
bryannielsen Oct 14, 2024
81f2b88
Merge pull request #894 from ExpressionEngine/release/7.5.0
bryannielsen Oct 14, 2024
5931626
Update cp-field-manager.png
bakin1999 Oct 14, 2024
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
4 changes: 2 additions & 2 deletions docs/_downloads/sample-atom.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
{exp:rss:feed channel="{master_channel_name}"}

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

<title type="text"><![CDATA[{channel_name}]]></title>
<subtitle type="text"><![CDATA[{channel_name} - {channel_description}]]></subtitle>
Expand Down Expand Up @@ -39,4 +39,4 @@

</feed>

{/exp:rss:feed}
{/exp:rss:feed}
Binary file modified docs/_images/cp-field-manager.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/cp-template-generators.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/_tips/form-validation.md
Original file line number Diff line number Diff line change
@@ -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.
16 changes: 15 additions & 1 deletion docs/add-ons/email.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ The contact form is created similar to a standard web form, only you **do not**
</p>
{/exp:email:contact_form}

{{embed:_tips/form-validation.md}}

## Parameters

[TOC=3]
Expand All @@ -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"
Expand Down Expand Up @@ -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"
Expand Down Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions docs/add-ons/pro-search/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down Expand Up @@ -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

Expand Down
8 changes: 4 additions & 4 deletions docs/add-ons/pro-search/filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand All @@ -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(
Expand Down Expand Up @@ -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.
Expand All @@ -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

Expand Down
33 changes: 17 additions & 16 deletions docs/add-ons/pro-search/tags.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}

Expand Down Expand Up @@ -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}<ul>{/if}
Expand Down Expand Up @@ -316,7 +317,7 @@ Alternative syntax for the native {if no_results}{/if} conditional.
#### `group_id=`

Limit shortcuts by given group ID

{exp:pro_search:shortcuts group_id="1"}
{if count == 1}<ul>{/if}
<li><a href="{path="search/{shortcut_name}"}">{shortcut_label}</a></li>
Expand Down Expand Up @@ -402,7 +403,7 @@ Group ID the shortcut needs to be saved to. **Required**.
<button type="submit">Save</button>
</fieldset>
{/exp:pro_search:save}

#### `form_attribute=`

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.
Expand Down Expand Up @@ -437,7 +438,7 @@ The encoded search query to inherit. Not needed when [not encoding queries](http

#### `reset=`

Set to "yes" to stop this tag from inheriting the current query.
Set to "yes" to stop this tag from inheriting the current query.

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

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

You can also use it as a paired loop to output multi-valued parameters.

{exp:pro_search:param:loop get="category" as="cat_id" query="{segment_3}"}
{cat_id}
{/exp:pro_search:param:loop}
Expand Down Expand Up @@ -500,7 +501,7 @@ Use this tag to display a list of popular keywords. The Search Log must be enabl
#### `limit=`

Maximum number of keywords to display. Defaults to 10.

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

{exp:pro_search:suggestions method="soundex"}

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.

#### `query=`
Expand Down
2 changes: 2 additions & 0 deletions docs/add-ons/structure/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,6 @@ Structure is a powerful add-on that lets you create pages, generate navigation,

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.

Structure provides a [Template Generator](templates/generators.md) that demonstrates how to integrate Structure template tags with your site.

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).
3 changes: 2 additions & 1 deletion docs/channels/channel-form/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ The Channel Form makes it possible to add and edit channel entries from outside

## Basic Usage

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

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:

Expand Down
4 changes: 3 additions & 1 deletion docs/channels/entries.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ The directives that tell the tag how to behave are **parameters**:

Within the opening and closing ExpressionEngine Tags are **variables**. `{title}` is replaced with the Title of each entry, and `{body}` is replaced with the content from the "Body" field of each entry.

The Channel Entries module provides a [Template Generator](templates/generators.md) that creates functional templates while demonstrating the parameters and variables documented below.

## Parameters

[TOC=3 hide]
Expand Down Expand Up @@ -893,7 +895,7 @@ The "count" out of the current entries being displayed. If five entries are bein
<a href="{cp_edit_entry_url}">Edit Entry</a>
{/if}

The URL of the entry form in the control panel where this entry can be edited. It is recommended you wrap this variable in an `{if logged_in}` conditional to hide your control panel's URL from regular site visitors. If you are running a membership-based site, hide it behind an appropriate `logged_in_primary_role_id` conditional or use [exp:member:has_role](/member/member-roles-tags.html#expmemberhas_role). For example, to hide this link from everyone but Super Admins:
The URL of the entry form in the control panel where this entry can be edited. It is recommended you wrap this variable in an `{if logged_in}` conditional to hide your control panel's URL from regular site visitors. If you are running a membership-based site, hide it behind an appropriate `logged_in_primary_role_id` conditional or use [exp:member:has_role](/member/member-roles-tags.md#expmemberhas_role). For example, to hide this link from everyone but Super Admins:

{if logged_in_primary_role_id == 1}
<a href="{cp_edit_entry_url}">Edit Entry</a>
Expand Down
80 changes: 80 additions & 0 deletions docs/channels/fields.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
<!--
This source file is part of the open source project
ExpressionEngine User Guide (https://github.com/ExpressionEngine/ExpressionEngine-User-Guide)

@link https://expressionengine.com/
@copyright Copyright (c) 2003-2020, Packet Tide, LLC (https://packettide.com)
@license https://expressionengine.com/license Licensed under Apache License, Version 2.0
-->

# Channel Field Tag

[TOC]

## Overview

`{exp:channel:field}` tag allows displaying properties of [channel field](control-panel/field-manager/edit-field.md) irrespective of the context.

{exp:channel:field field_name="department"}
<div>
<p>Choose <b>{field_label}</b>:</p>
{field_options}
<p><span class="value">{value}</span>: <span class="label">{label}</span></p>
{/field_options}
</div>
{/exp:channel:field}

## Parameters

### `field_id=`

field_id="2"

Specify field ID. It is required to have either field_id or field_name parameter. If both are specified, field_id will be used.

### `field_name=`

field_name="body"

Specify field name. It is required to have either field_id or field_name parameter.

### `site_id=`

site_id="2"

By default, the tag is looking for fields that are set up for current MSM site. If you need to display properties of field that belongs to other MSM site, you need to specify site_id parameter.


## Variables

[TOC=3]

### `{field_id}`

Field ID

### `{field_name}`

Field name

### `{field_label}`

Field label

### `{field_instructions}`

Field instructions for the CP

### `{field_type}`

Field type

### `{field_options}`

Tag pair that contains possible field options. It is used for fields like Radio Buttons, Checkboxes, Select Dropdown, etc.

Inside the tag pair you can use `{value}` and `{label}` variables:

{field_options}
{value} / {label}
{/field_options}
Loading