Skip to content
Merged
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
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
2 changes: 2 additions & 0 deletions 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
4 changes: 2 additions & 2 deletions docs/control-panel/template-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -241,12 +241,12 @@ This section of the Control Panel allows you to create or edit a template group.

## Template Generators

**Control Panel Location: `Developer > Templates > Template Generators`**
**Control Panel Location: `Developer > Templates > Template Generator`**

This section of the Control Panel allows you to automatically create the basic tag framework for a variety of modules, including channels, navigation, member tags, etc. using [Template Generators](templates/generators.md).

## Export Templates

**Control Panel Location: `Developer > Templates > Export`**

![Export All Templates icon](/_images/export_templates.png) Clicking the Export All Templates Icon will download all templates, partials, and variables as a compressed *.zip archive.
![Export All Templates icon](/_images/export_templates.png) Clicking the Export All Templates Icon will download all templates, partials, and variables as a compressed *.zip archive.
2 changes: 1 addition & 1 deletion docs/member/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ You'll find many member management options available at:
- The [Members](control-panel/member-manager.md) section, which hosts a comprehensive suite of member management utilities including the [Membership Preferences](control-panel/settings/members.md) page.
- The My Account Page, accessible from the Control Panel's sidebar. It can also display information for any member if you choose a particular member from `Members`.
- Member [global template variables](templates/globals/single-variables.md#member-variables), which allow you to output information on the current user.
- Member tags can be used to build a robust frontend member area, enabling your site members to manage their personal profile information without having access to your Control Panel.
- Member tags can be used to build a robust frontend member area, enabling your site members to manage their personal profile information without having access to your Control Panel. The Member Management [Template Generator](templates/generators.md) can create a set of functional templates that demonstrate how to use these tags along with their available parameters and variables.


NOTE: **Note:** A member account's Username and Screen Name can be identical, but the Username must be unique system-wide.
Expand Down
2 changes: 1 addition & 1 deletion docs/templates/generators.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ ExpressionEngine provides a set of template generators that allow you to quickly

## Control Panel Usage

Before you can use the template generators you will need to set up your channels and custom fields. Once this is done you can navigate to Templates > Template Generator.
Before you can use the template generators you will need to set up your channels and custom fields. Once this is done you can navigate to `Developer > Templates > Template Generator`.

![ExpressionEngine Control Panel Template Generator](_images/cp-template-generators.png)

Expand Down