Merge pull request #5213 from kenjis/fix-docs-app-config-decoration

lonnieezell · web-flow · commit b6c3ddb0c6dd · 2021-10-18T08:25:13.000-05:00
docs: unify the decoration of app/Config/*.php
diff --git a/user_guide_src/cilexer/pycilexer.egg-info/top_level.txt b/user_guide_src/cilexer/pycilexer.egg-info/top_level.txt
@@ -0,0 +1 @@
+cilexer
diff --git a/user_guide_src/source/concepts/structure.rst b/user_guide_src/source/concepts/structure.rst
@@ -84,6 +84,6 @@ Modifying Directory Locations
 -----------------------------
 
 If you've relocated any of the main directories, you can change the configuration
-settings inside ``app/Config/Paths``.
+settings inside **app/Config/Paths.php**.
 
 Please read `Managing your Applications <../general/managing_apps.html>`_
diff --git a/user_guide_src/source/general/logging.rst b/user_guide_src/source/general/logging.rst
@@ -38,7 +38,7 @@ Configuration
 =============
 
 You can modify which levels are actually logged, as well as assign different Loggers to handle different levels, within
-the ``/app/Config/Logger.php`` configuration file.
+the **app/Config/Logger.php** configuration file.
 
 The ``threshold`` value of the config file determines which levels are logged across your application. If any levels
 are requested to be logged by the application, but the threshold doesn't allow them to log currently, they will be
@@ -140,8 +140,8 @@ You can use any other logger that you might like as long as it extends from eith
 that you can easily drop in use for any PSR3-compatible logger, or create your own.
 
 You must ensure that the third-party logger can be found by the system, by adding it to either
-the ``/app/Config/Autoload.php`` configuration file, or through another autoloader,
-like Composer. Next, you should modify ``/app/Config/Services.php`` to point the ``logger``
+the **app/Config/Autoload.php** configuration file, or through another autoloader,
+like Composer. Next, you should modify **app/Config/Services.php** to point the ``logger``
 alias to your new class name.
 
 Now, any call that is done through the ``log_message()`` function will use your library instead.
diff --git a/user_guide_src/source/general/modules.rst b/user_guide_src/source/general/modules.rst
@@ -73,7 +73,7 @@ would be used.
 
 Another approach provided by CodeIgniter is to autoload these *non-class* files like how you would autoload
 your classes. All we need to do is provide the list of paths to those files and include them in the
-``$files`` property of your ``app/Config/Autoload.php`` file.
+``$files`` property of your **app/Config/Autoload.php** file.
 
 ::
 
diff --git a/user_guide_src/source/helpers/cookie_helper.rst b/user_guide_src/source/helpers/cookie_helper.rst
@@ -50,7 +50,7 @@ The following functions are available:
     detailed description of its use, as this function acts very
     similarly to ``IncomingRequest::getCookie()``, except it will also prepend
     the ``$cookiePrefix`` that you might've set in your
-    *app/Config/App.php* file.
+    **app/Config/App.php** file.
 
 .. php:function:: delete_cookie($name[, $domain = ''[, $path = '/'[, $prefix = '']]])
 
diff --git a/user_guide_src/source/helpers/text_helper.rst b/user_guide_src/source/helpers/text_helper.rst
@@ -257,7 +257,7 @@ The following functions are available:
         $string = convert_accented_characters($string);
 
     .. note:: This function uses a companion config file
-        `app/Config/ForeignCharacters.php` to define the to and
+        **app/Config/ForeignCharacters.php** to define the to and
         from array for transliteration.
 
 .. php:function:: word_censor($str, $censored[, $replacement = ''])
diff --git a/user_guide_src/source/incoming/controllers.rst b/user_guide_src/source/incoming/controllers.rst
@@ -288,7 +288,7 @@ one and place your controller classes within them.
 Each of your sub-directories may contain a default controller which will be
 called if the URL contains *only* the sub-directory. Simply put a controller
 in there that matches the name of your 'default_controller' as specified in
-your *app/Config/Routes.php* file.
+your **app/Config/Routes.php** file.
 
 CodeIgniter also permits you to remap your URIs using its :doc:`URI Routing <routing>` feature.
 
diff --git a/user_guide_src/source/incoming/filters.rst b/user_guide_src/source/incoming/filters.rst
@@ -88,7 +88,7 @@ the final output, or even to filter the final output with a bad words filter.
 Configuring Filters
 *******************
 
-Once you've created your filters, you need to configure when they get run. This is done in ``app/Config/Filters.php``.
+Once you've created your filters, you need to configure when they get run. This is done in **app/Config/Filters.php**.
 This file contains four properties that allow you to configure exactly when the filters run.
 
 $aliases
diff --git a/user_guide_src/source/incoming/routing.rst b/user_guide_src/source/incoming/routing.rst
@@ -238,7 +238,7 @@ run the filter before or after the controller. This is especially handy during a
         $routes->resource('users');
     });
 
-The value for the filter must match one of the aliases defined within ``app/Config/Filters.php``.
+The value for the filter must match one of the aliases defined within **app/Config/Filters.php**.
 
 It is possible to nest groups within groups for finer organization if you need it::
 
@@ -355,14 +355,14 @@ Applying Filters
 You can alter the behavior of specific routes by supplying filters to run before or after the controller. This is especially handy during authentication or api logging.
 The value for the filter can be a string or an array of strings:
 
-* matching the aliases defined in ``app/Config/Filters.php``.
+* matching the aliases defined in **app/Config/Filters.php**.
 * filter classnames
 
 See `Controller filters <filters.html>`_ for more information on setting up filters.
 
 **Alias filter**
 
-You specify an alias defined in ``app/Config/Filters.php`` for the filter value::
+You specify an alias defined in **app/Config/Filters.php** for the filter value::
 
     $routes->add('admin',' AdminController::index', ['filter' => 'admin-auth']);
 
@@ -477,7 +477,7 @@ Routes Configuration Options
 ============================
 
 The RoutesCollection class provides several options that affect all routes, and can be modified to meet your
-application's needs. These options are available at the top of `/app/Config/Routes.php`.
+application's needs. These options are available at the top of **app/Config/Routes.php**.
 
 Default Namespace
 -----------------
diff --git a/user_guide_src/source/installation/installing_composer.rst b/user_guide_src/source/installation/installing_composer.rst
@@ -140,7 +140,7 @@ Copy the ``env``, ``phpunit.xml.dist`` and ``spark`` files, from
 ``vendor/codeigniter4/framework`` to your project root
 
 You will have to adjust the system path to refer to the vendor one, e.g., ``ROOTPATH . '/vendor/codeigniter4/framework/system'``,
-- the ``$systemDirectory`` variable in ``app/Config/Paths.php``
+- the ``$systemDirectory`` variable in **app/Config/Paths.php**
 
 Upgrading
 ---------
diff --git a/user_guide_src/source/installation/troubleshooting.rst b/user_guide_src/source/installation/troubleshooting.rst
@@ -30,11 +30,11 @@ Only the default page loads
 If you find that no matter what you put in your URL only your default
 page is loading, it might be that your server does not support the
 REQUEST_URI variable needed to serve search-engine friendly URLs. As a
-first step, open your *app/Config/App.php* file and look for
+first step, open your **app/Config/App.php** file and look for
 the URI Protocol information. It will recommend that you try a couple of
 alternate settings. If it still doesn't work after you've tried this
 you'll need to force CodeIgniter to add a question mark to your URLs. To
-do this open your *app/Config/App.php* file and change this::
+do this open your **app/Config/App.php** file and change this::
 
     public $indexPage = 'index.php';
 
@@ -72,7 +72,7 @@ Don't forget to reset the environment to "production" once you fix the problem!
 CodeIgniter Error Logs
 ----------------------
 
-CodeIgniter logs error messages, according to the settings in `app/Config/Logger.php`.
+CodeIgniter logs error messages, according to the settings in **app/Config/Logger.php**.
 
 You can adjust the error threshold to see more or fewer messages.
 
diff --git a/user_guide_src/source/libraries/cookies.rst b/user_guide_src/source/libraries/cookies.rst
@@ -431,7 +431,7 @@ Cookie Personalization
 
 Sane defaults are already in place inside the ``Cookie`` class to ensure the smooth creation of cookie
 objects. However, you may wish to define your own settings by changing the following settings in the
-``Config\Cookie`` class in ``app/Config/Cookie.php`` file.
+``Config\Cookie`` class in **app/Config/Cookie.php** file.
 
 ==================== ===================================== ========= =====================================================
 Setting              Options/ Types                        Default   Description
diff --git a/user_guide_src/source/libraries/encryption.rst b/user_guide_src/source/libraries/encryption.rst
@@ -62,7 +62,7 @@ You don't need to worry about it.
 Configuring the Library
 =======================
 
-The example above uses the configuration settings found in ``app/Config/Encryption.php``.
+The example above uses the configuration settings found in **app/Config/Encryption.php**.
 
 ========== ====================================================
 Option     Possible values (default in parentheses)
@@ -108,10 +108,10 @@ you can use the Encryption library's ``createKey()`` method.
     $key = sodium_crypto_secretbox_keygen();
     $key = \CodeIgniter\Encryption\Encryption::createKey(SODIUM_CRYPTO_SECRETBOX_KEYBYTES);
 
-The key can be stored in ``app/Config/Encryption.php``, or you can design
+The key can be stored in **app/Config/Encryption.php**, or you can design
 a storage mechanism of your own and pass the key dynamically when encrypting/decrypting.
 
-To save your key to your ``app/Config/Encryption.php``, open the file
+To save your key to your **app/Config/Encryption.php**, open the file
 and set::
 
     public $key = 'YOUR KEY';
diff --git a/user_guide_src/source/libraries/honeypot.rst b/user_guide_src/source/libraries/honeypot.rst
@@ -14,7 +14,7 @@ assumed the request is coming from a Bot, and you can throw a ``HoneypotExceptio
 Enabling Honeypot
 =====================
 
-To enable a Honeypot, changes have to be made to the ``app/Config/Filters.php``. Just uncomment honeypot
+To enable a Honeypot, changes have to be made to the **app/Config/Filters.php**. Just uncomment honeypot
 from the ``$globals`` array, like...::
 
     public $globals = [
@@ -36,7 +36,7 @@ Customizing Honeypot
 =====================
 
 Honeypot can be customized. The fields below can be set either in
-``app/Config/Honeypot.php`` or in ``.env``.
+**app/Config/Honeypot.php** or in ``.env``.
 
 * ``hidden`` - true|false to control visibility of the honeypot field; default is ``true``
 * ``label`` - HTML label for the honeypot field, default is 'Fill This Field'
