Merge branch '7.dev' into nep-patch-captcha

Author: nep

README.md

@@ -32,7 +32,12 @@ To build the theme assets, run `npm run buildAssets`. You can also dynamically r
 
 ### Viewing local changes
 
-Manually load `/build/index.html` in your browser to view your local build. For example, `file:///Users/<username>/Documents/ExpressionEngine-User-Guide/build/index.html`. You can use the side navigation to navigate to different local files, but the search functionality always takes you to the live version at docs.expressionengine.com.
+There are 2 options for viewing your local changes.
+
+1. Run `npx http-server -o` which should make the site available at [http://127.0.0.1:8080/build/](http://127.0.0.1:8080/build/).
+2. Manually view any HTML file in `/build/` in your browser. For example, `file:///Users/<username>/Documents/ExpressionEngine-User-Guide/build/index.html` to view the home page.
+
+You can use the side navigation to navigate to different local files, but the search functionality takes you to the live version at [https://docs.expressionengine.com](https://docs.expressionengine.com) unless you follow the steps at [Using DocSearch Locally](#using-docsearch-locally).
 
 ## Using DocSearch Locally
 

docs/_images/cp_comments.png

@@ -97,7 +97,7 @@ The Template_Group/Template where you would like the search results to be shown.
 
     results="20"
 
-The number of results to show per page on the search results.
+The number of results to show per page. The maximum value of `results` is 255. This means one page of results can't have more than 255 items, though you can have more than 255 results once you paginate the results.
 
 ### `search_in=`
 

docs/_images/overview.png

@@ -8,7 +8,7 @@
 -->
 # ENV File Support
 
-Config files can also be configured using [PHP Environment variables ($_ENV)](https://www.php.net/manual/en/reserved.variables.environment.php). To utilize this, create a file named `.env.php` in the root of your ExpressionEngine install. 
+Config files can also be configured using [PHP Environment variables ($_ENV)](https://www.php.net/manual/en/reserved.variables.environment.php). To utilize this, create a file named `.env.php` in the root of your ExpressionEngine install.
 
 NOTE: The `.env.php` file must be placed in same directory as the `system` directory. If you move the `system` directory above the webroot you must also move `.env.php`.
 
@@ -31,19 +31,20 @@ This variable can now be used in your `/system/user/config.php` as illustrated b
 Here is an example of what it might look like to manage all your database connection settings, and Base URL in `.env.php`
 
 ```
-// .env.php
-
-// URLs
+#.env.php
+#URLs
 BASE_URL=http://mysite.test/
 
-// DATABASE SETTINGS
+#DATABASE SETTINGS
 DB_HOSTNAME=db
 DB_DATABASE=db
 DB_USERNAME=db
 DB_PASSWORD=db
 DB_PORT=3306
 ```
 
+NOTE: You must use `#` for comments within `.env.php`. Using `//` will result in your `.env.php` being unable to be read.
+
 ```
 // system/user/config.php
 <?php  if ( ! defined('BASEPATH')) exit('No direct script access allowed');
@@ -53,7 +54,7 @@ $config['save_tmpl_files'] = 'y';
 $config['base_url'] = $_ENV['BASE_URL'];
 $config['site_url'] = $config['base_url'];
 
-$config['app_version'] = '7.2.0';
+$config['app_version'] = '7.5.8';
 $config['encryption_key'] = 'bb748b72de235352315122d00';
 $config['session_crypt_key'] = '985796e4444444563463e2c80242';
 
@@ -83,15 +84,15 @@ The site short name can be accessed in the code using `$GLOBALS['assign_to_confi
 The below example demonstrates this approach, assuming you have 2 MSM sites with short names of `default_site` and `second_site`
 
 ```
-// .env.php
-// SITE-SPECIFIC SETTINGS
+#.env.php
+#SITE-SPECIFIC SETTINGS
 default_site.BASE_PATH=/home/sites/mysite.test/
 default_site.BASE_URL=http://mysite.test/
 
 second_site.BASE_PATH=/home/sites/anothersite.test/
 second_site.BASE_URL=http://anothersite.test/
 
-// DATABASE SETTINGS
+#DATABASE SETTINGS
 DB_HOSTNAME=db
 DB_DATABASE=db
 DB_USERNAME=db
@@ -110,7 +111,7 @@ $config['base_url'] = $_ENV[$GLOBALS['assign_to_config']['site_name'] . '.' . 'B
 
 $config['site_url'] = $config['base_url'];
 
-$config['app_version'] = '7.2.0';
+$config['app_version'] = '7.5.8';
 $config['encryption_key'] = 'bb748b72de235352315122d00';
 $config['session_crypt_key'] = '985796e4444444563463e2c80242';
 

docs/add-ons/search/simple.md

@@ -46,13 +46,12 @@ The Channel Form tag will automatically load jQuery for you. If you prefer to in
 
 ### Allowing Guests to Post Entries
 
-Allowing guest posts is controlled in the Channel Form settings at `Developer --> Channels` in the channel's **Settings** tab.
+Allowing guest posts is controlled in the Channel Form settings in `Channels` in the channel's **Settings** tab.
 
-To allow guests to post in a certain channel, locate the options for "Allow Guest Posts" next to the channel you want to allow guest posts for, and choose "Yes".
+You can optionally choose an author that entries entered as guests appear as authored by in the Guest Author field.
 
-You can optionally require the guest to pass a captcha before they submit the Channel Form by choosing "Yes" under "Guest Captcha".
+Requirements regarding use of a captcha for guest posting are controlled in `Settings --> CAPTCHA`.
 
-Finally, you can optionally choose an author that entries entered as guests appear as authored by under Guest Author.
 
 ### Form Validation
 

docs/advanced-usage/env-support.md

@@ -789,6 +789,10 @@ If five entries are being displayed per page, then for the fourth entry on the s
 
 **BONUS:** Since the Search module utilizes channel variables, {absolute_count} is also available to the Search Results tag.
 
+### `{absolute_index}`
+
+Similar to `absolute_count` but starts at 0 instead of 1. So the first entry will have value of "0" and the second entry will have a value of "1" etc.
+
 ### `{absolute_results}`
 
 This variable will always display the absolute total number of results that are returned by the tag, regardless of pagination.
@@ -963,6 +967,10 @@ The date the entry was submitted in GMT. This variable is **not** localized for
 
 The date on which the entry was last edited in GMT. This variable is **not** localized for each user's date settings. See [Date Variable Formatting](templates/date-variable-formatting.md) for more information.
 
+### `{index}`
+
+Similar to `count` but starts at 0 instead of 1. So the first entry will have value of "0" and the second entry will have a value of "1" etc.
+
 ### `{ip_address}`
 
 The IP address of the author when they posted the entry.

docs/channels/channel-form/overview.md

@@ -0,0 +1,7 @@
+# `sync:upload-directory`
+
+This command updates old file format data to the modern format and synchronizes the file usage records in the database. File usage data for a given file in the file manager can be viewed in the [File Editor](control-panel/file-manager/file-edit.md). This functionality is also available through [Utilities - File Usage](control-panel/utilities/data-operations.md#update-file-usage-information).
+
+## Example:
+
+`php eecli.php sync:file-usage`

docs/channels/entries.md

@@ -29,6 +29,7 @@ By default the CLI is located `system/ee/eecli.php` .
         - [migrate:rollback - Rolls back most recent migration group](cli/built-in-commands/migrate.md)
     - Sync
         - [sync:conditional-fields - Sync channel entry conditional logic](cli/built-in-commands/sync-conditional-fields.md)
+        - [sync:file-usage - Sync files usage](cli/built-in-commands/sync-file-usage.md)		
         - [sync:reindex - Sync content used in search indexes](cli/built-in-commands/sync-reindex.md)
         - [sync:upload-directory - Sync files in an upload directory](cli/built-in-commands/sync-upload-directory.md)
     - [Update ExpressionEngine](cli/built-in-commands/update.md)

docs/cli/built-in-commands/sync-file-usage.md

@@ -13,7 +13,7 @@ In addition to `config.php` ExpressionEngine has a number of other configuration
 
 As a general rule, the values provided in those config files (located in `system/ee/ExpressionEngine/Config` folder) are good for most sites, however there might be cases where certain setup would need to override some of the values.
 
-In order to do that, simply copy the corresponding file to `system/user/config` folder and change or add the values that are needed. There is no need to keep the full copy of config file, just keep the properties that need to be changed and remove the ones that you are fine with - the default values will be used for those.
+In order to do that, simply copy the corresponding file to `system/user/config` folder and change or add the values that are needed. 
 
 [TOC=4]
 
@@ -33,15 +33,20 @@ This file contains an array of foreign characters for transliteration conversion
 
 `valid_form_attributes.php`
 
-A list of HTML attributes that are allowed to be passed via EE template tag parameters to the `form` tag when creating forms with `ee()->functions->form_declaration()`. Additionally, attributes prefixed with `data-` and `aria-` can be used.
+A list of HTML attributes that are allowed to be passed via EE template tag parameters to the `form` tag when creating forms with `ee()->functions->form_declaration()`. Additionally, attributes prefixed with `data-` and `aria-` can be used without being specified in the config settings.
 
 #### Allowed Mime Types
 
 `mimes.php`
 
-These are the mime types that are allowed to be uploaded using the upload class. For security reasons the list is kept as small as possible.  If you need to upload types that are not in the list you can add them.
+This file sets the mime types that are allowed to be uploaded using the upload class. For security reasons the list is kept as small as possible.  The `mimes.php` file in your `system/user/config` folder will override the system `mimes.php` entirely.  If you need to upload mime types that are not in the list you can add them. If you want to disallow a mime type that is allowed by default, you can remove it from your mimes.php file and it will be disallowed.  
 
-The mime types are grouped by file type. You can add the allowed mime types directly or you can add new file types containing multiple mimes.
+The mime types are grouped by file type. These file types make up the 'Allowed File Types' options in the [upload directory](control-panel/file-manager/upload-directories.md#allowed-file-types) settings. You can add new mimes to an existing file type or create a new file type and add to that. Your new file type will be included as an option in the file upload preferrence file types.
+
+Tip: Customizing Allowed File Types in ExpressionEngine
+<div class="video-wrapper">
+<iframe src="https://www.youtube.com/embed/W6-NEmd7Urk" width="1920" height="1080" title="Customizing Allowed File Types in ExpressionEngine" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
+</div>
 
 #### Reverse Proxy IP addresses
 

docs/cli/intro.md

@@ -11,22 +11,27 @@
 
 **Control Panel Location: `Home`**
 
-The overview page is shown when a member has logged into the control panel, or has clicked the Home icon next to the name of the site in the top navigation bar. The overview page provides a quick glance at site statistics, and provides convenient links to relevant action items. Here's an overview of all the sections that can be visible based on member permissions on the overview page.
+The Overview page is the first screen a member sees upon logging into the control panel or clicking the "Overview" link in the navigation. It provides a quick snapshot of key site information and convenient links to relevant actions. Below is a breakdown of the sections that may appear based on member permissions.
 
 ![](_images/overview.png)
 
-## Comments
+## Release Notes
 
-If you have comments enabled, this box will appear on the overview page to show you how many new comments have been left since your last visit to the control panel, as well as let you know if any comments are awaiting your moderation. You then have the option to review and/or approve those new comments.
+This section appears after each update until dismissed. It highlights new features and improvements introduced in the latest version of ExpressionEngine. A Release Notes link is also included, directing users to the full changelog for detailed information on recent updates.
 
-## Channels
+## Recent Entries
 
-If a member has access to Channels, they will see a Channels box with quick access a channels listing, as well as a link to existing field groups. An action button will let them create a new Channel.
+For members with Channel access, this section displays the seven most recently created entries, providing quick access to editing or viewing them. A View All link leads to the [Entry Manager](/control-panel/entry-manager.md) or managing all entries.
 
 ## Members
 
-The members section gives a glance at the total number of members and banned members, along with links to manage them. An action button will allow members with proper permissions to create a new member.
+This section shows the most recent member logins, along with links to manage user accounts. A View All link directs users to the [Member Management](/control-panel/member-manager.md)) section for full member administration.
+
+## ExpressionEngine Support
 
-## Content
+A quick-access box linking to official ExpressionEngine support, ensuring help is always within reach.
+
+## Comments
 
-The content section provides quick statistics on Channel entries with links to a list of the sites entries available to manage. The action button in the upper right will allow members to jump to the publish form of a particular Channel to create a new entry.
+![](_images/cp_comments.png)
+If comments are enabled, this section displays the number of new comments since the user's last visit, as well as any pending moderation tasks. Users can quickly review and approve comments directly from this section.

docs/config/config-files.md

@@ -9,6 +9,8 @@
 
 # Add-on Update File
 
+[TOC]
+
 ## Overview
 
 The `upd.[addon_name].php` file (commonly just called the `upd` file) is critical to ExpressionEngine knowing what to do with your add-on. Here we tell ExpressionEngine what actions to register, core hooks we want to use, database tables to update, and much more. We need to tell ExpressionEngine what to do when we install an add-on, update an add-on, and uninstall and add-on. Thankfully the CLI takes care of most of this for us.
@@ -63,8 +65,8 @@ class Amazing_add_on_upd extends Installer
 The first thing you will notice in our `Amazing_add_on_upd` class is a list of properties that describe some specifics of our add-on to ExpressionEngine. There are two required properties to declare here:
 
 ```
-    public $has_cp_backend = 'y'; // Shows the option to see addon’s settings.
-    public $has_publish_fields = 'n'; // Whether module provides tab for entry edit page
+public $has_cp_backend = 'y'; // Shows the option to see addon’s settings.
+public $has_publish_fields = 'n'; // Whether module provides tab for entry edit page
 ```
 
 ## Install Your Add-On (`install()`)
@@ -77,23 +79,25 @@ The CLI automatically generates our install method. This method will ensure that
 
 
 ```
-   public function install()
-    {
-        parent::install();
+public function install()
+{
+    parent::install();
 
-        // create a database table
-        // notify mission control
-        // add publish tabs
+    // create a database table
+    // notify mission control
+    // add publish tabs
 
-        return true;
-    }
+    return true;
+}
 ```
 
 ### Adding Publish Tabs
 Optionally add the publish page tab fields to any saved publish layouts. This is ONLY used if the module adds a tab to the publish page and it requires the [`tabs()` function](#add-publish-tabs-with-your-add-on-tabs):
 
-      ee()->load->library('layout');
-      ee()->layout->add_layout_tabs($this->tabs(), 'module_name');
+```
+ee()->load->library('layout');
+ee()->layout->add_layout_tabs($this->tabs(), 'module_name');
+```
 
 
 ## Add Publish Tabs With Your Add-on (`tabs()`)
@@ -104,25 +108,27 @@ Optionally add the publish page tab fields to any saved publish layouts. This is
 
 An optional function included only if your add-on adds a tab to the publish page. This function should return a multidimensional associative array: the top array key consisting of the tab name, followed by any field names, with each field having a variety of default settings. Note that when the fields are added to the publish page, they are namespaced to prevent variable collisions:
 
-    function tabs()
-    {
-        $tabs['tab_name'] = array(
-            'field_name_one'=> array(
-                'visible'   => 'true',
-                'collapse'  => 'false',
-                'htmlbuttons'   => 'true',
-                'width'     => '100%'
-                ),
-            'field_name_two'=> array(
-                'visible'   => 'true',
-                'collapse'  => 'false',
-                'htmlbuttons'   => 'true',
-                'width'     => '100%'
-                ),
-            );
-
-        return $tabs;
-    }
+```
+function tabs()
+{
+    $tabs['tab_name'] = array(
+        'field_name_one'=> array(
+            'visible'   => 'true',
+            'collapse'  => 'false',
+            'htmlbuttons'   => 'true',
+            'width'     => '100%'
+            ),
+        'field_name_two'=> array(
+            'visible'   => 'true',
+            'collapse'  => 'false',
+            'htmlbuttons'   => 'true',
+            'width'     => '100%'
+            ),
+        );
+
+    return $tabs;
+}
+```
 
 Be sure that you also update your [`install()` function](#adding-publish-tabs) to add your specified tabs.
 
@@ -138,22 +144,24 @@ The `update` method will run code when a user installs an update to our add-on.
 | \$current | `string`  | The last recorded version of the module in the `exp_modules` table |
 | Returns   | `Boolean` | `FALSE` if no update is needed, `TRUE` otherwise
 
-    public function update($current = '')
-    {
-        // Runs migrations
-        parent::update($current);
+```
+public function update($current = '')
+{
+    // Runs migrations
+    parent::update($current);
 
-        // only run the update if the user is currently running a version less than 2.0
-        if (version_compare($current, '2.0', '<'))
-        {
-            // Do your update code here
-            // update database
-            // notify mission control of the update
-        }
+    // only run the update if the user is currently running a version less than 2.0
+    if (version_compare($current, '2.0', '<'))
+    {
+        // Do your update code here
+        // update database
+        // notify mission control of the update
+    }
 
 
-        return true;
-    }
+    return true;
+}
+```
 
 ## Uninstall Your Add-On (`uninstall()`)
 The CLI automatically generates our uninstall method. This method will ensure that all extensions and actions declared above will be properly uninstalled. Similarly to installation, if you just need to ensure your actions and extensions are uninstalled, you can leave this method as is. However, you added custom functionality in the `install()` method, then you need to also ensure you clean up after yourself here.
@@ -162,19 +170,23 @@ The CLI automatically generates our uninstall method. This method will ensure th
 | --------- | --------- | ------------------------------------------------------------ |
 | Returns   | `Boolean` | `TRUE` if everything uninstalled properly, `FALSE` otherwise |
 
-    public function uninstall()
-    {
-        parent::uninstall();
+```
+public function uninstall()
+{
+    parent::uninstall();
 
-        // remove my database tables
-        // remove any publish tabs
-        // turn off the lights
+    // remove my database tables
+    // remove any publish tabs
+    // turn off the lights
 
-        return true;
-    }
+    return true;
+}
+```
 
 ### Removing Tabs
 Optionally delete any publish page tab fields saved in publish layouts. This is ONLY used if the module adds a tab to the publish page and it requires the `tabs()` function:
 
-      ee()->load->library('layout');
-      ee()->layout->delete_layout_tabs($this->tabs(), 'module_name');
+```
+ee()->load->library('layout');
+ee()->layout->delete_layout_tabs($this->tabs(), 'module_name');
+```