docs: fix format

user_guide_src/source/changelogs/v4.0.0-alpha.1.rst

@@ -5,25 +5,31 @@ Release Date: September 28, 2018
 
 **Rewrite of the CodeIgniter framework**
 
-New packages list:
-    - API 
+.. contents::
+    :local:
+    :depth: 2
+
+New Packages List
+-----------------
+
+    - API
         - \\ ResponseTrait
-    - Autoloader 
+    - Autoloader
         - \\ AutoLoader, FileLocator
-    - CLI 
+    - CLI
         - \\ BaseCommand, CLI, CommandRunner, Console
-    - Cache 
+    - Cache
         - \\ CacheFactory, CacheInterface
         - \\ Handlers ... Dummy, File, Memcached, Predis, Redis, Wincache
-    - Commands 
+    - Commands
         - \\ Help, ListCommands
         - \\ Database \\ CreateMigration, MigrateCurrent, MigrateLatest, MigrateRefresh,
           MigrateRollback, MigrateStatus, MigrateVersion, Seed
         - \\ Server \\ Serve
         - \\ Sessions \\ CreateMigration
         - \\ Utilities \\ Namespaces, Routes
-    - Config 
-        -   \\ AutoloadConfig, BaseConfig, BaseService, Config, DotEnv, ForeignCharacters, 
+    - Config
+        -   \\ AutoloadConfig, BaseConfig, BaseService, Config, DotEnv, ForeignCharacters,
             Routes, Services, View
     - Database
         -   \\ BaseBuilder, BaseConnection, BasePreparedQuery, BaseResult, BaseUtils, Config,
@@ -42,7 +48,7 @@ New packages list:
     - Files
         - \\ File
     - Filters
-        - \\ FilterInterface, Filters  
+        - \\ FilterInterface, Filters
     - Format
         - \\ FormatterInterface, JSONFormatter, XMLFormatter
     - HTTP
@@ -50,10 +56,10 @@ New packages list:
             IncomingRequest, Message, Negotiate, Request, RequestInterface,
             Response, ResponseInterface, URI, UserAgent
         -   \\ Files \\ FileCollection, UploadedFile, UploadedFileInterface
-    - Helpers 
+    - Helpers
         -   ... array, cookie, date, filesystem, form, html, inflector, number,
             security, text, url
-    - Honeypot 
+    - Honeypot
         - \\ Honeypot
     - I18n
         - \\ Time, TimeDifference
@@ -67,14 +73,14 @@ New packages list:
         - \\ Handlers ...  Base, ChromeLogger, File, HandlerInterface
     - Pager
         - \\ Pager, PagerInterface, PagerRenderer
-    - Router 
+    - Router
         - \\ RouteCollection, RouteCollectionInterface, Router, RouterInterface
-    - Security 
+    - Security
         - \\ Security
     - Session
         - \\ Session, SessionInterface
         - \\ Handlers ... Base, File, Memcached, Redis
-    - Test 
+    - Test
         - \\ CIDatabaseTestCase, CIUnitTestCase, FeatureResponse, FeatureTestCase, ReflectionHelper
         - \\ Filters \\ CITestStreamFilter
     - ThirdParty (bundled)

user_guide_src/source/changelogs/v4.0.0-alpha.2.rst

@@ -5,6 +5,13 @@ Release Date: Oct 26, 2018
 
 **Second alpha release of CodeIgniter4**
 
+.. contents::
+    :local:
+    :depth: 2
+
+Changed Files
+-------------
+
 The list of changed files follows, with PR numbers shown.
 
 application /
@@ -144,8 +151,8 @@ user_guide_src /source/
 /
     - spark #1305
 
-PRs merged:
------------
+PRs merged
+----------
 
 - #1361 Add timing assertion to CIUnitTestCase
 - #1312 Add headerEmitted assertions to CIUnitTestCase

user_guide_src/source/changelogs/v4.0.0-alpha.3.rst

@@ -5,6 +5,13 @@ Release Date: November 30, 2018
 
 **Next alpha release of CodeIgniter4**
 
+.. contents::
+    :local:
+    :depth: 2
+
+Changed Files
+-------------
+
 The list of changed files follows, with PR numbers shown.
 
 - admin/
