diff --git a/user_guide_src/source/helpers/html_helper.rst b/user_guide_src/source/helpers/html_helper.rst
index 95760b4af4da..88d551ce5039 100755
--- a/user_guide_src/source/helpers/html_helper.rst
+++ b/user_guide_src/source/helpers/html_helper.rst
@@ -2,8 +2,7 @@
HTML Helper
###########
-The HTML Helper file contains functions that assist in working with
-HTML.
+The HTML Helper file contains functions that assist in working with HTML.
.. contents::
:local:
@@ -28,37 +27,36 @@ The following functions are available:
.. php:function:: img([$src = ''[, $indexPage = false[, $attributes = '']]])
- :param string|array $src: Image source URI, or array of attributes and values
- :param bool $indexPage: Whether to treat ``$src`` as a routed URI string
- :param mixed $attributes: Additional HTML attributes
- :returns: HTML image tag
+ :param string|array $src: Image source URI, or array of attributes and values
+ :param bool $indexPage: Should indexPage be added to the source path
+ :param mixed $attributes: Additional HTML attributes
+ :returns: An HTML image element
:rtype: string
- Lets you create HTML ```` tags. The first parameter contains the
+ Lets you create HTML ```` elements. The first parameter contains the
image source. Example:
.. 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.
- Presumably, this would be if you were using a media controller:
+ 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 true 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:
.. literalinclude:: html_helper/004.php
-.. php:function:: img_data([$src = ''[, $indexPage = false[, $attributes = '']]])
+.. php:function:: img_data($path[, $mime = null])
- :param string $path: Path to the image file
+ :param string $path: Path to the image file
:param string|null $mime: MIME type to use, or null to guess
- :returns: base64 encoded binary image string
+ :returns: base64 encoded binary image string
:rtype: string
Generates a src-ready string from an image using the "data:" protocol.
@@ -82,14 +80,14 @@ The following functions are available:
:param string $type: Type of the related document
:param string $title: Link title
:param string $media: Media type
- :param bool $indexPage: Whether to treat ``$src`` as a routed URI string
+ :param bool $indexPage: Should indexPage be added to the link path
:param string $hreflang: Hreflang type
- :returns: HTML link tag
+ :returns: An HTML link element
:rtype: string
- Lets you create HTML ```` tags. This is useful for stylesheet links,
+ Lets you create HTML ```` elements. This is useful for stylesheet links,
as well as other links. The parameters are *href*, with optional *rel*,
- *type*, *title*, *media* and *indexPage*.
+ *type*, *title*, *media*, *indexPage* and *hreflang*.
*indexPage* is a boolean value that specifies if the *href* should have
the page specified by ``$config['indexPage']`` added to the address it creates.
@@ -109,12 +107,12 @@ The following functions are available:
.. php:function:: script_tag([$src = ''[, $indexPage = false]])
- :param array|string $src: The source name or URL of a JavaScript file, or an associative array specifying the attributes
+ :param array|string $src: The source name or URL of a JavaScript file, or an associative array specifying the attributes
:param bool $indexPage: Whether to treat ``$src`` as a routed URI string
- :returns: HTML script tag
+ :returns: An HTML script element
:rtype: string
- Lets you create HTML ```` tags. The parameters is *src*, with optional *indexPage*.
+ Lets you create HTML ```` tags. The parameters are *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.
@@ -130,13 +128,13 @@ The following functions are available:
.. php:function:: ul($list[, $attributes = ''])
- :param array $list: List entries
- :param array $attributes: HTML attributes
- :returns: HTML-formatted unordered list
+ :param array $list: List entries
+ :param mixed $attributes: HTML attributes
+ :returns: An HTML unordered list element
:rtype: string
- Permits you to generate unordered HTML lists from simple or
- multi-dimensional arrays. Example:
+ Permits you to generate an unordered HTML list from a simple or
+ multi-dimensional array. Example:
.. literalinclude:: html_helper/012.php
@@ -201,28 +199,28 @@ The following functions are available:
-.. php:function:: ol($list, $attributes = '')
+.. php:function:: ol($list[, $attributes = ''])
- :param array $list: List entries
- :param array $attributes: HTML attributes
- :returns: HTML-formatted ordered list
+ :param array $list: List entries
+ :param mixed $attributes: HTML attributes
+ :returns: An HTML ordered list element
:rtype: string
- Identical to :php:func:`ul()`, only it produces the ``
`` tag for
+ Identical to :php:func:`ul()`, only it produces ```` element for
ordered lists instead of ``
``.
.. php:function:: video($src[, $unsupportedMessage = ''[, $attributes = ''[, $tracks = [][, $indexPage = false]]]])
:param mixed $src: Either a source string or an array of sources. See :php:func:`source()` function
- :param string $unsupportedMessage: The message to display if the media tag is not supported by the browser
+ :param string $unsupportedMessage: The message to display if the video element is not supported by the browser
:param string $attributes: HTML attributes
:param array $tracks: Use the track function inside an array. See :php:func:`track()` function
- :param bool $indexPage:
- :returns: HTML-formatted video element
+ :param bool $indexPage: Should indexPage be added to the video source path
+ :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
@@ -253,52 +251,67 @@ The following functions are available:
.. php:function:: audio($src[, $unsupportedMessage = ''[, $attributes = ''[, $tracks = [][, $indexPage = false]]]])
:param mixed $src: Either a source string or an array of sources. See :php:func:`source()` function
- :param string $unsupportedMessage: The message to display if the media tag is not supported by the browser
- :param string $attributes:
+ :param string $unsupportedMessage: The message to display if the audie element is not supported by the browser
+ :param string $attributes: HTML attributes
:param array $tracks: Use the track function inside an array. See :php:func:`track()` function
- :param bool $indexPage:
- :returns: HTML-formatted audio element
+ :param bool $indexPage: Should indexPage be added to the audio source path
+ :returns: An HTML audio element
:rtype: string
- Identical to :php:func:`video()`, only it produces the ``