From 496ef239baa83fca758ec4034b36fe462feeada4 Mon Sep 17 00:00:00 2001 From: Osman Bozdag Date: Mon, 2 Sep 2024 06:13:07 +0200 Subject: [PATCH 1/2] docs: Fix some typos in helpers/html_helper.rst Fix some typos in helpers/html_helper.rst --- user_guide_src/source/helpers/html_helper.rst | 21 +++++++++---------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/user_guide_src/source/helpers/html_helper.rst b/user_guide_src/source/helpers/html_helper.rst index b16bba0eb933..afa58c8ccb27 100644 --- a/user_guide_src/source/helpers/html_helper.rst +++ b/user_guide_src/source/helpers/html_helper.rst @@ -38,16 +38,15 @@ The following functions are available: .. literalinclude:: html_helper/002.php - There is an optional second parameter that is a true/false value that - specifics if the *src* should have the page specified by - ``$config['indexPage']`` added to the address it creates. + There is an optional second parameter, a true/false value, that + specifies if the *src* should have ``$config['indexPage']`` added to the address it creates. Presumably, this would be if you were using a media controller: .. literalinclude:: html_helper/003.php Additionally, an associative array can be passed as the first parameter, for complete control over all attributes and values. If an *alt* attribute - is not provided, CodeIgniter will generate an empty string. + is not provided, CodeIgniter will generate one with empty string. Example: @@ -220,8 +219,8 @@ The following functions are available: :returns: An HTML video element :rtype: string - Permits you to generate HTML video element from simple or - source arrays. Example: + Permits you to generate an HTML video element from a source string or an array of sources. + Example: .. literalinclude:: html_helper/014.php @@ -269,8 +268,8 @@ The following functions are available: :returns: An HTML source element :rtype: string - Lets you create HTML ```` elements. The first parameter contains the - source source. Example: + Lets you create HTML ```` elements. The first parameter contains the path of the resource. + Example: .. literalinclude:: html_helper/015.php @@ -352,11 +351,11 @@ The following functions are available: .. literalinclude:: html_helper/020.php - The following is a list of the pre-defined doctype choices. These are configurable, - pulled from **app/Config/DocTypes.php**, or they could be over-ridden in your **.env** configuration. + The following is a list of the pre-defined doctypes. These are + pulled from **app/Config/DocTypes.php**, or they could be overridden in your **.env** configuration. =============================== =================== ================================================================================================================================================== - Document type Option Result + Document type $type parameter Result =============================== =================== ================================================================================================================================================== XHTML 1.1 xhtml11 XHTML 1.0 Strict xhtml1-strict From fe6efeddf83e01bff730901d422a4869c719e683 Mon Sep 17 00:00:00 2001 From: Osman Bozdag Date: Thu, 5 Sep 2024 21:38:02 +0200 Subject: [PATCH 2/2] docs: Update $config['indexPage'] in helpers/html_helper.rst Update $config['indexPage'] to Config\App::$indexPage in img function in helpers/html_helper.rst --- user_guide_src/source/helpers/html_helper.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/user_guide_src/source/helpers/html_helper.rst b/user_guide_src/source/helpers/html_helper.rst index afa58c8ccb27..4e81d6801d4d 100644 --- a/user_guide_src/source/helpers/html_helper.rst +++ b/user_guide_src/source/helpers/html_helper.rst @@ -39,7 +39,7 @@ The following functions are available: .. literalinclude:: html_helper/002.php There is an optional second parameter, a true/false value, that - specifies if the *src* should have ``$config['indexPage']`` added to the address it creates. + specifies if the *src* should have ``Config\App::$indexPage`` added to the address it creates. Presumably, this would be if you were using a media controller: .. literalinclude:: html_helper/003.php