@@ -242,8 +249,8 @@ The list of changed files follows, with PR numbers shown.
     - spark 2047b5a
     - .travis.yml #1394
 
-PRs merged:
------------
+PRs merged
+----------
 
 - #1554 Serviceinstances
 - #1553 Admin/scripts

user_guide_src/source/changelogs/v4.0.0-alpha.4.rst

@@ -5,13 +5,21 @@ Release Date: Dec 15, 2018
 
 **Next alpha release of CodeIgniter4**
 
-Highlights:
+.. contents::
+    :local:
+    :depth: 2
+
+Highlights
+----------
 
 - Refactor for consistency: folder application renamed to app;
     constant BASEPATH renamed to SYSTEMPATH
 - Debug toolbar gets its own config, history collector
 - Numerous corrections and enhancements
 
+Changed Files
+-------------
+
 The list of changed files follows, with PR numbers shown.
 
 - admin/
@@ -171,8 +179,8 @@ The list of changed files follows, with PR numbers shown.
 - spark #1579
 - Vagrantfile.dist #1459
 
-PRs merged:
------------
+PRs merged
+----------
 
 - #1610 Test, fix & enhance Language
 - #a0fc68 Clear binds after inserts, updates, and find queries

user_guide_src/source/changelogs/v4.0.0-alpha.5.rst

@@ -5,7 +5,12 @@ Release Date: Jan 30, 2019
 
 **Next alpha release of CodeIgniter4**
 
-Highlights:
+.. contents::
+    :local:
+    :depth: 2
+
+Highlights
+----------
 
 - added $maxQueries setting to app/Config/Toolbar.php
 - updated PHP dependency to 7.2
@@ -18,6 +23,9 @@ Highlights:
 
 We hope this will be the last alpha, and that the next pre-release will be our first beta ... fingers crossed!
 
+Changed Files
+-------------
+
 The list of changed files follows, with PR numbers shown.
 
 - admin/
@@ -200,8 +208,8 @@ The list of changed files follows, with PR numbers shown.
 - spark #1648
 - .travis.yml #1649, #1670
 
-PRs merged:
------------
+PRs merged
+----------
 
 - #1693 Docs/tutorial
 - #5951c3 Allow domain/sub-domain routes to overwrite existing routes

user_guide_src/source/changelogs/v4.0.0-beta.1.rst

@@ -3,7 +3,12 @@ Version 4.0.0-beta.1
 
 Release Date: Mar 1, 2019
 
-Highlights:
+.. contents::
+    :local:
+    :depth: 2
+
+Highlights
+----------
 
 - New View Layouts provide simple way to create site site view templates.
 - Fixed user guide CSS for proper wide table display
@@ -11,18 +16,23 @@ Highlights:
 - Numerous database, migration & model bugs fixed
 - Refactored unit testing for appstarter & framework distributions
 
-New messages:
+New Messages
+------------
 
 - Database.tableNotFound
 - HTTP.uploadErr...
 
-App changes:
+App Changes
+-----------
 
 - app/Config/Cache has new setting: database
 - app/Views/welcome_message has logo tinted
 - composer.json has a case correction
 - env adds CI_ENVIRONMENT suggestion
 
+Changed Files
+-------------
+
 The list of changed files follows, with PR numbers shown.
 
 - app/
@@ -134,8 +144,8 @@ The list of changed files follows, with PR numbers shown.
 - composer.json #1755
 - .env #1749
 
-PRs merged:
------------
+PRs merged
+----------
 
 - #1774 Housekeeping for beta.1
 - #1768 Helper changes - signatures & typos

user_guide_src/source/changelogs/v4.0.0-beta.2.rst

@@ -3,7 +3,12 @@ Version 4.0.0-beta.2
 
 Release Date: April 4, 2019
 
-Highlights:
+.. contents::
+    :local:
+    :depth: 2
+
+Highlights
+----------
 
 - A number of fixes & improvements, importantly for the Model and testing classes
 - Models now require a primary key
@@ -11,17 +16,22 @@ Highlights:
 - Validation rules have been enhanced
 - .htaccess beefed up
 
-New messages:
+New messages
+------------
 
 - Database.noPrimaryKey, forFindColumnHaveMultipleColumns, Database.forEmptyInputGiven
 
