Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
52 commits
Select commit Hold shift + click to select a range
150b9b0
let tabs display data in entry manager
intoeetive Jan 5, 2023
04a0bed
search module docs
intoeetive Jan 18, 2023
6ba552d
Update tab-files.md
TomJaeger Feb 3, 2023
2c22829
addon management CLI
intoeetive Mar 10, 2023
9d13583
addons:update --all
intoeetive Mar 22, 2023
a309c4e
Merge branch '7.dev' into feature/7.x/cli-addon-install
intoeetive May 8, 2023
59539d0
cloning layouts, fields, categories, roles
intoeetive May 9, 2023
2d6c46f
tip about using variable modifiers on search results
intoeetive May 10, 2023
a062b65
spelling
bakin1999 May 9, 2023
71a301c
"show time" setting for date field
intoeetive May 10, 2023
918e503
Added per-channel setting to enforce automatic URL titles for entries
intoeetive May 11, 2023
b8dcf6c
add info on 'show status' setting for relationship
intoeetive May 12, 2023
321262e
add missing file
intoeetive May 12, 2023
041426d
Update channels.md
TomJaeger May 23, 2023
550b3c3
7.3.0 changelog
intoeetive May 26, 2023
a896d44
Update add-on management docs
matthewjohns0n May 30, 2023
00a3e37
Add backup:database documentation, as well as config and env command …
matthewjohns0n May 30, 2023
5106362
Update wording and spelling on relationships
matthewjohns0n May 30, 2023
b669182
Wording updates to categories docs
matthewjohns0n May 30, 2023
eb9b205
Update channel cloning wording
matthewjohns0n May 30, 2023
4af5ef1
Update field-manager-settings.md
matthewjohns0n May 30, 2023
2e38806
Update member manager wording
matthewjohns0n May 30, 2023
beb4277
update field name description
intoeetive May 31, 2023
300e0ef
Update addon docs
matthewjohns0n Jun 2, 2023
8567734
Update addons.md
matthewjohns0n Jun 2, 2023
79a8fa1
Update backup database wording on absolute path
matthewjohns0n Jun 2, 2023
a2a0580
Update edit-field.md
matthewjohns0n Jun 2, 2023
b431006
Update date.md
matthewjohns0n Jun 2, 2023
883bead
Update date.md
matthewjohns0n Jun 2, 2023
aeee121
field groups in Fluid (#522)
intoeetive Jun 5, 2023
14fa42c
Adding TTL documentation
dougblackjr Apr 6, 2023
0954355
Merge pull request #594 from ExpressionEngine/feature/7.x/cli-addon-i…
intoeetive Jun 5, 2023
496d586
week_start setting
intoeetive May 8, 2023
6594b43
setting for shared upload directory
intoeetive May 8, 2023
987dc63
Merge branch '7.dev' into release/7.3.0
intoeetive Jun 5, 2023
32cafa8
Merge pull request #553 from ExpressionEngine/feature/7.x/tabs-in-ent…
intoeetive Jun 5, 2023
594659d
Merge pull request #658 from ExpressionEngine/feature/7.x/relationshi…
intoeetive Jun 5, 2023
1bf0e59
Merge pull request #657 from ExpressionEngine/feature/7.x/skip-url-ti…
intoeetive Jun 5, 2023
9c55d05
Merge pull request #655 from ExpressionEngine/feature/7.x/show-time-i…
intoeetive Jun 5, 2023
098bd09
Remove FLoC header from docs
intoeetive May 10, 2023
a1527a2
Merge pull request #652 from ExpressionEngine/feature/7.x/cloning-docs
intoeetive Jun 5, 2023
a233e57
entries prolet
intoeetive May 8, 2023
bbf329b
Merge pull request #567 from ExpressionEngine/feature/7.x/search-module
intoeetive Jun 5, 2023
5aa4107
Adding a section on CP access
robinsowell Jun 5, 2023
ab8a7d8
Adding link back to idle check
robinsowell Jun 5, 2023
15255f6
Added some more examples
robinsowell Jun 6, 2023
e5066a2
Merge pull request #665 from ExpressionEngine/7.3/beef-fluid-field-gr…
robinsowell Jun 6, 2023
bce9a32
Beefed up session info a bit.
robinsowell Jun 6, 2023
dd8019c
updated the image for relationship field
Yulyaswan Jun 7, 2023
fcae906
Merge pull request #664 from ExpressionEngine/7.3/admin-cp-modal
robinsowell Jun 7, 2023
20b89fb
Reflect new session config override changes.
robinsowell Jun 7, 2023
2d81309
clarify website session override
robinsowell Jun 7, 2023
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
Binary file added docs/_images/admin-access-modal.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/channel-publish-layouts.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_fields_edit.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/ee73-relationship-status.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/relationship-ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
81 changes: 42 additions & 39 deletions docs/add-ons/http-header.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,42 +25,45 @@ This is a single tag that will set a 410 "Gone" status on the request.

Here are the available parameters:

|Parameter|Corresponding HTTP Header / Instructions|
|--- |--- |
|access_control_allow_credentials=|Access-Control-Allow-Credentials|
|access_control_allow_headers=|Access-Control-Allow-Headers|
|access_control_allow_methods=|Access-Control-Allow-Methods|
|access_control_allow_origin=|Access-Control-Allow-Origin|
|access_control_expose_headers=|Access-Control-Expose-Headers|
|access_control_max_age=|Access-Control-Max-Age|
|alt_svc=|Alt-Svc|
|cache_control=|Cache-Control|
|charset=|charset to use with the content_type parameter.|
|content_disposition=|Content-Disposition - You can manually write out the full header value (i.e. attachment; filename="example.txt"), or just use a value of "attachmenet" and use the filename= parameter.|
|content_encoding=|Content-Encoding|
|content_language=|Content-Language|
|content_length=|Content-Length|
|content_location=|Content-Location|
|content_md5=|Content-MD5|
|content_range=|Content-Range|
|content_type=|Content-Type - You can manually write out the full header value (i.e. text/html; charset=UTF-8) or you can simply specify the type and use the charset= parameter.|
|etag=|ETag|
|expires=|Expires - You can use relative date such as "+1 day";|
|filename=|When content_disposition is set to attachment, this sets the filename.|
|last_modified=|Last-Modified - You can use relative date such as "+1 day";|
|link=|Link|
|location=|Location|
|permissions_policy|Permissions-Policy (set to `interest-cohort=()` to opt out of FLoC)|
|pragma=|Pragma|
|refresh=|Refresh - You can manually write out the full header value (i.e. 5; url=https://example.com/), or just set the refresh value in seconds and use the url= parameter.|
|retry_after=|Retry-After - You can either specify a number of seconds or use relative dates (i.e. "+90 mins").|
|status=|Status|
|tk=|Tk|
|url=|URL to use in the refresh parameter.|
|vary=|Vary|
|via=|Via|
|warning=|Warning|
|x_content_duration=|X-Content-Duration|
|x_content_type_options=|X-Content-Type-Options|
|x_frame_options=|X-Frame-Options|
|x_ua_compatible=|X-UA-Compatible|
| Parameter | Corresponding HTTP Header / Instructions|
|----------------------------------- |---------------------------------------- |
|access_control_allow_credentials= |Access-Control-Allow-Credentials|
|access_control_allow_headers= |Access-Control-Allow-Headers|
|access_control_allow_methods= |Access-Control-Allow-Methods|
|access_control_allow_origin= |Access-Control-Allow-Origin|
|access_control_expose_headers= |Access-Control-Expose-Headers|
|access_control_max_age= |Access-Control-Max-Age|
|alt_svc= |Alt-Svc|
|cache_control= |Cache-Control|
|charset= |charset to use with the content_type parameter.|
|content_disposition= |Content-Disposition - You can manually write out the full header value (i.e. attachment; filename="example.txt"), or just use a value of "attachmenet" and use the filename= parameter.|
|content_encoding= |Content-Encoding|
|content_language= |Content-Language|
|content_length= |Content-Length|
|content_location= |Content-Location|
|content_md5= |Content-MD5|
|content_range= |Content-Range|
|content_type= |Content-Type - You can manually write out the full header value (i.e. text/html; charset=UTF-8) or you can simply specify the type and use the charset= parameter.|
|etag= |ETag|
|expires= |Expires - You can use relative date such as "+1 day";|
|filename= |When content_disposition is set to `attachment`, this sets the filename.|
|last_modified= |Last-Modified - You can use relative date such as "+1 day";|
|link= |Link|
|location= |Location|
|permissions_policy= |Permissions-Policy|
|pragma= |Pragma|
|refresh= |Refresh - You can manually write out the full header value (i.e. 5; url=https://example.com/), or just set the refresh value in seconds and use the url= parameter.|
|retry_after= |Retry-After - You can either specify a number of seconds or use relative dates (i.e. "+90 mins").|
|status= |Status|
|tk= |Tk|
|url= |URL to use in the refresh parameter.|
|vary= |Vary|
|via= |Via|
|warning= |Warning|
|x_content_duration= |X-Content-Duration|
|x_content_type_options= |X-Content-Type-Options|
|x_frame_options= |X-Frame-Options|
|x_ua_compatible= |X-UA-Compatible|


NOTE: **Note:** The plugin can only be used in templates that are not being cached.
59 changes: 58 additions & 1 deletion docs/add-ons/search/advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,63 @@ With this parameter, you can specify the css class you want the form to have, en

With this parameter, you can specify the css id you want the form to have.

### `orderby=`

orderby="entry_date"

The "orderby" parameter sets the display order of the entries. The available values for this property are `entry_date`, `most_comments`, `recent_comment`, `title`, `status`, `entry_id`, `url_title`, `edit_date`, `comment_total`, `expiration_date`, `view_count_one`, `view_count_two`, `view_count_three`, `view_count_four`.`

If this parameter is not set, it will default to ordering by entry date.

### `sort=`

sort="asc"

sort="desc"

The sort order can be "asc" (ascending order or "oldest item first") or "desc" (descending order or "newest item first"). If you do not use a sort order the default is desc.

## Variables

A full discussion of the available variables is not feasible there is a great deal of interdependence between the various form fields, variables, and javascript functions. The Parameters can be used to modify how the search behaves. If you wish to modify the search form itself, simply use the default form as a base and customize it from there.
### `channel_names`

Pre-populated string containing list of `<option>` tags containing channels that can be used to select channel to search in.

### `lang:...`

Should you be willing to use the language string from ExpressionEngine language files to build the search, the following are available:

#### `lang:search_engine`
#### `lang:search`
#### `lang:search_by_keyword`
#### `lang:search_in_titles`
#### `lang:search_in_entries`
#### `lang:search_everywhere`
#### `lang:search_by_member_name`
#### `lang:exact_name_match`
#### `lang:exact_phrase_match`
#### `lang:also_search_comments`
#### `lang:any_date`
#### `lang:today_and`
#### `lang:this_week_and`
#### `lang:one_month_ago_and`
#### `lang:three_months_ago_and`
#### `lang:six_months_ago_and`
#### `lang:one_year_ago_and`
#### `lang:channels`
#### `lang:weblogs`
#### `lang:categories`
#### `lang:newer`
#### `lang:older`
#### `lang:sort_results_by`
#### `lang:date`
#### `lang:title`
#### `lang:most_comments`
#### `lang:recent_comment`
#### `lang:descending`
#### `lang:ascending`
#### `lang:search_entries_from`
#### `lang:any_category`
#### `lang:search_any_words`
#### `lang:search_all_words`
#### `lang:search_exact_word`
2 changes: 2 additions & 0 deletions docs/add-ons/search/results.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,8 @@ An excerpt from the entry. The excerpt consists of the first 50 words from the f

The text from the entry. Unlike the {excerpt} variable, this one returns the entire text from the field specified for search excerpting in your [Channel Management](control-panel/channels.md) settings for your channels.

TIP: **Tip:** Use [variable modifiers](templates/variable-modifiers.md) to more precisely control the output of search results variables.

### `{id_auto_path}`

This parameter is replaced with the URL to the entry with the Entry ID appended to the end. Unlike other "path" variables, this variable does **not** require the Template_Group/Template to be specified. Instead, the path will automatically be determined by the Channel URL setting for the channel in [Channel Management](control-panel/channels.md).
Expand Down
16 changes: 16 additions & 0 deletions docs/add-ons/search/simple.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,22 @@ With this parameter, you can specify the css class you want the form to have, en

With this parameter, you can specify the css id you want the form to have.

### `orderby=`

orderby="entry_date"

The "orderby" parameter sets the display order of the entries. The available values for this property are `entry_date`, `most_comments`, `recent_comment`, `title`, `status`, `entry_id`, `url_title`, `edit_date`, `comment_total`, `expiration_date`, `view_count_one`, `view_count_two`, `view_count_three`, `view_count_four`.`

If this parameter is not set, it will default to ordering by entry date.

### `sort=`

sort="asc"

sort="desc"

The sort order can be "asc" (ascending order or "oldest item first") or "desc" (descending order or "newest item first"). If you do not use a sort order the default is desc.

## Variables

There are no specific variables associated with the Simple Search Form. You may use the [{path=''}](templates/globals/path.md) Global Variable to create a link to an Advanced Search Form if you wish.
8 changes: 6 additions & 2 deletions docs/advanced-usage/front-end/dock.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,15 @@ The Control Panel button on the Dock will open the site's Control Panel in a new
## Prolets
Prolets are add-on components that reveal some of add-on's functionality for the Control Panel to the front-end, making it possible to edit data directly on the page where it belongs.

### Entries Prolet
Pro is currently shipped with the Entries prolet. Clicking on the Entries prolet opens a prolet window with all entries currently listed. Allowing you to quickly find and edit other entries in your site.
### Built-in Prolets
ExpressionEngine is shipped with the Entries and Publish prolets.

Clicking on the Entries prolet opens a prolet window with all entries currently listed. Allowing you to quickly find and edit other entries in your site.

![dock entries](_images/ee-pro-dock-entries.png)

Publish prolets allows creation of new entry directly from the page you are viewing. Clicking Publish prolet button brings the window with channel selection, and picking the channel brings entry form.

### Custom Prolets
Developers may create third-party prolets that can be installed with add-ons. Read the [docs on creating prolets](development/prolets.md) for more information on how to create and install third-party prolets.

Expand Down
68 changes: 68 additions & 0 deletions docs/cli/built-in-commands/addons.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# Add-on Management

Set of CLI commands that allows listing, installing, updating and uninstalling add-ons.

[TOC]

## `addons:list`

Lists all add-ons available in the system.

php eecli.php addons:list

List add-ons that are currently installed:

php eecli.php addons:list i

or

php eecli.php addons:list installed

List add-ons that have an update available:

php eecli.php addons:list a

or

php eecli.php addons:list update-available

List add-ons that are currently uninstalled:

php eecli.php addons:list u
or

php eecli.php addons:list uninstalled

## `addons:install`

Installs an add-on. Add-on name can be selected (typed) in dialog or provided with `--addon` or `-a` option.

php eecli.php addons:install

or

php eecli.php addons:install --addon block_and_allow

## `addons:update`

Updates an add-on. Add-on name can be selected (typed) in dialog or provided with `--addon` or `-a` option.
You can also set `--all` flag to run all add-on updates that are available.

php eecli.php addons:update

or

php eecli.php addons:update --addon block_and_allow

or

php eecli.php addons:update --all

## `addons:uninstall`

Uninstalls an add-on. Add-on name can be selected (typed) in dialog or provided with `--addon` or `-a` option.

php eecli.php addons:uninstall
or

php eecli.php addons:uninstall --addon block_and_allow
39 changes: 39 additions & 0 deletions docs/cli/built-in-commands/backup-database.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# backup:database

Database backups

## Options list:

--relative_path=<value>
-p <value>
Path to database backup, relative to the cache folder

--absolute_path=<value>
-a <value>
Absolute path to the directory the database backup will be stored

--file_name=<value>
-f <value>
Name of sql file to be saved

--speed=<value>
-s <value>
Speed of database backup (between 1-10). Setting a lower speed allows for more time between database commands. Default speed is 5.


## Examples:

### Backup the database to the default path, at the default speed

php eecli.php backup:database

# Example backup path and filename:
system/user/cache/eedatabase_2023-05-30_18h05m39sUTC.sql

### Backup the database to the to an absolute path, with a custom filename

php eecli.php backup:database --file_name=deploy_backup.sql --absolute_path='/home/forge/backups'

### Backup the database at a slow speed, to help with the potential to lock up the database.

php eecli.php backup:database --speed=1
63 changes: 63 additions & 0 deletions docs/cli/built-in-commands/config-management.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Config Management

Set of CLI commands that updates the config file values, as well as ENV values. These are commonly use to provision a site or as part of a deploy script.

[TOC]

## `config:config`

Updates values in the config.php file.

### Options list
--config-variable=<value>
-c <value>
The config item to modify

--value=<value>
-v <value>
The value to set the config item to

### Examples

Set system to offline:

php eecli.php config:config -c is_system_on -v n

Set system to online:

php eecli.php config:config -c is_system_on -v y


Set debug to 1:

php eecli.php config:config -c debug -v 1


## `config:env`

Updates values in the .env.php file.

### Options list
--env-variable=<value>
-e <value>
The env item to set/modify

--value=<value>
-v <value>
The value to set the env item to

### Examples

Set system to offline:

php eecli.php config:env -e IS_SYSTEM_ON -v n

Set system to online:

php eecli.php config:env -e IS_SYSTEM_ON -v y

Set EE_INSTALL_MODE to false

php eecli.php config:env -e EE_INSTALL_MODE -v FALSE


2 changes: 1 addition & 1 deletion docs/cli/built-in-commands/make-action.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# make:action

Action Generator -- Creates a new action for an add-on
Action Generator -- Creates a new action for an add-on

## Options list:

Expand Down
Loading