user_guide/doc_style/template.html

   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>CodeIgniter Project Documentation Template</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 <meta http-equiv='expires' content='-1' />
  12 <meta http-equiv= 'pragma' content='no-cache' />
  13 <meta name='robots' content='all' />
  14
  15 </head>
  16 <body>
  17
  18 <!-- START NAVIGATION -->
  19 <div id="nav"><div id="nav_inner"></div></div>
  20 <div id="nav2"><a name="top">&nbsp;</a></div>
  21 <div id="masthead">
  22 <table cellpadding="0" cellspacing="0" border="0" style="width:100%">
  23 <tr>
  24 <td><h1>Project Title</h1></td>
  25 <td id="breadcrumb_right"><a href="#">Right Breadcrumb</a></td>
  26 </tr>
  27 </table>
  28 </div>
  29 <!-- END NAVIGATION -->
  30
  31
  32 <!-- START BREADCRUMB -->
  33 <table cellpadding="0" cellspacing="0" border="0" style="width:100%">
  34 <tr>
  35 <td id="breadcrumb">
  36 <a href="http://example.com/">Project Home</a> &nbsp;&#8250;&nbsp;
  37 <a href="#">User Guide Home</a> &nbsp;&#8250;&nbsp;
  38 Foo Class
  39 </td>
  40 <td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="example.com/user_guide/" />Search Project 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>
  41 </tr>
  42 </table>
  43 <!-- END BREADCRUMB -->
  44
  45 <br clear="all" />
  46
  47
  48 <!-- START CONTENT -->
  49 <div id="content">
  50
  51
  52 <h1>Foo Class</h1>
  53
  54 <p>Brief description of Foo Class.  If it extends a native CodeIgniter class, please link to the class in the CodeIgniter documents here.</p>
  55
  56 <p class="important"><strong>Important:</strong>&nbsp; This is an important note with <kbd>EMPHASIS</kbd>.</p>
  57
  58 <p>Features:</p>
  59
  60 <ul>
  61         <li>Foo</li>
  62         <li>Bar</li>
  63 </ul>
  64
  65 <h2>Usage Heading</h2>
  66
  67 <p>Within a text string, <var>highlight variables</var> using <var>&lt;var&gt;&lt;/var&gt;</var> tags, and <dfn>highlight code</dfn> using the <dfn>&lt;dfn&gt;&lt;/dfn&gt;</dfn> tags.</p>
  68
  69 <h3>Sub-heading</h3>
  70
  71 <p>Put code examples within <dfn>&lt;code&gt;&lt;/code&gt;</dfn> tags:</p>
  72
  73 <code>
  74         $this->load->library('foo');<br />
  75         <br />
  76         $this->foo->bar('bat');
  77 </code>
  78
  79
  80 <h2>Table Preferences</h2>
  81
  82 <p>Use tables where appropriate for long lists of preferences.</p>
  83
  84
  85 <table cellpadding="0" cellspacing="1" border="0" style="width:100%" class="tableborder">
  86 <tr>
  87         <th>Preference</th>
  88         <th>Default&nbsp;Value</th>
  89         <th>Options</th>
  90         <th>Description</th>
  91 </tr>
  92 <tr>
  93         <td class="td"><strong>foo</strong></td>
  94         <td class="td">Foo</td>
  95         <td class="td">None</td>
  96         <td class="td">Description of foo.</td>
  97 </tr>
  98 <tr>
  99         <td class="td"><strong>bar</strong></td>
 100         <td class="td">Bar</td>
 101         <td class="td">bat, bag, or bak</td>
 102         <td class="td">Description of bar.</td>
 103 </tr>
 104 </table>
 105
 106 <h2>Foo Function Reference</h2>
 107
 108 <h3>$this->foo->bar()</h3>
 109 <p>Description</p>
 110 <code>$this->foo->bar('<var>baz</var>')</code>
 111
 112 </div>
 113 <!-- END CONTENT -->
 114
 115
 116 <div id="footer">
 117 <p>
 118 Previous Topic:&nbsp;&nbsp;<a href="#">Previous Class</a>
 119 &nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
 120 <a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
 121 <a href="#">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
 122 Next Topic:&nbsp;&nbsp;<a href="#">Next Class</a>
 123 </p>
 124 <p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006 - 2011 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">EllisLab, Inc.</a></p>
 125 </div>
 126
 127 </body>
 128 </html>