-App changes:
+App Changes
+-----------
 
 - updated app/Config/Events
 - added app/Controllers/BaseController
 - added tests/ folder for unit testing
 - added phpunit.xml.dist for unit testing configuration
 
+Changed Files
+-------------
+
 The list of changed files follows, with PR numbers shown.
 
 - .htaccess #1900
@@ -187,8 +197,8 @@ The list of changed files follows, with PR numbers shown.
     - testing/
         - controllers #1848
 
-PRs merged:
------------
+PRs merged
+----------
 
 - #1913 More RouteCollection tests for overwriting. Closes #1692
 - #1912 Additional RouteCollectionTests

user_guide_src/source/changelogs/v4.0.0-beta.3.rst

@@ -3,22 +3,32 @@ Version 4.0.0-beta.3
 
 Release Date: May 7, 2019
 
-Highlights:
+.. contents::
+    :local:
+    :depth: 2
+
+Highlights
+----------
 
 - Type hinting added throughout & typos corrected (see API docs)
 - Fixed a number of model, database, validation & debug toolbar issues
 
-New messages:
+New Messages
+------------
 
 - Database.FieldNotExists
 - Validation.equals, not_equals
 
-App changes:
+App Changes
+-----------
 
 - Removed $salt config item in app/Config/App
 - Enabled migrations by default in app/Config/Migrations
 - Simplified public/.htaccess
 
+Changed Files
+-------------
+
 The list of changed files follows, with PR numbers shown.
 
 - admin/
@@ -136,8 +146,8 @@ The list of changed files follows, with PR numbers shown.
 - composer.json #1935
 - phpdoc.dist.xml #1987
 
-PRs merged:
------------
+PRs merged
+----------
 
 - #1987 Correct API docblock problems for phpdocs
 - #1986 Update docblock version to 4.0.0

user_guide_src/source/changelogs/v4.0.0-beta.4.rst

@@ -3,7 +3,12 @@ Version 4.0.0-beta.4
 
 Release Date: Jul 25, 2019
 
-Highlights:
+.. contents::
+    :local:
+    :depth: 2
+
+Highlights
+----------
 
 There are some breaking changes...
 
@@ -11,16 +16,22 @@ There are some breaking changes...
 - The Model class changing has been updated to better handle soft deletes
 - The routing has been beefed up
 
-New messages:
+New Messages
+------------
 
 - new translation key: Database/noDateFormat
 
-App changes:
+App Changes
+-----------
 
-Testing changes:
+Testing Changes
+---------------
 
 - enhanced database & migration testing in tests/_support
 
+Changed Files
+-------------
+
 The list of changed files follows, with PR numbers shown.
 
 - admin/
@@ -151,8 +162,8 @@ The list of changed files follows, with PR numbers shown.
     - testing/
         - database #2051, #2053
 
-PRs merged:
------------
+PRs merged
+----------
 
 - #2104 File & UploadFile Fixes
 - #2091 Timezone select

user_guide_src/source/changelogs/v4.0.0-rc.1.rst

@@ -5,7 +5,12 @@ Release Date: Sep 3, 2019
 
 **RC.1 release of CodeIgniter4**
 
-Enhancements:
+.. contents::
+    :local:
+    :depth: 2
+
+Enhancements
+------------
 
 - CI3 Email ported to CI4
 - Encryption (basic) added
@@ -16,18 +21,23 @@ Enhancements:
 - RESTful controllers added to shorten dev time for RESTful APIs
 - added RouteCollection::presenter() as part of the RESTful support
 
-App changes:
+App Changes
+-----------
 
 - added app/Common to make it easier to override common functions
 - Config/Email and Encryption added
 - Config/Migration modified, and has different settings
 - Controllers/Home fixed, removing unnecessary model reference
 
-Message changes:
+Message Changes
+---------------
 
 - Migration has new & modified messages
 - Messages now has RESTful set
 
+Changed Files
+-------------
+
 The list of changed files follows, with PR numbers shown.
 
 - admin/
@@ -188,8 +198,8 @@ The list of changed files follows, with PR numbers shown.
 - README.md #2010
 - spark
 
-PRs merged:
------------
+PRs merged
+----------
 
 - #2178 Add fallback for missing finfo_open
 - #2177 Fix missing form close tag

