blob: c01f85fb80ac68cafd3e798833bc76b35fc53f45 [file] [log] [blame]
Derek Jones9fbf6732008-01-21 19:21:29 +00001<!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<title>CodeIgniter Project Documentation Template</title>
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
10<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
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;
38Foo 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>Description of using Foo. Highlight variables and filenames in regular text with the <var>&lt;var&gt; tag</var>, and code using the <dfn>&lt;dfn&gt; tag</dfn>.</p>
68
69<code>
70 $this->load->library('foo');<br />
71 <br />
72 $this->foo->bar('bat');
73</code>
74
75
76<h2>Table Preferences</h2>
77
78<p>Use tables where appropriate for long lists of preferences.</p>
79
80
81<table cellpadding="0" cellspacing="1" border="0" style="width:100%" class="tableborder">
82<tr>
83 <th>Preference</th>
84 <th>Default&nbsp;Value</th>
85 <th>Options</th>
86 <th>Description</th>
87</tr>
88<tr>
89 <td class="td"><strong>foo</strong></td>
90 <td class="td">Foo</td>
91 <td class="td">None</td>
92 <td class="td">Description of foo.</td>
93</tr>
94<tr>
95 <td class="td"><strong>bar</strong></td>
96 <td class="td">Bar</td>
97 <td class="td">bat, bag, or bak</td>
98 <td class="td">Description of bar.</td>
99</tr>
100</table>
101
102<h2>Foo Function Reference</h2>
103
104<h3>$this->foo->bar()</h3>
105<p>Description</p>
106<code>$this->foo->bar('<var>baz</var>')</code>
107
108</div>
109<!-- END CONTENT -->
110
111
112<div id="footer">
113<p>
114Previous Topic:&nbsp;&nbsp;<a href="database/index.html">Previous Class</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="#">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
118Next Topic:&nbsp;&nbsp;<a href="#">Next Class</a>
119</p>
120<p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2007 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
121</div>
122
123</body>
124</html>