From 3bc791f34c4b71955b4a34d123c187958f29b7c2 Mon Sep 17 00:00:00 2001 From: Rick Ellis Date: Fri, 12 Sep 2008 23:15:52 +0000 Subject: typography tweaks --- user_guide/libraries/typography.html | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) (limited to 'user_guide/libraries/typography.html') diff --git a/user_guide/libraries/typography.html b/user_guide/libraries/typography.html index 91b205bb2..359c590ce 100644 --- a/user_guide/libraries/typography.html +++ b/user_guide/libraries/typography.html @@ -89,7 +89,21 @@ the following formatting:

$string = $this->typography->auto_typography($string); -

Note: Typographic formatting can be processor intensive, particularly if you have a lot of content being formatted. +

Parameters

+ +

There are two optional parameters:

+ +
    +
  1. Strip JavaScript Event Handlers. Determines whether the parser should strip all JavaScript event handlers for security. Use bolean TRUE or FALSE.
    2. +
  2. Reduce Linebreaks. Determines whether the parser should reduce more then two consecutive linebreaks down to two. Use bolean TRUE or FALSE.
    3. +
+ +

By default the parser strips JS Event handlers and does not reduce line breaks. In other words, if no parameters are submitted, it is the same as doing this:

+ +$string = $this->typography->auto_typography($string, TRUE, FALSE); + + +

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 your pages.

@@ -97,9 +111,19 @@ If you choose to use this function you may want to consider

convert_characters()

+

This function is similiar to the auto_typography function above, except that it only does character conversion:

+ +

Usage example:

+$string = $this->typography->convert_characters($string);

nl2br_except_pre()

-- cgit v1.2.3-24-g4f1b