user_guide_src/source/changelogs/v4.0.0-rc.2.rst

@@ -5,21 +5,31 @@ Release Date: Sept 27, 2019
 
 **RC.2 release of CodeIgniter4**
 
-Enhancements:
+.. contents::
+    :local:
+    :depth: 2
+
+Enhancements
+------------
 
 - query builder testability simplified with new property, but dropped
     method parameters (breaking change)
 - database, migrations and sessions beefed up
 - numerous smaller bugs corrected
 
-App changes:
+App Changes
+-----------
 
 - Config/Constants, Paths & some config settings have had changes
 
-Message changes:
+Message Changes
+---------------
 
 - N/A
 
+Changed Files
+-------------
+
 The list of changed files follows, with PR numbers shown.
 
 - admin/
@@ -162,8 +172,8 @@ The list of changed files follows, with PR numbers shown.
         - news_section #2221
         - static_pages #2221
 
-PRs merged:
---------------------------
+PRs merged
+----------
 
 - #2271 fix ResourcePresenter::setModel()
 - #2270 groupStart() refactorization

user_guide_src/source/changelogs/v4.0.0-rc.3.rst

@@ -5,16 +5,26 @@ Release Date: Oct 19, 2019
 
 **RC.3 release of CodeIgniter4**
 
-Enhancements:
+.. contents::
+    :local:
+    :depth: 2
+
+Enhancements
+------------
 
 - Beefed up database, session & routing handling.
 - Fixed numerous bugs & user guide errata.
 
-App changes:
+App Changes
+-----------
 
 - New $CSRFHeaderName property in App/Config/App
 
-Message changes:
+Message Changes
+---------------
+
+Changed Files
+-------------
 
 The list of changed files follows, with PR numbers shown.
 
@@ -120,8 +130,8 @@ The list of changed files follows, with PR numbers shown.
     - outgoing/
         - table #2337
 
-PRs merged:
------------
+PRs merged
+----------
 
 - #2348 CodeIgniter Foundation gets copyright
 - #2346 Fix FilerHandlerTest.php wierdness

user_guide_src/source/changelogs/v4.0.0-rc.4.rst

@@ -5,15 +5,21 @@ Release Date: February 6, 2020
 
 **RC.4 release of CodeIgniter4**
 
-Enhancements:
+.. contents::
+    :local:
+    :depth: 2
+
+Enhancements
+------------
 
 - Fixed url systems so that it would work when system is served out of subfolders.
 - Added required insert ignore support for sqlite3 and mysql.
 - Add validation function `is_not_unique`
 - Various improvements and cleanup to the Email class
 
-PRs merged:
------------
+PRs merged
+----------
+
 - #2527 Update manual.rst
 - #2454 Page in the official documentation on ajax requests with iSAJAX() fixes
 - #2525 Remove incorrect inline doc type

user_guide_src/source/changelogs/v4.0.0.rst

@@ -5,7 +5,12 @@ Release Date: February 24, 2020
 
 **4.0 release of CodeIgniter4**
 
-Enhancements:
+.. contents::
+    :local:
+    :depth: 2
+
+Enhancements
+------------
 
 - Updated welcome view file
 - Debug Toolbar now supports dark mode
@@ -17,7 +22,8 @@ Enhancements:
 - New :php:func:`model()` helper method for easy singleton Models.
 - Tests completely reorganized to make app-level tests simpler out of the box.
 
-Repo changes:
+Repo Changes
+------------
 
 The devstarter repo has been deprecated.
 

user_guide_src/source/changelogs/v4.0.3.rst

@@ -5,11 +5,16 @@ Release Date: May 1, 2020
 
 **4.0.3 release of CodeIgniter4**
 
+.. contents::
+    :local:
+    :depth: 2
+
 Thanks to the community, there have been 74 bugs closed, 21 issues closed, and 88 merged pull requests. These are all
 listed in the `changelog <https://github.com/codeigniter4/CodeIgniter4/blob/develop/CHANGELOG.md/>`_. This is a small
 representation of some of the bigger changes you should know about.
 
-Enhancements:
+Enhancements
+------------
 
 - The API Response Trait now only determines the final formatting (json/xml) through content negotiation when the controller's ``$format`` variable is ``null``. If it contains either ``json`` or ``xml``, then that format will always be returned.
 - Pagination now can actually create next page and previous page links, instead of next/previous groups of links.
