doc fixes

5 files changed, 27 insertions, 175 deletions

diff --git a/user_guide/general/helpers.html b/user_guide/general/helpers.html
index 063ef720c..5569d9834 100644
--- a/user_guide/general/helpers.html
+++ b/user_guide/general/helpers.html
@@ -69,8 +69,7 @@ Each helper function performs one specific task, with no dependence on other fun
 <p>CodeIgniter does not load Helper Files by default, so the first step in using

 a Helper is to load it.  Once loaded, it becomes globally available in your <a href="../general/controllers.html">controller</a> and <a href="../general/views.html">views</a>.</p>

 

-<p>Helpers are typically stored in your <dfn>system/helpers</dfn> directory.  Alternately you can create a folder called <kbd>helpers</kbd> inside

-your <kbd>application</kbd> folder and store them there.  CodeIgniter will look first in your <dfn>system/application/helpers</dfn>

+<p>Helpers are typically stored in your <dfn>system/helpers</dfn>, or <dfn>system/application/helpers </dfn>directory.    CodeIgniter will look first in your <dfn>system/application/helpers</dfn>

 directory.  If the directory does not exist or the specified helper is not located there CI will instead look in your global

 <dfn>system/helpers</dfn> folder.</p>

 

@@ -149,7 +148,7 @@ function any_in_array($needle, $haystack)<br />
 function random_element($array)<br />

 {<br />

 &nbsp;&nbsp;&nbsp;&nbsp;shuffle($array);<br />

-&nbsp;&nbsp;&nbsp;&nbsp;return array_pop();<br />

+&nbsp;&nbsp;&nbsp;&nbsp;return array_pop($array);<br />

 }<br />

 </code>

 

