summaryrefslogtreecommitdiffstats
path: root/user_guide_src
diff options
context:
space:
mode:
authorDerek Jones <derek.jones@ellislab.com>2013-07-20 01:21:17 +0200
committerDerek Jones <derek.jones@ellislab.com>2013-07-20 01:21:17 +0200
commit26eb256ea28dd2dd03c2170de1a4af3b7a5fef9e (patch)
tree9b799b4518a1a437308bcea9236772b205167947 /user_guide_src
parente07b4e7e6c26e3aa5c4c8e57b2842e1ba818517e (diff)
Updating Typography helper docs
Diffstat (limited to 'user_guide_src')
-rw-r--r--user_guide_src/source/helpers/typography_helper.rst56
1 files changed, 29 insertions, 27 deletions
diff --git a/user_guide_src/source/helpers/typography_helper.rst b/user_guide_src/source/helpers/typography_helper.rst
index bce2d149d..d32befac1 100644
--- a/user_guide_src/source/helpers/typography_helper.rst
+++ b/user_guide_src/source/helpers/typography_helper.rst
@@ -5,7 +5,12 @@ Typography Helper
The Typography Helper file contains functions that help your format text
in semantically relevant ways.
-.. contents:: Page Contents
+.. contents::
+ :local:
+
+.. raw:: html
+
+ <div class="custom-index container"></div>
Loading this Helper
===================
@@ -14,51 +19,48 @@ This helper is loaded using the following code::
$this->load->helper('typography');
+Available Functions
+===================
+
The following functions are available:
-auto_typography()
-=================
-.. function:: auto_typography($str, $reduce_linebreaks = FALSE)
+.. function:: auto_typography($str[, $reduce_linebreaks = FALSE])
:param string $str: Input string
:param bool $reduce_linebreaks: Whether to reduce multiple instances of double newlines to two
:returns: string
-Formats text so that it is semantically and typographically correct
-HTML.
+ Formats text so that it is semantically and typographically correct
+ HTML.
-This function is an alias for ``CI_Typography::auto_typography``.
-For more info, please see the :doc:`Typography Library
-<../libraries/typography>` documentation.
+ This function is an alias for ``CI_Typography::auto_typography``.
+ For more info, please see the :doc:`Typography Library
+ <../libraries/typography>` documentation.
-Usage example::
+ Usage example::
- $string = auto_typography($string);
+ $string = auto_typography($string);
-.. note:: Typographic formatting can be processor intensive, particularly if
- you have a lot of content being formatted. If you choose to use this
- function you may want to consider `caching <../general/caching>` your
- pages.
+ .. note:: Typographic formatting can be processor intensive, particularly if
+ you have a lot of content being formatted. If you choose to use this
+ function you may want to consider `caching <../general/caching>` your
+ pages.
-nl2br_except_pre()
-==================
.. function:: nl2br_except_pre($str)
:param string $str: Input string
:returns: string
-Converts newlines to <br /> tags unless they appear within <pre> tags.
-This function is identical to the native PHP ``nl2br()`` function,
-except that it ignores <pre> tags.
+ Converts newlines to <br /> tags unless they appear within <pre> tags.
+ This function is identical to the native PHP ``nl2br()`` function,
+ except that it ignores <pre> tags.
-Usage example::
+ Usage example::
- $string = nl2br_except_pre($string);
+ $string = nl2br_except_pre($string);
-entity_decode()
-===============
.. function:: entity_decode($str, $charset = NULL)
@@ -66,6 +68,6 @@ entity_decode()
:param string $charset: Character set
:returns: string
-This function is an alias for ``CI_Security::entity_decode()``.
-Fore more info, please see the :doc:`Security Library
-<../libraries/security>` documentation. \ No newline at end of file
+ This function is an alias for ``CI_Security::entity_decode()``.
+ Fore more info, please see the :doc:`Security Library
+ <../libraries/security>` documentation. \ No newline at end of file