summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDerek Jones <derek.jones@ellislab.com>2008-01-21 20:21:29 +0100
committerDerek Jones <derek.jones@ellislab.com>2008-01-21 20:21:29 +0100
commit9fbf6730b18eeb55e6cd08dc26a9d2b6af2c7df0 (patch)
tree8f1651e79231ae433b464b9f41aa8a2b4b100e65
parent7a9193afa6d890a91eb3528fa0e62df799b07ed6 (diff)
added user guide template for developers to use in their own projects
-rw-r--r--user_guide/doc_style/index.html80
-rw-r--r--user_guide/doc_style/template.html124
-rw-r--r--user_guide/toc.html1
3 files changed, 205 insertions, 0 deletions
diff --git a/user_guide/doc_style/index.html b/user_guide/doc_style/index.html
new file mode 100644
index 000000000..eb78da1b7
--- /dev/null
+++ b/user_guide/doc_style/index.html
@@ -0,0 +1,80 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+
+<title>CodeIgniter User Guide : Writing Documentation</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="../nav/nav.js"></script>
+<script type="text/javascript" src="../nav/prototype.lite.js"></script>
+<script type="text/javascript" src="../nav/moo.fx.js"></script>
+<script type="text/javascript" src="../nav/user_guide_menu.js"></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='ExpressionEngine Dev Team' />
+<meta name='description' content='CodeIgniter 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>CodeIgniter User Guide Version 1.6.0</h1></td>
+<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</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://codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
+<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
+Writing Documentation
+</td>
+<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>
+</tr>
+</table>
+<!-- END BREADCRUMB -->
+
+<br clear="all" />
+
+
+<!-- START CONTENT -->
+<div id="content">
+
+<h1>Writing Documentation</h1>
+
+<p>To help facilitate a consistent, easy-to-read documentation style for CodeIgniter projects, Ellislab is making the markup and CSS from the CodeIgniter user guide freely available to the community for their use. For your convenience, a template file has been created that includes the primary blocks of markup used with brief samples.</p>
+
+<h2>Files</h2>
+
+<ul>
+ <li><a href="../userguide.css">Stylesheet</a></li>
+ <li><a href="./template.html">Page Template</a></li>
+</ul>
+
+
+</div>
+<!-- END CONTENT -->
+
+
+<div id="footer">
+<p><a href="#top">Top of Page</a></p>
+<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>
+</div>
+
+</body>
+</html> \ No newline at end of file
diff --git a/user_guide/doc_style/template.html b/user_guide/doc_style/template.html
new file mode 100644
index 000000000..c01f85fb8
--- /dev/null
+++ b/user_guide/doc_style/template.html
@@ -0,0 +1,124 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+
+<title>CodeIgniter Project Documentation Template</title>
+
+<style type='text/css' media='all'>@import url('./userguide.css');</style>
+<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
+
+<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' />
+
+</head>
+<body>
+
+<!-- START NAVIGATION -->
+<div id="nav"><div id="nav_inner"></div></div>
+<div id="nav2"><a name="top">&nbsp;</a></div>
+<div id="masthead">
+<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
+<tr>
+<td><h1>Project Title</h1></td>
+<td id="breadcrumb_right"><a href="#">Right Breadcrumb</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://example.com/">Project Home</a> &nbsp;&#8250;&nbsp;
+<a href="#">User Guide Home</a> &nbsp;&#8250;&nbsp;
+Foo Class
+</td>
+<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>
+</tr>
+</table>
+<!-- END BREADCRUMB -->
+
+<br clear="all" />
+
+
+<!-- START CONTENT -->
+<div id="content">
+
+
+<h1>Foo Class</h1>
+
+<p>Brief description of Foo Class. If it extends a native CodeIgniter class, please link to the class in the CodeIgniter documents here.</p>
+
+<p class="important"><strong>Important:</strong>&nbsp; This is an important note with <kbd>EMPHASIS</kbd>.</p>
+
+<p>Features:</p>
+
+<ul>
+ <li>Foo</li>
+ <li>Bar</li>
+</ul>
+
+<h2>Usage Heading</h2>
+
+<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>
+
+<code>
+ $this->load->library('foo');<br />
+ <br />
+ $this->foo->bar('bat');
+</code>
+
+
+<h2>Table Preferences</h2>
+
+<p>Use tables where appropriate for long lists of preferences.</p>
+
+
+<table cellpadding="0" cellspacing="1" border="0" style="width:100%" class="tableborder">
+<tr>
+ <th>Preference</th>
+ <th>Default&nbsp;Value</th>
+ <th>Options</th>
+ <th>Description</th>
+</tr>
+<tr>
+ <td class="td"><strong>foo</strong></td>
+ <td class="td">Foo</td>
+ <td class="td">None</td>
+ <td class="td">Description of foo.</td>
+</tr>
+<tr>
+ <td class="td"><strong>bar</strong></td>
+ <td class="td">Bar</td>
+ <td class="td">bat, bag, or bak</td>
+ <td class="td">Description of bar.</td>
+</tr>
+</table>
+
+<h2>Foo Function Reference</h2>
+
+<h3>$this->foo->bar()</h3>
+<p>Description</p>
+<code>$this->foo->bar('<var>baz</var>')</code>
+
+</div>
+<!-- END CONTENT -->
+
+
+<div id="footer">
+<p>
+Previous Topic:&nbsp;&nbsp;<a href="database/index.html">Previous Class</a>
+&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
+<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
+<a href="#">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
+Next Topic:&nbsp;&nbsp;<a href="#">Next Class</a>
+</p>
+<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>
+</div>
+
+</body>
+</html> \ No newline at end of file
diff --git a/user_guide/toc.html b/user_guide/toc.html
index 9a9784763..59ab2113e 100644
--- a/user_guide/toc.html
+++ b/user_guide/toc.html
@@ -178,6 +178,7 @@ Table of Contents
<li><a href="./general/quick_reference.html">Quick Reference Chart</a></li>
<li><a href="http://codeigniter.com/forums/">Community Forums</a></li>
<li><a href="http://codeigniter.com/wiki/">Community Wiki</a></li>
+<li><a href="./doc_style/index.html">Writing Documentation</a></li>
</ul>