[ PHPXref.com ] [ Generated: Sun Jul 20 20:37:06 2008 ] [ TextilePHP 2.0.8 ]
[ Index ]     [ Variables ]     [ Functions ]     [ Classes ]     [ Constants ]     [ Statistics ]

title

Body

[close]

/doc/ -> classMTLikeTextile.html (source)

   1  <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2  <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   3  <title>TextilePHP: MTLikeTextile class Reference</title>
   4  <link href="doxygen.css" rel="stylesheet" type="text/css">
   5  </head><body>
   6  <!-- Generated by Doxygen 1.3.7 -->
   7  <div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a></div>
   8  <h1>MTLikeTextile Class Reference</h1>A <a class="el" href="classTextile.html">Textile</a> implementation providing additional Movable-Type-like formatting to produce results similar to the mttextile plugin.  
   9  <a href="#_details">More...</a>
  10  <p>
  11  <p>Inheritance diagram for MTLikeTextile:
  12  <p><center><img src="classMTLikeTextile.png" usemap="#MTLikeTextile_map" border="0" alt=""></center>
  13  <map name="MTLikeTextile_map">
  14  <area href="classTextile.html" alt="Textile" shape="rect" coords="0,0,89,24">
  15  </map>
  16  <a href="classMTLikeTextile-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
  17  <tr><td></td></tr>
  18  <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
  19  <tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMTLikeTextile.html#a0">MTLikeTextile</a> ($options=array())</td></tr>
  20  
  21  <tr><td colspan=2><br><h2>Private Member Functions</h2></td></tr>
  22  <tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMTLikeTextile.html#d0">process_quotes</a> ($str)</td></tr>
  23  
  24  <tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classMTLikeTextile.html#d1">format_url</a> ($args)</td></tr>
  25  
  26  </table>
  27  <hr><a name="_details"></a><h2>Detailed Description</h2>
  28  A <a class="el" href="classTextile.html">Textile</a> implementation providing additional Movable-Type-like formatting to produce results similar to the mttextile plugin. 
  29  <p>
  30  Brad Choate's mttextile Movable Type plugin adds some additional functionality to the Textile.pm Perl module. This includes optional "SmartyPants" processing of text to produce smart quotes, dashes, etc., code colorizing using Beautifier, and some special lookup links (imdb, google, dict, and amazon). The <code>MTLikeTextile</code> class is a subclass of <code><a class="el" href="classTextile.html">Textile</a></code> that provides an MT-like implementation of <a class="el" href="classTextile.html">Textile</a> to produce results similar to that of the mttextile plugin. Currently only the SmartyPants and special lookup links are implemented.<p>
  31  Using the <code>MTLikeTextile</code> class is exactly the same as using <code><a class="el" href="classTextile.html">Textile</a></code>. Simply use <code>$textile = new MTLikeTextile;</code> instead of <code>$textile = new <a class="el" href="classTextile.html">Textile</a>;</code> to create a <a class="el" href="classTextile.html">Textile</a> object. This will enable the special lookup links. To enable SmartyPants processing, you must install the SmartyPants-PHP implementation available at <a href="http://monauraljerk.org/smartypants-php/">http://monauraljerk.org/smartypants-php/</a> and include the SmartyPants-PHP.inc file.<p>
  32  <pre><code>
  33   include_once("Textile.php");
  34   include_once("SmartyPants-PHP.inc");
  35   $text = &lt;&lt;&lt;EOT
  36   h1. Heading</code></pre><p>
  37  <pre><code> A _simple_ demonstration of <a class="el" href="classTextile.html">Textile</a> markup.</code></pre><p>
  38  <pre><code> * One
  39   * Two
  40   * Three</code></pre><p>
  41  <pre><code> "More information":<a href="http://www.textism.com/tools/textile">http://www.textism.com/tools/textile</a> is available.
  42   EOT;</code></pre><p>
  43  <pre><code> $textile = new MTLikeTextile;
  44   $html = $textile-&gt;process($text);
  45   print $html;
  46   </code></pre><p>
  47  <dl compact><dt><b>Author:</b></dt><dd>Jim Riggs &lt;textile at jimandlisa dot com&gt; </dd></dl>
  48  
  49  <p>
  50  
  51  <p>
  52  Definition at line <a class="el" href="Textile_8php-source.html#l03337">3337</a> of file <a class="el" href="Textile_8php-source.html">Textile.php</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
  53  <a class="anchor" name="a0" doxytag="MTLikeTextile::MTLikeTextile" ></a><p>
  54  <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  55    <tr>
  56      <td class="mdRow">
  57        <table cellpadding="0" cellspacing="0" border="0">
  58          <tr>
  59            <td class="md" nowrap valign="top"> MTLikeTextile::MTLikeTextile           </td>
  60            <td class="md" valign="top">(&nbsp;</td>
  61            <td class="md" nowrap valign="top">$&nbsp;</td>
  62            <td class="mdname1" valign="top" nowrap> <em>options</em> = <code>array()</code>          </td>
  63            <td class="md" valign="top">&nbsp;)&nbsp;</td>
  64            <td class="md" nowrap></td>
  65          </tr>
  66        </table>
  67      </td>
  68    </tr>
  69  </table>
  70  <table cellspacing=5 cellpadding=0 border=0>
  71    <tr>
  72      <td>
  73        &nbsp;
  74      </td>
  75      <td>
  76  
  77  <p>
  78  Instantiates a new MTLikeTextile object. Optional options can be passed to initialize the object. Attributes for the options key are the same as the get/set method names documented here.<p>
  79  <dl compact><dt><b>Parameters:</b></dt><dd>
  80    <table border="0" cellspacing="2" cellpadding="0">
  81      <tr><td></td><td valign=top><em>$options</em>&nbsp;</td><td>The <code>array</code> specifying the options to use for this object. </td></tr>
  82    </table>
  83  </dl>
  84  
  85  <p>
  86  Definition at line <a class="el" href="Textile_8php-source.html#l03349">3349</a> of file <a class="el" href="Textile_8php-source.html">Textile.php</a>.    </td>
  87    </tr>
  88  </table>
  89  <hr><h2>Member Function Documentation</h2>
  90  <a class="anchor" name="d1" doxytag="MTLikeTextile::format_url" ></a><p>
  91  <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  92    <tr>
  93      <td class="mdRow">
  94        <table cellpadding="0" cellspacing="0" border="0">
  95          <tr>
  96            <td class="md" nowrap valign="top"> MTLikeTextile::format_url           </td>
  97            <td class="md" valign="top">(&nbsp;</td>
  98            <td class="md" nowrap valign="top">$&nbsp;</td>
  99            <td class="mdname1" valign="top" nowrap> <em>args</em>          </td>
 100            <td class="md" valign="top">&nbsp;)&nbsp;</td>
 101            <td class="md" nowrap><code> [private]</code></td>
 102          </tr>
 103        </table>
 104      </td>
 105    </tr>
 106  </table>
 107  <table cellspacing=5 cellpadding=0 border=0>
 108    <tr>
 109      <td>
 110        &nbsp;
 111      </td>
 112      <td>
 113  
 114  <p>
 115  Takes the given <code>$url</code> and transforms it appropriately.<p>
 116  <dl compact><dt><b>Parameters:</b></dt><dd>
 117    <table border="0" cellspacing="2" cellpadding="0">
 118      <tr><td></td><td valign=top><em>$args</em>&nbsp;</td><td>An <code>array</code> specifying the attributes for formatting the url.</td></tr>
 119    </table>
 120  </dl>
 121  <dl compact><dt><b>Returns:</b></dt><dd>A <code>string</code> containing the formatted url. </dd></dl>
 122  
 123  <p>
 124  Reimplemented from <a class="el" href="classTextile.html#d13">Textile</a>.
 125  <p>
 126  Definition at line <a class="el" href="Textile_8php-source.html#l03367">3367</a> of file <a class="el" href="Textile_8php-source.html">Textile.php</a>.
 127  <p>
 128  References <a class="el" href="Textile_8php-source.html#l03367">format_url()</a>.
 129  <p>
 130  Referenced by <a class="el" href="Textile_8php-source.html#l03367">format_url()</a>.    </td>
 131    </tr>
 132  </table>
 133  <a class="anchor" name="d0" doxytag="MTLikeTextile::process_quotes" ></a><p>
 134  <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 135    <tr>
 136      <td class="mdRow">
 137        <table cellpadding="0" cellspacing="0" border="0">
 138          <tr>
 139            <td class="md" nowrap valign="top"> MTLikeTextile::process_quotes           </td>
 140            <td class="md" valign="top">(&nbsp;</td>
 141            <td class="md" nowrap valign="top">$&nbsp;</td>
 142            <td class="mdname1" valign="top" nowrap> <em>str</em>          </td>
 143            <td class="md" valign="top">&nbsp;)&nbsp;</td>
 144            <td class="md" nowrap><code> [private]</code></td>
 145          </tr>
 146        </table>
 147      </td>
 148    </tr>
 149  </table>
 150  <table cellspacing=5 cellpadding=0 border=0>
 151    <tr>
 152      <td>
 153        &nbsp;
 154      </td>
 155      <td>
 156  
 157  <p>
 158  Processes string, formatting plain quotes into curly quotes.<p>
 159  <dl compact><dt><b>Parameters:</b></dt><dd>
 160    <table border="0" cellspacing="2" cellpadding="0">
 161      <tr><td></td><td valign=top><em>$str</em>&nbsp;</td><td>A <code>string</code> specifying the text to process.</td></tr>
 162    </table>
 163  </dl>
 164  <dl compact><dt><b>Returns:</b></dt><dd>A <code>string</code> containing the processed text. </dd></dl>
 165  
 166  <p>
 167  Reimplemented from <a class="el" href="classTextile.html#d24">Textile</a>.
 168  <p>
 169  Definition at line <a class="el" href="Textile_8php-source.html#l03356">3356</a> of file <a class="el" href="Textile_8php-source.html">Textile.php</a>.
 170  <p>
 171  References <a class="el" href="Textile_8php-source.html#l03356">process_quotes()</a>.
 172  <p>
 173  Referenced by <a class="el" href="Textile_8php-source.html#l03356">process_quotes()</a>.    </td>
 174    </tr>
 175  </table>
 176  <hr>The documentation for this class was generated from the following file:<ul>
 177  <li><a class="el" href="Textile_8php-source.html">Textile.php</a></ul>
 178  <hr size="1"><address style="align: right;"><small>Generated on Mon Mar 21 08:37:29 2005 for TextilePHP by
 179  <a href="http://www.doxygen.org/index.html">
 180  <img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.7 </small></address>
 181  </body>
 182  </html>


[ Powered by PHPXref - Served by Debian GNU/Linux ]