@@ -19,7 +24,8 @@ Enhancements:
 - add ability to replace {locale} to request->getLocale() in form_open('action')
 - tables generated by CLI commands can now be colored.
 
-Bugs Fixed:
+Bugs Fixed
+----------
 
 - Deleting through the Model on a table with string primary key now works.
 - Default pagination templates fixed to use the correct locale.

user_guide_src/source/changelogs/v4.0.4.rst

@@ -5,7 +5,12 @@ Release Date: July 15, 2020
 
 **4.0.4 release of CodeIgniter4**
 
-Enhancements:
+.. contents::
+    :local:
+    :depth: 2
+
+Enhancements
+------------
 
 - The location for the SQLite3 database has changed and by default will be now located in a ``writable`` folder instead of the ``public`` folder.
 - New CLI command: ``cache:clear`` that will destroy all data within the current cache engine.
@@ -31,7 +36,8 @@ Enhancements:
 - Cookies and headers can be copied from the global Response object when doing a redirect using the new ``withCookies()`` and ``withHeaders()`` methods.
 - Support for special prefix "hex2bin:" which can be used with ``$key`` parameter in :doc:`Encryption class</libraries/encryption>` or in .env file.
 
-Bugs Fixed:
+Bugs Fixed
+----------
 
 - Fixed location for the SQLite3 database which by default will be now located in a ``writable`` folder instead of the ``public`` folder.
 - Fixed bug where ``force_https`` could add ``https://`` a second time.

user_guide_src/source/changelogs/v4.0.5.rst

@@ -5,7 +5,12 @@ Release Date: January 31, 2021
 
 **4.0.5 release of CodeIgniter4**
 
-Enhancements:
+.. contents::
+    :local:
+    :depth: 2
+
+Enhancements
+------------
 
 - New URL helper function ``url_to()`` which creates absolute URLs based on controllers.
 - New Model option: ``$useAutoIncrement`` which when set to ``false`` allows you to provide your own primary key for each record in the table. Handy when we want to implement 1:1 relation or use UUIDs for our model.
@@ -16,17 +21,20 @@ Enhancements:
 - The getter functions for file extensions of uploaded files now have different fallback values (``$this->getClientExtension()`` for ``UploadedFile->getExtension()`` and ``''`` for ``UploadedFile->guessExtension()``). This is a security fix and makes the process less dependent on the client.
 - The Cache ``FileHandler`` now allows setting the file permissions mode via ``Config\Cache``
 
-Changes:
+Changes
+-------
 
 - System messages defined in ``system/Language/en/`` are now strictly for internal framework use and are not covered by backwards compatibility (BC) promise. Users may use these messages in their applications but at their own risks.
 
-Bugs Fixed:
+Bugs Fixed
+----------
 
 - Fixed a bug in ``Entity`` class where declaring class parameters was preventing data propagation to the ``attributes`` array.
 - Handling for the environment variable ``encryption.key`` has changed. Previously, explicit function calls, like ``getenv('encryption.key')`` or ``env('encryption.key')`` where the value has the special prefix ``hex2bin:`` returns an automatically converted binary string. This is now changed to just return the character string with the prefix. This change was due to incompatibility with handling binary strings in environment variables on Windows platforms. However, accessing ``$key`` using ``Encryption`` class config remains unchanged and still returns a binary string.
 - ``Config\Services`` (in **app/Config/Services.php**) now extends ``CodeIgniter\Config\BaseService`` to allow proper discovery of third-party services.
 
-Deprecations:
+Deprecations
+------------
 
 - Deprecated ``BaseCommand::getPad`` in favor of ``BaseCommand::setPad``.
 - Deprecated ``CodeIgniter\Controller::loadHelpers`` in favor of ``helper`` function.

user_guide_src/source/changelogs/v4.1.1.rst

@@ -5,7 +5,12 @@ Release Date: February 1, 2021
 
 **4.1.1 release of CodeIgniter4**
 
-Bugs Fixed:
+.. contents::
+    :local:
+    :depth: 2
+
+Bugs Fixed
+----------
 
 - Fixed an issue where ``.gitattributes`` was preventing framework downloads.
 

