Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / bbedc76aaf59f6f12a7bc32e1aa851317a61c837 / . / user_guide / libraries / typography.html
blob: a53d7e73225910148ea9df86c4a10250d0233bfc [file] [log] [blame]
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
3<head>
4
5<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6<title>Typography Class : CodeIgniter User Guide</title>
7
8<style type='text/css' media='all'>@import url('../userguide.css');</style>
9<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
10
11<script type="text/javascript" src="../nav/nav.js"></script>
12<script type="text/javascript" src="../nav/prototype.lite.js"></script>
13<script type="text/javascript" src="../nav/moo.fx.js"></script>
14<script type="text/javascript" src="../nav/user_guide_menu.js"></script>
15
16<meta http-equiv='expires' content='-1' />
17<meta http-equiv= 'pragma' content='no-cache' />
18<meta name='robots' content='all' />
19<meta name='author' content='ExpressionEngine Dev Team' />
20<meta name='description' content='CodeIgniter User Guide' />
21
22</head>
23<body>
24
25<!-- START NAVIGATION -->
26<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
27<div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../images/nav_toggle_darker.jpg" width="154" height="43" border="0" title="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div>
28<div id="masthead">
29<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
30<tr>
Derek Jonesbbedc762009-09-11 14:47:37 +0000[diff] [blame^]31<td><h1>CodeIgniter User Guide Version 1.7.2</h1></td>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]32<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
33</tr>
34</table>
35</div>
36<!-- END NAVIGATION -->
37
38
39<!-- START BREADCRUMB -->
40<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
41<tr>
42<td id="breadcrumb">
43<a href="http://codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
44<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
45Typography Class
46</td>
47<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="codeigniter.com/user_guide/" />Search User Guide&nbsp; <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" />&nbsp;<input type="submit" class="submit" name="sa" value="Go" /></form></td>
48</tr>
49</table>
50<!-- END BREADCRUMB -->
51
52<br clear="all" />
53
54
55<!-- START CONTENT -->
56<div id="content">
57
58
59<h1>Typography Class</h1>
60
61<p>The Typography Class provides functions that help you format text.</p>
62
63
64<h2>Initializing the Class</h2>
65
66<p>Like most other classes in CodeIgniter, the Typography class is initialized in your controller using the <dfn>$this->load->library</dfn> function:</p>
67
68<code>$this->load->library('typography');</code>
69<p>Once loaded, the Typography library object will be available using: <dfn>$this->typography</dfn></p>
70
71
72<h2>auto_typography()</h2>
73
74<p>Formats text so that it is semantically and typographically correct HTML. Takes a string as input and returns it with
75the following formatting:</p>
76
77<ul>
78<li>Surrounds paragraphs within &lt;p&gt;&lt;/p&gt; (looks for double line breaks to identify paragraphs).</li>
79<li>Single line breaks are converted to &lt;br /&gt;, except those that appear within &lt;pre&gt; tags.</li>
80<li>Block level elements, like &lt;div&gt; tags, are not wrapped within paragraphs, but their contained text is if it contains paragraphs.</li>
81<li>Quotes are converted to correctly facing curly quote entities, except those that appear within tags.</li>
Derek Allard162c0222008-12-23 15:49:46 +0000[diff] [blame]82<li>Apostrophes are converted to curly apostrophe entities.</li>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]83<li>Double dashes (either like -- this or like--this) are converted to em&#8212;dashes.</li>
84<li>Three consecutive periods either preceding or following a word are converted to ellipsis&#8230;</li>
85<li>Double spaces following sentences are converted to non-breaking spaces to mimic double spacing.</li>
86</ul>
87
88<p>Usage example:</p>
89
90<code>$string = $this->typography->auto_typography($string);</code>
91
92<h3>Parameters</h3>
93
Derek Allard162c0222008-12-23 15:49:46 +0000[diff] [blame]94<p>There is one optional parameters that determines whether the parser should reduce more then two consecutive line breaks down to two. Use boolean <kbd>TRUE</kbd> or <kbd>FALSE</kbd>.
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]95
96<p>By default the parser does not reduce line breaks. In other words, if no parameters are submitted, it is the same as doing this:</p>
97
98<code>$string = $this->typography->auto_typography($string, <kbd>FALSE</kbd>);</code>
99
100
101<p class="important"><strong>Note:</strong> Typographic formatting can be processor intensive, particularly if you have a lot of content being formatted.
102If you choose to use this function you may want to consider
103<a href="../general/caching.html">caching</a> your pages.</p>
104
105
106
Derek Allard162c0222008-12-23 15:49:46 +0000[diff] [blame]107<h2>format_characters()</h2>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]108
Derek Allard162c0222008-12-23 15:49:46 +0000[diff] [blame]109<p>This function is similar to the <dfn>auto_typography</dfn> function above, except that it only does character conversion:</p>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]110
111<ul>
112<li>Quotes are converted to correctly facing curly quote entities, except those that appear within tags.</li>
Derek Allard162c0222008-12-23 15:49:46 +0000[diff] [blame]113<li>Apostrophes are converted to curly apostrophe entities.</li>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]114<li>Double dashes (either like -- this or like--this) are converted to em&#8212;dashes.</li>
115<li>Three consecutive periods either preceding or following a word are converted to ellipsis&#8230;</li>
116<li>Double spaces following sentences are converted to non-breaking spaces to mimic double spacing.</li>
117</ul>
118
119<p>Usage example:</p>
120
Derek Allard162c0222008-12-23 15:49:46 +0000[diff] [blame]121<code>$string = $this->typography->format_characters($string);</code>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]122
123
124<h2>nl2br_except_pre()</h2>
125
126<p>Converts newlines to &lt;br /&gt; tags unless they appear within &lt;pre&gt; tags.
127This function is identical to the native PHP <dfn>nl2br()</dfn> function, except that it ignores &lt;pre&gt; tags.</p>
128
129<p>Usage example:</p>
130
131<code>$string = $this->typography->nl2br_except_pre($string);</code>
132
133<h2>protect_braced_quotes</h2>
134
135<p>When using the Typography library in conjunction with the Template Parser library it can often be desirable to protect single
136 and double quotes within curly braces. To enable this, set the <kbd>protect_braced_quotes</kbd> class property to <samp>TRUE</samp>.
137
138<p>Usage example:</p>
139
140<code>$this->load->library('typography');<br />
141$this->typography->protect_braced_quotes = TRUE;
142</code>
143
144</div>
145<!-- END CONTENT -->
146
147
148<div id="footer">
149<p>
150Previous Topic:&nbsp;&nbsp;<a href="parser.html">Template Parser</a>
151&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
152<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
153<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
154Next Topic:&nbsp;&nbsp;<a href="unit_testing.html">Unit Testing Class</a>
155</p>
Derek Jonesfc395a12009-04-22 14:15:09 +0000[diff] [blame]156<p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006-2009 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]157</div>
158
159</body>
Rick Ellis7eb56d62008-09-12 07:22:35 +0000[diff] [blame]160</html>