Skip to content

Commit 0705c53

Browse files
committed
docs: decorate HTML tags with '``'
1 parent 8ffd0ad commit 0705c53

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

user_guide_src/source/helpers/html_helper.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The following functions are available:
3232
:returns: HTML image tag
3333
:rtype: string
3434

35-
Lets you create HTML <img /> tags. The first parameter contains the
35+
Lets you create HTML ``<img />`` tags. The first parameter contains the
3636
image source. Example::
3737

3838
echo img('images/picture.jpg');
@@ -99,7 +99,7 @@ The following functions are available:
9999
:returns: HTML link tag
100100
:rtype: string
101101

102-
Lets you create HTML <link /> tags. This is useful for stylesheet links,
102+
Lets you create HTML ``<link />`` tags. This is useful for stylesheet links,
103103
as well as other links. The parameters are *href*, with optional *rel*,
104104
*type*, *title*, *media* and *indexPage*.
105105

@@ -139,7 +139,7 @@ The following functions are available:
139139
:returns: HTML script tag
140140
:rtype: string
141141

142-
Lets you create HTML <script></script> tags. The parameters is *src*, with optional *indexPage*.
142+
Lets you create HTML ``<script></script>`` tags. The parameters is *src*, with optional *indexPage*.
143143

144144
*indexPage* is a boolean value that specifies if the *src* should have
145145
the page specified by ``$config['indexPage']`` added to the address it creates.
@@ -284,8 +284,8 @@ The following functions are available:
284284
:returns: HTML-formatted ordered list
285285
:rtype: string
286286

287-
Identical to :php:func:`ul()`, only it produces the <ol> tag for
288-
ordered lists instead of <ul>.
287+
Identical to :php:func:`ul()`, only it produces the ``<ol>`` tag for
288+
ordered lists instead of ``<ul>``.
289289

290290
.. php:function:: video($src[, $unsupportedMessage = ''[, $attributes = ''[, $tracks = [][, $indexPage = false]]]])
291291
@@ -359,7 +359,7 @@ The following functions are available:
359359
:returns: HTML-formatted audio element
360360
:rtype: string
361361

362-
Identical to :php:func:`video()`, only it produces the <audio> tag instead of <video>.
362+
Identical to :php:func:`video()`, only it produces the ``<audio>`` tag instead of ``<video>``.
363363

364364
.. php:function:: source($src = ''[, $type = false[, $attributes = '']])
365365
@@ -369,7 +369,7 @@ The following functions are available:
369369
:returns: HTML source tag
370370
:rtype: string
371371

372-
Lets you create HTML <source /> tags. The first parameter contains the
372+
Lets you create HTML ``<source />`` tags. The first parameter contains the
373373
source source. Example::
374374

375375
echo source('movie.mp4', 'video/mp4', 'class="test"');
@@ -384,7 +384,7 @@ The following functions are available:
384384
:returns: HTML embed tag
385385
:rtype: string
386386

387-
Lets you create HTML <embed /> tags. The first parameter contains the
387+
Lets you create HTML ``<embed />`` tags. The first parameter contains the
388388
embed source. Example::
389389

390390
echo embed('movie.mov', 'video/quicktime', 'class="test"');
@@ -399,7 +399,7 @@ The following functions are available:
399399
:returns: HTML object tag
400400
:rtype: string
401401

402-
Lets you create HTML <object /> tags. The first parameter contains the
402+
Lets you create HTML ``<object />`` tags. The first parameter contains the
403403
object data. Example::
404404

405405
echo object('movie.swf', 'application/x-shockwave-flash', 'class="test"');
@@ -433,7 +433,7 @@ The following functions are available:
433433
:returns: HTML param tag
434434
:rtype: string
435435

436-
Lets you create HTML <param /> tags. The first parameter contains the
436+
Lets you create HTML ``<param />`` tags. The first parameter contains the
437437
param source. Example::
438438

439439
echo param('movie.mov', 'video/quicktime', 'class="test"');

0 commit comments

Comments
 (0)