| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | |
| <html> | |
| <head> | |
| <title>Code Igniter User Guide</title> | |
| <style type='text/css' media='all'>@import url('../userguide.css');</style> | |
| <link rel='stylesheet' type='text/css' media='all' href='../userguide.css' /> | |
| <script type="text/javascript" src="../scripts/nav.js"></script> | |
| <script type="text/javascript" src="../scripts/prototype.lite.js"></script> | |
| <script type="text/javascript" src="../scripts/moo.fx.js"></script> | |
| <script type="text/javascript"> | |
| window.onload = function() { | |
| myHeight = new fx.Height('nav', {duration: 400}); | |
| myHeight.hide(); | |
| } | |
| </script> | |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | |
| <meta http-equiv='expires' content='-1' /> | |
| <meta http-equiv= 'pragma' content='no-cache' /> | |
| <meta name='robots' content='all' /> | |
| <meta name='author' content='Rick Ellis' /> | |
| <meta name='description' content='Code Igniter User Guide' /> | |
| </head> | |
| <body> | |
| <!-- START NAVIGATION --> | |
| <div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div> | |
| <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> | |
| <div id="masthead"> | |
| <table cellpadding="0" cellspacing="0" border="0" style="width:100%"> | |
| <tr> | |
| <td><h1>Code Igniter User Guide Version 1.4.0</h1></td> | |
| <td id="breadcrumb_right"><a href="../toc.html">Full Table of Contents</a></td> | |
| </tr> | |
| </table> | |
| </div> | |
| <!-- END NAVIGATION --> | |
| <!-- START BREADCRUMB --> | |
| <table cellpadding="0" cellspacing="0" border="0" style="width:100%"> | |
| <tr> | |
| <td id="breadcrumb"> | |
| <a href="http://www.codeigniter.com/">Code Igniter Home</a> › | |
| <a href="../index.html">User Guide Home</a> › | |
| Typography Helper | |
| </td> | |
| <td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="www.codeigniter.com/user_guide/" />Search User Guide <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" /> <input type="submit" class="submit" name="sa" value="Go" /></form></td> | |
| </tr> | |
| </table> | |
| <!-- END BREADCRUMB --> | |
| <br clear="all" /> | |
| <!-- START CONTENT --> | |
| <div id="content"> | |
| <h1>Typography Helper</h1> | |
| <p>The Typography Helper file contains functions that help your format text in semantically relevant ways.</p> | |
| <h2>Loading this Helper</h2> | |
| <p>This helper is loaded using the following code:</p> | |
| <code>$this->load->helper('typography');</code> | |
| <p>The following functions are available:</p> | |
| <h2>auto_typography()</h2> | |
| <p>Formats text so that it is semantically and typographically correct HTML. Takes a string as input and returns it with | |
| the following formatting:</p> | |
| <ul> | |
| <li>Surrounds paragraphs within <p></p> (looks for double line breaks to identify paragraphs).</li> | |
| <li>Single line breaks are converted to <br />, except those that appear within <pre> tags.</li> | |
| <li>Block level elements, like <div> tags, are are not wrapped within paragraphs, but their contained text is if it contains paragraphs.</li> | |
| <li>Quotes are converted to correctly facing curly quote entities, except those that appear within tags.</li> | |
| <li>Apostrophes are converted to curly apostrophy entities.</li> | |
| <li>Double dashes (either like -- this or like--this) are converted to em—dashes.</li> | |
| <li>Three consecutive periods either preceding or following a word are converted to ellipsis…</li> | |
| <li>Double spaces following sentences are converted to non-breaking spaces to mimic double spacing.</li> | |
| </ul> | |
| <p>Usage example:</p> | |
| <code>$string = auto_typography($string);</code> | |
| <p><strong>Note:</strong> 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 | |
| <a href="../general/caching.html">caching</a> your pages.</p> | |
| <h2>nl2br_except_pre()</h2> | |
| <p>Converts newlines to <br /> tags unless they appear within <pre> tags. | |
| This function is identical to the native PHP <dfn>nl2br()</dfn> function, except that it ignores <pre> tags.</p> | |
| <p>Usage example:</p> | |
| <code>$string = nl2br_except_pre($string);</code> | |
| </div> | |
| <!-- END CONTENT --> | |
| <div id="footer"> | |
| <p> | |
| Previous Topic: <a href="text_helper.html">Text Helper</a> | |
| · | |
| <a href="#top">Top of Page</a> · | |
| <a href="../index.html">User Guide Home</a> · | |
| Next Topic: <a href="url_helper.html">URL Helper</a> | |
| <p> | |
| <p><a href="http://www.codeigniter.com">Code Igniter</a> · Copyright © 2006 · <a href="http://www.pmachine.com">pMachine, Inc.</a></p> | |
| </div> | |
| </body> | |
| </html> |