Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / 39b622db9bda38282a32bb45623da63efe685729 / . / user_guide / helpers / typography_helper.html
blob: e3d18f8fb6eda48233fd609fe43f1b190c22a962 [file] [log] [blame]
adminb0dd10f2006-08-25 17:25:49 +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>
3<head>
4
Derek Allard404e35d2007-08-07 01:00:45 +0000[diff] [blame]5<title>CodeIgniter User Guide : Typography Helper</title>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]6
7<style type='text/css' media='all'>@import url('../userguide.css');</style>
8<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
9
admin17a890d2006-09-27 20:42:42 +0000[diff] [blame]10<script type="text/javascript" src="../nav/nav.js"></script>
admin2296fc32006-09-27 21:07:02 +0000[diff] [blame]11<script type="text/javascript" src="../nav/prototype.lite.js"></script>
admin17a890d2006-09-27 20:42:42 +0000[diff] [blame]12<script type="text/javascript" src="../nav/moo.fx.js"></script>
Derek Allardb3412372007-10-25 12:15:16 +0000[diff] [blame]13<script type="text/javascript" src="../nav/user_guide_menu.js"></script>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]14
15<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
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='Rick Ellis' />
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]20<meta name='description' content='CodeIgniter User Guide' />
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]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.jpg" width="153" height="44" 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 Allard39b622d2008-01-16 21:10:09 +0000[diff] [blame^]31<td><h1>CodeIgniter User Guide Version 1.6.0</h1></td>
adminc0d5d522006-10-30 19:40:35 +0000[diff] [blame]32<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]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">
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]43<a href="http://www.codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]44<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
45Typography Helper
46</td>
Derek Allardbc030912007-06-24 18:25:29 +0000[diff] [blame]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>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]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 Helper</h1>
60
61<p>The Typography Helper file contains functions that help your format text in semantically relevant ways.</p>
62
63
64<h2>Loading this Helper</h2>
65
66<p>This helper is loaded using the following code:</p>
67<code>$this->load->helper('typography');</code>
68
69<p>The following functions are available:</p>
70
71
72<h2>auto_typography()</h2>
73
admine334c472006-10-21 19:44:22 +0000[diff] [blame]74<p>Formats text so that it is semantically and typographically correct HTML. Takes a string as input and returns it with
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]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>
admine7e1dcd2006-10-21 18:04:01 +0000[diff] [blame]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>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]81<li>Quotes are converted to correctly facing curly quote entities, except those that appear within tags.</li>
82<li>Apostrophes are converted to curly apostrophy entities.</li>
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 = auto_typography($string);</code>
91
admine334c472006-10-21 19:44:22 +0000[diff] [blame]92<p><strong>Note:</strong> Typographic formatting can be processor intensive, particularly if you have a lot of content being formatted.
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]93If you choose to use this function you may want to consider
94<a href="../general/caching.html">caching</a> your pages.</p>
95
96
97<h2>nl2br_except_pre()</h2>
98
admine334c472006-10-21 19:44:22 +0000[diff] [blame]99<p>Converts newlines to &lt;br /&gt; tags unless they appear within &lt;pre&gt; tags.
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]100This function is identical to the native PHP <dfn>nl2br()</dfn> function, except that it ignores &lt;pre&gt; tags.</p>
101
102<p>Usage example:</p>
103
104<code>$string = nl2br_except_pre($string);</code>
105
106
107
108</div>
109<!-- END CONTENT -->
110
111
112<div id="footer">
113<p>
114Previous Topic:&nbsp;&nbsp;<a href="text_helper.html">Text Helper</a>
115&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
116<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
117<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
118Next Topic:&nbsp;&nbsp;<a href="url_helper.html">URL Helper</a>
Derek Allardc6441282007-07-04 23:54:32 +0000[diff] [blame]119</p>
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]120<p><a href="http://www.codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2007 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]121</div>
122
123</body>
124</html>