Skip to content

Commit e0e7702

Browse files
authored
docs: Fix $indexPage param explanations in helpers/html_helper.rst
Fix $indexPage parameter explanations in helpers/html_helper.rst
1 parent c326cd1 commit e0e7702

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

user_guide_src/source/helpers/html_helper.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ The following functions are available:
2828
.. php:function:: img([$src = ''[, $indexPage = false[, $attributes = '']]])
2929
3030
:param string|array $src: Image source URI, or array of attributes and values
31-
:param bool $indexPage: Whether to treat ``$src`` as a routed URI string
31+
:param bool $indexPage: Should indexPage be added to the source path
3232
:param mixed $attributes: Additional HTML attributes
33-
:returns: HTML image element
33+
:returns: An HTML image element
3434
:rtype: string
3535

3636
Lets you create HTML ``<img>`` elements. The first parameter contains the
@@ -81,14 +81,14 @@ The following functions are available:
8181
:param string $type: Type of the related document
8282
:param string $title: Link title
8383
:param string $media: Media type
84-
:param bool $indexPage: Whether to treat ``$src`` as a routed URI string
84+
:param bool $indexPage: Should indexPage be added to the link path
8585
:param string $hreflang: Hreflang type
8686
:returns: An HTML link element
8787
:rtype: string
8888

8989
Lets you create HTML ``<link>`` elements. This is useful for stylesheet links,
9090
as well as other links. The parameters are *href*, with optional *rel*,
91-
*type*, *title*, *media* and *indexPage*.
91+
*type*, *title*, *media*, *indexPage* and *hreflang*.
9292

9393
*indexPage* is a boolean value that specifies if the *href* should have
9494
the page specified by ``$config['indexPage']`` added to the address it creates.
@@ -216,7 +216,7 @@ The following functions are available:
216216
:param string $unsupportedMessage: The message to display if the video element is not supported by the browser
217217
:param string $attributes: HTML attributes
218218
:param array $tracks: Use the track function inside an array. See :php:func:`track()` function
219-
:param bool $indexPage:
219+
:param bool $indexPage: Should indexPage be added to the video source path
220220
:returns: An HTML video element
221221
:rtype: string
222222

@@ -255,7 +255,7 @@ The following functions are available:
255255
:param string $unsupportedMessage: The message to display if the audio element is not supported by the browser
256256
:param string $attributes:
257257
:param array $tracks: Use the track function inside an array. See :php:func:`track()` function
258-
:param bool $indexPage:
258+
:param bool $indexPage: Should indexPage be added to the audio source path
259259
:returns: An HTML audio element
260260
:rtype: string
261261

@@ -279,7 +279,7 @@ The following functions are available:
279279
:param string $src: The path of the resource to embed
280280
:param bool $type: MIME-type
281281
:param array $attributes: HTML attributes
282-
:param bool $indexPage:
282+
:param bool $indexPage: Should indexPage be added to the source path
283283
:returns: An HTML embed element
284284
:rtype: string
285285

@@ -293,6 +293,7 @@ The following functions are available:
293293
:param string $data: A resource URL
294294
:param bool $type: Content-type of the resource
295295
:param array $attributes: HTML attributes
296+
:param bool $indexPage: Should indexPage be added to the resource URL
296297
:param array $params: Use the param function inside an array. See :php:func:`param()` function
297298
:returns: An HTML object element
298299
:rtype: string

0 commit comments

Comments
 (0)