From 8ede1a2ecbb62577afd32996956c5feaf7ddf9b6 Mon Sep 17 00:00:00 2001 From: Derek Jones Date: Wed, 5 Oct 2011 13:34:52 -0500 Subject: replacing the old HTML user guide with a Sphinx-managed user guide --- user_guide/libraries/typography.html | 160 ----------------------------------- 1 file changed, 160 deletions(-) delete mode 100644 user_guide/libraries/typography.html (limited to 'user_guide/libraries/typography.html') diff --git a/user_guide/libraries/typography.html b/user_guide/libraries/typography.html deleted file mode 100644 index cd287933c..000000000 --- a/user_guide/libraries/typography.html +++ /dev/null @@ -1,160 +0,0 @@ - - - - - -Typography Class : CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- - -

Typography Class

- -

The Typography Class provides functions that help you format text.

- - -

Initializing the Class

- -

Like most other classes in CodeIgniter, the Typography class is initialized in your controller using the $this->load->library function:

- -$this->load->library('typography'); -

Once loaded, the Typography library object will be available using: $this->typography

- - -

auto_typography()

- -

Formats text so that it is semantically and typographically correct HTML. Takes a string as input and returns it with -the following formatting:

- - - -

Usage example:

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

Parameters

- -

There is one optional parameters that determines whether the parser should reduce more then two consecutive line breaks down to two. Use boolean TRUE or FALSE.

- -

By default the parser 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, 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.

- - - -

format_characters()

- -

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

- - - -

Usage example:

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

nl2br_except_pre()

- -

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:

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

protect_braced_quotes

- -

When using the Typography library in conjunction with the Template Parser library it can often be desirable to protect single - and double quotes within curly braces. To enable this, set the protect_braced_quotes class property to TRUE.

- -

Usage example:

- -$this->load->library('typography');
-$this->typography->protect_braced_quotes = TRUE; - - -
- - - - - - - \ No newline at end of file -- cgit v1.2.3-24-g4f1b