) that is displayed to the side of the sidebar when hovering over the sidebar.
+The sidebar can also be collapsed using the arrow icon ( 
) that is displayed to the side of the sidebar when hovering over the sidebar.
### Filters
@@ -45,7 +45,7 @@ Filters allow you to quickly filter the files listed to find exactly what you ne
The following selectable filters are available:
* Type - Filter by the file type. Available types are Image, Document, Archive, Audio, Video (only file types of currently uploaded files are displayed)
-* Category - Filter by categories available to files.
+* Category - Filter by categories available to files.
* Date Added - Filter by date added. Available options are Custom Date (enter in a specific date), Last 24 Hours, Last 7 Days, Last 30 Days, Last 180 Days, Last 365 Days
* Added By - Filter by the member who uploaded files
@@ -55,7 +55,7 @@ Files can also be filtered using the keyword search option.
### File Listing
-The bulk of the File Manager screen is composed of the file list.
+The bulk of the File Manager screen is composed of the file list.
@@ -75,7 +75,7 @@ The List View also exposes a Utility Action menu which quickly allows for action
-The columns displayed in the List View can also be adjusted to display file information relevant to your needs.
+The columns displayed in the List View can also be adjusted to display file information relevant to your needs.
These columns include:
* Title
diff --git a/docs/control-panel/file-manager/upload-directories.md b/docs/control-panel/file-manager/upload-directories.md
index fe2d968fd..3d18ee93c 100644
--- a/docs/control-panel/file-manager/upload-directories.md
+++ b/docs/control-panel/file-manager/upload-directories.md
@@ -49,7 +49,7 @@ The directory can be restricted to accept one or several following file types: I
By default, only images are allowed.
-Only file types that are specified in ExpressionEngine's Mime Type file are allowed to be uploaded. The Mime Type file can be found in [`mimes.php`](config/config-files.md#allowed-mime-types). If you are uploading something uncommon and run into problems, you may need to add the mime type for your file to the allow list.
+Only file types that are specified in ExpressionEngine's Mime Type file are allowed to be uploaded. The Mime Type file can be found in [`mimes.php`](config/config-files.md#allowed-mime-types). If you are uploading something uncommon and run into problems, you may need to add the mime type for your file to the allow list.
See also [MIME allow list](general/system-configuration-overrides.md#mime_whitelist_additions) and [Mime member exception allow list](general/system-configuration-overrides.md#mime_whitelist_member_exception) for more info.
##### Share Upload Directory on all sites?
@@ -86,7 +86,7 @@ Optionally set the maximum allowed height in pixels for uploaded images. Images
##### Constrain or Crop
-Specify one or more alternate versions of an image that automatically get created when the original image is uploaded. A manipulation can include a resized version, a [watermark](control-panel/file-manager/file-manager.md#watermarks), or both. You can refer to a particular Image Manipulation in your templates via a File Field's [single variable tag](fieldtypes/file.md#single-variable-usage) or its [variable pair tag](fieldtypes/file.md#url). The resize type will determine whether the image is constrained (resized) or cropped to the specified dimensions. If only height or width is specified, the thumbnails will be created using that as the master dimension. For example, setting the height to 200 and leaving the width blank will result in an image that is no higher than 200 pixels, with the width resized proportionately. Setting both the height and the width to 200 would result in an image that is no higher or wider than 200 pixels.
+Specify one or more alternate versions of an image that automatically get created when the original image is uploaded. A manipulation can include a resized version, a [watermark](control-panel/file-manager/watermarks.md), or both. You can refer to a particular Image Manipulation in your templates via a File Field's [single variable tag](fieldtypes/file.md#single-variable-usage) or its [variable pair tag](fieldtypes/file.md#url). The resize type will determine whether the image is constrained (resized) or cropped to the specified dimensions. If only height or width is specified, the thumbnails will be created using that as the master dimension. For example, setting the height to 200 and leaving the width blank will result in an image that is no higher than 200 pixels, with the width resized proportionately. Setting both the height and the width to 200 would result in an image that is no higher or wider than 200 pixels.
##### Allowed member roles
diff --git a/docs/control-panel/member-manager.md b/docs/control-panel/member-manager.md
index 695fe5cf9..86d4e2a9c 100755
--- a/docs/control-panel/member-manager.md
+++ b/docs/control-panel/member-manager.md
@@ -44,7 +44,7 @@ ExpressionEngine comes with 5 built-in Roles:
These roles should never be deleted.
-If you need a custom set of permissions for the role, we suggest creating a new role for each case. You can do that by clicking "New Role" button, or you can create a new role based on an exsting one by picking "Clone to New Role" from the role's "Save" dropdown.
+If you need a custom set of permissions for the role, we suggest creating a new role for each case. You can do that by clicking "New Role" button, or you can create a new role based on an existing one by picking "Clone to New Role" from the role's "Save" dropdown.
Edit the role by clicking its name in the list.
diff --git a/docs/control-panel/settings/captcha.md b/docs/control-panel/settings/captcha.md
index 7f24a29c6..c609e5446 100755
--- a/docs/control-panel/settings/captcha.md
+++ b/docs/control-panel/settings/captcha.md
@@ -55,7 +55,7 @@ If you wish to use Google reCAPTCH v3 as a replacement you will need to ensure t
### Use reCAPTCHA v3?
-If you enable this preference then the system will use reCAPTCH v3 in place of the older image based solution.
+If you enable this preference then the system will use reCAPTCHA v3 in place of the older image based solution.
### reCAPTCHA site key
diff --git a/docs/control-panel/settings/content-design.md b/docs/control-panel/settings/content-design.md
index 70802d2cb..4b435dd76 100755
--- a/docs/control-panel/settings/content-design.md
+++ b/docs/control-panel/settings/content-design.md
@@ -34,9 +34,9 @@ Set whether to assign an entry to both the selected category and its parent cate
### Run File Manager in Compatibility Mode?
-WARN:**Note:** Compatibility Mode is enabeld by default for sites upgrading from ExpressionEngine versions less than ExpressionEngine 7.
+WARN:**Note:** Compatibility Mode is enabled by default for sites upgrading from ExpressionEngine versions less than ExpressionEngine 7.
-When Compatibility Mode is enabled, files will be stored in the database using a format compatiblie with ExpressionEngine versions 6 and prior. Compatibility Mode disables many newer File Manager features and prevents issues with add-ons that are not ExpressionEngine 7+ compatible. See [`File Manager > Compatibility Mode`](/control-panel/file-manager/file-manager.md#compatibility-mode) for more information.
+When Compatibility Mode is enabled, files will be stored in the database using a format compatible with ExpressionEngine versions 6 and prior. Compatibility Mode disables many newer File Manager features and prevents issues with add-ons that are not ExpressionEngine 7+ compatible. See [`File Manager > Compatibility Mode`](/control-panel/file-manager/file-manager.md#compatibility-mode) for more information.
### Protocol
diff --git a/docs/control-panel/settings/debug-output.md b/docs/control-panel/settings/debug-output.md
index 09bc5761c..38db4b0ab 100755
--- a/docs/control-panel/settings/debug-output.md
+++ b/docs/control-panel/settings/debug-output.md
@@ -21,7 +21,7 @@ When set to "enable", super admins and member roles with permissions will see PH
### Enable debugging?
-If enabled, Super Admins will see benchmark results, SQL queries, and submitted form data displayed at the bottom of the browser window. On the front end, this includes Global Variables, Conditionals, Tags, PHP on Input/Ouput, Embeds, and Extension Hooks. This is an excellent tool for debugging.
+If enabled, Super Admins will see benchmark results, SQL queries, and submitted form data displayed at the bottom of the browser window. On the front end, this includes Global Variables, Conditionals, Tags, PHP on Input/Output, Embeds, and Extension Hooks. This is an excellent tool for debugging.
### Enable GZIP compression?
diff --git a/docs/control-panel/settings/front-end-editing.md b/docs/control-panel/settings/front-end-editing.md
index 4310a5600..1b70a91d5 100644
--- a/docs/control-panel/settings/front-end-editing.md
+++ b/docs/control-panel/settings/front-end-editing.md
@@ -12,17 +12,17 @@
[TOC]
-**Control Panel Location:** `Seetings -> Content & Design > Front-End Editing`
+**Control Panel Location:** `Settings -> Content & Design > Front-End Editing`
## **Enable Dock**
-(Default: On, Matching Config Override: [`enable_dock`](#enable_dock) )
+(Default: On, Matching Config Override: [`enable_dock`](general/system-configuration-overrides.md#enable_dock) )
Enabling the Dock controls whether ExpressionEngine Pro is turned on for the front-end of your website. When the Dock is disabled all front-end editing, prolets, and Dock features will be disabled.
## **Enable front-end editing**
-(Default: On, Matching Config Override: [`enable_frontedit`](#enable_frontedit))
+(Default: On, Matching Config Override: [`enable_frontedit`](general/system-configuration-overrides.md#enable_frontedit))
Enabling front-end editing allows users with respective permissions to edit channel entries and content on the front-end of your website using provided edit links ( 
) .
## **Enable automatic front-end editing links**
-(Default: On, Matching Config Override: [`enable_frontedit_links`](#enable_frontedit_links))
+(Default: On, Matching Config Override: [`enable_frontedit_links`](general/system-configuration-overrides.md#enable_frontedit_links))
By default ExpressionEngine Pro automatically inserts edit links ( ) where editable content is found in templates. These can be disabled on a per field basis or globally when using this toggle. When toggled off, ExpressionEngine Pro will no longer automatically generate edit links and links will need to be [added manually](/advanced-usage/front-end/frontend.md#customizing-the-link-location) where needed in templates.
\ No newline at end of file
diff --git a/docs/development/actions.md b/docs/development/actions.md
index 951d601a9..fe9d85090 100644
--- a/docs/development/actions.md
+++ b/docs/development/actions.md
@@ -9,12 +9,12 @@
# Actions
-TIP: If you are working with an existing add-on, we recommend you start with [Modernizing add-ons](development/modernizing-existing-add-ons.md)
+TIP: If you are working with an existing add-on, we recommend you start with [Modernizing add-ons](development/modernizing-existing-add-ons.md)
[TOC]
## Overview
-Actions in ExpressionEngine are URL endpoints that are reached with the `ACT` query parameter. An example of this might be `http://myamazingsite.com/?ACT=43` where 43 is the ID given to an action registered in the `exp_actions` database table. These actions are tied to methods in an add-on which can be used to accept input from forms or run some sort of other functionality defined in the add-on.
+Actions in ExpressionEngine are URL endpoints that are reached with the `ACT` query parameter. An example of this might be `http://myamazingsite.com/?ACT=43` where 43 is the ID given to an action registered in the `exp_actions` database table. These actions are tied to methods in an add-on which can be used to accept input from forms or run some sort of other functionality defined in the add-on.
NOTE:Before adding an action to your add-on, you need to already have an add-on in place. See [Building An Add-On: Getting Started](development/addon-development-overview.md#getting-started) for how to generate the starter files for your add-on.
@@ -37,7 +37,7 @@ amazing_add_on
┗...
```
-We also notice that a migration is created in our `database/migrations` folder. This migration is ran when your add-on is installed or uninstalled to tell ExpressionEngine what actions we needed added or removed with our add-on.
+We also notice that a migration is created in our `database/migrations` folder. This migration is ran when your add-on is installed or uninstalled to tell ExpressionEngine what actions we needed added or removed with our add-on.
```
//database/migrations/[timestamp]_[mirgrationname].php
@@ -45,7 +45,7 @@ We also notice that a migration is created in our `database/migrations` folder.
use ExpressionEngine\Service\Migration\Migration;
-class CreateactionamazingaztionforaddonamazingAddOn extends Migration
+class CreateactionamazingactionforaddonamazingAddOn extends Migration
{
/**
* Execute the migration
@@ -55,7 +55,7 @@ class CreateactionamazingaztionforaddonamazingAddOn extends Migration
{
ee('Model')->make('Action', [
'class' => 'Amazing_add_on',
- 'method' => 'AmazingAztion',
+ 'method' => 'AmazingAction',
'csrf_exempt' => false,
])->save();
}
@@ -68,7 +68,7 @@ class CreateactionamazingaztionforaddonamazingAddOn extends Migration
{
ee('Model')->get('Action')
->filter('class', 'Amazing_add_on')
- ->filter('method', 'AmazingAztion')
+ ->filter('method', 'AmazingAction')
->delete();
}
}
@@ -150,9 +150,9 @@ The `exp_actions` table is comprised of 4 columns:
WARN:**Security Alert:**Setting your action to CSRF Exempt, also makes this endpoint less secure though as you are allowing outside connections to your application.
-For security reasons, actions are protected by [Cross Site Request Forgery(CSRF)](/development/guidelines/security.md#cross-site-request-forgery). If you want users to be able to reach this endpoint from outside your site (e.g. using cURL to from another domain or application to reach this endpoint and expect data to be returned ) then you will most likely need to make your action CSRF exempt.
+For security reasons, actions are protected by [Cross Site Request Forgery(CSRF)](/development/guidelines/security.md#cross-site-request-forgery). If you want users to be able to reach this endpoint from outside your site (e.g. using cURL to from another domain or application to reach this endpoint and expect data to be returned ) then you will most likely need to make your action CSRF exempt.
-- To make your action immediately CSRF exempt, update the `csrf_exempt` value in the `exp_actions` table to be a value of `1`.
+- To make your action immediately CSRF exempt, update the `csrf_exempt` value in the `exp_actions` table to be a value of `1`.
- To ensure your action is CSRF exempt for future installations, update the corresponding migration by setting the `csrf_exempt` property to `true`:
```
...
@@ -160,13 +160,13 @@ public function up()
{
ee('Model')->make('Action', [
'class' => 'Amazing_add_on',
- 'method' => 'AmazingAztion',
+ 'method' => 'AmazingAction',
'csrf_exempt' => true,
])->save();
}
...
```
-- To set an action as CSRF exempt on creation, use the `--csrf_exempt` or `-c` flag in the CLI:
+- To set an action as CSRF exempt on creation, use the `--csrf_exempt` or `-c` flag in the CLI:
```
$ php system/ee/eecli.php make:action --csrf_exempt
@@ -176,10 +176,10 @@ $ php system/ee/eecli.php make:action --csrf_exempt
## Do Something - Build An Action
-Let's do something with our action to demonstrate how this would work.
+Let's do something with our action to demonstrate how this would work.
### Form Data
-In this example we want to insert a row into our database when a user submits a form.
+In this example we want to insert a row into our database when a user submits a form.
For this example we'll use a really basic form that would be found in our template which uses our action's endpoint as the action for the form. We know our action's ID from the `exp_actions` table and we're just going to collect the user's first name and last name. We'll then take that information and store it in our database. For the purpose of this example, we'll insert this into a custom table we've added to ExpressionEngine which just has columns `ID`, `first_name`, `last_name`.
@@ -191,7 +191,7 @@ What is the action name? ExampleAction
What add-on is the action being added to? [amazing_add_on,...]: amazing_add_on
```
-This creates our required files.
+This creates our required files.
Now we had some functionality to our action which will add the first and last name submitted from a form to our custom database table.
@@ -220,7 +220,7 @@ class ExampleAction extends AbstractRoute
ee()->db->insert('our_amazing_table', $data);
return true;
-
+
}
}
```
@@ -319,7 +319,7 @@ The response:
...
```
-This is because of the [`csrf_exempt` value](#cross-site-request-forgerycsrf-exemption) mentioned above. To fix this we can go into the `exp_actions` table of our database and update the `csrf_exempt` column to `1`.
+This is because of the [`csrf_exempt` value](#cross-site-request-forgerycsrf-exemption) mentioned above. To fix this we can go into the `exp_actions` table of our database and update the `csrf_exempt` column to `1`.
Now when I send that same request, I simply get the entry title I requested:
diff --git a/docs/development/addon-development-overview.md b/docs/development/addon-development-overview.md
index b79f3d16b..b2dfcb8d0 100644
--- a/docs/development/addon-development-overview.md
+++ b/docs/development/addon-development-overview.md
@@ -11,12 +11,12 @@
With custom add-ons you can add new fieldtypes, features, template tags, and much more to ExpressionEngine. Here we are going to look at different parts of an add-on, and how to define just what our add-on is going to do.
-TIP: In this section, we're explaining the parts of an add-on. No need to memorize everything though, the [CLI](/cli/intro.html) will generate all the pieces we need based on what functions we want our add-on to have.
+TIP: In this section, we're explaining the parts of an add-on. No need to memorize everything though, the [CLI](cli/intro.html) will generate all the pieces we need based on what functions we want our add-on to have.
[TOC]
## Why Create A Custom Add-On
-While ExpressionEngine offers a lot of functionality right out of the box, sometimes you want more power or to do things that ExpressionEngine doesn't natively do.
+While ExpressionEngine offers a lot of functionality right out of the box, sometimes you want more power or to do things that ExpressionEngine doesn't natively do.
Here are some ideas of what you can accomplish with a custom add-on:
@@ -25,16 +25,16 @@ Here are some ideas of what you can accomplish with a custom add-on:
- Add custom [fieldtypes](development/fieldtypes/fieldtypes.md) for content editors when creating channel entries.
- Add custom [CLI commands](cli/creating-a-command.md) like `$ eecli.php amazing_add_on:do_something_amazing`
- Add custom [Publish Form tabs](development/tab-files.md) to help organize entry fields for content editors.
-- Hook into ExpressionEngine and run [custom functions (called Extensions)](development/extensions.md) when ExpressionEngine does certain actions, like emailing your team whenever a post is created or manipulating text when a template is rendered.
+- Hook into ExpressionEngine and run [custom functions (called Extensions)](development/extensions.md) when ExpressionEngine does certain actions, like emailing your team whenever a post is created or manipulating text when a template is rendered.
- Display information from your add-on to content editors on the front-end by adding a [Prolet](/development/prolets.md) to the [ExpressionEngine Dock](/advanced-usage/front-end/dock.md).
- Display information in the [Control Panel Dashboard](/control-panel/dashboard_management.md) using a [custom Dashboard Widget](/development/widgets.md).
-These are just a few ideas of what you can do with custom add-ons. The possibilities are almost endless.
+These are just a few ideas of what you can do with custom add-ons. The possibilities are almost endless.
## Getting Started
-Getting started making an add-on is incredibly easy with the CLI. To begin making an add-on, simply use the `make:addon` command from the [CLI](/cli/intro.html).
+Getting started making an add-on is incredibly easy with the CLI. To begin making an add-on, simply use the `make:addon` command from the [CLI](cli/intro.html).
-TIP: If you are working with an existing add-on, we recommend you start with [Modernizing add-ons](development/modernizing-existing-add-ons.md)
+TIP: If you are working with an existing add-on, we recommend you start with [Modernizing add-ons](development/modernizing-existing-add-ons.md)
```
$ php system/ee/eecli.php make:addon
@@ -61,7 +61,7 @@ amazing_add_on/
┗ upd.amazing_add_on.php
```
-At this point, your add-on can't really do anything other than be installed. However, from here, you can add more functionality to your add-on via the CLI depending on your needs.
+At this point, your add-on can't really do anything other than be installed. However, from here, you can add more functionality to your add-on via the CLI depending on your needs.
Here's a list of functionality that can be added to your add-on and the corresponding CLI command if applicable:
@@ -85,7 +85,7 @@ Below is the complete structure of an add-on that we'll call "Amazing Add-on". T
```
amazing_add_on
┣ Commands
- ┃ ┗ CommandAnAmazingCommand.php
+ ┃ ┗ CommandAnAmazingCommand.php
┣ database
┃ ┣ migrations
┃ ┃ ┗ 2022_11_14_170449_amazing_migration.php
@@ -128,84 +128,84 @@ NOTE: **Note:** Pay attention to how these filenames are structured. For filenam
### The Add-on Setup File (`addon.setup.php`)
-Starting with version 3.0 each add-on in ExpressionEngine must have an `addon.setup.php` file in its package directory. This file provides descriptive data about a specific add-on, such as author, name, and version.
+Starting with version 3.0 each add-on in ExpressionEngine must have an `addon.setup.php` file in its package directory. This file provides descriptive data about a specific add-on, such as author, name, and version.
Reference [The Add-on Setup File](development/addon-setup-php-file.md) for more information on the contents of this file.
### The Update File (`upd.[addon_name].php`)
-**class `Add_on_name_upd extends Installer`**
-The Update file for an add-on includes a class with a name that is a combination of the add-on's name with a `_upd` suffix. Here you define functionality that should be executed on installation, update, and uninstallation of your add-on.
+**class `Add_on_name_upd extends Installer`**
+The Update file for an add-on includes a class with a name that is a combination of the add-on's name with a `_upd` suffix. Here you define functionality that should be executed on installation, update, and uninstallation of your add-on.
Reference [The Add-on Update File](development/add-on-update-file.md) for more information on this file.
### The Extension File (`ext.[addon_name].php`)
-**class `Add_on_name_upd extends Extension`**
-The extension file is used to route ExpressionEngine to our `Extensions` Folder.
+**class `Add_on_name_upd extends Extension`**
+The extension file is used to route ExpressionEngine to our `Extensions` Folder.
Reference [Extending The Core](development/extensions.md) for more information on how to use core hooks to extend what ExpressionEngine can do.
### The Fieldtype File (`ft.[addon_name].php`)
-**class `Add_on_name_ft extends EE_Fieldtype`**
-The fieldtype file is used to create new [fieldtypes](/fieldtypes/overview.md) in ExpressionEngine when your add-on is installed.
+**class `Add_on_name_ft extends EE_Fieldtype`**
+The fieldtype file is used to create new [fieldtypes](/fieldtypes/overview.md) in ExpressionEngine when your add-on is installed.
Reference [Adding Fieldtypes](development/fieldtypes/fieldtypes.md) for more information on adding fieldtypes with your add-on.
### The Mcp File (`mcp.[addon_name].php`)
-**class `Add_on_name_upd extends Mcp`**
-The Mcp file is used to route ExpressionEngine to our `ControlPanel` Folder, which contains logic for your Control Panel pages (settings or other pages you might want to add to the Control Panel for your users to interact with).
+**class `Add_on_name_upd extends Mcp`**
+The Mcp file is used to route ExpressionEngine to our `ControlPanel` Folder, which contains logic for your Control Panel pages (settings or other pages you might want to add to the Control Panel for your users to interact with).
Reference [Adding Control Panel Pages](development/modules.md) for more information on adding Control Panel pages with your add-on.
### The Module File `mod.[addon_name].php`
-**class `Add_on_name_upd extends Module`**
-The module file is used to route ExpressionEngine to our `Modules` Folder, which contains any actions or template tags you are adding with your add-on.
+**class `Add_on_name_upd extends Module`**
+The module file is used to route ExpressionEngine to our `Modules` Folder, which contains any actions or template tags you are adding with your add-on.
Reference [Adding Template Tags](development/custom-template-tags.md) for more information on adding template tags with your add-on or [Adding Actions](development/actions.md) for more information on creating URL endpoints (actions) with your add-on.
### The Tab File (`tab.[addon_name].php`)
-**class `Module_name_tab`**
-The tab file is used to create tabs that are visible in [Publish Layouts](control-panel/channels.md#publish-layouts). Respectively, these tabs would also be visible on the Entry Publish/Edit page if selected in the publish layout.
+**class `Module_name_tab`**
+The tab file is used to create tabs that are visible in [Publish Layouts](control-panel/channels.md#publish-layouts). Respectively, these tabs would also be visible on the Entry Publish/Edit page if selected in the publish layout.
Reference [Adding Publish Form Tabs](development/tab-files.md) for more information on adding Publish Form Tabs with your add-on.
### The Prolet File `pro.[addon_name].php`
-**class `Add_on_name_upd extends AbstractProlet implements ProletInterface`**
-The Prolet file is used to create new [Prolets](/development/prolets.md) with our add-on.
+**class `Add_on_name_upd extends AbstractProlet implements ProletInterface`**
+The Prolet file is used to create new [Prolets](/development/prolets.md) with our add-on.
Reference [Adding Prolets](development/prolets.md) for more information on adding prolets to your add-on.
### The Add-on Icon File `icon.svg`
The add-on icon folder is used both in the Add-on Manager and in the Dock on the front-end to distinguish your add-on from others.
### Extensions - `/Extensions`
-When we tell the CLI that we want to create an extension, classes are automatically created in the `Extensions` folder along with the above mentioned `ext.[addon_name].php` file. Interacting with hooks allows us to extend ExpressionEngine's functionality, thus we refer to these as "extensions".
+When we tell the CLI that we want to create an extension, classes are automatically created in the `Extensions` folder along with the above mentioned `ext.[addon_name].php` file. Interacting with hooks allows us to extend ExpressionEngine's functionality, thus we refer to these as "extensions".
TIP: Reference the [Extensions](development/extensions.md) section of the docs for more information on using extensions in your add-on.
### Actions - `/Actions`
-The `/Actions` folder stores all the business logic for any actions that we are adding to ExpressionEngine with our add-on. Each action will have a separate file and corresponding class created based on information provided in the `$actions` array in the `upd` file.
+The `/Actions` folder stores all the business logic for any actions that we are adding to ExpressionEngine with our add-on. Each action will have a separate file and corresponding class created based on information provided in the `$actions` array in the `upd` file.
Reference [Adding Actions](development/actions.md) for more information on creating URL endpoints (actions) with your add-on.
### Control Panel Routes - `/ControlPanel`
-The `ControlPanel` folder contains all the Control Panel routes and we create for our add-on as well as our sidebar.
+The `ControlPanel` folder contains all the Control Panel routes and we create for our add-on as well as our sidebar.
Reference [Adding Control Panel Pages](development/modules.md) for more information on adding Control Panel routes and pages with your add-on.
### `/Tags`
-The `/Tags` folder stores all the business logic for any template tags we create with our add-on.
+The `/Tags` folder stores all the business logic for any template tags we create with our add-on.
Reference [Adding Template Tags](development/custom-template-tags.md) for more information on adding template tags with your add-on.
### `/views`
The `views` folder contains all of our Control Panel views which will be used to render our add-on's control panel pages.
### `/language`
-The `language` folder contains all of our language files that will be used to display text on a page in whatever language is selected in the user’s account settings.
+The `language` folder contains all of our language files that will be used to display text on a page in whatever language is selected in the user’s account settings.
Reference [Using Language Files](development/add-on-language-files.md) for more information on using language files with your add-on.
### `/database/migrations`
The `/database/migrations` folder holds all migrations that will be ran on installation or updating of our add-on. Using the CLI, migrations can also be ran independently.
### `Model`
-The `Model` folder holds all models that we are creating with our add-on.
+The `Model` folder holds all models that we are creating with our add-on.
Reference [Building Your Own Models](/development/services/model/building-your-own.md) for more information on creating your own models with your add-on.
### `widgets`
The `widgets` folder holds all dashboard widgets we create with our add-on.
Reference [Developing Dashboard Widgets](development/widgets.md) for more information on creating widgets with your add-on.
-## Setting Default CLI Config Values
+## Setting Default CLI Config Values
When creating an add-on via the CLI you will be asked for author and the author's URL. If you'd like to skip these questions when creating an add-on, you can set default values in your [config](/general/system-configuration-overrides.md#main-configuration-file) file like so:
@@ -217,8 +217,8 @@ $config['cli_default_addon_author_url'] = 'https://expressionengine.com';
```
## A Word About Legacy Add-On Development
-In the past, add-ons were often categorized based on their functionality. We identified our add-on to ExpressionEngine as a fieldtype, extension, module, or plug-in. Thus there was never a straightforward process on structuring one add-on that contained all these categories in one.
+In the past, add-ons were often categorized based on their functionality. We identified our add-on to ExpressionEngine as a fieldtype, extension, module, or plug-in. Thus there was never a straightforward process on structuring one add-on that contained all these categories in one.
-With the release of 6.4.x and 7.2.x this paradigm has been updated to reflect the idea that we are just creating add-ons, and those add-ons can have multiple types of functionality. The CLI has also been updated to make creating add-ons and adding functionality incredibly easy. We have also updated the docs to reflect the ideal workflow of creating an add-on.
+With the release of 6.4.x and 7.2.x this paradigm has been updated to reflect the idea that we are just creating add-ons, and those add-ons can have multiple types of functionality. The CLI has also been updated to make creating add-ons and adding functionality incredibly easy. We have also updated the docs to reflect the ideal workflow of creating an add-on.
-While the latest changes shift our view of add-ons and how developers will create add-ons, you may still come across add-ons using the old methodology. We have left much of the old methods and structure in place in the core so that older add-ons will continue to work. However, we are choosing to not actively update the documentation for the old methods because we feel it's no longer in the best interest of the community to develop add-ons in this way. If you need to access how the docs once were regarding add-ons, you can reference the [legacy docs in GitHub](https://github.com/ExpressionEngine/ExpressionEngine-User-Guide/releases/tag/legacy-add-on-structure) (note that v7 and v6 were the same in these regards).
+While the latest changes shift our view of add-ons and how developers will create add-ons, you may still come across add-ons using the old methodology. We have left much of the old methods and structure in place in the core so that older add-ons will continue to work. However, we are choosing to not actively update the documentation for the old methods because we feel it's no longer in the best interest of the community to develop add-ons in this way. If you need to access how the docs once were regarding add-ons, you can reference the [legacy docs in GitHub](https://github.com/ExpressionEngine/ExpressionEngine-User-Guide/releases/tag/legacy-add-on-structure) (note that v7 and v6 were the same in these regards).
diff --git a/docs/development/addon-setup-php-file.md b/docs/development/addon-setup-php-file.md
index 3f3268051..d0258eda3 100755
--- a/docs/development/addon-setup-php-file.md
+++ b/docs/development/addon-setup-php-file.md
@@ -224,7 +224,7 @@ NOTE: **Note:** Cookie settings are only applicable for users running Expression
If your add-on sets any custom cookies, you can provide default settings for each those.
-In the above example, `forum_theme` is the cookie name, `description` sets default description for cookie to string referenced by `forum_theme_desc` key in add-on's language file and `lifetime_changeable` indicates that cookie's liefime cannot be changed by site administrator.
+In the above example, `forum_theme` is the cookie name, `description` sets default description for cookie to string referenced by `forum_theme_desc` key in add-on's language file and `lifetime_changeable` indicates that cookie's lifetime cannot be changed by site administrator.
| Type | Purpose |
| --------------------- | ---------------------- |
diff --git a/docs/development/cypress-tests.md b/docs/development/cypress-tests.md
index 0ea804d21..0862d5b52 100644
--- a/docs/development/cypress-tests.md
+++ b/docs/development/cypress-tests.md
@@ -44,7 +44,7 @@ You will need to set up environment file that will hold important information th
This command will open the Cypress UI that lists all tests that exist for ExpressionEngine in `tests/cypress/cypress/integration` folder and can be run individually. Clicking on the test file name will run the test using selected browser.
5. `npx cypress run --headed --no-exit -s cypress/integration/cp/login.ee6.js`
-This command will run particular test file as specified by `-s` parameter. You can also specicy wildcart `*` in place of file name to run all tests in folder. Note that as of current Cypress version that EE is using the test files cannot be placed above `tests/cypress` directory in directories tree.
+This command will run particular test file as specified by `-s` parameter. You can also specify a wildcard `*` in place of the file name to run all tests in a folder. Note that as of the current Cypress version that EE is using the test files cannot be placed above `tests/cypress` directory in directories tree.
## Cypress commands and tasks for EE
@@ -134,7 +134,7 @@ However if you have more than one test, it's better to have them organized into
})
})
-The typical test would try to emulate user performing certain actions and then check the result against what is expected.
+The typical test would try to emulate user performing certain actions and then check the result against what is expected.
It is recommended to keep the tests granular, so if one of the tests fails and the other ones pass you know exactly where to look. However for complex test cases sometimes the procedure needs to be written as one large test; in such case, it is good practice to perform intermediate checks during the test run.
diff --git a/docs/development/extension-hooks/cp/myaccount.md b/docs/development/extension-hooks/cp/myaccount.md
index fa79e8820..1729f3d8b 100755
--- a/docs/development/extension-hooks/cp/myaccount.md
+++ b/docs/development/extension-hooks/cp/myaccount.md
@@ -37,7 +37,7 @@ How it's called:
$this->extensions->call('myaccount_nav_setup')
);
-Your hook should return an associative array with the key matching one of the keys above that match the My Account sections. The value should be another associative array with the key being the text you want in the navgation and the value being another associative array with `extension` and `method` being the keys and their values being the respective extension's name and the method being a method that exists in the method's control panel.
+Your hook should return an associative array with the key matching one of the keys above that match the My Account sections. The value should be another associative array with the key being the text you want in the navigation and the value being another associative array with `extension` and `method` being the keys and their values being the respective extension's name and the method being a method that exists in the method's control panel.
Additionally, you should check `extensions->last_call` to avoid overwriting previous changes to the My Account navigation and be sure to use `array_merge_recursive` when merging the previous extension results:
diff --git a/docs/development/extension-hooks/extension-hooks-overview.md b/docs/development/extension-hooks/extension-hooks-overview.md
index 7bac8c885..44e962ccb 100644
--- a/docs/development/extension-hooks/extension-hooks-overview.md
+++ b/docs/development/extension-hooks/extension-hooks-overview.md
@@ -65,7 +65,7 @@ Core hooks are categorized into 5 categories:
- [Role Model](development/extension-hooks/model/role.md)
- [Site Model](development/extension-hooks/model/site.md)
- [Snippet Model](development/extension-hooks/model/template-snippet.md)
- - [SpecialityTemplate Model](development/extension-hooks/model/template-specialty-template.md)
+ - [SpecialtyTemplate Model](development/extension-hooks/model/template-specialty-template.md)
- [Status Model](development/extension-hooks/model/status.md)
- [TemplateGroup Model](development/extension-hooks/model/template-group.md)
- [TemplateRoute Model](development/extension-hooks/model/template-route.md)
diff --git a/docs/development/extensions.md b/docs/development/extensions.md
index 8a363a7e7..917cf2eff 100755
--- a/docs/development/extensions.md
+++ b/docs/development/extensions.md
@@ -12,7 +12,7 @@ lang: php
-->
# Extensions and Hooks
-TIP: If you are working with an existing add-on, we recommend you start with [Modernizing add-ons](development/modernizing-existing-add-ons.md)
+TIP: If you are working with an existing add-on, we recommend you start with [Modernizing add-ons](development/modernizing-existing-add-ons.md)
[TOC]
@@ -40,7 +40,7 @@ NOTE: If you are using the command above to add an extension to an existing add-
TIP: Files that interact with ExpressionEngine core hooks are referred to as "extensions" because they extend the functionality of ExpressionEngine.
-This will create an `ext.[addon_name].php` file in our add-on along with an `Extensions` folder where we will build out the code we want to run when we interact with a core hook.
+This will create an `ext.[addon_name].php` file in our add-on along with an `Extensions` folder where we will build out the code we want to run when we interact with a core hook.
Inside our `Extensions` folder the CLI will create a file with the same name as the core hook we plan to use.
@@ -59,7 +59,7 @@ TIP: Extensions need to be enabled to work. When you create an extension, a migr
## Anatomy Of An Extension
Once we've added the ability to hook into the core with our add-on, an `Extensions` folder is created. The CLI will generate a class and a respective file for each core hook we wish to use.
-Here we have added the ability to interact with the [`typography_parse_type_end()`](/development/extension-hooks/global/typography.html#typography_parse_type_endstr-this-prefs) hook.
+Here we have added the ability to interact with the [`typography_parse_type_end()`](/development/extension-hooks/global/typography.md#typography_parse_type_endstr-this-prefs) hook.
So our add-on structure now looks like this:
@@ -95,7 +95,7 @@ class TypographyParseTypeEnd extends AbstractRoute
As we can see, the CLI has correctly created a new class using our core hook in PascalCase as the name.
-Inside our class is the `process()` function. Again the CLI has already added all parameters that will be passed in from the core hook.
+Inside our class is the `process()` function. Again the CLI has already added all parameters that will be passed in from the core hook.
TIP:Reference the [Available Core Hooks](development/extension-hooks/extension-hooks-overview.md) section of the docs to read on what parameters your hook uses.
@@ -173,7 +173,7 @@ class TypographyParseTypeEnd extends AbstractRoute
```
-Now when we render our site using fields like textarea or other fields that use the Typography Library, our users will see how amazing EE is.
+Now when we render our site using fields like textarea or other fields that use the Typography Library, our users will see how amazing EE is.
NOTE:**NOTE:** Although ExpressionEngine is amazing, we do not suggest using the above example in production.
diff --git a/docs/development/fieldtypes/example.md b/docs/development/fieldtypes/example.md
index d2dea2c68..270b535aa 100644
--- a/docs/development/fieldtypes/example.md
+++ b/docs/development/fieldtypes/example.md
@@ -18,14 +18,14 @@ The snippets below were truncated for clarity. The full example fieldtype can be
[TOC]
## Generate Fieldtype File
-Start by generating a custom fieldtype for your add-on using the `make:fieldtype` command.
+Start by generating a custom fieldtype for your add-on using the `make:fieldtype` command.
```
$ php system/ee/eecli.php make:fieldtype
Let's implement a fieldtype!
What is the fieldtype name? Amazing Fieldtype
What add-on is the fieldtype being added to? [amazing_add_on]: amazing_add_on
-Building fieldype.
+Building fieldtype.
Fieldtype created successfully!
```
diff --git a/docs/development/fieldtypes/fieldtypes.md b/docs/development/fieldtypes/fieldtypes.md
index 51f4367bc..819a9036f 100644
--- a/docs/development/fieldtypes/fieldtypes.md
+++ b/docs/development/fieldtypes/fieldtypes.md
@@ -16,7 +16,7 @@ lang: php
[TOC]
## Overview
-ExpressionEngine ships with a range of fieldtypes already in place. However, perhaps you want to had your fieldtype that executes functionality differently than the fields that ship with ExpressionEngine. If so, then read below for how to create your own custom fieldtype.
+ExpressionEngine ships with a range of fieldtypes already in place. However, perhaps you want to had your fieldtype that executes functionality differently than the fields that ship with ExpressionEngine. If so, then read below for how to create your own custom fieldtype.
TIP: For an overview of what a Fieldtype is, read the [Fieldtype Overview docs](/fieldtypes/overview.md).
@@ -24,7 +24,7 @@ NOTE:Before adding a fieldtype to your add-on, you need to already have an add-o
## Creating An Amazing Fieldtype
-Adding a custom fieldtype to your add-on is easy with the `make:fieldtype` command.
+Adding a custom fieldtype to your add-on is easy with the `make:fieldtype` command.
```
$ php system/ee/eecli.php make:fieldtype
@@ -221,7 +221,7 @@ Display the field data as column in the Entry Manager
#### `EE_Fieldtype::getTableColumnConfig()`
-Sets [table column configuration](development/services/table.html#setting-the-columns) for Entry Manager
+Sets [table column configuration](development/services/table.md#setting-the-columns) for Entry Manager
Returns `Array`
diff --git a/docs/development/legacy/helpers/html-helper.md b/docs/development/legacy/helpers/html-helper.md
index 1e80dd186..30471e2ca 100755
--- a/docs/development/legacy/helpers/html-helper.md
+++ b/docs/development/legacy/helpers/html-helper.md
@@ -204,7 +204,7 @@ The above code will produce this:
'my_value' => [|Array|| -|disabled_choices|For checkboxes, indicates options that are not currently choosable with an array of field values whose checkboxes should be disabled, e.g. `['value', 'another']`|Array|NULL| +|disabled_choices|For checkboxes, indicates options that are not currently selectable with an array of field values whose checkboxes should be disabled, e.g. `['value', 'another']`|Array|NULL| |maxlength|Sets the maxlength= attribute on text inputs.|Boolean|FALSE| |placeholder| Sets the placeholder= attribute on text inputs.|String|NULL| no_results|For checkboxes, radio buttons and select fields, can be set to show a “no results” message and a call-to-action link button to create content that would populate options for the field.|Array|NULL| diff --git a/docs/development/tab-files.md b/docs/development/tab-files.md index 00a25e892..2e0711527 100644 --- a/docs/development/tab-files.md +++ b/docs/development/tab-files.md @@ -77,7 +77,7 @@ class Amazing_add_on_tab public function delete($entry_ids){ } - + // This function is needed to display data as an Entry Manager column public function renderTableCell($data, $field_id, $entry) @@ -227,6 +227,6 @@ Display the tab data as column in the Entry Manager #### `getTableColumnConfig()` -Sets [table column configuration](development/services/table.html#setting-the-columns) for Entry Manager +Sets [table column configuration](development/services/table.md#setting-the-columns) for Entry Manager Returns `Array` diff --git a/docs/fieldtypes/fluid.md b/docs/fieldtypes/fluid.md index 4eecf99cb..86a44089c 100755 --- a/docs/fieldtypes/fluid.md +++ b/docs/fieldtypes/fluid.md @@ -31,7 +31,7 @@ Select custom field groups to make them available to fluid field on the publish ### Add -Each fluid field has a list of buttons of available custom fields and custom field groups displayed below. Clicking on the button adds a field (or field group) to Fluid, maintaing all of the field's settings, instructions and requirements. +Each fluid field has a list of buttons of available custom fields and custom field groups displayed below. Clicking on the button adds a field (or field group) to Fluid, maintaining all of the field's settings, instructions and requirements. Also, each Fluid row has '+' button. Clicking on it shows a dropdown populated with the field names assigned to the fluid field. When you choose a field from the dropdown, it adds it to the page. @@ -61,7 +61,7 @@ For example, if you have a Fluid field `fluid_content` with a text field `fluid_ The prefixed tag pair is a looping tag pair. You can have more than one `fluid_text` field for the entry, it's entirely at the entry author's discretion. The author also determines the order of the field output. -Displaying field groups from within Fluid field is sligtly different, as it requires additions `{fields}` tag pair. +Displaying field groups from within Fluid field is slightly different, as it requires additions `{fields}` tag pair. So given that `blog` is the short name of custom field group and `fluid_header` and `fluid_text` are fields in that group, the template might look like: {fluid_content} diff --git a/docs/fieldtypes/relationships.md b/docs/fieldtypes/relationships.md index b677a35dc..a86e6a13e 100755 --- a/docs/fieldtypes/relationships.md +++ b/docs/fieldtypes/relationships.md @@ -80,7 +80,7 @@ The order of selected entries can be rearranged with drag&drop.  -NOTE: **Note:** The described Relationship UI is only available when using Control Panel or [Pro Front-end Content Management](advanced-usage/front-end/frontend). If you need to use this field in [Channel Form](channels/channel-form/fields.md#relationship-field) then HTML Select input will be used. +NOTE: **Note:** The described Relationship UI is only available when using Control Panel or [Pro Front-end Content Management](advanced-usage/front-end/frontend.md). If you need to use this field in [Channel Form](channels/channel-form/fields.md#relationship-field) then HTML Select input will be used. ## Template Tags @@ -107,7 +107,7 @@ The following parameters are available to all looping relationship tags, allowin Some relationship tags may have additional parameters available. These are included in the usage instructions below. -NOTE: **NOTE:** The [`disable`](fieldtypes/relationships.md#optimizing-relationships-rerformance) parameter should be applied to the containing `{exp:channel:entries}` call, not to the relationship tag itself. +NOTE: **NOTE:** The [`disable`](fieldtypes/relationships.md#optimizing-relationships-performance) parameter should be applied to the containing `{exp:channel:entries}` call, not to the relationship tag itself. ## Accessing Children diff --git a/docs/general/cookies.md b/docs/general/cookies.md index 62acf5822..24e245eb8 100644 --- a/docs/general/cookies.md +++ b/docs/general/cookies.md @@ -35,7 +35,7 @@ NOTE: **Note:** This should not be considered an exhaustive list of cookies that | cp_last_site_id | MSM cookie indicating the last site accessed in the Control Panel. | Session | Functionality | | viewtype | Indicates "thumb view" or "table view" for File Manager in Control Panel. | 360 days | Functionality | | ee_cp_viewmode | Indicates whether "navigation-less" mode should be used in Control Panel. | 360 days | Functionality | -| collapsed_nav | Indicates whether main sidebar navigation in Control Panel should be collapased. | 360 days | Functionality | +| collapsed_nav | Indicates whether main sidebar navigation in Control Panel should be collapsed. | 360 days | Functionality | NOTE: **Note:** If you need to define how long the user will stay logged in for, you can change the lifetime of the remember cookie by copying [`system/ee/ExpressionEngine/Config/remember.php`](https://github.com/ExpressionEngine/ExpressionEngine/blob/6.dev/system/ee/ExpressionEngine/Config/remember.php) to `/system/user/config/stopwords.php` and changing the value of the `remember_me_ttl` property in that file. diff --git a/docs/general/text-formatting.md b/docs/general/text-formatting.md index 47b760bf5..0f819c937 100755 --- a/docs/general/text-formatting.md +++ b/docs/general/text-formatting.md @@ -40,7 +40,7 @@ NOTE: **Note:** To use the Markdown option, the Markdown Add-on must be installe This Auto BR feature simply converts each line break into an HTML `
'label' => lang('my_label'),
'instructions' => lang('my_instructions')
]
diff --git a/docs/msm/overview.md b/docs/msm/overview.md index ccb009308..60e92fbe3 100755 --- a/docs/msm/overview.md +++ b/docs/msm/overview.md @@ -25,7 +25,7 @@ That's not a perfect analogy but it conveys the scope of what the Multiple Site The site manager must be enabled in Control Panel setting: `Settings > General Settings > Enable Site Manager?` in order to create sites. -Once MSM is enabled a new site can be created or editied by clicking the icon next to the site name in the top of the Control Panel sidebar and either selecting the site to edit or adding a new site. +Once MSM is enabled a new site can be created or edited by clicking the icon next to the site name in the top of the Control Panel sidebar and either selecting the site to edit or adding a new site.  @@ -88,7 +88,7 @@ Open domain2's new `admin.php` file (this is the file that allows Control Panel $assign_to_config['site_name'] = 'domain2_short_name'; $assign_to_config['cp_url'] = 'https://domain2.com/admin.php'; -TIP: **Tip:** In some multi-site situations, you may not want to allow Control Panel access from anyhere other than domain1. The `admin.php` file can be removed in those cases. +TIP: **Tip:** In some multi-site situations, you may not want to allow Control Panel access from anywhere other than domain1. The `admin.php` file can be removed in those cases. ### Step 4 @@ -119,4 +119,4 @@ However, cookies for one domain cannot be set from a different domain. If your s $config['multi_login_sites'] = "https://www.example.com/index.php|https://www.sitetwo.com/index.php"; -Now when a user logs into the frontend of one of the sites, the login routine will invisibly loop through each URL in the configuration, redirecting to that site, setting the appropriate cookies, and then cycling through to the next site. Once the user has been logged into all of the sites, they'll end up back on the starting URL. The login redirects will be virtually unnoticable. +Now when a user logs into the frontend of one of the sites, the login routine will invisibly loop through each URL in the configuration, redirecting to that site, setting the appropriate cookies, and then cycling through to the next site. Once the user has been logged into all of the sites, they'll end up back on the starting URL. The login redirects will be virtually unnoticeable. diff --git a/docs/optimization/caching.md b/docs/optimization/caching.md index 8e0f27d91..eebc48e21 100755 --- a/docs/optimization/caching.md +++ b/docs/optimization/caching.md @@ -122,7 +122,7 @@ Caches are cleared automatically when certain actions occur: - Updating an Email Notification (clears all caches) - Updating a Theme Template (clears all caches) - Running a Template Sync (clears all caches) -- Submission, updating or deleting of an Entry through API (clears if needed either all or sql cache). See [Clear cache for new ntries?](control-panel/settings/content-design.md#clear-cache-for-new-entries). +- Submission, updating or deleting of an Entry through API (clears if needed either all or sql cache). See [Clear cache for new entries?](control-panel/settings/content-design.md#clear-cache-for-new-entries). - Comment Module: - Creating, updating or deleting a Comment (clears all caches) - Change Comment Status (clears all caches) diff --git a/docs/templates/globals/consent.md b/docs/templates/globals/consent.md index d10f78395..facf74ab7 100755 --- a/docs/templates/globals/consent.md +++ b/docs/templates/globals/consent.md @@ -71,7 +71,7 @@ User-created Consent requests, that you as the site builder create, are referenc ### Checking if the User has Responded -All of the above variables act like a boolean—`TRUE` if the user has given consent and `FALSE` if they've not given consent, or have denied or withdrawn it. But what about folks who haven't responded yet? You can use the `has_reponded:` prefix with any consent variable. For example, you could ask for consent for using a cool widget, but only if they've not responded. If they told you no, you don't want to keep asking. +All of the above variables act like a boolean—`TRUE` if the user has given consent and `FALSE` if they've not given consent, or have denied or withdrawn it. But what about folks who haven't responded yet? You can use the `has_responded:` prefix with any consent variable. For example, you could ask for consent for using a cool widget, but only if they've not responded. If they told you no, you don't want to keep asking. has_responded: :