From 8ffd0ad3895b4d16f77817f25ba79f4e943549fc Mon Sep 17 00:00:00 2001 From: kenjis Date: Tue, 2 Nov 2021 15:44:35 +0900 Subject: [PATCH 1/4] docs: fix sample code format --- 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 a477b9cbd311..a7ad04914831 100755 --- a/user_guide_src/source/helpers/html_helper.rst +++ b/user_guide_src/source/helpers/html_helper.rst @@ -79,7 +79,7 @@ The following functions are available: echo img($src); There is an optional second parameter to specify the MIME type, otherwise the - function will use your Mimes config to guess. + function will use your Mimes config to guess:: $src = img_data('path/img_without_extension', 'image/png'); // data:image/png;base64,HT5A822... From 0705c535247a13a0ede50b53cea53d545464123e Mon Sep 17 00:00:00 2001 From: kenjis Date: Tue, 2 Nov 2021 15:47:50 +0900 Subject: [PATCH 2/4] docs: decorate HTML tags with '``' --- user_guide_src/source/helpers/html_helper.rst | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/user_guide_src/source/helpers/html_helper.rst b/user_guide_src/source/helpers/html_helper.rst index a7ad04914831..8eb55fb649d0 100755 --- a/user_guide_src/source/helpers/html_helper.rst +++ b/user_guide_src/source/helpers/html_helper.rst @@ -32,7 +32,7 @@ The following functions are available: :returns: HTML image tag :rtype: string - Lets you create HTML tags. The first parameter contains the + Lets you create HTML ```` tags. The first parameter contains the image source. Example:: echo img('images/picture.jpg'); @@ -99,7 +99,7 @@ The following functions are available: :returns: HTML link tag :rtype: string - Lets you create HTML tags. This is useful for stylesheet links, + Lets you create HTML ```` tags. This is useful for stylesheet links, as well as other links. The parameters are *href*, with optional *rel*, *type*, *title*, *media* and *indexPage*. @@ -139,7 +139,7 @@ The following functions are available: :returns: HTML script tag :rtype: string - Lets you create HTML tags. The parameters is *src*, with optional *indexPage*. + Lets you create HTML ```` tags. The parameters is *src*, with optional *indexPage*. *indexPage* is a boolean value that specifies if the *src* should have the page specified by ``$config['indexPage']`` added to the address it creates. @@ -284,8 +284,8 @@ The following functions are available: :returns: HTML-formatted ordered list :rtype: string - Identical to :php:func:`ul()`, only it produces the
    tag for - ordered lists instead of
      . + Identical to :php:func:`ul()`, only it produces the ``
        `` tag for + ordered lists instead of ``
          ``. .. php:function:: video($src[, $unsupportedMessage = ''[, $attributes = ''[, $tracks = [][, $indexPage = false]]]]) @@ -359,7 +359,7 @@ The following functions are available: :returns: HTML-formatted audio element :rtype: string - Identical to :php:func:`video()`, only it produces the