diff --git a/user_guide/general/hooks.html b/user_guide/general/hooks.html
index 14e28d47f..11acc043e 100644
--- a/user_guide/general/hooks.html
+++ b/user_guide/general/hooks.html
@@ -122,7 +122,7 @@ $hook['pre_controller']<kbd>[]</kbd> = array(<br />
 

 <code>$hook['pre_controller']<kbd>[]</kbd></code>

 

-<p>This permits you to the same hook point with multiple scripts.  The order you define your array will be the execution order.</p>

+<p>This permits you to have the same hook point with multiple scripts.  The order you define your array will be the execution order.</p>

 

 

 <h2>Hook Points</h2>

@@ -130,45 +130,24 @@ $hook['pre_controller']<kbd>[]</kbd> = array(<br />
 <p>The following is a list of available hook points.</p>

 

 <ul>

-

-<li><strong>pre_system</strong><br />

-Called very early during system execution.  Only the benchmark and hooks class have been loaded at this point. No routing or other processes have happened.</li>

-

-<li><strong>pre_controller</strong><br />

-Called immediately prior to any of your controllers being called. All base classes, routing, and security checks have been done.</li>

-

-<li><strong>post_controller_constructor</strong><br />

-Called immediately after your controller is instantiated, but prior to any method calls happening.</li>

-

-<li><strong>post_controller</strong><br />

-Called immediately after your controller is fully executed.</li>

-

-<li><strong>display_override</strong><br />

-Overrides the <dfn>_display()</dfn> function, used to send the finalized page to the web browser at the end of system execution.  This permits you to

-use your own display methodology.  Note that the finalized data will be available by calling <dfn>$this->output->get_output()</dfn></li>

-

-<li><strong>cache_override</strong><br />

-Enables you to call your own function instead of the <dfn>_display_cache()</dfn> function in the output class.  This permits you to use your own cache display mechanism.</li>

-

-<li><strong>scaffolding_override</strong><br />

-Permits a scaffolding request to trigger your own script instead.</li>

-

-<li><strong>post_system</strong><br />

-Called after the final rendered page is sent to the browser, at the end of system execution after the finalized data is sent to the browser.</li>

-

-

-</ul>

-

-

-

-

-

-

-

-

-

-

-

+		<li><strong>pre_system</strong><br />

+			Called very early during system execution.  Only the benchmark and hooks class have been loaded at this point. No routing or other processes have happened.</li>

+		<li><strong>pre_controller</strong><br />

+			Called immediately prior to any of your controllers being called. All base classes, routing, and security checks have been done.</li>

+		<li><strong>post_controller_constructor</strong><br />

+			Called immediately after your controller is instantiated, but prior to any method calls happening.</li>

+		<li><strong>post_controller</strong><br />

+			Called immediately after your controller is fully executed.</li>

+		<li><strong>display_override</strong><br />

+			Overrides the <dfn>_display()</dfn> function, used to send the finalized page to the web browser at the end of system execution.  This permits you to

+			use your own display methodology.  Note that the finalized data will be available by calling <dfn>$this->output->get_output()</dfn></li>

+		<li><strong>cache_override</strong><br />

+			Enables you to call your own function instead of the <dfn>_display_cache()</dfn> function in the output class.  This permits you to use your own cache display mechanism.</li>

+		<li><strong>scaffolding_override</strong><br />

+			Permits a scaffolding request to trigger your own script instead.</li>

+		<li><strong>post_system</strong><br />

+			Called after the final rendered page is sent to the browser, at the end of system execution after the finalized data is sent to the browser.</li>

+	</ul>

 </div>

 <!-- END CONTENT -->

 

diff --git a/user_guide/helpers/index.html b/user_guide/helpers/index.html
deleted file mode 100644
index c46ac0487..000000000
--- a/user_guide/helpers/index.html
+++ /dev/null
@@ -1,126 +0,0 @@
-<!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 : Helper Functions</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.1</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;

-Helper Functions

-</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>Helper Functions</h1>

-

-<p>Helpers, as the name suggests, help you with tasks.  Each helper file is simply a collection of functions in a particular

-category.  There are <dfn>URL Helpers</dfn>, that assist in creating links, there are <dfn>Form Helpers</dfn>

-that help you create form elements, <dfn>Text Helpers</dfn> perform various text formatting routines,

-<dfn>Cookie Helpers</dfn> set and read cookies, <dfn>File Helpers</dfn> help you deal with files, etc.

-</p>

-

-<p>Unlike most other systems in CodeIgniter, Helpers are not written in an Object Oriented format.  They are simple, procedural functions.

-Each helper function performs one specific task, with no dependence on other functions.</p>

-

-<p>Helpers are intentionally kept very simple so that they can be used within your <strong>View Files</strong> with a minimal amount of code.

-This is important if you intend to have designers or non-programmer will be working with your view files, since it keeps the code to a minimum.

-</p>

-

-<p>CodeIgniter does not load Helper Files by default, so the first step in using

-a Helper is to load it.  Once loaded, it becomes globally available in your <a href="../general/controllers.html">controller</a> and <a href="../general/views.html">views</a>.</p>

-

-<h2>Loading a Helper</h2>

-

-<p>Loading a helper file is quite simple using the following function:</p>

-

-<code>$this->load->helper('<var>name</var>');</code>

-

-<p>Where <var>name</var> is the file name of the helper, without the .php file extension or the "helper" part.</p>

-

-<p>For example, to load the <dfn>URL Helper</dfn> file, which is named <var>url_helper.php</var>, you would do this:</p>

-

-<code>$this->load->helper('<var>url</var>');</code>

-

-<p>A helper can be loaded anywhere within your controller functions (or even within your View files, although that's not a good practice),

-as long as you load it before you use it.  You can load your helpers in your controller constructor so that they become available

-automatically in any function, or you can load a helper in a specific function that needs it.</p>

-

-<p class="important">Note: The Helper loading function above does not return a value, so don't try to assign it to a variable.  Just use it as shown.</p>

-

-<h2>Auto-loading Helpers</h2>

-

-<p>If you find that you need a particular helper globally throughout your application, you can tell CodeIgniter to auto-load it during system initialization.

-This is done by opening the <var>application/config/autoload.php</var> file and adding the helper to the autoload array.</p>

-

-

-<h2>Using a Helper</h2>

-

-<p>Once you've loaded the Helper File containing the function you intend to use, you'll call it the way you would a standard PHP function.</p>

-

-<p>For example, to create a link using the <dfn>anchor()</dfn> function in one of your view files you would do this:</p>

-

-<code>&lt;?=anchor('blog/comments', 'Click Here');?&gt;</code>

-

-<p>Where "Click Here" is the name of the link, and "blog/comments" is the URI to the controller/function you wish to link to.</p>

-

-

-<h2>Now What?</h2>

-

-<p>In the <a href="../toc.html">Table of Contents</a> you'll find a list of all the available Helper Files.  Browse each one to see what they do.</p>

-

-

-</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; 2006-2008 &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/helpers/smiley_helper.html b/user_guide/helpers/smiley_helper.html
index 15f9de066..7829f461b 100644
--- a/user_guide/helpers/smiley_helper.html
+++ b/user_guide/helpers/smiley_helper.html
@@ -97,7 +97,7 @@ your <dfn>smiley</dfn> folder.</p>
 <p>You'll notice that in addition to the smiley helper we are using the <a href="../libraries/table.html">Table Class</a>.</p>

 

 <textarea class="textarea" style="width:100%" cols="50" rows="25">

-<?php

+&lt;?php

 

 class Smileys extends Controller {

 

@@ -121,7 +121,7 @@ class Smileys extends Controller {
 	}

 	

 }

-?>

+?&gt;

 </textarea>

 

 <p>In your <dfn>application/views/</dfn> folder, create a file called <kbd>smiley_view.php</kbd> and place this code in it:</p>

@@ -157,7 +157,7 @@ class Smileys extends Controller {
 

 <h2>get_clickable_smileys()</h2>

 

-<p>Returns an array containing your smiley images wrapped in a cliackable link.  You must supply the URL to your smiley folder

+<p>Returns an array containing your smiley images wrapped in a clickable link.  You must supply the URL to your smiley folder

 via the first parameter:</p>

 

 <code>$image_array = get_clickable_smileys("http://www.your-site.com/images/smileys/");</code>

@@ -175,7 +175,7 @@ form field. This function is designed to be placed into the &lt;head&gt; area of
 <h2>parse_smileys()</h2>

 

 <p>Takes a string of text as input and replaces any contained plain text smileys into the image

-equivalent.  The first parameter must contain your string, the second must contain the the URL to your smiley folder:</p>

+equivalent.  The first parameter must contain your string, the second must contain  the URL to your smiley folder:</p>

 

 <code>

 

diff --git a/user_guide/libraries/zip.html b/user_guide/libraries/zip.html
index 484bbac64..7ee4d7be3 100644
--- a/user_guide/libraries/zip.html
+++ b/user_guide/libraries/zip.html
@@ -159,7 +159,7 @@ $this->zip->read_file($path);
 $this->zip->download('my_backup.zip');

 </code>

 

-<p>If you would like the Zip archive to maintain the directory structure the file is in, pass <kbd>TRUE</kbd> (boolean) in the

+<p>If you would like the Zip archive to maintain the directory structure of the file in it, pass <kbd>TRUE</kbd> (boolean) in the

 second parameter.  Example:</p>

 

 

@@ -202,7 +202,7 @@ directory is writable (666 or 777 is usually OK). Example:</p>
 

 <h2>$this->zip->download()</h2>

 

-<p>Causes the Zip file to be downloaded to your server. The function must be passed the name you would like the zip file called.

+<p>Causes the Zip file to be downloaded from your server. The function must be passed the name you would like the zip file called.

 Example:</p>

 

 <code>$this->zip->download('latest_stuff.zip'); // File will be named "latest_stuff.zip"</code>