summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAdrian Voicu <avenir.ro@gmail.com>2015-03-12 15:42:50 +0100
committerAdrian Voicu <avenir.ro@gmail.com>2015-03-12 15:42:50 +0100
commit875d5a1ca843b8169f0b4e8adf8d6f0eb7b4ee3c (patch)
tree3e1d4875e14ddbc1abf92a78500b007bb540bf47
parent64d1d82e03ace010dcf03c509cf6b87e0da27ff4 (diff)
additional info on heading() function
...worth mentioning...
-rw-r--r--user_guide_src/source/helpers/html_helper.rst19
1 files changed, 11 insertions, 8 deletions
diff --git a/user_guide_src/source/helpers/html_helper.rst b/user_guide_src/source/helpers/html_helper.rst
index d35be396a..1989c88ae 100644
--- a/user_guide_src/source/helpers/html_helper.rst
+++ b/user_guide_src/source/helpers/html_helper.rst
@@ -27,11 +27,11 @@ The following functions are available:
.. php:function:: heading([$data = ''[, $h = '1'[, $attributes = '']]])
- :param string $data: Content
- :param string $h: Heading level
- :param array $attributes: HTML attributes
- :returns: HTML heading tag
- :rtype: string
+ :param string $data: Content
+ :param string $h: Heading level
+ :param array|string $attributes: HTML attributes
+ :returns: HTML heading tag
+ :rtype: string
Lets you create HTML heading tags. The first parameter will contain the
data, the second the size of the heading. Example::
@@ -41,15 +41,18 @@ The following functions are available:
The above would produce: <h3>Welcome!</h3>
Additionally, in order to add attributes to the heading tag such as HTML
- classes, ids or inline styles, a third parameter is available::
+ classes, ids or inline styles, a third parameter is available either
+ as a string or as an array::
- echo heading('Welcome!', 3, 'class="pink"')
+ echo heading('Welcome!', 3, 'class="pink"');
+ echo heading('How are you?', 4, array('id'=>'question', 'class'=>'green');
The above code produces:
.. code-block:: html
<h3 class="pink">Welcome!<h3>
+ <h3 id="question" class="green">How are you?</h3>
.. php:function:: img([$src = ''[, $index_page = FALSE[, $attributes = '']]])
@@ -401,4 +404,4 @@ The following functions are available:
&nbsp;&nbsp;&nbsp;
.. note:: This function is DEPRECATED. Use the native ``str_repeat()``
- in combination with ``&nbsp;`` instead. \ No newline at end of file
+ in combination with ``&nbsp;`` instead.