user_guide_src/source/changelogs/v4.1.2.rst

@@ -5,14 +5,20 @@ Release Date: May 16, 2021
 
 **4.1.2 release of CodeIgniter4**
 
-BREAKING:
+.. contents::
+    :local:
+    :depth: 2
+
+BREAKING
+--------
 
 Fixed `a bug <https://github.com/codeigniter4/CodeIgniter4/issues/4116>`_ in ``current_url()`` that prevented
 configurations with an ``indexPage`` from including that value in the return value. Any installations
 using ``App::$indexPage`` should expect altered values from ``current_url()`` and all its dependencies
 (including Response Testing, Pager, Form Helper, Pager, and View Parser).
 
-Enhancements:
+Enhancements
+------------
 
 - New HTTP classes, ``Cookie`` and ``CookieStore``, for abstracting web cookies.
 - New ``assertRedirectTo()`` assertion available for HTTP tests.
@@ -21,7 +27,8 @@ Enhancements:
 - New option in routing. The ``priority`` option lower the priority of specific route processing.
 - The ``Autoloader`` class can now load files which do not contain PHP classes. The list of `non-class` files will be listed in the ``$files`` property of ``Config\Autoload`` class.
 
-Changes:
+Changes
+-------
 
 - Layouts in views now support nested sections.
 - ``Response::getCookie`` now returns a ``Cookie`` instance instead of an array of cookie attributes.
@@ -36,7 +43,8 @@ Changes:
 - The array helper ``_array_search_dot`` is now marked for ``@internal`` use. As this is used by ``dot_array_search``, users should not use ``_array_search_dot`` directly in their code.
 - ``CacheInterface::getMetaData()`` returns ``null`` for misses, or an array with at least the "expires" key set to the absolute epoch expiration, or ``null`` for "never expires". The File, Memcached, and Wincache Handlers still return ``false`` which will become ``null`` in a future release.
 
-Deprecations:
+Deprecations
+------------
 
 - Deprecated ``CodeIgniter\View\View::$currentSection`` property.
 - Language strings and exceptions on invalid cookie samesite are deprecated for the ``CookieException``'s own exception message.
@@ -53,7 +61,8 @@ Deprecations:
 - Deprecated ``IncomingRequest::removeRelativeDirectory()``, use ``URI::removeDotSegments()`` instead
 - Deprecated ``\API\ResponseTrait::failValidationError`` to use ``\API\ResponseTrait::failValidationErrors`` instead
 
-Bugs Fixed:
+Bugs Fixed
+----------
 
 *See the repo's **CHANGELOG.MD** for a complete list of bugs fixed.*
 

user_guide_src/source/changelogs/v4.1.3.rst

@@ -5,19 +5,26 @@ Release Date: June 6, 2021
 
 **4.1.3 release of CodeIgniter4**
 
-Enhancements:
+.. contents::
+    :local:
+    :depth: 2
+
+Enhancements
+------------
 
 - New functions in the File Helper: ``directory_mirror()`` and ``same_file()``
 - Implemented NexusPHP's ``Tachycardia`` for slow test identification
 - Added a new ``$ttl`` option to ``Cache`` config for future use
 
-Changes:
+Changes
+-------
 
 - Added MySQL 8.0 to the test matrix
 - Improved environment detection from ``$_SERVER``
 - Numerous sweeping code improvements via Rector and analysis
 
-Bugs Fixed:
+Bugs Fixed
+----------
 
 - Fixed a bug where ``CURLRequest`` would try to use a project URI instead of its base
 - Fixed a bug where CLI mode was not detected under ``cgi-fcgi``

user_guide_src/source/changelogs/v4.1.4.rst

@@ -5,10 +5,15 @@ Release Date: September 6, 2021
 
 **4.1.4 release of CodeIgniter4**
 
+.. contents::
+    :local:
+    :depth: 2
+
 This release focuses on code style. All changes (except those noted below) are cosmetic to bring the code in line with the new
 `CodeIgniter Coding Standard <https://github.com/CodeIgniter/coding-standard>`_ (based on PSR-12).
 
-Breaking Changes:
+Breaking Changes
+----------------
 
 - The following methods were changed from "public" to "protected" to match their parent class methods and better align with their uses: