From 8bef54f488996ec6193204dcdd576c7c9402a044 Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Fri, 19 Jul 2013 14:16:17 -0700
Subject: whitespace in css file

---
 .../_themes/eldocs/static/asset/css/common.css     | 136 ++++++++++-----------
 1 file changed, 68 insertions(+), 68 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/_themes/eldocs/static/asset/css/common.css b/user_guide_src/source/_themes/eldocs/static/asset/css/common.css
index 648e33032..10e4de1d5 100644
--- a/user_guide_src/source/_themes/eldocs/static/asset/css/common.css
+++ b/user_guide_src/source/_themes/eldocs/static/asset/css/common.css
@@ -22,7 +22,7 @@ http://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
 
 html, body,
 h1, h2, h3, h4, h5, h6,
-p, ul, ol, li, dl, dd, dt, pre, form, fieldset{ margin: 0; padding: 0; } 
+p, ul, ol, li, dl, dd, dt, pre, form, fieldset{ margin: 0; padding: 0; }
 
 body{ background-color: #F9F9F9; color: #444444; font: normal normal 14px "Helvetica", "Arial", Sans-Serif; }
 
@@ -34,10 +34,10 @@ pre,
 #table-contents .toctree-wrapper{ font-size: 12px; }
 
 dfn, var,
-em.dfn, em.var{ 
-	background-color: #FFFDED; 
-	color: #578236; 
-	font-style: italic; 
+em.dfn, em.var{
+	background-color: #FFFDED;
+	color: #578236;
+	font-style: italic;
 	padding: 3px;
 }
 
@@ -53,7 +53,7 @@ h2{ font-size: 24px; font-weight: normal; }
 
 h1, h2, h3, h4, h5, h6{ margin-bottom: 20px; }
 
-h2, h3{ border-bottom: 2px solid #EEEEEE; padding: 0 0 3px; }	
+h2, h3{ border-bottom: 2px solid #EEEEEE; padding: 0 0 3px; }
 
 h3{ border-color: #E5E5E5; border-width: 1px; }
 
@@ -62,7 +62,7 @@ h4{ background-color: #FFFDED; display: inline-block; font-size: 18px; margin: 0
 	h1 a, h2 a{ font-weight: normal; }
 
 	h1 a, h2 a, h3 a{ text-decoration: none; }
-	
+
 h3, h5, h6{ font-size: 18px; margin: 20px 0; }
 
 	h4, h5, h6{ font-size: 14px; }
@@ -75,55 +75,55 @@ p, dl, ul, ol{ margin: 20px 0; }
 	li > ol{ margin: 0; margin-left: 40px; }
 
 	dl > dd{ margin-left: 20px; }
-	
+
 	li > p { margin: 0; }
 
 #expressionengine-user-guide li em { font-style: normal; }
 
 p, li, dd, dt, pre{ line-height: 1.5; }
 
-table{ 
+table{
 	background-color: #F5FBFF;
 	border: 1px solid #C8DEF0;
 	border-collapse: collapse;
 	margin-bottom: 20px;
 }
 
-	th, td{ 
-		border: 0; 
+	th, td{
+		border: 0;
 		border-bottom: 1px solid #C8DEF0;
-		padding: 8px; 
+		padding: 8px;
 	}
-	
-		th{ 
-			background-color: #326B95; 
+
+		th{
+			background-color: #326B95;
 			color: #FFFFFF;
-			text-align: left; 
+			text-align: left;
 		}
-	
+
 		td{ font-size: 12px; }
 
 	.descname{ color: #000080; font-weight: bold; }
 	.descclassname{ color: #094776; }
-	
+
 	.class .descname{ font-size: 18px; font-style: italic; }
 	.method .descname{ font-style: normal; }
-	
+
 	.class .property{ color: #094776; }
-	
+
 	.method big,
 	.method .optional{ color: #094776; padding: 0 4px 0 6px; }
-	
+
 	.class em,
 	.method em{ color: #008080; }
-	
+
 	.method dt{ margin: 20px 0; }
-		
+
 	.method table{ margin-bottom: 0; margin-left: 20px; }
-	
+
 	.method th,
 	.method td{ padding: 10px; }
-	
+
 	.method td > ul{ margin: 0; margin-left: 20px; }
 	.method td.field-body > p { margin: 0; margin-left: 20px; }
 
@@ -137,7 +137,7 @@ a.headerlink{ visibility: hidden; }
 
 	:hover > a.headerlink { visibility: visible; }
 
-a img{ 
+a img{
 	border: 0;
 	outline: 0;
 }
@@ -158,36 +158,36 @@ fieldset{ border: 0; }
 .highlight-perl,
 .highlight-php,
 .cp-path,
-.codeblock{ 
-	background-color: #F9FEFF; 
-	border: 1px solid #C8DEF0; 
+.codeblock{
+	background-color: #F9FEFF;
+	border: 1px solid #C8DEF0;
 	-moz-box-shadow: 4px 4px 0 rgba(0,0,0,0.03);
 	-webkit-box-shadow: 4px 4px 0 rgba(0,0,0,0.03);
 	box-shadow: 4px 4px 0 rgba(0,0,0,0.03);
-	margin: 20px 0; 
-	padding: 10px 10px 8px; 
+	margin: 20px 0;
+	padding: 10px 10px 8px;
 }
 
 .highlight-ci{ background-color: #FEFEFE; border-color: #E5E5E5; }
 
 	.admonition p{ margin: 0; }
-	
+
 	.codeblock{ margin: 10px 0; }
-	
+
 	.cp-path{ background-color: #FAFFF6; border-color: #D1CDB0; }
 	.important, .note{ background-color: #FFFFF2; border-color: #C8C8A5; }
-	
-.admonition-title{ 
+
+.admonition-title{
 	float: left;
-	font-weight: bold;  
-	padding-right: 4px; 
-	text-transform: uppercase; 
+	font-weight: bold;
+	padding-right: 4px;
+	text-transform: uppercase;
 }
 
 .admonition-title:after{ content: ':  '; }
 
 .highlighted{ background-color: #FFF09B; }
-	
+
 #table-contents{
 	bottom: 0;
 	left: -520px;
@@ -195,7 +195,7 @@ fieldset{ border: 0; }
 	top: 0;
 }
 
-#table-contents .toctree-wrapper{ 
+#table-contents .toctree-wrapper{
 	background-color: #444444;
 	background-color: rgba(0,0,0,0.9);
 	*+background-color: #444444;
@@ -209,16 +209,16 @@ fieldset{ border: 0; }
 }
 
 	#table-contents .toctree-wrapper ul{margin-bottom: 0; margin-top: 0; }
-	
+
 		#table-contents .toctree-wrapper li{ color: #999999; line-height: 1.7; padding: 1px 0; }
-		
+
 			#table-contents .toctree-l1{ list-style-type: none; }
-		
-			#table-contents .toctree-l1 > a{ 
-				background: transparent url(../../asset/img/paper-ico.gif) no-repeat 0 0; 
-				font-size: 14px; 
+
+			#table-contents .toctree-l1 > a{
+				background: transparent url(../../asset/img/paper-ico.gif) no-repeat 0 0;
+				font-size: 14px;
 				font-weight: bold;
-				padding-left: 20px; 
+				padding-left: 20px;
 			}
 
 	#header a:link,
@@ -233,15 +233,15 @@ fieldset{ border: 0; }
 
 #content{ background-color: #FFFFFF; padding: 40px 40px 20px; }
 
-#brand{ 
-	background-color: #F5F5F5; 
-	color: #FFFFFF; 
+#brand{
+	background-color: #F5F5F5;
+	color: #FFFFFF;
 	overflow: hidden;
-	padding: 10px 20px 13px; 
+	padding: 10px 20px 13px;
 }
 
 	#brand > *{ float: left; }
-	
+
 	#brand p{ font-size: 14px; margin: 2px 0 0 5px; }
 	#brand.ci p{ margin-top: 8px; }
 
@@ -250,18 +250,18 @@ fieldset{ border: 0; }
 	#brand.mm{ background-color: #222627; }
 	#brand.el{ background-color: #4A0202; }
 
-#header{ 
+#header{
 	background-color: #3B7EB0;
 	border-top: 2px solid #539ECC;
-	color: #FFFFFF; 
-	overflow: hidden; 
-	padding: 15px 15px 16px 20px; 
+	color: #FFFFFF;
+	overflow: hidden;
+	padding: 15px 15px 16px 20px;
 }
 
 	#header form{ float: right; overflow: hidden; }
-	
+
 	#header input{ float: left; }
-	
+
 	#header input[type="text"]{
 		background-color: #FFFFFF;
 		border: 1px solid;
@@ -271,9 +271,9 @@ fieldset{ border: 0; }
 		padding: 5px;
 		width: 175px;
 	}
-	
+
 		#header input[type="text"]:focus{ background-color: #FFFDED; outline: 0; }
-		
+
 	#header input[type="submit"]{
 		background: #F0F9FF url(../../asset/img/grades.gif) repeat-x 0 -58px;
 		border: 1px solid #033861;
@@ -283,18 +283,18 @@ fieldset{ border: 0; }
 		padding: 5px 10px 4px;
 		text-transform: uppercase;
 	}
-	
+
 		#header input[type="submit"]:hover{ background-position: 0 -83px; }
-	
-	#header ul{ 
+
+	#header ul{
 		float: left;
 		list-style-type: none;
-		margin: 0; 
+		margin: 0;
 		overflow: hidden;
 	}
-	
+
 		#header li{ float: left; margin: 4px 5px 0 0; }
-		
+
 #footer{ background-color: #F9F9F9; border-top: 1px solid #CCCCCC; padding: 20px; }
 
 	#footer p{ margin: 0; }
@@ -322,8 +322,8 @@ fieldset{ border: 0; }
 	-webkit-box-sizing: border-box;
 	box-sizing: border-box;
 	margin-bottom: 10px;
-	resize: none; 
-	width: 100%; 
+	resize: none;
+	width: 100%;
 }
 
 #comment_form input[type="submit"]{ margin-top: 10px; }
-- 
cgit v1.2.3-24-g4f1b


From 6290ed1922842812dddcfdaeb4973babc6ed8436 Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Fri, 19 Jul 2013 14:16:43 -0700
Subject: adding HTML highlight block rule

---
 user_guide_src/source/_themes/eldocs/static/asset/css/common.css | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/_themes/eldocs/static/asset/css/common.css b/user_guide_src/source/_themes/eldocs/static/asset/css/common.css
index 10e4de1d5..d1e9fe2d9 100644
--- a/user_guide_src/source/_themes/eldocs/static/asset/css/common.css
+++ b/user_guide_src/source/_themes/eldocs/static/asset/css/common.css
@@ -157,6 +157,7 @@ fieldset{ border: 0; }
 .highlight-bash,
 .highlight-perl,
 .highlight-php,
+.highlight-html,
 .cp-path,
 .codeblock{
 	background-color: #F9FEFF;
-- 
cgit v1.2.3-24-g4f1b


From e7dfb679cf4f1a683d837aaea94b5b5125204779 Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Fri, 19 Jul 2013 14:16:56 -0700
Subject: updating XML helper docs

---
 user_guide_src/source/helpers/xml_helper.rst | 42 ++++++++++++++++++++--------
 1 file changed, 30 insertions(+), 12 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/helpers/xml_helper.rst b/user_guide_src/source/helpers/xml_helper.rst
index be848bcd1..681408e03 100644
--- a/user_guide_src/source/helpers/xml_helper.rst
+++ b/user_guide_src/source/helpers/xml_helper.rst
@@ -5,7 +5,9 @@ XML Helper
 The XML Helper file contains functions that assist in working with XML
 data.
 
-.. contents:: Page Contents
+
+.. contents::
+  :local:
 
 Loading this Helper
 ===================
@@ -16,23 +18,39 @@ This helper is loaded using the following code
 
 	$this->load->helper('xml');
 
+Available Functions
+===================
+
 The following functions are available:
 
+
 xml_convert()
-=====================
+-------------
 
-Takes a string as input and converts the following reserved XML
-characters to entities:
+.. method:: xml_convert($str[, $protect_all = FALSE])
 
-- Ampersands: &
-- Less then and greater than characters: < >
-- Single and double quotes: ' "
-- Dashes: -
+  :param string $str: the text string to convert
+  :param bool $protect_all: Whether to protect all content that looks like a potential entity instead of just numbered entities, e.g. &foo;
+  :returns: converted string
+  :rtype: string
 
-This function ignores ampersands if they are part of existing character
-entities. Example
+  Takes a string as input and converts the following reserved XML
+  characters to entities:
 
-::
+  - Ampersands: &
+  - Less then and greater than characters: < >
+  - Single and double quotes: ' "
+  - Dashes: -
+
+  This function ignores ampersands if they are part of existing numbered
+  character entities, e.g. &#123;. Example::
+
+    $string = '<p>Here is a paragraph & an entity (&#123;).</p>';
+    $string = xml_convert($string);
+    echo $string;
+
+  outputs:
 
-	$string = xml_convert($string);
+  .. code-block:: html
 
+    &lt;p&gt;Here is a paragraph &amp; an entity (&#123;).&lt;/p&gt;
-- 
cgit v1.2.3-24-g4f1b


From 1e617c9b0cab036cff4de14f36ba9a2903462e51 Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Fri, 19 Jul 2013 15:34:49 -0700
Subject: Allowing creation of dynamic local ToC for method / function names

---
 user_guide_src/source/_themes/eldocs/layout.html   | 12 +++---
 .../_themes/eldocs/static/asset/js/method-toc.js   | 44 ++++++++++++++++++++++
 2 files changed, 51 insertions(+), 5 deletions(-)
 create mode 100644 user_guide_src/source/_themes/eldocs/static/asset/js/method-toc.js

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/_themes/eldocs/layout.html b/user_guide_src/source/_themes/eldocs/layout.html
index 7f2fe1a34..535c2f194 100644
--- a/user_guide_src/source/_themes/eldocs/layout.html
+++ b/user_guide_src/source/_themes/eldocs/layout.html
@@ -31,7 +31,7 @@
 	    {%- for cssfile in css_files %}
 	    <link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
 	    {%- endfor %}
-	
+
     {%- if not embedded %}
 	    <script type="text/javascript">
 	      var DOCUMENTATION_OPTIONS = {
@@ -46,11 +46,13 @@
 	    <script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
 	    {%- endfor %}
 
+	    <script type="text/javascript" src="{{ pathto('_static/asset/js/method-toc.js', 1) }}"></script>
+
 	    {%- if favicon %}
 	    <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
 	    {%- endif %}
 	{%- endif %}
-	
+
 	{%- block linktags %}
 	    {%- if hasdoc('about') %}
 	    <link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" />
@@ -96,7 +98,7 @@
 				{%- block rootrellink %}
 				<li><a href="{{ pathto(master_doc) }}">User Guide Home</a>{%- if pagename != 'index' %}&nbsp;&nbsp;{{ reldelim1 }}{%- endif %}</li>
 				{%- endblock %}
-				
+
 				{%- for parent in parents %}
 				<li><a href="{{ parent.link|e }}" {% if loop.last %}{{ accesskey("U") }}{% endif %}>{{ parent.title }}</a>&nbsp;&nbsp; {{ reldelim1 }}</li>
 		        {%- endfor %}
@@ -117,8 +119,8 @@
 		{% if pagename not in exclude_comments -%}
 		<!-- {user_guide_comments} -->
 		{% endif %}
-	
-	{%- block footer %}			
+
+	{%- block footer %}
 		<div id="footer">
 			<p class="top"><a href="#header" title="Return to top">Return to top</a></p>
 			<p><a href="http://{{ project_domain }}/">{{ project }}</a> &ndash; Copyright &copy; {{ copyright }}</a></p>
diff --git a/user_guide_src/source/_themes/eldocs/static/asset/js/method-toc.js b/user_guide_src/source/_themes/eldocs/static/asset/js/method-toc.js
new file mode 100644
index 000000000..92024c70a
--- /dev/null
+++ b/user_guide_src/source/_themes/eldocs/static/asset/js/method-toc.js
@@ -0,0 +1,44 @@
+/* modified from http://stackoverflow.com/a/12459801 */
+$(function (){
+    var createList = function(selector){
+
+        var ul = $('<ul>');
+        var selected = $(selector);
+
+        if (selected.length === 0){
+            return;
+        }
+
+        selected.clone().each(function (i,e){
+
+            var p = $(e).children('.descclassname');
+            var n = $(e).children('.descname');
+            var l = $(e).children('.headerlink');
+
+            var a = $('<a>');
+            a.attr('href',l.attr('href')).attr('title', 'Link to this definition');
+
+            a.append(p).append(n);
+
+            var entry = $('<li>').append(a);
+            ul.append(entry);
+        });
+        return ul;
+    }
+
+    var c = $('<div>');
+
+    var ul0 = c.clone().append($('.submodule-index'))
+
+    customIndex = $('.custom-index');
+    customIndex.empty();
+    customIndex.append(ul0);
+
+    var l = createList('dl.method > dt');
+    if (l) {
+        var ul = c.clone()
+            .append('<h3>Methods / Function</h3>')
+            .append(l);
+    }
+    customIndex.append(ul);
+});
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 65d4f7e1d239a44c4ba39f48b1b214546c8e1536 Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Fri, 19 Jul 2013 15:35:36 -0700
Subject: Adding function ToC to XML Helper

---
 user_guide_src/source/helpers/xml_helper.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/helpers/xml_helper.rst b/user_guide_src/source/helpers/xml_helper.rst
index 681408e03..3ac6a08bb 100644
--- a/user_guide_src/source/helpers/xml_helper.rst
+++ b/user_guide_src/source/helpers/xml_helper.rst
@@ -9,6 +9,10 @@ data.
 .. contents::
   :local:
 
+.. raw:: html
+
+  <div class="custom-index container"></div>
+
 Loading this Helper
 ===================
 
@@ -23,10 +27,6 @@ Available Functions
 
 The following functions are available:
 
-
-xml_convert()
--------------
-
 .. method:: xml_convert($str[, $protect_all = FALSE])
 
   :param string $str: the text string to convert
-- 
cgit v1.2.3-24-g4f1b


From 1b9d1d2cc8ef1d6bd592fffcbbf4a575c523c97a Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Fri, 19 Jul 2013 15:36:18 -0700
Subject: whitespace in XML Helper docs

---
 user_guide_src/source/helpers/xml_helper.rst | 1 -
 1 file changed, 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/helpers/xml_helper.rst b/user_guide_src/source/helpers/xml_helper.rst
index 3ac6a08bb..881bf2db7 100644
--- a/user_guide_src/source/helpers/xml_helper.rst
+++ b/user_guide_src/source/helpers/xml_helper.rst
@@ -5,7 +5,6 @@ XML Helper
 The XML Helper file contains functions that assist in working with XML
 data.
 
-
 .. contents::
   :local:
 
-- 
cgit v1.2.3-24-g4f1b


From 22c9b804d53e15f6b582ee7961f9c2087fd33dbb Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Fri, 19 Jul 2013 15:38:06 -0700
Subject: simplify xml_convert method block

---
 user_guide_src/source/helpers/xml_helper.rst | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/helpers/xml_helper.rst b/user_guide_src/source/helpers/xml_helper.rst
index 881bf2db7..cd199095a 100644
--- a/user_guide_src/source/helpers/xml_helper.rst
+++ b/user_guide_src/source/helpers/xml_helper.rst
@@ -30,8 +30,7 @@ The following functions are available:
 
   :param string $str: the text string to convert
   :param bool $protect_all: Whether to protect all content that looks like a potential entity instead of just numbered entities, e.g. &foo;
-  :returns: converted string
-  :rtype: string
+  :returns: string
 
   Takes a string as input and converts the following reserved XML
   characters to entities:
-- 
cgit v1.2.3-24-g4f1b


From 1132b9c41f57f01eb624d4b04684ba077971371e Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Fri, 19 Jul 2013 15:39:31 -0700
Subject: pluralization

---
 user_guide_src/source/_themes/eldocs/static/asset/js/method-toc.js | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/_themes/eldocs/static/asset/js/method-toc.js b/user_guide_src/source/_themes/eldocs/static/asset/js/method-toc.js
index 92024c70a..5d5a19509 100644
--- a/user_guide_src/source/_themes/eldocs/static/asset/js/method-toc.js
+++ b/user_guide_src/source/_themes/eldocs/static/asset/js/method-toc.js
@@ -37,7 +37,7 @@ $(function (){
     var l = createList('dl.method > dt');
     if (l) {
         var ul = c.clone()
-            .append('<h3>Methods / Function</h3>')
+            .append('<h3>Methods / Functions</h3>')
             .append(l);
     }
     customIndex.append(ul);
-- 
cgit v1.2.3-24-g4f1b


From 8e64fd316b04686273055de286b698061b17e905 Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Fri, 19 Jul 2013 15:55:37 -0700
Subject: Adding CSS needed for function/method differences

---
 .../_themes/eldocs/static/asset/css/common.css     | 24 +++++++++++++++-------
 .../_themes/eldocs/static/asset/js/method-toc.js   |  4 ++--
 2 files changed, 19 insertions(+), 9 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/_themes/eldocs/static/asset/css/common.css b/user_guide_src/source/_themes/eldocs/static/asset/css/common.css
index d1e9fe2d9..d5b0e21bc 100644
--- a/user_guide_src/source/_themes/eldocs/static/asset/css/common.css
+++ b/user_guide_src/source/_themes/eldocs/static/asset/css/common.css
@@ -112,20 +112,30 @@ table{
 	.class .property{ color: #094776; }
 
 	.method big,
-	.method .optional{ color: #094776; padding: 0 4px 0 6px; }
+	.method .optional
+	.function big,
+	.function .optional{ color: #094776; padding: 0 4px 0 6px; }
 
 	.class em,
-	.method em{ color: #008080; }
+	.method em,
+	.function em{ color: #008080; }
 
-	.method dt{ margin: 20px 0; }
+	.method dt,
+	.function dt{ margin: 20px 0; }
 
-	.method table{ margin-bottom: 0; margin-left: 20px; }
+	.method table,
+	.function table{ margin-bottom: 0; margin-left: 20px; }
 
 	.method th,
-	.method td{ padding: 10px; }
+	.method td,
+	.function th,
+	.function td{ padding: 10px; }
 
-	.method td > ul{ margin: 0; margin-left: 20px; }
-	.method td.field-body > p { margin: 0; margin-left: 20px; }
+	.method td > ul,
+	.function td > ul{ margin: 0; margin-left: 20px; }
+
+	.method td.field-body > p,
+	.function td.field-body > p { margin: 0; margin-left: 20px; }
 
 a:link,
 a:visited{ color: #1A5B8D; }
diff --git a/user_guide_src/source/_themes/eldocs/static/asset/js/method-toc.js b/user_guide_src/source/_themes/eldocs/static/asset/js/method-toc.js
index 5d5a19509..b6ac96469 100644
--- a/user_guide_src/source/_themes/eldocs/static/asset/js/method-toc.js
+++ b/user_guide_src/source/_themes/eldocs/static/asset/js/method-toc.js
@@ -16,7 +16,7 @@ $(function (){
             var l = $(e).children('.headerlink');
 
             var a = $('<a>');
-            a.attr('href',l.attr('href')).attr('title', 'Link to this definition');
+            a.attr('href',l.attr('href')).attr('title', 'jump to ' + n = '()');
 
             a.append(p).append(n);
 
@@ -34,7 +34,7 @@ $(function (){
     customIndex.empty();
     customIndex.append(ul0);
 
-    var l = createList('dl.method > dt');
+    var l = createList('dl.method > dt, dl.function > dt');
     if (l) {
         var ul = c.clone()
             .append('<h3>Methods / Functions</h3>')
-- 
cgit v1.2.3-24-g4f1b


From 5ef1ea7d932d74b084eedcd793bbaaa2d4b7f954 Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Fri, 19 Jul 2013 15:58:42 -0700
Subject: syntax typo

---
 user_guide_src/source/_themes/eldocs/static/asset/js/method-toc.js | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/_themes/eldocs/static/asset/js/method-toc.js b/user_guide_src/source/_themes/eldocs/static/asset/js/method-toc.js
index b6ac96469..a926b3da9 100644
--- a/user_guide_src/source/_themes/eldocs/static/asset/js/method-toc.js
+++ b/user_guide_src/source/_themes/eldocs/static/asset/js/method-toc.js
@@ -16,7 +16,7 @@ $(function (){
             var l = $(e).children('.headerlink');
 
             var a = $('<a>');
-            a.attr('href',l.attr('href')).attr('title', 'jump to ' + n = '()');
+            a.attr('href',l.attr('href')).attr('title', 'jump to ' + n + '()');
 
             a.append(p).append(n);
 
-- 
cgit v1.2.3-24-g4f1b


From 261ba1cfadc13340f169556b7aeba2fd7ac2f570 Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Fri, 19 Jul 2013 16:01:32 -0700
Subject: semantic correction function -> method

---
 user_guide_src/source/helpers/xml_helper.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/helpers/xml_helper.rst b/user_guide_src/source/helpers/xml_helper.rst
index cd199095a..6d26c581e 100644
--- a/user_guide_src/source/helpers/xml_helper.rst
+++ b/user_guide_src/source/helpers/xml_helper.rst
@@ -26,7 +26,7 @@ Available Functions
 
 The following functions are available:
 
-.. method:: xml_convert($str[, $protect_all = FALSE])
+.. function:: xml_convert($str[, $protect_all = FALSE])
 
   :param string $str: the text string to convert
   :param bool $protect_all: Whether to protect all content that looks like a potential entity instead of just numbered entities, e.g. &foo;
-- 
cgit v1.2.3-24-g4f1b


From abbf518a5ec7c81bf928ced417b7670490f0f0d3 Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Fri, 19 Jul 2013 16:01:52 -0700
Subject: Update URL Helper docs

---
 user_guide_src/source/helpers/url_helper.rst | 408 +++++++++++++--------------
 1 file changed, 195 insertions(+), 213 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/helpers/url_helper.rst b/user_guide_src/source/helpers/url_helper.rst
index 7a49f188d..24c7e259f 100644
--- a/user_guide_src/source/helpers/url_helper.rst
+++ b/user_guide_src/source/helpers/url_helper.rst
@@ -4,7 +4,12 @@ URL Helper
 
 The URL Helper file contains functions that assist in working with URLs.
 
-.. contents:: Page Contents
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
 
 Loading this Helper
 ===================
@@ -15,371 +20,348 @@ This helper is loaded using the following code::
 
 The following functions are available:
 
-site_url()
-==========
+Available Functions
+===================
 
-.. php:function:: site_url($uri = '', $protocol = NULL)
+.. function:: site_url([$uri = ''[, $protocol = NULL]])
 
 	:param	string	$uri: URI string
 	:param	string	$protocol: Protocol, e.g. 'http' or 'https'
 	:returns:	string
 
-Returns your site URL, as specified in your config file. The index.php
-file (or whatever you have set as your site **index_page** in your config
-file) will be added to the URL, as will any URI segments you pass to the
-function, plus the **url_suffix** as set in your config file.
+	Returns your site URL, as specified in your config file. The index.php
+	file (or whatever you have set as your site **index_page** in your config
+	file) will be added to the URL, as will any URI segments you pass to the
+	function, plus the **url_suffix** as set in your config file.
+
+	You are encouraged to use this function any time you need to generate a
+	local URL so that your pages become more portable in the event your URL
+	changes.
 
-You are encouraged to use this function any time you need to generate a
-local URL so that your pages become more portable in the event your URL
-changes.
+	Segments can be optionally passed to the function as a string or an
+	array. Here is a string example::
 
-Segments can be optionally passed to the function as a string or an
-array. Here is a string example::
+		echo site_url('news/local/123');
 
-	echo site_url('news/local/123');
+	The above example would return something like:
+	*http://example.com/index.php/news/local/123*
 
-The above example would return something like:
-*http://example.com/index.php/news/local/123*
+	Here is an example of segments passed as an array::
 
-Here is an example of segments passed as an array::
+		$segments = array('news', 'local', '123');
+		echo site_url($segments);
 
-	$segments = array('news', 'local', '123');
-	echo site_url($segments);
+	This function is an alias for ``CI_Config::site_url()``. For more info,
+	please see the :doc:`Config Library <../libraries/config>` documentation.
 
-This function is an alias for ``CI_Config::site_url()``. For more info,
-please see the :doc:`Config Library <../libraries/config>` documentation.
 
-base_url()
-===========
 
-.. php:function:: base_url($uri = '', $protocol = NULL)
+.. function:: base_url($uri = '', $protocol = NULL)
 
 	:param	string	$uri: URI string
 	:param	string	$protocol: Protocol, e.g. 'http' or 'https'
 	:returns:	string
 
-Returns your site base URL, as specified in your config file. Example::
+	Returns your site base URL, as specified in your config file. Example::
 
-	echo base_url();
+		echo base_url();
 
-This function returns the same thing as :php:func:`site_url()`, without
-the *index_page* or *url_suffix* being appended.
+	This function returns the same thing as :func:`site_url()`, without
+	the *index_page* or *url_suffix* being appended.
 
-Also like :php:func:`site_url()`, you can supply segments as a string or
-an array. Here is a string example::
+	Also like :func:`site_url()`, you can supply segments as a string or
+	an array. Here is a string example::
 
-	echo base_url("blog/post/123");
+		echo base_url("blog/post/123");
 
-The above example would return something like:
-*http://example.com/blog/post/123*
+	The above example would return something like:
+	*http://example.com/blog/post/123*
 
-This is useful because unlike :php:func:`site_url()`, you can supply a
-string to a file, such as an image or stylesheet. For example::
+	This is useful because unlike :func:`site_url()`, you can supply a
+	string to a file, such as an image or stylesheet. For example::
 
-	echo base_url("images/icons/edit.png");
+		echo base_url("images/icons/edit.png");
 
-This would give you something like:
-*http://example.com/images/icons/edit.png*
+	This would give you something like:
+	*http://example.com/images/icons/edit.png*
 
-This function is an alias for ``CI_Config::base_url()``. For more info,
-please see the :doc:`Config Library <../libraries/config>` documentation.
+	This function is an alias for ``CI_Config::base_url()``. For more info,
+	please see the :doc:`Config Library <../libraries/config>` documentation.
 
-current_url()
-=============
 
-.. php:function:: current_url()
+.. function:: current_url()
 
 	:returns:	string
 
-Returns the full URL (including segments) of the page being currently
-viewed.
+	Returns the full URL (including segments) of the page being currently
+	viewed.
 
-.. note:: Calling this function is the same as doing this:
-	|
-	| site_url(uri_string());
+	.. note:: Calling this function is the same as doing this:
+		|
+		| site_url(uri_string());
 
-uri_string()
-============
 
-.. php:function:: uri_string()
+.. function:: uri_string()
 
 	:returns:	string
 
-Returns the URI segments of any page that contains this function.
-For example, if your URL was this::
+	Returns the URI segments of any page that contains this function.
+	For example, if your URL was this::
 
-	http://some-site.com/blog/comments/123
+		http://some-site.com/blog/comments/123
 
-The function would return::
+	The function would return::
 
-	blog/comments/123
+		blog/comments/123
 
-This function is an alias for ``CI_Config::uri_string()``. For more info,
-please see the :doc:`Config Library <../libraries/config>` documentation.
+	This function is an alias for ``CI_Config::uri_string()``. For more info,
+	please see the :doc:`Config Library <../libraries/config>` documentation.
 
-index_page()
-============
 
-.. php:function:: index_page()
+.. function:: index_page()
 
 	:returns:	string
 
-Returns your site **index_page**, as specified in your config file.
-Example::
+	Returns your site **index_page**, as specified in your config file.
+	Example::
 
-	echo index_page();
+		echo index_page();
 
-anchor()
-========
 
-.. php:function:: anchor($uri = '', $title = '', $attributes = '')
+.. function:: anchor($uri = '', $title = '', $attributes = '')
 
 	:param	string	$uri: URI string
 	:param	string	$title: Anchor title
 	:param	mixed	$attributes: HTML attributes
 	:returns:	string
 
-Creates a standard HTML anchor link based on your local site URL.
+	Creates a standard HTML anchor link based on your local site URL.
 
-The first parameter can contain any segments you wish appended to the
-URL. As with the :php:func:`site_url()` function above, segments can
-be a string or an array.
+	The first parameter can contain any segments you wish appended to the
+	URL. As with the :func:`site_url()` function above, segments can
+	be a string or an array.
 
-.. note:: If you are building links that are internal to your application
-	do not include the base URL (http://...). This will be added
-	automatically from the information specified in your config file.
-	Include only the URI segments you wish appended to the URL.
+	.. note:: If you are building links that are internal to your application
+		do not include the base URL (http://...). This will be added
+		automatically from the information specified in your config file.
+		Include only the URI segments you wish appended to the URL.
 
-The second segment is the text you would like the link to say. If you
-leave it blank, the URL will be used.
+	The second segment is the text you would like the link to say. If you
+	leave it blank, the URL will be used.
 
-The third parameter can contain a list of attributes you would like
-added to the link. The attributes can be a simple string or an
-associative array.
+	The third parameter can contain a list of attributes you would like
+	added to the link. The attributes can be a simple string or an
+	associative array.
 
-Here are some examples::
+	Here are some examples::
 
-	echo anchor('news/local/123', 'My News', 'title="News title"');
-	// Prints: <a href="http://example.com/index.php/news/local/123" title="News title">My News</a>
+		echo anchor('news/local/123', 'My News', 'title="News title"');
+		// Prints: <a href="http://example.com/index.php/news/local/123" title="News title">My News</a>
 
-	echo anchor('news/local/123', 'My News', array('title' => 'The best news!'));
-	// Prints: <a href="http://example.com/index.php/news/local/123" title="The best news!">My News</a>
+		echo anchor('news/local/123', 'My News', array('title' => 'The best news!'));
+		// Prints: <a href="http://example.com/index.php/news/local/123" title="The best news!">My News</a>
 
-	echo anchor('', 'Click here');
-	// Prints: <a href="http://example.com">Click Here</a>
+		echo anchor('', 'Click here');
+		// Prints: <a href="http://example.com">Click Here</a>
 
-anchor_popup()
-==============
 
-.. php:function:: anchor_popup($uri = '', $title = '', $attributes = FALSE)
+.. function:: anchor_popup($uri = '', $title = '', $attributes = FALSE)
 
 	:param	string	$uri: URI string
 	:param	string	$title: Anchor title
 	:param	mixed	$attributes: HTML attributes
 	:returns:	string
 
-Nearly identical to the :php:func:``anchor()`` function except that it
-opens the URL in a new window. You can specify JavaScript window
-attributes in the third parameter to control how the window is opened.
-If the third parameter is not set it will simply open a new window with
-your own browser settings.
+	Nearly identical to the :func:`anchor()` function except that it
+	opens the URL in a new window. You can specify JavaScript window
+	attributes in the third parameter to control how the window is opened.
+	If the third parameter is not set it will simply open a new window with
+	your own browser settings.
 
-Here is an example with attributes::
+	Here is an example with attributes::
 
-	$atts = array(
-		'width'       => 800,
-		'height'      => 600,
-		'scrollbars'  => 'yes',
-		'status'      => 'yes',
-		'resizable'   => 'yes',
-		'screenx'     => 0,
-		'screeny'     => 0,
-		'window_name' => '_blank'
-	);
+		$atts = array(
+			'width'       => 800,
+			'height'      => 600,
+			'scrollbars'  => 'yes',
+			'status'      => 'yes',
+			'resizable'   => 'yes',
+			'screenx'     => 0,
+			'screeny'     => 0,
+			'window_name' => '_blank'
+		);
 
-	echo anchor_popup('news/local/123', 'Click Me!', $atts);
+		echo anchor_popup('news/local/123', 'Click Me!', $atts);
 
-.. note:: The above attributes are the function defaults so you only need to
-	set the ones that are different from what you need. If you want the
-	function to use all of its defaults simply pass an empty array in the
-	third parameter:
-	|
-	| echo anchor_popup('news/local/123', 'Click Me!', array());
+	.. note:: The above attributes are the function defaults so you only need to
+		set the ones that are different from what you need. If you want the
+		function to use all of its defaults simply pass an empty array in the
+		third parameter:
+		|
+		| echo anchor_popup('news/local/123', 'Click Me!', array());
 
-.. note:: The **window_name** is not really an attribute, but an argument to
-	the JavaScript `window.open() <http://www.w3schools.com/jsref/met_win_open.asp>`
-	method, which accepts either a window name or a window target.
+	.. note:: The **window_name** is not really an attribute, but an argument to
+		the JavaScript `window.open() <http://www.w3schools.com/jsref/met_win_open.asp>`
+		method, which accepts either a window name or a window target.
 
-.. note:: Any other attribute than the listed above will be parsed as an
-	HTML attribute to the anchor tag.
+	.. note:: Any other attribute than the listed above will be parsed as an
+		HTML attribute to the anchor tag.
 
-mailto()
-========
 
-.. php:function:: mailto($email, $title = '', $attributes = '')
+.. function:: mailto($email, $title = '', $attributes = '')
 
 	:param	string	$email: E-mail address
 	:param	string	$title: Anchor title
 	:param	mixed	$attributes: HTML attributes
 	:returns:	string
 
-Creates a standard HTML e-mail link. Usage example::
+	Creates a standard HTML e-mail link. Usage example::
 
-	echo mailto('me@my-site.com', 'Click Here to Contact Me');
+		echo mailto('me@my-site.com', 'Click Here to Contact Me');
 
-As with the :php:func:`anchor()` tab above, you can set attributes using the
-third parameter::
+	As with the :func:`anchor()` tab above, you can set attributes using the
+	third parameter::
 
-	$attributes = array('title' => 'Mail me');
-	echo mailto('me@my-site.com', 'Contact Me', $attributes);
+		$attributes = array('title' => 'Mail me');
+		echo mailto('me@my-site.com', 'Contact Me', $attributes);
 
-safe_mailto()
-=============
 
-.. php:function:: safe_mailto($email, $title = '', $attributes = '')
+.. function:: safe_mailto($email, $title = '', $attributes = '')
 
 	:param	string	$email: E-mail address
 	:param	string	$title: Anchor title
 	:param	mixed	$attributes: HTML attributes
 	:returns:	string
 
-Identical to the :php:func:`mailto()` function except it writes an obfuscated
-version of the *mailto* tag using ordinal numbers written with JavaScript to
-help prevent the e-mail address from being harvested by spam bots.
+	Identical to the :func:`mailto()` function except it writes an obfuscated
+	version of the *mailto* tag using ordinal numbers written with JavaScript to
+	help prevent the e-mail address from being harvested by spam bots.
 
-auto_link()
-===========
 
-.. php:function:: auto_link($str, $type = 'both', $popup = FALSE)
+.. function:: auto_link($str, $type = 'both', $popup = FALSE)
 
 	:param	string	$str: Input string
 	:param	string	$type: Link type ('email', 'url' or 'both')
 	:param	bool	$popup: Whether to create popup links
 	:returns:	string
 
-Automatically turns URLs and e-mail addresses contained in a string into
-links. Example::
+	Automatically turns URLs and e-mail addresses contained in a string into
+	links. Example::
 
-	$string = auto_link($string);
+		$string = auto_link($string);
 
-The second parameter determines whether URLs and e-mails are converted or
-just one or the other. Default behavior is both if the parameter is not
-specified. E-mail links are encoded as :php:func:`safe_mailto()` as shown
-above.
+	The second parameter determines whether URLs and e-mails are converted or
+	just one or the other. Default behavior is both if the parameter is not
+	specified. E-mail links are encoded as :func:`safe_mailto()` as shown
+	above.
 
-Converts only URLs::
+	Converts only URLs::
 
-	$string = auto_link($string, 'url');
+		$string = auto_link($string, 'url');
 
-Converts only e-mail addresses::
+	Converts only e-mail addresses::
 
-	$string = auto_link($string, 'email');
+		$string = auto_link($string, 'email');
 
-The third parameter determines whether links are shown in a new window.
-The value can be TRUE or FALSE (boolean)::
+	The third parameter determines whether links are shown in a new window.
+	The value can be TRUE or FALSE (boolean)::
 
-	$string = auto_link($string, 'both', TRUE);
+		$string = auto_link($string, 'both', TRUE);
 
-url_title()
-===========
 
-.. php:function:: url_title($str, $separator = '-', $lowercase = FALSE)
+.. function:: url_title($str, $separator = '-', $lowercase = FALSE)
 
 	:param	string	$str: Input string
 	:param	string	$separator: Word separator
 	:param	string	$lowercase: Whether to transform the output string to lower-case
 	:returns:	string
 
-Takes a string as input and creates a human-friendly URL string. This is
-useful if, for example, you have a blog in which you'd like to use the
-title of your entries in the URL. Example::
+	Takes a string as input and creates a human-friendly URL string. This is
+	useful if, for example, you have a blog in which you'd like to use the
+	title of your entries in the URL. Example::
 
-	$title = "What's wrong with CSS?";
-	$url_title = url_title($title);
-	// Produces: Whats-wrong-with-CSS
+		$title = "What's wrong with CSS?";
+		$url_title = url_title($title);
+		// Produces: Whats-wrong-with-CSS
 
-The second parameter determines the word delimiter. By default dashes
-are used. Preferred options are: **-** (dash) or **_** (underscore)
+	The second parameter determines the word delimiter. By default dashes
+	are used. Preferred options are: **-** (dash) or **_** (underscore)
 
-Example::
+	Example::
 
-	$title = "What's wrong with CSS?";
-	$url_title = url_title($title, 'underscore');
-	// Produces: Whats_wrong_with_CSS
+		$title = "What's wrong with CSS?";
+		$url_title = url_title($title, 'underscore');
+		// Produces: Whats_wrong_with_CSS
 
-.. note:: Old usage of 'dash' and 'underscore' as the second parameter
-	is DEPRECATED.
+	.. note:: Old usage of 'dash' and 'underscore' as the second parameter
+		is DEPRECATED.
 
-The third parameter determines whether or not lowercase characters are
-forced. By default they are not. Options are boolean TRUE/FALSE.
+	The third parameter determines whether or not lowercase characters are
+	forced. By default they are not. Options are boolean TRUE/FALSE.
 
-Example::
+	Example::
 
-	$title = "What's wrong with CSS?";
-	$url_title = url_title($title, 'underscore', TRUE);
-	// Produces: whats_wrong_with_css
+		$title = "What's wrong with CSS?";
+		$url_title = url_title($title, 'underscore', TRUE);
+		// Produces: whats_wrong_with_css
 
-prep_url()
-----------
 
-.. php:function:: prep_url($str = '')
+.. function:: prep_url($str = '')
 
 	:param	string	$str: URL string
 	:returns:	string
 
-This function will add http:// in the event that a protocol prefix
-is missing from a URL.
+	This function will add http:// in the event that a protocol prefix
+	is missing from a URL.
 
-Pass the URL string to the function like this::
+	Pass the URL string to the function like this::
 
-	$url = prep_url('example.com');
+		$url = prep_url('example.com');
 
-redirect()
-==========
 
-.. php:function:: redirect($uri = '', $method = 'auto', $code = NULL)
+.. function:: redirect($uri = '', $method = 'auto', $code = NULL)
 
 	:param	string	$uri: URI string
 	:param	string	$method: Redirect method ('auto', 'location' or 'refresh')
 	:param	string	$code: HTTP Response code (usually 302 or 303)
 	:returns:	void
 
-Does a "header redirect" to the URI specified. If you specify the full
-site URL that link will be built, but for local links simply providing
-the URI segments to the controller you want to direct to will create the
-link. The function will build the URL based on your config file values.
+	Does a "header redirect" to the URI specified. If you specify the full
+	site URL that link will be built, but for local links simply providing
+	the URI segments to the controller you want to direct to will create the
+	link. The function will build the URL based on your config file values.
 
-The optional second parameter allows you to force a particular redirection
-method. The available methods are **auto**, **location** and **refresh**,
-with location being faster but less reliable on IIS servers.
-The default is **auto**, which will attempt to intelligently choose the
-method based on the server environment.
+	The optional second parameter allows you to force a particular redirection
+	method. The available methods are **auto**, **location** and **refresh**,
+	with location being faster but less reliable on IIS servers.
+	The default is **auto**, which will attempt to intelligently choose the
+	method based on the server environment.
 
-The optional third parameter allows you to send a specific HTTP Response
-Code - this could be used for example to create 301 redirects for search
-engine purposes. The default Response Code is 302. The third parameter is
-*only* available with **location** redirects, and not *refresh*. Examples::
+	The optional third parameter allows you to send a specific HTTP Response
+	Code - this could be used for example to create 301 redirects for search
+	engine purposes. The default Response Code is 302. The third parameter is
+	*only* available with **location** redirects, and not *refresh*. Examples::
 
-	if ($logged_in == FALSE)
-	{      
-		redirect('/login/form/');
-	}
+		if ($logged_in == FALSE)
+		{      
+			redirect('/login/form/');
+		}
 
-	// with 301 redirect
-	redirect('/article/13', 'location', 301);
+		// with 301 redirect
+		redirect('/article/13', 'location', 301);
 
-.. note:: In order for this function to work it must be used before anything
-	is outputted to the browser since it utilizes server headers.
+	.. note:: In order for this function to work it must be used before anything
+		is outputted to the browser since it utilizes server headers.
 
-.. note:: For very fine grained control over headers, you should use the
-	`Output Library </libraries/output>` ``set_header()`` method.
+	.. note:: For very fine grained control over headers, you should use the
+		`Output Library </libraries/output>` ``set_header()`` method.
 
-.. note:: To IIS users: if you hide the `Server` HTTP header, the *auto*
-	method won't detect IIS, in that case it is advised you explicitly
-	use the **refresh** method.
+	.. note:: To IIS users: if you hide the `Server` HTTP header, the *auto*
+		method won't detect IIS, in that case it is advised you explicitly
+		use the **refresh** method.
 
-.. note:: When the **location** method is used, an HTTP status code of 303
-	will *automatically* be selected when the page is currently accessed
-	via POST and HTTP/1.1 is used.
+	.. note:: When the **location** method is used, an HTTP status code of 303
+		will *automatically* be selected when the page is currently accessed
+		via POST and HTTP/1.1 is used.
 
-.. important:: This function will terminate script execution.
\ No newline at end of file
+	.. important:: This function will terminate script execution.
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From b8c283a695c8074a57d8c3dfa00934312638931d Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Fri, 19 Jul 2013 16:02:53 -0700
Subject: Dropping unecessary php: directive to function definitions in user
 guide

---
 .../source/general/ancillary_classes.rst           |  4 +-
 user_guide_src/source/general/common_functions.rst | 24 +++++------
 user_guide_src/source/general/errors.rst           | 12 +++---
 user_guide_src/source/helpers/array_helper.rst     | 12 +++---
 user_guide_src/source/helpers/captcha_helper.rst   |  4 +-
 user_guide_src/source/helpers/cookie_helper.rst    |  6 +--
 user_guide_src/source/helpers/date_helper.rst      | 28 ++++++------
 user_guide_src/source/helpers/download_helper.rst  |  2 +-
 user_guide_src/source/helpers/email_helper.rst     |  4 +-
 user_guide_src/source/helpers/file_helper.rst      | 18 ++++----
 user_guide_src/source/helpers/form_helper.rst      | 50 +++++++++++-----------
 user_guide_src/source/helpers/html_helper.rst      | 18 ++++----
 user_guide_src/source/helpers/inflector_helper.rst | 12 +++---
 user_guide_src/source/helpers/language_helper.rst  |  4 +-
 user_guide_src/source/helpers/number_helper.rst    |  4 +-
 user_guide_src/source/helpers/path_helper.rst      |  4 +-
 user_guide_src/source/helpers/security_helper.rst  | 10 ++---
 user_guide_src/source/helpers/smiley_helper.rst    |  6 +--
 user_guide_src/source/helpers/string_helper.rst    | 26 +++++------
 user_guide_src/source/helpers/text_helper.rst      | 20 ++++-----
 .../source/helpers/typography_helper.rst           |  6 +--
 21 files changed, 137 insertions(+), 137 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/general/ancillary_classes.rst b/user_guide_src/source/general/ancillary_classes.rst
index 5dc058ad4..edb3a14fb 100644
--- a/user_guide_src/source/general/ancillary_classes.rst
+++ b/user_guide_src/source/general/ancillary_classes.rst
@@ -9,7 +9,7 @@ resources. This is easily possible as you'll see.
 get_instance()
 ==============
 
-.. php:function:: get_instance()
+.. function:: get_instance()
 
 	:returns:	object of class CI_Controller
 
@@ -48,7 +48,7 @@ Once you've assigned the object to a variable, you'll use that variable
 	passed by reference::
 
 		$CI =& get_instance();
-	
+
 	This is very important. Assigning by reference allows you to use the
 	original CodeIgniter object rather than creating a copy of it.
 
diff --git a/user_guide_src/source/general/common_functions.rst b/user_guide_src/source/general/common_functions.rst
index 32e8a8be0..8a57c183e 100644
--- a/user_guide_src/source/general/common_functions.rst
+++ b/user_guide_src/source/general/common_functions.rst
@@ -9,7 +9,7 @@ loading any libraries or helpers.
 is_php()
 ========
 
-.. php:function:: is_php($version = '5.3.0')
+.. function:: is_php($version = '5.3.0')
 
 	:param	string	$version: Version number
 	:returns:	bool
@@ -31,7 +31,7 @@ version of PHP is lower than the supplied version number.
 is_really_writable()
 ====================
 
-.. php:function:: is_really_writable($file)
+.. function:: is_really_writable($file)
 
 	:param	string	$file: File path
 	:returns:	bool
@@ -58,7 +58,7 @@ Example::
 config_item()
 =============
 
-.. php:function:: config_item($key)
+.. function:: config_item($key)
 
 	:param	string	$key: Config item key
 	:returns:	mixed
@@ -71,7 +71,7 @@ documentation for more information.
 show_error()
 ============
 
-.. php:function:: show_error($message, $status_code, $heading = 'An Error Was Encountered')
+.. function:: show_error($message, $status_code, $heading = 'An Error Was Encountered')
 
 	:param	mixed	$message: Error message
 	:param	int	$status_code: HTTP Response status code
@@ -84,7 +84,7 @@ please see the :doc:`Error Handling <errors>` documentation.
 show_404()
 ==========
 
-.. php:function:: show_404($page = '', $log_error = TRUE)
+.. function:: show_404($page = '', $log_error = TRUE)
 
 	:param	string	$page: URI string
 	:param	bool	$log_error: Whether to log the error
@@ -96,7 +96,7 @@ please see the :doc:`Error Handling <errors>` documentation.
 log_message()
 =============
 
-.. php:function:: log_message($level, $message, $php_error = FALSE)
+.. function:: log_message($level, $message, $php_error = FALSE)
 
 	:param	string	$level: Log level: 'error', 'debug' or 'info'
 	:param	string	$message: Message to log
@@ -109,7 +109,7 @@ please see the :doc:`Error Handling <errors>` documentation.
 set_status_header()
 ===============================
 
-.. php:function:: set_status_header($code, $text = '')
+.. function:: set_status_header($code, $text = '')
 
 	:param	int	$code: HTTP Reponse status code
 	:param	string	$text: A custom message to set with the status code
@@ -126,7 +126,7 @@ a full list of headers.
 remove_invisible_characters()
 =============================
 
-.. php:function:: remove_invisible_characters($str, $url_encoded = TRUE)
+.. function:: remove_invisible_characters($str, $url_encoded = TRUE)
 
 	:param	string	$str: Input string
 	:param	bool	$url_encoded: Whether to remove URL-encoded characters as well
@@ -143,7 +143,7 @@ Example::
 html_escape()
 =============
 
-.. php:function:: html_escape($var)
+.. function:: html_escape($var)
 
 	:param	mixed	$var: Variable to escape
 			(string or array)
@@ -157,7 +157,7 @@ It is useful in preventing Cross Site Scripting (XSS).
 get_mimes()
 ===========
 
-.. php:function:: get_mimes()
+.. function:: get_mimes()
 
 	:returns:	array
 
@@ -167,7 +167,7 @@ This function returns a *reference* to the MIMEs array from
 is_https()
 ==========
 
-.. php:function:: is_https()
+.. function:: is_https()
 
 	:returns:	bool
 
@@ -177,7 +177,7 @@ in any other case (including non-HTTP requests).
 function_usable()
 =================
 
-.. php:function:: function_usable($function_name)
+.. function:: function_usable($function_name)
 
 	:param	string	$function_name: Function name
 	:returns:	bool
diff --git a/user_guide_src/source/general/errors.rst b/user_guide_src/source/general/errors.rst
index f12d992f8..6cc8a0966 100644
--- a/user_guide_src/source/general/errors.rst
+++ b/user_guide_src/source/general/errors.rst
@@ -21,8 +21,8 @@ without having to worry about class/function scoping.
 CodeIgniter also returns a status code whenever a portion of the core
 calls ``exit()``. This exit status code is separate from the HTTP status
 code, and serves as a notice to other processes that may be watching of
-whether the script completed successfully, or if not, what kind of 
-problem it encountered that caused it to abort. These values are 
+whether the script completed successfully, or if not, what kind of
+problem it encountered that caused it to abort. These values are
 defined in *application/config/constants.php*. While exit status codes
 are most useful in CLI settings, returning the proper code helps server
 software keep track of your scripts and the health of your application.
@@ -32,7 +32,7 @@ The following functions let you generate errors:
 show_error()
 ============
 
-.. php:function:: show_error($message, $status_code, $heading = 'An Error Was Encountered')
+.. function:: show_error($message, $status_code, $heading = 'An Error Was Encountered')
 
 	:param	mixed	$message: Error message
 	:param	int	$status_code: HTTP Response status code
@@ -49,13 +49,13 @@ code should be sent with the error. If ``$status_code`` is less than 100,
 the HTTP status code will be set to 500, and the exit status code will
 be set to ``$status_code + EXIT__AUTO_MIN``. If that value is larger than
 ``EXIT__AUTO_MAX``, or if ``$status_code`` is 100 or higher, the exit
-status code will be set to ``EXIT_ERROR``. You can check in 
+status code will be set to ``EXIT_ERROR``. You can check in
 *application/config/constants.php* for more detail.
 
 show_404()
 ==========
 
-.. php:function:: show_404($page = '', $log_error = TRUE)
+.. function:: show_404($page = '', $log_error = TRUE)
 
 	:param	string	$page: URI string
 	:param	bool	$log_error: Whether to log the error
@@ -77,7 +77,7 @@ optional second parameter to FALSE will skip logging.
 log_message()
 =============
 
-.. php:function:: log_message($level, $message, $php_error = FALSE)
+.. function:: log_message($level, $message, $php_error = FALSE)
 
 	:param	string	$level: Log level: 'error', 'debug' or 'info'
 	:param	string	$message: Message to log
diff --git a/user_guide_src/source/helpers/array_helper.rst b/user_guide_src/source/helpers/array_helper.rst
index 9435b3ac7..90ead2942 100644
--- a/user_guide_src/source/helpers/array_helper.rst
+++ b/user_guide_src/source/helpers/array_helper.rst
@@ -19,7 +19,7 @@ The following functions are available:
 element()
 =========
 
-.. php:function:: element($item, $array, $default = NULL)
+.. function:: element($item, $array, $default = NULL)
 
 	:param	string	$item: Item to fetch from the array
 	:param	array	$array: Input array
@@ -39,13 +39,13 @@ Example::
 		'size'	=> ''
 	);
 
-	echo element('color', $array); // returns "red" 
-	echo element('size', $array, 'foobar'); // returns "foobar" 
+	echo element('color', $array); // returns "red"
+	echo element('size', $array, 'foobar'); // returns "foobar"
 
 elements()
 ==========
 
-.. php:function:: elements($items, $array, $default = NULL)
+.. function:: elements($items, $array, $default = NULL)
 
 	:param	string	$item: Item to fetch from the array
 	:param	array	$array: Input array
@@ -55,7 +55,7 @@ elements()
 Lets you fetch a number of items from an array. The function tests
 whether each of the array indices is set. If an index does not exist it
 is set to NULL, or whatever you've specified as the default value via
-the third parameter. 
+the third parameter.
 
 Example::
 
@@ -106,7 +106,7 @@ updated.
 random_element()
 ================
 
-.. php:function:: random_element($array)
+.. function:: random_element($array)
 
 	:param	array	$array: Input array
 	:returns:	string (a random element from the array)
diff --git a/user_guide_src/source/helpers/captcha_helper.rst b/user_guide_src/source/helpers/captcha_helper.rst
index 3c56addf3..b40d8a252 100644
--- a/user_guide_src/source/helpers/captcha_helper.rst
+++ b/user_guide_src/source/helpers/captcha_helper.rst
@@ -20,7 +20,7 @@ The following functions are available:
 create_captcha()
 ================
 
-.. php:function:: function create_captcha($data = '', $img_path = '', $img_url = '', $font_path = '')
+.. function:: function create_captcha($data = '', $img_path = '', $img_url = '', $font_path = '')
 
 	:param	array	$data: Array of data for the CAPTCHA
 	:param	string	$img_path: Path to create the image in
@@ -132,7 +132,7 @@ CAPTCHA will be shown you'll have something like this::
 	$this->db->query($query);
 
 	echo 'Submit the word you see below:';
-	echo $cap['image']; 
+	echo $cap['image'];
 	echo '<input type="text" name="captcha" value="" />';
 
 Then, on the page that accepts the submission you'll have something like
diff --git a/user_guide_src/source/helpers/cookie_helper.rst b/user_guide_src/source/helpers/cookie_helper.rst
index c41193c3c..c09f5eb4c 100644
--- a/user_guide_src/source/helpers/cookie_helper.rst
+++ b/user_guide_src/source/helpers/cookie_helper.rst
@@ -19,7 +19,7 @@ The following functions are available:
 set_cookie()
 ============
 
-.. php:function:: set_cookie($name = '', $value = '', $expire = '', $domain = '', $path = '/', $prefix = '', $secure = FALSE, $httponly = FALSE)
+.. function:: set_cookie($name = '', $value = '', $expire = '', $domain = '', $path = '/', $prefix = '', $secure = FALSE, $httponly = FALSE)
 
 	:param	string	$name: Cookie name
 	:param	string	$value: Cookie value
@@ -39,7 +39,7 @@ description of its use, as this function is an alias for
 get_cookie()
 ============
 
-.. php:function:: get_cookie($index = '', $xss_clean = FALSE)
+.. function:: get_cookie($index = '', $xss_clean = FALSE)
 
 	:param	string	$index: Cookie name
 	:param	bool	$xss_clean: Whether to apply XSS filtering to the returned value
@@ -52,7 +52,7 @@ description of itsuse, as this function is an alias for ``CI_Input::cookie()``.
 delete_cookie()
 ===============
 
-.. php:function:: delete_cookie($name = '', $domain = '', $path = '/', $prefix = '')
+.. function:: delete_cookie($name = '', $domain = '', $path = '/', $prefix = '')
 
 	:param	string	$name: Cookie name
 	:param	string	$domain: Cookie domain (usually: .yourdomain.com)
diff --git a/user_guide_src/source/helpers/date_helper.rst b/user_guide_src/source/helpers/date_helper.rst
index 5dfee8b48..67ead0330 100644
--- a/user_guide_src/source/helpers/date_helper.rst
+++ b/user_guide_src/source/helpers/date_helper.rst
@@ -18,7 +18,7 @@ The following functions are available:
 now()
 =====
 
-.. php:function:: now($timezone = NULL)
+.. function:: now($timezone = NULL)
 
 	:param	string	$timezone: Timezone
 	:returns:	int
@@ -40,7 +40,7 @@ If a timezone is not provided, it will return ``time()`` based on the
 mdate()
 =======
 
-.. php:function:: mdate($datestr = '', $time = '')
+.. function:: mdate($datestr = '', $time = '')
 
 	:param	string 	$datestr: Date string
 	:param	int 	$time: UNIX timestamp
@@ -66,7 +66,7 @@ will be used.
 standard_date()
 ===============
 
-.. php:function:: standard_date($fmt = 'DATE_RFC822', $time = NULL)
+.. function:: standard_date($fmt = 'DATE_RFC822', $time = NULL)
 
 	:param	string	$fmt: Date format
 	:param	int 	$time: UNIX timestamp
@@ -109,7 +109,7 @@ DATE_W3C	W3C			2005-08-14T16:13:03+0000
 local_to_gmt()
 ==============
 
-.. php:function:: local_to_gmt($time = '')
+.. function:: local_to_gmt($time = '')
 
 	:param	int	$time: UNIX timestamp
 	:returns:	string
@@ -123,7 +123,7 @@ Example::
 gmt_to_local()
 ==============
 
-.. php:function:: gmt_to_local($time = '', $timezone = 'UTC', $dst = FALSE)
+.. function:: gmt_to_local($time = '', $timezone = 'UTC', $dst = FALSE)
 
 	:param	int 	$time: UNIX timestamp
 	:param	string	$timezone: Timezone
@@ -147,7 +147,7 @@ Example::
 mysql_to_unix()
 ===============
 
-.. php:function:: mysql_to_unix($time = '')
+.. function:: mysql_to_unix($time = '')
 
 	:param	int 	$time: UNIX timestamp
 	:returns:	int
@@ -161,7 +161,7 @@ Example::
 unix_to_human()
 ===============
 
-.. php:function:: unix_to_human($time = '', $seconds = FALSE, $fmt = 'us')
+.. function:: unix_to_human($time = '', $seconds = FALSE, $fmt = 'us')
 
 	:param	int	$time: UNIX timestamp
 	:param	bool	$seconds: Whether to show seconds
@@ -190,7 +190,7 @@ Examples::
 human_to_unix()
 ===============
 
-.. php:function:: human_to_unix($datestr = '')
+.. function:: human_to_unix($datestr = '')
 
 	:param	int 	$datestr: Date string
 	:returns:	int UNIX timestamp or FALSE on failure
@@ -209,7 +209,7 @@ Example::
 nice_date()
 ===========
 
-.. php:function:: nice_date($bad_date = '', $format = FALSE)
+.. function:: nice_date($bad_date = '', $format = FALSE)
 
 	:param	int	$bad_date: The terribly formatted date-like string
 	:param	string	$format: Date format to return (same as PHP's ``date()`` function)
@@ -235,7 +235,7 @@ Example::
 timespan()
 ==========
 
-.. php:function:: timespan($seconds = 1, $time = '', $units = '')
+.. function:: timespan($seconds = 1, $time = '', $units = '')
 
 	:param	int	$seconds: Number of seconds
 	:param	string	$time: UNIX timestamp
@@ -269,7 +269,7 @@ Example::
 days_in_month()
 ===============
 
-.. php:function:: days_in_month($month = 0, $year = '')
+.. function:: days_in_month($month = 0, $year = '')
 
 	:param	int	$month: a numeric month
 	:param	int	$year: a numeric year
@@ -287,7 +287,7 @@ If the second parameter is empty, the current year will be used.
 date_range()
 ============
 
-.. php:function:: date_range($unix_start = '', $mixed = '', $is_unix = TRUE, $format = 'Y-m-d')
+.. function:: date_range($unix_start = '', $mixed = '', $is_unix = TRUE, $format = 'Y-m-d')
 
 	:param	int	$unix_start: UNIX timestamp of the range start date
 	:param	int	$mixed: UNIX timestamp of the range end date or interval in days
@@ -309,7 +309,7 @@ Example::
 timezones()
 ===========
 
-.. php:function:: timezones($tz = '')
+.. function:: timezones($tz = '')
 
 	:param	string	$tz: a numeric timezone
 	:returns:	string
@@ -328,7 +328,7 @@ This function is useful when used with :php:func:`timezone_menu()`.
 timezone_menu()
 ===============
 
-.. php:function:: timezone_menu($default = 'UTC', $class = '', $name = 'timezones', $attributes = '')
+.. function:: timezone_menu($default = 'UTC', $class = '', $name = 'timezones', $attributes = '')
 
 	:param	string	$default: Timezone
 	:param	string	$class: Class name
diff --git a/user_guide_src/source/helpers/download_helper.rst b/user_guide_src/source/helpers/download_helper.rst
index 860c568b9..fd95f4f34 100644
--- a/user_guide_src/source/helpers/download_helper.rst
+++ b/user_guide_src/source/helpers/download_helper.rst
@@ -18,7 +18,7 @@ The following functions are available:
 force_download()
 ================
 
-.. php:function:: force_download($filename = '', $data = '', $set_mime = FALSE)
+.. function:: force_download($filename = '', $data = '', $set_mime = FALSE)
 
 	:param	string	$filename: Filename
 	:param	mixed	$data: File contents
diff --git a/user_guide_src/source/helpers/email_helper.rst b/user_guide_src/source/helpers/email_helper.rst
index 10adf1d0e..b38e7ec46 100644
--- a/user_guide_src/source/helpers/email_helper.rst
+++ b/user_guide_src/source/helpers/email_helper.rst
@@ -22,7 +22,7 @@ The following functions are available:
 valid_email()
 =============
 
-.. php:function:: valid_email($email)
+.. function:: valid_email($email)
 
 	:param	string	$email: Email address
 	:returns:	bool
@@ -49,7 +49,7 @@ Example::
 send_email()
 ============
 
-.. php:function:: send_email($recipient, $subject, $message)
+.. function:: send_email($recipient, $subject, $message)
 
 	:param	string	$recipient: E-mail address
 	:param	string	$subject: Mail subject
diff --git a/user_guide_src/source/helpers/file_helper.rst b/user_guide_src/source/helpers/file_helper.rst
index 194d4348f..be451db4d 100644
--- a/user_guide_src/source/helpers/file_helper.rst
+++ b/user_guide_src/source/helpers/file_helper.rst
@@ -18,7 +18,7 @@ The following functions are available:
 read_file()
 ===========
 
-.. php:function:: read_file($file)
+.. function:: read_file($file)
 
 	:param	string	$file: File path
 	:returns:	string or FALSE on failure
@@ -45,7 +45,7 @@ The path can be a relative or full server path. Returns FALSE (boolean) on failu
 write_file()
 ============
 
-.. php:function:: write_file($path, $data, $mode = 'wb')
+.. function:: write_file($path, $data, $mode = 'wb')
 
 	:param	string	$path: File path
 	:param	string	$data: Data to write to file
@@ -87,7 +87,7 @@ for mode options.
 delete_files()
 ==============
 
-.. php:function:: delete_files($path, $del_dir = FALSE, $htdocs = FALSE)
+.. function:: delete_files($path, $del_dir = FALSE, $htdocs = FALSE)
 
 	:param	string	$path: Directory path
 	:param	bool	$del_dir: Whether to also delete directories
@@ -112,7 +112,7 @@ Example::
 get_filenames()
 ===============
 
-.. php:function:: get_filenames($source_dir, $include_path = FALSE)
+.. function:: get_filenames($source_dir, $include_path = FALSE)
 
 	:param	string	$source_dir: Directory path
 	:param	bool	$include_path: Whether to include the path as part of the filenames
@@ -129,7 +129,7 @@ Example::
 get_dir_file_info()
 ===================
 
-.. php:function:: get_dir_file_info($source_dir, $top_level_only)
+.. function:: get_dir_file_info($source_dir, $top_level_only)
 
 	:param	string	$source_dir: Directory path
 	:param	bool	$top_level_only: Whether to look only at the specified directory
@@ -148,7 +148,7 @@ Example::
 get_file_info()
 ===============
 
-.. php:function: get_file_info($file, $returned_values = array('name', 'server_path', 'size', 'date'))
+.. function: get_file_info($file, $returned_values = array('name', 'server_path', 'size', 'date'))
 
 	:param	string	$file: File path
 	:param	array	$returned_values: What type of info to return
@@ -168,7 +168,7 @@ Valid ``$returned_values`` options are: `name`, `size`, `date`, `readable`, `wri
 get_mime_by_extension()
 =======================
 
-.. php:function:: get_mime_by_extension($filename)
+.. function:: get_mime_by_extension($filename)
 
 	:param	string	$filename: File name
 	:returns:	string or FALSE on failure
@@ -188,7 +188,7 @@ Returns FALSE if it can't determine the type, or read the MIME config file.
 symbolic_permissions()
 ======================
 
-.. php:function:: symbolic_permissions($perms)
+.. function:: symbolic_permissions($perms)
 
 	:param	int	$perms: Permissions
 	:returns:	string
@@ -203,7 +203,7 @@ standard symbolic notation of file permissions.
 octal_permissions()
 ===================
 
-.. php:function:: octal_permissions($perms)
+.. function:: octal_permissions($perms)
 
 	:param	int	$perms: Permissions
 	:returns:	string
diff --git a/user_guide_src/source/helpers/form_helper.rst b/user_guide_src/source/helpers/form_helper.rst
index b2a9b6f0f..e88a5de87 100644
--- a/user_guide_src/source/helpers/form_helper.rst
+++ b/user_guide_src/source/helpers/form_helper.rst
@@ -19,7 +19,7 @@ The following functions are available:
 form_open()
 ===========
 
-.. php:function:: form_open($action = '', $attributes = '', $hidden = array())
+.. function:: form_open($action = '', $attributes = '', $hidden = array())
 
 	:param	string	$action: Form action/target URI string
 	:param	string	$attributes: HTML attributes
@@ -74,7 +74,7 @@ The above example would create a form similar to this::
 form_open_multipart()
 =====================
 
-.. php:function:: form_open_multipart($action = '', $attributes = array(), $hidden = array())
+.. function:: form_open_multipart($action = '', $attributes = array(), $hidden = array())
 
 	:param	string	$action: Form action/target URI string
 	:param	string	$attributes: HTML attributes
@@ -88,7 +88,7 @@ would like to use the form to upload files with.
 form_hidden()
 =============
 
-.. php:function:: form_hidden($name, $value = '')
+.. function:: form_hidden($name, $value = '')
 
 	:param	string	$name: Field name
 	:param	string	$value: Field value
@@ -156,7 +156,7 @@ If you want to create hidden input fields with extra attributes::
 form_input()
 ============
 
-.. php:function:: form_input($data = '', $value = '', $extra = '')
+.. function:: form_input($data = '', $value = '', $extra = '')
 
 	:param	array	$data: Field attributes data
 	:param	string	$value: Field value
@@ -197,7 +197,7 @@ JavaScript, you can pass it as a string in the third parameter::
 form_password()
 ===============
 
-.. php:function:: form_password($data = '', $value = '', $extra = '')
+.. function:: form_password($data = '', $value = '', $extra = '')
 
 	:param	array	$data: Field attributes data
 	:param	string	$value: Field value
@@ -210,7 +210,7 @@ function above except that it uses the "password" input type.
 form_upload()
 =============
 
-.. php:function:: form_upload($data = '', $value = '', $extra = '')
+.. function:: form_upload($data = '', $value = '', $extra = '')
 
 	:param	array	$data: Field attributes data
 	:param	string	$value: Field value
@@ -224,7 +224,7 @@ be used to upload files.
 form_textarea()
 ===============
 
-.. php:function:: form_textarea($data = '', $value = '', $extra = '')
+.. function:: form_textarea($data = '', $value = '', $extra = '')
 
 	:param	array	$data: Field attributes data
 	:param	string	$value: Field value
@@ -240,7 +240,7 @@ function above except that it generates a "textarea" type.
 form_dropdown()
 ===============
 
-.. php:function:: form_dropdown($name = '', $options = array(), $selected = array(), $extra = '')
+.. function:: form_dropdown($name = '', $options = array(), $selected = array(), $extra = '')
 
 	:param	string	$name: Field name
 	:param	array	$options: An associative array of options to be listed
@@ -305,7 +305,7 @@ label.
 form_multiselect()
 ==================
 
-.. php:function:: form_multiselect($name = '', $options = array(), $selected = array(), $extra = '')
+.. function:: form_multiselect($name = '', $options = array(), $selected = array(), $extra = '')
 
 	:param	string	$name: Field name
 	:param	array	$options: An associative array of options to be listed
@@ -325,7 +325,7 @@ syntax, e.g. foo[].
 form_fieldset()
 ===============
 
-.. php:function:: form_fieldset($legend_text = '', $attributes = array())
+.. function:: form_fieldset($legend_text = '', $attributes = array())
 
 	:param	string	$legend_text: Text to put in the <legend> tag
 	:param	array	$attributes: Attributes to be set on the <fieldset> tag
@@ -372,7 +372,7 @@ second parameter if you prefer to set additional attributes::
 form_fieldset_close()
 =====================
 
-.. php:function:: form_fieldset_close($extra = '')
+.. function:: form_fieldset_close($extra = '')
 
 	:param	string	$extra: Anything to append after the closing tag, *as is*
 	:returns:	string
@@ -390,7 +390,7 @@ the tag. For example
 form_checkbox()
 ===============
 
-.. php:function:: form_checkbox($data = '', $value = '', $checked = FALSE, $extra = '')
+.. function:: form_checkbox($data = '', $value = '', $checked = FALSE, $extra = '')
 
 	:param	array	$data: Field attributes data
 	:param	string	$value: Field value
@@ -432,7 +432,7 @@ fourth parameter::
 form_radio()
 ============
 
-.. php:function:: form_radio($data = '', $value = '', $checked = FALSE, $extra = '')
+.. function:: form_radio($data = '', $value = '', $checked = FALSE, $extra = '')
 
 	:param	array	$data: Field attributes data
 	:param	string	$value: Field value
@@ -446,7 +446,7 @@ function above except that it uses the "radio" input type.
 form_label()
 ============
 
-.. php:function:: form_label($label_text = '', $id = '', $attributes = array())
+.. function:: form_label($label_text = '', $id = '', $attributes = array())
 
 	:param	string	$label_text: Text to put in the <label> tag
 	:param	string	$id: ID of the form element that we're making a label for
@@ -474,7 +474,7 @@ Example::
 form_submit()
 =============
 
-.. php:function:: form_submit($data = '', $value = '', $extra = '')
+.. function:: form_submit($data = '', $value = '', $extra = '')
 
 	:param	string	$data: Button name
 	:param	string	$value: Button value
@@ -493,7 +493,7 @@ parameter lets you add extra data to your form, like JavaScript.
 form_reset()
 ============
 
-.. php:function:: form_reset($data = '', $value = '', $extra = '')
+.. function:: form_reset($data = '', $value = '', $extra = '')
 
 	:param	string	$data: Button name
 	:param	string	$value: Button value
@@ -506,7 +506,7 @@ Lets you generate a standard reset button. Use is identical to
 form_button()
 =============
 
-.. php:function:: form_button($data = '', $content = '', $extra = '')
+.. function:: form_button($data = '', $content = '', $extra = '')
 
 	:param	string	$data: Button name
 	:param	string	$content: Button label
@@ -542,7 +542,7 @@ JavaScript, you can pass it as a string in the third parameter::
 form_close()
 ============
 
-.. php:function:: form_close($extra = '')
+.. function:: form_close($extra = '')
 
 	:param	string	$extra: Anything to append after the closing tag, *as is*
 	:returns:	string
@@ -558,7 +558,7 @@ the tag. For example::
 form_prep()
 ===========
 
-.. php:function:: form_prep($str = '', $is_textarea = FALSE)
+.. function:: form_prep($str = '', $is_textarea = FALSE)
 
 	:param	string	$str: Value to escape
 	:param	bool	$is_textarea: Whether we're preparing for <textarea> or a regular input tag
@@ -585,7 +585,7 @@ safely::
 set_value()
 ===========
 
-.. php:function:: set_value($field = '', $default = '', $is_textarea = FALSE)
+.. function:: set_value($field = '', $default = '', $is_textarea = FALSE)
 
 	:param	string	$field: Field name
 	:param	string	$default: Default value
@@ -606,7 +606,7 @@ The above form will show "0" when loaded for the first time.
 set_select()
 ============
 
-.. php:function:: set_select($field = '', $value = '', $default = FALSE)
+.. function:: set_select($field = '', $value = '', $default = FALSE)
 
 	:param	string	$field: Field name
 	:param	string	$value: Value to check for
@@ -631,7 +631,7 @@ Example::
 set_checkbox()
 ==============
 
-.. php:function:: set_checkbox($field = '', $value = '', $default = FALSE)
+.. function:: set_checkbox($field = '', $value = '', $default = FALSE)
 
 	:param	string	$field: Field name
 	:param	string	$value: Value to check for
@@ -652,7 +652,7 @@ Example::
 set_radio()
 ===========
 
-.. php:function:: set_radio($field = '', $value = '', $default = FALSE)
+.. function:: set_radio($field = '', $value = '', $default = FALSE)
 
 	:param	string	$field: Field name
 	:param	string	$value: Value to check for
@@ -676,7 +676,7 @@ Example::
 form_error()
 ============
 
-.. php:function:: form_error($field = '', $prefix = '', $suffix = '')
+.. function:: form_error($field = '', $prefix = '', $suffix = '')
 
 	:param	string	$field:	Field name
 	:param	string	$prefix: Error opening tag
@@ -698,7 +698,7 @@ Example::
 validation_errors()
 ===================
 
-.. php:function:: validation_errors($prefix = '', $suffix = '')
+.. function:: validation_errors($prefix = '', $suffix = '')
 
 	:param	string	$prefix: Error opening tag
 	:param	string	$suffix: Error closing tag
diff --git a/user_guide_src/source/helpers/html_helper.rst b/user_guide_src/source/helpers/html_helper.rst
index df53ebd2f..cc0f2d3ab 100644
--- a/user_guide_src/source/helpers/html_helper.rst
+++ b/user_guide_src/source/helpers/html_helper.rst
@@ -19,7 +19,7 @@ The following functions are available:
 br()
 ====
 
-.. php:function:: br($count = 1)
+.. function:: br($count = 1)
 
 	:param	int	$count: Number of times to repeat the tag
 	:returns:	string
@@ -34,7 +34,7 @@ The above would produce: <br /><br /><br />
 heading()
 =========
 
-.. php:function:: heading($data = '', $h = '1', $attributes = '')
+.. function:: heading($data = '', $h = '1', $attributes = '')
 
 	:param	string	$data: Content
 	:param	string	$h: Heading level
@@ -58,7 +58,7 @@ The above code produces: <h3 class="pink">Welcome!<<h3>
 img()
 =====
 
-.. php:function:: img($src = '', $index_page = FALSE, $attributes = '')
+.. function:: img($src = '', $index_page = FALSE, $attributes = '')
 
 	:param	string	$src: Image source data
 	:param	bool	$index_page: Whether to treat $src as a routed URI string
@@ -101,7 +101,7 @@ Example::
 link_tag()
 ==========
 
-.. php:function:: ling_tag($href = '', $rel = 'stylesheet', $type = 'text/css', $title = '', $media = '', $index_page = FALSE)
+.. function:: ling_tag($href = '', $rel = 'stylesheet', $type = 'text/css', $title = '', $media = '', $index_page = FALSE)
 
 	:param	string	$href: What are we linking to
 	:param	string	$rel: Relation type
@@ -148,7 +148,7 @@ for complete control over all attributes and values::
 nbs()
 =====
 
-.. php:function:: nbs($num = 1)
+.. function:: nbs($num = 1)
 
 	:param	int	$num: Number of space entities to produce
 	:returns:	string
@@ -165,7 +165,7 @@ The above would produce::
 ul() and ol()
 =============
 
-.. php:function:: ul($list, $attributes = '')
+.. function:: ul($list, $attributes = '')
 
 	:param	array	$list: List entries
 	:param	array	$attributes: HTML attributes
@@ -280,7 +280,7 @@ The above code will produce this::
 		</li>
 	</ul>
 
-.. php:function:: ol($list, $attributes = '')
+.. function:: ol($list, $attributes = '')
 
 	:param	array	$list: List entries
 	:param	array	$attributes: HTML attributes
@@ -292,7 +292,7 @@ ordered lists instead of <ul>.
 meta()
 ======
 
-.. php:function:: meta($name = '', $content = '', $type = 'name', $newline = "\n")
+.. function:: meta($name = '', $content = '', $type = 'name', $newline = "\n")
 
 	:param	string	$name: Meta name
 	:param	string	$content: Meta content
@@ -349,7 +349,7 @@ Examples::
 doctype()
 =========
 
-.. php:function:: doctype($type = 'xhtml1-strict')
+.. function:: doctype($type = 'xhtml1-strict')
 
 	:param	string	$type: Doctype name
 
diff --git a/user_guide_src/source/helpers/inflector_helper.rst b/user_guide_src/source/helpers/inflector_helper.rst
index 1f54b76c0..5f1dea736 100644
--- a/user_guide_src/source/helpers/inflector_helper.rst
+++ b/user_guide_src/source/helpers/inflector_helper.rst
@@ -19,7 +19,7 @@ The following functions are available:
 singular()
 ==========
 
-.. php:function:: singular($str)
+.. function:: singular($str)
 
 	:param	string	$str: Input string
 	:returns:	string
@@ -31,7 +31,7 @@ Changes a plural word to singular. Example::
 plural()
 ========
 
-.. php:function:: plural($str)
+.. function:: plural($str)
 
 	:param	string	$str: Input string
 	:returns:	string
@@ -43,7 +43,7 @@ Changes a singular word to plural. Example::
 camelize()
 ==========
 
-.. php:function:: camelize($str)
+.. function:: camelize($str)
 
 	:param	string	$str: Input string
 	:returns:	string
@@ -56,7 +56,7 @@ case. Example::
 underscore()
 ============
 
-.. php:function:: camelize($str)
+.. function:: camelize($str)
 
 	:param	string	$str: Input string
 	:returns:	string
@@ -69,7 +69,7 @@ Example::
 humanize()
 ==========
 
-.. php:function:: camelize($str)
+.. function:: camelize($str)
 
 	:param	string	$str: Input string
 	:param	string	$separator: Input separator
@@ -89,7 +89,7 @@ To use dashes instead of underscores::
 is_countable()
 ==============
 
-.. php:function:: is_countable($word)
+.. function:: is_countable($word)
 
 	:param	string	$word: Input string
 	:returns:	bool
diff --git a/user_guide_src/source/helpers/language_helper.rst b/user_guide_src/source/helpers/language_helper.rst
index 1911e3bfd..2b2342f16 100644
--- a/user_guide_src/source/helpers/language_helper.rst
+++ b/user_guide_src/source/helpers/language_helper.rst
@@ -19,7 +19,7 @@ The following functions are available:
 lang()
 ======
 
-.. php:function:: lang($line, $for = '', $attributes = array())
+.. function:: lang($line, $for = '', $attributes = array())
 
 	:param	string	$line: Language line key
 	:param	string	$for: HTML "for" attribute (ID of the element we're creating a label for)
@@ -27,7 +27,7 @@ lang()
 	:returns:	string
 
 This function returns a line of text from a loaded language file with
-simplified syntax that may be more desirable for view files than 
+simplified syntax that may be more desirable for view files than
 ``CI_Lang::line()``.
 
 Example::
diff --git a/user_guide_src/source/helpers/number_helper.rst b/user_guide_src/source/helpers/number_helper.rst
index 8e0ebda5e..4e12f9a27 100644
--- a/user_guide_src/source/helpers/number_helper.rst
+++ b/user_guide_src/source/helpers/number_helper.rst
@@ -19,7 +19,7 @@ The following functions are available:
 byte_format()
 =============
 
-.. php:function:: byte_format($num, $precision = 1)
+.. function:: byte_format($num, $precision = 1)
 
 	:param	mixed	$num: Number of bytes
 	:param	int	$precision: Floating point precision
@@ -27,7 +27,7 @@ byte_format()
 
 Formats numbers as bytes, based on size, and adds the appropriate
 suffix. Examples::
-	
+
 	echo byte_format(456); // Returns 456 Bytes
 	echo byte_format(4567); // Returns 4.5 KB
 	echo byte_format(45678); // Returns 44.6 KB
diff --git a/user_guide_src/source/helpers/path_helper.rst b/user_guide_src/source/helpers/path_helper.rst
index 3a271b28f..863a5589e 100644
--- a/user_guide_src/source/helpers/path_helper.rst
+++ b/user_guide_src/source/helpers/path_helper.rst
@@ -19,7 +19,7 @@ The following functions are available:
 set_realpath()
 ==============
 
-.. php:function:: set_realpath($path, $check_existance = FALSE)
+.. function:: set_realpath($path, $check_existance = FALSE)
 
 	:param	string	$path: Path
 	:param	bool	$check_existance: Whether to check if the path actually exists
@@ -40,7 +40,7 @@ Examples::
 
 	$directory = '/etc/php5';
 	echo set_realpath($directory);	// Prints '/etc/php5/'
-	
+
 	$non_existent_directory = '/path/to/nowhere';
 	echo set_realpath($non_existent_directory, TRUE);	// Shows an error, as the path cannot be resolved
 	echo set_realpath($non_existent_directory, FALSE);	// Prints '/path/to/nowhere'
\ No newline at end of file
diff --git a/user_guide_src/source/helpers/security_helper.rst b/user_guide_src/source/helpers/security_helper.rst
index 21bf53490..b06f78df6 100644
--- a/user_guide_src/source/helpers/security_helper.rst
+++ b/user_guide_src/source/helpers/security_helper.rst
@@ -18,7 +18,7 @@ The following functions are available:
 xss_clean()
 ===========
 
-.. php:function:: xss_clean($str, $is_image = FALSE)
+.. function:: xss_clean($str, $is_image = FALSE)
 
 	:param	string	$str: Input data
 	:param	bool	$is_image: Whether we're dealing with an image
@@ -32,7 +32,7 @@ please see the :doc:`Input Library <../libraries/input>` documentation.
 sanitize_filename()
 ===================
 
-.. php:function:: sanitize_filename($filename)
+.. function:: sanitize_filename($filename)
 
 	:param	string	$filename: Filename
 	:returns:	string
@@ -46,7 +46,7 @@ documentation.
 do_hash()
 =========
 
-.. php:function:: do_hash($str, $type = 'sha1')
+.. function:: do_hash($str, $type = 'sha1')
 
 	:param	string	$str: Input
 	:param	string	$type: Algorithm
@@ -71,7 +71,7 @@ Examples::
 strip_image_tags()
 ==================
 
-.. php:function:: strip_image_tags($str)
+.. function:: strip_image_tags($str)
 
 	:param	string	$str: Input
 	:returns:	string
@@ -90,7 +90,7 @@ documentation.
 encode_php_tags()
 =================
 
-.. php:function:: encode_php_tags($str)
+.. function:: encode_php_tags($str)
 
 	:param	string	$str: Input
 	:returns:	string
diff --git a/user_guide_src/source/helpers/smiley_helper.rst b/user_guide_src/source/helpers/smiley_helper.rst
index 7069b465e..cfb4acb98 100644
--- a/user_guide_src/source/helpers/smiley_helper.rst
+++ b/user_guide_src/source/helpers/smiley_helper.rst
@@ -107,7 +107,7 @@ To map the alias to the field id, pass them both into the
 get_clickable_smileys()
 =======================
 
-.. php:function:: get_clickable_smileys($image_url, $alias = '', $smileys = NULL)
+.. function:: get_clickable_smileys($image_url, $alias = '', $smileys = NULL)
 
 	:param	string	$image_url: URL path to the smileys directory
 	:param	string	$alias: Field alias
@@ -124,7 +124,7 @@ Example::
 smiley_js()
 ===========
 
-.. php:function:: smiley_js($alias = '', $field_id = '', $inline = TRUE)
+.. function:: smiley_js($alias = '', $field_id = '', $inline = TRUE)
 
 	:param	string	$alias: Field alias
 	:param	string	$field_id: Field ID
@@ -143,7 +143,7 @@ Example::
 parse_smileys()
 ===============
 
-.. php:function:: parse_smileys($str = '', $image_url = '', $smileys = NULL)
+.. function:: parse_smileys($str = '', $image_url = '', $smileys = NULL)
 
 	:param	string	$str: Text containing smiley codes
 	:param	string	$image_url: URL path to the smileys directory
diff --git a/user_guide_src/source/helpers/string_helper.rst b/user_guide_src/source/helpers/string_helper.rst
index d0d302476..b6417c2a6 100644
--- a/user_guide_src/source/helpers/string_helper.rst
+++ b/user_guide_src/source/helpers/string_helper.rst
@@ -19,7 +19,7 @@ The following functions are available:
 random_string()
 ===============
 
-.. php:function:: random_string($type = 'alnum', $len = 8)
+.. function:: random_string($type = 'alnum', $len = 8)
 
 	:param	string	$type: Randomization type
 	:param	int	$len: Output string length
@@ -49,7 +49,7 @@ Usage example::
 increment_string()
 ==================
 
-.. php:function:: increment_string($str, $separator = '_', $first = 1)
+.. function:: increment_string($str, $separator = '_', $first = 1)
 
 	:param	string	$str: Input string
 	:param	string	$separator: Separator to append a duplicate number with
@@ -69,7 +69,7 @@ Usage example::
 alternator()
 ============
 
-.. php:function:: alternator($args)
+.. function:: alternator($args)
 
 	:param	mixed	$args: A variable number of arguments
 	:returns:	mixed
@@ -98,7 +98,7 @@ your loop the next item will be returned.
 repeater()
 ==========
 
-.. php:function:: repeater($data, $num = 1)
+.. function:: repeater($data, $num = 1)
 
 	:param	string	$data: Input
 	:param	int	$num: Number of times to repeat
@@ -117,7 +117,7 @@ The above would generate 30 newlines.
 reduce_double_slashes()
 =======================
 
-.. php:function:: reduce_double_slashes($str)
+.. function:: reduce_double_slashes($str)
 
 	:param	string	$str: Input string
 	:returns:	string
@@ -133,7 +133,7 @@ Example::
 strip_slashes()
 ===============
 
-.. php:function:: strip_slashes($data)
+.. function:: strip_slashes($data)
 
 	:param	array	$data: Input
 	:returns:	array
@@ -141,14 +141,14 @@ strip_slashes()
 Removes any slashes from an array of strings.
 
 Example::
-	
+
 	$str = array(
 		'question'  => 'Is your name O\'reilly?',
 		'answer' => 'No, my name is O\'connor.'
 	);
-	
+
 	$str = strip_slashes($str);
-	
+
 The above will return the following array::
 
 	array(
@@ -163,7 +163,7 @@ The above will return the following array::
 trim_slashes()
 ==============
 
-.. php:function:: trim_slashes($str)
+.. function:: trim_slashes($str)
 
 	:param	string	$str: Input string
 	:returns:	string
@@ -180,7 +180,7 @@ Removes any leading/trailing slashes from a string. Example::
 reduce_multiples()
 ==================
 
-.. php:function:: reduce_multiples($str, $character = '', $trim = FALSE)
+.. function:: reduce_multiples($str, $character = '', $trim = FALSE)
 
 	:param	string	$str: Text to search in
 	:param	string	$character: Character to reduce
@@ -202,7 +202,7 @@ character at the beginning and the end of the string. Example::
 quotes_to_entities()
 ====================
 
-.. php:function:: quotes_to_entities($str)
+.. function:: quotes_to_entities($str)
 
 	:param	string	$str: Input string
 	:returns:	string
@@ -216,7 +216,7 @@ entities. Example::
 strip_quotes()
 ==============
 
-.. php:function:: strip_quotes($str)
+.. function:: strip_quotes($str)
 
 	:param	string	$str: Input string
 	:returns:	string
diff --git a/user_guide_src/source/helpers/text_helper.rst b/user_guide_src/source/helpers/text_helper.rst
index aec36c9a7..773257220 100644
--- a/user_guide_src/source/helpers/text_helper.rst
+++ b/user_guide_src/source/helpers/text_helper.rst
@@ -19,7 +19,7 @@ The following functions are available:
 word_limiter()
 ==============
 
-.. php:function:: word_limiter($str, $limit = 100, $end_char = '&#8230;')
+.. function:: word_limiter($str, $limit = 100, $end_char = '&#8230;')
 
 	:param	string	$str: Input string
 	:param	int	$limit: Limit
@@ -38,7 +38,7 @@ default it adds an ellipsis.
 character_limiter()
 ===================
 
-.. php:function:: character_limiter($str, $n = 500, $end_char = '&#8230;')
+.. function:: character_limiter($str, $n = 500, $end_char = '&#8230;')
 
 	:param	string	$str: Input string
 	:param	int	$n: Number of characters
@@ -64,7 +64,7 @@ undeclared this helper uses an ellipsis.
 ascii_to_entities()
 ===================
 
-.. php:function:: ascii_to_entities($str)
+.. function:: ascii_to_entities($str)
 
 	:param	string	$str: Input string
 	:returns:	string
@@ -84,7 +84,7 @@ Example::
 entities_to_ascii()
 ===================
 
-.. php:function::entities_to_ascii($str, $all = TRUE)
+.. function::entities_to_ascii($str, $all = TRUE)
 
 	:param	string	$str: Input string
 	:param	bool	$all: Whether to convert unsafe entities as well
@@ -96,7 +96,7 @@ It turns character entities back into ASCII.
 convert_accented_characters()
 =============================
 
-.. php:function:: convert_accented_characters($str)
+.. function:: convert_accented_characters($str)
 
 	:param	string	$str: Input string
 	:returns:	string
@@ -116,7 +116,7 @@ Example::
 word_censor()
 =============
 
-.. php:function:: word_censor($str, $censored, $replacement = '')
+.. function:: word_censor($str, $censored, $replacement = '')
 
 	:param	string	$str: Input string
 	:param	array	$censored: List of bad words to censor
@@ -137,7 +137,7 @@ Example::
 highlight_code()
 ================
 
-.. php:function:: highlight_code($str)
+.. function:: highlight_code($str)
 
 	:param	string	$str: Input string
 	:returns:	string
@@ -152,7 +152,7 @@ colors used are the ones specified in your php.ini file.
 highlight_phrase()
 ==================
 
-.. php:function:: highlight_phrase($str, $phrase, $tag_open = '<strong>', $tag_close = '</strong>')
+.. function:: highlight_phrase($str, $phrase, $tag_open = '<strong>', $tag_close = '</strong>')
 
 	:param	string	$str: Input string
 	:param	string	$phrase: Phrase to highlight
@@ -177,7 +177,7 @@ The above code prints::
 word_wrap()
 ===========
 
-.. php:function:: word_wrap($str, $charlim = 76)
+.. function:: word_wrap($str, $charlim = 76)
 
 	:param	string	$str: Input string
 	:param	int	$charlim: Character limit
@@ -198,7 +198,7 @@ Example::
 ellipsize()
 ===========
 
-.. php:function:: ellipsize($str, $max_length, $position = 1, $ellipsis = '&hellip;')
+.. function:: ellipsize($str, $max_length, $position = 1, $ellipsis = '&hellip;')
 
 	:param	string	$str: Input string
 	:param	int	$max_length: String length limit
diff --git a/user_guide_src/source/helpers/typography_helper.rst b/user_guide_src/source/helpers/typography_helper.rst
index 3c81687ac..bce2d149d 100644
--- a/user_guide_src/source/helpers/typography_helper.rst
+++ b/user_guide_src/source/helpers/typography_helper.rst
@@ -19,7 +19,7 @@ The following functions are available:
 auto_typography()
 =================
 
-.. php:function:: auto_typography($str, $reduce_linebreaks = FALSE)
+.. function:: auto_typography($str, $reduce_linebreaks = FALSE)
 
 	:param	string	$str: Input string
 	:param	bool	$reduce_linebreaks: Whether to reduce multiple instances of double newlines to two
@@ -44,7 +44,7 @@ Usage example::
 nl2br_except_pre()
 ==================
 
-.. php:function:: nl2br_except_pre($str)
+.. function:: nl2br_except_pre($str)
 
 	:param	string	$str: Input string
 	:returns:	string
@@ -60,7 +60,7 @@ Usage example::
 entity_decode()
 ===============
 
-.. php:function:: entity_decode($str, $charset = NULL)
+.. function:: entity_decode($str, $charset = NULL)
 
 	:param	string	$str: Input string
 	:param	string	$charset: Character set
-- 
cgit v1.2.3-24-g4f1b


From e07b4e7e6c26e3aa5c4c8e57b2842e1ba818517e Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Fri, 19 Jul 2013 16:14:38 -0700
Subject: Updating Array Helper docs

---
 user_guide_src/source/helpers/array_helper.rst | 141 +++++++++++++------------
 1 file changed, 72 insertions(+), 69 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/helpers/array_helper.rst b/user_guide_src/source/helpers/array_helper.rst
index 90ead2942..20f5864a6 100644
--- a/user_guide_src/source/helpers/array_helper.rst
+++ b/user_guide_src/source/helpers/array_helper.rst
@@ -5,7 +5,12 @@ Array Helper
 The Array Helper file contains functions that assist in working with
 arrays.
 
-.. contents:: Page Contents
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
 
 Loading this Helper
 ===================
@@ -14,114 +19,112 @@ This helper is loaded using the following code::
 
 	$this->load->helper('array');
 
+
+Available Functions
+===================
+
 The following functions are available:
 
-element()
-=========
 
-.. function:: element($item, $array, $default = NULL)
+.. function:: element($item, $array[, $default = NULL])
 
 	:param	string	$item: Item to fetch from the array
 	:param	array	$array: Input array
 	:param	bool	$default: What to return if the array isn't valid
 	:returns:	NULL on failure or the array item.
 
-Lets you fetch an item from an array. The function tests whether the
-array index is set and whether it has a value. If a value exists it is
-returned. If a value does not exist it returns NULL, or whatever you've
-specified as the default value via the third parameter.
+	Lets you fetch an item from an array. The function tests whether the
+	array index is set and whether it has a value. If a value exists it is
+	returned. If a value does not exist it returns NULL, or whatever you've
+	specified as the default value via the third parameter.
 
-Example::
+	Example::
 
-	$array = array(
-		'color'	=> 'red',
-		'shape'	=> 'round',
-		'size'	=> ''
-	);
+		$array = array(
+			'color'	=> 'red',
+			'shape'	=> 'round',
+			'size'	=> ''
+		);
 
-	echo element('color', $array); // returns "red"
-	echo element('size', $array, 'foobar'); // returns "foobar"
+		echo element('color', $array); // returns "red"
+		echo element('size', $array, 'foobar'); // returns "foobar"
 
-elements()
-==========
 
-.. function:: elements($items, $array, $default = NULL)
+.. function:: elements($items, $array[, $default = NULL])
 
 	:param	string	$item: Item to fetch from the array
 	:param	array	$array: Input array
 	:param	bool	$default: What to return if the array isn't valid
 	:returns:	NULL on failure or the array item.
 
-Lets you fetch a number of items from an array. The function tests
-whether each of the array indices is set. If an index does not exist it
-is set to NULL, or whatever you've specified as the default value via
-the third parameter.
+	Lets you fetch a number of items from an array. The function tests
+	whether each of the array indices is set. If an index does not exist it
+	is set to NULL, or whatever you've specified as the default value via
+	the third parameter.
 
-Example::
+	Example::
 
-	$array = array(
-		'color' => 'red',
-		'shape' => 'round',
-		'radius' => '10',
-		'diameter' => '20'
-	);
+		$array = array(
+			'color' => 'red',
+			'shape' => 'round',
+			'radius' => '10',
+			'diameter' => '20'
+		);
 
-	$my_shape = elements(array('color', 'shape', 'height'), $array);
+		$my_shape = elements(array('color', 'shape', 'height'), $array);
 
-The above will return the following array::
+	The above will return the following array::
 
-	array(
-		'color' => 'red',
-		'shape' => 'round',
-		'height' => NULL
-	);
+		array(
+			'color' => 'red',
+			'shape' => 'round',
+			'height' => NULL
+		);
 
-You can set the third parameter to any default value you like.
-::
+	You can set the third parameter to any default value you like.
+	::
 
-	 $my_shape = elements(array('color', 'shape', 'height'), $array, 'foobar');
+		 $my_shape = elements(array('color', 'shape', 'height'), $array, 'foobar');
 
-The above will return the following array::
+	The above will return the following array::
 
-	array(     
-		'color' 	=> 'red',
-		'shape' 	=> 'round',
-		'height'	=> 'foobar'
-	);
+		array(     
+			'color' 	=> 'red',
+			'shape' 	=> 'round',
+			'height'	=> 'foobar'
+		);
 
-This is useful when sending the ``$_POST`` array to one of your Models.
-This prevents users from sending additional POST data to be entered into
-your tables.
+	This is useful when sending the ``$_POST`` array to one of your Models.
+	This prevents users from sending additional POST data to be entered into
+	your tables.
 
-::
+	::
 
-	$this->load->model('post_model');
-	$this->post_model->update(
-		elements(array('id', 'title', 'content'), $_POST)
-	);
+		$this->load->model('post_model');
+		$this->post_model->update(
+			elements(array('id', 'title', 'content'), $_POST)
+		);
 
-This ensures that only the id, title and content fields are sent to be
-updated.
+	This ensures that only the id, title and content fields are sent to be
+	updated.
 
-random_element()
-================
 
 .. function:: random_element($array)
 
 	:param	array	$array: Input array
 	:returns:	string (a random element from the array)
 
-Takes an array as input and returns a random element from it.
+	Takes an array as input and returns a random element from it.
 
-Usage example::
+	Usage example::
 
-	$quotes = array(
-		"I find that the harder I work, the more luck I seem to have. - Thomas Jefferson",
-		"Don't stay in bed, unless you can make money in bed. - George Burns",
-		"We didn't lose the game; we just ran out of time. - Vince Lombardi",
-		"If everything seems under control, you're not going fast enough. - Mario Andretti",
-		"Reality is merely an illusion, albeit a very persistent one. - Albert Einstein",
-		"Chance favors the prepared mind - Louis Pasteur"
-	);
+		$quotes = array(
+			"I find that the harder I work, the more luck I seem to have. - Thomas Jefferson",
+			"Don't stay in bed, unless you can make money in bed. - George Burns",
+			"We didn't lose the game; we just ran out of time. - Vince Lombardi",
+			"If everything seems under control, you're not going fast enough. - Mario Andretti",
+			"Reality is merely an illusion, albeit a very persistent one. - Albert Einstein",
+			"Chance favors the prepared mind - Louis Pasteur"
+		);
 
-	echo random_element($quotes);
\ No newline at end of file
+		echo random_element($quotes);
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 26eb256ea28dd2dd03c2170de1a4af3b7a5fef9e Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Fri, 19 Jul 2013 16:21:17 -0700
Subject: Updating Typography helper docs

---
 .../source/helpers/typography_helper.rst           | 56 +++++++++++-----------
 1 file changed, 29 insertions(+), 27 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/helpers/typography_helper.rst b/user_guide_src/source/helpers/typography_helper.rst
index bce2d149d..d32befac1 100644
--- a/user_guide_src/source/helpers/typography_helper.rst
+++ b/user_guide_src/source/helpers/typography_helper.rst
@@ -5,7 +5,12 @@ Typography Helper
 The Typography Helper file contains functions that help your format text
 in semantically relevant ways.
 
-.. contents:: Page Contents
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
 
 Loading this Helper
 ===================
@@ -14,51 +19,48 @@ This helper is loaded using the following code::
 
 	$this->load->helper('typography');
 
+Available Functions
+===================
+
 The following functions are available:
 
-auto_typography()
-=================
 
-.. function:: auto_typography($str, $reduce_linebreaks = FALSE)
+.. function:: auto_typography($str[, $reduce_linebreaks = FALSE])
 
 	:param	string	$str: Input string
 	:param	bool	$reduce_linebreaks: Whether to reduce multiple instances of double newlines to two
 	:returns:	string
 
-Formats text so that it is semantically and typographically correct
-HTML.
+	Formats text so that it is semantically and typographically correct
+	HTML.
 
-This function is an alias for ``CI_Typography::auto_typography``.
-For more info, please see the :doc:`Typography Library
-<../libraries/typography>` documentation.
+	This function is an alias for ``CI_Typography::auto_typography``.
+	For more info, please see the :doc:`Typography Library
+	<../libraries/typography>` documentation.
 
-Usage example::
+	Usage example::
 
-	$string = auto_typography($string);
+		$string = auto_typography($string);
 
-.. note:: Typographic formatting can be processor intensive, particularly if
-	you have a lot of content being formatted. If you choose to use this
-	function you may want to consider `caching <../general/caching>` your
-	pages.
+	.. note:: Typographic formatting can be processor intensive, particularly if
+		you have a lot of content being formatted. If you choose to use this
+		function you may want to consider `caching <../general/caching>` your
+		pages.
 
-nl2br_except_pre()
-==================
 
 .. function:: nl2br_except_pre($str)
 
 	:param	string	$str: Input string
 	:returns:	string
 
-Converts newlines to <br /> tags unless they appear within <pre> tags.
-This function is identical to the native PHP ``nl2br()`` function,
-except that it ignores <pre> tags.
+	Converts newlines to <br /> tags unless they appear within <pre> tags.
+	This function is identical to the native PHP ``nl2br()`` function,
+	except that it ignores <pre> tags.
 
-Usage example::
+	Usage example::
 
-	$string = nl2br_except_pre($string);
+		$string = nl2br_except_pre($string);
 
-entity_decode()
-===============
 
 .. function:: entity_decode($str, $charset = NULL)
 
@@ -66,6 +68,6 @@ entity_decode()
 	:param	string	$charset: Character set
 	:returns:	string
 
-This function is an alias for ``CI_Security::entity_decode()``.
-Fore more info, please see the :doc:`Security Library
-<../libraries/security>` documentation.
\ No newline at end of file
+	This function is an alias for ``CI_Security::entity_decode()``.
+	Fore more info, please see the :doc:`Security Library
+	<../libraries/security>` documentation.
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 2488ed218f42ad4c068a26ef01280766673edf5a Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Fri, 19 Jul 2013 16:35:25 -0700
Subject: Updating Text Helper docs

---
 user_guide_src/source/helpers/text_helper.rst | 201 ++++++++++++--------------
 1 file changed, 93 insertions(+), 108 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/helpers/text_helper.rst b/user_guide_src/source/helpers/text_helper.rst
index 773257220..0cacd1b69 100644
--- a/user_guide_src/source/helpers/text_helper.rst
+++ b/user_guide_src/source/helpers/text_helper.rst
@@ -5,7 +5,12 @@ Text Helper
 The Text Helper file contains functions that assist in working with
 text.
 
-.. contents:: Page Contents
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
 
 Loading this Helper
 ===================
@@ -14,145 +19,131 @@ This helper is loaded using the following code::
 
 	$this->load->helper('text');
 
-The following functions are available:
+Available Functions
+===================
 
-word_limiter()
-==============
+The following functions are available:
 
-.. function:: word_limiter($str, $limit = 100, $end_char = '&#8230;')
+.. function:: word_limiter($str[, $limit = 100[, $end_char = '&#8230;']])
 
 	:param	string	$str: Input string
 	:param	int	$limit: Limit
 	:param	string	$end_char: End character (usually an ellipsis)
 	:returns:	string
 
-Truncates a string to the number of *words* specified. Example::
+	Truncates a string to the number of *words* specified. Example::
 
-	$string = "Here is a nice text string consisting of eleven words.";
-	$string = word_limiter($string, 4);
-	// Returns:  Here is a nice…
+		$string = "Here is a nice text string consisting of eleven words.";
+		$string = word_limiter($string, 4);
+		// Returns:  Here is a nice…
 
-The third parameter is an optional suffix added to the string. By
-default it adds an ellipsis.
+	The third parameter is an optional suffix added to the string. By
+	default it adds an ellipsis.
 
-character_limiter()
-===================
 
-.. function:: character_limiter($str, $n = 500, $end_char = '&#8230;')
+.. function:: character_limiter($str[, $n = 500[, $end_char = '&#8230;']])
 
 	:param	string	$str: Input string
 	:param	int	$n: Number of characters
 	:param	string	$end_char: End character (usually an ellipsis)
 	:returns:	string
 
-Truncates a string to the number of *characters* specified. It
-maintains the integrity of words so the character count may be slightly
-more or less then what you specify.
+	Truncates a string to the number of *characters* specified. It
+	maintains the integrity of words so the character count may be slightly
+	more or less then what you specify.
 
-Example::
+	Example::
 
-	$string = "Here is a nice text string consisting of eleven words.";
-	$string = character_limiter($string, 20);
-	// Returns:  Here is a nice text string…
+		$string = "Here is a nice text string consisting of eleven words.";
+		$string = character_limiter($string, 20);
+		// Returns:  Here is a nice text string…
 
-The third parameter is an optional suffix added to the string, if
-undeclared this helper uses an ellipsis.
+	The third parameter is an optional suffix added to the string, if
+	undeclared this helper uses an ellipsis.
 
-.. note:: If you need to truncate to an exact number of characters please
-	see the :ref:`ellipsize()` function below.
+	.. note:: If you need to truncate to an exact number of characters please
+		see the :func:`ellipsize()` function below.
 
-ascii_to_entities()
-===================
 
 .. function:: ascii_to_entities($str)
 
 	:param	string	$str: Input string
 	:returns:	string
 
-Converts ASCII values to character entities, including high ASCII and MS
-Word characters that can cause problems when used in a web page, so that
-they can be shown consistently regardless of browser settings or stored
-reliably in a database. There is some dependence on your server's
-supported character sets, so it may not be 100% reliable in all cases,
-but for the most part it should correctly identify characters outside
-the normal range (like accented characters).
+	Converts ASCII values to character entities, including high ASCII and MS
+	Word characters that can cause problems when used in a web page, so that
+	they can be shown consistently regardless of browser settings or stored
+	reliably in a database. There is some dependence on your server's
+	supported character sets, so it may not be 100% reliable in all cases,
+	but for the most part it should correctly identify characters outside
+	the normal range (like accented characters).
 
-Example::
+	Example::
 
-	$string = ascii_to_entities($string);
+		$string = ascii_to_entities($string);
 
-entities_to_ascii()
-===================
 
-.. function::entities_to_ascii($str, $all = TRUE)
+.. function::entities_to_ascii($str[, $all = TRUE])
 
 	:param	string	$str: Input string
 	:param	bool	$all: Whether to convert unsafe entities as well
 	:returns:	string
 
-This function does the opposite of :php:func:`ascii_to_entities()`.
-It turns character entities back into ASCII.
+	This function does the opposite of :func:`ascii_to_entities()`.
+	It turns character entities back into ASCII.
 
-convert_accented_characters()
-=============================
 
 .. function:: convert_accented_characters($str)
 
 	:param	string	$str: Input string
 	:returns:	string
 
-Transliterates high ASCII characters to low ASCII equivalents. Useful
-when non-English characters need to be used where only standard ASCII
-characters are safely used, for instance, in URLs.
+	Transliterates high ASCII characters to low ASCII equivalents. Useful
+	when non-English characters need to be used where only standard ASCII
+	characters are safely used, for instance, in URLs.
 
-Example::
+	Example::
 
-	$string = convert_accented_characters($string);
+		$string = convert_accented_characters($string);
 
-.. note:: This function uses a companion config file
-	`application/config/foreign_chars.php` to define the to and
-	from array for transliteration.
+	.. note:: This function uses a companion config file
+		`application/config/foreign_chars.php` to define the to and
+		from array for transliteration.
 
-word_censor()
-=============
 
-.. function:: word_censor($str, $censored, $replacement = '')
+.. function:: word_censor($str, $censored[, $replacement = ''])
 
 	:param	string	$str: Input string
 	:param	array	$censored: List of bad words to censor
 	:param	string	$replacement: What to replace bad words with
 	:returns:	string
 
-Enables you to censor words within a text string. The first parameter
-will contain the original string. The second will contain an array of
-words which you disallow. The third (optional) parameter can contain
-a replacement value for the words. If not specified they are replaced
-with pound signs: ####.
+	Enables you to censor words within a text string. The first parameter
+	will contain the original string. The second will contain an array of
+	words which you disallow. The third (optional) parameter can contain
+	a replacement value for the words. If not specified they are replaced
+	with pound signs: ####.
 
-Example::
+	Example::
 
-	$disallowed = array('darn', 'shucks', 'golly', 'phooey');
-	$string = word_censor($string, $disallowed, 'Beep!');
+		$disallowed = array('darn', 'shucks', 'golly', 'phooey');
+		$string = word_censor($string, $disallowed, 'Beep!');
 
-highlight_code()
-================
 
 .. function:: highlight_code($str)
 
 	:param	string	$str: Input string
 	:returns:	string
 
-Colorizes a string of code (PHP, HTML, etc.). Example::
+	Colorizes a string of code (PHP, HTML, etc.). Example::
 
-	$string = highlight_code($string);
+		$string = highlight_code($string);
 
-The function uses PHP's ``highlight_string()`` function, so the
-colors used are the ones specified in your php.ini file.
+	The function uses PHP's ``highlight_string()`` function, so the
+	colors used are the ones specified in your php.ini file.
 
-highlight_phrase()
-==================
 
-.. function:: highlight_phrase($str, $phrase, $tag_open = '<strong>', $tag_close = '</strong>')
+.. function:: highlight_phrase($str, $phrase[, $tag_open = '<strong>'[, $tag_close = '</strong>']])
 
 	:param	string	$str: Input string
 	:param	string	$phrase: Phrase to highlight
@@ -160,45 +151,39 @@ highlight_phrase()
 	:param	string	$tag_close: Closing tag for the highlight
 	:returns:	string
 
-Will highlight a phrase within a text string. The first parameter will
-contain the original string, the second will contain the phrase you wish
-to highlight. The third and fourth parameters will contain the
-opening/closing HTML tags you would like the phrase wrapped in.
+	Will highlight a phrase within a text string. The first parameter will
+	contain the original string, the second will contain the phrase you wish
+	to highlight. The third and fourth parameters will contain the
+	opening/closing HTML tags you would like the phrase wrapped in.
 
-Example::
+	Example::
 
-	$string = "Here is a nice text string about nothing in particular.";
-	echo highlight_phrase($string, "nice text", '<span style="color:#990000;">', '</span>');
+		$string = "Here is a nice text string about nothing in particular.";
+		echo highlight_phrase($string, "nice text", '<span style="color:#990000;">', '</span>');
 
-The above code prints::
+	The above code prints::
 
-	Here is a <span style="color:#990000;">nice text</span> string about nothing in particular.
+		Here is a <span style="color:#990000;">nice text</span> string about nothing in particular.
 
-word_wrap()
-===========
 
-.. function:: word_wrap($str, $charlim = 76)
+.. function:: word_wrap($str[, $charlim = 76])
 
 	:param	string	$str: Input string
 	:param	int	$charlim: Character limit
 	:returns:	string
 
-Wraps text at the specified *character* count while maintaining
-complete words.
-
-Example::
+	Wraps text at the specified *character* count while maintaining
+	complete words.
 
-	$string = "Here is a simple string of text that will help us demonstrate this function.";
-	echo word_wrap($string, 25);
+	Example::
 
-	// Would produce:  Here is a simple string of text that will help us demonstrate this function
+		$string = "Here is a simple string of text that will help us demonstrate this function.";
+		echo word_wrap($string, 25);
 
-.. _ellipsize():
+		// Would produce:  Here is a simple string of text that will help us demonstrate this function
 
-ellipsize()
-===========
 
-.. function:: ellipsize($str, $max_length, $position = 1, $ellipsis = '&hellip;')
+.. function:: ellipsize($str, $max_length[, $position = 1[, $ellipsis = '&hellip;']])
 
 	:param	string	$str: Input string
 	:param	int	$max_length: String length limit
@@ -207,23 +192,23 @@ ellipsize()
 	:param	string	$ellipsis: What to use as the ellipsis character
 	:returns:	string
 
-This function will strip tags from a string, split it at a defined
-maximum length, and insert an ellipsis.
+	This function will strip tags from a string, split it at a defined
+	maximum length, and insert an ellipsis.
 
-The first parameter is the string to ellipsize, the second is the number
-of characters in the final string. The third parameter is where in the
-string the ellipsis should appear from 0 - 1, left to right. For
-example. a value of 1 will place the ellipsis at the right of the
-string, .5 in the middle, and 0 at the left.
+	The first parameter is the string to ellipsize, the second is the number
+	of characters in the final string. The third parameter is where in the
+	string the ellipsis should appear from 0 - 1, left to right. For
+	example. a value of 1 will place the ellipsis at the right of the
+	string, .5 in the middle, and 0 at the left.
 
-An optional forth parameter is the kind of ellipsis. By default,
-&hellip; will be inserted.
+	An optional forth parameter is the kind of ellipsis. By default,
+	&hellip; will be inserted.
 
-Example::
+	Example::
 
-	$str = 'this_string_is_entirely_too_long_and_might_break_my_design.jpg';
-	echo ellipsize($str, 32, .5);
+		$str = 'this_string_is_entirely_too_long_and_might_break_my_design.jpg';
+		echo ellipsize($str, 32, .5);
 
-Produces::
+	Produces::
 
-	this_string_is_e&hellip;ak_my_design.jpg
\ No newline at end of file
+		this_string_is_e&hellip;ak_my_design.jpg
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 123bb20c52e0e9d6a622e14bac33e05b10ffc013 Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Fri, 19 Jul 2013 16:37:51 -0700
Subject: Updating user guide :php:func: refs to :func:

---
 user_guide_src/source/changelog.rst                | 72 +++++++++++-----------
 user_guide_src/source/general/reserved_names.rst   | 26 ++++----
 user_guide_src/source/helpers/date_helper.rst      |  4 +-
 user_guide_src/source/helpers/form_helper.rst      | 18 +++---
 user_guide_src/source/helpers/html_helper.rst      |  2 +-
 user_guide_src/source/helpers/security_helper.rst  |  2 +-
 user_guide_src/source/helpers/smiley_helper.rst    |  4 +-
 user_guide_src/source/installation/upgrade_300.rst | 12 ++--
 user_guide_src/source/libraries/language.rst       |  2 +-
 9 files changed, 71 insertions(+), 71 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index efbe86069..79f120754 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -61,22 +61,22 @@ Release Date: Not Released
 
    -  :doc:`Date Helper <helpers/date_helper>` changes include:
 
-      - :php:func:`now()` now works with all timezone strings supported by PHP.
-      - Added an optional third parameter to :php:func:`timespan()` that constrains the number of time units displayed.
-      - Added an optional parameter to :php:func:`timezone_menu()` that allows more attributes to be added to the generated select tag.
+      - :func:`now()` now works with all timezone strings supported by PHP.
+      - Added an optional third parameter to :func:`timespan()` that constrains the number of time units displayed.
+      - Added an optional parameter to :func:`timezone_menu()` that allows more attributes to be added to the generated select tag.
       - Deprecated ``standard_date()``, which now just uses the native ``date()`` with `DateTime constants <http://www.php.net/manual/en/class.datetime.php#datetime.constants.types>`_.
-      - Added function :php:func:`date_range()` that generates a list of dates between a specified period.
+      - Added function :func:`date_range()` that generates a list of dates between a specified period.
 
    -  :doc:`URL Helper <helpers/url_helper>` changes include:
 
-      - Deprecated *separator* options **dash** and **underscore** for function :php:func:`url_title()` (they are only aliases for '-' and '_' respectively).
-      - :php:func:`url_title()` will now trim extra dashes from beginning and end.
-      - :php:func:`anchor_popup()` will now fill the *href* attribute with the URL and its JS code will return FALSE instead.
-      - Added JS window name support to the :php:func:`anchor_popup()` function.
-      - Added support (auto-detection) for HTTP/1.1 response code 303 in :php:func:`redirect()`.
-      - Changed :php:func:`redirect()` to only choose the **refresh** method only on IIS servers, instead of all servers on Windows (when **auto** is used).
-      - Changed :php:func:`anchor()`, :php:func:`anchor_popup()`, and :php:func:`redirect()` to support protocol-relative URLs (e.g. *//ellislab.com/codeigniter*).
-      - Added an optional second parameter to both :php:func:`base_url()` and :php:func:`site_url()` that allows enforcing of a protocol different than the one in the *base_url* configuration setting.
+      - Deprecated *separator* options **dash** and **underscore** for function :func:`url_title()` (they are only aliases for '-' and '_' respectively).
+      - :func:`url_title()` will now trim extra dashes from beginning and end.
+      - :func:`anchor_popup()` will now fill the *href* attribute with the URL and its JS code will return FALSE instead.
+      - Added JS window name support to the :func:`anchor_popup()` function.
+      - Added support (auto-detection) for HTTP/1.1 response code 303 in :func:`redirect()`.
+      - Changed :func:`redirect()` to only choose the **refresh** method only on IIS servers, instead of all servers on Windows (when **auto** is used).
+      - Changed :func:`anchor()`, :func:`anchor_popup()`, and :func:`redirect()` to support protocol-relative URLs (e.g. *//ellislab.com/codeigniter*).
+      - Added an optional second parameter to both :func:`base_url()` and :func:`site_url()` that allows enforcing of a protocol different than the one in the *base_url* configuration setting.
 
    -  :doc:`HTML Helper <helpers/html_helper>` changes include:
 
@@ -86,24 +86,24 @@ Release Date: Not Released
 
    -  :doc:`Inflector Helper <helpers/inflector_helper>` changes include:
 
-      - Changed :php:func:`humanize()` to allow passing an input separator as its second parameter.
-      - Refactored :php:func:`plural()` and :php:func:`singular()` to avoid double pluralization and support more words.
+      - Changed :func:`humanize()` to allow passing an input separator as its second parameter.
+      - Refactored :func:`plural()` and :func:`singular()` to avoid double pluralization and support more words.
 
    -  :doc:`Download Helper <helpers/download_helper>` changes include:
 
-      - Added an optional third parameter to :php:func:`force_download()` that enables/disables sending the actual file MIME type in the Content-Type header (disabled by default).
-      - Added a work-around in :php:func:`force_download()` for a bug Android <= 2.1, where the filename extension needs to be in uppercase.
-      - Added support for reading from an existing file path by passing NULL as the second parameter to :php:func:`force_download()` (useful for large files and/or safely transmitting binary data).
+      - Added an optional third parameter to :func:`force_download()` that enables/disables sending the actual file MIME type in the Content-Type header (disabled by default).
+      - Added a work-around in :func:`force_download()` for a bug Android <= 2.1, where the filename extension needs to be in uppercase.
+      - Added support for reading from an existing file path by passing NULL as the second parameter to :func:`force_download()` (useful for large files and/or safely transmitting binary data).
 
    -  :doc:`Form Helper <helpers/form_helper>` changes include:
 
-      - :php:func:`form_dropdown()` will now also take an array for unity with other form helpers.
-      - :php:func:`form_prep()`'s second argument now only accepts a boolean value, which determines whether the value is escaped for a <textarea> or a regular <input> element.
+      - :func:`form_dropdown()` will now also take an array for unity with other form helpers.
+      - :func:`form_prep()`'s second argument now only accepts a boolean value, which determines whether the value is escaped for a <textarea> or a regular <input> element.
 
    -  :doc:`Security Helper <helpers/security_helper>` changes include:
 
-      - :php:func:`do_hash()` now uses PHP's native ``hash()`` function (supporting more algorithms) and is deprecated.
-      - :php:func:`strip_image_tags()` is now an alias for the same method in the :doc:`Security Library <libraries/security>`.
+      - :func:`do_hash()` now uses PHP's native ``hash()`` function (supporting more algorithms) and is deprecated.
+      - :func:`strip_image_tags()` is now an alias for the same method in the :doc:`Security Library <libraries/security>`.
 
    -  :doc:`Smiley Helper <helpers/smiley_helper>` changes include:
 
@@ -113,23 +113,23 @@ Release Date: Not Released
 
    -  :doc:`File Helper <helpers/file_helper>` changes include:
 
-      - :php:func:`set_realpath()` can now also handle file paths as opposed to just directories.
-      - Added an optional paramater to :php:func:`delete_files()` to enable it to skip deleting files such as *.htaccess* and *index.html*.
+      - :func:`set_realpath()` can now also handle file paths as opposed to just directories.
+      - Added an optional paramater to :func:`delete_files()` to enable it to skip deleting files such as *.htaccess* and *index.html*.
       - Deprecated function ``read_file()`` - it's just an alias for PHP's native ``file_get_contents()``.
 
    -  :doc:`String Helper <helpers/string_helper>` changes include:
 
       - Deprecated function ``repeater()`` - it's just an alias for PHP's native ``str_repeat()``.
       - Deprecated function ``trim_slashes()`` - it's just an alias for PHP's native ``trim()`` (with a slash as its second argument).
-      - Deprecated randomization type options **unique** and **encrypt** for funcion :php:func:`random_string()` (they are only aliases for **md5** and **sha1** respectively).
+      - Deprecated randomization type options **unique** and **encrypt** for funcion :func:`random_string()` (they are only aliases for **md5** and **sha1** respectively).
 
    -  :doc:`CAPTCHA Helper <helpers/captcha_helper>` changes include:
 
       - Added *word_length* and *pool* options to allow customization of the generated word.
       - Added *colors* configuration to allow customization for the *background*, *border*, *text* and *grid* colors.
 
-   -  :doc:`Directory Helper <helpers/directory_helper>` :php:func:`directory_map()` will now append ``DIRECTORY_SEPARATOR`` to directory names in the returned array.
-   -  :doc:`Language Helper <helpers/language_helper>` :php:func:`lang()` now accepts an optional list of additional HTML attributes.
+   -  :doc:`Directory Helper <helpers/directory_helper>` :func:`directory_map()` will now append ``DIRECTORY_SEPARATOR`` to directory names in the returned array.
+   -  :doc:`Language Helper <helpers/language_helper>` :func:`lang()` now accepts an optional list of additional HTML attributes.
    -  Deprecated the :doc:`Email Helper <helpers/email_helper>` as its ``valid_email()``, ``send_email()`` functions are now only aliases for PHP native functions ``filter_var()`` and ``mail()`` respectively.
 
 -  Database
@@ -387,12 +387,12 @@ Release Date: Not Released
 
    -  :doc:`Common functions <general/common_functions>` changes include:
 
-      -  Added function :php:func:`get_mimes()` to return the *application/config/mimes.php* array.
-      -  Added support for HTTP code 303 ("See Other") in :php:func:`set_status_header()`.
-      -  Removed redundant conditional to determine HTTP server protocol in :php:func:`set_status_header()`.
+      -  Added function :func:`get_mimes()` to return the *application/config/mimes.php* array.
+      -  Added support for HTTP code 303 ("See Other") in :func:`set_status_header()`.
+      -  Removed redundant conditional to determine HTTP server protocol in :func:`set_status_header()`.
       -  Changed ``_exception_handler()`` to respect php.ini *display_errors* setting.
-      -  Added function :php:func:`is_https()` to check if a secure connection is used.
-      -  Added function :php:func:`function_usable()` to check if a function exists and is not disabled by `Suhosin <http://www.hardened-php.net/suhosin/>`.
+      -  Added function :func:`is_https()` to check if a secure connection is used.
+      -  Added function :func:`function_usable()` to check if a function exists and is not disabled by `Suhosin <http://www.hardened-php.net/suhosin/>`.
 
    -  :doc:`Output Library <libraries/output>` changes include:
 
@@ -437,13 +437,13 @@ Bug fixes for 3.0
 -  Fixed a bug (#181) where a mis-spelling was in the form validation language file.
 -  Fixed a bug (#159, #163) - :doc:`Query Builder <database/query_builder>` nested transactions didn't work properly due to ``_trans_depth`` not being incremented.
 -  Fixed a bug (#737, #75) - :doc:`Pagination <libraries/pagination>` anchor class was not set properly when using initialize method.
--  Fixed a bug (#419) - :php:func:`auto_link()` didn't recognize URLs that come after a word boundary.
+-  Fixed a bug (#419) - :func:`auto_link()` didn't recognize URLs that come after a word boundary.
 -  Fixed a bug (#724) - :doc:`Form Validation Library <libraries/form_validation>` rule **is_unique** didn't check if a database connection exists.
 -  Fixed a bug (#647) - :doc:`Zip Library <libraries/zip>` internal method ``_get_mod_time()`` didn't suppress possible "stat failed" errors generated by ``filemtime()``.
 -  Fixed a bug (#157, #174) - :doc:`Image Manipulation Library <libraries/image_lib>` method ``clear()`` didn't completely clear properties.
 -  Fixed a bug where :doc:`Database Forge <database/forge>` method ``create_table()`` with PostgreSQL database could lead to fetching the whole table.
--  Fixed a bug (#795) - :doc:`Form Helper <helpers/form_helper>` :php:func:`form_open()` didn't add the default form *method* and *accept-charset* when an empty array is passed to it.
--  Fixed a bug (#797) - :php:func:`timespan()` was using incorrect seconds for year and month.
+-  Fixed a bug (#795) - :doc:`Form Helper <helpers/form_helper>` :func:`form_open()` didn't add the default form *method* and *accept-charset* when an empty array is passed to it.
+-  Fixed a bug (#797) - :func:`timespan()` was using incorrect seconds for year and month.
 -  Fixed a bug in CI_Cart::contents() where if called without a TRUE (or equal) parameter, it would fail due to a typo.
 -  Fixed a bug (#696) - make oci_execute() calls inside num_rows() non-committing, since they are only there to reset which row is next in line for oci_fetch calls and thus don't need to be committed.
 -  Fixed a bug (#406) - SQLSRV DB driver not returning resource on ``db_pconnect()``.
@@ -570,7 +570,7 @@ Bug fixes for 3.0
 -  Fixed a bug - :doc:`Routing Library <general/routing>` didn't properly handle *default_controller* in a subdirectory when a method is also specified.
 -  Fixed a bug (#953) - :doc:`post_controller_constructor hook <general/hooks>` wasn't called with a *404_override*.
 -  Fixed a bug (#1220) - :doc:`Profiler Library <general/profiling>` didn't display information for database objects that are instantiated inside models.
--  Fixed a bug (#1978) - :doc:`Directory Helper <helpers/directory_helper>` function :php:func:`directory_map()`'s return array didn't make a distinction between directories and file indexes when a directory with a numeric name is present.
+-  Fixed a bug (#1978) - :doc:`Directory Helper <helpers/directory_helper>` function :func:`directory_map()`'s return array didn't make a distinction between directories and file indexes when a directory with a numeric name is present.
 -  Fixed a bug (#777) - :doc:`Loader Library <libraries/loader>` didn't look for helper extensions in added package paths.
 -  Fixed a bug (#18) - :doc:`APC Cache <libraries/caching>` driver didn't (un)serialize data, resulting in failure to store objects.
 -  Fixed a bug (#188) - :doc:`Unit Testing Library <libraries/unit_testing>` filled up logs with error messages for non-existing language keys.
@@ -594,7 +594,7 @@ Bug fixes for 3.0
 -  Fixed a bug (#2425) - OCI8 :doc:`database <database>` driver's method ``stored_procedure()`` didn't log an error unless **db_debug** was set to TRUE.
 -  Fixed a bug (#2490) - :doc:`Database Class <database/queries>` method ``query()`` returning boolean instead of a result object for PostgreSQL-specific *INSERT INTO ... RETURNING* statements.
 -  Fixed a bug (#249) - :doc:`Cache Library <libraries/caching>` didn't properly handle Memcache(d) configurations with missing options.
--  Fixed a bug (#180) - :php:func:`config_item()` didn't take into account run-time configuration changes.
+-  Fixed a bug (#180) - :func:`config_item()` didn't take into account run-time configuration changes.
 
 Version 2.1.4
 =============
diff --git a/user_guide_src/source/general/reserved_names.rst b/user_guide_src/source/general/reserved_names.rst
index ccc17d61b..a767651fb 100644
--- a/user_guide_src/source/general/reserved_names.rst
+++ b/user_guide_src/source/general/reserved_names.rst
@@ -25,22 +25,22 @@ your controller any of these:
 Functions
 ---------
 
--  :php:func:`is_php()`
--  :php:func:`is_really_writable()`
+-  :func:`is_php()`
+-  :func:`is_really_writable()`
 -  ``load_class()``
 -  ``is_loaded()``
 -  ``get_config()``
--  :php:func:`config_item()`
--  :php:func:`show_error()`
--  :php:func:`show_404()`
--  :php:func:`log_message()`
--  :php:func:`set_status_header()`
--  :php:func:`get_mimes()`
--  :php:func:`html_escape()`
--  :php:func:`remove_invisible_characters()`
--  :php:func:`is_https()`
--  :php:func:`function_usable()`
--  :php:func:`get_instance()`
+-  :func:`config_item()`
+-  :func:`show_error()`
+-  :func:`show_404()`
+-  :func:`log_message()`
+-  :func:`set_status_header()`
+-  :func:`get_mimes()`
+-  :func:`html_escape()`
+-  :func:`remove_invisible_characters()`
+-  :func:`is_https()`
+-  :func:`function_usable()`
+-  :func:`get_instance()`
 -  ``_exception_handler()``
 -  ``_stringify_attributes()``
 
diff --git a/user_guide_src/source/helpers/date_helper.rst b/user_guide_src/source/helpers/date_helper.rst
index 67ead0330..1a552c920 100644
--- a/user_guide_src/source/helpers/date_helper.rst
+++ b/user_guide_src/source/helpers/date_helper.rst
@@ -195,7 +195,7 @@ human_to_unix()
 	:param	int 	$datestr: Date string
 	:returns:	int UNIX timestamp or FALSE on failure
 
-The opposite of the :php:func:`unix_to_time()` function. Takes a "human"
+The opposite of the :func:`unix_to_time()` function. Takes a "human"
 time as input and returns it as a UNIX timestamp. This is useful if you
 accept "human" formatted dates submitted via a form. Returns boolean FALSE
 date string passed to it is not formatted as indicated above.
@@ -323,7 +323,7 @@ Example::
 	echo timezones('UM5');
 
 
-This function is useful when used with :php:func:`timezone_menu()`.
+This function is useful when used with :func:`timezone_menu()`.
 
 timezone_menu()
 ===============
diff --git a/user_guide_src/source/helpers/form_helper.rst b/user_guide_src/source/helpers/form_helper.rst
index e88a5de87..fd66f0191 100644
--- a/user_guide_src/source/helpers/form_helper.rst
+++ b/user_guide_src/source/helpers/form_helper.rst
@@ -81,7 +81,7 @@ form_open_multipart()
 	:param	array	$hidden: An array of hidden fields' definitions
 	:returns:	string
 
-This function is absolutely identical to :php:func:`form_open()` above,
+This function is absolutely identical to :func:`form_open()` above,
 except that it adds a *multipart* attribute, which is necessary if you
 would like to use the form to upload files with.
 
@@ -204,7 +204,7 @@ form_password()
 	:param	string	$extra: Extra attributes to be added to the tag *as is*
 	:returns:	string
 
-This function is identical in all respects to the :php:func:`form_input()`
+This function is identical in all respects to the :func:`form_input()`
 function above except that it uses the "password" input type.
 
 form_upload()
@@ -217,7 +217,7 @@ form_upload()
 	:param	string	$extra: Extra attributes to be added to the tag *as is*
 	:returns:	string
 
-This function is identical in all respects to the :php:func:`form_input()`
+This function is identical in all respects to the :func:`form_input()`
 function above except that it uses the "file" input type, allowing it to
 be used to upload files.
 
@@ -231,7 +231,7 @@ form_textarea()
 	:param	string	$extra: Extra attributes to be added to the tag *as is*
 	:returns:	string
 
-This function is identical in all respects to the :php:func:`form_input()`
+This function is identical in all respects to the :func:`form_input()`
 function above except that it generates a "textarea" type.
 
 .. note: Instead of the *maxlength* and *size* attributes in the above example,
@@ -318,7 +318,7 @@ contain the name of the field, the second parameter will contain an
 associative array of options, and the third parameter will contain the
 value or values you wish to be selected.
 
-The parameter usage is identical to using :php:func:`form_dropdown()` above,
+The parameter usage is identical to using :func:`form_dropdown()` above,
 except of course that the name of the field will need to use POST array
 syntax, e.g. foo[].
 
@@ -440,7 +440,7 @@ form_radio()
 	:param	string	$extra: Extra attributes to be added to the tag *as is*
 	:returns:	string
 
-This function is identical in all respects to the :php:func:`form_checkbox()`
+This function is identical in all respects to the :func:`form_checkbox()`
 function above except that it uses the "radio" input type.
 
 form_label()
@@ -501,7 +501,7 @@ form_reset()
 	:returns:	string
 
 Lets you generate a standard reset button. Use is identical to
-:php:func:`form_submit()`.
+:func:`form_submit()`.
 
 form_button()
 =============
@@ -660,7 +660,7 @@ set_radio()
 	:returns:	string
 
 Permits you to display radio buttons in the state they were submitted.
-This function is identical to the :php:func:`set_checkbox()` function above.
+This function is identical to the :func:`set_checkbox()` function above.
 
 Example::
 
@@ -704,7 +704,7 @@ validation_errors()
 	:param	string	$suffix: Error closing tag
 	:returns:	string
 
-Similarly to the :php:func:`form_error()` function, returns all validation
+Similarly to the :func:`form_error()` function, returns all validation
 error messages produced by the :doc:`Form Validation Library
 <../libraries/form_validation>`, with optional opening and closing tags
 around each of the messages.
diff --git a/user_guide_src/source/helpers/html_helper.rst b/user_guide_src/source/helpers/html_helper.rst
index cc0f2d3ab..1016d3bcd 100644
--- a/user_guide_src/source/helpers/html_helper.rst
+++ b/user_guide_src/source/helpers/html_helper.rst
@@ -286,7 +286,7 @@ The above code will produce this::
 	:param	array	$attributes: HTML attributes
 	:returns:	string
 
-Identical to :php:func:`ul()`, only it produces the <ol> tag for
+Identical to :func:`ul()`, only it produces the <ol> tag for
 ordered lists instead of <ul>.
 
 meta()
diff --git a/user_guide_src/source/helpers/security_helper.rst b/user_guide_src/source/helpers/security_helper.rst
index b06f78df6..cf9854c1b 100644
--- a/user_guide_src/source/helpers/security_helper.rst
+++ b/user_guide_src/source/helpers/security_helper.rst
@@ -97,7 +97,7 @@ encode_php_tags()
 
 This is a security function that converts PHP tags to entities.
 
-.. note: :php:func:`xss_clean()` does this automatically, if you use it.
+.. note: :func:`xss_clean()` does this automatically, if you use it.
 
 Example::
 
diff --git a/user_guide_src/source/helpers/smiley_helper.rst b/user_guide_src/source/helpers/smiley_helper.rst
index cfb4acb98..3fad253b2 100644
--- a/user_guide_src/source/helpers/smiley_helper.rst
+++ b/user_guide_src/source/helpers/smiley_helper.rst
@@ -46,7 +46,7 @@ The Controller
 In your `application/controllers/` folder, create a file called
 smileys.php and place the code below in it.
 
-.. important:: Change the URL in the :php:func:`get_clickable_smileys()`
+.. important:: Change the URL in the :func:`get_clickable_smileys()`
 	function below so that it points to your smiley folder.
 
 You'll notice that in addition to the smiley helper, we are also using
@@ -100,7 +100,7 @@ links a generic name that will be tied to a specific id in your view.
 	$image_array = get_smiley_links("http://example.com/images/smileys/", "comment_textarea_alias");
 
 To map the alias to the field id, pass them both into the
-:php:func:`smiley_js()` function::
+:func:`smiley_js()` function::
 
 	$image_array = smiley_js("comment_textarea_alias", "comments");
 
diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst
index b396d9acb..74e87e2d6 100644
--- a/user_guide_src/source/installation/upgrade_300.rst
+++ b/user_guide_src/source/installation/upgrade_300.rst
@@ -261,7 +261,7 @@ CodeIgniter 3.1+.
 String helper repeater()
 ========================
 
-:doc:`String Helper <../helpers/string_helper>` function :php:func:`repeater()` is now just an alias for
+:doc:`String Helper <../helpers/string_helper>` function :func:`repeater()` is now just an alias for
 PHP's native ``str_repeat()`` function. It is deprecated and scheduled for removal in CodeIgniter 3.1+.
 
 .. note:: This function is still available, but you're strongly encouraged to remove its usage sooner
@@ -270,7 +270,7 @@ PHP's native ``str_repeat()`` function. It is deprecated and scheduled for remov
 String helper trim_slashes()
 ============================
 
-:doc:`String Helper <../helpers/string_helper>` function :php:func:`trim_slashes()` is now just an alias
+:doc:`String Helper <../helpers/string_helper>` function :func:`trim_slashes()` is now just an alias
 for PHP's native ``trim()`` function (with a slash passed as its second argument). It is deprecated and
 scheduled for removal in CodeIgniter 3.1+.
 
@@ -282,8 +282,8 @@ Email helper functions
 
 :doc:`Email Helper <../helpers/email_helper>` only has two functions
 
- - :php:func:`valid_email()`
- - :php:func:`send_email()`
+ - :func:`valid_email()`
+ - :func:`send_email()`
 
 Both of them are now aliases for PHP's native ``filter_var()`` and ``mail()`` functions, respectively.
 Therefore the :doc:`Email Helper <../helpers/email_helper>` altogether is being deprecated and
@@ -333,7 +333,7 @@ CodeIgniter 3.1+.
 String helper random_string() types 'unique' and 'encrypt'
 ==========================================================
 
-When using the :doc:`String Helper <../helpers/string_helper>` function :php:func:`random_string()`,
+When using the :doc:`String Helper <../helpers/string_helper>` function :func:`random_string()`,
 you should no longer pass the **unique** and **encrypt** randomization types. They are only
 aliases for **md5** and **sha1** respectively and are now deprecated and scheduled for removal
 in CodeIgniter 3.1+.
@@ -344,7 +344,7 @@ in CodeIgniter 3.1+.
 URL helper url_title() separators 'dash' and 'underscore'
 =========================================================
 
-When using the :doc:`URL Helper <../helpers/url_helper>` function :php:func:`url_title()`, you
+When using the :doc:`URL Helper <../helpers/url_helper>` function :func:`url_title()`, you
 should no longer pass **dash** or **underscore** as the word separator. This function will
 now accept any character and you should just pass the chosen character directly, so you
 should write '-' instead of 'dash' and '_' instead of 'underscore'.
diff --git a/user_guide_src/source/libraries/language.rst b/user_guide_src/source/libraries/language.rst
index d288cd65e..e772e8e27 100644
--- a/user_guide_src/source/libraries/language.rst
+++ b/user_guide_src/source/libraries/language.rst
@@ -79,7 +79,7 @@ Using language lines as form labels
 -----------------------------------
 
 This feature has been deprecated from the language library and moved to
-the :php:func:`lang()` function of the :doc:`Language Helper
+the :func:`lang()` function of the :doc:`Language Helper
 <../helpers/language_helper>`.
 
 Auto-loading Languages
-- 
cgit v1.2.3-24-g4f1b


From 4b184f3cbb48fcddf24f3c09d0f85baeca0f6480 Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Fri, 19 Jul 2013 16:41:57 -0700
Subject: Update String helper docs

---
 user_guide_src/source/helpers/string_helper.rst | 204 +++++++++++-------------
 1 file changed, 96 insertions(+), 108 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/helpers/string_helper.rst b/user_guide_src/source/helpers/string_helper.rst
index b6417c2a6..1ca654ea6 100644
--- a/user_guide_src/source/helpers/string_helper.rst
+++ b/user_guide_src/source/helpers/string_helper.rst
@@ -5,7 +5,12 @@ String Helper
 The String Helper file contains functions that assist in working with
 strings.
 
-.. contents:: Page Contents
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
 
 Loading this Helper
 ===================
@@ -14,124 +19,115 @@ This helper is loaded using the following code::
 
 	$this->load->helper('string');
 
+Available Functions
+===================
+
 The following functions are available:
 
-random_string()
-===============
 
-.. function:: random_string($type = 'alnum', $len = 8)
+.. function:: random_string([$type = 'alnum'[, $len = 8]])
 
 	:param	string	$type: Randomization type
 	:param	int	$len: Output string length
 	:returns:	string
 
-Generates a random string based on the type and length you specify.
-Useful for creating passwords or generating random hashes.
+	Generates a random string based on the type and length you specify.
+	Useful for creating passwords or generating random hashes.
 
-The first parameter specifies the type of string, the second parameter
-specifies the length. The following choices are available:
+	The first parameter specifies the type of string, the second parameter
+	specifies the length. The following choices are available:
 
--  **alpha**: A string with lower and uppercase letters only.
--  **alnum**: Alpha-numeric string with lower and uppercase characters.
--  **basic**: A random number based on ``mt_rand()``.
--  **numeric**: Numeric string.
--  **nozero**: Numeric string with no zeros.
--  **md5**: An encrypted random number based on ``md5()`` (fixed length of 32).
--  **sha1**: An encrypted random number based on ``sha1()`` (fixed length of 40).
+	-  **alpha**: A string with lower and uppercase letters only.
+	-  **alnum**: Alpha-numeric string with lower and uppercase characters.
+	-  **basic**: A random number based on ``mt_rand()``.
+	-  **numeric**: Numeric string.
+	-  **nozero**: Numeric string with no zeros.
+	-  **md5**: An encrypted random number based on ``md5()`` (fixed length of 32).
+	-  **sha1**: An encrypted random number based on ``sha1()`` (fixed length of 40).
 
-Usage example::
+	Usage example::
 
-	echo random_string('alnum', 16);
+		echo random_string('alnum', 16);
 
-.. note:: Usage of the *unique* and *encrypt* types is DEPRECATED. They
-	are just aliases for *md5* and *sha1* respectively.
+	.. note:: Usage of the *unique* and *encrypt* types is DEPRECATED. They
+		are just aliases for *md5* and *sha1* respectively.
 
-increment_string()
-==================
 
-.. function:: increment_string($str, $separator = '_', $first = 1)
+.. function:: increment_string($str[, $separator = '_'[, $first = 1]])
 
 	:param	string	$str: Input string
 	:param	string	$separator: Separator to append a duplicate number with
 	:param	int	$first: Starting number
 	:returns:	string
 
-Increments a string by appending a number to it or increasing the
-number. Useful for creating "copies" or a file or duplicating database
-content which has unique titles or slugs.
+	Increments a string by appending a number to it or increasing the
+	number. Useful for creating "copies" or a file or duplicating database
+	content which has unique titles or slugs.
 
-Usage example::
+	Usage example::
 
-	echo increment_string('file', '_'); // "file_1"
-	echo increment_string('file', '-', 2); // "file-2"
-	echo increment_string('file_4'); // "file_5"
+		echo increment_string('file', '_'); // "file_1"
+		echo increment_string('file', '-', 2); // "file-2"
+		echo increment_string('file_4'); // "file_5"
 
-alternator()
-============
 
 .. function:: alternator($args)
 
 	:param	mixed	$args: A variable number of arguments
 	:returns:	mixed
 
-Allows two or more items to be alternated between, when cycling through
-a loop. Example::
+	Allows two or more items to be alternated between, when cycling through
+	a loop. Example::
 
-	for ($i = 0; $i < 10; $i++)
-	{     
-		echo alternator('string one', 'string two');
-	}
+		for ($i = 0; $i < 10; $i++)
+		{     
+			echo alternator('string one', 'string two');
+		}
 
-You can add as many parameters as you want, and with each iteration of
-your loop the next item will be returned.
+	You can add as many parameters as you want, and with each iteration of
+	your loop the next item will be returned.
 
-::
+	::
 
-	for ($i = 0; $i < 10; $i++)
-	{     
-		echo alternator('one', 'two', 'three', 'four', 'five');
-	}
+		for ($i = 0; $i < 10; $i++)
+		{     
+			echo alternator('one', 'two', 'three', 'four', 'five');
+		}
 
-.. note:: To use multiple separate calls to this function simply call the
-	function with no arguments to re-initialize.
+	.. note:: To use multiple separate calls to this function simply call the
+		function with no arguments to re-initialize.
 
-repeater()
-==========
 
-.. function:: repeater($data, $num = 1)
+.. function:: repeater($data[, $num = 1])
 
 	:param	string	$data: Input
 	:param	int	$num: Number of times to repeat
 	:returns:	string
 
-Generates repeating copies of the data you submit. Example::
+	Generates repeating copies of the data you submit. Example::
 
-	$string = "\n";
-	echo repeater($string, 30);
+		$string = "\n";
+		echo repeater($string, 30);
 
-The above would generate 30 newlines.
+	The above would generate 30 newlines.
 
-.. note:: This function is DEPRECATED. Use the native ``str_repeat()``
-	instead.
+	.. note:: This function is DEPRECATED. Use the native ``str_repeat()``
+		instead.
 
-reduce_double_slashes()
-=======================
 
 .. function:: reduce_double_slashes($str)
 
 	:param	string	$str: Input string
 	:returns:	string
 
-Converts double slashes in a string to a single slash, except those
-found in URL protocol prefixes (e.g. http://).
+	Converts double slashes in a string to a single slash, except those
+	found in URL protocol prefixes (e.g. http://).
 
-Example::
+	Example::
 
-	$string = "http://example.com//index.php";
-	echo reduce_double_slashes($string); // results in "http://example.com/index.php"
+		$string = "http://example.com//index.php";
+		echo reduce_double_slashes($string); // results in "http://example.com/index.php"
 
-strip_slashes()
-===============
 
 .. function:: strip_slashes($data)
 
@@ -140,88 +136,80 @@ strip_slashes()
 
 Removes any slashes from an array of strings.
 
-Example::
+	Example::
 
-	$str = array(
-		'question'  => 'Is your name O\'reilly?',
-		'answer' => 'No, my name is O\'connor.'
-	);
+		$str = array(
+			'question'  => 'Is your name O\'reilly?',
+			'answer' => 'No, my name is O\'connor.'
+		);
 
-	$str = strip_slashes($str);
+		$str = strip_slashes($str);
 
-The above will return the following array::
+	The above will return the following array::
 
-	array(
-		'question'  => "Is your name O'reilly?",
-		'answer' => "No, my name is O'connor."
-	);
+		array(
+			'question'  => "Is your name O'reilly?",
+			'answer' => "No, my name is O'connor."
+		);
 
-.. note:: For historical reasons, this function will also accept
-	and handle string inputs. This however makes it just an
-	alias for ``stripslashes()``.
+	.. note:: For historical reasons, this function will also accept
+		and handle string inputs. This however makes it just an
+		alias for ``stripslashes()``.
 
-trim_slashes()
-==============
 
 .. function:: trim_slashes($str)
 
 	:param	string	$str: Input string
 	:returns:	string
 
-Removes any leading/trailing slashes from a string. Example::
+	Removes any leading/trailing slashes from a string. Example::
 
-	$string = "/this/that/theother/";
-	echo trim_slashes($string); // results in this/that/theother
+		$string = "/this/that/theother/";
+		echo trim_slashes($string); // results in this/that/theother
 
-.. note:: This function is DEPRECATED. Use the native ``trim()`` instead:
-	|
-	| trim($str, '/');
+	.. note:: This function is DEPRECATED. Use the native ``trim()`` instead:
+		|
+		| trim($str, '/');
 
-reduce_multiples()
-==================
 
-.. function:: reduce_multiples($str, $character = '', $trim = FALSE)
+.. function:: reduce_multiples($str[, $character = ''[, $trim = FALSE]])
 
 	:param	string	$str: Text to search in
 	:param	string	$character: Character to reduce
 	:param	bool	$trim: Whether to also trim the specified character
 	:returns:	string
 
-Reduces multiple instances of a particular character occuring directly
-after each other. Example::
+	Reduces multiple instances of a particular character occuring directly
+	after each other. Example::
 
-	$string = "Fred, Bill,, Joe, Jimmy";
-	$string = reduce_multiples($string,","); //results in "Fred, Bill, Joe, Jimmy"
+		$string = "Fred, Bill,, Joe, Jimmy";
+		$string = reduce_multiples($string,","); //results in "Fred, Bill, Joe, Jimmy"
 
-If the third parameter is set to TRUE it will remove occurences of the
-character at the beginning and the end of the string. Example::
+	If the third parameter is set to TRUE it will remove occurrences of the
+	character at the beginning and the end of the string. Example::
 
-	$string = ",Fred, Bill,, Joe, Jimmy,";
-	$string = reduce_multiples($string, ", ", TRUE); //results in "Fred, Bill, Joe, Jimmy"
+		$string = ",Fred, Bill,, Joe, Jimmy,";
+		$string = reduce_multiples($string, ", ", TRUE); //results in "Fred, Bill, Joe, Jimmy"
 
-quotes_to_entities()
-====================
 
 .. function:: quotes_to_entities($str)
 
 	:param	string	$str: Input string
 	:returns:	string
 
-Converts single and double quotes in a string to the corresponding HTML
-entities. Example::
+	Converts single and double quotes in a string to the corresponding HTML
+	entities. Example::
 
-	$string = "Joe's \"dinner\"";
-	$string = quotes_to_entities($string); //results in "Joe&#39;s &quot;dinner&quot;"
+		$string = "Joe's \"dinner\"";
+		$string = quotes_to_entities($string); //results in "Joe&#39;s &quot;dinner&quot;"
 
-strip_quotes()
-==============
 
 .. function:: strip_quotes($str)
 
 	:param	string	$str: Input string
 	:returns:	string
 
-Removes single and double quotes from a string. Example::
+	Removes single and double quotes from a string. Example::
 
-	$string = "Joe's \"dinner\"";
-	$string = strip_quotes($string); //results in "Joes dinner"
\ No newline at end of file
+		$string = "Joe's \"dinner\"";
+		$string = strip_quotes($string); //results in "Joes dinner"
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From f33091fa39002415f0fe91ffd48ffba0f2395299 Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Fri, 19 Jul 2013 16:44:19 -0700
Subject: Update Smiley helper docs

---
 user_guide_src/source/helpers/smiley_helper.rst | 59 +++++++++++++------------
 1 file changed, 30 insertions(+), 29 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/helpers/smiley_helper.rst b/user_guide_src/source/helpers/smiley_helper.rst
index 3fad253b2..a42440f2a 100644
--- a/user_guide_src/source/helpers/smiley_helper.rst
+++ b/user_guide_src/source/helpers/smiley_helper.rst
@@ -5,7 +5,12 @@ Smiley Helper
 The Smiley Helper file contains functions that let you manage smileys
 (emoticons).
 
-.. contents:: Page Contents
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
 
 Loading this Helper
 ===================
@@ -104,61 +109,57 @@ To map the alias to the field id, pass them both into the
 
 	$image_array = smiley_js("comment_textarea_alias", "comments");
 
-get_clickable_smileys()
-=======================
+Available Functions
+===================
 
-.. function:: get_clickable_smileys($image_url, $alias = '', $smileys = NULL)
+.. function:: get_clickable_smileys($image_url[, $alias = ''[, $smileys = NULL]])
 
 	:param	string	$image_url: URL path to the smileys directory
 	:param	string	$alias: Field alias
 	:returns:	array
 
-Returns an array containing your smiley images wrapped in a clickable
-link. You must supply the URL to your smiley folder and a field id or
-field alias.
+	Returns an array containing your smiley images wrapped in a clickable
+	link. You must supply the URL to your smiley folder and a field id or
+	field alias.
 
-Example::
+	Example::
 
-	$image_array = get_smiley_links("http://example.com/images/smileys/", "comment");
+		$image_array = get_smiley_links("http://example.com/images/smileys/", "comment");
 
-smiley_js()
-===========
 
-.. function:: smiley_js($alias = '', $field_id = '', $inline = TRUE)
+.. function:: smiley_js([$alias = ''[, $field_id = ''[, $inline = TRUE]]])
 
 	:param	string	$alias: Field alias
 	:param	string	$field_id: Field ID
 	:param	bool	$inline: Whether we're inserting an inline smiley
 
-Generates the JavaScript that allows the images to be clicked and
-inserted into a form field. If you supplied an alias instead of an id
-when generating your smiley links, you need to pass the alias and
-corresponding form id into the function. This function is designed to be
-placed into the <head> area of your web page.
+	Generates the JavaScript that allows the images to be clicked and
+	inserted into a form field. If you supplied an alias instead of an id
+	when generating your smiley links, you need to pass the alias and
+	corresponding form id into the function. This function is designed to be
+	placed into the <head> area of your web page.
 
-Example::
+	Example::
 
-	<?php echo smiley_js(); ?>
+		<?php echo smiley_js(); ?>
 
-parse_smileys()
-===============
 
-.. function:: parse_smileys($str = '', $image_url = '', $smileys = NULL)
+.. function:: parse_smileys([$str = ''[, $image_url = ''[, $smileys = NULL]]])
 
 	:param	string	$str: Text containing smiley codes
 	:param	string	$image_url: URL path to the smileys directory
 	:param	array	$smileys: An array of smileys
 	:returns:	string
 
-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 URL to your smiley folder
+	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 URL to your smiley folder
 
-Example::
+	Example::
 
-	$str = 'Here are some simileys: :-)  ;-)';
-	$str = parse_smileys($str, "http://example.com/images/smileys/");
-	echo $str;
+		$str = 'Here are some simileys: :-)  ;-)';
+		$str = parse_smileys($str, "http://example.com/images/smileys/");
+		echo $str;
 
 
 .. |smile!| image:: ../images/smile.gif
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From f9491c984d56a9fb363f572bd4c10a185e5f186b Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Fri, 19 Jul 2013 16:46:18 -0700
Subject: Update Security helper docs

---
 user_guide_src/source/helpers/security_helper.rst | 80 +++++++++++------------
 1 file changed, 39 insertions(+), 41 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/helpers/security_helper.rst b/user_guide_src/source/helpers/security_helper.rst
index cf9854c1b..7df85d017 100644
--- a/user_guide_src/source/helpers/security_helper.rst
+++ b/user_guide_src/source/helpers/security_helper.rst
@@ -4,7 +4,12 @@ Security Helper
 
 The Security Helper file contains security related functions.
 
-.. contents:: Page Contents
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
 
 Loading this Helper
 ===================
@@ -13,92 +18,85 @@ This helper is loaded using the following code::
 
 	$this->load->helper('security');
 
+Available Functions
+===================
+
 The following functions are available:
 
-xss_clean()
-===========
 
-.. function:: xss_clean($str, $is_image = FALSE)
+.. function:: xss_clean($str[, $is_image = FALSE])
 
 	:param	string	$str: Input data
 	:param	bool	$is_image: Whether we're dealing with an image
 	:returns:	string
 
-Provides Cross Site Script Hack filtering.
+	Provides Cross Site Script Hack filtering.
 
-This function is an alias for ``CI_Input::xss_clean()``. For more info,
-please see the :doc:`Input Library <../libraries/input>` documentation.
+	This function is an alias for ``CI_Input::xss_clean()``. For more info,
+	please see the :doc:`Input Library <../libraries/input>` documentation.
 
-sanitize_filename()
-===================
 
 .. function:: sanitize_filename($filename)
 
 	:param	string	$filename: Filename
 	:returns:	string
 
-Provides protection against directory traversal.
+	Provides protection against directory traversal.
 
-This function is an alias for ``CI_Security::sanitize_filename()``.
-For more info, please see the :doc:`Security Library <../libraries/security>`
-documentation.
+	This function is an alias for ``CI_Security::sanitize_filename()``.
+	For more info, please see the :doc:`Security Library <../libraries/security>`
+	documentation.
 
-do_hash()
-=========
 
-.. function:: do_hash($str, $type = 'sha1')
+.. function:: do_hash($str[, $type = 'sha1'])
 
 	:param	string	$str: Input
 	:param	string	$type: Algorithm
 	:returns:	string
 
-Permits you to create one way hashes suitable for encrypting
-passwords. Will use SHA1 by default.
+	Permits you to create one way hashes suitable for encrypting
+	passwords. Will use SHA1 by default.
 
-See `hash_algos() <http://php.net/function.hash_algos>`_
-for a full list of supported algorithms.
+	See `hash_algos() <http://php.net/function.hash_algos>`_
+	for a full list of supported algorithms.
 
-Examples::
+	Examples::
 
-	$str = do_hash($str); // SHA1
-	$str = do_hash($str, 'md5'); // MD5
+		$str = do_hash($str); // SHA1
+		$str = do_hash($str, 'md5'); // MD5
 
-.. note:: This function was formerly named ``dohash()``, which has been
-	removed in favor of ``do_hash()``.
+	.. note:: This function was formerly named ``dohash()``, which has been
+		removed in favor of ``do_hash()``.
 
-.. note:: This function is DEPRECATED. Use the native ``hash()`` instead.
+	.. note:: This function is DEPRECATED. Use the native ``hash()`` instead.
 
-strip_image_tags()
-==================
 
 .. function:: strip_image_tags($str)
 
 	:param	string	$str: Input
 	:returns:	string
 
-This is a security function that will strip image tags from a string.
-It leaves the image URL as plain text.
+	This is a security function that will strip image tags from a string.
+	It leaves the image URL as plain text.
 
-Example::
+	Example::
 
-	$string = strip_image_tags($string);
+		$string = strip_image_tags($string);
 
-This function is an alias for ``CI_Security::strip_image_tags()``. For
-more info, please see the :doc:`Security Library <../libraries/security>`
-documentation.
+	This function is an alias for ``CI_Security::strip_image_tags()``. For
+	more info, please see the :doc:`Security Library <../libraries/security>`
+	documentation.
 
-encode_php_tags()
-=================
 
 .. function:: encode_php_tags($str)
 
 	:param	string	$str: Input
 	:returns:	string
 
-This is a security function that converts PHP tags to entities.
+	This is a security function that converts PHP tags to entities.
 
-.. note: :func:`xss_clean()` does this automatically, if you use it.
+	.. note:: :func:`xss_clean()` does this automatically, if you use it.
 
-Example::
+	Example::
 
-	$string = encode_php_tags($string);
\ No newline at end of file
+		$string = encode_php_tags($string);
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 6851be175d1e7ab804a47d41d78807bef9805866 Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Fri, 19 Jul 2013 16:47:12 -0700
Subject: Update Path helper docs

---
 user_guide_src/source/helpers/path_helper.rst | 42 +++++++++++++++------------
 1 file changed, 24 insertions(+), 18 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/helpers/path_helper.rst b/user_guide_src/source/helpers/path_helper.rst
index 863a5589e..61877d75b 100644
--- a/user_guide_src/source/helpers/path_helper.rst
+++ b/user_guide_src/source/helpers/path_helper.rst
@@ -5,7 +5,12 @@ Path Helper
 The Path Helper file contains functions that permits you to work with
 file paths on the server.
 
-.. contents:: Page Contents
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
 
 Loading this Helper
 ===================
@@ -14,33 +19,34 @@ This helper is loaded using the following code::
 
 	$this->load->helper('path');
 
+Available Functions
+===================
+
 The following functions are available:
 
-set_realpath()
-==============
 
-.. function:: set_realpath($path, $check_existance = FALSE)
+.. function:: set_realpath($path[, $check_existance = FALSE])
 
 	:param	string	$path: Path
 	:param	bool	$check_existance: Whether to check if the path actually exists
 	:returns:	string
 
-This function will return a server path without symbolic links or
-relative directory structures. An optional second argument will
-cause an error to be triggered if the path cannot be resolved.
+	This function will return a server path without symbolic links or
+	relative directory structures. An optional second argument will
+	cause an error to be triggered if the path cannot be resolved.
 
-Examples::
+	Examples::
 
-	$file = '/etc/php5/apache2/php.ini';
-	echo set_realpath($file); // Prints '/etc/php5/apache2/php.ini'
+		$file = '/etc/php5/apache2/php.ini';
+		echo set_realpath($file); // Prints '/etc/php5/apache2/php.ini'
 
-	$non_existent_file = '/path/to/non-exist-file.txt';
-	echo set_realpath($non_existent_file, TRUE);	// Shows an error, as the path cannot be resolved
-	echo set_realpath($non_existent_file, FALSE);	// Prints '/path/to/non-exist-file.txt'
+		$non_existent_file = '/path/to/non-exist-file.txt';
+		echo set_realpath($non_existent_file, TRUE);	// Shows an error, as the path cannot be resolved
+		echo set_realpath($non_existent_file, FALSE);	// Prints '/path/to/non-exist-file.txt'
 
-	$directory = '/etc/php5';
-	echo set_realpath($directory);	// Prints '/etc/php5/'
+		$directory = '/etc/php5';
+		echo set_realpath($directory);	// Prints '/etc/php5/'
 
-	$non_existent_directory = '/path/to/nowhere';
-	echo set_realpath($non_existent_directory, TRUE);	// Shows an error, as the path cannot be resolved
-	echo set_realpath($non_existent_directory, FALSE);	// Prints '/path/to/nowhere'
\ No newline at end of file
+		$non_existent_directory = '/path/to/nowhere';
+		echo set_realpath($non_existent_directory, TRUE);	// Shows an error, as the path cannot be resolved
+		echo set_realpath($non_existent_directory, FALSE);	// Prints '/path/to/nowhere'
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From c8b742c22a54639cc30428a50dbafeee3d809329 Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Fri, 19 Jul 2013 16:47:54 -0700
Subject: Update Number helper docs

---
 user_guide_src/source/helpers/number_helper.rst | 42 ++++++++++++++-----------
 1 file changed, 24 insertions(+), 18 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/helpers/number_helper.rst b/user_guide_src/source/helpers/number_helper.rst
index 4e12f9a27..5a3d72b00 100644
--- a/user_guide_src/source/helpers/number_helper.rst
+++ b/user_guide_src/source/helpers/number_helper.rst
@@ -5,7 +5,12 @@ Number Helper
 The Number Helper file contains functions that help you work with
 numeric data.
 
-.. contents:: Page Contents
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
 
 Loading this Helper
 ===================
@@ -14,32 +19,33 @@ This helper is loaded using the following code::
 
 	$this->load->helper('number');
 
+Available Functions
+===================
+
 The following functions are available:
 
-byte_format()
-=============
 
-.. function:: byte_format($num, $precision = 1)
+.. function:: byte_format($num[, $precision = 1])
 
 	:param	mixed	$num: Number of bytes
 	:param	int	$precision: Floating point precision
 	:returns:	string
 
-Formats numbers as bytes, based on size, and adds the appropriate
-suffix. Examples::
+	Formats numbers as bytes, based on size, and adds the appropriate
+	suffix. Examples::
 
-	echo byte_format(456); // Returns 456 Bytes
-	echo byte_format(4567); // Returns 4.5 KB
-	echo byte_format(45678); // Returns 44.6 KB
-	echo byte_format(456789); // Returns 447.8 KB
-	echo byte_format(3456789); // Returns 3.3 MB
-	echo byte_format(12345678912345); // Returns 1.8 GB
-	echo byte_format(123456789123456789); // Returns 11,228.3 TB
+		echo byte_format(456); // Returns 456 Bytes
+		echo byte_format(4567); // Returns 4.5 KB
+		echo byte_format(45678); // Returns 44.6 KB
+		echo byte_format(456789); // Returns 447.8 KB
+		echo byte_format(3456789); // Returns 3.3 MB
+		echo byte_format(12345678912345); // Returns 1.8 GB
+		echo byte_format(123456789123456789); // Returns 11,228.3 TB
 
-An optional second parameter allows you to set the precision of the
-result::
+	An optional second parameter allows you to set the precision of the
+	result::
 
-	 echo byte_format(45678, 2); // Returns 44.61 KB
+		 echo byte_format(45678, 2); // Returns 44.61 KB
 
-.. note:: The text generated by this function is found in the following
-	language file: `language/<your_lang>/number_lang.php`
\ No newline at end of file
+	.. note:: The text generated by this function is found in the following
+		language file: `language/<your_lang>/number_lang.php`
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 49c43c4449b6e0f217e7da451645b6ad7b15653e Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Fri, 19 Jul 2013 16:51:08 -0700
Subject: Update Language helper docs

---
 user_guide_src/source/helpers/language_helper.rst | 34 +++++++++++++----------
 1 file changed, 20 insertions(+), 14 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/helpers/language_helper.rst b/user_guide_src/source/helpers/language_helper.rst
index 2b2342f16..9e5d9bdc9 100644
--- a/user_guide_src/source/helpers/language_helper.rst
+++ b/user_guide_src/source/helpers/language_helper.rst
@@ -5,7 +5,12 @@ Language Helper
 The Language Helper file contains functions that assist in working with
 language files.
 
-.. contents:: Page Contents
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
 
 Loading this Helper
 ===================
@@ -14,23 +19,24 @@ This helper is loaded using the following code::
 
 	$this->load->helper('language');
 
+Available Functions
+===================
+
 The following functions are available:
 
-lang()
-======
 
-.. function:: lang($line, $for = '', $attributes = array())
+.. function:: lang($line[, $for = ''[, $attributes = array()]])
 
-	:param	string	$line: Language line key
-	:param	string	$for: HTML "for" attribute (ID of the element we're creating a label for)
-	:param	array	$attributes: Any additional HTML attributes
-	:returns:	string
+  :param	string	$line: Language line key
+  :param	string	$for: HTML "for" attribute (ID of the element we're creating a label for)
+  :param	array	$attributes: Any additional HTML attributes
+  :returns:	string
 
-This function returns a line of text from a loaded language file with
-simplified syntax that may be more desirable for view files than
-``CI_Lang::line()``.
+  This function returns a line of text from a loaded language file with
+  simplified syntax that may be more desirable for view files than
+  ``CI_Lang::line()``.
 
-Example::
+  Example::
 
-	echo lang('language_key', 'form_item_id', array('class' => 'myClass');
-	// Outputs: <label for="form_item_id" class="myClass">Language line</label>
\ No newline at end of file
+  	echo lang('language_key', 'form_item_id', array('class' => 'myClass');
+  	// Outputs: <label for="form_item_id" class="myClass">Language line</label>
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From e721a65320315943f936ba7f68aed129e8514a61 Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Fri, 19 Jul 2013 17:00:42 -0700
Subject: Update Inflector helper docs

---
 user_guide_src/source/helpers/inflector_helper.rst | 62 ++++++++++------------
 1 file changed, 29 insertions(+), 33 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/helpers/inflector_helper.rst b/user_guide_src/source/helpers/inflector_helper.rst
index 5f1dea736..717ecc678 100644
--- a/user_guide_src/source/helpers/inflector_helper.rst
+++ b/user_guide_src/source/helpers/inflector_helper.rst
@@ -5,7 +5,12 @@ Inflector Helper
 The Inflector Helper file contains functions that permits you to change
 words to plural, singular, camel case, etc.
 
-.. contents:: Page Contents
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
 
 Loading this Helper
 ===================
@@ -14,86 +19,77 @@ This helper is loaded using the following code::
 
 	$this->load->helper('inflector');
 
+Available Functions
+===================
+
 The following functions are available:
 
-singular()
-==========
 
 .. function:: singular($str)
 
 	:param	string	$str: Input string
 	:returns:	string
 
-Changes a plural word to singular. Example::
+	Changes a plural word to singular. Example::
 
-	echo singular('dogs'); // Prints 'dog'
+		echo singular('dogs'); // Prints 'dog'
 
-plural()
-========
 
 .. function:: plural($str)
 
 	:param	string	$str: Input string
 	:returns:	string
 
-Changes a singular word to plural. Example::
+	Changes a singular word to plural. Example::
 
-	echo plural('dog'); // Prints 'dogs'
+		echo plural('dog'); // Prints 'dogs'
 
-camelize()
-==========
 
 .. function:: camelize($str)
 
 	:param	string	$str: Input string
 	:returns:	string
 
-Changes a string of words separated by spaces or underscores to camel
-case. Example::
+	Changes a string of words separated by spaces or underscores to camel
+	case. Example::
 
-	echo camelize('my_dog_spot'); // Prints 'myDogSpot'
+		echo camelize('my_dog_spot'); // Prints 'myDogSpot'
 
-underscore()
-============
 
-.. function:: camelize($str)
+.. function:: underscore($str)
 
 	:param	string	$str: Input string
 	:returns:	string
 
-Takes multiple words separated by spaces and underscores them.
-Example::
+	Takes multiple words separated by spaces and underscores them.
+	Example::
 
-	echo underscore('my dog spot'); // Prints 'my_dog_spot'
+		echo underscore('my dog spot'); // Prints 'my_dog_spot'
 
-humanize()
-==========
 
-.. function:: camelize($str)
+.. function:: humanize($str[, $separator = '_'])
 
 	:param	string	$str: Input string
 	:param	string	$separator: Input separator
 	:returns:	string
 
-Takes multiple words separated by underscores and adds spaces between
-them. Each word is capitalized.
+	Takes multiple words separated by underscores and adds spaces between
+	them. Each word is capitalized.
 
-Example::
+	Example::
 
-	echo humanize('my_dog_spot'); // Prints 'My Dog Spot'
+		echo humanize('my_dog_spot'); // Prints 'My Dog Spot'
 
-To use dashes instead of underscores::
+	To use dashes instead of underscores::
 
-	echo humanize('my-dog-spot', '-'); // Prints 'My Dog Spot'
+		echo humanize('my-dog-spot', '-'); // Prints 'My Dog Spot'
 
-is_countable()
-==============
 
 .. function:: is_countable($word)
 
 	:param	string	$word: Input string
 	:returns:	bool
 
-Checks if the given word has a plural version. Example::
+	Checks if the given word has a plural version. Example::
 
-	is_countable('equipment'); // Returns FALSE
\ No newline at end of file
+		is_countable('equipment'); // Returns FALSE
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 333ad2e25052ae741e523b1396892f96f8ec6a32 Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Fri, 19 Jul 2013 17:03:25 -0700
Subject: Update CAPTCHA helper docs

---
 user_guide_src/source/helpers/captcha_helper.rst | 86 +++++++++++++-----------
 1 file changed, 45 insertions(+), 41 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/helpers/captcha_helper.rst b/user_guide_src/source/helpers/captcha_helper.rst
index b40d8a252..13cf92a19 100644
--- a/user_guide_src/source/helpers/captcha_helper.rst
+++ b/user_guide_src/source/helpers/captcha_helper.rst
@@ -5,55 +5,24 @@ CAPTCHA Helper
 The CAPTCHA Helper file contains functions that assist in creating
 CAPTCHA images.
 
-.. contents:: Page Contents
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
 
 Loading this Helper
 ===================
 
-This helper is loaded using the following code
-::
+This helper is loaded using the following code::
 
 	$this->load->helper('captcha');
 
-The following functions are available:
-
-create_captcha()
-================
-
-.. function:: function create_captcha($data = '', $img_path = '', $img_url = '', $font_path = '')
-
-	:param	array	$data: Array of data for the CAPTCHA
-	:param	string	$img_path: Path to create the image in
-	:param	string	$img_url: URL to the CAPTCHA image folder
-	:param	string	$font_path: Server path to font
-	:returns:	array('word' => $word, 'time' => $now, 'image' => $img)
-
-Takes an array of information to generate the CAPTCHA as input and
-creates the image to your specifications, returning an array of
-associative data about the image.
-
-::
-
-	array(
-		'image'	=> IMAGE TAG
-		'time'	=> TIMESTAMP (in microtime)
-		'word'	=> CAPTCHA WORD
-	)
-
-The **image** is the actual image tag::
-
-	<img src="http://example.com/captcha/12345.jpg" width="140" height="50" />
-
-The **time** is the micro timestamp used as the image name without the
-file extension. It will be a number like this: 1139612155.3422
-
-The **word** is the word that appears in the captcha image, which if not
-supplied to the function, will be a random string.
-
 Using the CAPTCHA helper
-------------------------
+========================
 
-Once loaded you can generate a captcha like this::
+Once loaded you can generate a CAPTCHA like this::
 
 	$vals = array(
 		'word'		=> 'Random word',
@@ -152,4 +121,39 @@ this::
 	if ($row->count == 0)
 	{     
 		echo 'You must submit the word that appears in the image.';
-	}
\ No newline at end of file
+	}
+
+Available Functions
+===================
+
+The following functions are available:
+
+.. function:: create_captcha([$data = ''[, $img_path = ''[, $img_url = ''[, $font_path = '']]]])
+
+	:param	array	$data: Array of data for the CAPTCHA
+	:param	string	$img_path: Path to create the image in
+	:param	string	$img_url: URL to the CAPTCHA image folder
+	:param	string	$font_path: Server path to font
+	:returns:	array('word' => $word, 'time' => $now, 'image' => $img)
+
+	Takes an array of information to generate the CAPTCHA as input and
+	creates the image to your specifications, returning an array of
+	associative data about the image.
+
+	::
+
+		array(
+			'image'	=> IMAGE TAG
+			'time'	=> TIMESTAMP (in microtime)
+			'word'	=> CAPTCHA WORD
+		)
+
+	The **image** is the actual image tag::
+
+		<img src="http://example.com/captcha/12345.jpg" width="140" height="50" />
+
+	The **time** is the micro timestamp used as the image name without the
+	file extension. It will be a number like this: 1139612155.3422
+
+	The **word** is the word that appears in the captcha image, which if not
+	supplied to the function, will be a random string.
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From b55d981d3febf3f2eca72cde5f11742a529e7f19 Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Sat, 20 Jul 2013 08:49:25 -0700
Subject: Update Cookie helper docs

---
 user_guide_src/source/helpers/cookie_helper.rst | 55 +++++++++++++------------
 1 file changed, 29 insertions(+), 26 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/helpers/cookie_helper.rst b/user_guide_src/source/helpers/cookie_helper.rst
index c09f5eb4c..41a6d1c56 100644
--- a/user_guide_src/source/helpers/cookie_helper.rst
+++ b/user_guide_src/source/helpers/cookie_helper.rst
@@ -5,7 +5,12 @@ Cookie Helper
 The Cookie Helper file contains functions that assist in working with
 cookies.
 
-.. contents:: Page Contents
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
 
 Loading this Helper
 ===================
@@ -14,14 +19,16 @@ This helper is loaded using the following code::
 
 	$this->load->helper('cookie');
 
+Available Functions
+===================
+
 The following functions are available:
 
-set_cookie()
-============
 
-.. function:: set_cookie($name = '', $value = '', $expire = '', $domain = '', $path = '/', $prefix = '', $secure = FALSE, $httponly = FALSE)
+.. function:: set_cookie($name = ''[, $value = ''[, $expire = ''[, $domain = ''[, $path = '/'[, $prefix = ''[, $secure = FALSE[, $httponly = FALSE]]]]]]])
 
-	:param	string	$name: Cookie name
+	:param	mixed	$name: Cookie name *or* associative array of all of
+		the parameters available to this function
 	:param	string	$value: Cookie value
 	:param	int	$expire: Number of seconds until expiration
 	:param	string	$domain: Cookie domain (usually: .yourdomain.com)
@@ -31,13 +38,11 @@ set_cookie()
 	:param	bool	$httponly: Whether to hide the cookie from JavaScript
 	:returns:	void
 
-This helper function gives you view file friendly syntax to set browser
-cookies. Refer to the :doc:`Input Library <../libraries/input>` for a
-description of its use, as this function is an alias for
-``CI_Input::set_cookie()``.
+	This helper function gives you view file friendly syntax to set browser
+	cookies. Refer to the :doc:`Input Library <../libraries/input>` for a
+	description of its use, as this function is an alias for
+	``CI_Input::set_cookie()``.
 
-get_cookie()
-============
 
 .. function:: get_cookie($index = '', $xss_clean = FALSE)
 
@@ -45,12 +50,10 @@ get_cookie()
 	:param	bool	$xss_clean: Whether to apply XSS filtering to the returned value
 	:returns:	mixed
 
-This helper function gives you view file friendly syntax to get browser
-cookies. Refer to the :doc:`Input Library <../libraries/input>` for a
-description of itsuse, as this function is an alias for ``CI_Input::cookie()``.
+	This helper function gives you view file friendly syntax to get browser
+	cookies. Refer to the :doc:`Input Library <../libraries/input>` for a
+	description of its use, as this function is an alias for ``CI_Input::cookie()``.
 
-delete_cookie()
-===============
 
 .. function:: delete_cookie($name = '', $domain = '', $path = '/', $prefix = '')
 
@@ -60,18 +63,18 @@ delete_cookie()
 	:param	string	$prefix: Cookie name prefix
 	:returns: void
 
-Lets you delete a cookie. Unless you've set a custom path or other
-values, only the name of the cookie is needed.
+	Lets you delete a cookie. Unless you've set a custom path or other
+	values, only the name of the cookie is needed.
 
-::
+	::
 
-	delete_cookie('name');
+		delete_cookie('name');
 
-This function is otherwise identical to ``set_cookie()``, except that it
-does not have the value and expiration parameters. You can submit an
-array of values in the first parameter or you can set discrete
-parameters.
+	This function is otherwise identical to ``set_cookie()``, except that it
+	does not have the value and expiration parameters. You can submit an
+	array of values in the first parameter or you can set discrete
+	parameters.
 
-::
+	::
 
-	delete_cookie($name, $domain, $path, $prefix)
\ No newline at end of file
+		delete_cookie($name, $domain, $path, $prefix)
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From a4db4320c529a3421d6193c1d2e84e81f8bc2898 Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Sat, 20 Jul 2013 08:59:59 -0700
Subject: Update Date helper docs

---
 user_guide_src/source/helpers/date_helper.rst | 460 ++++++++++++--------------
 1 file changed, 219 insertions(+), 241 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/helpers/date_helper.rst b/user_guide_src/source/helpers/date_helper.rst
index 1a552c920..e9e122f1c 100644
--- a/user_guide_src/source/helpers/date_helper.rst
+++ b/user_guide_src/source/helpers/date_helper.rst
@@ -4,7 +4,12 @@ Date Helper
 
 The Date Helper file contains functions that help you work with dates.
 
-.. contents:: Page Contents
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
 
 Loading this Helper
 ===================
@@ -13,281 +18,258 @@ This helper is loaded using the following code::
 
 	$this->load->helper('date');
 
+Available Functions
+===================
+
 The following functions are available:
 
-now()
-=====
 
-.. function:: now($timezone = NULL)
+.. function:: now([$timezone = NULL])
 
 	:param	string	$timezone: Timezone
 	:returns:	int
 
-Returns the current time as a UNIX timestamp, referenced either to your server's
-local time or any PHP suported timezone, based on the "time reference" setting
-in your config file. If you do not intend to set your master time reference to
-any other PHP supported timezone (which you'll typically do if you run a site
-that lets each user set their own timezone settings) there is no benefit to using
-this function over PHP's ``time()`` function.
+	Returns the current time as a UNIX timestamp, referenced either to your server's
+	local time or any PHP suported timezone, based on the "time reference" setting
+	in your config file. If you do not intend to set your master time reference to
+	any other PHP supported timezone (which you'll typically do if you run a site
+	that lets each user set their own timezone settings) there is no benefit to using
+	this function over PHP's ``time()`` function.
 
-::
+	::
 
-	echo now('Australia/Victoria');
+		echo now('Australia/Victoria');
 
-If a timezone is not provided, it will return ``time()`` based on the
-**time_reference** setting.
+	If a timezone is not provided, it will return ``time()`` based on the
+	**time_reference** setting.
 
-mdate()
-=======
 
-.. function:: mdate($datestr = '', $time = '')
+.. function:: mdate([$datestr = ''[, $time = '']])
 
 	:param	string 	$datestr: Date string
 	:param	int 	$time: UNIX timestamp
 	:returns:	int
 
-This function is identical to PHP's `date() <http://www.php.net/date>`_
-function, except that it lets you use MySQL style date codes, where each
-code letter is preceded with a percent sign, e.g. `%Y %m %d`
+	This function is identical to PHP's `date() <http://www.php.net/date>`_
+	function, except that it lets you use MySQL style date codes, where each
+	code letter is preceded with a percent sign, e.g. `%Y %m %d`
 
-The benefit of doing dates this way is that you don't have to worry
-about escaping any characters that are not date codes, as you would
-normally have to do with the ``date()`` function.
+	The benefit of doing dates this way is that you don't have to worry
+	about escaping any characters that are not date codes, as you would
+	normally have to do with the ``date()`` function.
 
-Example::
+	Example::
 
-	$datestring = 'Year: %Y Month: %m Day: %d - %h:%i %a';
-	$time = time();
-	echo mdate($datestring, $time);
+		$datestring = 'Year: %Y Month: %m Day: %d - %h:%i %a';
+		$time = time();
+		echo mdate($datestring, $time);
 
-If a timestamp is not included in the second parameter the current time
-will be used.
+	If a timestamp is not included in the second parameter the current time
+	will be used.
 
-standard_date()
-===============
 
-.. function:: standard_date($fmt = 'DATE_RFC822', $time = NULL)
+.. function:: standard_date([$fmt = 'DATE_RFC822'[, $time = NULL]])
 
 	:param	string	$fmt: Date format
 	:param	int 	$time: UNIX timestamp
 	:returns:	string
 
-Lets you generate a date string in one of several standardized formats.
+	Lets you generate a date string in one of several standardized formats.
 
-Example::
+	Example::
 
-	$format = 'DATE_RFC822';
-	$time = time();
-	echo standard_date($format, $time);
+		$format = 'DATE_RFC822';
+		$time = time();
+		echo standard_date($format, $time);
 
-.. note:: This function is DEPRECATED.Use the native ``date()`` combined with
-	`DateTime's format constants
-	<http://www.php.net/manual/en/class.datetime.php#datetime.constants.types>`_
-	instead:
+	.. note:: This function is DEPRECATED.Use the native ``date()`` combined with
+		`DateTime's format constants
+		<http://www.php.net/manual/en/class.datetime.php#datetime.constants.types>`_
+		instead::
 
-	|
-	| echo date(DATE_RFC822, time());
+			echo date(DATE_RFC822, time());
 
-Supported formats
------------------
+	**Supported formats:**
 
-===============	=======================	======================================
-Constant		Description				Example
-===============	=======================	======================================
-DATE_ATOM	Atom			2005-08-15T16:13:03+0000
-DATE_COOKIE	HTTP Cookies		Sun, 14 Aug 2005 16:13:03 UTC
-DATE_ISO8601   	ISO-8601		2005-08-14T16:13:03+00:00
-DATE_RFC822	RFC 822			Sun, 14 Aug 05 16:13:03 UTC
-DATE_RFC850	RFC 850			Sunday, 14-Aug-05 16:13:03 UTC
-DATE_RFC1036	RFC 1036		Sunday, 14-Aug-05 16:13:03 UTC
-DATE_RFC1123	RFC 1123		Sun, 14 Aug 2005 16:13:03 UTC
-DATE_RFC2822 	RFC 2822		Sun, 14 Aug 2005 16:13:03 +0000
-DATE_RSS	RSS			Sun, 14 Aug 2005 16:13:03 UTC
-DATE_W3C	W3C			2005-08-14T16:13:03+0000
-===============	=======================	======================================
+	===============	=======================	======================================
+	Constant		Description				Example
+	===============	=======================	======================================
+	DATE_ATOM	Atom			2005-08-15T16:13:03+0000
+	DATE_COOKIE	HTTP Cookies		Sun, 14 Aug 2005 16:13:03 UTC
+	DATE_ISO8601   	ISO-8601		2005-08-14T16:13:03+00:00
+	DATE_RFC822	RFC 822			Sun, 14 Aug 05 16:13:03 UTC
+	DATE_RFC850	RFC 850			Sunday, 14-Aug-05 16:13:03 UTC
+	DATE_RFC1036	RFC 1036		Sunday, 14-Aug-05 16:13:03 UTC
+	DATE_RFC1123	RFC 1123		Sun, 14 Aug 2005 16:13:03 UTC
+	DATE_RFC2822 	RFC 2822		Sun, 14 Aug 2005 16:13:03 +0000
+	DATE_RSS	RSS			Sun, 14 Aug 2005 16:13:03 UTC
+	DATE_W3C	W3C			2005-08-14T16:13:03+0000
+	===============	=======================	======================================
 
-local_to_gmt()
-==============
 
-.. function:: local_to_gmt($time = '')
+.. function:: local_to_gmt([$time = ''])
 
 	:param	int	$time: UNIX timestamp
 	:returns:	string
 
-Takes a UNIX timestamp as input and returns it as GMT.
+	Takes a UNIX timestamp as input and returns it as GMT.
 
-Example::
+	Example::
 
-	$gmt = local_to_gmt(time());
+		$gmt = local_to_gmt(time());
 
-gmt_to_local()
-==============
 
-.. function:: gmt_to_local($time = '', $timezone = 'UTC', $dst = FALSE)
+.. function:: gmt_to_local([$time = ''[, $timezone = 'UTC'[, $dst = FALSE]]])
 
 	:param	int 	$time: UNIX timestamp
 	:param	string	$timezone: Timezone
 	:param	bool 	$dst: Whether DST is active
 	:returns:	int
 
-Takes a UNIX timestamp (referenced to GMT) as input, and converts it to
-a localized timestamp based on the timezone and Daylight Saving Time
-submitted.
+	Takes a UNIX timestamp (referenced to GMT) as input, and converts it to
+	a localized timestamp based on the timezone and Daylight Saving Time
+	submitted.
 
-Example::
+	Example::
 
-	$timestamp = 1140153693;
-	$timezone  = 'UM8';
-	$daylight_saving = TRUE;
-	echo gmt_to_local($timestamp, $timezone, $daylight_saving);
+		$timestamp = 1140153693;
+		$timezone  = 'UM8';
+		$daylight_saving = TRUE;
+		echo gmt_to_local($timestamp, $timezone, $daylight_saving);
 
 
-.. note:: For a list of timezones see the reference at the bottom of this page.
+	.. note:: For a list of timezones see the reference at the bottom of this page.
 
-mysql_to_unix()
-===============
 
-.. function:: mysql_to_unix($time = '')
+.. function:: mysql_to_unix([$time = ''])
 
 	:param	int 	$time: UNIX timestamp
 	:returns:	int
 
-Takes a MySQL Timestamp as input and returns it as a UNIX timestamp.
+	Takes a MySQL Timestamp as input and returns it as a UNIX timestamp.
 
-Example::
+	Example::
 
-	$unix = mysql_to_unix('20061124092345');
+		$unix = mysql_to_unix('20061124092345');
 
-unix_to_human()
-===============
 
-.. function:: unix_to_human($time = '', $seconds = FALSE, $fmt = 'us')
+.. function:: unix_to_human([$time = ''[, $seconds = FALSE[, $fmt = 'us']]])
 
 	:param	int	$time: UNIX timestamp
 	:param	bool	$seconds: Whether to show seconds
 	:param	string	$fmt: format (us or euro)
 	:returns: integer
 
-Takes a UNIX timestamp as input and returns it in a human readable
-format with this prototype::
+	Takes a UNIX timestamp as input and returns it in a human readable
+	format with this prototype::
 
-	YYYY-MM-DD HH:MM:SS AM/PM
+		YYYY-MM-DD HH:MM:SS AM/PM
 
-This can be useful if you need to display a date in a form field for
-submission.
+	This can be useful if you need to display a date in a form field for
+	submission.
 
-The time can be formatted with or without seconds, and it can be set to
-European or US format. If only the timestamp is submitted it will return
-the time without seconds formatted for the U.S.
+	The time can be formatted with or without seconds, and it can be set to
+	European or US format. If only the timestamp is submitted it will return
+	the time without seconds formatted for the U.S.
 
-Examples::
+	Examples::
 
-	$now = time();
-	echo unix_to_human($now); // U.S. time, no seconds
-	echo unix_to_human($now, TRUE, 'us'); // U.S. time with seconds
-	echo unix_to_human($now, TRUE, 'eu'); // Euro time with seconds
+		$now = time();
+		echo unix_to_human($now); // U.S. time, no seconds
+		echo unix_to_human($now, TRUE, 'us'); // U.S. time with seconds
+		echo unix_to_human($now, TRUE, 'eu'); // Euro time with seconds
 
-human_to_unix()
-===============
 
-.. function:: human_to_unix($datestr = '')
+.. function:: human_to_unix([$datestr = ''])
 
 	:param	int 	$datestr: Date string
 	:returns:	int UNIX timestamp or FALSE on failure
 
-The opposite of the :func:`unix_to_time()` function. Takes a "human"
-time as input and returns it as a UNIX timestamp. This is useful if you
-accept "human" formatted dates submitted via a form. Returns boolean FALSE
-date string passed to it is not formatted as indicated above.
+	The opposite of the :func:`unix_to_time()` function. Takes a "human"
+	time as input and returns it as a UNIX timestamp. This is useful if you
+	accept "human" formatted dates submitted via a form. Returns boolean FALSE
+	date string passed to it is not formatted as indicated above.
 
-Example::
+	Example::
 
-	$now = time();
-	$human = unix_to_human($now);
-	$unix = human_to_unix($human);
+		$now = time();
+		$human = unix_to_human($now);
+		$unix = human_to_unix($human);
 
-nice_date()
-===========
 
-.. function:: nice_date($bad_date = '', $format = FALSE)
+.. function:: nice_date([$bad_date = ''[, $format = FALSE]])
 
 	:param	int	$bad_date: The terribly formatted date-like string
 	:param	string	$format: Date format to return (same as PHP's ``date()`` function)
 	:returns:	string
 
-This function can take a number poorly-formed date formats and convert
-them into something useful. It also accepts well-formed dates.
+	This function can take a number poorly-formed date formats and convert
+	them into something useful. It also accepts well-formed dates.
 
-The function will return a UNIX timestamp by default. You can, optionally,
-pass a format string (the same type as the PHP ``date()`` function accepts)
-as the second parameter.
+	The function will return a UNIX timestamp by default. You can, optionally,
+	pass a format string (the same type as the PHP ``date()`` function accepts)
+	as the second parameter.
 
-Example::
+	Example::
 
-	$bad_date = '199605';
-	// Should Produce: 1996-05-01
-	$better_date = nice_date($bad_date, 'Y-m-d');
+		$bad_date = '199605';
+		// Should Produce: 1996-05-01
+		$better_date = nice_date($bad_date, 'Y-m-d');
 
-	$bad_date = '9-11-2001';
-	// Should Produce: 2001-09-11
-	$better_date = nice_date($bad_date, 'Y-m-d');
+		$bad_date = '9-11-2001';
+		// Should Produce: 2001-09-11
+		$better_date = nice_date($bad_date, 'Y-m-d');
 
-timespan()
-==========
 
-.. function:: timespan($seconds = 1, $time = '', $units = '')
+.. function:: timespan([$seconds = 1[, $time = ''[, $units = '']]])
 
 	:param	int	$seconds: Number of seconds
 	:param	string	$time: UNIX timestamp
 	:param	int	$units: Number of time units to display
 	:returns:	string
 
-Formats a UNIX timestamp so that is appears similar to this::
+	Formats a UNIX timestamp so that is appears similar to this::
 
-	1 Year, 10 Months, 2 Weeks, 5 Days, 10 Hours, 16 Minutes
+		1 Year, 10 Months, 2 Weeks, 5 Days, 10 Hours, 16 Minutes
 
-The first parameter must contain a UNIX timestamp.
-The second parameter must contain a timestamp that is greater that the
-first timestamp.
-The thirdparameter is optional and limits the number of time units to display.
+	The first parameter must contain a UNIX timestamp.
+	The second parameter must contain a timestamp that is greater that the
+	first timestamp.
+	The thirdparameter is optional and limits the number of time units to display.
 
-If the second parameter empty, the current time will be used.
+	If the second parameter empty, the current time will be used.
 
-The most common purpose for this function is to show how much time has
-elapsed from some point in time in the past to now.
+	The most common purpose for this function is to show how much time has
+	elapsed from some point in time in the past to now.
 
-Example::
+	Example::
 
-	$post_date = '1079621429';
-	$now = time();
-	$units = 2;
-	echo timespan($post_date, $now, $units);
+		$post_date = '1079621429';
+		$now = time();
+		$units = 2;
+		echo timespan($post_date, $now, $units);
 
-.. note:: The text generated by this function is found in the following language
-	file: `language/<your_lang>/date_lang.php`
+	.. note:: The text generated by this function is found in the following language
+		file: `language/<your_lang>/date_lang.php`
 
-days_in_month()
-===============
 
-.. function:: days_in_month($month = 0, $year = '')
+.. function:: days_in_month([$month = 0[, $year = '']])
 
 	:param	int	$month: a numeric month
 	:param	int	$year: a numeric year
 	:returns:	int
 
-Returns the number of days in a given month/year. Takes leap years into
-account.
+	Returns the number of days in a given month/year. Takes leap years into
+	account.
 
-Example::
+	Example::
 
-	echo days_in_month(06, 2005);
+		echo days_in_month(06, 2005);
 
-If the second parameter is empty, the current year will be used.
+	If the second parameter is empty, the current year will be used.
 
-date_range()
-============
 
-.. function:: date_range($unix_start = '', $mixed = '', $is_unix = TRUE, $format = 'Y-m-d')
+.. function:: date_range([$unix_start = ''[, $mixed = ''[, $is_unix = TRUE[, $format = 'Y-m-d']]]])
 
 	:param	int	$unix_start: UNIX timestamp of the range start date
 	:param	int	$mixed: UNIX timestamp of the range end date or interval in days
@@ -295,40 +277,36 @@ date_range()
 	:param	string	$format: Output date format, same as in ``date()``
 	:returns:	array
 
-Returns a list of dates within a specified period.
+	Returns a list of dates within a specified period.
 
-Example::
+	Example::
 
-	$range = date_range('2012-01-01', '2012-01-15');
-	echo "First 15 days of 2012:";
-	foreach ($range as $date)
-	{
-		echo $date."\n";
-	}
+		$range = date_range('2012-01-01', '2012-01-15');
+		echo "First 15 days of 2012:";
+		foreach ($range as $date)
+		{
+			echo $date."\n";
+		}
 
-timezones()
-===========
 
-.. function:: timezones($tz = '')
+.. function:: timezones([$tz = ''])
 
 	:param	string	$tz: a numeric timezone
 	:returns:	string
 
-Takes a timezone reference (for a list of valid timezones, see the
-"Timezone Reference" below) and returns the number of hours offset from
-UTC.
+	Takes a timezone reference (for a list of valid timezones, see the
+	"Timezone Reference" below) and returns the number of hours offset from
+	UTC.
 
-Example::
+	Example::
 
-	echo timezones('UM5');
+		echo timezones('UM5');
 
 
-This function is useful when used with :func:`timezone_menu()`.
+	This function is useful when used with :func:`timezone_menu()`.
 
-timezone_menu()
-===============
 
-.. function:: timezone_menu($default = 'UTC', $class = '', $name = 'timezones', $attributes = '')
+.. function:: timezone_menu([$default = 'UTC'[, $class = ''[, $name = 'timezones'[, $attributes = '']]]])
 
 	:param	string	$default: Timezone
 	:param	string	$class: Class name
@@ -336,72 +314,72 @@ timezone_menu()
 	:param	mixed	$attributes: HTML attributes
 	:returns:	string
 
-Generates a pull-down menu of timezones, like this one:
-
-.. raw:: html
-
-	<form action="#">
-		<select name="timezones">
-			<option value='UM12'>(UTC -12:00) Baker/Howland Island</option>
-			<option value='UM11'>(UTC -11:00) Samoa Time Zone, Niue</option>
-			<option value='UM10'>(UTC -10:00) Hawaii-Aleutian Standard Time, Cook Islands, Tahiti</option>
-			<option value='UM95'>(UTC -9:30) Marquesas Islands</option>
-			<option value='UM9'>(UTC -9:00) Alaska Standard Time, Gambier Islands</option>
-			<option value='UM8'>(UTC -8:00) Pacific Standard Time, Clipperton Island</option>
-			<option value='UM7'>(UTC -7:00) Mountain Standard Time</option>
-			<option value='UM6'>(UTC -6:00) Central Standard Time</option>
-			<option value='UM5'>(UTC -5:00) Eastern Standard Time, Western Caribbean Standard Time</option>
-			<option value='UM45'>(UTC -4:30) Venezuelan Standard Time</option>
-			<option value='UM4'>(UTC -4:00) Atlantic Standard Time, Eastern Caribbean Standard Time</option>
-			<option value='UM35'>(UTC -3:30) Newfoundland Standard Time</option>
-			<option value='UM3'>(UTC -3:00) Argentina, Brazil, French Guiana, Uruguay</option>
-			<option value='UM2'>(UTC -2:00) South Georgia/South Sandwich Islands</option>
-			<option value='UM1'>(UTC -1:00) Azores, Cape Verde Islands</option>
-			<option value='UTC' selected='selected'>(UTC) Greenwich Mean Time, Western European Time</option>
-			<option value='UP1'>(UTC +1:00) Central European Time, West Africa Time</option>
-			<option value='UP2'>(UTC +2:00) Central Africa Time, Eastern European Time, Kaliningrad Time</option>
-			<option value='UP3'>(UTC +3:00) Moscow Time, East Africa Time</option>
-			<option value='UP35'>(UTC +3:30) Iran Standard Time</option>
-			<option value='UP4'>(UTC +4:00) Azerbaijan Standard Time, Samara Time</option>
-			<option value='UP45'>(UTC +4:30) Afghanistan</option>
-			<option value='UP5'>(UTC +5:00) Pakistan Standard Time, Yekaterinburg Time</option>
-			<option value='UP55'>(UTC +5:30) Indian Standard Time, Sri Lanka Time</option>
-			<option value='UP575'>(UTC +5:45) Nepal Time</option>
-			<option value='UP6'>(UTC +6:00) Bangladesh Standard Time, Bhutan Time, Omsk Time</option>
-			<option value='UP65'>(UTC +6:30) Cocos Islands, Myanmar</option>
-			<option value='UP7'>(UTC +7:00) Krasnoyarsk Time, Cambodia, Laos, Thailand, Vietnam</option>
-			<option value='UP8'>(UTC +8:00) Australian Western Standard Time, Beijing Time, Irkutsk Time</option>
-			<option value='UP875'>(UTC +8:45) Australian Central Western Standard Time</option>
-			<option value='UP9'>(UTC +9:00) Japan Standard Time, Korea Standard Time, Yakutsk Time</option>
-			<option value='UP95'>(UTC +9:30) Australian Central Standard Time</option>
-			<option value='UP10'>(UTC +10:00) Australian Eastern Standard Time, Vladivostok Time</option>
-			<option value='UP105'>(UTC +10:30) Lord Howe Island</option>
-			<option value='UP11'>(UTC +11:00) Magadan Time, Solomon Islands, Vanuatu</option>
-			<option value='UP115'>(UTC +11:30) Norfolk Island</option>
-			<option value='UP12'>(UTC +12:00) Fiji, Gilbert Islands, Kamchatka Time, New Zealand Standard Time</option>
-			<option value='UP1275'>(UTC +12:45) Chatham Islands Standard Time</option>
-			<option value='UP13'>(UTC +13:00) Phoenix Islands Time, Tonga</option>
-			<option value='UP14'>(UTC +14:00) Line Islands</option>
-		</select>
-	</form>
-
-
-This menu is useful if you run a membership site in which your users are
-allowed to set their local timezone value.
-
-The first parameter lets you set the "selected" state of the menu. For
-example, to set Pacific time as the default you will do this::
-
-	echo timezone_menu('UM8');
-
-Please see the timezone reference below to see the values of this menu.
-
-The second parameter lets you set a CSS class name for the menu.
-
-The fourth parameter lets you set one or more attributes on the generated select tag.
-
-.. note:: The text contained in the menu is found in the following
-	language file: `language/<your_lang>/date_lang.php`
+	Generates a pull-down menu of timezones, like this one:
+
+	.. raw:: html
+
+		<form action="#">
+			<select name="timezones">
+				<option value='UM12'>(UTC -12:00) Baker/Howland Island</option>
+				<option value='UM11'>(UTC -11:00) Samoa Time Zone, Niue</option>
+				<option value='UM10'>(UTC -10:00) Hawaii-Aleutian Standard Time, Cook Islands, Tahiti</option>
+				<option value='UM95'>(UTC -9:30) Marquesas Islands</option>
+				<option value='UM9'>(UTC -9:00) Alaska Standard Time, Gambier Islands</option>
+				<option value='UM8'>(UTC -8:00) Pacific Standard Time, Clipperton Island</option>
+				<option value='UM7'>(UTC -7:00) Mountain Standard Time</option>
+				<option value='UM6'>(UTC -6:00) Central Standard Time</option>
+				<option value='UM5'>(UTC -5:00) Eastern Standard Time, Western Caribbean Standard Time</option>
+				<option value='UM45'>(UTC -4:30) Venezuelan Standard Time</option>
+				<option value='UM4'>(UTC -4:00) Atlantic Standard Time, Eastern Caribbean Standard Time</option>
+				<option value='UM35'>(UTC -3:30) Newfoundland Standard Time</option>
+				<option value='UM3'>(UTC -3:00) Argentina, Brazil, French Guiana, Uruguay</option>
+				<option value='UM2'>(UTC -2:00) South Georgia/South Sandwich Islands</option>
+				<option value='UM1'>(UTC -1:00) Azores, Cape Verde Islands</option>
+				<option value='UTC' selected='selected'>(UTC) Greenwich Mean Time, Western European Time</option>
+				<option value='UP1'>(UTC +1:00) Central European Time, West Africa Time</option>
+				<option value='UP2'>(UTC +2:00) Central Africa Time, Eastern European Time, Kaliningrad Time</option>
+				<option value='UP3'>(UTC +3:00) Moscow Time, East Africa Time</option>
+				<option value='UP35'>(UTC +3:30) Iran Standard Time</option>
+				<option value='UP4'>(UTC +4:00) Azerbaijan Standard Time, Samara Time</option>
+				<option value='UP45'>(UTC +4:30) Afghanistan</option>
+				<option value='UP5'>(UTC +5:00) Pakistan Standard Time, Yekaterinburg Time</option>
+				<option value='UP55'>(UTC +5:30) Indian Standard Time, Sri Lanka Time</option>
+				<option value='UP575'>(UTC +5:45) Nepal Time</option>
+				<option value='UP6'>(UTC +6:00) Bangladesh Standard Time, Bhutan Time, Omsk Time</option>
+				<option value='UP65'>(UTC +6:30) Cocos Islands, Myanmar</option>
+				<option value='UP7'>(UTC +7:00) Krasnoyarsk Time, Cambodia, Laos, Thailand, Vietnam</option>
+				<option value='UP8'>(UTC +8:00) Australian Western Standard Time, Beijing Time, Irkutsk Time</option>
+				<option value='UP875'>(UTC +8:45) Australian Central Western Standard Time</option>
+				<option value='UP9'>(UTC +9:00) Japan Standard Time, Korea Standard Time, Yakutsk Time</option>
+				<option value='UP95'>(UTC +9:30) Australian Central Standard Time</option>
+				<option value='UP10'>(UTC +10:00) Australian Eastern Standard Time, Vladivostok Time</option>
+				<option value='UP105'>(UTC +10:30) Lord Howe Island</option>
+				<option value='UP11'>(UTC +11:00) Magadan Time, Solomon Islands, Vanuatu</option>
+				<option value='UP115'>(UTC +11:30) Norfolk Island</option>
+				<option value='UP12'>(UTC +12:00) Fiji, Gilbert Islands, Kamchatka Time, New Zealand Standard Time</option>
+				<option value='UP1275'>(UTC +12:45) Chatham Islands Standard Time</option>
+				<option value='UP13'>(UTC +13:00) Phoenix Islands Time, Tonga</option>
+				<option value='UP14'>(UTC +14:00) Line Islands</option>
+			</select>
+		</form>
+
+
+	This menu is useful if you run a membership site in which your users are
+	allowed to set their local timezone value.
+
+	The first parameter lets you set the "selected" state of the menu. For
+	example, to set Pacific time as the default you will do this::
+
+		echo timezone_menu('UM8');
+
+	Please see the timezone reference below to see the values of this menu.
+
+	The second parameter lets you set a CSS class name for the menu.
+
+	The fourth parameter lets you set one or more attributes on the generated select tag.
+
+	.. note:: The text contained in the menu is found in the following
+		language file: `language/<your_lang>/date_lang.php`
 
 
 Timezone Reference
-- 
cgit v1.2.3-24-g4f1b


From 26f7a9fb4aa08c66c2842b90b4f5ab1a08076df6 Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Sat, 20 Jul 2013 09:00:02 -0700
Subject: fixed param options on cookie helper function definitions

---
 user_guide_src/source/helpers/cookie_helper.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/helpers/cookie_helper.rst b/user_guide_src/source/helpers/cookie_helper.rst
index 41a6d1c56..e70893f2f 100644
--- a/user_guide_src/source/helpers/cookie_helper.rst
+++ b/user_guide_src/source/helpers/cookie_helper.rst
@@ -25,7 +25,7 @@ Available Functions
 The following functions are available:
 
 
-.. function:: set_cookie($name = ''[, $value = ''[, $expire = ''[, $domain = ''[, $path = '/'[, $prefix = ''[, $secure = FALSE[, $httponly = FALSE]]]]]]])
+.. function:: set_cookie([$name = ''[, $value = ''[, $expire = ''[, $domain = ''[, $path = '/'[, $prefix = ''[, $secure = FALSE[, $httponly = FALSE]]]]]]]])
 
 	:param	mixed	$name: Cookie name *or* associative array of all of
 		the parameters available to this function
@@ -44,7 +44,7 @@ The following functions are available:
 	``CI_Input::set_cookie()``.
 
 
-.. function:: get_cookie($index = '', $xss_clean = FALSE)
+.. function:: get_cookie([$index = ''[, $xss_clean = FALSE]])
 
 	:param	string	$index: Cookie name
 	:param	bool	$xss_clean: Whether to apply XSS filtering to the returned value
@@ -55,7 +55,7 @@ The following functions are available:
 	description of its use, as this function is an alias for ``CI_Input::cookie()``.
 
 
-.. function:: delete_cookie($name = '', $domain = '', $path = '/', $prefix = '')
+.. function:: delete_cookie([$name = ''[, $domain = ''[, $path = '/'[, $prefix = '']]]])
 
 	:param	string	$name: Cookie name
 	:param	string	$domain: Cookie domain (usually: .yourdomain.com)
-- 
cgit v1.2.3-24-g4f1b


From fb1917d8afa41aed76f0be091d3ce13c767e9af5 Mon Sep 17 00:00:00 2001
From: Hashem Qolami <hashem@qolami.com>
Date: Sun, 21 Jul 2013 01:26:47 +0430
Subject: Fix User Guide Search button issue

Signed-off-by: Hashem Qolami <hashem@qolami.com>
---
 .../source/_themes/eldocs/static/asset/css/common.css       | 13 ++++++-------
 1 file changed, 6 insertions(+), 7 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/_themes/eldocs/static/asset/css/common.css b/user_guide_src/source/_themes/eldocs/static/asset/css/common.css
index 648e33032..197739a57 100644
--- a/user_guide_src/source/_themes/eldocs/static/asset/css/common.css
+++ b/user_guide_src/source/_themes/eldocs/static/asset/css/common.css
@@ -133,7 +133,7 @@ a:visited{ color: #1A5B8D; }
 a:hover,
 a:active{ color: #742CAC; }
 
-a.headerlink{ visibility: hidden; }
+a.headerlink{ visibility: hidden; margin-left: 0.4em }
 
 	:hover > a.headerlink { visibility: visible; }
 
@@ -261,12 +261,12 @@ fieldset{ border: 0; }
 	#header form{ float: right; overflow: hidden; }
 	
 	#header input{ float: left; }
-	
+
 	#header input[type="text"]{
 		background-color: #FFFFFF;
 		border: 1px solid;
 		border-color: #033861 #13598F #13598F #033861;
-		font-size: inherit;
+		font: inherit;
 		margin-right: 5px;
 		padding: 5px;
 		width: 175px;
@@ -279,8 +279,9 @@ fieldset{ border: 0; }
 		border: 1px solid #033861;
 		color: #094776;
 		cursor: pointer;
+		font: inherit;
 		font-weight: bold;
-		padding: 5px 10px 4px;
+		padding: 5px 10px;
 		text-transform: uppercase;
 	}
 	
@@ -349,6 +350,4 @@ fieldset{ border: 0; }
 	h3,h4,h5,h6{ font-size: 14px; }
 }
 
-@media screen and (-webkit-min-device-pixel-ratio:0){
-	#header input[type="submit"]{ padding-bottom: 7px; }
-}
+#header input[type="submit"], x:-moz-any-link{ padding: 4px 10px; }
-- 
cgit v1.2.3-24-g4f1b


From f05ee7afe65e640e51eb3399883e0f3f0d255dfe Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Sun, 21 Jul 2013 10:56:28 -0700
Subject: Update Directory helper docs

---
 user_guide_src/source/helpers/directory_helper.rst | 112 +++++++++++----------
 1 file changed, 58 insertions(+), 54 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/helpers/directory_helper.rst b/user_guide_src/source/helpers/directory_helper.rst
index a785ebc8c..514e80c96 100644
--- a/user_guide_src/source/helpers/directory_helper.rst
+++ b/user_guide_src/source/helpers/directory_helper.rst
@@ -5,7 +5,12 @@ Directory Helper
 The Directory Helper file contains functions that assist in working with
 directories.
 
-.. contents:: Page Contents
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
 
 Loading this Helper
 ===================
@@ -16,64 +21,63 @@ This helper is loaded using the following code
 
 	$this->load->helper('directory');
 
+Available Functions
+===================
+
 The following functions are available:
 
-directory_map()
-===============
 
-This function reads the directory path specified in the first parameter
-and builds an array representation of it and all its contained files.
-	
-.. php:method:: directory_map($source_dir[, $directory_depth = 0[, $hidden = FALSE]])
+.. function:: directory_map($source_dir[, $directory_depth = 0[, $hidden = FALSE]])
 
 	:param string	$source_dir: path to the ource directory
 	:param integer	$directory_depth: depth of directories to traverse (0 =
 		fully recursive, 1 = current dir, etc)
 	:param boolean	$hidden: whether to include hidden directories
-	
-Examples::
-
-	$map = directory_map('./mydirectory/');
-
-.. note:: Paths are almost always relative to your main index.php file.
-
-
-Sub-folders contained within the directory will be mapped as well. If
-you wish to control the recursion depth, you can do so using the second
-parameter (integer). A depth of 1 will only map the top level directory::
-
-	$map = directory_map('./mydirectory/', 1);
-
-By default, hidden files will not be included in the returned array. To
-override this behavior, you may set a third parameter to true (boolean)::
-
-	$map = directory_map('./mydirectory/', FALSE, TRUE);
-
-Each folder name will be an array index, while its contained files will
-be numerically indexed. Here is an example of a typical array::
-
-	Array (    
-		[libraries] => Array    
-			(        
-				[0] => benchmark.html        
-				[1] => config.html        
-				["database/"] => Array
-					(              
-						[0] => query_builder.html              
-						[1] => binds.html              
-						[2] => configuration.html
-						[3] => connecting.html              
-						[4] => examples.html              
-						[5] => fields.html              
-						[6] => index.html
-						[7] => queries.html
-					)        
-				[2] => email.html        
-				[3] => file_uploading.html        
-				[4] => image_lib.html        
-				[5] => input.html        
-				[6] => language.html        
-				[7] => loader.html        
-				[8] => pagination.html        
-				[9] => uri.html
-			)
\ No newline at end of file
+	:returns: array
+
+	Examples::
+
+		$map = directory_map('./mydirectory/');
+
+	.. note:: Paths are almost always relative to your main index.php file.
+
+
+	Sub-folders contained within the directory will be mapped as well. If
+	you wish to control the recursion depth, you can do so using the second
+	parameter (integer). A depth of 1 will only map the top level directory::
+
+		$map = directory_map('./mydirectory/', 1);
+
+	By default, hidden files will not be included in the returned array. To
+	override this behavior, you may set a third parameter to true (boolean)::
+
+		$map = directory_map('./mydirectory/', FALSE, TRUE);
+
+	Each folder name will be an array index, while its contained files will
+	be numerically indexed. Here is an example of a typical array::
+
+		Array (    
+			[libraries] => Array    
+				(        
+					[0] => benchmark.html        
+					[1] => config.html        
+					["database/"] => Array
+						(              
+							[0] => query_builder.html              
+							[1] => binds.html              
+							[2] => configuration.html
+							[3] => connecting.html              
+							[4] => examples.html              
+							[5] => fields.html              
+							[6] => index.html
+							[7] => queries.html
+						)        
+					[2] => email.html        
+					[3] => file_uploading.html        
+					[4] => image_lib.html        
+					[5] => input.html        
+					[6] => language.html        
+					[7] => loader.html        
+					[8] => pagination.html        
+					[9] => uri.html
+				)
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 7e69feae3f805eafe5f8c4966c1e1b2af79ddbb8 Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Sun, 21 Jul 2013 10:57:25 -0700
Subject: Update Download helper docs

---
 user_guide_src/source/helpers/download_helper.rst | 48 +++++++++++++----------
 1 file changed, 27 insertions(+), 21 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/helpers/download_helper.rst b/user_guide_src/source/helpers/download_helper.rst
index fd95f4f34..17b68f454 100644
--- a/user_guide_src/source/helpers/download_helper.rst
+++ b/user_guide_src/source/helpers/download_helper.rst
@@ -4,7 +4,12 @@ Download Helper
 
 The Download Helper lets you download data to your desktop.
 
-.. contents:: Page Contents
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
 
 Loading this Helper
 ===================
@@ -13,38 +18,39 @@ This helper is loaded using the following code::
 
 	$this->load->helper('download');
 
+Available Functions
+===================
+
 The following functions are available:
 
-force_download()
-================
 
-.. function:: force_download($filename = '', $data = '', $set_mime = FALSE)
+.. function:: force_download([$filename = ''[, $data = ''[, $set_mime = FALSE]]])
 
 	:param	string	$filename: Filename
 	:param	mixed	$data: File contents
 	:param	bool	$set_mime: Whether to try to send the actual MIME type
 	:returns:	void
 
-Generates server headers which force data to be downloaded to your
-desktop. Useful with file downloads. The first parameter is the **name
-you want the downloaded file to be named**, the second parameter is the
-file data.
+	Generates server headers which force data to be downloaded to your
+	desktop. Useful with file downloads. The first parameter is the **name
+	you want the downloaded file to be named**, the second parameter is the
+	file data.
 
-If you set the second parameter to NULL and ``$filename`` is an existing, readable
-file path, then its content will be read instead.
+	If you set the second parameter to NULL and ``$filename`` is an existing, readable
+	file path, then its content will be read instead.
 
-If you set the third parameter to boolean TRUE, then the actual file MIME type
-(based on the filename extension) will be sent, so that if your browser has a
-handler for that type - it can use it.
+	If you set the third parameter to boolean TRUE, then the actual file MIME type
+	(based on the filename extension) will be sent, so that if your browser has a
+	handler for that type - it can use it.
 
-Example::
+	Example::
 
-	$data = 'Here is some text!';
-	$name = 'mytext.txt';
-	force_download($name, $data);
+		$data = 'Here is some text!';
+		$name = 'mytext.txt';
+		force_download($name, $data);
 
-If you want to download an existing file from your server you'll need to
-do the following::
+	If you want to download an existing file from your server you'll need to
+	do the following::
 
-	// Contents of photo.jpg will be automatically read
-	force_download('/path/to/photo.jpg', NULL);
\ No newline at end of file
+		// Contents of photo.jpg will be automatically read
+		force_download('/path/to/photo.jpg', NULL);
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From c43dc1e6b34104c4c060f2e0fc07ea61cabbf6c1 Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Sun, 21 Jul 2013 11:00:38 -0700
Subject: Update Email helper docs

---
 user_guide_src/source/helpers/email_helper.rst | 62 ++++++++++++++------------
 1 file changed, 34 insertions(+), 28 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/helpers/email_helper.rst b/user_guide_src/source/helpers/email_helper.rst
index b38e7ec46..fe3ccdda1 100644
--- a/user_guide_src/source/helpers/email_helper.rst
+++ b/user_guide_src/source/helpers/email_helper.rst
@@ -6,9 +6,14 @@ The Email Helper provides some assistive functions for working with
 Email. For a more robust email solution, see CodeIgniter's :doc:`Email
 Class <../libraries/email>`.
 
-.. contents:: Page Contents
+.. important:: The Email helper is **deprecated**.
 
-.. important:: The Email helper is DEPRECATED.
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
 
 Loading this Helper
 ===================
@@ -17,37 +22,36 @@ This helper is loaded using the following code::
 
 	$this->load->helper('email');
 
+Available Functions
+===================
+
 The following functions are available:
 
-valid_email()
-=============
 
 .. function:: valid_email($email)
 
 	:param	string	$email: Email address
 	:returns:	bool
 
-Checks if the input is a correctly formatted e-mail address. Note that is
-doesn't actually prove that the address will be able recieve mail, but
-simply that it is a validly formed address.
+	Checks if the input is a correctly formatted e-mail address. Note that is
+	doesn't actually prove that the address will be able recieve mail, but
+	simply that it is a validly formed address.
 
-Example::
+	Example::
 
-	if (valid_email('email@somesite.com'))
-	{
-		echo 'email is valid';
-	}
-	else
-	{
-		echo 'email is not valid';
-	}
+		if (valid_email('email@somesite.com'))
+		{
+			echo 'email is valid';
+		}
+		else
+		{
+			echo 'email is not valid';
+		}
 
-.. note:: All that this function does is to use PHP's native ``filter_var()``:
-	|
-	| (bool) filter_var($email, FILTER_VALIDATE_EMAIL);
+	.. note:: All that this function does is to use PHP's native ``filter_var()``::
+
+		(bool) filter_var($email, FILTER_VALIDATE_EMAIL);
 
-send_email()
-============
 
 .. function:: send_email($recipient, $subject, $message)
 
@@ -56,12 +60,14 @@ send_email()
 	:param	string	$message: Message body
 	:returns:	bool
 
-Sends an email using PHP's native `mail() <http://www.php.net/function.mail>`_
-function.
+	Sends an email using PHP's native `mail() <http://www.php.net/function.mail>`_
+	function.
+
+	.. note:: All that this function does is to use PHP's native ``mail``
+
+		::
 
-.. note:: All that this function does is to use PHP's native ``mail``:
-	|
-	| mail($recipient, $subject, $message);
+			mail($recipient, $subject, $message);
 
-For a more robust email solution, see CodeIgniter's :doc:`Email Library
-<../libraries/email>`.
+	For a more robust email solution, see CodeIgniter's :doc:`Email Library
+	<../libraries/email>`.
-- 
cgit v1.2.3-24-g4f1b


From 46c95474c9c2a310351934594a34f2f827e1cc9a Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Sun, 21 Jul 2013 11:03:33 -0700
Subject: Update File helper docs

---
 user_guide_src/source/helpers/file_helper.rst | 193 ++++++++++++--------------
 1 file changed, 91 insertions(+), 102 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/helpers/file_helper.rst b/user_guide_src/source/helpers/file_helper.rst
index be451db4d..4d225d278 100644
--- a/user_guide_src/source/helpers/file_helper.rst
+++ b/user_guide_src/source/helpers/file_helper.rst
@@ -4,7 +4,12 @@ File Helper
 
 The File Helper file contains functions that assist in working with files.
 
-.. contents:: Page Contents
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
 
 Loading this Helper
 ===================
@@ -13,121 +18,114 @@ This helper is loaded using the following code::
 
 	$this->load->helper('file');
 
+Available Functions
+===================
+
 The following functions are available:
 
-read_file()
-===========
 
 .. function:: read_file($file)
 
 	:param	string	$file: File path
 	:returns:	string or FALSE on failure
 
-Returns the data contained in the file specified in the path.
+	Returns the data contained in the file specified in the path.
 
-Example::
+	Example::
 
-	$string = read_file('./path/to/file.php');
+		$string = read_file('./path/to/file.php');
 
-The path can be a relative or full server path. Returns FALSE (boolean) on failure.
+	The path can be a relative or full server path. Returns FALSE (boolean) on failure.
 
-.. note:: The path is relative to your main site index.php file, NOT your
-	controller or view files. CodeIgniter uses a front controller so paths
-	are always relative to the main site index.
+	.. note:: The path is relative to your main site index.php file, NOT your
+		controller or view files. CodeIgniter uses a front controller so paths
+		are always relative to the main site index.
 
-.. note:: This function is DEPRECATED. Use the native ``file_get_contents()``
-	instead.
+	.. note:: This function is DEPRECATED. Use the native ``file_get_contents()``
+		instead.
 
-.. important:: If your server is running an **open_basedir** restriction this
-	function might not work if you are trying to access a file above the
-	calling script.
+	.. important:: If your server is running an **open_basedir** restriction this
+		function might not work if you are trying to access a file above the
+		calling script.
 
-write_file()
-============
 
-.. function:: write_file($path, $data, $mode = 'wb')
+.. function:: write_file($path, $data[, $mode = 'wb'])
 
 	:param	string	$path: File path
 	:param	string	$data: Data to write to file
 	:param	string	$mode: ``fopen()`` mode
 	:returns:	bool
 
-Writes data to the file specified in the path. If the file does not exist then the
-function will create it.
+	Writes data to the file specified in the path. If the file does not exist then the
+	function will create it.
 
-Example::
+	Example::
 
-	$data = 'Some file data';
-	if ( ! write_file('./path/to/file.php', $data))
-	{     
-		echo 'Unable to write the file';
-	}
-	else
-	{     
-		echo 'File written!';
-	}
+		$data = 'Some file data';
+		if ( ! write_file('./path/to/file.php', $data))
+		{     
+			echo 'Unable to write the file';
+		}
+		else
+		{     
+			echo 'File written!';
+		}
 
-You can optionally set the write mode via the third parameter::
+	You can optionally set the write mode via the third parameter::
 
-	write_file('./path/to/file.php', $data, 'r+');
+		write_file('./path/to/file.php', $data, 'r+');
 
-The default mode is 'wb'. Please see the `PHP user guide <http://php.net/fopen>`_
-for mode options.
+	The default mode is 'wb'. Please see the `PHP user guide <http://php.net/fopen>`_
+	for mode options.
 
-.. note: In order for this function to write data to a file, its permissions must
-	be set such that it is writable (666, 777, etc.). If the file does not
-	already exist, the directory containing it must be writable.
+	.. note: In order for this function to write data to a file, its permissions must
+		be set such that it is writable (666, 777, etc.). If the file does not
+		already exist, the directory containing it must be writable.
 
-.. note:: The path is relative to your main site index.php file, NOT your
-	controller or view files. CodeIgniter uses a front controller so paths
-	are always relative to the main site index.
+	.. note:: The path is relative to your main site index.php file, NOT your
+		controller or view files. CodeIgniter uses a front controller so paths
+		are always relative to the main site index.
 
-.. note:: This function acquires an exclusive lock on the file while writing to it.
+	.. note:: This function acquires an exclusive lock on the file while writing to it.
 
-delete_files()
-==============
 
-.. function:: delete_files($path, $del_dir = FALSE, $htdocs = FALSE)
+.. function:: delete_files($path[, $del_dir = FALSE[, $htdocs = FALSE]])
 
 	:param	string	$path: Directory path
 	:param	bool	$del_dir: Whether to also delete directories
 	:param	bool	$htdocs: Whether to skip deleting .htaccess and index page files
 	:returns:	bool
 
-Deletes ALL files contained in the supplied path.
+	Deletes ALL files contained in the supplied path.
 
-Example::
+	Example::
 
-	delete_files('./path/to/directory/');
+		delete_files('./path/to/directory/');
 
-If the second parameter is set to TRUE, any directories contained within the supplied
-root path will be deleted as well.
+	If the second parameter is set to TRUE, any directories contained within the supplied
+	root path will be deleted as well.
 
-Example::
+	Example::
 
-	delete_files('./path/to/directory/', TRUE);
+		delete_files('./path/to/directory/', TRUE);
 
-.. note:: The files must be writable or owned by the system in order to be deleted.
+	.. note:: The files must be writable or owned by the system in order to be deleted.
 
-get_filenames()
-===============
 
-.. function:: get_filenames($source_dir, $include_path = FALSE)
+.. function:: get_filenames($source_dir[, $include_path = FALSE])
 
 	:param	string	$source_dir: Directory path
 	:param	bool	$include_path: Whether to include the path as part of the filenames
 	:returns:	array
 
-Takes a server path as input and returns an array containing the names of all files
-contained within it. The file path can optionally be added to the file names by setting
-the second parameter to TRUE.
+	Takes a server path as input and returns an array containing the names of all files
+	contained within it. The file path can optionally be added to the file names by setting
+	the second parameter to TRUE.
 
-Example::
+	Example::
 
-	$controllers = get_filenames(APPPATH.'controllers/');
+		$controllers = get_filenames(APPPATH.'controllers/');
 
-get_dir_file_info()
-===================
 
 .. function:: get_dir_file_info($source_dir, $top_level_only)
 
@@ -136,81 +134,72 @@ get_dir_file_info()
 			(excluding sub-directories)
 	:returns:	array
 
-Reads the specified directory and builds an array containing the filenames, filesize,
-dates, and permissions. Sub-folders contained within the specified path are only read
-if forced by sending the second parameter to FALSE, as this can be an intensive
-operation.
+	Reads the specified directory and builds an array containing the filenames, filesize,
+	dates, and permissions. Sub-folders contained within the specified path are only read
+	if forced by sending the second parameter to FALSE, as this can be an intensive
+	operation.
 
-Example::
+	Example::
 
-	$models_info = get_dir_file_info(APPPATH.'models/');
+		$models_info = get_dir_file_info(APPPATH.'models/');
 
-get_file_info()
-===============
 
-.. function: get_file_info($file, $returned_values = array('name', 'server_path', 'size', 'date'))
+.. function:: get_file_info($file[, $returned_values = array('name', 'server_path', 'size', 'date')])
 
 	:param	string	$file: File path
 	:param	array	$returned_values: What type of info to return
 	:returns:	array or FALSE on failure
 
-Given a file and path, returns (optionally) the *name*, *path*, *size* and *date modified*
-information attributes for a file. Second parameter allows you to explicitly declare what
-information you want returned.
-
-Valid ``$returned_values`` options are: `name`, `size`, `date`, `readable`, `writeable`,
-`executable` and `fileperms`.
+	Given a file and path, returns (optionally) the *name*, *path*, *size* and *date modified*
+	information attributes for a file. Second parameter allows you to explicitly declare what
+	information you want returned.
 
-.. note:: The *writable* attribute is checked via PHP's ``is_writeable()`` function, which
-	known to have issues on the IIS webserver. Consider using *fileperms* instead,
-	which returns information from PHP's ``fileperms()`` function.
+	Valid ``$returned_values`` options are: `name`, `size`, `date`, `readable`, `writeable`,
+	`executable` and `fileperms`.
 
-get_mime_by_extension()
-=======================
+	.. note:: The *writable* attribute is checked via PHP's ``is_writeable()`` function, which
+		known to have issues on the IIS webserver. Consider using *fileperms* instead,
+		which returns information from PHP's ``fileperms()`` function.
 
 .. function:: get_mime_by_extension($filename)
 
 	:param	string	$filename: File name
 	:returns:	string or FALSE on failure
 
-Translates a filename extension into a MIME type based on *config/mimes.php*.
-Returns FALSE if it can't determine the type, or read the MIME config file.
+	Translates a filename extension into a MIME type based on *config/mimes.php*.
+	Returns FALSE if it can't determine the type, or read the MIME config file.
 
-::
+	::
 
-	$file = 'somefile.png';
-	echo $file.' is has a mime type of '.get_mime_by_extension($file);
+		$file = 'somefile.png';
+		echo $file.' is has a mime type of '.get_mime_by_extension($file);
 
-.. note:: This is not an accurate way of determining file MIME types, and
-	is here strictly for convenience. It should not be used for security
-	purposes.
+	.. note:: This is not an accurate way of determining file MIME types, and
+		is here strictly for convenience. It should not be used for security
+		purposes.
 
-symbolic_permissions()
-======================
 
 .. function:: symbolic_permissions($perms)
 
 	:param	int	$perms: Permissions
 	:returns:	string
 
-Takes numeric permissions (such as is returned by ``fileperms()``) and returns
-standard symbolic notation of file permissions.
+	Takes numeric permissions (such as is returned by ``fileperms()``) and returns
+	standard symbolic notation of file permissions.
 
-::
+	::
 
-	echo symbolic_permissions(fileperms('./index.php'));  // -rw-r--r--
+		echo symbolic_permissions(fileperms('./index.php'));  // -rw-r--r--
 
-octal_permissions()
-===================
 
 .. function:: octal_permissions($perms)
 
 	:param	int	$perms: Permissions
 	:returns:	string
 
-Takes numeric permissions (such as is returned by ``fileperms()``) and returns
-a three character octal notation of file permissions.
+	Takes numeric permissions (such as is returned by ``fileperms()``) and returns
+	a three character octal notation of file permissions.
 
-::
+	::
 
-	echo octal_permissions(fileperms('./index.php')); // 644
\ No newline at end of file
+		echo octal_permissions(fileperms('./index.php')); // 644
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 3530fc0d3a67cac0bb0679ef4e50271f6f658adf Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Sun, 21 Jul 2013 11:14:53 -0700
Subject: Update Form helper docs

---
 user_guide_src/source/helpers/form_helper.rst | 768 ++++++++++++--------------
 1 file changed, 362 insertions(+), 406 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/helpers/form_helper.rst b/user_guide_src/source/helpers/form_helper.rst
index fd66f0191..5bc5887aa 100644
--- a/user_guide_src/source/helpers/form_helper.rst
+++ b/user_guide_src/source/helpers/form_helper.rst
@@ -5,7 +5,12 @@ Form Helper
 The Form Helper file contains functions that assist in working with
 forms.
 
-.. contents:: Page Contents
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
 
 Loading this Helper
 ===================
@@ -14,233 +19,218 @@ This helper is loaded using the following code::
 
 	$this->load->helper('form');
 
+Available Functions
+===================
+
 The following functions are available:
 
-form_open()
-===========
 
-.. function:: form_open($action = '', $attributes = '', $hidden = array())
+.. function:: form_open([$action = ''[, $attributes = ''[, $hidden = array()]]])
 
 	:param	string	$action: Form action/target URI string
 	:param	string	$attributes: HTML attributes
 	:param	array	$hidden: An array of hidden fields' definitions
 	:returns:	string
 
-Creates an opening form tag with a base URL **built from your config preferences**.
-It will optionally let you add form attributes and hidden input fields, and
-will always add the `accept-charset` attribute based on the charset value in your
-config file.
+	Creates an opening form tag with a base URL **built from your config preferences**.
+	It will optionally let you add form attributes and hidden input fields, and
+	will always add the `accept-charset` attribute based on the charset value in your
+	config file.
 
-The main benefit of using this tag rather than hard coding your own HTML is that
-it permits your site to be more portable in the event your URLs ever change.
+	The main benefit of using this tag rather than hard coding your own HTML is that
+	it permits your site to be more portable in the event your URLs ever change.
 
-Here's a simple example::
+	Here's a simple example::
 
-	echo form_open('email/send');
+		echo form_open('email/send');
 
-The above example would create a form that points to your base URL plus the
-"email/send" URI segments, like this::
+	The above example would create a form that points to your base URL plus the
+	"email/send" URI segments, like this::
 
-	<form method="post" accept-charset="utf-8" action="http://example.com/index.php/email/send" />
+		<form method="post" accept-charset="utf-8" action="http://example.com/index.php/email/send" />
 
-Adding Attributes
-^^^^^^^^^^^^^^^^^
+	**Adding Attributes**
 
-Attributes can be added by passing an associative array to the second
-parameter, like this::
+		Attributes can be added by passing an associative array to the second
+		parameter, like this::
 
-	$attributes = array('class' => 'email', 'id' => 'myform');
-	echo form_open('email/send', $attributes);
+			$attributes = array('class' => 'email', 'id' => 'myform');
+			echo form_open('email/send', $attributes);
 
-The above example would create a form similar to this::
+		The above example would create a form similar to this::
 
-	<form method="post" accept-charset="utf-8" action="http://example.com/index.php/email/send" class="email" id="myform" />
+			<form method="post" accept-charset="utf-8" action="http://example.com/index.php/email/send" class="email" id="myform" />
 
-Adding Hidden Input Fields
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+	**Adding Hidden Input Fields**
 
-Hidden fields can be added by passing an associative array to the
-third parameter, like this::
+		Hidden fields can be added by passing an associative array to the
+		third parameter, like this::
 
-	$hidden = array('username' => 'Joe', 'member_id' => '234');
-	echo form_open('email/send', '', $hidden);
+			$hidden = array('username' => 'Joe', 'member_id' => '234');
+			echo form_open('email/send', '', $hidden);
 
-The above example would create a form similar to this::
+		The above example would create a form similar to this::
 
-	<form method="post" accept-charset="utf-8" action="http://example.com/index.php/email/send">
-		<input type="hidden" name="username" value="Joe" />
-		<input type="hidden" name="member_id" value="234" />
+			<form method="post" accept-charset="utf-8" action="http://example.com/index.php/email/send">
+				<input type="hidden" name="username" value="Joe" />
+				<input type="hidden" name="member_id" value="234" />
 
-form_open_multipart()
-=====================
 
-.. function:: form_open_multipart($action = '', $attributes = array(), $hidden = array())
+.. function:: form_open_multipart([$action = ''[, $attributes = array()[, $hidden = array()]])
 
 	:param	string	$action: Form action/target URI string
 	:param	string	$attributes: HTML attributes
 	:param	array	$hidden: An array of hidden fields' definitions
 	:returns:	string
 
-This function is absolutely identical to :func:`form_open()` above,
-except that it adds a *multipart* attribute, which is necessary if you
-would like to use the form to upload files with.
+	This function is absolutely identical to :func:`form_open()` above,
+	except that it adds a *multipart* attribute, which is necessary if you
+	would like to use the form to upload files with.
 
-form_hidden()
-=============
 
-.. function:: form_hidden($name, $value = '')
+.. function:: form_hidden($name[, $value = ''])
 
 	:param	string	$name: Field name
 	:param	string	$value: Field value
 	:returns:	string
 
-Lets you generate hidden input fields. You can either submit a
-name/value string to create one field::
+	Lets you generate hidden input fields. You can either submit a
+	name/value string to create one field::
 
-	form_hidden('username', 'johndoe');
-	// Would produce: <input type="hidden" name="username" value="johndoe" />
+		form_hidden('username', 'johndoe');
+		// Would produce: <input type="hidden" name="username" value="johndoe" />
 
-... or you can submit an associative array to create multiple fields::
+	... or you can submit an associative array to create multiple fields::
 
-	$data = array(
-		'name'	=> 'John Doe',
-		'email'	=> 'john@example.com',
-		'url'	=> 'http://example.com'
-	);
+		$data = array(
+			'name'	=> 'John Doe',
+			'email'	=> 'john@example.com',
+			'url'	=> 'http://example.com'
+		);
 
-	echo form_hidden($data);
+		echo form_hidden($data);
 
-	/*
-		Would produce:
-		<input type="hidden" name="name" value="John Doe" />
-		<input type="hidden" name="email" value="john@example.com" />
-		<input type="hidden" name="url" value="http://example.com" />
-	*/
+		/*
+			Would produce:
+			<input type="hidden" name="name" value="John Doe" />
+			<input type="hidden" name="email" value="john@example.com" />
+			<input type="hidden" name="url" value="http://example.com" />
+		*/
 
-You can also pass an associative array to the value field::
+	You can also pass an associative array to the value field::
 
-	$data = array(
-		'name'	=> 'John Doe',
-		'email'	=> 'john@example.com',
-		'url'	=> 'http://example.com'
-	);
+		$data = array(
+			'name'	=> 'John Doe',
+			'email'	=> 'john@example.com',
+			'url'	=> 'http://example.com'
+		);
 
-	echo form_hidden('my_array', $data);
+		echo form_hidden('my_array', $data);
 
-	/*
-		Would produce:
+		/*
+			Would produce:
 
-		<input type="hidden" name="my_array[name]" value="John Doe" />
-		<input type="hidden" name="my_array[email]" value="john@example.com" />
-		<input type="hidden" name="my_array[url]" value="http://example.com" />
-	*/
+			<input type="hidden" name="my_array[name]" value="John Doe" />
+			<input type="hidden" name="my_array[email]" value="john@example.com" />
+			<input type="hidden" name="my_array[url]" value="http://example.com" />
+		*/
 
-If you want to create hidden input fields with extra attributes::
+	If you want to create hidden input fields with extra attributes::
 
-	$data = array(
-		'type'	=> 'hidden',
-		'name'	=> 'email',
-		'id'	=> 'hiddenemail',
-		'value'	=> 'john@example.com',
-		'class'	=> 'hiddenemail'
-	);
+		$data = array(
+			'type'	=> 'hidden',
+			'name'	=> 'email',
+			'id'	=> 'hiddenemail',
+			'value'	=> 'john@example.com',
+			'class'	=> 'hiddenemail'
+		);
 
-	echo form_input($data);
+		echo form_input($data);
 
-	/*
-		Would produce:
+		/*
+			Would produce:
 
-		<input type="hidden" name="email" value="john@example.com" id="hiddenemail" class="hiddenemail" />
-	*/
+			<input type="hidden" name="email" value="john@example.com" id="hiddenemail" class="hiddenemail" />
+		*/
 
-form_input()
-============
 
-.. function:: form_input($data = '', $value = '', $extra = '')
+.. function:: form_input([$data = ''[, $value = ''[, $extra = '']])
 
 	:param	array	$data: Field attributes data
 	:param	string	$value: Field value
 	:param	string	$extra: Extra attributes to be added to the tag *as is*
 	:returns:	string
 
-Lets you generate a standard text input field. You can minimally pass
-the field name and value in the first and second parameter::
+	Lets you generate a standard text input field. You can minimally pass
+	the field name and value in the first and second parameter::
 
-	echo form_input('username', 'johndoe');
+		echo form_input('username', 'johndoe');
 
-Or you can pass an associative array containing any data you wish your
-form to contain::
+	Or you can pass an associative array containing any data you wish your
+	form to contain::
 
-	$data = array(
-		'name'		=> 'username',
-		'id'		=> 'username',
-		'value'		=> 'johndoe',
-		'maxlength'	=> '100',
-		'size'		=> '50',
-		'style'		=> 'width:50%'
-	);
+		$data = array(
+			'name'		=> 'username',
+			'id'		=> 'username',
+			'value'		=> 'johndoe',
+			'maxlength'	=> '100',
+			'size'		=> '50',
+			'style'		=> 'width:50%'
+		);
 
-	echo form_input($data);
+		echo form_input($data);
 
-	/*
-		Would produce:
+		/*
+			Would produce:
 
-		<input type="text" name="username" value="johndoe" id="username" maxlength="100" size="50" style="width:50%"  />
-	*/
+			<input type="text" name="username" value="johndoe" id="username" maxlength="100" size="50" style="width:50%"  />
+		*/
 
-If you would like your form to contain some additional data, like
-JavaScript, you can pass it as a string in the third parameter::
+	If you would like your form to contain some additional data, like
+	JavaScript, you can pass it as a string in the third parameter::
 
-	$js = 'onClick="some_function()"';
-	echo form_input('username', 'johndoe', $js);
+		$js = 'onClick="some_function()"';
+		echo form_input('username', 'johndoe', $js);
 
-form_password()
-===============
 
-.. function:: form_password($data = '', $value = '', $extra = '')
+.. function:: form_password([$data = ''[, $value = ''[, $extra = '']]])
 
 	:param	array	$data: Field attributes data
 	:param	string	$value: Field value
 	:param	string	$extra: Extra attributes to be added to the tag *as is*
 	:returns:	string
 
-This function is identical in all respects to the :func:`form_input()`
-function above except that it uses the "password" input type.
+	This function is identical in all respects to the :func:`form_input()`
+	function above except that it uses the "password" input type.
 
-form_upload()
-=============
 
-.. function:: form_upload($data = '', $value = '', $extra = '')
+.. function:: form_upload([$data = ''[, $value = ''[, $extra = '']]])
 
 	:param	array	$data: Field attributes data
 	:param	string	$value: Field value
 	:param	string	$extra: Extra attributes to be added to the tag *as is*
 	:returns:	string
 
-This function is identical in all respects to the :func:`form_input()`
-function above except that it uses the "file" input type, allowing it to
-be used to upload files.
+	This function is identical in all respects to the :func:`form_input()`
+	function above except that it uses the "file" input type, allowing it to
+	be used to upload files.
 
-form_textarea()
-===============
 
-.. function:: form_textarea($data = '', $value = '', $extra = '')
+.. function:: form_textarea([$data = ''[, $value = ''[, $extra = '']]])
 
 	:param	array	$data: Field attributes data
 	:param	string	$value: Field value
 	:param	string	$extra: Extra attributes to be added to the tag *as is*
 	:returns:	string
 
-This function is identical in all respects to the :func:`form_input()`
-function above except that it generates a "textarea" type.
+	This function is identical in all respects to the :func:`form_input()`
+	function above except that it generates a "textarea" type.
 
-.. note: Instead of the *maxlength* and *size* attributes in the above example,
-	you will instead specify *rows* and *cols*.
+	.. note:: Instead of the *maxlength* and *size* attributes in the above example,
+		you will instead specify *rows* and *cols*.
 
-form_dropdown()
-===============
 
-.. function:: form_dropdown($name = '', $options = array(), $selected = array(), $extra = '')
+.. function:: form_dropdown([$name = ''[, $options = array()[, $selected = array()[, $extra = '']]]])
 
 	:param	string	$name: Field name
 	:param	array	$options: An associative array of options to be listed
@@ -248,64 +238,62 @@ form_dropdown()
 	:param	string	$extra: Extra attributes to be added to the tag *as is*
 	:returns:	string
 
-Lets you create a standard drop-down field. The first parameter will
-contain the name of the field, the second parameter will contain an
-associative array of options, and the third parameter will contain the
-value you wish to be selected. You can also pass an array of multiple
-items through the third parameter, and CodeIgniter will create a
-multiple select for you.
-
-Example::
-
-	$options = array(
-		'small'  => 'Small Shirt',
-		'med'    => 'Medium Shirt',
-		'large'  => 'Large Shirt',
-		'xlarge' => 'Extra Large Shirt',
-	);
-
-	$shirts_on_sale = array('small', 'large');
-	echo form_dropdown('shirts', $options, 'large');
-
-	/*
-		Would produce:
-
-		<select name="shirts">
-			<option value="small">Small Shirt</option>
-			<option value="med">Medium  Shirt</option>
-			<option value="large" selected="selected">Large Shirt</option>
-			<option value="xlarge">Extra Large Shirt</option>
-		</select>
-	*/
+	Lets you create a standard drop-down field. The first parameter will
+	contain the name of the field, the second parameter will contain an
+	associative array of options, and the third parameter will contain the
+	value you wish to be selected. You can also pass an array of multiple
+	items through the third parameter, and CodeIgniter will create a
+	multiple select for you.
 
-	echo form_dropdown('shirts', $options, $shirts_on_sale);
+	Example::
 
-	/*
-		Would produce:
+		$options = array(
+			'small'  => 'Small Shirt',
+			'med'    => 'Medium Shirt',
+			'large'  => 'Large Shirt',
+			'xlarge' => 'Extra Large Shirt',
+		);
 
-		<select name="shirts" multiple="multiple">
-			<option value="small" selected="selected">Small Shirt</option>
-			<option value="med">Medium  Shirt</option>
-			<option value="large" selected="selected">Large Shirt</option>
-			<option value="xlarge">Extra Large Shirt</option>
-		</select>
-	*/
+		$shirts_on_sale = array('small', 'large');
+		echo form_dropdown('shirts', $options, 'large');
+
+		/*
+			Would produce:
+
+			<select name="shirts">
+				<option value="small">Small Shirt</option>
+				<option value="med">Medium  Shirt</option>
+				<option value="large" selected="selected">Large Shirt</option>
+				<option value="xlarge">Extra Large Shirt</option>
+			</select>
+		*/
+
+		echo form_dropdown('shirts', $options, $shirts_on_sale);
 
-If you would like the opening <select> to contain additional data, like
-an id attribute or JavaScript, you can pass it as a string in the fourth
-parameter::
+		/*
+			Would produce:
 
-	$js = 'id="shirts" onChange="some_function();"';
-	echo form_dropdown('shirts', $options, 'large', $js);
+			<select name="shirts" multiple="multiple">
+				<option value="small" selected="selected">Small Shirt</option>
+				<option value="med">Medium  Shirt</option>
+				<option value="large" selected="selected">Large Shirt</option>
+				<option value="xlarge">Extra Large Shirt</option>
+			</select>
+		*/
 
-If the array passed as ``$options`` is a multidimensional array, then
-``form_dropdown()`` will produce an <optgroup> with the array key as the
-label.
+	If you would like the opening <select> to contain additional data, like
+	an id attribute or JavaScript, you can pass it as a string in the fourth
+	parameter::
 
-form_multiselect()
-==================
+		$js = 'id="shirts" onChange="some_function();"';
+		echo form_dropdown('shirts', $options, 'large', $js);
 
-.. function:: form_multiselect($name = '', $options = array(), $selected = array(), $extra = '')
+	If the array passed as ``$options`` is a multidimensional array, then
+	``form_dropdown()`` will produce an <optgroup> with the array key as the
+	label.
+
+
+.. function:: form_multiselect([$name = ''[, $options = array()[, $selected = array()[, $extra = '']]]])
 
 	:param	string	$name: Field name
 	:param	array	$options: An associative array of options to be listed
@@ -313,84 +301,78 @@ form_multiselect()
 	:param	string	$extra: Extra attributes to be added to the tag *as is*
 	:returns:	string
 
-Lets you create a standard multiselect field. The first parameter will
-contain the name of the field, the second parameter will contain an
-associative array of options, and the third parameter will contain the
-value or values you wish to be selected.
+	Lets you create a standard multiselect field. The first parameter will
+	contain the name of the field, the second parameter will contain an
+	associative array of options, and the third parameter will contain the
+	value or values you wish to be selected.
 
-The parameter usage is identical to using :func:`form_dropdown()` above,
-except of course that the name of the field will need to use POST array
-syntax, e.g. foo[].
+	The parameter usage is identical to using :func:`form_dropdown()` above,
+	except of course that the name of the field will need to use POST array
+	syntax, e.g. foo[].
 
-form_fieldset()
-===============
 
-.. function:: form_fieldset($legend_text = '', $attributes = array())
+.. function:: form_fieldset([$legend_text = ''[, $attributes = array()]])
 
 	:param	string	$legend_text: Text to put in the <legend> tag
 	:param	array	$attributes: Attributes to be set on the <fieldset> tag
 	:returns:	string
 
-Lets you generate fieldset/legend fields.
+	Lets you generate fieldset/legend fields.
 
-Example::
+	Example::
 
-	echo form_fieldset('Address Information');
-	echo "<p>fieldset content here</p>\n";
-	echo form_fieldset_close();
+		echo form_fieldset('Address Information');
+		echo "<p>fieldset content here</p>\n";
+		echo form_fieldset_close();
 
-	/*
-		Produces:
+		/*
+			Produces:
 
-			<fieldset>
-				<legend>Address Information</legend>
-					<p>form content here</p>
-			</fieldset>
-	*/
+				<fieldset>
+					<legend>Address Information</legend>
+						<p>form content here</p>
+				</fieldset>
+		*/
 
-Similar to other functions, you can submit an associative array in the
-second parameter if you prefer to set additional attributes::
+	Similar to other functions, you can submit an associative array in the
+	second parameter if you prefer to set additional attributes::
 
-	$attributes = array(
-		'id'	=> 'address_info',
-		'class'	=> 'address_info'
-	);
+		$attributes = array(
+			'id'	=> 'address_info',
+			'class'	=> 'address_info'
+		);
 
-	echo form_fieldset('Address Information', $attributes);
-	echo "<p>fieldset content here</p>\n";
-	echo form_fieldset_close();
+		echo form_fieldset('Address Information', $attributes);
+		echo "<p>fieldset content here</p>\n";
+		echo form_fieldset_close();
 
-	/*
-		Produces:
+		/*
+			Produces:
 
-		<fieldset id="address_info" class="address_info">
-			<legend>Address Information</legend>
-			<p>form content here</p>
-		</fieldset>
-	*/
+			<fieldset id="address_info" class="address_info">
+				<legend>Address Information</legend>
+				<p>form content here</p>
+			</fieldset>
+		*/
 
-form_fieldset_close()
-=====================
 
-.. function:: form_fieldset_close($extra = '')
+.. function:: form_fieldset_close([$extra = ''])
 
 	:param	string	$extra: Anything to append after the closing tag, *as is*
 	:returns:	string
 
-Produces a closing </fieldset> tag. The only advantage to using this
-function is it permits you to pass data to it which will be added below
-the tag. For example
+	Produces a closing </fieldset> tag. The only advantage to using this
+	function is it permits you to pass data to it which will be added below
+	the tag. For example
 
-::
+	::
 
-	$string = '</div></div>';
-	echo form_fieldset_close($string);
-	// Would produce: </fieldset></div></div>
+		$string = '</div></div>';
+		echo form_fieldset_close($string);
+		// Would produce: </fieldset></div></div>
 
-form_checkbox()
-===============
 
-.. function:: form_checkbox($data = '', $value = '', $checked = FALSE, $extra = '')
+.. function:: form_checkbox([$data = ''[, $value = ''[, $checked = FALSE[, $extra = '']]]])
 
 	:param	array	$data: Field attributes data
 	:param	string	$value: Field value
@@ -398,41 +380,39 @@ form_checkbox()
 	:param	string	$extra: Extra attributes to be added to the tag *as is*
 	:returns:	string
 
-Lets you generate a checkbox field. Simple example::
+	Lets you generate a checkbox field. Simple example::
 
-	echo form_checkbox('newsletter', 'accept', TRUE);
-	// Would produce:  <input type="checkbox" name="newsletter" value="accept" checked="checked" />
+		echo form_checkbox('newsletter', 'accept', TRUE);
+		// Would produce:  <input type="checkbox" name="newsletter" value="accept" checked="checked" />
 
-The third parameter contains a boolean TRUE/FALSE to determine whether
-the box should be checked or not.
+	The third parameter contains a boolean TRUE/FALSE to determine whether
+	the box should be checked or not.
 
-Similar to the other form functions in this helper, you can also pass an
-array of attributes to the function
+	Similar to the other form functions in this helper, you can also pass an
+	array of attributes to the function
 
-::
+	::
 
-	$data = array(
-		'name'    => 'newsletter',
-		'id'      => 'newsletter',
-		'value'   => 'accept',
-		'checked' => TRUE,
-		'style'   => 'margin:10px'
-	);
+		$data = array(
+			'name'    => 'newsletter',
+			'id'      => 'newsletter',
+			'value'   => 'accept',
+			'checked' => TRUE,
+			'style'   => 'margin:10px'
+		);
 
-	echo form_checkbox($data);
-	// Would produce: <input type="checkbox" name="newsletter" id="newsletter" value="accept" checked="checked" style="margin:10px" />
+		echo form_checkbox($data);
+		// Would produce: <input type="checkbox" name="newsletter" id="newsletter" value="accept" checked="checked" style="margin:10px" />
 
-Also as with other functions, if you would like the tag to contain
-additional data like JavaScript, you can pass it as a string in the
-fourth parameter::
+	Also as with other functions, if you would like the tag to contain
+	additional data like JavaScript, you can pass it as a string in the
+	fourth parameter::
 
-	$js = 'onClick="some_function()"';
-	echo form_checkbox('newsletter', 'accept', TRUE, $js)
+		$js = 'onClick="some_function()"';
+		echo form_checkbox('newsletter', 'accept', TRUE, $js)
 
-form_radio()
-============
 
-.. function:: form_radio($data = '', $value = '', $checked = FALSE, $extra = '')
+.. function:: form_radio([$data = ''[, $value = ''[, $checked = FALSE[, $extra = '']]]])
 
 	:param	array	$data: Field attributes data
 	:param	string	$value: Field value
@@ -440,283 +420,259 @@ form_radio()
 	:param	string	$extra: Extra attributes to be added to the tag *as is*
 	:returns:	string
 
-This function is identical in all respects to the :func:`form_checkbox()`
-function above except that it uses the "radio" input type.
+	This function is identical in all respects to the :func:`form_checkbox()`
+	function above except that it uses the "radio" input type.
 
-form_label()
-============
 
-.. function:: form_label($label_text = '', $id = '', $attributes = array())
+.. function:: form_label([$label_text = ''[, $id = ''[, $attributes = array()]]])
 
 	:param	string	$label_text: Text to put in the <label> tag
 	:param	string	$id: ID of the form element that we're making a label for
 	:param	string	$attributes: HTML attributes
 	:returns:	string
 
-Lets you generate a <label>. Simple example::
+	Lets you generate a <label>. Simple example::
 
-	echo form_label('What is your Name', 'username');
-	// Would produce:  <label for="username">What is your Name</label>
+		echo form_label('What is your Name', 'username');
+		// Would produce:  <label for="username">What is your Name</label>
 
-Similar to other functions, you can submit an associative array in the
-third parameter if you prefer to set additional attributes.
+	Similar to other functions, you can submit an associative array in the
+	third parameter if you prefer to set additional attributes.
 
-Example::
+	Example::
 
-	$attributes = array(
-		'class' => 'mycustomclass',
-		'style' => 'color: #000;'
-	);
+		$attributes = array(
+			'class' => 'mycustomclass',
+			'style' => 'color: #000;'
+		);
 
-	echo form_label('What is your Name', 'username', $attributes);
-	// Would produce:  <label for="username" class="mycustomclass" style="color: #000;">What is your Name</label>
+		echo form_label('What is your Name', 'username', $attributes);
+		// Would produce:  <label for="username" class="mycustomclass" style="color: #000;">What is your Name</label>
 
-form_submit()
-=============
 
-.. function:: form_submit($data = '', $value = '', $extra = '')
+.. function:: form_submit([$data = ''[, $value = ''[, $extra = '']]])
 
 	:param	string	$data: Button name
 	:param	string	$value: Button value
 	:param	string	$extra: Extra attributes to be added to the tag *as is*
 	:returns:	string
 
-Lets you generate a standard submit button. Simple example::
+	Lets you generate a standard submit button. Simple example::
 
-	echo form_submit('mysubmit', 'Submit Post!');
-	// Would produce:  <input type="submit" name="mysubmit" value="Submit Post!" />
+		echo form_submit('mysubmit', 'Submit Post!');
+		// Would produce:  <input type="submit" name="mysubmit" value="Submit Post!" />
 
-Similar to other functions, you can submit an associative array in the
-first parameter if you prefer to set your own attributes. The third
-parameter lets you add extra data to your form, like JavaScript.
+	Similar to other functions, you can submit an associative array in the
+	first parameter if you prefer to set your own attributes. The third
+	parameter lets you add extra data to your form, like JavaScript.
 
-form_reset()
-============
 
-.. function:: form_reset($data = '', $value = '', $extra = '')
+.. function:: form_reset([$data = ''[, $value = ''[, $extra = '']]])
 
 	:param	string	$data: Button name
 	:param	string	$value: Button value
 	:param	string	$extra: Extra attributes to be added to the tag *as is*
 	:returns:	string
 
-Lets you generate a standard reset button. Use is identical to
-:func:`form_submit()`.
+	Lets you generate a standard reset button. Use is identical to
+	:func:`form_submit()`.
 
-form_button()
-=============
 
-.. function:: form_button($data = '', $content = '', $extra = '')
+.. function:: form_button([$data = ''[, $content = ''[, $extra = '']]])
 
 	:param	string	$data: Button name
 	:param	string	$content: Button label
 	:param	string	$extra: Extra attributes to be added to the tag *as is*
 	:returns:	string
 
-Lets you generate a standard button element. You can minimally pass the
-button name and content in the first and second parameter::
+	Lets you generate a standard button element. You can minimally pass the
+	button name and content in the first and second parameter::
 
-	echo form_button('name','content');
-	// Would produce: <button name="name" type="button">Content</button>
+		echo form_button('name','content');
+		// Would produce: <button name="name" type="button">Content</button>
 
-Or you can pass an associative array containing any data you wish your
-form to contain::
+	Or you can pass an associative array containing any data you wish your
+	form to contain::
 
-	$data = array(
-		'name'    => 'button',
-		'id'      => 'button',
-		'value'   => 'true',
-		'type'    => 'reset',
-		'content' => 'Reset'
-	);
+		$data = array(
+			'name'    => 'button',
+			'id'      => 'button',
+			'value'   => 'true',
+			'type'    => 'reset',
+			'content' => 'Reset'
+		);
 
-	echo form_button($data);
-	// Would produce: <button name="button" id="button" value="true" type="reset">Reset</button>
+		echo form_button($data);
+		// Would produce: <button name="button" id="button" value="true" type="reset">Reset</button>
 
-If you would like your form to contain some additional data, like
-JavaScript, you can pass it as a string in the third parameter::
+	If you would like your form to contain some additional data, like
+	JavaScript, you can pass it as a string in the third parameter::
 
-	$js = 'onClick="some_function()"';
-	echo form_button('mybutton', 'Click Me', $js);
+		$js = 'onClick="some_function()"';
+		echo form_button('mybutton', 'Click Me', $js);
 
-form_close()
-============
 
-.. function:: form_close($extra = '')
+.. function:: form_close([$extra = ''])
 
 	:param	string	$extra: Anything to append after the closing tag, *as is*
 	:returns:	string
 
-Produces a closing </form> tag. The only advantage to using this
-function is it permits you to pass data to it which will be added below
-the tag. For example::
+	Produces a closing </form> tag. The only advantage to using this
+	function is it permits you to pass data to it which will be added below
+	the tag. For example::
 
-	$string = '</div></div>';
-	echo form_close($string);
-	// Would produce:  </form> </div></div>
+		$string = '</div></div>';
+		echo form_close($string);
+		// Would produce:  </form> </div></div>
 
-form_prep()
-===========
 
-.. function:: form_prep($str = '', $is_textarea = FALSE)
+.. function:: form_prep([$str = ''[, $is_textarea = FALSE]])
 
 	:param	string	$str: Value to escape
 	:param	bool	$is_textarea: Whether we're preparing for <textarea> or a regular input tag
 	:returns:	string
 
-Allows you to safely use HTML and characters such as quotes within form
-elements without breaking out of the form.
+	Allows you to safely use HTML and characters such as quotes within form
+	elements without breaking out of the form.
 
-Consider this example::
+	Consider this example::
 
-	$string = 'Here is a string containing "quoted" text.';
-	<input type="text" name="myform" value="$string" />
+		$string = 'Here is a string containing "quoted" text.';
+		<input type="text" name="myform" value="$string" />
 
-Since the above string contains a set of quotes it will cause the form
-to break. The ``form_prep()`` function converts HTML so that it can be used
-safely::
+	Since the above string contains a set of quotes it will cause the form
+	to break. The ``form_prep()`` function converts HTML so that it can be used
+	safely::
 
-	<input type="text" name="myform" value="<?php echo form_prep($string); ?>" />
+		<input type="text" name="myform" value="<?php echo form_prep($string); ?>" />
 
-.. note:: If you use any of the form helper functions listed in this page the form
-	values will be prepped automatically, so there is no need to call this
-	function. Use it only if you are creating your own form elements.
+	.. note:: If you use any of the form helper functions listed in this page the form
+		values will be prepped automatically, so there is no need to call this
+		function. Use it only if you are creating your own form elements.
 
-set_value()
-===========
 
-.. function:: set_value($field = '', $default = '', $is_textarea = FALSE)
+.. function:: set_value([$field = ''[, $default = ''[, $is_textarea = FALSE]]])
 
 	:param	string	$field: Field name
 	:param	string	$default: Default value
 	:param	bool	$is_textarea: Whether we're setting <textarea> content
 	:returns:	string
 
-Permits you to set the value of an input form or textarea. You must
-supply the field name via the first parameter of the function. The
-second (optional) parameter allows you to set a default value for the
-form.
+	Permits you to set the value of an input form or textarea. You must
+	supply the field name via the first parameter of the function. The
+	second (optional) parameter allows you to set a default value for the
+	form.
 
-Example::
+	Example::
 
-	<input type="text" name="quantity" value="<?=set_value('quantity', '0');?>" size="50" />
+		<input type="text" name="quantity" value="<?=set_value('quantity', '0');?>" size="50" />
 
-The above form will show "0" when loaded for the first time.
+	The above form will show "0" when loaded for the first time.
 
-set_select()
-============
 
-.. function:: set_select($field = '', $value = '', $default = FALSE)
+.. function:: set_select([$field = ''[, $value = ''[, $default = FALSE]]])
 
 	:param	string	$field: Field name
 	:param	string	$value: Value to check for
 	:param	string	$default: Whether the value is also a default one
 	:returns:	string
 
-If you use a <select> menu, this function permits you to display the
-menu item that was selected.
+	If you use a <select> menu, this function permits you to display the
+	menu item that was selected.
 
-The first parameter must contain the name of the select menu, the second
-parameter must contain the value of each item, and the third (optional)
-parameter lets you set an item as the default (use boolean TRUE/FALSE).
+	The first parameter must contain the name of the select menu, the second
+	parameter must contain the value of each item, and the third (optional)
+	parameter lets you set an item as the default (use boolean TRUE/FALSE).
 
-Example::
+	Example::
 
-	<select name="myselect">
-		<option value="one" <?php echo  set_select('myselect', 'one', TRUE); ?> >One</option>
-		<option value="two" <?php echo  set_select('myselect', 'two'); ?> >Two</option>
-		<option value="three" <?php echo  set_select('myselect', 'three'); ?> >Three</option>
-	</select>
+		<select name="myselect">
+			<option value="one" <?php echo  set_select('myselect', 'one', TRUE); ?> >One</option>
+			<option value="two" <?php echo  set_select('myselect', 'two'); ?> >Two</option>
+			<option value="three" <?php echo  set_select('myselect', 'three'); ?> >Three</option>
+		</select>
 
-set_checkbox()
-==============
 
-.. function:: set_checkbox($field = '', $value = '', $default = FALSE)
+.. function:: set_checkbox([$field = ''[, $value = ''[, $default = FALSE]]])
 
 	:param	string	$field: Field name
 	:param	string	$value: Value to check for
 	:param	string	$default: Whether the value is also a default one
 	:returns:	string
 
-Permits you to display a checkbox in the state it was submitted.
+	Permits you to display a checkbox in the state it was submitted.
 
-The first parameter must contain the name of the checkbox, the second
-parameter must contain its value, and the third (optional) parameter
-lets you set an item as the default (use boolean TRUE/FALSE).
+	The first parameter must contain the name of the checkbox, the second
+	parameter must contain its value, and the third (optional) parameter
+	lets you set an item as the default (use boolean TRUE/FALSE).
 
-Example::
+	Example::
 
-	<input type="checkbox" name="mycheck" value="1" <?php echo set_checkbox('mycheck', '1'); ?> />
-	<input type="checkbox" name="mycheck" value="2" <?php echo set_checkbox('mycheck', '2'); ?> />
+		<input type="checkbox" name="mycheck" value="1" <?php echo set_checkbox('mycheck', '1'); ?> />
+		<input type="checkbox" name="mycheck" value="2" <?php echo set_checkbox('mycheck', '2'); ?> />
 
-set_radio()
-===========
 
-.. function:: set_radio($field = '', $value = '', $default = FALSE)
+.. function:: set_radio([$field = ''[, $value = ''[, $default = FALSE]]])
 
 	:param	string	$field: Field name
 	:param	string	$value: Value to check for
 	:param	string	$default: Whether the value is also a default one
 	:returns:	string
 
-Permits you to display radio buttons in the state they were submitted.
-This function is identical to the :func:`set_checkbox()` function above.
+	Permits you to display radio buttons in the state they were submitted.
+	This function is identical to the :func:`set_checkbox()` function above.
 
-Example::
+	Example::
 
-	<input type="radio" name="myradio" value="1" <?php echo  set_radio('myradio', '1', TRUE); ?> />
-	<input type="radio" name="myradio" value="2" <?php echo  set_radio('myradio', '2'); ?> />
+		<input type="radio" name="myradio" value="1" <?php echo  set_radio('myradio', '1', TRUE); ?> />
+		<input type="radio" name="myradio" value="2" <?php echo  set_radio('myradio', '2'); ?> />
 
-.. note:: If you are using the Form Validation class, you must always specify
-	a rule for your field, even if empty, in order for the ``set_*()``
-	functions to work. This is because if a Form Validation object is
-	defined, the control for ``set_*()`` is handed over to a method of the
-	class instead of the generic helper function.
+	.. note:: If you are using the Form Validation class, you must always specify
+		a rule for your field, even if empty, in order for the ``set_*()``
+		functions to work. This is because if a Form Validation object is
+		defined, the control for ``set_*()`` is handed over to a method of the
+		class instead of the generic helper function.
 
-form_error()
-============
 
-.. function:: form_error($field = '', $prefix = '', $suffix = '')
+.. function:: form_error([$field = ''[, $prefix = ''[, $suffix = '']]])
 
 	:param	string	$field:	Field name
 	:param	string	$prefix: Error opening tag
 	:param	string	$suffix: Error closing tag
 	:returns:	string
 
-Returns a validation error message from the :doc:`Form Validation Library
-<../libraries/form_validation>`, associated with the specified field name.
-You can optionally specify opening and closing tag(s) to put around the error
-message.
+	Returns a validation error message from the :doc:`Form Validation Library
+	<../libraries/form_validation>`, associated with the specified field name.
+	You can optionally specify opening and closing tag(s) to put around the error
+	message.
 
-Example::
+	Example::
 
-	// Assuming that the 'username' field value was incorrect:
-	echo form_error('myfield', '<div class="error">', '</div>');
+		// Assuming that the 'username' field value was incorrect:
+		echo form_error('myfield', '<div class="error">', '</div>');
 
-	// Would produce: <div class="error">Error message associated with the "username" field.</div>
+		// Would produce: <div class="error">Error message associated with the "username" field.</div>
 
-validation_errors()
-===================
 
-.. function:: validation_errors($prefix = '', $suffix = '')
+.. function:: validation_errors([$prefix = ''[, $suffix = '']])
 
 	:param	string	$prefix: Error opening tag
 	:param	string	$suffix: Error closing tag
 	:returns:	string
 
-Similarly to the :func:`form_error()` function, returns all validation
-error messages produced by the :doc:`Form Validation Library
-<../libraries/form_validation>`, with optional opening and closing tags
-around each of the messages.
+	Similarly to the :func:`form_error()` function, returns all validation
+	error messages produced by the :doc:`Form Validation Library
+	<../libraries/form_validation>`, with optional opening and closing tags
+	around each of the messages.
 
-Example::
+	Example::
 
-	echo validation_errors('<span class="error">', '</span>');
+		echo validation_errors('<span class="error">', '</span>');
 
-	/*
-		Would produce, e.g.:
+		/*
+			Would produce, e.g.:
 
-		<span class="error">The "email" field doesn't contain a valid e-mail address!</span>
-		<span class="error">The "password" field doesn't match the "repeat_password" field!</span>
+			<span class="error">The "email" field doesn't contain a valid e-mail address!</span>
+			<span class="error">The "password" field doesn't match the "repeat_password" field!</span>
 
-	 */
\ No newline at end of file
+		 */
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 0f0304c81c8641d373c88d970456e66ebe362ac2 Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Sun, 21 Jul 2013 11:35:30 -0700
Subject: Update HTML helper docs

---
 user_guide_src/source/helpers/html_helper.rst | 597 +++++++++++++-------------
 1 file changed, 300 insertions(+), 297 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/helpers/html_helper.rst b/user_guide_src/source/helpers/html_helper.rst
index 1016d3bcd..9e9d7ca62 100644
--- a/user_guide_src/source/helpers/html_helper.rst
+++ b/user_guide_src/source/helpers/html_helper.rst
@@ -5,7 +5,12 @@ HTML Helper
 The HTML Helper file contains functions that assist in working with
 HTML.
 
-.. contents:: Page Contents
+.. contents::
+	:local:
+
+.. raw:: html
+
+	<div class="custom-index container"></div>
 
 Loading this Helper
 ===================
@@ -14,94 +19,95 @@ This helper is loaded using the following code::
 
 	$this->load->helper('html');
 
+Available Functions
+===================
+
 The following functions are available:
 
-br()
-====
 
-.. function:: br($count = 1)
+.. function:: br([$count = 1])
 
 	:param	int	$count: Number of times to repeat the tag
 	:returns:	string
 
-Generates line break tags (<br />) based on the number you submit.
-Example::
+	Generates line break tags (<br />) based on the number you submit.
+	Example::
+
+		echo br(3);
+
+	The above would produce:
 
-	echo br(3);
+	.. code-block:: html
 
-The above would produce: <br /><br /><br />
+		<br /><br /><br />
 
-heading()
-=========
 
-.. function:: heading($data = '', $h = '1', $attributes = '')
+.. function:: heading([$data = ''[, $h = '1'[, $attributes = '']]])
 
 	:param	string	$data: Content
 	:param	string	$h: Heading level
 	:param	array	$attributes: HTML attributes
 	:returns:	string
 
-Lets you create HTML heading tags. The first parameter will contain the
-data, the second the size of the heading. Example::
+	Lets you create HTML heading tags. The first parameter will contain the
+	data, the second the size of the heading. Example::
 
-	echo heading('Welcome!', 3);
+		echo heading('Welcome!', 3);
 
-The above would produce: <h3>Welcome!</h3>
+	The above would produce: <h3>Welcome!</h3>
 
-Additionally, in order to add attributes to the heading tag such as HTML
-classes, ids or inline styles, a third parameter is available::
+	Additionally, in order to add attributes to the heading tag such as HTML
+	classes, ids or inline styles, a third parameter is available::
 
-	echo heading('Welcome!', 3, 'class="pink"')
+		echo heading('Welcome!', 3, 'class="pink"')
 
-The above code produces: <h3 class="pink">Welcome!<<h3>
+	The above code produces:
 
-img()
-=====
+	.. code-block:: html
 
-.. function:: img($src = '', $index_page = FALSE, $attributes = '')
+		<h3 class="pink">Welcome!<h3>
+
+
+.. function:: img([$src = ''[, $index_page = FALSE[, $attributes = '']]])
 
 	:param	string	$src: Image source data
 	:param	bool	$index_page: Whether to treat $src as a routed URI string
 	:param	array	$attributes: HTML attributes
 	:returns:	string
 
-Lets you create HTML <img /> tags. The first parameter contains the
-image source. Example::
-
-	echo img('images/picture.jpg'); // gives <img src="http://site.com/images/picture.jpg" />
+	Lets you create HTML <img /> tags. The first parameter contains the
+	image source. Example::
 
-There is an optional second parameter that is a TRUE/FALSE value that
-specifics if the *src* should have the page specified by
-``$config['index_page']`` added to the address it creates.
-Presumably, this would be if you were using a media controller::
+		echo img('images/picture.jpg'); // gives <img src="http://site.com/images/picture.jpg" />
 
-	echo img('images/picture.jpg', TRUE); // gives <img src="http://site.com/index.php/images/picture.jpg" alt="" />
+	There is an optional second parameter that is a TRUE/FALSE value that
+	specifics if the *src* should have the page specified by
+	``$config['index_page']`` added to the address it creates.
+	Presumably, this would be if you were using a media controller::
 
+		echo img('images/picture.jpg', TRUE); // gives <img src="http://site.com/index.php/images/picture.jpg" alt="" />
 
-Additionally, an associative array can be passed to the ``img()`` function
-for complete control over all attributes and values. If an *alt* attribute
-is not provided, CodeIgniter will generate an empty string.
+	Additionally, an associative array can be passed to the ``img()`` function
+	for complete control over all attributes and values. If an *alt* attribute
+	is not provided, CodeIgniter will generate an empty string.
 
-Example::
+	Example::
 
-	$image_properties = array(               
-		'src' 	=> 'images/picture.jpg',               
-		'alt' 	=> 'Me, demonstrating how to eat 4 slices of pizza at one time',  
-		'class' => 'post_images',               
-		'width' => '200',               
-		'height'=> '200',               
-		'title' => 'That was quite a night',               
-		'rel' 	=> 'lightbox'
-	);
+		$image_properties = array(
+			'src' 	=> 'images/picture.jpg',
+			'alt' 	=> 'Me, demonstrating how to eat 4 slices of pizza at one time',
+			'class' => 'post_images',
+			'width' => '200',
+			'height'=> '200',
+			'title' => 'That was quite a night',
+			'rel' 	=> 'lightbox'
+		);
 
-	img($image_properties);
-	// <img src="http://site.com/index.php/images/picture.jpg" alt="Me, demonstrating how to eat 4 slices of pizza at one time" class="post_images" width="200" height="200" title="That was quite a night" rel="lightbox" />
+		img($image_properties);
+		// <img src="http://site.com/index.php/images/picture.jpg" alt="Me, demonstrating how to eat 4 slices of pizza at one time" class="post_images" width="200" height="200" title="That was quite a night" rel="lightbox" />
 
 
-link_tag()
-==========
-
-.. function:: ling_tag($href = '', $rel = 'stylesheet', $type = 'text/css', $title = '', $media = '', $index_page = FALSE)
+.. function:: ling_tag([$href = ''[, $rel = 'stylesheet'[, $type = 'text/css'[, $title = ''[, $media = ''[, $index_page = FALSE]]]]]])
 
 	:param	string	$href: What are we linking to
 	:param	string	$rel: Relation type
@@ -111,174 +117,175 @@ link_tag()
 	:param	bool	$index_page: Whether to treat $src as a routed URI string
 	:returns:	string
 
-Lets you create HTML <link /> tags. This is useful for stylesheet links,
-as well as other links. The parameters are *href*, with optional *rel*,
-*type*, *title*, *media* and *index_page*.
-
-*index_page* is a boolean value that specifies if the *href* should have
-the page specified by ``$config['index_page']`` added to the address it creates.
+	Lets you create HTML <link /> tags. This is useful for stylesheet links,
+	as well as other links. The parameters are *href*, with optional *rel*,
+	*type*, *title*, *media* and *index_page*.
 
-Example::
+	*index_page* is a boolean value that specifies if the *href* should have
+	the page specified by ``$config['index_page']`` added to the address it creates.
 
-	echo link_tag('css/mystyles.css');
-	// gives <link href="http://site.com/css/mystyles.css" rel="stylesheet" type="text/css" />
+	Example::
 
+		echo link_tag('css/mystyles.css');
+		// gives <link href="http://site.com/css/mystyles.css" rel="stylesheet" type="text/css" />
 
-Further examples::
+	Further examples::
 
-	echo link_tag('favicon.ico', 'shortcut icon', 'image/ico');
-	// <link href="http://site.com/favicon.ico" rel="shortcut icon" type="image/ico" />
+		echo link_tag('favicon.ico', 'shortcut icon', 'image/ico');
+		// <link href="http://site.com/favicon.ico" rel="shortcut icon" type="image/ico" />
 
-	echo link_tag('feed', 'alternate', 'application/rss+xml', 'My RSS Feed');
-	// <link href="http://site.com/feed" rel="alternate" type="application/rss+xml" title="My RSS Feed" />
+		echo link_tag('feed', 'alternate', 'application/rss+xml', 'My RSS Feed');
+		// <link href="http://site.com/feed" rel="alternate" type="application/rss+xml" title="My RSS Feed" />
 
-Additionally, an associative array can be passed to the ``link()`` function
-for complete control over all attributes and values::
+	Additionally, an associative array can be passed to the ``link()`` function
+	for complete control over all attributes and values::
 
-	$link = array(               
-		'href'	=> 'css/printer.css',
-		'rel'	=> 'stylesheet',
-		'type'	=> 'text/css',
-		'media'	=> 'print'
-	);
+		$link = array(
+			'href'	=> 'css/printer.css',
+			'rel'	=> 'stylesheet',
+			'type'	=> 'text/css',
+			'media'	=> 'print'
+		);
 
-	echo link_tag($link);
-	// <link href="http://site.com/css/printer.css" rel="stylesheet" type="text/css" media="print" />
+		echo link_tag($link);
+		// <link href="http://site.com/css/printer.css" rel="stylesheet" type="text/css" media="print" />
 
-nbs()
-=====
 
-.. function:: nbs($num = 1)
+.. function:: nbs([$num = 1])
 
 	:param	int	$num: Number of space entities to produce
 	:returns:	string
 
-Generates non-breaking spaces (&nbsp;) based on the number you submit.
-Example::
+	Generates non-breaking spaces (&nbsp;) based on the number you submit.
+	Example::
+
+		echo nbs(3);
 
-	echo nbs(3);
+	The above would produce:
 
-The above would produce::
+	.. code-block:: html
 
-	&nbsp;&nbsp;&nbsp;
+		&nbsp;&nbsp;&nbsp;
 
-ul() and ol()
-=============
 
-.. function:: ul($list, $attributes = '')
+.. function:: ul($list[, $attributes = ''])
 
 	:param	array	$list: List entries
 	:param	array	$attributes: HTML attributes
 	:returns:	string
 
-Permits you to generate ordered or unordered HTML lists from simple or
-multi-dimensional arrays. Example::
+	Permits you to generate ordered or unordered HTML lists from simple or
+	multi-dimensional arrays. Example::
 
-	$list = array(
-		'red',
-		'blue',
-		'green',
-		'yellow'
-	);
-
-	$attributes = array(
-		'class'	=> 'boldlist',
-		'id'	=> 'mylist'
-	);
-
-	echo ul($list, $attributes);
-
-The above code will produce this::
-
-	 <ul class="boldlist" id="mylist">
-		<li>red</li>
-		<li>blue</li>
-		<li>green</li>
-		<li>yellow</li>
-	</ul>
-
-Here is a more complex example, using a multi-dimensional array::
-
-	$attributes = array(
-		'class'	=> 'boldlist',
-		'id'	=> 'mylist'
-	);
-
-	$list = array(
-		'colors'  => array(
+		$list = array(
 			'red',
 			'blue',
-			'green'
-		),
-		'shapes'  => array(
-			'round',
-			'square',
-			'circles' => array(
-				'ellipse',
-				'oval',
-				'sphere'
-			)
-		),
-		'moods'  => array(
-			'happy',
-			'upset' => array(
-				'defeated' => array(
-					'dejected',
-					'disheartened',
-					'depressed'
-				),
-				'annoyed',
-				'cross',
-				'angry'
+			'green',
+			'yellow'
+		);
+
+		$attributes = array(
+			'class'	=> 'boldlist',
+			'id'	=> 'mylist'
+		);
+
+		echo ul($list, $attributes);
+
+	The above code will produce this:
+
+	.. code-block:: html
+
+		<ul class="boldlist" id="mylist">
+			<li>red</li>
+			<li>blue</li>
+			<li>green</li>
+			<li>yellow</li>
+		</ul>
+
+	Here is a more complex example, using a multi-dimensional array::
+
+		$attributes = array(
+			'class'	=> 'boldlist',
+			'id'	=> 'mylist'
+		);
+
+		$list = array(
+			'colors'  => array(
+				'red',
+				'blue',
+				'green'
+			),
+			'shapes'  => array(
+				'round',
+				'square',
+				'circles' => array(
+					'ellipse',
+					'oval',
+					'sphere'
+				)
+			),
+			'moods'  => array(
+				'happy',
+				'upset' => array(
+					'defeated' => array(
+						'dejected',
+						'disheartened',
+						'depressed'
+					),
+					'annoyed',
+					'cross',
+					'angry'
+				)
 			)
-		)
-	);
-
-	echo ul($list, $attributes);
-
-The above code will produce this::
-
-	<ul class="boldlist" id="mylist">
-		<li>colors
-			<ul>
-				<li>red</li>
-				<li>blue</li>
-				<li>green</li>
-			</ul>
-		</li>
-		<li>shapes
-			<ul>
-				<li>round</li>
-				<li>suare</li>
-				<li>circles
-					<ul>
-						<li>elipse</li>
-						<li>oval</li>
-						<li>sphere</li>
-					</ul>
-				</li>
-			</ul>
-		</li>
-		<li>moods
-			<ul>
-				<li>happy</li>
-				<li>upset
-					<ul>
-						<li>defeated
-							<ul>
-								<li>dejected</li>
-								<li>disheartened</li>
-								<li>depressed</li>
-							</ul>
-						</li>
-						<li>annoyed</li>
-						<li>cross</li>
-						<li>angry</li>
-					</ul>
-				</li>
-			</ul>
-		</li>
-	</ul>
+		);
+
+		echo ul($list, $attributes);
+
+	The above code will produce this:
+
+	.. code-block:: html
+
+		<ul class="boldlist" id="mylist">
+			<li>colors
+				<ul>
+					<li>red</li>
+					<li>blue</li>
+					<li>green</li>
+				</ul>
+			</li>
+			<li>shapes
+				<ul>
+					<li>round</li>
+					<li>suare</li>
+					<li>circles
+						<ul>
+							<li>elipse</li>
+							<li>oval</li>
+							<li>sphere</li>
+						</ul>
+					</li>
+				</ul>
+			</li>
+			<li>moods
+				<ul>
+					<li>happy</li>
+					<li>upset
+						<ul>
+							<li>defeated
+								<ul>
+									<li>dejected</li>
+									<li>disheartened</li>
+									<li>depressed</li>
+								</ul>
+							</li>
+							<li>annoyed</li>
+							<li>cross</li>
+							<li>angry</li>
+						</ul>
+					</li>
+				</ul>
+			</li>
+		</ul>
 
 .. function:: ol($list, $attributes = '')
 
@@ -286,13 +293,11 @@ The above code will produce this::
 	:param	array	$attributes: HTML attributes
 	:returns:	string
 
-Identical to :func:`ul()`, only it produces the <ol> tag for
-ordered lists instead of <ul>.
+	Identical to :func:`ul()`, only it produces the <ol> tag for
+	ordered lists instead of <ul>.
 
-meta()
-======
 
-.. function:: meta($name = '', $content = '', $type = 'name', $newline = "\n")
+.. function:: meta([$name = ''[, $content = ''[, $type = 'name'[, $newline = "\n"]]]])
 
 	:param	string	$name: Meta name
 	:param	string	$content: Meta content
@@ -300,109 +305,107 @@ meta()
 	:param	string	$newline: Newline character
 	:returns:	string
 
-Helps you generate meta tags. You can pass strings to the function, or
-simple arrays, or multidimensional ones.
-
-Examples::
-
-	echo meta('description', 'My Great site');
-	// Generates:  <meta name="description" content="My Great Site" />
-
-	echo meta('Content-type', 'text/html; charset=utf-8', 'equiv');
-	// Note the third parameter.  Can be "equiv" or "name"
-	// Generates:  <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
-
-	echo meta(array('name' => 'robots', 'content' => 'no-cache'));
-	// Generates:  <meta name="robots" content="no-cache" />
-
-	$meta = array(
-		array(
-			'name' => 'robots',
-			'content' => 'no-cache'
-		),
-		array(
-			'name' => 'description',
-			'content' => 'My Great Site'
-		),
-		array(
-			'name' => 'keywords',
-			'content' => 'love, passion, intrigue, deception'
-		),
-		array(
-			'name' => 'robots',
-			'content' => 'no-cache'
-		),
-		array(
-			'name' => 'Content-type',
-			'content' => 'text/html; charset=utf-8', 'type' => 'equiv'
-		)
-	);
-
-	echo meta($meta);
-	// Generates:
-	// <meta name="robots" content="no-cache" />
-	// <meta name="description" content="My Great Site" />
-	// <meta name="keywords" content="love, passion, intrigue, deception" />
-	// <meta name="robots" content="no-cache" />
-	// <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
-
-doctype()
-=========
-
-.. function:: doctype($type = 'xhtml1-strict')
+	Helps you generate meta tags. You can pass strings to the function, or
+	simple arrays, or multidimensional ones.
+
+	Examples::
+
+		echo meta('description', 'My Great site');
+		// Generates:  <meta name="description" content="My Great Site" />
+
+		echo meta('Content-type', 'text/html; charset=utf-8', 'equiv');
+		// Note the third parameter.  Can be "equiv" or "name"
+		// Generates:  <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
+
+		echo meta(array('name' => 'robots', 'content' => 'no-cache'));
+		// Generates:  <meta name="robots" content="no-cache" />
+
+		$meta = array(
+			array(
+				'name' => 'robots',
+				'content' => 'no-cache'
+			),
+			array(
+				'name' => 'description',
+				'content' => 'My Great Site'
+			),
+			array(
+				'name' => 'keywords',
+				'content' => 'love, passion, intrigue, deception'
+			),
+			array(
+				'name' => 'robots',
+				'content' => 'no-cache'
+			),
+			array(
+				'name' => 'Content-type',
+				'content' => 'text/html; charset=utf-8', 'type' => 'equiv'
+			)
+		);
+
+		echo meta($meta);
+		// Generates:
+		// <meta name="robots" content="no-cache" />
+		// <meta name="description" content="My Great Site" />
+		// <meta name="keywords" content="love, passion, intrigue, deception" />
+		// <meta name="robots" content="no-cache" />
+		// <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
+
+
+.. function:: doctype([$type = 'xhtml1-strict'])
 
 	:param	string	$type: Doctype name
 
-Helps you generate document type declarations, or DTD's. XHTML 1.0
-Strict is used by default, but many doctypes are available.
-
-Example::
-
-	echo doctype(); // <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-
-	echo doctype('html4-trans'); // <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
-
-The following is a list of doctype choices. These are configurable, and
-pulled from application/config/doctypes.php
-
-+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| Doctype                       | Option                       | Result                                                                                                                                           |
-+===============================+==============================+==================================================================================================================================================+
-| XHTML 1.1                     | doctype('xhtml11')           | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">                                                |
-+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| XHTML 1.0 Strict              | doctype('xhtml1-strict')     | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">                                    |
-+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| XHTML 1.0 Transitional        | doctype('xhtml1-trans')      | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">                        |
-+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| XHTML 1.0 Frameset            | doctype('xhtml1-frame')      | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">                                |
-+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| XHTML Basic 1.1               | doctype('xhtml-basic11')     | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.1//EN" "http://www.w3.org/TR/xhtml-basic/xhtml-basic11.dtd">                                    |
-+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| HTML 5                        | doctype('html5')             | <!DOCTYPE html>                                                                                                                                  |
-+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| HTML 4 Strict                 | doctype('html4-strict')      | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">                                                       |
-+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| HTML 4 Transitional           | doctype('html4-trans')       | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">                                           |
-+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| HTML 4 Frameset               | doctype('html4-frame')       | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">                                            |
-+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| MathML 1.01                   | doctype('mathml1')	       | <!DOCTYPE math SYSTEM "http://www.w3.org/Math/DTD/mathml1/mathml.dtd">                                                                           |
-+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| MathML 2.0                    | doctype('mathml2')           | <!DOCTYPE math PUBLIC "-//W3C//DTD MathML 2.0//EN" "http://www.w3.org/Math/DTD/mathml2/mathml2.dtd">                                             |
-+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| SVG 1.0                       | doctype('svg10')             | <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.0//EN" "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">                                       |
-+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| SVG 1.1 Full                  | doctype('svg11')             | <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">                                               |
-+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| SVG 1.1 Basic                 | doctype('svg11-basic')       | <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1 Basic//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-basic.dtd">                                   |
-+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| SVG 1.1 Tiny                  | doctype('svg11-tiny')        | <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1 Tiny//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-tiny.dtd">                                     |
-+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| XHTML+MathML+SVG (XHTML host) | doctype('xhtml-math-svg-xh') | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd">    |
-+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| XHTML+MathML+SVG (SVG host)   | doctype('xhtml-math-svg-sh') | <!DOCTYPE svg:svg PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd"> |
-+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| XHTML+RDFa 1.0                | doctype('xhtml-rdfa-1')      | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML+RDFa 1.0//EN" "http://www.w3.org/MarkUp/DTD/xhtml-rdfa-1.dtd">                                          |
-+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| XHTML+RDFa 1.1                | doctype('xhtml-rdfa-2')      | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML+RDFa 1.1//EN" "http://www.w3.org/MarkUp/DTD/xhtml-rdfa-2.dtd">                                          |
-+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
\ No newline at end of file
+	Helps you generate document type declarations, or DTD's. XHTML 1.0
+	Strict is used by default, but many doctypes are available.
+
+	Example::
+
+		echo doctype(); // <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+
+		echo doctype('html4-trans'); // <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+
+	The following is a list of doctype choices. These are configurable, and
+	pulled from application/config/doctypes.php
+
+	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
+	| Doctype                       | Option                       | Result                                                                                                                                           |
+	+===============================+==============================+==================================================================================================================================================+
+	| XHTML 1.1                     | doctype('xhtml11')           | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">                                                |
+	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
+	| XHTML 1.0 Strict              | doctype('xhtml1-strict')     | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">                                    |
+	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
+	| XHTML 1.0 Transitional        | doctype('xhtml1-trans')      | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">                        |
+	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
+	| XHTML 1.0 Frameset            | doctype('xhtml1-frame')      | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">                                |
+	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
+	| XHTML Basic 1.1               | doctype('xhtml-basic11')     | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.1//EN" "http://www.w3.org/TR/xhtml-basic/xhtml-basic11.dtd">                                    |
+	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
+	| HTML 5                        | doctype('html5')             | <!DOCTYPE html>                                                                                                                                  |
+	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
+	| HTML 4 Strict                 | doctype('html4-strict')      | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">                                                       |
+	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
+	| HTML 4 Transitional           | doctype('html4-trans')       | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">                                           |
+	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
+	| HTML 4 Frameset               | doctype('html4-frame')       | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">                                            |
+	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
+	| MathML 1.01                   | doctype('mathml1')	       | <!DOCTYPE math SYSTEM "http://www.w3.org/Math/DTD/mathml1/mathml.dtd">                                                                           |
+	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
+	| MathML 2.0                    | doctype('mathml2')           | <!DOCTYPE math PUBLIC "-//W3C//DTD MathML 2.0//EN" "http://www.w3.org/Math/DTD/mathml2/mathml2.dtd">                                             |
+	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
+	| SVG 1.0                       | doctype('svg10')             | <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.0//EN" "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">                                       |
+	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
+	| SVG 1.1 Full                  | doctype('svg11')             | <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">                                               |
+	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
+	| SVG 1.1 Basic                 | doctype('svg11-basic')       | <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1 Basic//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-basic.dtd">                                   |
+	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
+	| SVG 1.1 Tiny                  | doctype('svg11-tiny')        | <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1 Tiny//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-tiny.dtd">                                     |
+	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
+	| XHTML+MathML+SVG (XHTML host) | doctype('xhtml-math-svg-xh') | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd">    |
+	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
+	| XHTML+MathML+SVG (SVG host)   | doctype('xhtml-math-svg-sh') | <!DOCTYPE svg:svg PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd"> |
+	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
+	| XHTML+RDFa 1.0                | doctype('xhtml-rdfa-1')      | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML+RDFa 1.0//EN" "http://www.w3.org/MarkUp/DTD/xhtml-rdfa-1.dtd">                                          |
+	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
+	| XHTML+RDFa 1.1                | doctype('xhtml-rdfa-2')      | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML+RDFa 1.1//EN" "http://www.w3.org/MarkUp/DTD/xhtml-rdfa-2.dtd">                                          |
+	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 220358aed00110bdefdfbcfde40d820a2b684b8b Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Sun, 21 Jul 2013 13:34:09 -0700
Subject: Update Documentation instructions a bit

---
 user_guide_src/source/documentation/index.rst | 79 +++++++++++++++------------
 1 file changed, 43 insertions(+), 36 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/documentation/index.rst b/user_guide_src/source/documentation/index.rst
index e977566d2..43afe6fd3 100644
--- a/user_guide_src/source/documentation/index.rst
+++ b/user_guide_src/source/documentation/index.rst
@@ -8,12 +8,28 @@ Markdown or Textile, you will quickly grasp reStructuredText.  The focus is
 on readability, user friendliness, and an "I've got your hand, baby" feel.
 While they can be quite technical, we always write for humans!
 
-A table of contents should always be included like the one below.
-It is created automatically by inserting the ``.. contents::``
-directive on a line by itself.
+A local table of contents should always be included like the one below.
+It is created automatically by inserting the the following:
 
-.. contents:: Page Contents
+::
 
+	.. contents::
+		:local:
+
+	.. raw:: html
+
+  	<div class="custom-index container"></div>
+
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
+
+The <div> that is inserted as raw HTML is a hook for the documentation's
+JavaScript to dynamically add links to any function and method definitions
+contained in the current page.
 
 **************
 Tools Required
@@ -50,39 +66,39 @@ overlines.  Other headings just use underlines, with the following hierarchy::
 	- for subsubsections
 	^ for subsubsubsections
 	" for subsubsubsubsections (!)
-	
+
 The :download:`TextMate ELDocs Bundle <./ELDocs.tmbundle.zip>` can help you
 create these with the following tab triggers::
 
 	title->
-	
+
 		##########
 		Page Title
 		##########
 
 	sec->
-	
+
 		*************
 		Major Section
 		*************
-		
+
 	sub->
-	
+
 		Subsection
 		==========
-		
+
 	sss->
-	
+
 		SubSubSection
 		-------------
-		
+
 	ssss->
-	
+
 		SubSubSubSection
 		^^^^^^^^^^^^^^^^
-		
+
 	sssss->
-	
+
 		SubSubSubSubSection (!)
 		"""""""""""""""""""""""
 
@@ -99,12 +115,9 @@ ReST:
 
 .. code-block:: rst
 
-	.. php:class:: Some_class
-
-	some_method()
-	=============
+	.. class:: Some_class
 
-		.. php:method:: some_method ( $foo [, $bar [, $bat]])
+		.. method:: some_method ( $foo [, $bar [, $bat]])
 
 			This function will perform some action. The ``$bar`` array must contain
 			a something and something else, and along with ``$bat`` is an optional
@@ -115,7 +128,7 @@ ReST:
 			:param bool $bat: whether or not to do something
 			:returns: FALSE on failure, TRUE if successful
 			:rtype: Boolean
-		
+
 			::
 
 				$this->load->library('some_class');
@@ -131,16 +144,14 @@ ReST:
 				{
 					show_error('An Error Occurred Doing Some Method');
 				}
-		
+
 			.. note:: Here is something that you should be aware of when using some_method().
 					For real.
-					
+
 			See also :php:meth:`Some_class::should_do_something`
 
-	should_do_something()
-	=====================
 
-		.. php:method:: should_do_something()
+		.. method:: should_do_something()
 
 			:returns: whether or something should be done or not
 			:rtype: Boolean
@@ -148,12 +159,10 @@ ReST:
 
 It creates the following display:
 
-.. php:class:: Some_class
+.. class:: Some_class
 
-some_method()
-=============
 
-	.. php:method:: some_method ( $foo [, $bar [, $bat]])
+	.. method:: some_method ( $foo [, $bar [, $bat]])
 
 		This function will perform some action. The ``$bar`` array must contain
 		a something and something else, and along with ``$bat`` is an optional
@@ -164,7 +173,7 @@ some_method()
 		:param bool $bat: whether or not to do something
 		:returns: FALSE on failure, TRUE if successful
 		:rtype: Boolean
-		
+
 		::
 
 			$this->load->library('some_class');
@@ -180,16 +189,14 @@ some_method()
 			{
 				show_error('An Error Occurred Doing Some Method');
 			}
-		
+
 		.. note:: Here is something that you should be aware of when using some_method().
 				For real.
-				
+
 		See also :php:meth:`Some_class::should_do_something`
 
-should_do_something()
-=====================
 
-	.. php:method:: should_do_something()
+	.. method:: should_do_something()
 
 		:returns: whether or something should be done or not
 		:rtype: Boolean
-- 
cgit v1.2.3-24-g4f1b


From da671680202c030a3347ab77f4fe0ead23c8886a Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Sun, 21 Jul 2013 13:34:18 -0700
Subject: Updating Benchmark lib docs

---
 user_guide_src/source/libraries/benchmark.rst | 51 +++++++++++++++++++++++++--
 1 file changed, 48 insertions(+), 3 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/benchmark.rst b/user_guide_src/source/libraries/benchmark.rst
index 5b86142dd..7a0313f43 100644
--- a/user_guide_src/source/libraries/benchmark.rst
+++ b/user_guide_src/source/libraries/benchmark.rst
@@ -13,10 +13,16 @@ invoked, and ended by the output class right before sending the final
 view to the browser, enabling a very accurate timing of the entire
 system execution to be shown.
 
-.. contents:: Table of Contents
+.. contents::
+  :local:
 
+.. raw:: html
+
+  <div class="custom-index container"></div>
+
+*************************
 Using the Benchmark Class
-=========================
+*************************
 
 The Benchmark class can be used within your
 :doc:`controllers </general/controllers>`,
@@ -68,7 +74,7 @@ _end. Each pair of points must otherwise be named identically. Example::
 
 	// Some code happens here...
 
-	$this->benchmark->mark('my_mark_end'); 
+	$this->benchmark->mark('my_mark_end');
 
 	$this->benchmark->mark('another_mark_start');
 
@@ -120,3 +126,42 @@ this pseudo-variable, if you prefer not to use the pure PHP::
 
 	{memory_usage}
 
+
+***************
+Class Reference
+***************
+
+.. class:: CI_Benchmark
+
+	.. method:: mark($name)
+
+		:param string $name: the name you wish to assign to your marker
+		:returns: void
+
+		Sets a benchmark marker.
+
+
+	.. method:: elapsed_time([$point1 = ''[, $point2 = ''[, $decimals = 4]]])
+
+		:param string $point1: a particular marked point
+		:param string $point2: a particular marked point
+		:param int $decimals: number of decimal places for precision
+		:returns: string
+
+		Calculates and returns the time difference between two marked points.
+
+		If the first parameter is empty this function instead returns the
+		``{elapsed_time}`` pseudo-variable. This permits the full system
+		execution time to be shown in a template. The output class will
+		swap the real value for this variable.
+
+
+	.. method:: memory_usage()
+
+		:returns: string
+
+		Simply returns the ``{memory_usage}`` marker.
+
+		This permits it to be put it anywhere in a template without the memory
+		being calculated until the end. The :doc:`Output Class <output>` will
+		swap the real value for this variable.
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From ca51e1a5695bfdf76d8db599ee6c7ba16c328bbc Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Sun, 21 Jul 2013 13:35:02 -0700
Subject: removing php: directive prefix from docs source as it is not
 necessary

---
 user_guide_src/source/libraries/caching.rst        | 56 +++++++++++-----------
 .../source/libraries/form_validation.rst           | 56 +++++++++++-----------
 2 files changed, 56 insertions(+), 56 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/caching.rst b/user_guide_src/source/libraries/caching.rst
index 8d7b4c440..ca4ad4935 100644
--- a/user_guide_src/source/libraries/caching.rst
+++ b/user_guide_src/source/libraries/caching.rst
@@ -20,16 +20,16 @@ available in the hosting environment.
 ::
 
 	$this->load->driver('cache', array('adapter' => 'apc', 'backup' => 'file'));
-	
+
 	if ( ! $foo = $this->cache->get('foo'))
 	{
 		echo 'Saving to the cache!<br />';
 		$foo = 'foobarbaz!';
-		
+
 		// Save into the cache for 5 minutes
 		$this->cache->save('foo', $foo, 300);
 	}
-	
+
 	echo $foo;
 
 You can also prefix cache item names via the **key_prefix** setting, which is useful
@@ -47,24 +47,24 @@ to avoid collisions when you're running multiple applications on the same enviro
 Function Reference
 ******************
 
-.. php:class:: CI_Cache
+.. class:: CI_Cache
 
 is_supported()
 ==============
 
-	.. php:method:: is_supported ( $driver )
+	.. method:: is_supported ( $driver )
 
 		This function is automatically called when accessing drivers via
 		$this->cache->get(). However, if the individual drivers are used, make
 		sure to call this function to ensure the driver is supported in the
 		hosting environment.
-		
+
 		:param string $driver: the name of the caching driver
 		:returns: TRUE if supported, FALSE if not
 		:rtype: Boolean
-		
+
 		::
-				
+
 			if ($this->cache->apc->is_supported()
 			{
 				if ($data = $this->cache->apc->get('my_cache'))
@@ -77,15 +77,15 @@ is_supported()
 get()
 =====
 
-	.. php:method:: get ( $id )
-	
+	.. method:: get ( $id )
+
 		This function will attempt to fetch an item from the cache store. If the
 		item does not exist, the function will return FALSE.
 
 		:param string $id: name of cached item
 		:returns: The item if it exists, FALSE if it does not
 		:rtype: Mixed
-		
+
 		::
 
 			$foo = $this->cache->get('my_cached_item');
@@ -94,8 +94,8 @@ get()
 save()
 ======
 
-	.. php:method:: save ( $id , $data [, $ttl])
-	
+	.. method:: save ( $id , $data [, $ttl])
+
 		This function will save an item to the cache store. If saving fails, the
 		function will return FALSE.
 
@@ -108,19 +108,19 @@ save()
 		::
 
 			$this->cache->save('cache_item_id', 'data_to_cache');
-	
+
 delete()
 ========
 
-	.. php:method:: delete ( $id )
-	
+	.. method:: delete ( $id )
+
 		This function will delete a specific item from the cache store. If item
 		deletion fails, the function will return FALSE.
 
 		:param string $id: name of cached item
 		:returns: TRUE if deleted, FALSE if the deletion fails
 		:rtype: Boolean
-		
+
 		::
 
 			$this->cache->delete('cache_item_id');
@@ -128,14 +128,14 @@ delete()
 clean()
 =======
 
-	.. php:method:: clean ( )
-	
+	.. method:: clean ( )
+
 		This function will 'clean' the entire cache. If the deletion of the
 		cache files fails, the function will return FALSE.
 
 		:returns: TRUE if deleted, FALSE if the deletion fails
 		:rtype: Boolean
-		
+
 		::
 
 			$this->cache->clean();
@@ -143,33 +143,33 @@ clean()
 cache_info()
 ============
 
-	.. php:method:: cache_info ( )
+	.. method:: cache_info ( )
 
 		This function will return information on the entire cache.
 
 		:returns: information on the entire cache
 		:rtype: Mixed
-		
+
 		::
 
 			var_dump($this->cache->cache_info());
-		
+
 		.. note:: The information returned and the structure of the data is dependent
 			on which adapter is being used.
-	
+
 
 get_metadata()
 ==============
 
-	.. php:method:: get_metadata ( $id )
-	
+	.. method:: get_metadata ( $id )
+
 		This function will return detailed information on a specific item in the
 		cache.
-		
+
 		:param string $id: name of cached item
 		:returns: metadadta for the cached item
 		:rtype: Mixed
-		
+
 		::
 
 			var_dump($this->cache->get_metadata('my_cached_item'));
diff --git a/user_guide_src/source/libraries/form_validation.rst b/user_guide_src/source/libraries/form_validation.rst
index 8b35fdc75..5dffb1cd1 100644
--- a/user_guide_src/source/libraries/form_validation.rst
+++ b/user_guide_src/source/libraries/form_validation.rst
@@ -477,8 +477,8 @@ following method::
 Where rule corresponds to the name of a particular rule, and Error
 Message is the text you would like displayed.
 
-If you'd like to include a field's "human" name, or the optional 
-parameter some rules allow for (such as max_length), you can add the 
+If you'd like to include a field's "human" name, or the optional
+parameter some rules allow for (such as max_length), you can add the
 **{field}** and **{param}** tags to your message, respectively::
 
 	$this->form_validation->set_message('min_length', '{field} must have at least {param} characters.');
@@ -860,14 +860,14 @@ use:
 ========================= ========== ============================================================================================= =======================
 Rule                      Parameter  Description                                                                                   Example
 ========================= ========== ============================================================================================= =======================
-**required**              No         Returns FALSE if the form element is empty.                                                                          
-**matches**               Yes        Returns FALSE if the form element does not match the one in the parameter.                    matches[form_item]     
-**differs**               Yes        Returns FALSE if the form element does not differ from the one in the parameter.              differs[form_item]     
-**is_unique**             Yes        Returns FALSE if the form element is not unique to the table and field name in the            is_unique[table.field] 
-                                     parameter. Note: This rule requires :doc:`Query Builder <../database/query_builder>` to be                             
+**required**              No         Returns FALSE if the form element is empty.
+**matches**               Yes        Returns FALSE if the form element does not match the one in the parameter.                    matches[form_item]
+**differs**               Yes        Returns FALSE if the form element does not differ from the one in the parameter.              differs[form_item]
+**is_unique**             Yes        Returns FALSE if the form element is not unique to the table and field name in the            is_unique[table.field]
+                                     parameter. Note: This rule requires :doc:`Query Builder <../database/query_builder>` to be
                                      enabled in order to work.
-**max_length**            Yes        Returns FALSE if the form element is longer then the parameter value.                         max_length[12]         
-**exact_length**          Yes        Returns FALSE if the form element is not exactly the parameter value.                         exact_length[8]        
+**max_length**            Yes        Returns FALSE if the form element is longer then the parameter value.                         max_length[12]
+**exact_length**          Yes        Returns FALSE if the form element is not exactly the parameter value.                         exact_length[8]
 **greater_than**          Yes        Returns FALSE if the form element is less than or equal to the parameter value or not         greater_than[8]
                                      numeric.
 **greater_than_equal_to** Yes        Returns FALSE if the form element is less than the parameter value,                           greater_than_equal_to[8]
@@ -876,15 +876,15 @@ Rule                      Parameter  Description
                                      not numeric.
 **less_than_equal_to**    Yes        Returns FALSE if the form element is greater than the parameter value,                        less_than_equal_to[8]
                                      or not numeric.
-**alpha**                 No         Returns FALSE if the form element contains anything other than alphabetical characters.                              
+**alpha**                 No         Returns FALSE if the form element contains anything other than alphabetical characters.
 **alpha_numeric**         No         Returns FALSE if the form element contains anything other than alpha-numeric characters.
 **alpha_numeric_spaces**  No         Returns FALSE if the form element contains anything other than alpha-numeric characters
-                                     or spaces.  Should be used after trim to avoid spaces at the beginning or end.                             
-**alpha_dash**            No         Returns FALSE if the form element contains anything other than alpha-numeric characters,                             
-                                     underscores or dashes.                                                                                               
-**numeric**               No         Returns FALSE if the form element contains anything other than numeric characters.                                   
-**integer**               No         Returns FALSE if the form element contains anything other than an integer.                                           
-**decimal**               No         Returns FALSE if the form element contains anything other than a decimal number.                                     
+                                     or spaces.  Should be used after trim to avoid spaces at the beginning or end.
+**alpha_dash**            No         Returns FALSE if the form element contains anything other than alpha-numeric characters,
+                                     underscores or dashes.
+**numeric**               No         Returns FALSE if the form element contains anything other than numeric characters.
+**integer**               No         Returns FALSE if the form element contains anything other than an integer.
+**decimal**               No         Returns FALSE if the form element contains anything other than a decimal number.
 **is_natural**            No         Returns FALSE if the form element contains anything other than a natural number:
                                      0, 1, 2, 3, etc.
 **is_natural_no_zero**    No         Returns FALSE if the form element contains anything other than a natural
@@ -933,14 +933,14 @@ Name                 Parameter Description
 Class Reference
 ***************
 
-.. php:class:: Form_validation
+.. class:: Form_validation
 
 The following methods are intended for use in your controller.
 
 $this->form_validation->set_rules()
 ===================================
 
-	.. php:method:: set_rules ($field, $label = '', $rules = '')
+	.. method:: set_rules ($field, $label = '', $rules = '')
 
 		:param string $field: The field name
 		:param string $label: The field label
@@ -955,8 +955,8 @@ $this->form_validation->set_rules()
 
 $this->form_validation->run()
 =============================
-	
-	.. php:method:: run ($group = '')
+
+	.. method:: run ($group = '')
 
 		:param string $group: The name of the validation group to run
 		:rtype: Boolean
@@ -967,8 +967,8 @@ $this->form_validation->run()
 
 $this->form_validation->set_message()
 =====================================
-	
-	.. php:method:: set_message ($lang, $val = '')
+
+	.. method:: set_message ($lang, $val = '')
 
 		:param string $lang: The rule the message is for
 		:param string $val: The message
@@ -978,8 +978,8 @@ $this->form_validation->set_message()
 
 $this->form_validation->set_data()
 ==================================
-	
-	.. php:method:: set_data ($data = '')
+
+	.. method:: set_data ($data = '')
 
 		:param array $data: The data to validate
 
@@ -989,15 +989,15 @@ $this->form_validation->set_data()
 $this->form_validation->reset_validation()
 ==========================================
 
-	.. php:method:: reset_validation ()
+	.. method:: reset_validation ()
 
 		Permits you to reset the validation when you validate more than one array.
 		This method should be called before validating each new array.
 
 $this->form_validation->error_array()
 =====================================
-	
-	.. php:method:: error_array ()
+
+	.. method:: error_array ()
 
 		:rtype: Array
 
@@ -1031,7 +1031,7 @@ Shows all error messages as a string: Example::
 
 	<?php echo validation_errors(); ?>
 
-The error delimiters can be optionally specified. See the 
+The error delimiters can be optionally specified. See the
 :ref:`changing-delimiters` section above.
 
 set_value()
-- 
cgit v1.2.3-24-g4f1b


From 9fe093e1cc359d9f5140cd4f32fd98465e1a207f Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Sun, 21 Jul 2013 13:47:08 -0700
Subject: Update Cache driver docs

---
 user_guide_src/source/libraries/caching.rst | 75 ++++++++++++-----------------
 1 file changed, 31 insertions(+), 44 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/caching.rst b/user_guide_src/source/libraries/caching.rst
index ca4ad4935..0e7de57c9 100644
--- a/user_guide_src/source/libraries/caching.rst
+++ b/user_guide_src/source/libraries/caching.rst
@@ -7,7 +7,12 @@ fast and dynamic caching. All but file-based caching require specific
 server requirements, and a Fatal Exception will be thrown if server
 requirements are not met.
 
-.. contents:: Table of Contents
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
 
 *************
 Example Usage
@@ -43,26 +48,23 @@ to avoid collisions when you're running multiple applications on the same enviro
 
 	$this->cache->get('foo'); // Will get the cache entry named 'my_foo'
 
-******************
-Function Reference
-******************
+***************
+Class Reference
+***************
 
 .. class:: CI_Cache
 
-is_supported()
-==============
-
 	.. method:: is_supported ( $driver )
 
+		:param string $driver: the name of the caching driver
+		:returns: TRUE if supported, FALSE if not
+		:rtype: Boolean
+
 		This function is automatically called when accessing drivers via
 		$this->cache->get(). However, if the individual drivers are used, make
 		sure to call this function to ensure the driver is supported in the
 		hosting environment.
 
-		:param string $driver: the name of the caching driver
-		:returns: TRUE if supported, FALSE if not
-		:rtype: Boolean
-
 		::
 
 			if ($this->cache->apc->is_supported()
@@ -74,30 +76,21 @@ is_supported()
 			}
 
 
-get()
-=====
-
 	.. method:: get ( $id )
 
-		This function will attempt to fetch an item from the cache store. If the
-		item does not exist, the function will return FALSE.
-
 		:param string $id: name of cached item
 		:returns: The item if it exists, FALSE if it does not
 		:rtype: Mixed
 
+		This function will attempt to fetch an item from the cache store. If the
+		item does not exist, the function will return FALSE.
+
 		::
 
 			$foo = $this->cache->get('my_cached_item');
 
 
-save()
-======
-
-	.. method:: save ( $id , $data [, $ttl])
-
-		This function will save an item to the cache store. If saving fails, the
-		function will return FALSE.
+	.. method:: save ( $id , $data [, $ttl = 60])
 
 		:param string $id: name of the cached item
 		:param mixed $data: the data to save
@@ -105,51 +98,48 @@ save()
 		:returns: TRUE on success, FALSE on failure
 		:rtype: Boolean
 
+		This function will save an item to the cache store. If saving fails, the
+		function will return FALSE.
+
 		::
 
 			$this->cache->save('cache_item_id', 'data_to_cache');
 
-delete()
-========
 
 	.. method:: delete ( $id )
 
-		This function will delete a specific item from the cache store. If item
-		deletion fails, the function will return FALSE.
-
 		:param string $id: name of cached item
 		:returns: TRUE if deleted, FALSE if the deletion fails
 		:rtype: Boolean
 
+		This function will delete a specific item from the cache store. If item
+		deletion fails, the function will return FALSE.
+
 		::
 
 			$this->cache->delete('cache_item_id');
 
-clean()
-=======
 
 	.. method:: clean ( )
 
-		This function will 'clean' the entire cache. If the deletion of the
-		cache files fails, the function will return FALSE.
-
 		:returns: TRUE if deleted, FALSE if the deletion fails
 		:rtype: Boolean
 
+		This function will 'clean' the entire cache. If the deletion of the
+		cache files fails, the function will return FALSE.
+
 		::
 
 			$this->cache->clean();
 
-cache_info()
-============
 
 	.. method:: cache_info ( )
 
-		This function will return information on the entire cache.
-
 		:returns: information on the entire cache
 		:rtype: Mixed
 
+		This function will return information on the entire cache.
+
 		::
 
 			var_dump($this->cache->cache_info());
@@ -158,18 +148,15 @@ cache_info()
 			on which adapter is being used.
 
 
-get_metadata()
-==============
-
 	.. method:: get_metadata ( $id )
 
-		This function will return detailed information on a specific item in the
-		cache.
-
 		:param string $id: name of cached item
 		:returns: metadadta for the cached item
 		:rtype: Mixed
 
+		This function will return detailed information on a specific item in the
+		cache.
+
 		::
 
 			var_dump($this->cache->get_metadata('my_cached_item'));
-- 
cgit v1.2.3-24-g4f1b


From 9046f20a2b34c6b27a86ac34da4e20d836f5e091 Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Sun, 21 Jul 2013 13:54:19 -0700
Subject: function to method semantic change in Cache docs

---
 user_guide_src/source/libraries/caching.rst | 30 ++++++++++++++---------------
 1 file changed, 15 insertions(+), 15 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/caching.rst b/user_guide_src/source/libraries/caching.rst
index 0e7de57c9..55fdabca3 100644
--- a/user_guide_src/source/libraries/caching.rst
+++ b/user_guide_src/source/libraries/caching.rst
@@ -60,9 +60,9 @@ Class Reference
 		:returns: TRUE if supported, FALSE if not
 		:rtype: Boolean
 
-		This function is automatically called when accessing drivers via
+		This method is automatically called when accessing drivers via
 		$this->cache->get(). However, if the individual drivers are used, make
-		sure to call this function to ensure the driver is supported in the
+		sure to call this method to ensure the driver is supported in the
 		hosting environment.
 
 		::
@@ -82,8 +82,8 @@ Class Reference
 		:returns: The item if it exists, FALSE if it does not
 		:rtype: Mixed
 
-		This function will attempt to fetch an item from the cache store. If the
-		item does not exist, the function will return FALSE.
+		This method will attempt to fetch an item from the cache store. If the
+		item does not exist, the method will return FALSE.
 
 		::
 
@@ -98,8 +98,8 @@ Class Reference
 		:returns: TRUE on success, FALSE on failure
 		:rtype: Boolean
 
-		This function will save an item to the cache store. If saving fails, the
-		function will return FALSE.
+		This method will save an item to the cache store. If saving fails, the
+		method will return FALSE.
 
 		::
 
@@ -112,8 +112,8 @@ Class Reference
 		:returns: TRUE if deleted, FALSE if the deletion fails
 		:rtype: Boolean
 
-		This function will delete a specific item from the cache store. If item
-		deletion fails, the function will return FALSE.
+		This method will delete a specific item from the cache store. If item
+		deletion fails, the method will return FALSE.
 
 		::
 
@@ -125,8 +125,8 @@ Class Reference
 		:returns: TRUE if deleted, FALSE if the deletion fails
 		:rtype: Boolean
 
-		This function will 'clean' the entire cache. If the deletion of the
-		cache files fails, the function will return FALSE.
+		This method will 'clean' the entire cache. If the deletion of the
+		cache files fails, the method will return FALSE.
 
 		::
 
@@ -138,7 +138,7 @@ Class Reference
 		:returns: information on the entire cache
 		:rtype: Mixed
 
-		This function will return information on the entire cache.
+		This method will return information on the entire cache.
 
 		::
 
@@ -154,7 +154,7 @@ Class Reference
 		:returns: metadadta for the cached item
 		:rtype: Mixed
 
-		This function will return detailed information on a specific item in the
+		This method will return detailed information on a specific item in the
 		cache.
 
 		::
@@ -171,7 +171,7 @@ Drivers
 Alternative PHP Cache (APC) Caching
 ===================================
 
-All of the functions listed above can be accessed without passing a
+All of the methods listed above can be accessed without passing a
 specific adapter to the driver loader as follows::
 
 	$this->load->driver('cache');
@@ -188,7 +188,7 @@ allows for pieces of view files to be cached. Use this with care, and
 make sure to benchmark your application, as a point can come where disk
 I/O will negate positive gains by caching.
 
-All of the functions listed above can be accessed without passing a
+All of the methods listed above can be accessed without passing a
 specific adapter to the driver loader as follows::
 
 	$this->load->driver('cache');
@@ -214,7 +214,7 @@ WinCache Caching
 
 Under Windows, you can also utilize the WinCache driver.
 
-All of the functions listed above can be accessed without passing a
+All of the methods listed above can be accessed without passing a
 specific adapter to the driver loader as follows::
 
 	$this->load->driver('cache');
-- 
cgit v1.2.3-24-g4f1b


From a756125436884dd622fdeff67084f3a62fc71b98 Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Sun, 21 Jul 2013 14:21:41 -0700
Subject: Updating Calendar lib docs

---
 user_guide_src/source/libraries/calendar.rst | 108 ++++++++++++++++++++++++++-
 1 file changed, 105 insertions(+), 3 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/calendar.rst b/user_guide_src/source/libraries/calendar.rst
index 3964db25e..d9a336d08 100644
--- a/user_guide_src/source/libraries/calendar.rst
+++ b/user_guide_src/source/libraries/calendar.rst
@@ -7,6 +7,17 @@ calendars can be formatted through the use of a calendar template,
 allowing 100% control over every aspect of its design. In addition, you
 can pass data to your calendar cells.
 
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
+
+***************************
+Using the Calendaring Class
+***************************
+
 Initializing the Class
 ======================
 
@@ -87,7 +98,7 @@ month heading, and the "short" day names. More information regarding
 preferences below.
 
 ======================  ===========  ===============================================  ===================================================================
-Preference              Default		Options						Description                                                    
+Preference              Default		Options						Description
 ======================  ===========  ===============================================  ===================================================================
 **template**           	None		None                                         	A string containing your calendar template.
 											See the template section below.
@@ -95,7 +106,7 @@ Preference              Default		Options						Description
 **start_day**         	sunday		Any week day (sunday, monday, tuesday, etc.) 	Sets the day of the week the calendar should start on.
 **month_type**        	long          	long, short                                   	Determines what version of the month name to use in the header.
 											long = January, short = Jan.
-**day_type**		abr		long, short, abr 				Determines what version of the weekday names to use in 
+**day_type**		abr		long, short, abr 				Determines what version of the weekday names to use in
 											the column headers. long = Sunday, short = Sun, abr = Su.
 **show_next_prev**	FALSE		TRUE/FALSE (boolean)				Determines whether to display links allowing you to toggle
 											to next/previous months. See information on this feature below.
@@ -171,4 +182,95 @@ pair of pseudo-variables as shown here::
 
 	$this->load->library('calendar', $prefs);
 
-	echo $this->calendar->generate();
\ No newline at end of file
+	echo $this->calendar->generate();
+
+***************
+Class Reference
+***************
+
+.. class:: CI_Calendar
+
+	.. method:: initialize([$config = array()])
+
+		:param array $config: config preferences
+		:returns: void
+
+		Initializes the Calendaring preferences. Accepts an associative array as input, containing display preferences.
+
+
+	.. method:: generate([$year = ''[, $month = ''[, $data = array()]]])
+
+		:param int $year: the year
+		:param int $month: the month
+		:param array $data: the data to be shown in the calendar cells
+		:returns: string
+
+		Generate the calendar.
+
+
+	.. method:: get_month_name($month)
+
+		:param int $month: the numeric month
+		:returns: string
+
+		Generates a textual month name based on the numeric month provided.
+
+
+	.. method:: get_day_names($day_type = '')
+
+		:param string $day_type: one of 'long', 'short', or 'abr'
+		:returns: array
+
+		Returns an array of day names (Sunday, Monday, etc.) based on the type
+		provided. Options: long, short, abr. If no ``$day_type`` is provided (or
+		if an invalid type is provided) this method will return the "abbreviated"
+		style.
+
+
+	.. method:: adjust_date($month, $year)
+
+		:param int $month: the month
+		:param int $year: the year
+		:returns: array
+
+		This method makes usre that you have a valid month/year. For example, if
+		you submit 13 as the month, the year will increment and the month will
+		become January::
+
+			print_r($this->calendar->adjust_date(13, 2013));
+
+		outputs::
+
+			Array
+			(    
+				[month] => '01'
+				[year] => '2014'
+			)
+
+
+	.. method:: get_total_days($month, $year)
+
+		:param int $month: the month
+		:param int $year: the year
+		:returns: int
+
+		Total days in a given month::
+
+			echo $this->calendar->get_total_days(2, 2012);
+			// 29
+
+
+	.. method:: default_template()
+
+		:returns: array
+
+		Sets the default template. This method is used when you have not created
+		your own template.
+
+
+	.. method:: parse_template()
+
+		:returns: void
+
+		Harvests the data within the template ``{pseudo-variables}`` used to
+		display the calendar.
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 82b34e6c10fa80e1b3a0d03c41d084e5ff121403 Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Sun, 21 Jul 2013 23:07:20 -0700
Subject: Update Cart lib docs

---
 user_guide_src/source/libraries/cart.rst | 152 +++++++++++++++++++++----------
 1 file changed, 105 insertions(+), 47 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/cart.rst b/user_guide_src/source/libraries/cart.rst
index 716e94bcb..ad1955d27 100644
--- a/user_guide_src/source/libraries/cart.rst
+++ b/user_guide_src/source/libraries/cart.rst
@@ -11,7 +11,16 @@ Please note that the Cart Class ONLY provides the core "cart"
 functionality. It does not provide shipping, credit card authorization,
 or other processing components.
 
-.. contents:: Page Contents
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
+
+********************
+Using the Cart Class
+********************
 
 Initializing the Shopping Cart Class
 ====================================
@@ -29,7 +38,7 @@ use the $this->load->library function::
 	$this->load->library('cart');
 
 Once loaded, the Cart object will be available using::
- 	
+
 	$this->cart
 
 .. note:: The Cart Class will load and initialize the Session Class
@@ -179,7 +188,7 @@ helper </helpers/form_helper>`.
 	</table>
 
 	<p><?php echo form_submit('', 'Update your Cart'); ?></p>
-	
+
 Updating The Cart
 =================
 
@@ -197,7 +206,7 @@ function:
 	               'qty'   => 3
 	            );
 
-	$this->cart->update($data); 
+	$this->cart->update($data);
 
 	// Or a multi-dimensional array
 
@@ -243,66 +252,115 @@ update form is submitted. Please examine the construction of the "view
 cart" page above for more information.
 
 
-Function Reference
-==================
+***************
+Class Reference
+***************
+
+.. class:: CI_Cart
+
+	.. attribute:: $product_id_rules = '\.a-z0-9_-'
+
+		These are the regular expression rules that we use to validate the product
+		ID - alpha-numeric, dashes, underscores, or periods by default
+
+	.. attribute:: $product_name_rules	= '\w \-\.\:'
+
+		These are the regular expression rules that we use to validate the product ID and product name - alpha-numeric, dashes, underscores, colons or periods by
+		default
+
+	.. attribute:: $product_name_safe = TRUE
+
+		Whether or not to only allow safe product names. Default TRUE.
+
+
+	.. method:: insert([$items = array()])
+
+		:param array $items: the items to insert into the cart
+		:returns: bool
+
+		Insert items into the cart and save it to the session table. Returns TRUE
+		on success and FALSE on failure.
+
+
+	.. method:: update([$items = array()])
+
+		:param array $items: the items to update in the cart
+		:returns: bool
+
+		This method permits the quantity of a given item to be changed.
+		Typically it is called from the "view cart" page if a user makes changes
+		to the quantity before checkout. That array must contain the product ID
+		and quantity for each item.
+
+
+	.. method:: remove($rowid)
+
+		:param int $rowid: the ID of the item to remove from the cart
+		:returns: bool
+
+		Allows you to remove an item from the shopping cart by passing it the
+		``$rowid``.
+
+
+	.. method:: total()
+
+		:returns: int
+
+		Displays the total amount in the cart.
+
+
+	.. method:: total_items()
+
+		:returns: int
+
+		Displays the total number of items in the cart.
 
-$this->cart->insert();
-**********************
 
-Permits you to add items to the shopping cart, as outlined above.
+	.. method:: contents([$newest_first = FALSE])
 
-$this->cart->update();
-**********************
+		:param bool $newest_first: order the array with newest first?
+		:returns: array
 
-Permits you to update items in the shopping cart, as outlined above.
+		Returns an array containing everything in the cart. You can sort the
+		order by which the array is returned by passing it TRUE where the contents
+		will be sorted from newest to oldest, otherwise it is sorted from oldest
+		to newest.
 
-$this->cart->remove(rowid);
-***************************
 
-Allows you to remove an item from the shopping cart by passing it the rowid.
+	.. method:: get_item($row_id)
 
-$this->cart->total();
-*********************
+		:param int $row_id: the row ID to retrieve
+		:returns: array
 
-Displays the total amount in the cart.
+		Returns an array containing data for the item matching the specified row
+		ID, or FALSE if no such item exists.
 
-$this->cart->total_items();
-***************************
 
-Displays the total number of items in the cart.
+	.. method:: has_options($row_id = '')
 
-$this->cart->contents(boolean);
-*******************************
+		:param int $row_id: the row ID to inspect
+		:returns: bool
 
-Returns an array containing everything in the cart. You can sort the order,
-by which this is returned by passing it "true" where the contents will be sorted
-from newest to oldest, by leaving this function blank, you'll automatically just get
-first added to the basket to last added to the basket.
+		Returns TRUE (boolean) if a particular row in the cart contains options.
+		This method is designed to be used in a loop with :meth:contents:, since
+		you must pass the rowid to this function, as shown in the Displaying
+		the Cart example above.
 
-$this->cart->get_item($row_id);
-*******************************
 
-Returns an array containing data for the item matching the specified row ID,
-or FALSE if no such item exists.
+	.. method:: product_options([$row_id = ''])
 
-$this->cart->has_options($row_id);
-**********************************
+		:param int $row_id: the row ID
+		:returns: array
 
-Returns TRUE (boolean) if a particular row in the cart contains options.
-This function is designed to be used in a loop with
-$this->cart->contents(), since you must pass the rowid to this function,
-as shown in the Displaying the Cart example above.
+		Returns an array of options for a particular product. This method is
+		designed to be used in a loop with :meth:contents:, since you
+		must pass the rowid to this method, as shown in the Displaying the
+		Cart example above.
 
-$this->cart->product_options($row_id);
-**************************************
 
-Returns an array of options for a particular product. This function is
-designed to be used in a loop with $this->cart->contents(), since you
-must pass the rowid to this function, as shown in the Displaying the
-Cart example above.
+	.. method:: destroy()
 
-$this->cart->destroy();
-***********************
+		:returns: void
 
-Permits you to destroy the cart. This function will likely be called
-when you are finished processing the customer's order.
+		Permits you to destroy the cart. This method will likely be called
+		when you are finished processing the customer's order.
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 912ee4c5ca099162b5accc153f1bb6f2cb9b5fa1 Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Sun, 21 Jul 2013 23:52:27 -0700
Subject: Update Config lib docs

---
 user_guide_src/source/libraries/config.rst | 102 ++++++++++++++++++++++++-----
 1 file changed, 85 insertions(+), 17 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/config.rst b/user_guide_src/source/libraries/config.rst
index 08d9c2905..54aa70b2d 100644
--- a/user_guide_src/source/libraries/config.rst
+++ b/user_guide_src/source/libraries/config.rst
@@ -9,7 +9,16 @@ These preferences can come from the default config file
 .. note:: This class is initialized automatically by the system so there
 	is no need to do it manually.
 
-.. contents:: Page Contents
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
+
+*****************************
+Working with the Config Class
+*****************************
 
 Anatomy of a Config File
 ========================
@@ -157,27 +166,86 @@ folders:
 	that you wish to change for your environment. The config items declared in your environment
 	folders always overwrite those in your global config files.
 
-Helper Functions
-================
 
-The config class has the following helper functions:
+***************
+Class Reference
+***************
 
-$this->config->site_url();
-***************************
+.. class:: CI_Config
 
-This function retrieves the URL to your site, along with the "index"
-value you've specified in the config file.
+	.. attribute:: $config
 
-$this->config->base_url();
-***************************
+		Array of all loaded config values
 
-This function retrieves the URL to your site, plus an optional path such
-as to a stylesheet or image.
+	.. attribute:: $is_loaded
 
-The two functions above are normally accessed via the corresponding
-functions in the :doc:`URL Helper </helpers/url_helper>`.
+		Array of all loaded config files
 
-$this->config->system_url();
-*****************************
 
-This function retrieves the URL to your system folder.
+	.. method:: item($item[, $index=''])
+
+		:param string $item: config item name
+		:param string $index: index name, if the item is an element in a config
+			item that is itself an array.
+		:returns: mixed - the config item or FALSE if it does not exist
+
+		Fetch a config file item.
+
+
+	.. method:: set_item($item, $value)
+
+		:param string $item: config item name
+		:param string $value: config item value
+		:returns: void
+
+		Sets a config file item to the specified value.
+
+
+	.. method:: slash_item($item)
+
+		:param string $item: config item name
+		:returns: moxied - the config item (slashed) or FALSE if it does not exist
+
+		This method is identical to :meth:item:, except it appends a forward
+		slash to the end of the item, if it exists.
+
+
+	.. method:: load([$file = ''[, $use_sections = FALSE[, $fail_gracefully = FALSE]]])
+
+		:param string $file: Configuration file name
+		:param bool $use_sections: Whether config values shoud be loaded into
+			their own section (index of the main config array)
+		:param bool $fail_gracefully: Whether to return FALSE or to display an
+			error message
+		:returns: bool
+
+		Loads a configuration file.
+
+
+	.. method:: site_url()
+
+		:returns: string
+
+		This method retrieves the URL to your site, along with the "index" value
+		you've specified in the config file.
+
+		This method is normally accessed via the corresponding functions in the
+		:doc:`URL Helper </helpers/url_helper>`.
+
+
+	.. method:: base_url()
+
+		:returns: string
+
+		This method retrieves the URL to your site, plus an optional path such
+		as to a stylesheet or image.
+
+		This method is normally accessed via the corresponding functions in the
+		:doc:`URL Helper </helpers/url_helper>`.
+
+
+	.. method:: system_url()
+
+		:returns: string
+
+		This method retrieves the URL to your system folder.
-- 
cgit v1.2.3-24-g4f1b


From d386f25b4288bbe706c662ec169627d9e91ed31f Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Wed, 24 Jul 2013 17:35:45 -0700
Subject: Update Email lib docs

---
 user_guide_src/source/libraries/email.rst | 346 ++++++++++++++++++------------
 1 file changed, 206 insertions(+), 140 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/email.rst b/user_guide_src/source/libraries/email.rst
index 39629ece1..1d9d2c171 100644
--- a/user_guide_src/source/libraries/email.rst
+++ b/user_guide_src/source/libraries/email.rst
@@ -16,6 +16,17 @@ CodeIgniter's robust Email Class supports the following features:
    BCC batches.
 -  Email Debugging tools
 
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
+
+***********************
+Using the Email Library
+***********************
+
 Sending Email
 =============
 
@@ -31,12 +42,12 @@ This example assumes you are sending the email from one of your
 	$this->load->library('email');
 
 	$this->email->from('your@example.com', 'Your Name');
-	$this->email->to('someone@example.com'); 
-	$this->email->cc('another@another-example.com'); 
-	$this->email->bcc('them@their-example.com'); 
+	$this->email->to('someone@example.com');
+	$this->email->cc('another@another-example.com');
+	$this->email->bcc('them@their-example.com');
 
 	$this->email->subject('Email Test');
-	$this->email->message('Testing the email class.');	
+	$this->email->message('Testing the email class.');
 
 	$this->email->send();
 
@@ -83,7 +94,7 @@ Preference          Default Value          Options                      Descript
 =================== ====================== ============================ =======================================================================
 **useragent**       CodeIgniter            None                         The "user agent".
 **protocol**        mail                   mail, sendmail, or smtp      The mail sending protocol.
-**mailpath**        /usr/sbin/sendmail     None                         The server path to Sendmail. 
+**mailpath**        /usr/sbin/sendmail     None                         The server path to Sendmail.
 **smtp_host**       No Default             None                         SMTP Server Address.
 **smtp_user**       No Default             None                         SMTP Username.
 **smtp_pass**       No Default             None                         SMTP Password.
@@ -106,206 +117,261 @@ Preference          Default Value          Options                      Descript
 **dsn**             FALSE                  TRUE or FALSE (boolean)      Enable notify message from server
 =================== ====================== ============================ =======================================================================
 
-Email Methods Reference
-=======================
+Overriding Word Wrapping
+========================
 
-$this->email->from()
---------------------
+If you have word wrapping enabled (recommended to comply with RFC 822)
+and you have a very long link in your email it can get wrapped too,
+causing it to become un-clickable by the person receiving it.
+CodeIgniter lets you manually override word wrapping within part of your
+message like this::
 
-Sets the email address and name of the person sending the email::
+	The text of your email that
+	gets wrapped normally.
 
-	$this->email->from('you@example.com', 'Your Name');
+	{unwrap}http://example.com/a_long_link_that_should_not_be_wrapped.html{/unwrap}
 
-You can also set a Return-Path, to help redirect undelivered mail::
+	More text that will be
+	wrapped normally.
 
-	$this->email->from('you@example.com', 'Your Name', 'returned_emails@example.com');
-	
-.. note:: Return-Path can't be used if you've configured
-	'smtp' as your protocol.
 
-$this->email->reply_to()
-------------------------
+Place the item you do not want word-wrapped between: {unwrap} {/unwrap}
 
-Sets the reply-to address. If the information is not provided the
-information in the "from" method is used. Example::
+***************
+Class Reference
+***************
 
-	$this->email->reply_to('you@example.com', 'Your Name');
+.. class:: CI_Email
 
-$this->email->to()
-------------------
+	.. method:: from($from[, $name = ''[, $return_path = NULL]])
 
-Sets the email address(s) of the recipient(s). Can be a single email, a
-comma-delimited list or an array::
+		:param string $from: "From" email address
+		:param string $name: "From" display name
+		:param string $return_path: optional email address to redirect undelivered email
+		:returns: CI_Email object for method chaining
 
-	$this->email->to('someone@example.com');
+		Sets the email address and name of the person sending the email::
 
-::
+			$this->email->from('you@example.com', 'Your Name');
 
-	$this->email->to('one@example.com, two@example.com, three@example.com');
+		You can also set a Return-Path, to help redirect undelivered mail::
 
-::
+			$this->email->from('you@example.com', 'Your Name', 'returned_emails@example.com');
 
-	$list = array('one@example.com', 'two@example.com', 'three@example.com');
+		.. note:: Return-Path can't be used if you've configured 'smtp' as
+			your protocol.
 
-	$this->email->to($list);
 
-$this->email->cc()
-------------------
+	.. method:: reply_to($replyto[, $name = ''])
 
-Sets the CC email address(s). Just like the "to", can be a single email,
-a comma-delimited list or an array.
+		:param string $replyto: email address for replies
+		:param string $name: display name for reply email address
+		:returns: CI_Email object for method chaining
 
-$this->email->bcc()
--------------------
+		Sets the reply-to address. If the information is not provided the
+		information in the :meth:from method is used. Example::
 
-Sets the BCC email address(s). Just like the "to", can be a single
-email, a comma-delimited list or an array.
+			$this->email->reply_to('you@example.com', 'Your Name');
 
-$this->email->subject()
------------------------
 
-Sets the email subject::
+	.. method:: to($to)
 
-	$this->email->subject('This is my subject');
+		:param mixed $to: comma delimited string or array of email addresses
+		:returns: CI_Email object for method chaining
 
-$this->email->message()
------------------------
+		Sets the email address(s) of the recipient(s). Can be a single email
+		, a comma-delimited list or an array::
 
-Sets the email message body::
+			$this->email->to('someone@example.com');
 
-	$this->email->message('This is my message');
+		::
 
-$this->email->set_alt_message()
--------------------------------
+			$this->email->to('one@example.com, two@example.com, three@example.com');
 
-Sets the alternative email message body::
+		::
 
-	$this->email->set_alt_message('This is the alternative message');
+			$list = array('one@example.com', 'two@example.com', 'three@example.com');
 
-This is an optional message string which can be used if you send HTML
-formatted email. It lets you specify an alternative message with no HTML
-formatting which is added to the header string for people who do not
-accept HTML email. If you do not set your own message CodeIgniter will
-extract the message from your HTML email and strip the tags.
+			$this->email->to($list);
 
-$this->email->set_header()
---------------------------
 
-Appends additional headers to the e-mail::
+	.. method:: cc($cc)
 
-	$this->email->set_header('Header1', 'Value1');
-	$this->email->set_header('Header2', 'Value2');
+		:param mixed $cc: comma delimited string or array of email addresses
+		:returns: CI_Email object for method chaining
 
-$this->email->clear()
----------------------
+		Sets the CC email address(s). Just like the "to", can be a single
+		email, a comma-delimited list or an array.
 
-Initializes all the email variables to an empty state. This method is
-intended for use if you run the email sending method in a loop,
-permitting the data to be reset between cycles.
 
-::
+	.. method:: bcc($bcc, $limit = '')
 
-	foreach ($list as $name => $address)
-	{
-		$this->email->clear();
+		:param mixed $bcc: comma delimited string or array of email addresses
+		:param int $limit: Maximum number of emails to send per batch
+		:returns: CI_Email object for method chaining
 
-		$this->email->to($address);
-		$this->email->from('your@example.com');
-		$this->email->subject('Here is your info '.$name);
-		$this->email->message('Hi '.$name.' Here is the info you requested.');
-		$this->email->send();
-	}
+		Sets the BCC email address(s). Just like the "to", can be a single
+		email, a comma-delimited list or an array.
 
-If you set the parameter to TRUE any attachments will be cleared as
-well::
+		If ``$limit`` is set, "batch mode" will be enabled, which will send
+		the emails to batches, with each batch not exceeding the specified
+		``$limit``.
 
-	$this->email->clear(TRUE);
 
-$this->email->send()
---------------------
+	.. method:: subject($subject)
 
-The Email sending method. Returns boolean TRUE or FALSE based on
-success or failure, enabling it to be used conditionally::
+		:param string $subject: email subject line
+		:returns: CI_Email object for method chaining
 
-	if ( ! $this->email->send())
-	{
-		// Generate error
-	}
+		Sets the email subject::
 
-This method will automatically clear all parameters if the request was
-successful. To stop this behaviour pass FALSE::
+			$this->email->subject('This is my subject');
 
- 	if ($this->email->send(FALSE))
- 	{
- 		// Parameters won't be cleared
- 	}
 
-.. note:: In order to use the ``print_debugger()`` method, you need
-	to avoid clearing the email parameters.
+	.. method:: message($body)
 
-$this->email->attach()
-----------------------
+		:param string $body: email body
+		:returns: CI_Email object for method chaining
 
-Enables you to send an attachment. Put the file path/name in the first
-parameter. Note: Use a file path, not a URL. For multiple attachments
-use the method multiple times. For example::
+		Sets the email message body::
 
-	$this->email->attach('/path/to/photo1.jpg');
-	$this->email->attach('/path/to/photo2.jpg');
-	$this->email->attach('/path/to/photo3.jpg');
+			$this->email->message('This is my message');
 
-To use the default disposition (attachment), leave the second parameter blank,
-otherwise use a custom disposition::
 
-	$this->email->attach('image.jpg', 'inline');
+	.. method:: set_alt_message([$str = ''])
 
-If you'd like to use a custom file name, you can use the third paramater::
+		:param string $str: alternate email body
+		:returns: CI_Email object for method chaining
 
-	$this->email->attach('filename.pdf', 'attachment', 'report.pdf');
+		Sets the alternative email message body::
 
-If you need to use a buffer string instead of a real - physical - file you can
-use the first parameter as buffer, the third parameter as file name and the fourth
-parameter as mime-type::
+			$this->email->set_alt_message('This is the alternative message');
 
-	$this->email->attach($buffer, 'attachment', 'report.pdf', 'application/pdf');
+		This is an optional message string which can be used if you send
+		HTML formatted email. It lets you specify an alternative message
+		with no HTML formatting which is added to the header string for
+		people who do not accept HTML email. If you do not set your own
+		message CodeIgniter will extract the message from your HTML email
+		and strip the tags.
 
-$this->email->print_debugger()
-------------------------------
 
-Returns a string containing any server messages, the email headers, and
-the email messsage. Useful for debugging.
+	.. method:: set_header($header, $value)
 
-You can optionally specify which parts of the message should be printed.
-Valid options are: **headers**, **subject**, **body**.
+		:param string $header: header name
+		:param string $value: header value
+		:returns: void
 
-Example::
+		Appends additional headers to the e-mail::
 
-	// You need to pass FALSE while sending in order for the email data
-	// to not be cleared - if that happens, print_debugger() would have
-	// nothing to output.
-	$this->email->send(FALSE);
+			$this->email->set_header('Header1', 'Value1');
+			$this->email->set_header('Header2', 'Value2');
 
-	// Will only print the email headers, excluding the message subject and body
-	$this->email->print_debugger(array('headers'));
 
-.. note:: By default, all of the raw data will be printed.
+	.. method:: clear([$clear_attachments = FALSE])
 
-Overriding Word Wrapping
-========================
+		:param bool $clear_attachments: whether or not to clear attachments
 
-If you have word wrapping enabled (recommended to comply with RFC 822)
-and you have a very long link in your email it can get wrapped too,
-causing it to become un-clickable by the person receiving it.
-CodeIgniter lets you manually override word wrapping within part of your
-message like this::
+		Initializes all the email variables to an empty state. This method
+		is intended for use if you run the email sending method in a loop,
+		permitting the data to be reset between cycles.
 
-	The text of your email that
-	gets wrapped normally.
+		::
 
-	{unwrap}http://example.com/a_long_link_that_should_not_be_wrapped.html{/unwrap}
+			foreach ($list as $name => $address)
+			{
+				$this->email->clear();
 
-	More text that will be
-	wrapped normally.
-	
+				$this->email->to($address);
+				$this->email->from('your@example.com');
+				$this->email->subject('Here is your info '.$name);
+				$this->email->message('Hi '.$name.' Here is the info you requested.');
+				$this->email->send();
+			}
+
+		If you set the parameter to TRUE any attachments will be cleared as
+		well::
+
+			$this->email->clear(TRUE);
+
+
+	.. method:: send([$auto_clear = TRUE])
+
+		:param bool $auto_clear: Whether to :meth:clear automatically
+		:returns: bool
+
+		The Email sending method. Returns boolean TRUE or FALSE based on
+		success or failure, enabling it to be used conditionally::
+
+			if ( ! $this->email->send())
+			{
+				// Generate error
+			}
+
+		This method will automatically clear all parameters if the request was
+		successful. To stop this behaviour pass FALSE::
+
+		 	if ($this->email->send(FALSE))
+		 	{
+		 		// Parameters won't be cleared
+		 	}
+
+		.. note:: In order to use the ``print_debugger()`` method, you need
+			to avoid clearing the email parameters.
+
+
+	.. method:: attach($filename[, $disposition = ''[, $newname = NULL[, $mime = '']]])
+
+		:param string $filename: name of the file
+		:param string $disposition: 'disposition' of the attachment. Most
+			email clients make their own decision regardless of the MIME
+			specification used here. https://www.iana.org/assignments/cont-disp/cont-disp.xhtml
+		:param string $newname: custom name to use for the file in the email
+		:param string $mime: MIME type to use (useful for buffered data)
+		:returns: CI_Email object for method chaining
+
+		Enables you to send an attachment. Put the file path/name in the first
+		parameter. Note: Use a file path, not a URL. For multiple attachments
+		use the method multiple times. For example::
+
+			$this->email->attach('/path/to/photo1.jpg');
+			$this->email->attach('/path/to/photo2.jpg');
+			$this->email->attach('/path/to/photo3.jpg');
+
+		To use the default disposition (attachment), leave the second parameter blank,
+		otherwise use a custom disposition::
+
+			$this->email->attach('image.jpg', 'inline');
+
+		If you'd like to use a custom file name, you can use the third paramater::
+
+			$this->email->attach('filename.pdf', 'attachment', 'report.pdf');
+
+		If you need to use a buffer string instead of a real - physical - file you can
+		use the first parameter as buffer, the third parameter as file name and the fourth
+		parameter as mime-type::
+
+			$this->email->attach($buffer, 'attachment', 'report.pdf', 'application/pdf');
+
+
+	.. method:: print_debugger([$include = array('headers', 'subject', 'body')])
+
+		:param array $include: Which parts of the message to print out
+		:returns: string
+
+		Returns a string containing any server messages, the email headers, and
+		the email messsage. Useful for debugging.
+
+		You can optionally specify which parts of the message should be printed.
+		Valid options are: **headers**, **subject**, **body**.
+
+		Example::
+
+			// You need to pass FALSE while sending in order for the email data
+			// to not be cleared - if that happens, print_debugger() would have
+			// nothing to output.
+			$this->email->send(FALSE);
+
+			// Will only print the email headers, excluding the message subject and body
+			$this->email->print_debugger(array('headers'));
 
-Place the item you do not want word-wrapped between: {unwrap} {/unwrap}
\ No newline at end of file
+		.. note:: By default, all of the raw data will be printed.
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 5d80d0f215a48ed985e0e4ff9eb50f53f399e9bd Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Wed, 24 Jul 2013 17:44:29 -0700
Subject: Update Encrypt lib docs

---
 user_guide_src/source/libraries/encryption.rst | 176 +++++++++++++++----------
 1 file changed, 105 insertions(+), 71 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/encryption.rst b/user_guide_src/source/libraries/encryption.rst
index a38122203..f7235bfd2 100644
--- a/user_guide_src/source/libraries/encryption.rst
+++ b/user_guide_src/source/libraries/encryption.rst
@@ -10,6 +10,17 @@ reasonable degree of security for encrypted sessions or other such
 "light" purposes. If Mcrypt is available, you'll be provided with a high
 degree of security appropriate for storage.
 
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
+
+****************************
+Using the Encryption Library
+****************************
+
 Setting your Key
 ================
 
@@ -61,104 +72,127 @@ initialized in your controller using the **$this->load->library** function::
 
 	$this->load->library('encrypt');
 
-Once loaded, the Encrypt library object will be available using:
-$this->encrypt
+Once loaded, the Encrypt library object will be available using
+``$this->encrypt``
+
+***************
+Class Reference
+***************
+
+.. class:: CI_Encrypt
+
+	.. method:: encode($string, $key = '')
+
+		:param string $string: contents to be encrypted
+		:param string $key: encryption key
+		:returns: string
+
+		Performs the data encryption and returns it as a string. Example::
+
+			$msg = 'My secret message';
+
+			$encrypted_string = $this->encrypt->encode($msg);
+
+		You can optionally pass your encryption key via the second parameter if
+		you don't want to use the one in your config file::
+
+			$msg = 'My secret message';
+			$key = 'super-secret-key';
+
+			$encrypted_string = $this->encrypt->encode($msg, $key);
+
 
-$this->encrypt->encode()
-========================
+	.. method:: decode($string, $key = '')
 
-Performs the data encryption and returns it as a string. Example::
+		:param string $string: contents to be decrypted
+		:param string $key: encryption key
+		:returns: string
 
-	$msg = 'My secret message';
+		Decrypts an encoded string. Example::
 
-	$encrypted_string = $this->encrypt->encode($msg);
-	
+			$encrypted_string = 'APANtByIGI1BpVXZTJgcsAG8GZl8pdwwa84';
 
-You can optionally pass your encryption key via the second parameter if
-you don't want to use the one in your config file::
+			$plaintext_string = $this->encrypt->decode($encrypted_string);
 
-	$msg = 'My secret message';
-	$key = 'super-secret-key';
+		You can optionally pass your encryption key via the second parameter if
+		you don't want to use the one in your config file::
 
-	$encrypted_string = $this->encrypt->encode($msg, $key);
+			$msg = 'My secret message';
+			$key = 'super-secret-key';
 
-$this->encrypt->decode()
-========================
+			$encrypted_string = $this->encrypt->decode($msg, $key);
 
-Decrypts an encoded string. Example::
 
-	$encrypted_string = 'APANtByIGI1BpVXZTJgcsAG8GZl8pdwwa84';
+	.. method:: set_cipher($cipher)
 
-	$plaintext_string = $this->encrypt->decode($encrypted_string);
+		:param int $cipher: valid PHP Mcrypt cypher constant
+		:returns: CI_Encrypt object for method chaining
 
-You can optionally pass your encryption key via the second parameter if
-you don't want to use the one in your config file::
+		Permits you to set an Mcrypt cipher. By default it uses
+		**MCRYPT_RIJNDAEL_256**. Example::
 
-	$msg = 'My secret message';
-	$key = 'super-secret-key';
+			$this->encrypt->set_cipher(MCRYPT_BLOWFISH);
 
-	$encrypted_string = $this->encrypt->decode($msg, $key);
+		Please visit php.net for a list of `available
+		ciphers <http://php.net/mcrypt>`_.
 
-$this->encrypt->set_cipher();
-==============================
+		If you'd like to manually test whether your server supports Mcrypt you
+		can use::
 
-Permits you to set an Mcrypt cipher. By default it uses
-**MCRYPT_RIJNDAEL_256**. Example::
+			echo ( ! function_exists('mcrypt_encrypt')) ? 'Nope' : 'Yup';
 
-	$this->encrypt->set_cipher(MCRYPT_BLOWFISH);
 
-Please visit php.net for a list of `available
-ciphers <http://php.net/mcrypt>`_.
+	.. method:: set_mode($mode)
 
-If you'd like to manually test whether your server supports Mcrypt you
-can use::
+		:param int $mode: valid PHP Mcrypt mode constant
+		:returns: CI_Encrypt object for method chaining
 
-	echo ( ! function_exists('mcrypt_encrypt')) ? 'Nope' : 'Yup';
+		Permits you to set an Mcrypt mode. By default it uses **MCRYPT_MODE_CBC**.
+		Example::
 
-$this->encrypt->set_mode();
-============================
+			$this->encrypt->set_mode(MCRYPT_MODE_CFB);
 
-Permits you to set an Mcrypt mode. By default it uses **MCRYPT_MODE_CBC**.
-Example::
+		Please visit php.net for a list of `available
+		modes <http://php.net/mcrypt>`_.
 
-	$this->encrypt->set_mode(MCRYPT_MODE_CFB);
 
-Please visit php.net for a list of `available
-modes <http://php.net/mcrypt>`_.
+	.. method:: encode_from_legacy($string[, $legacy_mode = MCRYPT_MODE_ECB[, $key = '']])
 
-$this->encrypt->encode_from_legacy($orig_data, $legacy_mode = MCRYPT_MODE_ECB, $key = '');
-==========================================================================================
+		:param string $string: contents to be encrypted
+		:param int $legacy_mode: valid PHP Mcrypt cypher constant
+		:param string $key: encryption key
+		:returns: string
 
-Enables you to re-encode data that was originally encrypted with
-CodeIgniter 1.x to be compatible with the Encryption library in
-CodeIgniter 2.x. It is only necessary to use this method if you have
-encrypted data stored permanently such as in a file or database and are
-on a server that supports Mcrypt. "Light" use encryption such as
-encrypted session data or transitory encrypted flashdata require no
-intervention on your part. However, existing encrypted Sessions will be
-destroyed since data encrypted prior to 2.x will not be decoded.
+		Enables you to re-encode data that was originally encrypted with
+		CodeIgniter 1.x to be compatible with the Encryption library in
+		CodeIgniter 2.x. It is only necessary to use this method if you have
+		encrypted data stored permanently such as in a file or database and are
+		on a server that supports Mcrypt. "Light" use encryption such as
+		encrypted session data or transitory encrypted flashdata require no
+		intervention on your part. However, existing encrypted Sessions will be
+		destroyed since data encrypted prior to 2.x will not be decoded.
 
-.. important::
-	**Why only a method to re-encode the data instead of maintaining legacy
-	methods for both encoding and decoding?** The algorithms in the
-	Encryption library have improved in CodeIgniter 2.x both for performance
-	and security, and we do not wish to encourage continued use of the older
-	methods. You can of course extend the Encryption library if you wish and
-	replace the new methods with the old and retain seamless compatibility
-	with CodeIgniter 1.x encrypted data, but this a decision that a
-	developer should make cautiously and deliberately, if at all.
+		.. important::
+			**Why only a method to re-encode the data instead of maintaining legacy
+			methods for both encoding and decoding?** The algorithms in the
+			Encryption library have improved in CodeIgniter 2.x both for performance
+			and security, and we do not wish to encourage continued use of the older
+			methods. You can of course extend the Encryption library if you wish and
+			replace the new methods with the old and retain seamless compatibility
+			with CodeIgniter 1.x encrypted data, but this a decision that a
+			developer should make cautiously and deliberately, if at all.
 
-::
+		::
 
-	$new_data = $this->encrypt->encode_from_legacy($old_encrypted_string);
+			$new_data = $this->encrypt->encode_from_legacy($old_encrypted_string);
 
-======================	===============	 =======================================================================
-Parameter		 Default	  Description
-======================	===============  =======================================================================
-**$orig_data**		n/a 		 The original encrypted data from CodeIgniter 1.x's Encryption library
-**$legacy_mode**	MCRYPT_MODE_ECB	 The Mcrypt mode that was used to generate the original encrypted data.
-					 CodeIgniter 1.x's default was MCRYPT_MODE_ECB, and it will assume that
-					 to be the case unless overridden by this parameter.
-**$key**		n/a 		 The encryption key. This it typically specified in your config file as
-					 outlined above.
-======================	===============	 =======================================================================
\ No newline at end of file
+		======================	===============	 =======================================================================
+		Parameter		 Default	  Description
+		======================	===============  =======================================================================
+		**$orig_data**		n/a 		 The original encrypted data from CodeIgniter 1.x's Encryption library
+		**$legacy_mode**	MCRYPT_MODE_ECB	 The Mcrypt mode that was used to generate the original encrypted data.
+							 CodeIgniter 1.x's default was MCRYPT_MODE_ECB, and it will assume that
+							 to be the case unless overridden by this parameter.
+		**$key**		n/a 		 The encryption key. This it typically specified in your config file as
+							 outlined above.
+		======================	===============	 =======================================================================
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From c9bf303220f90b0e71acd54d150fafc87df3df81 Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Wed, 24 Jul 2013 18:01:27 -0700
Subject: Update Upload lib docs

---
 user_guide_src/source/libraries/file_uploading.rst | 165 ++++++++++-----------
 1 file changed, 82 insertions(+), 83 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/file_uploading.rst b/user_guide_src/source/libraries/file_uploading.rst
index a92d3af34..695998d73 100644
--- a/user_guide_src/source/libraries/file_uploading.rst
+++ b/user_guide_src/source/libraries/file_uploading.rst
@@ -5,6 +5,13 @@ File Uploading Class
 CodeIgniter's File Uploading Class permits files to be uploaded. You can
 set various preferences, restricting the type and size of the files.
 
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
+
 ***********
 The Process
 ***********
@@ -240,105 +247,97 @@ preferences in a config file.
 Class Reference
 ***************
 
-The following methods are available:
+.. class:: CI_Upload
 
-$this->upload->do_upload()
-==========================
+	.. method:: do_upload([$field = 'userfile'])
 
-Performs the upload based on the preferences you've set.
+		:param string $field: name of the form field
+		:returns: bool
 
-.. note:: By default the upload routine expects the file to come from
-	a form field called userfile, and the form must be of type
-	"multipart".
+		Performs the upload based on the preferences you've set.
 
-::
+		.. note:: By default the upload routine expects the file to come from
+			a form field called userfile, and the form must be of type
+			"multipart".
 
-	<form method="post" action="some_action" enctype="multipart/form-data" />
+		::
 
-If you would like to set your own field name simply pass its value to
-the ``do_upload()`` method::
+			<form method="post" action="some_action" enctype="multipart/form-data" />
 
-	$field_name = "some_field_name";
-	$this->upload->do_upload($field_name);
+		If you would like to set your own field name simply pass its value to
+		the ``do_upload()`` method::
 
-$this->upload->display_errors()
-===============================
+			$field_name = "some_field_name";
+			$this->upload->do_upload($field_name);
 
-Retrieves any error messages if the ``do_upload()`` method returned
-false. The method does not echo automatically, it returns the data so
-you can assign it however you need.
 
-Formatting Errors
-*****************
+	.. method:: display_errors([$open = '<p>'[, $close = '</p>']])
 
-By default the above method wraps any errors within <p> tags. You can
-set your own delimiters like this::
+		:param string $open: Opening markup
+		:param string $close: Closing markup
+		:returns: string
 
-	$this->upload->display_errors('<p>', '</p>');
+		Retrieves any error messages if the ``do_upload()`` method returned
+		false. The method does not echo automatically, it returns the data so
+		you can assign it however you need.
 
-$this->upload->data()
-=====================
+		**Formatting Errors**
 
-This is a helper method that returns an array containing all of the
-data related to the file you uploaded. Here is the array prototype::
+			By default the above method wraps any errors within <p> tags. You can
+			set your own delimiters like this::
 
-	Array
-	(
-		[file_name]	=> mypic.jpg
-		[file_type]	=> image/jpeg
-		[file_path]	=> /path/to/your/upload/
-		[full_path]	=> /path/to/your/upload/jpg.jpg
-		[raw_name]	=> mypic
-		[orig_name]	=> mypic.jpg
-		[client_name]	=> mypic.jpg
-		[file_ext]	=> .jpg
-		[file_size]	=> 22.2
-		[is_image]	=> 1
-		[image_width]	=> 800
-		[image_height]	=> 600
-		[image_type]	=> jpeg
-		[image_size_str] => width="800" height="200"
-	)
+				$this->upload->display_errors('<p>', '</p>');
 
-To return one element from the array::
 
-	$this->upload->data('file_name');	// Returns: mypic.jpg
+	.. method:: data([$index = NULL])
 
-Explanation
-***********
+		:param string $data: element to return instead of the full array
+		:returns: mixed
+
+		This is a helper method that returns an array containing all of the
+		data related to the file you uploaded. Here is the array prototype::
+
+			Array
+			(
+				[file_name]	=> mypic.jpg
+				[file_type]	=> image/jpeg
+				[file_path]	=> /path/to/your/upload/
+				[full_path]	=> /path/to/your/upload/jpg.jpg
+				[raw_name]	=> mypic
+				[orig_name]	=> mypic.jpg
+				[client_name]	=> mypic.jpg
+				[file_ext]	=> .jpg
+				[file_size]	=> 22.2
+				[is_image]	=> 1
+				[image_width]	=> 800
+				[image_height]	=> 600
+				[image_type]	=> jpeg
+				[image_size_str] => width="800" height="200"
+			)
+
+		To return one element from the array::
+
+			$this->upload->data('file_name');	// Returns: mypic.jpg
+
+		**Explanation**
+
+			Here is an explanation of the above array items.
 
-Here is an explanation of the above array items.
-
-Item
-Description
-**file_name**
-The name of the file that was uploaded including the file extension.
-**file_type**
-The file's Mime type
-**file_path**
-The absolute server path to the file
-**full_path**
-The absolute server path including the file name
-**raw_name**
-The file name without the extension
-**orig_name**
-The original file name. This is only useful if you use the encrypted
-name option.
-**client_name**
-The file name as supplied by the client user agent, prior to any file
-name preparation or incrementing.
-**file_ext**
-The file extension with period
-**file_size**
-The file size in kilobytes
-**is_image**
-Whether the file is an image or not. 1 = image. 0 = not.
-**image_width**
-Image width.
-**image_height**
-Image height
-**image_type**
-Image type. Typically the file extension without the period.
-**image_size_str**
-A string containing the width and height. Useful to put into an image
-tag.
\ No newline at end of file
+			================	================================================
+			Item							Description
+			================	================================================
+			file_name					The name of the file that was uploaded including the file extension.
+			file_type					The file's Mime type
+			file_path					The absolute server path to the file
+			full_path					The absolute server path including the file name
+			raw_name					The file name without the extension
+			orig_name					The original file name. This is only useful if you use the encrypted name option.
+			client_name				The file name as supplied by the client user agent, prior to any file name preparation or incrementing.
+			file_ext					The file extension with period
+			file_size					The file size in kilobytes
+			is_image					Whether the file is an image or not. 1 = image. 0 = not.
+			image_width				Image width.
+			image_height			Image height
+			image_type				Image type. Typically the file extension without the period.
+			image_size_str		A string containing the width and height. Useful to put into an image tag.
+			================	================================================
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 2efd1f25ce59b917fdd8eebf1bd959f4eca7d904 Mon Sep 17 00:00:00 2001
From: vlakoff <vlakoff@gmail.com>
Date: Tue, 6 Aug 2013 17:31:48 +0200
Subject: Fix various typos

---
 user_guide_src/source/changelog.rst                | 10 +++++-----
 user_guide_src/source/helpers/smiley_helper.rst    |  6 +++---
 user_guide_src/source/installation/upgrade_300.rst |  2 +-
 3 files changed, 9 insertions(+), 9 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 79f120754..44c6f16c5 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -74,7 +74,7 @@ Release Date: Not Released
       - :func:`anchor_popup()` will now fill the *href* attribute with the URL and its JS code will return FALSE instead.
       - Added JS window name support to the :func:`anchor_popup()` function.
       - Added support (auto-detection) for HTTP/1.1 response code 303 in :func:`redirect()`.
-      - Changed :func:`redirect()` to only choose the **refresh** method only on IIS servers, instead of all servers on Windows (when **auto** is used).
+      - Changed :func:`redirect()` to choose the **refresh** method only on IIS servers, instead of all servers on Windows (when **auto** is used).
       - Changed :func:`anchor()`, :func:`anchor_popup()`, and :func:`redirect()` to support protocol-relative URLs (e.g. *//ellislab.com/codeigniter*).
       - Added an optional second parameter to both :func:`base_url()` and :func:`site_url()` that allows enforcing of a protocol different than the one in the *base_url* configuration setting.
 
@@ -403,7 +403,7 @@ Release Date: Not Released
    -  :doc:`Config Library <libraries/config>` changes include:
 
       -  Changed ``site_url()`` method  to accept an array as well.
-      -  Removed internal method ``_assign_to_config()`` and moved it's implementation in *CodeIgniter.php* instead.
+      -  Removed internal method ``_assign_to_config()`` and moved its implementation in *CodeIgniter.php* instead.
 
    -  :doc:`Security Library <libraries/security>` changes include:
 
@@ -508,7 +508,7 @@ Bug fixes for 3.0
 -  Fixed a bug (#784, #861) - :doc:`Database Forge <database/forge>` method ``create_table()`` used to accept constraints for MSSQL/SQLSRV integer-type columns.
 -  Fixed a bug (#706) - SQLSRV/MSSSQL didn't escape field names.
 -  Fixed a bug (#1452) - ``protect_identifiers()`` didn't properly detect identifiers with spaces in their names.
--  Fixed a bug where ``protect_identifiers()`` ignored it's extra arguments when the value passed to it is an array.
+-  Fixed a bug where ``protect_identifiers()`` ignored its extra arguments when the value passed to it is an array.
 -  Fixed a bug where ``_has_operator()`` didn't detect BETWEEN.
 -  Fixed a bug in :doc:`Query Builder <database/query_builder>`'s ``join()`` method where it failed with identifiers containing dashes.
 -  Fixed a bug (#1264) - :doc:`Database Forge <database/forge>` and :doc:`Database Utilities <database/utilities>` didn't update/reset the databases and tables list cache when a table or a database is created, dropped or renamed.
@@ -548,7 +548,7 @@ Bug fixes for 3.0
 -  Fixed a bug where the :doc:`Session Library <libraries/sessions>` accepted cookies with *last_activity* values being in the future.
 -  Fixed a bug (#1897) - :doc:`Email Library <libraries/email>` triggered PHP E_WARNING errors when *mail* protocol used and ``to()`` is never called.
 -  Fixed a bug (#1409) - :doc:`Email Library <libraries/email>` didn't properly handle multibyte characters when applying Q-encoding to headers.
--  Fixed a bug where :doc:`Email Library <libraries/email>` didn't honor it's *wordwrap* setting while handling alternative messages.
+-  Fixed a bug where :doc:`Email Library <libraries/email>` didn't honor its *wordwrap* setting while handling alternative messages.
 -  Fixed a bug (#1476, #1909) - :doc:`Pagination Library <libraries/pagination>` didn't take into account actual routing when determining the current page.
 -  Fixed a bug (#1766) - :doc:`Query Builder <database/query_builder>` didn't always take into account the *dbprefix* setting.
 -  Fixed a bug (#779) - :doc:`URI Class <libraries/uri>` didn't always trim slashes from the *uri_string* as shown in the documentation.
@@ -674,7 +674,7 @@ Bug fixes for 2.1.1
 -  Fixed a bug (#538) - Windows paths were ignored when using the :doc:`Image Manipulation Library <libraries/image_lib>` to create a new file.
 -  Fixed a bug - When database caching was enabled, $this->db->query() checked the cache before binding variables which resulted in cached queries never being found.
 -  Fixed a bug - CSRF cookie value was allowed to be any (non-empty) string before being written to the output, making code injection a risk.
--  Fixed a bug (#726) - PDO put a 'dbname' argument in it's connection string regardless of the database platform in use, which made it impossible to use SQLite.
+-  Fixed a bug (#726) - PDO put a 'dbname' argument in its connection string regardless of the database platform in use, which made it impossible to use SQLite.
 -  Fixed a bug - ``CI_DB_pdo_driver::num_rows()`` was not returning properly value with SELECT queries, cause it was relying on ``PDOStatement::rowCount()``.
 -  Fixed a bug (#1059) - ``CI_Image_lib::clear()`` was not correctly clearing all necessary object properties, namely width and height.
 
diff --git a/user_guide_src/source/helpers/smiley_helper.rst b/user_guide_src/source/helpers/smiley_helper.rst
index a42440f2a..7ac91c345 100644
--- a/user_guide_src/source/helpers/smiley_helper.rst
+++ b/user_guide_src/source/helpers/smiley_helper.rst
@@ -22,7 +22,7 @@ This helper is loaded using the following code::
 Overview
 ========
 
-The Smiley helper has a renderer that takes plain text simileys, like
+The Smiley helper has a renderer that takes plain text smileys, like
 :-) and turns them into a image representation, like |smile!|
 
 It also lets you display a set of smiley images that when clicked will
@@ -49,7 +49,7 @@ The Controller
 --------------
 
 In your `application/controllers/` folder, create a file called
-smileys.php and place the code below in it.
+Smileys.php and place the code below in it.
 
 .. important:: Change the URL in the :func:`get_clickable_smileys()`
 	function below so that it points to your smiley folder.
@@ -157,7 +157,7 @@ Available Functions
 
 	Example::
 
-		$str = 'Here are some simileys: :-)  ;-)';
+		$str = 'Here are some smileys: :-)  ;-)';
 		$str = parse_smileys($str, "http://example.com/images/smileys/");
 		echo $str;
 
diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst
index 74e87e2d6..b36a70cc8 100644
--- a/user_guide_src/source/installation/upgrade_300.rst
+++ b/user_guide_src/source/installation/upgrade_300.rst
@@ -162,7 +162,7 @@ If your application relies on IF EXISTS, you'll have to change its usage.
 	// Produces DROP TABLE IF EXISTS `table_name`
 	$this->dbforge->drop_table('table_name', TRUE);
 
-.. note:: The given example users MySQL-specific syntax, but it should work across
+.. note:: The given example uses MySQL-specific syntax, but it should work across
 	all drivers with the exception of ODBC.
 
 ***********************************************************
-- 
cgit v1.2.3-24-g4f1b


From b799a0b3f09238fe46892b811025e7bf2ac81b19 Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Tue, 6 Aug 2013 15:38:21 -0700
Subject: Partial update to FTP docs

---
 user_guide_src/source/libraries/ftp.rst | 87 +++++++++++++++++++--------------
 1 file changed, 49 insertions(+), 38 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/ftp.rst b/user_guide_src/source/libraries/ftp.rst
index 05a3fdcc8..fd82590b9 100644
--- a/user_guide_src/source/libraries/ftp.rst
+++ b/user_guide_src/source/libraries/ftp.rst
@@ -10,9 +10,19 @@ directory to be recreated remotely via FTP.
 .. note:: SFTP and SSL FTP protocols are not supported, only standard
 	FTP.
 
-**********************
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
+
+**************************
+Working with the FTP Class
+**************************
+
 Initializing the Class
-**********************
+======================
 
 Like most other classes in CodeIgniter, the FTP class is initialized in
 your controller using the $this->load->library function::
@@ -79,53 +89,54 @@ In this example a local directory is mirrored on the server.
 
 	$this->ftp->close();
 
-******************
-Function Reference
-******************
+***************
+Class Reference
+***************
 
-$this->ftp->connect()
-=====================
+.. class:: CI_FTP
 
-Connects and logs into to the FTP server. Connection preferences are set
-by passing an array to the function, or you can store them in a config
-file.
+	.. method:: connect([$config = array()])
 
-Here is an example showing how you set preferences manually::
+		:param array $config: Connection values
+		:returns: bool
 
-	$this->load->library('ftp');
+		Connects and logs into to the FTP server. Connection preferences are set
+		by passing an array to the function, or you can store them in a config
+		file.
 
-	$config['hostname'] = 'ftp.example.com';
-	$config['username'] = 'your-username';
-	$config['password'] = 'your-password';
-	$config['port']     = 21;
-	$config['passive']  = FALSE;
-	$config['debug']    = TRUE;
+		Here is an example showing how you set preferences manually::
 
-	$this->ftp->connect($config);
+			$this->load->library('ftp');
 
-Setting FTP Preferences in a Config File
-****************************************
+			$config['hostname'] = 'ftp.example.com';
+			$config['username'] = 'your-username';
+			$config['password'] = 'your-password';
+			$config['port']     = 21;
+			$config['passive']  = FALSE;
+			$config['debug']    = TRUE;
 
-If you prefer you can store your FTP preferences in a config file.
-Simply create a new file called the ftp.php, add the $config array in
-that file. Then save the file at config/ftp.php and it will be used
-automatically.
+			$this->ftp->connect($config);
 
-Available connection options
-****************************
+		**Setting FTP Preferences in a Config File**
 
--  **hostname** - the FTP hostname. Usually something like:
-   ftp.example.com
--  **username** - the FTP username.
--  **password** - the FTP password.
--  **port** - The port number. Set to 21 by default.
--  **debug** - TRUE/FALSE (boolean). Whether to enable debugging to
-   display error messages.
--  **passive** - TRUE/FALSE (boolean). Whether to use passive mode.
-   Passive is set automatically by default.
+		If you prefer you can store your FTP preferences in a config file.
+		Simply create a new file called the ftp.php, add the $config array in
+		that file. Then save the file at config/ftp.php and it will be used
+		automatically.
+
+		**Available connection options**
+
+		==================		===================================
+		Option Name						Description
+		==================		===================================
+		**hostname**					the FTP hostname. Usually something like: ftp.example.com
+		**username**					the FTP username
+		**password**					the FTP password
+		**port**							The port number. Set to 21 by default.
+		**debug**							TRUE/FALSE (boolean). Whether to enable debugging to display error messages.
+		**passive**						TRUE/FALSE (boolean). Whether to use passive mode. Passive is set automatically by default.
+		==================		===================================
 
-$this->ftp->upload()
-====================
 
 Uploads a file to your server. You must supply the local path and the
 remote path, and you can optionally set the mode and permissions.
-- 
cgit v1.2.3-24-g4f1b


From 1c75780da904b2a56c30c693fc3e03d2145614c2 Mon Sep 17 00:00:00 2001
From: vlakoff <vlakoff@gmail.com>
Date: Tue, 6 Aug 2013 20:25:14 +0200
Subject: Fix a few more merge conflicts

---
 user_guide_src/source/changelog.rst             |  2 +-
 user_guide_src/source/helpers/form_helper.rst   | 44 ++++++++++++++-----------
 user_guide_src/source/helpers/smiley_helper.rst |  4 +--
 3 files changed, 27 insertions(+), 23 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 44c6f16c5..f9beff36b 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -403,7 +403,7 @@ Release Date: Not Released
    -  :doc:`Config Library <libraries/config>` changes include:
 
       -  Changed ``site_url()`` method  to accept an array as well.
-      -  Removed internal method ``_assign_to_config()`` and moved its implementation in *CodeIgniter.php* instead.
+      -  Removed internal method ``_assign_to_config()`` and moved its implementation to *CodeIgniter.php* instead.
 
    -  :doc:`Security Library <libraries/security>` changes include:
 
diff --git a/user_guide_src/source/helpers/form_helper.rst b/user_guide_src/source/helpers/form_helper.rst
index 5bc5887aa..8ad8f7dcd 100644
--- a/user_guide_src/source/helpers/form_helper.rst
+++ b/user_guide_src/source/helpers/form_helper.rst
@@ -47,7 +47,7 @@ The following functions are available:
 	The above example would create a form that points to your base URL plus the
 	"email/send" URI segments, like this::
 
-		<form method="post" accept-charset="utf-8" action="http://example.com/index.php/email/send" />
+		<form method="post" accept-charset="utf-8" action="http://example.com/index.php/email/send">
 
 	**Adding Attributes**
 
@@ -57,9 +57,13 @@ The following functions are available:
 			$attributes = array('class' => 'email', 'id' => 'myform');
 			echo form_open('email/send', $attributes);
 
-		The above example would create a form similar to this::
+		Alternatively, you can specify the second parameter as a string::
+
+			echo form_open('email/send', 'class="email" id="myform"');
+
+		The above examples would create a form similar to this::
 
-			<form method="post" accept-charset="utf-8" action="http://example.com/index.php/email/send" class="email" id="myform" />
+			<form method="post" accept-charset="utf-8" action="http://example.com/index.php/email/send" class="email" id="myform">
 
 	**Adding Hidden Input Fields**
 
@@ -69,6 +73,8 @@ The following functions are available:
 			$hidden = array('username' => 'Joe', 'member_id' => '234');
 			echo form_open('email/send', '', $hidden);
 
+		You can skip the second parameter by passing any falsy value to it.
+
 		The above example would create a form similar to this::
 
 			<form method="post" accept-charset="utf-8" action="http://example.com/index.php/email/send">
@@ -248,10 +254,10 @@ The following functions are available:
 	Example::
 
 		$options = array(
-			'small'  => 'Small Shirt',
-			'med'    => 'Medium Shirt',
-			'large'  => 'Large Shirt',
-			'xlarge' => 'Extra Large Shirt',
+			'small'		=> 'Small Shirt',
+			'med'		=> 'Medium Shirt',
+			'large'		=> 'Large Shirt',
+			'xlarge'	=> 'Extra Large Shirt',
 		);
 
 		$shirts_on_sale = array('small', 'large');
@@ -389,16 +395,14 @@ The following functions are available:
 	the box should be checked or not.
 
 	Similar to the other form functions in this helper, you can also pass an
-	array of attributes to the function
-
-	::
+	array of attributes to the function::
 
 		$data = array(
-			'name'    => 'newsletter',
-			'id'      => 'newsletter',
-			'value'   => 'accept',
-			'checked' => TRUE,
-			'style'   => 'margin:10px'
+			'name'		=> 'newsletter',
+			'id'		=> 'newsletter',
+			'value'		=> 'accept',
+			'checked'	=> TRUE,
+			'style'		=> 'margin:10px'
 		);
 
 		echo form_checkbox($data);
@@ -495,11 +499,11 @@ The following functions are available:
 	form to contain::
 
 		$data = array(
-			'name'    => 'button',
-			'id'      => 'button',
-			'value'   => 'true',
-			'type'    => 'reset',
-			'content' => 'Reset'
+			'name'		=> 'button',
+			'id'		=> 'button',
+			'value'		=> 'true',
+			'type'		=> 'reset',
+			'content'	=> 'Reset'
 		);
 
 		echo form_button($data);
diff --git a/user_guide_src/source/helpers/smiley_helper.rst b/user_guide_src/source/helpers/smiley_helper.rst
index 7ac91c345..0601f0244 100644
--- a/user_guide_src/source/helpers/smiley_helper.rst
+++ b/user_guide_src/source/helpers/smiley_helper.rst
@@ -48,7 +48,7 @@ View as described.
 The Controller
 --------------
 
-In your `application/controllers/` folder, create a file called
+In your **application/controllers/** directory, create a file called
 Smileys.php and place the code below in it.
 
 .. important:: Change the URL in the :func:`get_clickable_smileys()`
@@ -75,7 +75,7 @@ the :doc:`Table Class <../libraries/table>`::
 
 	}
 
-In your `application/views/` folder, create a file called `smiley_view.php`
+In your **application/views/** folder, create a file called **smiley_view.php**
 and place this code in it::
 
 	<html>
-- 
cgit v1.2.3-24-g4f1b


From 3914c0eff4414dc8997e6866276c5eefe6103ff3 Mon Sep 17 00:00:00 2001
From: AdwinTrave <storyteller@freedombase.net>
Date: Sun, 15 Sep 2013 13:21:38 -0400
Subject: Adding missing reference to min_length in rules reference

---
 user_guide_src/source/libraries/form_validation.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/form_validation.rst b/user_guide_src/source/libraries/form_validation.rst
index 032cff23b..8534175bb 100644
--- a/user_guide_src/source/libraries/form_validation.rst
+++ b/user_guide_src/source/libraries/form_validation.rst
@@ -866,6 +866,7 @@ Rule                      Parameter  Description
 **is_unique**             Yes        Returns FALSE if the form element is not unique to the table and field name in the            is_unique[table.field] 
                                      parameter. Note: This rule requires :doc:`Query Builder <../database/query_builder>` to be                             
                                      enabled in order to work.
+**min_length**            Yes        Returns FALSE if the form element is shorter then the parameter value.                        min_length[3]         
 **max_length**            Yes        Returns FALSE if the form element is longer then the parameter value.                         max_length[12]         
 **exact_length**          Yes        Returns FALSE if the form element is not exactly the parameter value.                         exact_length[8]        
 **greater_than**          Yes        Returns FALSE if the form element is less than or equal to the parameter value or not         greater_than[8]
-- 
cgit v1.2.3-24-g4f1b


From 0c23a2712b07a53041cf808c280e71c623df3c8a Mon Sep 17 00:00:00 2001
From: vlakoff <vlakoff@gmail.com>
Date: Fri, 20 Sep 2013 22:09:20 +0200
Subject: Fix duplicate changelog entry

---
 user_guide_src/source/changelog.rst | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 69f88a8a8..e36be29f6 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -766,7 +766,6 @@ Bug fixes for 2.1.0
    but the requested method did not.
 -  Fixed a bug (Reactor #89) where MySQL export would fail if the table
    had hyphens or other non alphanumeric/underscore characters.
--  Fixed a bug (#200) where MySQL queries would be malformed after calling $this->db->count_all() then $this->db->get()
 -  Fixed a bug (#105) that stopped query errors from being logged unless database debugging was enabled
 -  Fixed a bug (#160) - Removed unneeded array copy in the file cache
    driver.
@@ -787,7 +786,7 @@ Bug fixes for 2.1.0
 -  Fixed a bug (#537) - Support for all wav type in browser.
 -  Fixed a bug (#576) - Using ini_get() function to detect if apc is enabled or not.
 -  Fixed invalid date time format in :doc:`Date helper <helpers/date_helper>` and :doc:`XMLRPC library <libraries/xmlrpc>`.
--  Fixed a bug (#200) - MySQL queries would be malformed after calling count_all() then db->get().
+-  Fixed a bug (#200) - MySQL queries would be malformed after calling db->count_all() then db->get().
 
 Version 2.0.3
 =============
-- 
cgit v1.2.3-24-g4f1b


From fd0aabb1e6f3db088ad9b3079adc0f9bba9b6c2b Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Mon, 23 Sep 2013 13:18:20 +0300
Subject: Fix issue #33

---
 user_guide_src/source/changelog.rst | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index d804cc532..a66fb265f 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -392,6 +392,7 @@ Release Date: Not Released
       -  Changed methods ``get()``, ``post()``, ``get_post()``, ``cookie()``, ``server()``, ``user_agent()`` to return NULL instead of FALSE when no value is found.
       -  Added method ``post_get()`` and changed ``get_post()`` to search in GET data first. Both methods' names now properly match their GET/POST data search priorities.
       -  Changed method ``_fetch_from_array()`` to parse array notation in field name.
+      -  Added an option for ``_clean_input_keys()`` to return FALSE instead of terminating the whole script.
 
    -  :doc:`Common functions <general/common_functions>` changes include:
 
@@ -614,6 +615,7 @@ Bug fixes for 3.0
 -  Fixed a bug (#2590) - :php:func:`log_message()` didn't actually cache the ``CI_Log`` class instance.
 -  Fixed a bug (#2609) - :php:func:`get_config()` optional argument was only effective on first function call. Also, it can now add items, in addition to updating existing items.
 -  Fixed a bug in the 'postgre' :doc:`database <database/index>` driver where the connection ID wasn't passed to ``pg_escape_string()``.
+-  Fixed a bug (#33) - Script execution was terminated when an invalid cookie key was encountered.
 
 Version 2.1.4
 =============
-- 
cgit v1.2.3-24-g4f1b


From 2c08e4e4df83e67262d0cde8aed729e4343564fb Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Mon, 23 Sep 2013 15:20:21 +0300
Subject: [ci skip] Update Zip library docs

---
 user_guide_src/source/libraries/zip.rst | 229 ++++++++++++++++----------------
 1 file changed, 116 insertions(+), 113 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/zip.rst b/user_guide_src/source/libraries/zip.rst
index c27718273..e0955e3d6 100644
--- a/user_guide_src/source/libraries/zip.rst
+++ b/user_guide_src/source/libraries/zip.rst
@@ -6,6 +6,17 @@ CodeIgniter's Zip Encoding Class classes permit you to create Zip
 archives. Archives can be downloaded to your desktop or saved to a
 directory.
 
+.. contents::
+	:local:
+
+.. raw:: html
+
+	 <div class="custom-index container"></div>
+
+****************************
+Using the Zip Encoding Class
+****************************
+
 Initializing the Class
 ======================
 
@@ -35,174 +46,166 @@ your server, and download it to your desktop.
 	// Download the file to your desktop. Name it "my_backup.zip"
 	$this->zip->download('my_backup.zip');
 
-******************
-Function Reference
-******************
+***************
+Class Reference
+***************
 
-$this->zip->add_data()
-=======================
+.. class:: CI_Zip
 
-Permits you to add data to the Zip archive. The first parameter must
-contain the name you would like given to the file, the second parameter
-must contain the file data as a string::
+	.. method:: add_data($filepath[, $data = NULL])
 
-	$name = 'my_bio.txt';
-	$data = 'I was born in an elevator...';
+		:param mixed $filepath: a single file path or an array of file => data pairs
+		:param array $data: single file contents
+		:returns: void
 
-	$this->zip->add_data($name, $data);
+		Adds data to the Zip archive. Can work both in single and multiple files mode.
 
-You are allowed multiple calls to this function in order to add several
-files to your archive. Example::
+		When adding a single file, the first parameter must contain the name you would like given to the file and the second must contain the file contents::
 
-	$name = 'mydata1.txt';
-	$data = 'A Data String!';
-	$this->zip->add_data($name, $data);
+			$name = 'mydata1.txt';
+			$data = 'A Data String!';
+			$this->zip->add_data($name, $data);
 
-	$name = 'mydata2.txt';
-	$data = 'Another Data String!';
-	$this->zip->add_data($name, $data);
+			$name = 'mydata2.txt';
+			$data = 'Another Data String!';
+			$this->zip->add_data($name, $data);
+			
+		When adding multiple files, the first parameter must contain *file => contents* pairs and the second parameter is ignored::
 
-Or you can pass multiple files using an array::
+			$data = array(
+				'mydata1.txt' => 'A Data String!',
+				'mydata2.txt' => 'Another Data String!'
+			);
 
-	$data = array(
-	                'mydata1.txt' => 'A Data String!',
-	                'mydata2.txt' => 'Another Data String!'
-	            );
+			$this->zip->add_data($data);
 
-	$this->zip->add_data($data);
+		If you would like your compressed data organized into sub-directories, simply include the path as part of the filename(s)::
 
-	$this->zip->download('my_backup.zip');
+			$name = 'personal/my_bio.txt';
+			$data = 'I was born in an elevator...';
 
-If you would like your compressed data organized into sub-folders,
-include the path as part of the filename::
+			$this->zip->add_data($name, $data);
 
-	$name = 'personal/my_bio.txt';
-	$data = 'I was born in an elevator...';
+		The above example will place my_bio.txt inside a folder called personal.
 
-	$this->zip->add_data($name, $data);
+	.. method:: add_dir($directory)
 
-The above example will place my_bio.txt inside a folder called
-personal.
+		:param mixed $directory: string directory name or an array of multiple directories
+		:returns: void
 
-$this->zip->add_dir()
-======================
+		Permits you to add a directory. Usually this method is unnecessary since you can place your data into directories when using
+		``$this->zip->add_data()``, but if you would like to create an empty directory you can do so::
 
-Permits you to add a directory. Usually this function is unnecessary
-since you can place your data into folders when using
-$this->zip->add_data(), but if you would like to create an empty folder
-you can do so. Example::
+			$this->zip->add_dir('myfolder'); // Creates a directory called "myfolder"
 
-	$this->zip->add_dir('myfolder'); // Creates a folder called "myfolder"
+	.. method:: read_file($path[, $preserve_filepath = FALSE])
 
-$this->zip->read_file()
-========================
+		:param string $path: path to file
+		:param bool $preserve_filepath: whether to maintain the original filepath
+		:returns: bool
 
-Permits you to compress a file that already exists somewhere on your
-server. Supply a file path and the zip class will read it and add it to
-the archive::
+		Permits you to compress a file that already exists somewhere on your server.
+		Supply a file path and the zip class will read it and add it to the archive::
 
-	$path = '/path/to/photo.jpg';
+			$path = '/path/to/photo.jpg';
 
-	$this->zip->read_file($path); 
+			$this->zip->read_file($path); 
 
-	// Download the file to your desktop. Name it "my_backup.zip"
-	$this->zip->download('my_backup.zip');
+			// Download the file to your desktop. Name it "my_backup.zip"
+			$this->zip->download('my_backup.zip');
 
-If you would like the Zip archive to maintain the directory structure of
-the file in it, pass TRUE (boolean) in the second parameter. Example::
+		If you would like the Zip archive to maintain the directory structure of
+		the file in it, pass TRUE (boolean) in the second parameter. Example::
 
-	$path = '/path/to/photo.jpg';
+			$path = '/path/to/photo.jpg';
 
-	$this->zip->read_file($path, TRUE); 
+			$this->zip->read_file($path, TRUE); 
 
-	// Download the file to your desktop. Name it "my_backup.zip"
-	$this->zip->download('my_backup.zip');
+			// Download the file to your desktop. Name it "my_backup.zip"
+			$this->zip->download('my_backup.zip');
 
-In the above example, photo.jpg will be placed inside two folders:
-path/to/
+		In the above example, photo.jpg will be placed into the *path/to/* directory.
 
-$this->zip->read_dir()
-=======================
+	.. method:: read_dir($path[, $preserve_filepath = TRUE[, $root_path = NULL]])
 
-Permits you to compress a folder (and its contents) that already exists
-somewhere on your server. Supply a file path to the directory and the
-zip class will recursively read it and recreate it as a Zip archive. All
-files contained within the supplied path will be encoded, as will any
-sub-folders contained within it. Example::
+		:param string $path: path to directory
+		:param bool $preserve_filepath: whether to maintain the original path
+		:param string $root_path: part of the path to exclude from the archive directory
+		:returns: bool
 
-	$path = '/path/to/your/directory/';
+		Permits you to compress a directory (and its contents) that already exists somewhere on your server.
+		Supply a path to the directory and the zip class will recursively read and recreate it as a Zip archive.
+		All files contained within the supplied path will be encoded, as will any sub-directories contained within it. Example::
 
-	$this->zip->read_dir($path); 
+			$path = '/path/to/your/directory/';
 
-	// Download the file to your desktop. Name it "my_backup.zip"
-	$this->zip->download('my_backup.zip');
+			$this->zip->read_dir($path); 
 
-By default the Zip archive will place all directories listed in the
-first parameter inside the zip. If you want the tree preceding the
-target folder to be ignored you can pass FALSE (boolean) in the second
-parameter. Example::
+			// Download the file to your desktop. Name it "my_backup.zip"
+			$this->zip->download('my_backup.zip');
 
-	$path = '/path/to/your/directory/';
+		By default the Zip archive will place all directories listed in the first parameter inside the zip.
+		If you want the tree preceding the target directory to be ignored you can pass FALSE (boolean) in the second parameter. Example::
 
-	$this->zip->read_dir($path, FALSE);
+			$path = '/path/to/your/directory/';
 
-This will create a ZIP with the folder "directory" inside, then all
-sub-folders stored correctly inside that, but will not include the
-folders /path/to/your.
+			$this->zip->read_dir($path, FALSE);
 
-$this->zip->archive()
-=====================
+		This will create a ZIP with a directory named "directory" inside, then all sub-directories stored correctly inside that, but will not include the
+		*/path/to/your* part of the path.
 
-Writes the Zip-encoded file to a directory on your server. Submit a
-valid server path ending in the file name. Make sure the directory is
-writable (666 or 777 is usually OK). Example::
+	.. method:: archive($filepath)
 
-	$this->zip->archive('/path/to/folder/myarchive.zip'); // Creates a file named myarchive.zip
+		:param string $filepath: path to target zip archive
+		:returns: bool
 
-$this->zip->download()
-======================
+		Writes the Zip-encoded file to a directory on your server. Submit a valid server path ending in the file name.
+		Make sure the directory is writable (660 or 666 is usually OK). Example::
 
-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::
+			$this->zip->archive('/path/to/folder/myarchive.zip'); // Creates a file named myarchive.zip
 
-	$this->zip->download('latest_stuff.zip'); // File will be named "latest_stuff.zip"
+	.. method:: download($filename = 'backup.zip')
 
-.. note:: Do not display any data in the controller in which you call
-	this function since it sends various server headers that cause the
-	download to happen and the file to be treated as binary.
+		:param string $filename: the archive file name
+		:returns: void
 
-$this->zip->get_zip()
-======================
+		Causes the Zip file to be downloaded from your server. You must pass the name you would like the zip file called. Example::
 
-Returns the Zip-compressed file data. Generally you will not need this
-function unless you want to do something unique with the data. Example::
+			$this->zip->download('latest_stuff.zip'); // File will be named "latest_stuff.zip"
 
-	$name = 'my_bio.txt';
-	$data = 'I was born in an elevator...';
+		.. note:: Do not display any data in the controller in which you call
+			this method since it sends various server headers that cause the
+			download to happen and the file to be treated as binary.
 
-	$this->zip->add_data($name, $data);
+	.. method:: get_zip()
 
-	$zip_file = $this->zip->get_zip();
+		:returns: string
 
-$this->zip->clear_data()
-=========================
+		Returns the Zip-compressed file data. Generally you will not need this method unless you want to do something unique with the data. Example::
 
-The Zip class caches your zip data so that it doesn't need to recompile
-the Zip archive for each function you use above. If, however, you need
-to create multiple Zips, each with different data, you can clear the
-cache between calls. Example::
+			$name = 'my_bio.txt';
+			$data = 'I was born in an elevator...';
 
-	$name = 'my_bio.txt';
-	$data = 'I was born in an elevator...';
+			$this->zip->add_data($name, $data);
 
-	$this->zip->add_data($name, $data);
-	$zip_file = $this->zip->get_zip();
+			$zip_file = $this->zip->get_zip();
+
+	.. method:: clear_data()
+
+		:returns: void
+
+		The Zip class caches your zip data so that it doesn't need to recompile the Zip archive for each method you use above.
+		If, however, you need to create multiple Zip archives, each with different data, you can clear the cache between calls. Example::
 
-	$this->zip->clear_data(); 
+			$name = 'my_bio.txt';
+			$data = 'I was born in an elevator...';
 
-	$name = 'photo.jpg';
-	$this->zip->read_file("/path/to/photo.jpg"); // Read the file's contents
+			$this->zip->add_data($name, $data);
+			$zip_file = $this->zip->get_zip();
 
+			$this->zip->clear_data(); 
 
-	$this->zip->download('myphotos.zip');
+			$name = 'photo.jpg';
+			$this->zip->read_file("/path/to/photo.jpg"); // Read the file's contents
 
+			$this->zip->download('myphotos.zip');
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From d8afb982f10e259142f33f882f6d6032a3ca9b1c Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Mon, 23 Sep 2013 16:01:46 +0300
Subject: [ci skip] Update XML-RPC library docs

---
 user_guide_src/source/libraries/xmlrpc.rst | 182 +++++++++++++++++------------
 1 file changed, 106 insertions(+), 76 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/xmlrpc.rst b/user_guide_src/source/libraries/xmlrpc.rst
index a43c48837..c79f8bed9 100644
--- a/user_guide_src/source/libraries/xmlrpc.rst
+++ b/user_guide_src/source/libraries/xmlrpc.rst
@@ -5,6 +5,13 @@ XML-RPC and XML-RPC Server Classes
 CodeIgniter's XML-RPC classes permit you to send requests to another
 server, or set up your own XML-RPC server to receive requests.
 
+.. contents::
+	:local:
+
+.. raw:: html
+
+	<div class="custom-index container"></div>
+
 ****************
 What is XML-RPC?
 ****************
@@ -24,8 +31,11 @@ it to determine which class/method should be called to process the
 request. Once processed, the server will then send back a response
 message.
 
-For detailed specifications, you can visit the
-`XML-RPC <http://www.xmlrpc.com/>`_ site.
+For detailed specifications, you can visit the `XML-RPC <http://www.xmlrpc.com/>`_ site.
+
+***********************
+Using the XML-RPC Class
+***********************
 
 Initializing the Class
 ======================
@@ -123,6 +133,7 @@ with the data type in the second position::
 
 The `Data Types <#datatypes>`_ section below has a full list of data
 types.
+
 Creating an XML-RPC Server
 ==========================
 
@@ -425,114 +436,133 @@ the Server.
 	$size = $parameters[1]['size'];
 	$shape = $parameters[1]['shape'];
 
-**************************
-XML-RPC Function Reference
-**************************
+Data Types
+==========
 
-$this->xmlrpc->server()
-=======================
+According to the `XML-RPC spec <http://www.xmlrpc.com/spec>`_ there are
+seven types of values that you can send via XML-RPC:
 
-Sets the URL and port number of the server to which a request is to be
-sent::
+-  *int* or *i4*
+-  *boolean*
+-  *string*
+-  *double*
+-  *dateTime.iso8601*
+-  *base64*
+-  *struct* (contains array of values)
+-  *array* (contains array of values)
 
-	$this->xmlrpc->server('http://www.sometimes.com/pings.php', 80);
+***************
+Class Reference
+***************
 
-$this->xmlrpc->timeout()
-========================
+.. class:: CI_Xmlrpc
 
-Set a time out period (in seconds) after which the request will be
-canceled::
+	.. method:: initialize([$config = array()])
 
-	$this->xmlrpc->timeout(6);
+		:param array $config: configuration data
+		:returns: void
 
-$this->xmlrpc->method()
-=======================
+		Initializes the XML-RPC library. Accepts an associative array containing your settings.
 
-Sets the method that will be requested from the XML-RPC server::
+	.. method:: server($url[, $port = 80[, $proxy = FALSE[, $proxy_port = 8080]]])
 
-	$this->xmlrpc->method('method');
+		:param string $url: XML-RPC server URL
+		:param int $port: server port
+		:param string $proxy: optional proxy
+		:param int $proxy_port: proxy listening port
+		:returns: void
 
-Where method is the name of the method.
+		Sets the URL and port number of the server to which a request is to be sent::
 
-$this->xmlrpc->request()
-========================
+			$this->xmlrpc->server('http://www.sometimes.com/pings.php', 80);
 
-Takes an array of data and builds request to be sent to XML-RPC server::
+	.. method:: timeout($seconds = 5)
 
-	$request = array(array('My Photoblog', 'string'), 'http://www.yoursite.com/photoblog/');
-	$this->xmlrpc->request($request);
+		:param int $seconds: timeout in seconds
+		:returns: void
 
-$this->xmlrpc->send_request()
-==============================
+		Set a time out period (in seconds) after which the request will be canceled::
 
-The request sending function. Returns boolean TRUE or FALSE based on
-success for failure, enabling it to be used conditionally.
+			$this->xmlrpc->timeout(6);
 
-$this->xmlrpc->set_debug(TRUE);
-================================
+	.. method:: method($function)
 
-Enables debugging, which will display a variety of information and error
-data helpful during development.
+		:param string $function: method name
+		:returns: void
 
-$this->xmlrpc->display_error()
-===============================
+		Sets the method that will be requested from the XML-RPC server::
 
-Returns an error message as a string if your request failed for some
-reason.
+			$this->xmlrpc->method('method');
 
-::
+		Where method is the name of the method.
 
-	echo $this->xmlrpc->display_error();
+	.. method:: request($incoming)
 
-$this->xmlrpc->display_response()
-==================================
+		:param array $incoming: request data
+		:returns: void
 
-Returns the response from the remote server once request is received.
-The response will typically be an associative array.
+		Takes an array of data and builds request to be sent to XML-RPC server::
 
-::
+			$request = array(array('My Photoblog', 'string'), 'http://www.yoursite.com/photoblog/');
+			$this->xmlrpc->request($request);
 
-	$this->xmlrpc->display_response();
+	.. method:: send_request()
 
-$this->xmlrpc->send_error_message()
-=====================================
+		:returns: bool
 
-This function lets you send an error message from your server to the
-client. First parameter is the error number while the second parameter
-is the error message.
+		The request sending method. Returns boolean TRUE or FALSE based on success for failure, enabling it to be used conditionally.
 
-::
+	.. method set_debug($flag = TRUE)
 
-	return $this->xmlrpc->send_error_message('123', 'Requested data not available');
+		:param bool $flag: debug status flag
+		:returns: void
 
-$this->xmlrpc->send_response()
-===============================
+	Enables or disables debugging, which will display a variety of information and error data helpful during development.
 
-Lets you send the response from your server to the client. An array of
-valid data values must be sent with this method.
+	.. method:: display_error()
 
-::
+		:returns: string
 
-	$response = array(
-	                 array(
-	                        'flerror' => array(FALSE, 'boolean'),
-	                        'message' => "Thanks for the ping!"
-	                     )
-	                 'struct');
-	return $this->xmlrpc->send_response($response);
+		Returns an error message as a string if your request failed for some reason.
+		::
 
-Data Types
-==========
+			echo $this->xmlrpc->display_error();
 
-According to the `XML-RPC spec <http://www.xmlrpc.com/spec>`_ there are
-seven types of values that you can send via XML-RPC:
+	.. method:: display_response()
 
--  *int* or *i4*
--  *boolean*
--  *string*
--  *double*
--  *dateTime.iso8601*
--  *base64*
--  *struct* (contains array of values)
--  *array* (contains array of values)
+		:returns: mixed
+
+		Returns the response from the remote server once request is received. The response will typically be an associative array.
+		::
+
+			$this->xmlrpc->display_response();
+
+	.. method:: send_error_message($number, $message)
+
+		:param int $number: error number
+		:param string $message: error message
+		:returns: object
 
+		This method lets you send an error message from your server to the client.
+		First parameter is the error number while the second parameter is the error message.
+		::
+
+		return $this->xmlrpc->send_error_message(123, 'Requested data not available');
+
+	.. method send_response($response)
+
+		:param array $response: response data
+		:returns: object
+
+		Lets you send the response from your server to the client. An array of valid data values must be sent with this method.
+		::
+
+			$response = array(
+				array(
+					'flerror' => array(FALSE, 'boolean'),
+					'message' => "Thanks for the ping!"
+				),
+				'struct'
+			);
+
+		return $this->xmlrpc->send_response($response);
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 20d93e4806ce0084b3fd6540a626b761d5d66712 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Mon, 23 Sep 2013 16:22:23 +0300
Subject: [ci skip] Update the User Agent library docs

---
 user_guide_src/source/libraries/user_agent.rst | 242 ++++++++++++++-----------
 1 file changed, 134 insertions(+), 108 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/user_agent.rst b/user_guide_src/source/libraries/user_agent.rst
index 97abd2244..3662cf3ad 100644
--- a/user_guide_src/source/libraries/user_agent.rst
+++ b/user_guide_src/source/libraries/user_agent.rst
@@ -7,6 +7,17 @@ about the browser, mobile device, or robot visiting your site. In
 addition you can get referrer information as well as language and
 supported character-set information.
 
+.. contents::
+	:local:
+
+.. raw:: html
+
+	<div class="custom-index container"></div>
+
+**************************
+Using the User Agent Class
+**************************
+
 Initializing the Class
 ======================
 
@@ -15,7 +26,7 @@ initialized in your controller using the $this->load->library function::
 
 	$this->load->library('user_agent');
 
-Once loaded, the object will be available using: $this->agent
+Once loaded, the object will be available using: ``$this->agent``
 
 User Agent Definitions
 ======================
@@ -38,163 +49,178 @@ is available.
 
 	if ($this->agent->is_browser())
 	{
-	    $agent = $this->agent->browser().' '.$this->agent->version();
+		$agent = $this->agent->browser().' '.$this->agent->version();
 	}
 	elseif ($this->agent->is_robot())
 	{
-	    $agent = $this->agent->robot();
+		$agent = $this->agent->robot();
 	}
 	elseif ($this->agent->is_mobile())
 	{
-	    $agent = $this->agent->mobile();
+		$agent = $this->agent->mobile();
 	}
 	else
 	{
-	    $agent = 'Unidentified User Agent';
+		$agent = 'Unidentified User Agent';
 	}
 
 	echo $agent;
 
 	echo $this->agent->platform(); // Platform info (Windows, Linux, Mac, etc.)
 
-******************
-Function Reference
-******************
+***************
+Class Reference
+***************
 
-$this->agent->is_browser()
-===========================
+.. class: CI_User_agent
 
-Returns TRUE/FALSE (boolean) if the user agent is a known web browser.
+	.. method:: is_browser([$key = NULL])
 
-::
+		:param string $key: optional browser name
+		:returns: bool
 
-	if ($this->agent->is_browser('Safari'))
-	{
-	    echo 'You are using Safari.';
-	}
-	elseif ($this->agent->is_browser())
-	{
-	    echo 'You are using a browser.';
-	}
-	
+		Returns TRUE/FALSE (boolean) if the user agent is a known web browser.
+		::
 
-.. note:: The string "Safari" in this example is an array key in the
-	list of browser definitions. You can find this list in
-	application/config/user_agents.php if you want to add new browsers or
-	change the stings.
+			if ($this->agent->is_browser('Safari'))
+			{
+				echo 'You are using Safari.';
+			}
+			elseif ($this->agent->is_browser())
+			{
+				echo 'You are using a browser.';
+			}
 
-$this->agent->is_mobile()
-==========================
+		.. note:: The string "Safari" in this example is an array key in the list of browser definitions.
+			You can find this list in **application/config/user_agents.php** if you want to add new
+			browsers or change the stings.
 
-Returns TRUE/FALSE (boolean) if the user agent is a known mobile device.
+	.. method:: is_mobile([$key = NULL])
 
-::
+		:param string $key: optional mobile device name
+		:returns: bool
 
-	if ($this->agent->is_mobile('iphone'))
-	{
-	    $this->load->view('iphone/home');
-	}
-	elseif ($this->agent->is_mobile())
-	{
-	    $this->load->view('mobile/home');
-	}
-	else
-	{
-	    $this->load->view('web/home');
-	}
-	
+		Returns TRUE/FALSE (boolean) if the user agent is a known mobile device.
+		::
 
-$this->agent->is_robot()
-=========================
+			if ($this->agent->is_mobile('iphone'))
+			{
+				$this->load->view('iphone/home');
+			}
+			elseif ($this->agent->is_mobile())
+			{
+				$this->load->view('mobile/home');
+			}
+			else
+			{
+				$this->load->view('web/home');
+			}
 
-Returns TRUE/FALSE (boolean) if the user agent is a known robot.
+	.. method:: is_robot([$key = NULL])
 
-.. note:: The user agent library only contains the most common robot
-	definitions. It is not a complete list of bots. There are hundreds of
-	them so searching for each one would not be very efficient. If you find
-	that some bots that commonly visit your site are missing from the list
-	you can add them to your application/config/user_agents.php file.
+		:param string $key: optional robot name
+		:returns: bool
 
-$this->agent->is_referral()
-============================
+		Returns TRUE/FALSE (boolean) if the user agent is a known robot.
 
-Returns TRUE/FALSE (boolean) if the user agent was referred from another
-site.
+		.. note:: The user agent library only contains the most common robot definitions. It is not a complete list of bots.
+			There are hundreds of them so searching for each one would not be very efficient. If you find that some bots
+			that commonly visit your site are missing from the list you can add them to your
+			**application/config/user_agents.php** file.
 
-$this->agent->browser()
-=======================
+	.. method:: is_referral()
 
-Returns a string containing the name of the web browser viewing your
-site.
+		:returns: bool
 
-$this->agent->version()
-=======================
+		Returns TRUE/FALSE (boolean) if the user agent was referred from another site.
 
-Returns a string containing the version number of the web browser
-viewing your site.
+	.. method:: browser()
 
-$this->agent->mobile()
-======================
+		:returns: string
 
-Returns a string containing the name of the mobile device viewing your
-site.
+		Returns a string containing the name of the web browser viewing your site.
 
-$this->agent->robot()
-=====================
+	.. method:: version()
 
-Returns a string containing the name of the robot viewing your site.
+		:returns: string
 
-$this->agent->platform()
-========================
+		Returns a string containing the version number of the web browser viewing your site.
 
-Returns a string containing the platform viewing your site (Linux,
-Windows, OS X, etc.).
+	.. method:: mobile()
 
-$this->agent->referrer()
-========================
+		:returns: string
 
-The referrer, if the user agent was referred from another site.
-Typically you'll test for this as follows::
+		Returns a string containing the name of the mobile device viewing your site.
 
-	if ($this->agent->is_referral())
-	{
-	    echo $this->agent->referrer();
-	}
+	.. method:: robot()
 
-$this->agent->agent_string()
-=============================
+		:returns: string
 
-Returns a string containing the full user agent string. Typically it
-will be something like this::
+		Returns a string containing the name of the robot viewing your site.
 
-	Mozilla/5.0 (Macintosh; U; Intel Mac OS X; en-US; rv:1.8.0.4) Gecko/20060613 Camino/1.0.2
+	.. method:: platform()
 
-$this->agent->accept_lang()
-============================
+		:returns: string
 
-Lets you determine if the user agent accepts a particular language.
-Example::
+		Returns a string containing the platform viewing your site (Linux, Windows, OS X, etc.).
 
-	if ($this->agent->accept_lang('en'))
-	{
-	    echo 'You accept English!';
-	}
+	.. method:: referrer()
 
-.. note:: This function is not typically very reliable since some
-	browsers do not provide language info, and even among those that do, it
-	is not always accurate.
+		:returns: string
 
-$this->agent->accept_charset()
-===============================
+		The referrer, if the user agent was referred from another site. Typically you'll test for this as follows::
 
-Lets you determine if the user agent accepts a particular character set.
-Example::
+			if ($this->agent->is_referral())
+			{
+				echo $this->agent->referrer();
+			}
 
-	if ($this->agent->accept_charset('utf-8'))
-	{
-	    echo 'You browser supports UTF-8!';
-	}
+	.. method:: agent_string()
+
+		:returns: string
+
+		Returns a string containing the full user agent string. Typically it will be something like this::
+
+			Mozilla/5.0 (Macintosh; U; Intel Mac OS X; en-US; rv:1.8.0.4) Gecko/20060613 Camino/1.0.2
+
+	.. method:: accept_lang([$lang = 'en'])
+
+		:param string $lang: language key
+		:returns: bool
+
+		Lets you determine if the user agent accepts a particular language. Example::
+
+			if ($this->agent->accept_lang('en'))
+			{
+				echo 'You accept English!';
+			}
+
+		.. note:: This method is not typically very reliable since some	browsers do not provide language info,
+			and even among those that do, it is not always accurate.
+
+	.. method:: languages()
+
+		:returns: array
+
+		Returns an array of languages supported by the user agent.
+
+	.. method:: accept_charset([$charset = 'utf-8'])
+
+		:param string $charset: character set
+		:returns: bool
+
+		Lets you determine if the user agent accepts a particular character set. Example::
+
+			if ($this->agent->accept_charset('utf-8'))
+			{
+				echo 'You browser supports UTF-8!';
+			}
+
+		.. note:: This method is not typically very reliable since some browsers do not provide character-set info,
+			and even among those that do, it is not always accurate.
+
+	.. method:: charsets()
+
+		:returns: array
 
-.. note:: This function is not typically very reliable since some
-	browsers do not provide character-set info, and even among those that
-	do, it is not always accurate.
+		Returns an array of character sets accepted by the user agent.
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From cc231fe7dc8d61e4d4f5d6a054e6131ea0659909 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Mon, 23 Sep 2013 16:46:52 +0300
Subject: [ci skip] Update the Typography library docs

---
 user_guide_src/source/libraries/typography.rst | 137 ++++++++++++-------------
 1 file changed, 68 insertions(+), 69 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/typography.rst b/user_guide_src/source/libraries/typography.rst
index db3f227be..8dab053ba 100644
--- a/user_guide_src/source/libraries/typography.rst
+++ b/user_guide_src/source/libraries/typography.rst
@@ -2,104 +2,103 @@
 Typography Class
 ################
 
-The Typography Class provides functions that help you format text.
+The Typography Class provides methods that help you format text.
+
+.. content::
+	:local:
+
+.. raw:: html
+
+	<div class="custom-index container"></div>
+
+**************************
+Using the Typography Class
+**************************
 
 Initializing the Class
 ======================
 
 Like most other classes in CodeIgniter, the Typography class is
-initialized in your controller using the $this->load->library function::
+initialized in your controller using the ``$this->load->library()`` method::
 
 	$this->load->library('typography');
 
-Once loaded, the Typography library object will be available using:
-$this->typography
+Once loaded, the Typography library object will be available using::
 
-auto_typography()
-==================
+	$this->typography
 
-Formats text so that it is semantically and typographically correct
-HTML. Takes a string as input and returns it with the following
-formatting:
+***************
+Class Reference
+***************
 
--  Surrounds paragraphs within <p></p> (looks for double line breaks to
-   identify paragraphs).
--  Single line breaks are converted to <br />, except those that appear
-   within <pre> tags.
--  Block level elements, like <div> tags, are not wrapped within
-   paragraphs, but their contained text is if it contains paragraphs.
--  Quotes are converted to correctly facing curly quote entities, except
-   those that appear within tags.
--  Apostrophes are converted to curly apostrophe entities.
--  Double dashes (either like -- this or like--this) are converted to
-   em—dashes.
--  Three consecutive periods either preceding or following a word are
-   converted to ellipsis…
--  Double spaces following sentences are converted to non-breaking
-   spaces to mimic double spacing.
+.. class:: CI_Typography
 
-Usage example::
+	.. attribute:: $protect_braced_quotes = FALSE
 
-	$string = $this->typography->auto_typography($string);
+		When using the Typography library in conjunction with the :doc:`Template Parser library <../parser>`
+		it can often be desirable to protect single and double quotes within curly braces.
+		To enable this, set the ``protect_braced_quotes`` class property to TRUE.
 
-Parameters
-----------
+		Usage example::
 
-There is one optional parameters that determines whether the parser
-should reduce more then two consecutive line breaks down to two. Use
-boolean TRUE or FALSE.
+			$this->load->library('typography');
+			$this->typography->protect_braced_quotes = TRUE;
 
-By default the parser does not reduce line breaks. In other words, if no
-parameters are submitted, it is the same as doing this::
+	.. method auto_typography($str[, $reduce_linebreaks = FALSE])
 
-	$string = $this->typography->auto_typography($string, FALSE);
+		:param string $str: input string
+		:param bool $reduce_linebreaks: whether to reduce consequitive linebreaks
+		:returns: string
 
-.. note:: Typographic formatting can be processor intensive,
-	particularly if you have a lot of content being formatted. If you choose
-	to use this function you may want to consider :doc:`caching <../general/caching>`
-	your pages.
+		Formats text so that it is semantically and typographically correct HTML.
+		Takes a string as input and returns it with the following formatting:
 
-format_characters()
-====================
+		 -  Surrounds paragraphs within <p></p> (looks for double line breaks to identify paragraphs).
+		 -  Single line breaks are converted to <br />, except those that appear within <pre> tags.
+		 -  Block level elements, like <div> tags, are not wrapped within paragraphs, but their contained text is if it contains paragraphs.
+		 -  Quotes are converted to correctly facing curly quote entities, except those that appear within tags.
+		 -  Apostrophes are converted to curly apostrophe entities.
+		 -  Double dashes (either like -- this or like--this) are converted to em—dashes.
+		 -  Three consecutive periods either preceding or following a word are converted to ellipsis (…).
+		 -  Double spaces following sentences are converted to non-breaking spaces to mimic double spacing.
 
-This function is similar to the auto_typography function above, except
-that it only does character conversion:
+		Usage example::
 
--  Quotes are converted to correctly facing curly quote entities, except
-   those that appear within tags.
--  Apostrophes are converted to curly apostrophe entities.
--  Double dashes (either like -- this or like--this) are converted to
-   em—dashes.
--  Three consecutive periods either preceding or following a word are
-   converted to ellipsis…
--  Double spaces following sentences are converted to non-breaking
-   spaces to mimic double spacing.
+			$string = $this->typography->auto_typography($string);
 
-Usage example::
+		There is one optional parameter that determines whether the parser should reduce more then two consecutive line breaks down to two.
+		Pass boolean TRUE to enable reducing line breaks::
 
-	$string = $this->typography->format_characters($string);
+			$string = $this->typography->auto_typography($string, TRUE);
 
-nl2br_except_pre()
-====================
+		.. note:: Typographic formatting can be processor intensive, particularly if you have a lot of content being formatted.
+			If you choose to use this method you may want to consider :doc:`caching <../general/caching>` your pages.
 
-Converts newlines to <br /> tags unless they appear within <pre> tags.
-This function is identical to the native PHP nl2br() function, except
-that it ignores <pre> tags.
+	.. method:: format_characters($str)
 
-Usage example::
+		:param string $str: input string
+		:returns: string
 
-	$string = $this->typography->nl2br_except_pre($string);
+		This method is similar to ``auto_typography()`` above, except that it only does character conversion:
 
-protect_braced_quotes
-=======================
+		 -  Quotes are converted to correctly facing curly quote entities, except those that appear within tags.
+		 -  Apostrophes are converted to curly apostrophe entities.
+		 -  Double dashes (either like -- this or like--this) are converted to em—dashes.
+		 -  Three consecutive periods either preceding or following a word are converted to ellipsis (…).
+		 -  Double spaces following sentences are converted to non-breaking spaces to mimic double spacing.
 
-When using the Typography library in conjunction with the Template
-Parser library it can often be desirable to protect single and double
-quotes within curly braces. To enable this, set the
-protect_braced_quotes class property to TRUE.
+		Usage example::
 
-Usage example::
+			$string = $this->typography->format_characters($string);
 
-	$this->load->library('typography');
-	$this->typography->protect_braced_quotes = TRUE;
+	.. method:: nl2br_except_pre($str)
+
+		:param string $str: input string
+		:returns: string
+
+		Converts newlines to <br /> tags unless they appear within <pre> tags.
+		This method is identical to the native PHP :php:func:`nl2br()` function, except that it ignores <pre> tags.
+
+		Usage example::
 
+			$string = $this->typography->nl2br_except_pre($string);
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 9ea31e823af8cfe73154d4e262331623a2f1ded5 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Mon, 23 Sep 2013 17:20:56 +0300
Subject: [ci skip] Update the Trackback library docs

---
 user_guide_src/source/libraries/trackback.rst | 215 ++++++++++++++++++++------
 1 file changed, 171 insertions(+), 44 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/trackback.rst b/user_guide_src/source/libraries/trackback.rst
index f9e0df882..72958934c 100644
--- a/user_guide_src/source/libraries/trackback.rst
+++ b/user_guide_src/source/libraries/trackback.rst
@@ -8,16 +8,28 @@ receive Trackback data.
 If you are not familiar with Trackbacks you'll find more information
 `here <http://en.wikipedia.org/wiki/Trackback>`_.
 
+.. content::
+	:local:
+
+.. raw:: html
+
+	<div class="custom-index container"></div>
+
+*************************
+Using the Trackback Class
+*************************
+
 Initializing the Class
 ======================
 
 Like most other classes in CodeIgniter, the Trackback class is
-initialized in your controller using the $this->load->library function::
+initialized in your controller using the ``$this->load->library()`` method::
 
 	$this->load->library('trackback');
 
-Once loaded, the Trackback library object will be available using:
-$this->trackback
+Once loaded, the Trackback library object will be available using::
+
+	$this->trackback
 
 Sending Trackbacks
 ==================
@@ -28,38 +40,36 @@ similar to this example::
 	$this->load->library('trackback');
 
 	$tb_data = array(
-	                'ping_url'  => 'http://example.com/trackback/456',
-	                'url'       => 'http://www.my-example.com/blog/entry/123',
-	                'title'     => 'The Title of My Entry',
-	                'excerpt'   => 'The entry content.',
-	                'blog_name' => 'My Blog Name',
-	                'charset'   => 'utf-8'
-	                );
+		'ping_url'  => 'http://example.com/trackback/456',
+		'url'       => 'http://www.my-example.com/blog/entry/123',
+		'title'     => 'The Title of My Entry',
+		'excerpt'   => 'The entry content.',
+		'blog_name' => 'My Blog Name',
+		'charset'   => 'utf-8'
+	);
 
 	if ( ! $this->trackback->send($tb_data))
 	{
-	     echo $this->trackback->display_errors();
+		echo $this->trackback->display_errors();
 	}
 	else
 	{
-	     echo 'Trackback was sent!';
+		echo 'Trackback was sent!';
 	}
 
 Description of array data:
 
 -  **ping_url** - The URL of the site you are sending the Trackback to.
-   You can send Trackbacks to multiple URLs by separating each URL with
-   a comma.
+   You can send Trackbacks to multiple URLs by separating each URL with a comma.
 -  **url** - The URL to YOUR site where the weblog entry can be seen.
 -  **title** - The title of your weblog entry.
--  **excerpt** - The content of your weblog entry. Note: the Trackback
-   class will automatically send only the first 500 characters of your
-   entry. It will also strip all HTML.
+-  **excerpt** - The content of your weblog entry.
+   .. note:: the Trackback class will automatically send only the first 500 characters of your
+  	entry. It will also strip all HTML.
 -  **blog_name** - The name of your weblog.
--  **charset** - The character encoding your weblog is written in. If
-   omitted, UTF-8 will be used.
+-  **charset** - The character encoding your weblog is written in. If omitted, UTF-8 will be used.
 
-The Trackback sending function returns TRUE/FALSE (boolean) on success
+The Trackback sending method returns TRUE/FALSE (boolean) on success
 or failure. If it fails, you can retrieve the error message using::
 
 	$this->trackback->display_errors();
@@ -107,16 +117,16 @@ Before you can receive Trackbacks you must create a table in which to
 store them. Here is a basic prototype for such a table::
 
 	CREATE TABLE trackbacks (
-	 tb_id int(10) unsigned NOT NULL auto_increment,
-	 entry_id int(10) unsigned NOT NULL default 0,
-	 url varchar(200) NOT NULL,
-	 title varchar(100) NOT NULL,
-	 excerpt text NOT NULL,
-	 blog_name varchar(100) NOT NULL,
-	 tb_date int(10) NOT NULL,
-	 ip_address varchar(45) NOT NULL,
-	 PRIMARY KEY `tb_id` (`tb_id`),
-	 KEY `entry_id` (`entry_id`)
+		tb_id int(10) unsigned NOT NULL auto_increment,
+		entry_id int(10) unsigned NOT NULL default 0,
+		url varchar(200) NOT NULL,
+		title varchar(100) NOT NULL,
+		excerpt text NOT NULL,
+		blog_name varchar(100) NOT NULL,
+		tb_date int(10) NOT NULL,
+		ip_address varchar(45) NOT NULL,
+		PRIMARY KEY `tb_id` (`tb_id`),
+		KEY `entry_id` (`entry_id`)
 	);
 
 The Trackback specification only requires four pieces of information to
@@ -129,33 +139,31 @@ Processing a Trackback
 
 Here is an example showing how you will receive and process a Trackback.
 The following code is intended for use within the controller function
-where you expect to receive Trackbacks.
-
-::
+where you expect to receive Trackbacks.::
 
 	$this->load->library('trackback');
 	$this->load->database();
 
 	if ($this->uri->segment(3) == FALSE)
 	{
-	    $this->trackback->send_error("Unable to determine the entry ID");
+		$this->trackback->send_error('Unable to determine the entry ID');
 	}
 
 	if ( ! $this->trackback->receive())
 	{
-	    $this->trackback->send_error("The Trackback did not contain valid data");
+		$this->trackback->send_error('The Trackback did not contain valid data');
 	}
 
 	$data = array(
-	                'tb_id'      => '',
-	                'entry_id'   => $this->uri->segment(3),
-	                'url'        => $this->trackback->data('url'),
-	                'title'      => $this->trackback->data('title'),
-	                'excerpt'    => $this->trackback->data('excerpt'),
-	                'blog_name'  => $this->trackback->data('blog_name'),
-	                'tb_date'    => time(),
-	                'ip_address' => $this->input->ip_address()
-	                );
+		'tb_id'      => '',
+		'entry_id'   => $this->uri->segment(3),
+		'url'        => $this->trackback->data('url'),
+		'title'      => $this->trackback->data('title'),
+		'excerpt'    => $this->trackback->data('excerpt'),
+		'blog_name'  => $this->trackback->data('blog_name'),
+		'tb_date'    => time(),
+		'ip_address' => $this->input->ip_address()
+	);
 
 	$sql = $this->db->insert_string('trackbacks', $data);
 	$this->db->query($sql);
@@ -199,3 +207,122 @@ message using::
 
 .. note:: The above code contains no data validation, which you are
 	encouraged to add.
+
+***************
+Class Reference
+***************
+
+.. class:: CI_Trackback
+
+	.. attribute:: $data = array('url' => '', 'title' => '', 'excerpt' => '', 'blog_name' => '', 'charset' => '')
+
+		Trackback data array.
+
+	.. attribute:: $convert_ascii = TRUE
+
+		Whether to convert high ASCII and MS Word characters to HTML entities.
+
+	.. method:: send($tb_data)
+
+		:param array $tb_data: trackback data
+		:returns: bool
+
+		Send trackback.
+
+	.. method:: receive()
+
+		:returns: bool
+
+		This method simply validates the incoming TB data, returning TRUE on success and FALSE on failure.
+		If the data is valid it is set to the ``$this->data`` array so that it can be inserted into a database.
+
+	.. method:: send_error([$message = 'Incomplete information')
+
+		:param string $message: error message
+		:returns: void
+
+		Responses to a trackback request with an error message.
+
+		.. note:: This method will terminate script execution.
+
+	.. method:: send_success()
+
+		:returns: void
+
+		Responses to a trackback request with a success message.
+
+		.. note:: This method will terminate script execution.
+
+	.. method:: data($item)
+
+		:param string $item: data key
+		:returns: string
+
+		Returns a single item from the reponse data array.
+
+	.. method:: process($url, $data)
+
+		:param string $url: target url
+		:param string $data: raw post data
+		:returns: bool
+
+		Opens a socket connection and passes the data to the server, returning TRUE on success and FALSE on failure.
+
+	.. method:: extract_urls($urls)
+
+		:param string $urls: comma-separated url list
+		:returns: string
+
+		This method lets multiple trackbacks to be sent. It takes a string of URLs (separated by comma or space) and puts each URL into an array.
+
+	.. method:: validate_url(&$url)
+
+		:param string $url: trackback url
+		:returns: void
+
+		Simply adds the *http://* prefix it it's not already present in the URL.
+
+	.. method:: get_id($url)
+
+		:param string $url: trackback url
+		:returns: string
+
+		Find and return a trackback URL's ID or FALSE on failure.
+
+	.. method:: convert_xml($str)
+
+		:param string $str: input string
+		:returns: string
+
+		Converts reserved XML characters to entities.
+
+	.. method:: limit_characters($str[, $n = 500[, $end_char = '&#8230;']])
+
+		:param string $str: input string
+		:param int $n: max characters number
+		:param string $end_char: character to put at end of string
+		:returns: string
+
+		Limits the string based on the character count. Will preserve complete words.
+
+	.. method:: convert_ascii($str)
+
+		:param string $str: input string
+		:returns: string
+
+		Converts high ASCII text and MS Word special characterss to HTML entities.
+
+	.. method:: set_error($msg)
+
+		:param string $msg: error message
+		:returns: void
+
+		Set an log an error message.
+
+	.. method:: display_errors([$open = '<p>'[, $close = '</p>']])
+
+		:param string $open: open tag
+		:param string $close: close tag
+		:returns: string
+
+		Returns error messages formatted in HTML or an empty string if there are no errors.
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 0ee2a6333a8b987fd85c6bd6018fdd95906277ac Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Mon, 23 Sep 2013 18:55:38 +0300
Subject: [ci skip] Update the Table library docs

---
 user_guide_src/source/libraries/table.rst | 272 ++++++++++++++++--------------
 1 file changed, 143 insertions(+), 129 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/table.rst b/user_guide_src/source/libraries/table.rst
index 6a808abc2..25927800e 100644
--- a/user_guide_src/source/libraries/table.rst
+++ b/user_guide_src/source/libraries/table.rst
@@ -5,48 +5,60 @@ HTML Table Class
 The Table Class provides functions that enable you to auto-generate HTML
 tables from arrays or database result sets.
 
+.. content::
+	:local:
+
+.. raw:: html
+
+	<div class="custom-index container"></div>
+
+*********************
+Using the Table Class
+*********************
+
 Initializing the Class
 ======================
 
 Like most other classes in CodeIgniter, the Table class is initialized
-in your controller using the $this->load->library function::
+in your controller using the ``$this->load->library()`` method::
 
 	$this->load->library('table');
 
-Once loaded, the Table library object will be available using:
-$this->table
+Once loaded, the Table library object will be available using::
+
+	$this->table
 
 Examples
 ========
 
 Here is an example showing how you can create a table from a
 multi-dimensional array. Note that the first array index will become the
-table heading (or you can set your own headings using the set_heading()
-function described in the function reference below).
+table heading (or you can set your own headings using the ``set_heading()``
+method described in the function reference below).
 
 ::
 
 	$this->load->library('table');
 
 	$data = array(
-	             array('Name', 'Color', 'Size'),
-	             array('Fred', 'Blue', 'Small'),
-	             array('Mary', 'Red', 'Large'),
-	             array('John', 'Green', 'Medium')	
-	             );
+		array('Name', 'Color', 'Size'),
+		array('Fred', 'Blue', 'Small'),
+		array('Mary', 'Red', 'Large'),
+		array('John', 'Green', 'Medium')	
+	);
 
 	echo $this->table->generate($data);
 
 Here is an example of a table created from a database query result. The
 table class will automatically generate the headings based on the table
-names (or you can set your own headings using the set_heading()
-function described in the function reference below).
+names (or you can set your own headings using the ``set_heading()``
+method described in the class reference below).
 
 ::
 
 	$this->load->library('table');
 
-	$query = $this->db->query("SELECT * FROM my_table");
+	$query = $this->db->query('SELECT * FROM my_table');
 
 	echo $this->table->generate($query);
 
@@ -82,28 +94,28 @@ Changing the Look of Your Table
 The Table Class permits you to set a table template with which you can
 specify the design of your layout. Here is the template prototype::
 
-	$tmpl = array (
-	                    'table_open'          => '<table border="0" cellpadding="4" cellspacing="0">',
+	$template = array(
+		'table_open'          => '<table border="0" cellpadding="4" cellspacing="0">',
 
-	                    'heading_row_start'   => '<tr>',
-	                    'heading_row_end'     => '</tr>',
-	                    'heading_cell_start'  => '<th>',
-	                    'heading_cell_end'    => '</th>',
+		'heading_row_start'   => '<tr>',
+		'heading_row_end'     => '</tr>',
+		'heading_cell_start'  => '<th>',
+		'heading_cell_end'    => '</th>',
 
-	                    'row_start'           => '<tr>',
-	                    'row_end'             => '</tr>',
-	                    'cell_start'          => '<td>',
-	                    'cell_end'            => '</td>',
+		'row_start'           => '<tr>',
+		'row_end'             => '</tr>',
+		'cell_start'          => '<td>',
+		'cell_end'            => '</td>',
 
-	                    'row_alt_start'       => '<tr>',
-	                    'row_alt_end'         => '</tr>',
-	                    'cell_alt_start'      => '<td>',
-	                    'cell_alt_end'        => '</td>',
+		'row_alt_start'       => '<tr>',
+		'row_alt_end'         => '</tr>',
+		'cell_alt_start'      => '<td>',
+		'cell_alt_end'        => '</td>',
 
-	                    'table_close'         => '</table>'
-	              );
+		'table_close'         => '</table>'
+	);
 
-	$this->table->set_template($tmpl);
+	$this->table->set_template($template);
 
 .. note:: You'll notice there are two sets of "row" blocks in the
 	template. These permit you to create alternating row colors or design
@@ -113,157 +125,159 @@ You are NOT required to submit a complete template. If you only need to
 change parts of the layout you can simply submit those elements. In this
 example, only the table opening tag is being changed::
 
-	$tmpl = array ( 'table_open'  => '<table border="1" cellpadding="2" cellspacing="1" class="mytable">' );
+	$template = array(
+		'table_open' => '<table border="1" cellpadding="2" cellspacing="1" class="mytable">'
+	);
 
-	$this->table->set_template($tmpl);
+	$this->table->set_template($template);
 	
 You can also set defaults for these in a config file.
 
-******************
-Function Reference
-******************
+***************
+Class Reference
+***************
 
-$this->table->generate()
-========================
+.. class:: CI_Table
 
-Returns a string containing the generated table. Accepts an optional
-parameter which can be an array or a database result object.
+	.. attribute:: $function = FALSE
 
-$this->table->set_caption()
-============================
+		Allows you to specify a native PHP function or a valid function array object to be applied to all cell data.
+		::
 
-Permits you to add a caption to the table.
+			$this->load->library('table');
 
-::
+			$this->table->set_heading('Name', 'Color', 'Size');
+			$this->table->add_row('Fred', '<strong>Blue</strong>', 'Small');
 
-	$this->table->set_caption('Colors');
+			$this->table->function = 'htmlspecialchars';
+			echo $this->table->generate();
 
-$this->table->set_heading()
-============================
+		In the above example, all cell data would be ran through PHP's :php:func:`htmlspecialchars()` function, resulting in::
 
-Permits you to set the table heading. You can submit an array or
-discrete params::
+			<td>Fred</td><td>&lt;strong&gt;Blue&lt;/strong&gt;</td><td>Small</td>
 
-	$this->table->set_heading('Name', 'Color', 'Size');
+	.. method:: generate([$table_data = NULL])
 
-::
+		:param mixed $table_data: data to populate the table rows with
+		:returns: string
 
-	$this->table->set_heading(array('Name', 'Color', 'Size'));
+		Returns a string containing the generated table. Accepts an optional parameter which can be an array or a database result object.
 
-$this->table->add_row()
-========================
+	.. method:: set_caption($caption)
 
-Permits you to add a row to your table. You can submit an array or
-discrete params::
+		:param string $caption: table caption
+		:returns: void
 
-	$this->table->add_row('Blue', 'Red', 'Green');
+		Permits you to add a caption to the table.
+		::
 
-::
+			$this->table->set_caption('Colors');
 
-	$this->table->add_row(array('Blue', 'Red', 'Green'));
+	.. method:: set_heading([$args = array()[, ...]])
 
-If you would like to set an individual cell's tag attributes, you can
-use an associative array for that cell. The associative key 'data'
-defines the cell's data. Any other key => val pairs are added as
-key='val' attributes to the tag::
+		:param mixed $args: an array or multiple strings containing the table column titles
+		:returns: void
 
-	$cell = array('data' => 'Blue', 'class' => 'highlight', 'colspan' => 2);
-	$this->table->add_row($cell, 'Red', 'Green');
+		Permits you to set the table heading. You can submit an array or discrete params::
 
-	// generates
-	// <td class='highlight' colspan='2'>Blue</td><td>Red</td><td>Green</td>
+			$this->table->set_heading('Name', 'Color', 'Size');
 
-$this->table->make_columns()
-=============================
+			$this->table->set_heading(array('Name', 'Color', 'Size'));
 
-This function takes a one-dimensional array as input and creates a
-multi-dimensional array with a depth equal to the number of columns
-desired. This allows a single array with many elements to be displayed
-in a table that has a fixed column count. Consider this example::
+	.. method:: add_row([$args = array()[, ...]])
 
-	$list = array('one', 'two', 'three', 'four', 'five', 'six', 'seven', 'eight', 'nine', 'ten', 'eleven', 'twelve');
+		:param mixed $args: an array or multiple strings containing the row values
+		:returns: void
 
-	$new_list = $this->table->make_columns($list, 3);
+		Permits you to add a row to your table. You can submit an array or discrete params::
 
-	$this->table->generate($new_list);
+			$this->table->add_row('Blue', 'Red', 'Green');
 
-	// Generates a table with this prototype
+			$this->table->add_row(array('Blue', 'Red', 'Green'));
 
-	<table border="0" cellpadding="4" cellspacing="0">
-	<tr>
-	<td>one</td><td>two</td><td>three</td>
-	</tr><tr>
-	<td>four</td><td>five</td><td>six</td>
-	</tr><tr>
-	<td>seven</td><td>eight</td><td>nine</td>
-	</tr><tr>
-	<td>ten</td><td>eleven</td><td>twelve</td></tr>
-	</table>
+		If you would like to set an individual cell's tag attributes, you can use an associative array for that cell.
+		The associative key **data** defines the cell's data. Any other key => val pairs are added as key='val' attributes to the tag::
 
-$this->table->set_template()
-=============================
+			$cell = array('data' => 'Blue', 'class' => 'highlight', 'colspan' => 2);
+			$this->table->add_row($cell, 'Red', 'Green');
 
-Permits you to set your template. You can submit a full or partial
-template.
+			// generates
+			// <td class='highlight' colspan='2'>Blue</td><td>Red</td><td>Green</td>
 
-::
+	.. method:: make_columns([$array = array()[, $col_limit = 0]])
 
-	$tmpl = array ( 'table_open'  => '<table border="1" cellpadding="2" cellspacing="1" class="mytable">' );
+		:param array $array: an array containing multiple rows' data
+		:param int $col_limit: count of columns in the table
+		:returns: array
 
-	$this->table->set_template($tmpl);
+		This method takes a one-dimensional array as input and creates a multi-dimensional array with a depth equal to the number of columns desired.
+		This allows a single array with many elements to be displayed in a table that has a fixed column count. Consider this example::
 
-$this->table->set_empty()
-==========================
+			$list = array('one', 'two', 'three', 'four', 'five', 'six', 'seven', 'eight', 'nine', 'ten', 'eleven', 'twelve');
 
-Let's you set a default value for use in any table cells that are empty.
-You might, for example, set a non-breaking space::
+			$new_list = $this->table->make_columns($list, 3);
 
-	 $this->table->set_empty("&nbsp;");
+			$this->table->generate($new_list);
 
-$this->table->clear()
-=====================
+			// Generates a table with this prototype
 
-Lets you clear the table heading and row data. If you need to show
-multiple tables with different data you should to call this function
-after each table has been generated to empty the previous table
-information. Example::
+			<table border="0" cellpadding="4" cellspacing="0">
+			<tr>
+			<td>one</td><td>two</td><td>three</td>
+			</tr><tr>
+			<td>four</td><td>five</td><td>six</td>
+			</tr><tr>
+			<td>seven</td><td>eight</td><td>nine</td>
+			</tr><tr>
+			<td>ten</td><td>eleven</td><td>twelve</td></tr>
+			</table>
 
-	$this->load->library('table');
 
-	$this->table->set_heading('Name', 'Color', 'Size');
-	$this->table->add_row('Fred', 'Blue', 'Small');
-	$this->table->add_row('Mary', 'Red', 'Large');
-	$this->table->add_row('John', 'Green', 'Medium');
+	.. method:: set_template($template)
 
-	echo $this->table->generate();
+		:param array $template: associative array containing template values
+		:returns: bool
 
-	$this->table->clear();
+		Permits you to set your template. You can submit a full or partial template.
+		::
 
-	$this->table->set_heading('Name', 'Day', 'Delivery');
-	$this->table->add_row('Fred', 'Wednesday', 'Express');
-	$this->table->add_row('Mary', 'Monday', 'Air');
-	$this->table->add_row('John', 'Saturday', 'Overnight');
+		$template = array(
+			'table_open'  => '<table border="1" cellpadding="2" cellspacing="1" class="mytable">'
+		);
 
-	echo $this->table->generate();
+		$this->table->set_template($template);
 
-$this->table->function
-======================
+	.. method:: set_empty($value)
 
-Allows you to specify a native PHP function or a valid function array
-object to be applied to all cell data.
+		:param mixed $value: value to put in empty cells
+		:returns: void
 
-::
+		Lets you set a default value for use in any table cells that are empty.
+		You might, for example, set a non-breaking space::
 
-	$this->load->library('table');
+			$this->table->set_empty("&nbsp;");
 
-	$this->table->set_heading('Name', 'Color', 'Size');
-	$this->table->add_row('Fred', '<strong>Blue</strong>', 'Small');
+	.. method:: clear()
 
-	$this->table->function = 'htmlspecialchars';
-	echo $this->table->generate();
+		:returns: void
+
+		Lets you clear the table heading and row data. If you need to show multiple tables with different data you should to call this method
+		after each table has been generated to clear the previous table information. Example::
+
+			$this->load->library('table');
+
+			$this->table->set_heading('Name', 'Color', 'Size');
+			$this->table->add_row('Fred', 'Blue', 'Small');
+			$this->table->add_row('Mary', 'Red', 'Large');
+			$this->table->add_row('John', 'Green', 'Medium');
+
+			echo $this->table->generate();
 
-In the above example, all cell data would be ran through PHP's
-htmlspecialchars() function, resulting in::
+			$this->table->clear();
 
-	<td>Fred</td><td>&lt;strong&gt;Blue&lt;/strong&gt;</td><td>Small</td>
+			$this->table->set_heading('Name', 'Day', 'Delivery');
+			$this->table->add_row('Fred', 'Wednesday', 'Express');
+			$this->table->add_row('Mary', 'Monday', 'Air');
+			$this->table->add_row('John', 'Saturday', 'Overnight');
 
+			echo $this->table->generate();
-- 
cgit v1.2.3-24-g4f1b


From 871d8f67611d94e2662dd0ac6e06b96accc954e6 Mon Sep 17 00:00:00 2001
From: Jesse van Assen <jesse.v.assen@gmail.com>
Date: Fri, 27 Sep 2013 12:04:37 +0200
Subject: Added changelog entry.

---
 user_guide_src/source/changelog.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 2adbca19d..f5e2da738 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -501,6 +501,7 @@ Bug fixes for 3.0
 -  Fixed a bug (#2380) - :doc:`URI Routing <general/routing>` method ``fetch_method()`` returned 'index' if the requested method name matches its controller name.
 -  Fixed a bug (#2388) - :doc:`Email Library <libraries/email>` used to ignore attachment errors, resulting in broken emails being sent.
 -  Fixed a bug (#2498) - :doc:`Form Validation Library <libraries/form_validation>` rule **valid_base64** only checked characters instead of actual validity.
+-  Fixed a bug (#2515) - The script now halts when a fatal error occurs, instead of continuing.
 
 Version 2.1.3
 =============
-- 
cgit v1.2.3-24-g4f1b


From 5d4131b2d8a156e0793a185987292c35a898e332 Mon Sep 17 00:00:00 2001
From: Michael <michael@webstart.bg>
Date: Mon, 30 Sep 2013 12:22:29 +0300
Subject: Update the Session library docs

Signed-off-by: Michael <michael@webstart.bg>
---
 user_guide_src/source/libraries/sessions.rst | 65 +++++++++++++++-------------
 1 file changed, 34 insertions(+), 31 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/sessions.rst b/user_guide_src/source/libraries/sessions.rst
index 36c7c1d32..51bcc8022 100644
--- a/user_guide_src/source/libraries/sessions.rst
+++ b/user_guide_src/source/libraries/sessions.rst
@@ -21,11 +21,12 @@ initializing the class will cause it to read, create, and update
 sessions.
 
 To initialize the Session class manually in your controller constructor,
-use the $this->load->driver function::
+use the ``$this->load->driver`` function::
 
 	$this->load->driver('session');
 
-Once loaded, the Sessions library object will be available using:
+Once loaded, the Sessions library object will be available using::
+
 $this->session
 
 How do Sessions work?
@@ -49,23 +50,23 @@ What is Session Data?
 A *session*, as far as CodeIgniter is concerned, is simply an array
 containing the following information:
 
--  The user's unique Session ID (this is a statistically random string
+*  The user's unique Session ID (this is a statistically random string
    with very strong entropy, hashed with MD5 for portability, and
    regenerated (by default) every five minutes)
--  The user's IP Address
--  The user's User Agent data (the first 120 characters of the browser
+*  The user's IP Address
+*  The user's User Agent data (the first 120 characters of the browser
    data string)
--  The "last activity" time stamp.
+*  The "last activity" time stamp.
 
 The above data is stored in a cookie as a serialized array with this
 prototype::
 
 	[array]
 	(
-	     'session_id'    => random hash,
-	     'ip_address'    => 'string - user IP address',
-	     'user_agent'    => 'string - user agent data',
-	     'last_activity' => timestamp
+		'session_id'    => random hash,
+		'ip_address'    => 'string - user IP address',
+		'user_agent'    => 'string - user agent data',
+		'last_activity' => timestamp
 	)
 
 .. note:: Sessions are only updated every five minutes by default to
@@ -112,21 +113,21 @@ Where $array is an associative array containing your new data. Here's an
 example::
 
 	$newdata = array(
-	                   'username'  => 'johndoe',
-	                   'email'     => 'johndoe@some-site.com',
-	                   'logged_in' => TRUE
-	               );
+		'username'  => 'johndoe',
+		'email'     => 'johndoe@some-site.com',
+		'logged_in' => TRUE
+	);
 
 	$this->session->set_userdata($newdata);
 
-If you want to add userdata one value at a time, set_userdata() also
+If you want to add userdata one value at a time, ``set_userdata()`` also
 supports this syntax.
 
 ::
 
 	$this->session->set_userdata('some_name', 'some_value');
 
-If you want to verify that a userdata value exists, call has_userdata().
+If you want to verify that a userdata value exists, call ``has_userdata()``.
 
 ::
 
@@ -143,10 +144,10 @@ And returns an associative array like the following::
 
 	Array
 	(
-	    [session_id] => 4a5a5dca22728fb0a84364eeb405b601
-	    [ip_address] => 127.0.0.1
-	    [user_agent] => Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_7;
-	    [last_activity] => 1303142623
+		[session_id] => 4a5a5dca22728fb0a84364eeb405b601
+		[ip_address] => 127.0.0.1
+		[user_agent] => Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_7;
+		[last_activity] => 1303142623
 	)
 
 Removing Session Data
@@ -185,8 +186,8 @@ To add flashdata::
 	$this->session->set_flashdata('item', 'value');
 
 
-You can also pass an array to set_flashdata(), in the same manner as
-set_userdata().
+You can also pass an array to ``set_flashdata()``, in the same manner as
+``set_userdata()``.
 
 To read a flashdata variable::
 
@@ -198,7 +199,7 @@ An array of all flashdata can be retrieved as follows::
 
 
 If you find that you need to preserve a flashdata variable through an
-additional request, you can do so using the keep_flashdata() function.
+additional request, you can do so using the ``keep_flashdata()`` function.
 You can either pass a single item or an array of flashdata items to keep.
 
 ::
@@ -206,6 +207,8 @@ You can either pass a single item or an array of flashdata items to keep.
 	$this->session->keep_flashdata('item');
 	$this->session->keep_flashdata(array('item1', 'item2', 'item3'));
 
+.. note:: The function will return NULL if the item cannot be found.
+
 Tempdata
 ========
 
@@ -219,7 +222,7 @@ To add tempdata::
 
 	$this->session->set_tempdata('item', 'value', $expire);
 
-You can also pass an array to set_tempdata()::
+You can also pass an array to ``set_tempdata()``::
 
 	$tempdata = array('newuser' => TRUE, 'message' => 'Thanks for joining!');
 
@@ -233,7 +236,7 @@ To read a tempdata variable::
 	$this->session->tempdata('item');
 
 If you need to remove a tempdata value before it expires,
-use unset_tempdata()::
+use ``unset_tempdata()``::
 
 	$this->session->unset_tempdata('item');
 
@@ -246,7 +249,7 @@ To clear the current session::
 
 .. note:: This function should be the last one called, and even flash
 	variables will no longer be available. If you only want some items
-	destroyed and not all, use unset_userdata().
+	destroyed and not all, use ``unset_userdata()``.
 
 Session Preferences
 ===================
@@ -303,7 +306,7 @@ installed, and `Custom Drivers`_ may also be installed by the user.
 Typically, only one driver will be used at a time, but CodeIgniter does
 support loading multiple drivers. If a specific valid driver is called, it
 will be automatically loaded. Or, an additional driver may be explicitly
-loaded by calling load_driver()::
+loaded by ``calling load_driver()``::
 
 	$this->session->load_driver('native');
 
@@ -328,7 +331,7 @@ the call to unset the *native* 'foo' value. The drivers maintain independent
 sets of values, regardless of key names.
 
 A specific driver may also be explicitly selected for use by pursuant
-methods with the select_driver() call::
+methods with the ``select_driver()`` call::
 
 	$this->session->select_driver('native');
 
@@ -422,7 +425,7 @@ You may also :doc:`create your own <../general/creating_drivers>` custom
 session drivers. A session driver basically manages an array of name/value
 pairs with some sort of storage mechanism.
 
-To make a new driver, extend CI_Session_driver. Overload the initialize()
+To make a new driver, extend CI_Session_driver. Overload the ``initialize()``
 method and read or create session data. Then implement a save handler to
 write changed data to storage (sess_save), a destroy handler to remove
 deleted data (sess_destroy), a regenerate handler to make a new session ID
@@ -456,13 +459,13 @@ Your initial class might look like::
 		}
 	}
 
-Notice that get_userdata() returns a reference so the parent library is
+Notice that ``get_userdata()`` returns a reference so the parent library is
 accessing the same array the driver object is using. This saves memory
 and avoids synchronization issues during usage.
 
 Put your driver in the libraries/Session/drivers folder anywhere in your
 package paths. This includes the application directory, the system directory,
-or any path you add with $CI->load->add_package_path(). Your driver must be
+or any path you add with ``$CI->load->add_package_path()``. Your driver must be
 named CI_Session_<name>, and your filename must be Session_<name>.php,
 preferably also capitalized, such as::
 
-- 
cgit v1.2.3-24-g4f1b


From 1c7438f08bf289c08d5d1c466316850831b9b0ed Mon Sep 17 00:00:00 2001
From: Michael <michael@webstart.bg>
Date: Sun, 6 Oct 2013 15:21:21 +0300
Subject: Added class reference to the session docs

Signed-off-by: Michael <michael@webstart.bg>
---
 user_guide_src/source/libraries/sessions.rst | 193 ++++++++++++++++++++++++++-
 1 file changed, 189 insertions(+), 4 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/sessions.rst b/user_guide_src/source/libraries/sessions.rst
index 51bcc8022..3dc067a70 100644
--- a/user_guide_src/source/libraries/sessions.rst
+++ b/user_guide_src/source/libraries/sessions.rst
@@ -50,13 +50,13 @@ What is Session Data?
 A *session*, as far as CodeIgniter is concerned, is simply an array
 containing the following information:
 
-*  The user's unique Session ID (this is a statistically random string
+-  The user's unique Session ID (this is a statistically random string
    with very strong entropy, hashed with MD5 for portability, and
    regenerated (by default) every five minutes)
-*  The user's IP Address
-*  The user's User Agent data (the first 120 characters of the browser
+-  The user's IP Address
+-  The user's User Agent data (the first 120 characters of the browser
    data string)
-*  The "last activity" time stamp.
+-  The "last activity" time stamp.
 
 The above data is stored in a cookie as a serialized array with this
 prototype::
@@ -486,3 +486,188 @@ without making it the initially loaded driver, set 'sess_valid_drivers' in
 your config.php file to an array including your driver name::
 
 	$config['sess_valid_drivers'] = array('sess_driver');
+
+
+
+***************
+Class Reference
+***************
+
+.. class:: CI_Session
+
+Userdata
+--------
+
+	.. method:: set_userdata($newdata = array(), $newval)
+
+		:param mixed $newdata: Item name or array of items
+		:param mixed $newval: Item value or empty string (not required if $newdata is array)
+		:returns: void
+
+		Sets items into session example usages::
+
+			$this->session->set_userdata('user', 'example@example.com');
+			// adds item user with value example@example.com to the session
+
+			$this->session->set_userdata(array('user'=>'example@example.com'));
+			// does the same as the above example - adds item user with value example@example.com to the session
+
+	.. method:: userdata($item)
+
+		:param string $item: name of session item
+		:returns: string
+
+		Returns a string containing the value of the passed item or NULL if the item is not found. Example::
+
+			$this->session->userdata('user');
+			//returns example@example.com considering the set_userdata example.
+
+	.. method:: unset_userdata($item)
+
+		:param mixed $item: name of item or array of items
+		:returns: void
+
+		Unsets previously setted items from the session. Example::
+
+			$this->session->unset_userdata('user');
+			//unsets 'user' from session data.
+
+			$this->session->unset_userdata(array('user', 'useremail'));
+			//unsets both 'user' nad 'useremail' from the session data.
+
+	.. method:: has_userdata($item)
+
+		:param string $item: name of item
+		:returns: bool
+
+		Checks if an item exists in the session.
+
+	.. method:: all_userdata()
+
+		:returns: array
+
+		Retruns array of userdata session items
+
+
+
+Flashdata
+---------
+.. note:: the flashdata items are available only one server request
+
+	.. method:: set_flashdata($newdata = array(), $newval)
+
+		:param mixed $newdata: Item name or array of items
+		:param mixed $newval: Item value or empty string (not required if $newdata is array)
+		:returns: void
+
+		Sets items into session flashdata example usages::
+
+			$this->session->set_flashdata('message', 'Test message.');
+			// adds item 'message' with value 'Test message.' to the session flashdata
+
+			$this->session->set_flashdata(array('message'=>'Test message.'));
+			// does the same as the above example - adds item 'message' with value 'Test message.'
+			 to the session flashdata
+
+	.. method:: flashdata($item)
+
+		:param string $item: name of session item
+		:returns: string
+
+		Returns a string containing the value of the passed item or NULL if the item is not found. Example::
+
+			$this->session->flashdata('message');
+			//returns 'Test message.' considering the set_flashdata example.
+
+	.. method:: has_flashdata($item)
+
+		:param string $item: name of item
+		:returns: bool
+
+		Checks if an item exists in the session flashdata.
+
+	.. method:: all_flashdata()
+
+		:returns: array
+
+		Retruns array of flashdata session items
+
+	.. method:: keep_flashdata($item)
+
+		:param mixed $item: name of item or array of flashdata items
+		:returns: void
+
+		Keeps items into flashdata for one more request
+
+
+Tempdata
+--------
+
+	.. method:: set_tempdata($newdata = array(), $newval, $expires)
+
+		:param mixed $newdata: Item name or array of items
+		:param string $newval: Item value or empty string (not required if $newdata is array)
+		:param int $expires: lifetime in seconds (0 for default)
+		:returns: void
+
+		Sets items into session tempdata example::
+
+			$this->session->set_tempdata('message', 'Test message.', '60');
+			// adds item 'message' with value 'Test message.' to the session tempdata for 60 seconds
+
+			$this->session->set_tempdata(array('message'=>'Test message.'));
+			// does the same as the above example - adds item 'message' with value 'Test message.' 
+			to the session tempdata for the default value of
+
+	.. method:: tempdata($item)
+
+		:param string $item: name of tempdata item
+		:returns: string
+
+		Returns a string containing the value of the passed item or NULL if the item is not found. Example::
+
+			$this->session->tempdata('message');
+			//returns 'Test message.' considering the set_tempdata example.
+
+	.. method:: unset_tempdata($item)
+
+		:param mixed $item: name of item or array of items
+		:returns: void
+
+		Unsets previously setted items from the tempdata. Example::
+
+			$this->session->unset_tempdata('user');
+			//unsets 'user' from tempdata.
+
+			$this->session->unset_tempdata(array('user', 'useremail'));
+			//unsets both 'user' nad 'useremail' from the tempdata.
+
+Session
+-------
+
+	.. method:: sess_destroy()
+
+		Destroys current session
+		.. note:: This function should be the last one called, and even flash variables will no longer be available.
+		 If you only want some items destroyed and not all, use ``unset_userdata()``.
+
+	.. method:: sess_regenerate($destroy)
+
+		:param bool $destroy: Destroy session data flag (default: false)
+		:returns: void
+
+		Regenerate the current session data
+
+	.. method:: load_driver($driver)
+
+		:param string $driver: Driver name
+		:returns: object Loaded driver object
+
+		Loads a session storage driver
+
+	.. method:: select_driver($driver)
+
+		:param string $driver: Driver name
+		:returns: void
+
+		Selects default session storage driver.
-- 
cgit v1.2.3-24-g4f1b


From 8bb20a1ff7217c9f5125db49916da8a9b6574c19 Mon Sep 17 00:00:00 2001
From: Tomaz Lovrec <tomaz.lovrec@gmail.com>
Date: Wed, 16 Oct 2013 12:34:36 +0200
Subject: Fixed empty line at EOF and added changelog entry

---
 user_guide_src/source/changelog.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index a66fb265f..a76fcd784 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -57,6 +57,7 @@ Release Date: Not Released
    -  Removed *cheatsheets* and *quick_reference* PDFs from the documentation.
    -  Added availability checks where usage of dangerous functions like ``eval()`` and ``exec()`` is required.
    -  Added support for changing the file extension of log files using ``$config['log_file_extension']``.
+   -  Added possibility clear out the cached variables from the Loader.
 
 -  Helpers
 
-- 
cgit v1.2.3-24-g4f1b


From b69cbcb6844870af6f95fd7648c8533408b12eb6 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Wed, 16 Oct 2013 13:59:43 +0300
Subject: Changelog/doc edits following PR #2684

---
 user_guide_src/source/changelog.rst        | 2 +-
 user_guide_src/source/libraries/loader.rst | 5 +++++
 2 files changed, 6 insertions(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index a76fcd784..5774ff115 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -57,7 +57,6 @@ Release Date: Not Released
    -  Removed *cheatsheets* and *quick_reference* PDFs from the documentation.
    -  Added availability checks where usage of dangerous functions like ``eval()`` and ``exec()`` is required.
    -  Added support for changing the file extension of log files using ``$config['log_file_extension']``.
-   -  Added possibility clear out the cached variables from the Loader.
 
 -  Helpers
 
@@ -382,6 +381,7 @@ Release Date: Not Released
       -  Added support for model aliasing on autoload.
       -  Changed method ``is_loaded()`` to ask for the (case sensitive) library name instead of its instance name.
       -  Removed ``$_base_classes`` property and unified all class data in ``$_ci_classes`` instead.
+      -  Added method ``clear_vars()`` to allow clearing the cached variables for views.
 
    -  :doc:`Input Library <libraries/input>` changes include:
 
diff --git a/user_guide_src/source/libraries/loader.rst b/user_guide_src/source/libraries/loader.rst
index 19446a9c8..91db5afbd 100644
--- a/user_guide_src/source/libraries/loader.rst
+++ b/user_guide_src/source/libraries/loader.rst
@@ -234,6 +234,11 @@ $this->load->get_vars()
 
 This method retrieves all variables available to your views.
 
+$this->load->clear_vars()
+=========================
+
+Clears cached view variables.
+
 $this->load->helper('file_name')
 ================================
 
-- 
cgit v1.2.3-24-g4f1b


From abcb67c76ccb384ea213f9c4f42a392b15b3e15e Mon Sep 17 00:00:00 2001
From: David Cox Jr <DaveMC08@gmail.com>
Date: Wed, 16 Oct 2013 14:43:52 -0400
Subject: req. changes: cleaned up conditionals added changelog note regarding
 profiler updated as per styleguide

---
 user_guide_src/source/changelog.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index a66fb265f..052624076 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -351,6 +351,7 @@ Release Date: Not Released
       -  Database object names are now being displayed.
       -  The sum of all queries running times in seconds is now being displayed.
       -  Added support for displaying the HTTP DNT ("Do Not Track") header.
+      -  Added support for displaying $_FILES.
 
    -  :doc:`Migration Library <libraries/migration>` changes include:
 
-- 
cgit v1.2.3-24-g4f1b


From 3fa729d7092c814fe14e15d8d51789ce7907f2a8 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Fri, 18 Oct 2013 20:57:41 +0300
Subject: Fix issue #2681 (alternative to PR #2690)

---
 user_guide_src/source/changelog.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 8f5cffcb0..b5c00699a 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -618,6 +618,7 @@ Bug fixes for 3.0
 -  Fixed a bug (#2609) - :php:func:`get_config()` optional argument was only effective on first function call. Also, it can now add items, in addition to updating existing items.
 -  Fixed a bug in the 'postgre' :doc:`database <database/index>` driver where the connection ID wasn't passed to ``pg_escape_string()``.
 -  Fixed a bug (#33) - Script execution was terminated when an invalid cookie key was encountered.
+-  Fixed a bug (#2681) - `CI_Security::entity_decode()` used the `PREG_REPLACE_EVAL` flag, which is deprecated since PHP 5.5.
 
 Version 2.1.4
 =============
-- 
cgit v1.2.3-24-g4f1b


From a277a50f82dacaa129876160dadbda98fc9e33ca Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Fri, 18 Oct 2013 20:58:44 +0300
Subject: [ci skip] Fix a changelog entry

---
 user_guide_src/source/changelog.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index b5c00699a..8c992a575 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -618,7 +618,7 @@ Bug fixes for 3.0
 -  Fixed a bug (#2609) - :php:func:`get_config()` optional argument was only effective on first function call. Also, it can now add items, in addition to updating existing items.
 -  Fixed a bug in the 'postgre' :doc:`database <database/index>` driver where the connection ID wasn't passed to ``pg_escape_string()``.
 -  Fixed a bug (#33) - Script execution was terminated when an invalid cookie key was encountered.
--  Fixed a bug (#2681) - `CI_Security::entity_decode()` used the `PREG_REPLACE_EVAL` flag, which is deprecated since PHP 5.5.
+-  Fixed a bug (#2681) - ``CI_Security::entity_decode()`` used the `PREG_REPLACE_EVAL` flag, which is deprecated since PHP 5.5.
 
 Version 2.1.4
 =============
-- 
cgit v1.2.3-24-g4f1b


From e0a631c3353ea26483e3958306fb2b53d7558a21 Mon Sep 17 00:00:00 2001
From: Michael <michael@webstart.bg>
Date: Sun, 20 Oct 2013 10:40:51 +0300
Subject: refactored the class reference in session.rst to properly reflect the
 session class

Signed-off-by: Michael <michael@webstart.bg>
---
 user_guide_src/source/libraries/sessions.rst | 145 +++++++++++----------------
 1 file changed, 61 insertions(+), 84 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/sessions.rst b/user_guide_src/source/libraries/sessions.rst
index 3dc067a70..cab7669ae 100644
--- a/user_guide_src/source/libraries/sessions.rst
+++ b/user_guide_src/source/libraries/sessions.rst
@@ -495,22 +495,32 @@ Class Reference
 
 .. class:: CI_Session
 
-Userdata
---------
+	.. method:: load_driver($driver)
 
-	.. method:: set_userdata($newdata = array(), $newval)
+		:param string $driver: Driver name
+		:returns: object Loaded driver object
 
-		:param mixed $newdata: Item name or array of items
-		:param mixed $newval: Item value or empty string (not required if $newdata is array)
+		Loads a session storage driver
+
+	.. method:: select_driver($driver)
+
+		:param string $driver: Driver name
 		:returns: void
 
-		Sets items into session example usages::
+		Selects default session storage driver.
 
-			$this->session->set_userdata('user', 'example@example.com');
-			// adds item user with value example@example.com to the session
+	.. method:: sess_destroy()
 
-			$this->session->set_userdata(array('user'=>'example@example.com'));
-			// does the same as the above example - adds item user with value example@example.com to the session
+		Destroys current session
+		.. note:: This function should be the last one called, and even flash variables will no longer be available.
+		 If you only want some items destroyed and not all, use ``unset_userdata()``.
+
+	.. method:: sess_regenerate($destroy)
+
+		:param bool $destroy: Destroy session data flag (default: false)
+		:returns: void
+
+		Regenerate the current session data
 
 	.. method:: userdata($item)
 
@@ -522,6 +532,32 @@ Userdata
 			$this->session->userdata('user');
 			//returns example@example.com considering the set_userdata example.
 
+	.. method:: all_userdata()
+
+		:returns: array
+
+		Retruns array of userdata session items
+
+	.. method:: all_flashdata()
+
+		:returns: array
+
+		Retruns array of flashdata session items
+
+	.. method:: set_userdata($newdata = array(), $newval)
+
+		:param mixed $newdata: Item name or array of items
+		:param mixed $newval: Item value or empty string (not required if $newdata is array)
+		:returns: void
+
+		Sets items into session example usages::
+
+			$this->session->set_userdata('user', 'example@example.com');
+			// adds item user with value example@example.com to the session
+
+			$this->session->set_userdata(array('user'=>'example@example.com'));
+			// does the same as the above example - adds item user with value example@example.com to the session
+
 	.. method:: unset_userdata($item)
 
 		:param mixed $item: name of item or array of items
@@ -533,7 +569,7 @@ Userdata
 			//unsets 'user' from session data.
 
 			$this->session->unset_userdata(array('user', 'useremail'));
-			//unsets both 'user' nad 'useremail' from the session data.
+			//unsets both 'user' and 'useremail' from the session data.
 
 	.. method:: has_userdata($item)
 
@@ -542,18 +578,6 @@ Userdata
 
 		Checks if an item exists in the session.
 
-	.. method:: all_userdata()
-
-		:returns: array
-
-		Retruns array of userdata session items
-
-
-
-Flashdata
----------
-.. note:: the flashdata items are available only one server request
-
 	.. method:: set_flashdata($newdata = array(), $newval)
 
 		:param mixed $newdata: Item name or array of items
@@ -569,6 +593,13 @@ Flashdata
 			// does the same as the above example - adds item 'message' with value 'Test message.'
 			 to the session flashdata
 
+	.. method:: keep_flashdata($item)
+
+		:param mixed $item: name of item or array of flashdata items
+		:returns: void
+
+		Keeps items into flashdata for one more request
+
 	.. method:: flashdata($item)
 
 		:param string $item: name of session item
@@ -579,30 +610,6 @@ Flashdata
 			$this->session->flashdata('message');
 			//returns 'Test message.' considering the set_flashdata example.
 
-	.. method:: has_flashdata($item)
-
-		:param string $item: name of item
-		:returns: bool
-
-		Checks if an item exists in the session flashdata.
-
-	.. method:: all_flashdata()
-
-		:returns: array
-
-		Retruns array of flashdata session items
-
-	.. method:: keep_flashdata($item)
-
-		:param mixed $item: name of item or array of flashdata items
-		:returns: void
-
-		Keeps items into flashdata for one more request
-
-
-Tempdata
---------
-
 	.. method:: set_tempdata($newdata = array(), $newval, $expires)
 
 		:param mixed $newdata: Item name or array of items
@@ -619,16 +626,6 @@ Tempdata
 			// does the same as the above example - adds item 'message' with value 'Test message.' 
 			to the session tempdata for the default value of
 
-	.. method:: tempdata($item)
-
-		:param string $item: name of tempdata item
-		:returns: string
-
-		Returns a string containing the value of the passed item or NULL if the item is not found. Example::
-
-			$this->session->tempdata('message');
-			//returns 'Test message.' considering the set_tempdata example.
-
 	.. method:: unset_tempdata($item)
 
 		:param mixed $item: name of item or array of items
@@ -640,34 +637,14 @@ Tempdata
 			//unsets 'user' from tempdata.
 
 			$this->session->unset_tempdata(array('user', 'useremail'));
-			//unsets both 'user' nad 'useremail' from the tempdata.
-
-Session
--------
-
-	.. method:: sess_destroy()
-
-		Destroys current session
-		.. note:: This function should be the last one called, and even flash variables will no longer be available.
-		 If you only want some items destroyed and not all, use ``unset_userdata()``.
-
-	.. method:: sess_regenerate($destroy)
-
-		:param bool $destroy: Destroy session data flag (default: false)
-		:returns: void
-
-		Regenerate the current session data
+			//unsets both 'user' and 'useremail' from the tempdata.
 
-	.. method:: load_driver($driver)
-
-		:param string $driver: Driver name
-		:returns: object Loaded driver object
-
-		Loads a session storage driver
+	.. method:: tempdata($item)
 
-	.. method:: select_driver($driver)
+		:param string $item: name of tempdata item
+		:returns: string
 
-		:param string $driver: Driver name
-		:returns: void
+		Returns a string containing the value of the passed item or NULL if the item is not found. Example::
 
-		Selects default session storage driver.
+			$this->session->tempdata('message');
+			//returns 'Test message.' considering the set_tempdata example.
-- 
cgit v1.2.3-24-g4f1b


From 6c85442746c46009cdf3fe517465e174a91cc4c5 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Mon, 21 Oct 2013 13:58:15 +0300
Subject: Fix #2691

---
 user_guide_src/source/changelog.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 8c992a575..9f6feb744 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -619,6 +619,7 @@ Bug fixes for 3.0
 -  Fixed a bug in the 'postgre' :doc:`database <database/index>` driver where the connection ID wasn't passed to ``pg_escape_string()``.
 -  Fixed a bug (#33) - Script execution was terminated when an invalid cookie key was encountered.
 -  Fixed a bug (#2681) - ``CI_Security::entity_decode()`` used the `PREG_REPLACE_EVAL` flag, which is deprecated since PHP 5.5.
+-  Fixed a bug (#2691) - nested transactions could end in a deadlock when an error is encountered with *db_debug* set to TRUE.
 
 Version 2.1.4
 =============
-- 
cgit v1.2.3-24-g4f1b


From 72b4b3cbc71d2c266938b8878baba11c11c565ca Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Mon, 21 Oct 2013 14:44:57 +0300
Subject: Add 'filename' to the return elements for create_captcha() (PR #2602)

---
 user_guide_src/source/changelog.rst              | 1 +
 user_guide_src/source/helpers/captcha_helper.rst | 9 +++++----
 2 files changed, 6 insertions(+), 4 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 8f5dfe540..053f57703 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -128,6 +128,7 @@ Release Date: Not Released
 
       - Added *word_length* and *pool* options to allow customization of the generated word.
       - Added *colors* configuration to allow customization for the *background*, *border*, *text* and *grid* colors.
+      - Added *filename* to the returned array elements.
 
    -  :doc:`Directory Helper <helpers/directory_helper>` :php:func:`directory_map()` will now append ``DIRECTORY_SEPARATOR`` to directory names in the returned array.
    -  :doc:`Array Helper <helpers/array_helper>` :php:func:`element()` and :php:func:`elements()` now return NULL instead of FALSE when the required elements don't exist.
diff --git a/user_guide_src/source/helpers/captcha_helper.rst b/user_guide_src/source/helpers/captcha_helper.rst
index 3c56addf3..f47173453 100644
--- a/user_guide_src/source/helpers/captcha_helper.rst
+++ b/user_guide_src/source/helpers/captcha_helper.rst
@@ -26,7 +26,7 @@ create_captcha()
 	:param	string	$img_path: Path to create the image in
 	:param	string	$img_url: URL to the CAPTCHA image folder
 	:param	string	$font_path: Server path to font
-	:returns:	array('word' => $word, 'time' => $now, 'image' => $img)
+	:returns:	array
 
 Takes an array of information to generate the CAPTCHA as input and
 creates the image to your specifications, returning an array of
@@ -35,9 +35,10 @@ associative data about the image.
 ::
 
 	array(
-		'image'	=> IMAGE TAG
-		'time'	=> TIMESTAMP (in microtime)
-		'word'	=> CAPTCHA WORD
+		'word'     => CAPTCHA WORD,
+		'time'     => TIMESTAMP (in microtime),
+		'image'    => IMAGE TAG,
+		'filename' => IMAGE FILE NAME
 	)
 
 The **image** is the actual image tag::
-- 
cgit v1.2.3-24-g4f1b


From 32c7212edb0488524a0eece98cb1e2321ee90c29 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Mon, 21 Oct 2013 15:35:05 +0300
Subject: Add CI_Upload:: option

---
 user_guide_src/source/changelog.rst                | 1 +
 user_guide_src/source/libraries/file_uploading.rst | 5 +++++
 2 files changed, 6 insertions(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 053f57703..ecd0eb541 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -274,6 +274,7 @@ Release Date: Not Released
       -  Added the **min_width** and **min_height** options for images.
       -  Removed method ``clean_file_name()`` and its usage in favor of :doc:`Security Library <libraries/security>`'s ``sanitize_filename()``.
       -  Added **file_ext_tolower** config setting.
+      -  Added **mod_mime_fix** option to disable suffixing multiple file extensions with an underscore.
 
    -  :doc:`Cart library <libraries/cart>` changes include:
 
diff --git a/user_guide_src/source/libraries/file_uploading.rst b/user_guide_src/source/libraries/file_uploading.rst
index a295d7427..ac56fabce 100644
--- a/user_guide_src/source/libraries/file_uploading.rst
+++ b/user_guide_src/source/libraries/file_uploading.rst
@@ -224,6 +224,11 @@ Preference                   Default Value     Options                 Descripti
 **detect_mime**              TRUE              TRUE/FALSE (boolean)    If set to TRUE, a server side detection of the file type will be
                                                                        performed to avoid code injection attacks. DO NOT disable this option
                                                                        unless you have no other option as that would cause a security risk.
+**mod_mime_fix**             TRUE              TRUE/FALSE (boolean)    If set to TRUE, multiple filename extensions will be suffixed with an
+                                                                       underscore in order to avoid triggering `Apache mod_mime
+                                                                       <http://httpd.apache.org/docs/2.0/mod/mod_mime.html#multipleext>`_.
+                                                                       DO NOT turn off this option if your upload directory is public, as this
+                                                                       is a security risk.
 ============================ ================= ======================= ======================================================================
 
 Setting preferences in a config file
-- 
cgit v1.2.3-24-g4f1b


From 4c07fce7191ed5d9c393479406cce454a9c4a7cc Mon Sep 17 00:00:00 2001
From: vlakoff <vlakoff@gmail.com>
Date: Fri, 25 Oct 2013 01:20:32 +0200
Subject: Implement $protocol parameter in Config base_url() and site_url()
 methods

Let's keep the implementation logic in one place.
Improves 2023c3d05b042cf1322286d69557c2b8bf3bd8d5.
---
 user_guide_src/source/changelog.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index ecd0eb541..8f11bcc00 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -419,6 +419,7 @@ Release Date: Not Released
       -  Changed ``site_url()`` method  to accept an array as well.
       -  Removed internal method ``_assign_to_config()`` and moved its implementation to *CodeIgniter.php* instead.
       -  ``item()`` now returns NULL instead of FALSE when the required config item doesn't exist.
+      -  Added an optional second parameter to both ``base_url()`` and ``site_url()`` that allows enforcing of a protocol different than the one in the *base_url* configuration setting.
 
    -  :doc:`Security Library <libraries/security>` changes include:
 
-- 
cgit v1.2.3-24-g4f1b


From 8c0e56f5349cb52e993eb7132a87151e838e95b0 Mon Sep 17 00:00:00 2001
From: vlakoff <vlakoff@gmail.com>
Date: Sat, 26 Oct 2013 01:15:49 +0200
Subject: Remove redundant changelog entry

---
 user_guide_src/source/changelog.rst | 1 -
 1 file changed, 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 8f11bcc00..c191432b8 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -77,7 +77,6 @@ Release Date: Not Released
       - Added support (auto-detection) for HTTP/1.1 response code 303 in :php:func:`redirect()`.
       - Changed :php:func:`redirect()` to choose the **refresh** method only on IIS servers, instead of all servers on Windows (when **auto** is used).
       - Changed :php:func:`anchor()`, :php:func:`anchor_popup()`, and :php:func:`redirect()` to support protocol-relative URLs (e.g. *//ellislab.com/codeigniter*).
-      - Added an optional second parameter to both :php:func:`base_url()` and :php:func:`site_url()` that allows enforcing of a protocol different than the one in the *base_url* configuration setting.
 
    -  :doc:`HTML Helper <helpers/html_helper>` changes include:
 
-- 
cgit v1.2.3-24-g4f1b


From c6fc0c8a4e3e3909b305e3fc24d898a3563d82a8 Mon Sep 17 00:00:00 2001
From: kakysha <ezhikvdele@gmail.com>
Date: Mon, 28 Oct 2013 23:01:08 +0300
Subject: Update Redis Caching block

Added config options
---
 user_guide_src/source/libraries/caching.rst | 23 +++++++++++++++++------
 1 file changed, 17 insertions(+), 6 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/caching.rst b/user_guide_src/source/libraries/caching.rst
index 8d7b4c440..10d0e84d7 100644
--- a/user_guide_src/source/libraries/caching.rst
+++ b/user_guide_src/source/libraries/caching.rst
@@ -239,21 +239,32 @@ For more information on WinCache, please see
 Redis Caching
 =============
 
+Redis is an in-memory key-value store which can operate in LRU cache mode. 
+To use it, you need Redis server and any Redis PHP extension, e.g. this one
+`https://github.com/nicolasff/phpredis <https://github.com/nicolasff/phpredis>`_.
+
+Config options to connect to redis server must be stored in the application/config/redis.php file.
+Available options are::
+	
+	$config['socket_type'] = 'tcp'; //`tcp` or `unix`
+	$config['socket'] = '/var/run/redis.sock'; // in case of `unix` socket type
+	$config['host'] = '127.0.0.1';
+	$config['password'] = NULL;
+	$config['port'] = 6379;
+	$config['timeout'] = 0;
+
 All of the methods listed above can be accessed without passing a
 specific adapter to the driver loader as follows::
 
 	$this->load->driver('cache');
 	$this->cache->redis->save('foo', 'bar', 10);
 
-.. important:: Redis may require one or more of the following options:
-	**host**, **post**, **timeout**, **password**.
-
-The Redis PHP extension repository is located at
-`https://github.com/nicolasff/phpredis <https://github.com/nicolasff/phpredis>`_.
+For more information on Redis, please see
+`http://redis.io <http://redis.io>`_.
 
 Dummy Cache
 ===========
 
 This is a caching backend that will always 'miss.' It stores no data,
 but lets you keep your caching code in place in environments that don't
-support your chosen cache.
\ No newline at end of file
+support your chosen cache.
-- 
cgit v1.2.3-24-g4f1b


From 6b1b803ee134462e29053a8e34cff8dc2dc96f2d Mon Sep 17 00:00:00 2001
From: kakysha <ezhikvdele@gmail.com>
Date: Mon, 28 Oct 2013 23:12:19 +0300
Subject: Added changelog entry

---
 user_guide_src/source/changelog.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index c191432b8..fd024ffce 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -623,6 +623,7 @@ Bug fixes for 3.0
 -  Fixed a bug (#2681) - ``CI_Security::entity_decode()`` used the `PREG_REPLACE_EVAL` flag, which is deprecated since PHP 5.5.
 -  Fixed a bug (#2691) - nested transactions could end in a deadlock when an error is encountered with *db_debug* set to TRUE.
 -  Fixed a bug (#2515) - ``_exception_handler()`` used to send the 200 "OK" HTTP status code and didn't stop script exection even on fatal errors.
+-  Fixed a bug - `redis` :doc:`Caching <libraries/caching>` driver didn't handle connection failure properly.
 
 Version 2.1.4
 =============
-- 
cgit v1.2.3-24-g4f1b


From f06864ca1442101d2d3644b5b0948ce5dfcd097f Mon Sep 17 00:00:00 2001
From: kakysha <ezhikvdele@gmail.com>
Date: Tue, 29 Oct 2013 02:52:44 +0300
Subject: typos

---
 user_guide_src/source/changelog.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index fd024ffce..1c1100b3d 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -623,7 +623,7 @@ Bug fixes for 3.0
 -  Fixed a bug (#2681) - ``CI_Security::entity_decode()`` used the `PREG_REPLACE_EVAL` flag, which is deprecated since PHP 5.5.
 -  Fixed a bug (#2691) - nested transactions could end in a deadlock when an error is encountered with *db_debug* set to TRUE.
 -  Fixed a bug (#2515) - ``_exception_handler()`` used to send the 200 "OK" HTTP status code and didn't stop script exection even on fatal errors.
--  Fixed a bug - `redis` :doc:`Caching <libraries/caching>` driver didn't handle connection failure properly.
+-  Fixed a bug - Redis :doc:`Caching <libraries/caching>` driver didn't handle connection failures properly.
 
 Version 2.1.4
 =============
-- 
cgit v1.2.3-24-g4f1b


From 34565a7299fa12e951f8e4b40164b8f34d17de23 Mon Sep 17 00:00:00 2001
From: kakysha <ezhikvdele@gmail.com>
Date: Tue, 29 Oct 2013 02:59:30 +0300
Subject: Update caching.rst

---
 user_guide_src/source/libraries/caching.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/caching.rst b/user_guide_src/source/libraries/caching.rst
index 10d0e84d7..9c588f29e 100644
--- a/user_guide_src/source/libraries/caching.rst
+++ b/user_guide_src/source/libraries/caching.rst
@@ -240,7 +240,7 @@ Redis Caching
 =============
 
 Redis is an in-memory key-value store which can operate in LRU cache mode. 
-To use it, you need Redis server and any Redis PHP extension, e.g. this one
+To use it, you need Redis server and phpredis PHP extension 
 `https://github.com/nicolasff/phpredis <https://github.com/nicolasff/phpredis>`_.
 
 Config options to connect to redis server must be stored in the application/config/redis.php file.
-- 
cgit v1.2.3-24-g4f1b


From 4118981aff99c3495a4cf63c96271959587e06ce Mon Sep 17 00:00:00 2001
From: Kakysha <ezhikvdele@gmail.com>
Date: Tue, 29 Oct 2013 04:00:41 +0400
Subject: newline at the eof

---
 user_guide_src/source/libraries/caching.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/caching.rst b/user_guide_src/source/libraries/caching.rst
index 9c588f29e..3f7dc2dd9 100644
--- a/user_guide_src/source/libraries/caching.rst
+++ b/user_guide_src/source/libraries/caching.rst
@@ -267,4 +267,4 @@ Dummy Cache
 
 This is a caching backend that will always 'miss.' It stores no data,
 but lets you keep your caching code in place in environments that don't
-support your chosen cache.
+support your chosen cache.
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 2d5ebf754546f680879831f58b9236d8d53af8b5 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Tue, 29 Oct 2013 13:27:59 +0200
Subject: Update sess_time_to_update description (rel #2397)

---
 user_guide_src/source/libraries/sessions.rst | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/sessions.rst b/user_guide_src/source/libraries/sessions.rst
index 36c7c1d32..2f8bea0b6 100644
--- a/user_guide_src/source/libraries/sessions.rst
+++ b/user_guide_src/source/libraries/sessions.rst
@@ -252,7 +252,7 @@ Session Preferences
 ===================
 
 You'll find the following Session related preferences in your
-application/config/config.php file:
+*application/config/config.php* file:
 
 =========================== =============== =========================== ==========================================================================
 Preference                  Default         Options                     Description
@@ -271,7 +271,8 @@ Preference                  Default         Options                     Descript
                                                                         table before enabling this option (Cookie driver only).
 **sess_table_name**         ci_sessions     Any valid SQL table name    The name of the session database table (Cookie driver only).
 **sess_time_to_update**     300             Time in seconds             This options controls how often the session class will regenerate itself
-                                                                        and create a new session id.
+                                                                        and create a new session ID. Setting it to 0 will disable session
+                                                                        ID regeneartion.
 **sess_match_ip**           FALSE           TRUE/FALSE (boolean)        Whether to match the user's IP address when reading the session data.
                                                                         Note that some ISPs dynamically changes the IP, so if you want a
                                                                         non-expiring session you will likely set this to FALSE.
-- 
cgit v1.2.3-24-g4f1b


From 0b58b3cad456efc5ecce89f622876c6b715439c2 Mon Sep 17 00:00:00 2001
From: Fatih Kalifa <fatih@pvey.es>
Date: Tue, 5 Nov 2013 15:36:40 +0700
Subject: Fix HTTP Verb Routing Rules

Fix code style, removed (:any) rule in http verb to avoid confusion, and
add proposed documentation and changelog
---
 user_guide_src/source/changelog.rst       |  1 +
 user_guide_src/source/general/routing.rst | 36 +++++++++++++++++++++++++++++++
 2 files changed, 37 insertions(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 4a45a71b0..90229d206 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -420,6 +420,7 @@ Release Date: Not Released
 
    -  :doc:`URI Routing <general/routing>` changes include:
 
+      -  Added possibility to route requests using HTTP Verb
       -  Added possibility to route requests using callbacks.
       -  Added a new reserved route (*translate_uri_dashes*) to allow usage of dashes in the controller and method URI segments.
       -  Deprecated methods ``fetch_directory()``, ``fetch_class()`` and ``fetch_method()`` in favor of their respective public properties.
diff --git a/user_guide_src/source/general/routing.rst b/user_guide_src/source/general/routing.rst
index 5520f59fe..6495f1ad4 100644
--- a/user_guide_src/source/general/routing.rst
+++ b/user_guide_src/source/general/routing.rst
@@ -142,6 +142,42 @@ routing rules to process the back-references. Example::
 		return 'catalog/product_edit/' . strtolower($product_type) . '/' . $id;
 	};
 
+Using HTTP Verb in Routes
+=========================
+
+If you prefer you can use HTTP Verb (or method) to define your routing rules.
+This is particularly useful when building RESTful application. You can use standard HTTP
+Verb (GET, PUT, POST, DELETE) or custom HTTP Verb (e.g: PURGE). HTTP Verb rule is case 
+insensitive. All you need to do is add array index using HTTP Verb rule. Example::
+
+	$route['products']['put'] = 'product/insert';
+
+In the above example, a PUT request to URI "products" would call the "product" controller
+class and "insert" method
+
+::
+
+	$route['products/(:num)']['DELETE'] = 'product/delete/$1';
+
+A DELETE request to URL with "products" as first segment and a number in the second will be
+remapped to the "product" class and "delete" method passing in the match as a variable to
+the method.
+
+::
+
+	$route['products/([a-z]+)/(\d+)']['get'] = 'product/$1/$2';
+
+A GET request to a URI similar to products/shirts/123 would call the "product" controller
+class and "shirt" method with number as method parameter
+
+Using HTTP Verb is optional, so if you want any HTTP Verb to be handled in one rule
+You could just write your routing rule without HTTP Verb. Example::
+
+	$route['product'] = 'product';
+
+This way, all incoming request using any HTTP method containing the word "product"
+in the first segment will be remapped to "product" class
+
 Reserved Routes
 ===============
 
-- 
cgit v1.2.3-24-g4f1b


From 01e9fb1d6aab8e513a9ebd786e9abff74d8b63ca Mon Sep 17 00:00:00 2001
From: GDmac <grdalenoort@gmail.com>
Date: Sat, 9 Nov 2013 08:01:52 +0100
Subject: docs: get_compile_select

get_compile_select(null,false) without reset also preserves LIMIT settings
---
 user_guide_src/source/database/query_builder.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/database/query_builder.rst b/user_guide_src/source/database/query_builder.rst
index 65609c1cb..5e0dcb4be 100644
--- a/user_guide_src/source/database/query_builder.rst
+++ b/user_guide_src/source/database/query_builder.rst
@@ -68,7 +68,7 @@ Example::
 	// Produces string: SELECT * FROM mytable
 
 The second parameter enables you to set whether or not the query builder query
-will be reset (by default it will be&mdash;just like `$this->db->get()`)::
+will be reset (by default it will be reset, just like when using `$this->db->get()`)::
 
 	echo $this->db->limit(10,20)->get_compiled_select('mytable', FALSE);
 	// Produces string: SELECT * FROM mytable LIMIT 20, 10
@@ -76,7 +76,7 @@ will be reset (by default it will be&mdash;just like `$this->db->get()`)::
 
 	echo $this->db->select('title, content, date')->get_compiled_select();
 
-	// Produces string: SELECT title, content, date FROM mytable
+	// Produces string: SELECT title, content, date FROM mytable LIMIT 20, 10
 
 The key thing to notice in the above example is that the second query did not
 utilize `$this->db->from()`_ and did not pass a table name into the first
@@ -1055,4 +1055,4 @@ run the query::
 	$data = $this->db->get()->result_array();
 
 	// Would execute and return an array of results of the following query:
-	// SELECT field1, field1 from mytable where field3 = 5;
\ No newline at end of file
+	// SELECT field1, field1 from mytable where field3 = 5;
-- 
cgit v1.2.3-24-g4f1b


From c761a206def7714d18623d46b05adc2bbeedce21 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Mon, 11 Nov 2013 14:02:15 +0200
Subject: Polish changes from PR #2712

---
 user_guide_src/source/changelog.rst       |  2 +-
 user_guide_src/source/general/routing.rst | 37 ++++++++++---------------------
 2 files changed, 13 insertions(+), 26 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index fbea04c43..5fc86b1b5 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -429,7 +429,7 @@ Release Date: Not Released
 
    -  :doc:`URI Routing <general/routing>` changes include:
 
-      -  Added possibility to route requests using HTTP Verb
+      -  Added possibility to route requests using HTTP verbs.
       -  Added possibility to route requests using callbacks.
       -  Added a new reserved route (*translate_uri_dashes*) to allow usage of dashes in the controller and method URI segments.
       -  Deprecated methods ``fetch_directory()``, ``fetch_class()`` and ``fetch_method()`` in favor of their respective public properties.
diff --git a/user_guide_src/source/general/routing.rst b/user_guide_src/source/general/routing.rst
index 6495f1ad4..0b91d3fa9 100644
--- a/user_guide_src/source/general/routing.rst
+++ b/user_guide_src/source/general/routing.rst
@@ -142,41 +142,28 @@ routing rules to process the back-references. Example::
 		return 'catalog/product_edit/' . strtolower($product_type) . '/' . $id;
 	};
 
-Using HTTP Verb in Routes
-=========================
+Using HTTP verbs in routes
+==========================
 
-If you prefer you can use HTTP Verb (or method) to define your routing rules.
-This is particularly useful when building RESTful application. You can use standard HTTP
-Verb (GET, PUT, POST, DELETE) or custom HTTP Verb (e.g: PURGE). HTTP Verb rule is case 
-insensitive. All you need to do is add array index using HTTP Verb rule. Example::
+It is possible to use HTTP verbs (request method) to define your routing rules.
+This is particularly useful when building RESTful applications. You can use standard HTTP
+verbs (GET, PUT, POST, DELETE, PATCH) or a custom one such (e.g. PURGE). HTTP verb rules
+are case-insensitive. All you need to do is to add the verb as an array key to your route.
+Example::
 
 	$route['products']['put'] = 'product/insert';
 
-In the above example, a PUT request to URI "products" would call the "product" controller
-class and "insert" method
+In the above example, a PUT request to URI "products" would call the ``Product::insert()``
+controller method.
 
 ::
 
 	$route['products/(:num)']['DELETE'] = 'product/delete/$1';
 
-A DELETE request to URL with "products" as first segment and a number in the second will be
-remapped to the "product" class and "delete" method passing in the match as a variable to
-the method.
-
-::
-
-	$route['products/([a-z]+)/(\d+)']['get'] = 'product/$1/$2';
-
-A GET request to a URI similar to products/shirts/123 would call the "product" controller
-class and "shirt" method with number as method parameter
-
-Using HTTP Verb is optional, so if you want any HTTP Verb to be handled in one rule
-You could just write your routing rule without HTTP Verb. Example::
-
-	$route['product'] = 'product';
+A DELETE request to URL with "products" as first the segment and a number in the second will be
+mapped to the ``Product::delete()`` method, passing the numeric value as the first parameter.
 
-This way, all incoming request using any HTTP method containing the word "product"
-in the first segment will be remapped to "product" class
+Using HTTP verbs is of course, optional.
 
 Reserved Routes
 ===============
-- 
cgit v1.2.3-24-g4f1b


From 17a0528c23c4d6cf95b03299fbfe2ff789b82249 Mon Sep 17 00:00:00 2001
From: GDmac <grdalenoort@gmail.com>
Date: Mon, 11 Nov 2013 13:18:09 +0100
Subject: Cleanup PR #2719

for Fix #2406 query builder cache

Signed-off-by: GDmac <grdalenoort@gmail.com>
---
 user_guide_src/source/database/query_builder.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/database/query_builder.rst b/user_guide_src/source/database/query_builder.rst
index 5e0dcb4be..480067407 100644
--- a/user_guide_src/source/database/query_builder.rst
+++ b/user_guide_src/source/database/query_builder.rst
@@ -1055,4 +1055,4 @@ run the query::
 	$data = $this->db->get()->result_array();
 
 	// Would execute and return an array of results of the following query:
-	// SELECT field1, field1 from mytable where field3 = 5;
+	// SELECT field1, field1 from mytable where field3 = 5;
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From f964b16f3db95d655420dfae2012ee9fbb98a1a8 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Tue, 12 Nov 2013 17:04:55 +0200
Subject: Deprecate CI_Input::is_cli_request() and add common function is_cli()
 to replace it

Calls to this function are often needed before the Input library is available
---
 user_guide_src/source/changelog.rst                |  2 ++
 user_guide_src/source/general/cli.rst              |  2 +-
 user_guide_src/source/general/common_functions.rst | 13 ++++++++++++
 user_guide_src/source/helpers/date_helper.rst      |  2 +-
 user_guide_src/source/installation/upgrade_300.rst | 24 ++++++++++++++++++++++
 user_guide_src/source/libraries/input.rst          |  3 +++
 6 files changed, 44 insertions(+), 2 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 5fc86b1b5..23fd95893 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -396,6 +396,7 @@ Release Date: Not Released
       -  Added method ``post_get()`` and changed ``get_post()`` to search in GET data first. Both methods' names now properly match their GET/POST data search priorities.
       -  Changed method ``_fetch_from_array()`` to parse array notation in field name.
       -  Added an option for ``_clean_input_keys()`` to return FALSE instead of terminating the whole script.
+      -  Deprecated the ``is_cli_request()`` method, it is now an alias for the new :php:func:`is_cli()` common function.
 
    -  :doc:`Common functions <general/common_functions>` changes include:
 
@@ -404,6 +405,7 @@ Release Date: Not Released
       -  Removed redundant conditional to determine HTTP server protocol in :php:func:`set_status_header()`.
       -  Changed ``_exception_handler()`` to respect php.ini *display_errors* setting.
       -  Added function :php:func:`is_https()` to check if a secure connection is used.
+      -  Added function :php:func:`is_cli()` to replace the ``CI_Input::is_cli_request()`` method.
       -  Added function :php:func:`function_usable()` to check if a function exists and is not disabled by `Suhosin <http://www.hardened-php.net/suhosin/>`.
       -  Removed the third (`$php_error`) from function :php:func:`log_message()`.
 
diff --git a/user_guide_src/source/general/cli.rst b/user_guide_src/source/general/cli.rst
index 4145d5ccc..4f3b07d9e 100644
--- a/user_guide_src/source/general/cli.rst
+++ b/user_guide_src/source/general/cli.rst
@@ -23,7 +23,7 @@ but they are not always obvious.
 
 -  Run your cron-jobs without needing to use *wget* or *curl*
 -  Make your cron-jobs inaccessible from being loaded in the URL by
-   checking for ``$this->input->is_cli_request()``
+   checking the return value of :func:`is_cli()`.
 -  Make interactive "tasks" that can do things like set permissions,
    prune cache folders, run backups, etc.
 -  Integrate with other applications in other languages. For example, a
diff --git a/user_guide_src/source/general/common_functions.rst b/user_guide_src/source/general/common_functions.rst
index e085ef808..2dfec9cc0 100644
--- a/user_guide_src/source/general/common_functions.rst
+++ b/user_guide_src/source/general/common_functions.rst
@@ -173,6 +173,19 @@ is_https()
 Returns TRUE if a secure (HTTPS) connection is used and FALSE
 in any other case (including non-HTTP requests).
 
+is_cli()
+========
+
+.. php:function:: is_cli()
+
+	:returns:	bool
+
+Returns TRUE if the application is run through the command line
+and FALSE if not.
+
+.. note:: This function checks both if the ``PHP_SAPI`` value is 'cli'
+	or if the ``STDIN`` constant is defined.
+
 function_usable()
 =================
 
diff --git a/user_guide_src/source/helpers/date_helper.rst b/user_guide_src/source/helpers/date_helper.rst
index 5dfee8b48..8126eba6c 100644
--- a/user_guide_src/source/helpers/date_helper.rst
+++ b/user_guide_src/source/helpers/date_helper.rst
@@ -80,7 +80,7 @@ Example::
 	$time = time();
 	echo standard_date($format, $time);
 
-.. note:: This function is DEPRECATED.Use the native ``date()`` combined with
+.. note:: This function is DEPRECATED. Use the native ``date()`` combined with
 	`DateTime's format constants
 	<http://www.php.net/manual/en/class.datetime.php#datetime.constants.types>`_
 	instead:
diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst
index e8fdd0b15..8f9cc1bdc 100644
--- a/user_guide_src/source/installation/upgrade_300.rst
+++ b/user_guide_src/source/installation/upgrade_300.rst
@@ -457,4 +457,28 @@ then you can now just access the properties instead::
 	$this->router->method;
 
 .. note:: Those methods are still available, but you're strongly encouraged to remove their usage
+	sooner rather than later.
+
+Input library method is_cli_request()
+=====================================
+
+Calls to the ``CI_Input::is_cli_request()`` method are necessary at many places
+in the CodeIgniter internals and this is often before the :doc:`Input Library
+<../libraries/input>` is loaded. Because of that, it is being replaced by a common
+function named :php:func:`is_cli()` and this method is now just an alias.
+
+The new function is both available at all times for you to use and shorter to type.
+
+::
+
+	// Old
+	$this->input->is_cli_request();
+
+	// New
+	is_cli();
+
+``CI_Input::is_cli_request()`` is now now deprecated and scheduled for removal in
+CodeIgniter 3.1+.
+
+.. note:: This method is still available, but you're strongly encouraged to remove its usage
 	sooner rather than later.
\ No newline at end of file
diff --git a/user_guide_src/source/libraries/input.rst b/user_guide_src/source/libraries/input.rst
index fb245d7cd..b58ed2f0d 100644
--- a/user_guide_src/source/libraries/input.rst
+++ b/user_guide_src/source/libraries/input.rst
@@ -315,6 +315,9 @@ see if PHP is being run on the command line.
 
 	$this->input->is_cli_request()
 
+.. note:: This method is DEPRECATED and is now just an alias for the
+	:php:func:`is_cli()` function.
+
 $this->input->method()
 ======================
 
-- 
cgit v1.2.3-24-g4f1b


From 29947ee882a8d519d62ca9061ed6513cedfb1930 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Tue, 12 Nov 2013 18:36:46 +0200
Subject: Add CLI error templates and only send HTTP status headers for non-CLI
 requests (issue #1743)

---
 user_guide_src/source/changelog.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 23fd95893..93e75c2a2 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -55,6 +55,7 @@ Release Date: Not Released
    -  Changed environment defaults to report all errors in *development* and only fatal ones in *testing*, *production* but only display them in *development*.
    -  Updated *ip_address* database field lengths from 16 to 45 for supporting IPv6 address on :doc:`Trackback Library <libraries/trackback>` and :doc:`Captcha Helper <helpers/captcha_helper>`.
    -  Removed *cheatsheets* and *quick_reference* PDFs from the documentation.
+   -  Added support non-HTML error templates for CLI applications.
    -  Added availability checks where usage of dangerous functions like ``eval()`` and ``exec()`` is required.
    -  Added support for changing the file extension of log files using ``$config['log_file_extension']``.
 
-- 
cgit v1.2.3-24-g4f1b


From fb2ac41b6c914fd55b539337e381860bfcc2cf7b Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Tue, 12 Nov 2013 18:45:23 +0200
Subject: Update the upgrade instructions for error templates

---
 user_guide_src/source/installation/upgrade_300.rst | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst
index 8f9cc1bdc..ec80e8041 100644
--- a/user_guide_src/source/installation/upgrade_300.rst
+++ b/user_guide_src/source/installation/upgrade_300.rst
@@ -119,11 +119,18 @@ need to rename the `$active_record` variable to `$query_builder`
 	// $active_record = TRUE;
 	$query_builder = TRUE;
 
-*******************************************
-Step 8: Move your error templates directory
-*******************************************
+************************************
+Step 8: Replace your error templates
+************************************
 
-In version 3.0.0, the errors folder has been moved from _application/errors* to _application/views/errors*.
+In CodeIgniter 3.0, the error templates are now considered as views and have been moved to the
+_application/views/errors* directory.
+
+Furthermore, we've added support for CLI error templates in plain-text format that unlike HTML,
+is suitable for the command line. This of course requires another level of separation.
+
+It is safe to move your old templates from _application/errors* to _application/views/errors/html*,
+but you'll have to copy the new _application/views/errors/cli* directory from the CodeIgniter archive.
 
 *******************************************************
 Step 9: Update your config/routes.php containing (:any)
-- 
cgit v1.2.3-24-g4f1b


From f8f14f3da263338bb4723012229f6c373a1764c6 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Tue, 10 Dec 2013 11:32:32 +0200
Subject: Fix a bug where DB() tried to set the MySQL-specific 'sql_mode' on
 all drivers

Supersedes PR #2756
---
 user_guide_src/source/changelog.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 93e75c2a2..b7fa9bb41 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -628,6 +628,7 @@ Bug fixes for 3.0
 -  Fixed a bug (#2691) - nested transactions could end in a deadlock when an error is encountered with *db_debug* set to TRUE.
 -  Fixed a bug (#2515) - ``_exception_handler()`` used to send the 200 "OK" HTTP status code and didn't stop script exection even on fatal errors.
 -  Fixed a bug - Redis :doc:`Caching <libraries/caching>` driver didn't handle connection failures properly.
+-  Fixed a bug (#2756) - :doc:`Database Class <database/index>` executed the MySQL-specific `SET SESSION sql_mode` query for all drivers when the 'stricton' option is set.
 
 Version 2.1.4
 =============
-- 
cgit v1.2.3-24-g4f1b


From 25a246c2bf184f968c2d895de1653319eaa081aa Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Tue, 17 Dec 2013 13:07:26 +0200
Subject: Fix #2775 (security lib docs)

---
 user_guide_src/source/libraries/security.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/security.rst b/user_guide_src/source/libraries/security.rst
index 05553142f..be1f8d205 100644
--- a/user_guide_src/source/libraries/security.rst
+++ b/user_guide_src/source/libraries/security.rst
@@ -83,14 +83,14 @@ application/config/config.php file and setting this::
 
 If you use the :doc:`form helper <../helpers/form_helper>`, then
 ``form_open()`` will automatically insert a hidden csrf field in
-your forms. If not, then you can use ``csrf_get_token_name()``
-and ``csrf_get_hash()``
+your forms. If not, then you can use ``get_csrf_token_name()``
+and ``get_csrf_hash()``
 
 ::
 
 	$csrf = array(
-		'name' => $this->security->csrf_get_token_name(),
-		'hash' => $this->security->csrf_get_hash()
+		'name' => $this->security->get_csrf_token_name(),
+		'hash' => $this->security->get_csrf_hash()
 	);
 
 	...
-- 
cgit v1.2.3-24-g4f1b


From 6bdfa428d96358787b5c1fdb05c811ab57860e16 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Thu, 19 Dec 2013 15:36:01 +0200
Subject: [ci skip] Add notes to get_compiled_insert(), get_compiled_update()
 docs

---
 user_guide_src/source/database/query_builder.rst | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/database/query_builder.rst b/user_guide_src/source/database/query_builder.rst
index 480067407..9a96db003 100644
--- a/user_guide_src/source/database/query_builder.rst
+++ b/user_guide_src/source/database/query_builder.rst
@@ -665,10 +665,12 @@ will be reset (by default it will be--just like `$this->db->insert()`_)::
 	// Produces string: INSERT INTO mytable (title, content) VALUES ('My Title', 'My Content')
 
 The key thing to notice in the above example is that the second query did not
-utlize `$this->db->from()`_ nor did it pass a table name into the first
+utlize `$this->db->from()` nor did it pass a table name into the first
 parameter. The reason this worked is because the query has not been executed
-using `$this->db->insert()`_ which resets values or reset directly using
-`$this->db->reset_query()`_.
+using `$this->db->insert()` which resets values or reset directly using
+`$this->db->reset_query()`.
+
+.. note:: This method doesn't work for batched inserts.
 
 $this->db->insert_batch()
 =========================
@@ -886,8 +888,9 @@ $this->db->get_compiled_update()
 This works exactly the same way as ``$this->db->get_compiled_insert()`` except
 that it produces an UPDATE SQL string instead of an INSERT SQL string.
 
-For more information view documentation for `$this->db->get_compiled_insert()`_.
+For more information view documentation for `$this->db->get_compiled_insert()`.
 
+.. note:: This method doesn't work for batched updates.
 
 *************
 Deleting Data
-- 
cgit v1.2.3-24-g4f1b


From 3cfd53937034d92ff15f9c2457a0f5bc1d80b0f6 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Thu, 19 Dec 2013 16:08:12 +0200
Subject: [ci skip] Fix a changelog message

---
 user_guide_src/source/changelog.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index b7fa9bb41..d1a5e8c2b 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -439,7 +439,7 @@ Release Date: Not Released
 
    -  :doc:`Language Library <libraries/language>` changes include:
 
-      -  Changed method ``load()`` to filter the language name with ``ctype_digit()``.
+      -  Changed method ``load()`` to filter the language name with ``ctype_alpha()``.
       -  Added an optional second parameter to method ``line()`` to disable error login for line keys that were not found.
       -  Language files are now loaded in a cascading style with the one in **system/** always loaded and overriden afterwards, if another one is found.
 
-- 
cgit v1.2.3-24-g4f1b


From 0db570c1958e43531b7dc3c83584c85521a3d144 Mon Sep 17 00:00:00 2001
From: Tufan Barış YILDIRIM <tufanbarisyildirim@gmail.com>
Date: Thu, 19 Dec 2013 21:31:23 +0200
Subject: added changelog about EXISTS / NOT EXISTS @narfbg "And you should
 also add a changelog entry for this addition. :)"

---
 user_guide_src/source/changelog.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index d1a5e8c2b..3dc7ade36 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -137,6 +137,7 @@ Release Date: Not Released
 
 -  Database
 
+   -  Added EXISTS / NOT EXISTS support to DB_Driver class.
    -  Added **dsn** configuration setting for drivers that support DSN strings (PDO, PostgreSQL, Oracle, ODBC, CUBRID).
    -  Added **schema** configuration setting (defaults to *public*) for drivers that might need it (currently used by PostgreSQL and ODBC).
    -  Added subdrivers support (currently only used by PDO).
-- 
cgit v1.2.3-24-g4f1b


From 295cfa92574c2ee0c0465e4f86a0d3215a32413c Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Fri, 20 Dec 2013 11:48:38 +0200
Subject: Polishing changes from #PR #2781

Looks like an unnecessary commit was made by the author just as I was clicking the Merge button. :)
---
 user_guide_src/source/changelog.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 3dc7ade36..54583e6fb 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -137,7 +137,6 @@ Release Date: Not Released
 
 -  Database
 
-   -  Added EXISTS / NOT EXISTS support to DB_Driver class.
    -  Added **dsn** configuration setting for drivers that support DSN strings (PDO, PostgreSQL, Oracle, ODBC, CUBRID).
    -  Added **schema** configuration setting (defaults to *public*) for drivers that might need it (currently used by PostgreSQL and ODBC).
    -  Added subdrivers support (currently only used by PDO).
@@ -166,6 +165,7 @@ Release Date: Not Released
       - Added an optional parameter that allows to disable escaping (useful for custom fields) for methods ``join()``, ``order_by()``, ``where_in()``, ``or_where_in()``, ``where_not_in()``, ``or_where_not_in()``, ``insert()``, ``insert_batch()``.
       - Added support for ``join()`` with multiple conditions.
       - Added support for *USING* in ``join()``.
+      - Added support for *EXISTS* in ``where()``.
       - Added seed values support for random ordering with ``order_by(seed, 'RANDOM')``.
       - Changed ``limit()`` to ignore NULL values instead of always casting to integer.
       - Changed ``offset()`` to ignore empty values instead of always casting to integer.
-- 
cgit v1.2.3-24-g4f1b


From 5e6ce4699e074118c15d887e30b1e6720448264e Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Fri, 3 Jan 2014 11:25:30 +0200
Subject: [ci skip] Add a missing semicolon in the docs css

---
 user_guide_src/source/_themes/eldocs/static/asset/css/common.css | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/_themes/eldocs/static/asset/css/common.css b/user_guide_src/source/_themes/eldocs/static/asset/css/common.css
index 197739a57..5cbb37f94 100644
--- a/user_guide_src/source/_themes/eldocs/static/asset/css/common.css
+++ b/user_guide_src/source/_themes/eldocs/static/asset/css/common.css
@@ -133,7 +133,7 @@ a:visited{ color: #1A5B8D; }
 a:hover,
 a:active{ color: #742CAC; }
 
-a.headerlink{ visibility: hidden; margin-left: 0.4em }
+a.headerlink{ visibility: hidden; margin-left: 0.4em; }
 
 	:hover > a.headerlink { visibility: visible; }
 
@@ -350,4 +350,4 @@ fieldset{ border: 0; }
 	h3,h4,h5,h6{ font-size: 14px; }
 }
 
-#header input[type="submit"], x:-moz-any-link{ padding: 4px 10px; }
+#header input[type="submit"], x:-moz-any-link{ padding: 4px 10px; }
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From b57b2ade712990b9214ffaf80ae97829b91303db Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Fri, 3 Jan 2014 12:02:08 +0200
Subject: [ci skip] Add/remove some newlines from the session docs

---
 user_guide_src/source/libraries/sessions.rst | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/sessions.rst b/user_guide_src/source/libraries/sessions.rst
index cab7669ae..b3de2252c 100644
--- a/user_guide_src/source/libraries/sessions.rst
+++ b/user_guide_src/source/libraries/sessions.rst
@@ -433,6 +433,7 @@ deleted data (sess_destroy), a regenerate handler to make a new session ID
 Your initial class might look like::
 
 	class CI_Session_custom extends CI_Session_driver {
+
 		protected function initialize()
 		{
 			// Read existing session data or create a new one
@@ -457,6 +458,7 @@ Your initial class might look like::
 		{
 			// Return a reference to your userdata array
 		}
+
 	}
 
 Notice that ``get_userdata()`` returns a reference so the parent library is
@@ -488,7 +490,6 @@ your config.php file to an array including your driver name::
 	$config['sess_valid_drivers'] = array('sess_driver');
 
 
-
 ***************
 Class Reference
 ***************
@@ -647,4 +648,4 @@ Class Reference
 		Returns a string containing the value of the passed item or NULL if the item is not found. Example::
 
 			$this->session->tempdata('message');
-			//returns 'Test message.' considering the set_tempdata example.
+			//returns 'Test message.' considering the set_tempdata example.
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 5363f4647b4fba3a0f7a52230cc33889096651ca Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Fri, 3 Jan 2014 12:31:53 +0200
Subject: [ci skip] Update the Security class docs

---
 user_guide_src/source/libraries/security.rst | 103 ++++++++++++++++-----------
 1 file changed, 60 insertions(+), 43 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/security.rst b/user_guide_src/source/libraries/security.rst
index 05553142f..3d0697bbe 100644
--- a/user_guide_src/source/libraries/security.rst
+++ b/user_guide_src/source/libraries/security.rst
@@ -23,12 +23,7 @@ Note: This function should only be used to deal with data upon
 submission. It's not something that should be used for general runtime
 processing since it requires a fair amount of processing overhead.
 
-To filter data through the XSS filter use this function:
-
-$this->security->xss_clean()
-============================
-
-Here is an usage example::
+To filter data through the XSS filter use the ``xss_clean()`` method::
 
 	$data = $this->security->xss_clean($data);
 
@@ -38,10 +33,10 @@ application/config/config.php file and setting this::
 
 	$config['global_xss_filtering'] = TRUE;
 
-Note: If you use the form validation class, it gives you the option of
-XSS filtering as well.
+.. note:: If you use the form validation class, it gives you the option of
+	XSS filtering as well.
 
-An optional second parameter, is_image, allows this function to be used
+An optional second parameter, *is_image*, allows this function to be used
 to test images for potential XSS attacks, useful for file upload
 security. When this second parameter is set to TRUE, instead of
 returning an altered string, the function returns TRUE if the image is
@@ -52,40 +47,20 @@ browser may attempt to execute.
 
 	if ($this->security->xss_clean($file, TRUE) === FALSE)
 	{
-	    // file failed the XSS test
+		// file failed the XSS test
 	}
 
-$this->security->sanitize_filename()
-====================================
-
-When accepting filenames from user input, it is best to sanitize them to
-prevent directory traversal and other security related issues. To do so,
-use the sanitize_filename() method of the Security class. Here is an
-example::
-
-	$filename = $this->security->sanitize_filename($this->input->post('filename'));
-
-If it is acceptable for the user input to include relative paths, e.g.
-file/in/some/approved/folder.txt, you can set the second optional
-parameter, $relative_path to TRUE.
-
-::
-
-	$filename = $this->security->sanitize_filename($this->input->post('filename'), TRUE);
-
 Cross-site request forgery (CSRF)
 =================================
 
-You can enable CSRF protection by opening your
-application/config/config.php file and setting this::
+You can enable CSRF protection by altering your **application/config/config.php**
+file in the following way::
 
 	$config['csrf_protection'] = TRUE;
 
 If you use the :doc:`form helper <../helpers/form_helper>`, then
-``form_open()`` will automatically insert a hidden csrf field in
-your forms. If not, then you can use ``csrf_get_token_name()``
-and ``csrf_get_hash()``
-
+:func:`form_open()` will automatically insert a hidden csrf field in
+your forms. If not, then you can use ``csrf_get_token_name()`` and ``csrf_get_hash()``
 ::
 
 	$csrf = array(
@@ -114,15 +89,57 @@ by editing the 'csrf_exclude_uris' config parameter::
 
 	$config['csrf_exclude_uris'] = array('api/person/add');
 
-$this->security->get_csrf_token_name()
-======================================
+***************
+Class Reference
+***************
+
+.. class:: CI_Security
+
+	.. method:: xss_clean($str[, $is_image = FALSE])
+
+		:param string $str: Input string
+		:returns: mixed
+
+		Tries to remove XSS exploits from the input data and returns the cleaned string.
+		If the optional second parameter is set to true, it will return boolean TRUE if the image is safe to use and FALSE if malicious data was detected in it.
+
+	.. method:: sanitize_filename($str[, $relative_path = FALSE])
+
+		:param string $str: File name/path
+		:param bool $relative_path: Whether to preserve any directories in the file path
+		:returns: string
+
+		Tries to sanitize filenames in order to prevent directory traversal attempts
+		and other security threats, which is particularly useful for files that were supplied via user input.
+		::
+
+			$filename = $this->security->sanitize_filename($this->input->post('filename'));
+
+		If it is acceptable for the user input to include relative paths, e.g.
+		*file/in/some/approved/folder.txt*, you can set the second optional parameter, ``$relative_path`` to TRUE.
+		::
+
+			$filename = $this->security->sanitize_filename($this->input->post('filename'), TRUE);
+
+	.. method:: get_csrf_token_name()
+
+		:returns: string
+
+		Returns the CSRF token name (the ``$config['csrf_token_name']`` value).
+
+	.. method:: get_csrf_hash()
+
+		:returns: string
+
+		Returns the CSRF hash value. Useful in combination with ``get_csrf_token_name()``
+		for manually building forms or sending valid AJAX POST requests.
+
+	.. method:: entity_decode($str[, $charset = NULL])
 
-Returns the CSRF token name, which is set by
-``$config['csrf_token_name']``.
+		:param string $str: Input string
+		:param string $charset: Character set of the input string
 
-$this->security->get_csrf_hash()
-================================
+		This method acts a lot like PHP's own native ``html_entity_decode()`` function in ENT_COMPAT mode, only
+		it tries to detect HTML entities that don't end in a semicolon because some browsers allow that.
 
-Returns the CSRF hash value. Useful in combination with
-``get_csrf_token_name()`` for manually building forms or 
-sending valid AJAX POST requests.
\ No newline at end of file
+		If the ``$charset`` parameter is left empty, then your configured ``$config['charset']`` value will be used.
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 8da2e229362fc59329b3c3d8eea0dfcbf86759bb Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Fri, 3 Jan 2014 12:47:37 +0200
Subject: [ci skip] Update the Parser library docs

---
 user_guide_src/source/libraries/parser.rst | 49 +++++++++++++++++++++---------
 1 file changed, 35 insertions(+), 14 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/parser.rst b/user_guide_src/source/libraries/parser.rst
index 0b77ae4b9..5c184be58 100644
--- a/user_guide_src/source/libraries/parser.rst
+++ b/user_guide_src/source/libraries/parser.rst
@@ -46,15 +46,10 @@ in your controller using the $this->load->library function::
 Once loaded, the Parser library object will be available using:
 $this->parser
 
-The following functions are available in this library:
+Parsing templates
+=================
 
-$this->parser->parse()
-======================
-
-This method accepts a template name and data array as input, and it
-generates a parsed version. Example::
-
-	$this->load->library('parser');
+You can use the ``parse()`` method to parse (or render) simple templates, like this::
 
 	$data = array(
 	            'blog_title' => 'My Blog Title',
@@ -77,12 +72,6 @@ third parameter::
 
 	$string = $this->parser->parse('blog_template', $data, TRUE);
 
-$this->parser->parse_string()
-==============================
-
-This method works exactly like parse(), only accepts a string as the
-first parameter in place of a view file.
-
 Variable Pairs
 ==============
 
@@ -147,3 +136,35 @@ function::
 
 	$this->parser->parse('blog_template', $data);
 
+***************
+Class Reference
+***************
+
+.. class: CI_Parser
+
+	.. method:: parse($template, $data[, $return = FALSE])
+
+		:param string $template: Path to view file
+		:param array $data: Variable data
+		:param bool $return: Whether to return the parsed template
+		:returns: mixed
+
+		Parses a template from the provided path and variables.
+
+	.. method:: parse_string($template, $data[, $return = FALSE])
+
+		:param string $template: Path to view file
+		:param array $data: Variable data
+		:param bool $return: Whether to return the parsed template
+		:returns: mixed
+
+		This method works exactly like ``parse()``, only it accepts the template as a
+		string instead of loading a view file.
+
+	.. method:: set_delimiters([$l = '{'[, $r = '}']])
+
+		:param string $l: Left delimiter
+		:param string $r: Right delimiter
+		:returns: void
+
+		Sets the delimiters (opening and closing) for a value "tag" in a template.
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From f4bee9b68bf06f4161ddec05fe838af7b8fb561d Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Fri, 3 Jan 2014 13:19:49 +0200
Subject: [ci skip] Update the Pagination library docs

---
 user_guide_src/source/libraries/pagination.rst | 105 ++++++++++++++-----------
 1 file changed, 57 insertions(+), 48 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/pagination.rst b/user_guide_src/source/libraries/pagination.rst
index d9d3f5092..06627cfeb 100644
--- a/user_guide_src/source/libraries/pagination.rst
+++ b/user_guide_src/source/libraries/pagination.rst
@@ -15,7 +15,7 @@ Example
 *******
 
 Here is a simple example showing how to create pagination in one of your
-:doc:`controller <../general/controllers>` functions::
+:doc:`controller <../general/controllers>` methods::
 
 	$this->load->library('pagination');
 
@@ -30,8 +30,8 @@ Here is a simple example showing how to create pagination in one of your
 Notes
 =====
 
-The $config array contains your configuration variables. It is passed to
-the $this->pagination->initialize function as shown above. Although
+The ``$config`` array contains your configuration variables. It is passed to
+the ``$this->pagination->initialize()`` method as shown above. Although
 there are some twenty items you can configure, at minimum you need the
 three shown. Here is a description of what those items represent:
 
@@ -46,7 +46,7 @@ three shown. Here is a description of what those items represent:
 -  **per_page** The number of items you intend to show per page. In the
    above example, you would be showing 20 items per page.
 
-The create_links() function returns an empty string when there is no
+The ``create_links()`` method returns an empty string when there is no
 pagination to show.
 
 Setting preferences in a config file
@@ -54,9 +54,9 @@ Setting preferences in a config file
 
 If you prefer not to set preferences using the above method, you can
 instead put them into a config file. Simply create a new file called
-pagination.php, add the $config array in that file. Then save the file
-in: config/pagination.php and it will be used automatically. You will
-NOT need to use the $this->pagination->initialize function if you save
+pagination.php, add the ``$config`` array in that file. Then save the file
+in *application/config/pagination.php* and it will be used automatically.
+You will NOT need to use ``$this->pagination->initialize()`` if you save
 your preferences in a config file.
 
 **************************
@@ -67,14 +67,14 @@ The following is a list of all the preferences you can pass to the
 initialization function to tailor the display.
 
 $config['uri_segment'] = 3;
-============================
+===========================
 
 The pagination function automatically determines which segment of your
 URI contains the page number. If you need something different you can
 specify it.
 
 $config['num_links'] = 2;
-==========================
+=========================
 
 The number of "digit" links you would like before and after the selected
 page number. For example, the number 2 will place two digits on either
@@ -92,25 +92,19 @@ $config['page_query_string'] = TRUE;
 
 By default, the pagination library assume you are using :doc:`URI
 Segments <../general/urls>`, and constructs your links something
-like
-
-::
+like::
 
 	http://example.com/index.php/test/page/20
 
-
-If you have $config['enable_query_strings'] set to TRUE your links
+If you have ``$config['enable_query_strings']`` set to TRUE your links
 will automatically be re-written using Query Strings. This option can
-also be explictly set. Using $config['page_query_string'] set to TRUE,
-the pagination link will become.
-
-::
+also be explictly set. Using ``$config['page_query_string']`` set to TRUE,
+the pagination link will become::
 
 	http://example.com/index.php?c=test&m=page&per_page=20
 
-
 Note that "per_page" is the default query string passed, however can be
-configured using $config['query_string_segment'] = 'your_string'
+configured using ``$config['query_string_segment'] = 'your_string'``
 
 $config['reuse_query_string'] = FALSE;
 ======================================
@@ -118,9 +112,7 @@ $config['reuse_query_string'] = FALSE;
 By default your Query String arguments (nothing to do with other
 query string options) will be ignored. Setting this config to
 TRUE will add existing query string arguments back into the
-URL after the URI segment and before the suffix
-
-::
+URL after the URI segment and before the suffix.::
 
 	http://example.com/index.php/test/page/20?query=search%term
 
@@ -128,13 +120,13 @@ This helps you mix together normal :doc:`URI Segments <../general/urls>`
 as well as query string arguments, which until 3.0 was not possible.
 
 $config['prefix'] = '';
-==================================
+=======================
 
 A custom prefix added to the path. The prefix value will be right before
 the offset segment.
 
 $config['suffix'] = '';
-==================================
+=======================
 
 A custom suffix added to the path. The sufix value will be right after
 the offset segment.
@@ -144,15 +136,15 @@ Adding Enclosing Markup
 ***********************
 
 If you would like to surround the entire pagination with some markup you
-can do it with these two prefs:
+can do it with these two preferences:
 
 $config['full_tag_open'] = '<p>';
-===================================
+=================================
 
 The opening tag placed on the left side of the entire result.
 
 $config['full_tag_close'] = '</p>';
-=====================================
+===================================
 
 The closing tag placed on the right side of the entire result.
 
@@ -161,18 +153,18 @@ Customizing the First Link
 **************************
 
 $config['first_link'] = 'First';
-=================================
+================================
 
 The text you would like shown in the "first" link on the left. If you do
 not want this link rendered, you can set its value to FALSE.
 
 $config['first_tag_open'] = '<div>';
-======================================
+====================================
 
 The opening tag for the "first" link.
 
 $config['first_tag_close'] = '</div>';
-========================================
+======================================
 
 The closing tag for the "first" link.
 
@@ -181,18 +173,18 @@ Customizing the Last Link
 *************************
 
 $config['last_link'] = 'Last';
-===============================
+==============================
 
 The text you would like shown in the "last" link on the right. If you do
 not want this link rendered, you can set its value to FALSE.
 
 $config['last_tag_open'] = '<div>';
-=====================================
+===================================
 
 The opening tag for the "last" link.
 
 $config['last_tag_close'] = '</div>';
-=======================================
+=====================================
 
 The closing tag for the "last" link.
 
@@ -201,18 +193,18 @@ Customizing the "Next" Link
 ***************************
 
 $config['next_link'] = '&gt;';
-===============================
+==============================
 
 The text you would like shown in the "next" page link. If you do not
 want this link rendered, you can set its value to FALSE.
 
 $config['next_tag_open'] = '<div>';
-=====================================
+===================================
 
 The opening tag for the "next" link.
 
 $config['next_tag_close'] = '</div>';
-=======================================
+=====================================
 
 The closing tag for the "next" link.
 
@@ -221,18 +213,18 @@ Customizing the "Previous" Link
 *******************************
 
 $config['prev_link'] = '&lt;';
-===============================
+==============================
 
 The text you would like shown in the "previous" page link. If you do not
 want this link rendered, you can set its value to FALSE.
 
 $config['prev_tag_open'] = '<div>';
-=====================================
+===================================
 
 The opening tag for the "previous" link.
 
 $config['prev_tag_close'] = '</div>';
-=======================================
+=====================================
 
 The closing tag for the "previous" link.
 
@@ -241,12 +233,12 @@ Customizing the "Current Page" Link
 ***********************************
 
 $config['cur_tag_open'] = '<b>';
-==================================
+================================
 
 The opening tag for the "current" link.
 
 $config['cur_tag_close'] = '</b>';
-====================================
+==================================
 
 The closing tag for the "current" link.
 
@@ -255,12 +247,12 @@ Customizing the "Digit" Link
 ****************************
 
 $config['num_tag_open'] = '<div>';
-====================================
+==================================
 
 The opening tag for the "digit" link.
 
 $config['num_tag_close'] = '</div>';
-======================================
+====================================
 
 The closing tag for the "digit" link.
 
@@ -280,9 +272,7 @@ Adding attributes to anchors
 
 If you want to add an extra attribute to be added to every link rendered
 by the pagination class, you can set them as key/value pairs in the
-"attributes" config
-
-::
+"attributes" config::
 
 	// Produces: class="myclass"
 	$config['attributes'] = array('class' => 'myclass');
@@ -300,4 +290,23 @@ you can pass boolean FALSE as a regular attribute
 
 ::
 
-	$config['attributes']['rel'] = FALSE;
\ No newline at end of file
+	$config['attributes']['rel'] = FALSE;
+
+***************
+Class Reference
+***************
+
+.. class:: CI_Pagination
+
+	.. method:: initialize([$params = array()])
+
+		:param array $params: Configuration parameters
+		:returns: void
+
+		Initializes the Pagination class with your preferred options.
+
+	.. method:: create_links()
+
+		:returns: string
+
+		Returns a "pagination" bar, containing the generated links or an empty string if there's just a single page.
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From c8f34854d6fe11f0b71aa6b1ebb30412937f062c Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Fri, 3 Jan 2014 13:47:27 +0200
Subject: [ci skip] Update the Output library docs

---
 user_guide_src/source/libraries/output.rst | 224 +++++++++++++++--------------
 1 file changed, 120 insertions(+), 104 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/output.rst b/user_guide_src/source/libraries/output.rst
index a3d67b847..a518f853d 100644
--- a/user_guide_src/source/libraries/output.rst
+++ b/user_guide_src/source/libraries/output.rst
@@ -2,7 +2,7 @@
 Output Class
 ############
 
-The Output class is a small class with one main function: To send the
+The Output class is a core class with one main function: To send the
 finalized web page to the requesting browser. It is also responsible for
 :doc:`caching <../general/caching>` your web pages, if you use that
 feature.
@@ -16,159 +16,175 @@ use the :doc:`Loader <../libraries/loader>` class to load a view file,
 it's automatically passed to the Output class, which will be called
 automatically by CodeIgniter at the end of system execution. It is
 possible, however, for you to manually intervene with the output if you
-need to, using either of the two following functions:
+need to.
 
-$this->output->set_output();
-=============================
+***************
+Class Reference
+***************
 
-Permits you to manually set the final output string. Usage example::
+.. class:: CI_Output
 
-	$this->output->set_output($data);
+	.. attribute:: $parse_exec_vars = TRUE;
 
-.. important:: If you do set your output manually, it must be the last
-	thing done in the function you call it from. For example, if you build a
-	page in one of your controller functions, don't set the output until the
-	end.
+		Enables/disables parsing of the {elapsed_time} and {memory_usage} pseudo-variables.
 
-$this->output->set_content_type();
-====================================
+		CodeIgniter will parse those tokens in your output by default. To disable this, set
+		this property to FALSE in your controller.
+		::
 
-Permits you to set the mime-type of your page so you can serve JSON
-data, JPEG's, XML, etc easily.
+			$this->output->parse_exec_vars = FALSE;
 
-::
+	.. method:: set_output($output)
 
-	$this->output
-	    ->set_content_type('application/json')
-	    ->set_output(json_encode(array('foo' => 'bar')));
+		:param string $output: String to set the output to
+		:returns: object
 
-	$this->output
-	    ->set_content_type('jpeg') // You could also use ".jpeg" which will have the full stop removed before looking in config/mimes.php
-	    ->set_output(file_get_contents('files/something.jpg'));
+		Permits you to manually set the final output string. Usage example::
 
-.. important:: Make sure any non-mime string you pass to this method
-	exists in config/mimes.php or it will have no effect.
+			$this->output->set_output($data);
 
-You can also set the character set of the document, by passing a second argument::
+		.. important:: If you do set your output manually, it must be the last thing done
+			in the function you call it from. For example, if you build a page in one
+			of your controller functions, don't set the output until the end.
 
-	$this->output->set_content_type('css', 'utf-8');
+	.. method:: set_content_type($mime_type[, $charset = NULL])
 
-$this->output->get_content_type()
-=================================
+		:param string $mime_type: MIME Type idenitifer string
+		:param string $charset: Character set
+		:returns: object
 
-Returns the Content-Type HTTP header that's currently in use,
-excluding the character set value.
+		Permits you to set the mime-type of your page so you can serve JSON data, JPEG's, XML, etc easily.
+		::
 
-	$mime = $this->output->get_content_type();
+			$this->output
+				->set_content_type('application/json')
+				->set_output(json_encode(array('foo' => 'bar')));
 
-.. note:: If not set, the default return value is 'text/html'.
+			$this->output
+				->set_content_type('jpeg') // You could also use ".jpeg" which will have the full stop removed before looking in config/mimes.php
+				->set_output(file_get_contents('files/something.jpg'));
 
-$this->output->get_header()
-===========================
+		.. important:: Make sure any non-mime string you pass to this method
+			exists in *application/config/mimes.php* or it will have no effect.
 
-Gets the requested HTTP header value, if set.
+		You can also set the character set of the document, by passing a second argument::
 
-If the header is not set, NULL will be returned.
-If an empty value is passed to the method, it will return FALSE.
+			$this->output->set_content_type('css', 'utf-8');
 
-Example::
+	.. method:: get_content_type()
 
-	$this->output->set_content_type('text/plain', 'UTF-8');
-	echo $this->output->get_header('content-type');
-	// Outputs: text/plain; charset=utf-8
+		:returns: string
 
-.. note:: The header name is compared in a case-insensitive manner.
+		Returns the Content-Type HTTP header that's currently in use, excluding the character set value.
+		::
 
-.. note:: Raw headers sent via PHP's native ``header()`` function are
-	also detected.
+			$mime = $this->output->get_content_type();
 
-$this->output->get_output()
-===========================
+		.. note:: If not set, the default return value is 'text/html'.
 
-Permits you to manually retrieve any output that has been sent for
-storage in the output class. Usage example::
+	.. method:: get_header($header)
 
-	$string = $this->output->get_output();
+		:param string $header: HTTP header name
+		:returns: string
 
-Note that data will only be retrievable from this function if it has
-been previously sent to the output class by one of the CodeIgniter
-functions like $this->load->view().
+		Returns the requested HTTP header value, or NULL if the requested header is not set.
+		Example::
 
-$this->output->append_output();
-================================
+			$this->output->set_content_type('text/plain', 'UTF-8');
+			echo $this->output->get_header('content-type');
+			// Outputs: text/plain; charset=utf-8
 
-Appends data onto the output string. Usage example::
+		.. note:: The header name is compared in a case-insensitive manner.
 
-	$this->output->append_output($data);
+		.. note:: Raw headers sent via PHP's native ``header()`` function are also detected.
 
-$this->output->set_header();
-=============================
+	.. method:: get_output()
 
-Permits you to manually set server headers, which the output class will
-send for you when outputting the final rendered display. Example::
+		:returns: string
 
-	$this->output->set_header("HTTP/1.0 200 OK");
-	$this->output->set_header("HTTP/1.1 200 OK");
-	$this->output->set_header('Last-Modified: '.gmdate('D, d M Y H:i:s', $last_update).' GMT');
-	$this->output->set_header("Cache-Control: no-store, no-cache, must-revalidate");
-	$this->output->set_header("Cache-Control: post-check=0, pre-check=0");
-	$this->output->set_header("Pragma: no-cache");
+		Permits you to manually retrieve any output that has been sent for
+		storage in the output class. Usage example::
 
-$this->output->set_status_header(code, 'text');
-=================================================
+			$string = $this->output->get_output();
 
-Permits you to manually set a server status header. Example::
+		Note that data will only be retrievable from this function if it has
+		been previously sent to the output class by one of the CodeIgniter
+		functions like ``$this->load->view()``.
 
-	$this->output->set_status_header('401');
-	// Sets the header as:  Unauthorized
+	.. method:: append_output($output)
 
-`See here <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html>`_ for
-a full list of headers.
+		:param string $output: Additional output data to append
+		:returns: object
 
-.. note:: This method is an alias for :doc:`Common function <../general/common_functions>`
-	``set_status_header()``.
+		Appends data onto the output string.
+		::
 
-$this->output->enable_profiler();
-==================================
+			$this->output->append_output($data);
 
-Permits you to enable/disable the
-:doc:`Profiler <../general/profiling>`, which will display benchmark
-and other data at the bottom of your pages for debugging and
-optimization purposes.
+	.. method:: set_header($header[, $replace = TRUE])
 
-To enable the profiler place the following function anywhere within your
-:doc:`Controller <../general/controllers>` functions::
+		:param string $header: HTTP Header
+		:param bool $replace: Whether to replace the old header value, if it is already set
+		:returns: object
 
-	$this->output->enable_profiler(TRUE);
+		Permits you to manually set server headers, which the output class will
+		send for you when outputting the final rendered display. Example::
 
-When enabled a report will be generated and inserted at the bottom of
-your pages.
+			$this->output->set_header('HTTP/1.0 200 OK');
+			$this->output->set_header('HTTP/1.1 200 OK');
+			$this->output->set_header('Last-Modified: '.gmdate('D, d M Y H:i:s', $last_update).' GMT');
+			$this->output->set_header('Cache-Control: no-store, no-cache, must-revalidate');
+			$this->output->set_header('Cache-Control: post-check=0, pre-check=0');
+			$this->output->set_header('Pragma: no-cache');
 
-To disable the profiler you will use::
+	.. method:: set_status_header([$code = 200[, $text = '']])
 
-	$this->output->enable_profiler(FALSE);
+		:param int $code: HTTP status code
+		:param string $text: Optional message
+		:returns: object
 
-$this->output->set_profiler_sections();
-=========================================
+		Permits you to manually set a server status header. Example::
 
-Permits you to enable/disable specific sections of the Profiler when
-enabled. Please refer to the :doc:`Profiler <../general/profiling>`
-documentation for further information.
+			$this->output->set_status_header('401');
+			// Sets the header as:  Unauthorized
 
-$this->output->cache();
-=======================
+		`See here <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html>`_ for a full list of headers.
 
-The CodeIgniter output library also controls caching. For more
-information, please see the :doc:`caching
-documentation <../general/caching>`.
+		.. note:: This method is an alias for :doc:`Common function <../general/common_functions>`
+			:func:`set_status_header()`.
 
-Parsing Execution Variables
-===========================
+	.. method:: enable_profiler([$val = TRUE])
 
-CodeIgniter will parse the pseudo-variables {elapsed_time} and
-{memory_usage} in your output by default. To disable this, set the
-$parse_exec_vars class property to FALSE in your controller.
-::
+		:param bool $val: Whether to enable or disable the Profiler
+		:returns: object
 
-	$this->output->parse_exec_vars = FALSE;
+		Permits you to enable/disable the :doc:`Profiler <../general/profiling>`, which will display benchmark
+		and other data at the bottom of your pages for debugging and optimization purposes.
 
+		To enable the profiler place the following line anywhere within your
+		:doc:`Controller <../general/controllers>` methods::
+
+			$this->output->enable_profiler(TRUE);
+
+		When enabled a report will be generated and inserted at the bottom of your pages.
+
+		To disable the profiler you would use::
+
+			$this->output->enable_profiler(FALSE);
+
+	.. method:: set_profiler_sections($sections)
+
+		:param array $sections: Profiler sections
+		:returns: object
+
+		Permits you to enable/disable specific sections of the Profiler when it is enabled.
+		Please refer to the :doc:`Profiler <../general/profiling>` documentation for further information.
+
+	.. method:: cache($time)
+
+		:param int $time: Cache expiration time in seconds
+		:returns: object
+
+		Caches the current page for the specified amount of seconds.
+
+		For more information, please see the :doc:`caching documentation <../general/caching>`.
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 11f58dcb887316f86e9e1f148355bf3a01ca1877 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Fri, 3 Jan 2014 13:57:58 +0200
Subject: [ci skip] Update the Migration library docs

---
 user_guide_src/source/libraries/migration.rst | 116 ++++++++++++++------------
 1 file changed, 62 insertions(+), 54 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/migration.rst b/user_guide_src/source/libraries/migration.rst
index b734f5c34..a007d5be7 100644
--- a/user_guide_src/source/libraries/migration.rst
+++ b/user_guide_src/source/libraries/migration.rst
@@ -10,8 +10,8 @@ need to be run against the production machines next time you deploy.
 
 The database table **migration** tracks which migrations have already been 
 run so all you have to do is update your application files and 
-call **$this->migration->current()** to work out which migrations should be run. 
-The current version is found in **config/migration.php**.
+call ``$this->migration->current()`` to work out which migrations should be run. 
+The current version is found in **application/config/migration.php**.
 
 ********************
 Migration file names
@@ -28,23 +28,24 @@ method taken. Two numbering styles are available:
   helps prevent numbering conflicts when working in a team environment, and is
   the preferred scheme in CodeIgniter 3.0 and later.
 
-The desired style may be selected using the **$config['migration_type']**
-setting in your **migration.php** config file.
+The desired style may be selected using the ``$config['migration_type']``
+setting in your *application/config/migration.php* file.
 
 Regardless of which numbering style you choose to use, prefix your migration
 files with the migration number followed by an underscore and a descriptive
 name for the migration. For example:
 
-* **001_add_blog.php** (sequential numbering)
-* **20121031100537_add_blog.php** (timestamp numbering)
+* 001_add_blog.php (sequential numbering)
+* 20121031100537_add_blog.php (timestamp numbering)
 
 ******************
 Create a Migration
 ******************
 	
 This will be the first migration for a new site which has a blog. All 
-migrations go in the folder **application/migrations/** and have names such 
-as **20121031100537_add_blog.php**.::
+migrations go in the **application/migrations/** directory and have names such 
+as *20121031100537_add_blog.php*.
+::
 
 	<?php
 
@@ -80,7 +81,7 @@ as **20121031100537_add_blog.php**.::
 		}
 	}
 
-Then in **application/config/migration.php** set **$config['migration_version'] = 1;**.
+Then in **application/config/migration.php** set ``$config['migration_version'] = 1;``.
 
 *************
 Usage Example
@@ -93,54 +94,18 @@ to update the schema.::
 	
 	class Migrate extends CI_Controller
 	{
-	    public function index()
-	    {
-	    	$this->load->library('migration');
-	    	
-	    	if ($this->migration->current() === FALSE)
-	    	{
-	    		show_error($this->migration->error_string());
-	    	}
-	    }
-	}
-
-******************
-Function Reference
-******************
-
-$this->migration->current()
-============================
-
-The current migration is whatever is set for **$config['migration_version']** in 
-**application/config/migration.php**.
-
-$this->migration->error_string()
-=================================
-
-This returns a string of errors while performing a migration.
-
-$this->migration->find_migrations()
-====================================
 
-An array of migration filenames are returned that are found in the **migration_path** 
-property.
-
-$this->migration->latest()
-===========================
-
-This works much the same way as current() but instead of looking for 
-the **$config['migration_version']** the Migration class will use the very 
-newest migration found in the filesystem.
-
-$this->migration->version()
-============================
-
-Version can be used to roll back changes or step forwards programmatically to 
-specific versions. It works just like current but ignores **$config['migration_version']**.::
+		public function index()
+		{
+			$this->load->library('migration');
 
-	$this->load->library('migration');
+			if ($this->migration->current() === FALSE)
+			{
+				show_error($this->migration->error_string());
+			}
+		}
 
-	$this->migration->version(5);
+	}
 
 *********************
 Migration Preferences
@@ -161,3 +126,46 @@ Preference                 Default                Options                    Des
 **migration_type**         'timestamp'            'timestamp' / 'sequential' The type of numeric identifier used to name
                                                                              migration files.
 ========================== ====================== ========================== =============================================
+
+***************
+Class Reference
+***************
+
+.. class:: CI_Migration
+
+	.. method:: current()
+
+		:returns: mixed
+
+		Migrates up to the current version (whatever is set for ``$config['migration_version']`` in *application/config/migration.php*).
+
+	.. method:: error_string()
+
+		:returns: string
+
+		This returns a string of errors that were detected while performing a migration.
+
+	.. method:: find_migrations()
+
+		:returns: array
+
+		An array of migration filenames are returned that are found in the **migration_path** property.
+
+	.. method:: latest()
+
+		:returns: mixed
+
+		This works much the same way as ``current()`` but instead of looking for 
+		the ``$config['migration_version']`` the Migration class will use the very 
+		newest migration found in the filesystem.
+
+	.. method:: version($target_version)
+
+		:param mixed $target_version: Migration version to process
+		:returns: mixed
+
+		Version can be used to roll back changes or step forwards programmatically to 
+		specific versions. It works just like ``current()`` but ignores ``$config['migration_version']``.
+		::
+
+			$this->migration->version(5);
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 3a5638b51deb1921a149d416846e3078bc38163d Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Fri, 3 Jan 2014 14:57:03 +0200
Subject: [ci skip] Update the URI library docs

---
 user_guide_src/source/libraries/uri.rst | 273 +++++++++++++++++---------------
 1 file changed, 149 insertions(+), 124 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/uri.rst b/user_guide_src/source/libraries/uri.rst
index bb959b002..1256afdef 100644
--- a/user_guide_src/source/libraries/uri.rst
+++ b/user_guide_src/source/libraries/uri.rst
@@ -2,187 +2,212 @@
 URI Class
 #########
 
-The URI Class provides functions that help you retrieve information from
+The URI Class provides methods that help you retrieve information from
 your URI strings. If you use URI routing, you can also retrieve
 information about the re-routed segments.
 
 .. note:: This class is initialized automatically by the system so there
 	is no need to do it manually.
 
-$this->uri->segment(n)
-======================
+***************
+Class Reference
+***************
 
-Permits you to retrieve a specific segment. Where n is the segment
-number you wish to retrieve. Segments are numbered from left to right.
-For example, if your full URL is this::
+.. class:: CI_URI
 
-	http://example.com/index.php/news/local/metro/crime_is_up
+	.. method:: segment($n[, $no_result = NULL])
 
-The segment numbers would be this:
+		:param int $n: Segment index number
+		:param mixed $no_result: What to return if the searched segment is not found
+		:returns: mixed
 
-#. news
-#. local
-#. metro
-#. crime_is_up
+		Permits you to retrieve a specific segment. Where n is the segment
+		number you wish to retrieve. Segments are numbered from left to right.
+		For example, if your full URL is this::
 
-By default the function returns NULL if the segment does not
-exist. There is an optional second parameter that permits you to set
-your own default value if the segment is missing. For example, this
-would tell the function to return the number zero in the event of
-failure::
+			http://example.com/index.php/news/local/metro/crime_is_up
 
-	$product_id = $this->uri->segment(3, 0);
+		The segment numbers would be this:
 
-It helps avoid having to write code like this::
+		#. news
+		#. local
+		#. metro
+		#. crime_is_up
 
-	if ($this->uri->segment(3) === FALSE)
-	{
-	    $product_id = 0;
-	}
-	else
-	{
-	    $product_id = $this->uri->segment(3);
-	}
+		The optional second parameter defaults to NULL and allows you to set the return value
+		of this method when the requested URI segment is missing.
+		For example, this would tell the method to return the number zero in the event of failure::
 
-$this->uri->rsegment(n)
-=======================
+			$product_id = $this->uri->segment(3, 0);
 
-This function is identical to the previous one, except that it lets you
-retrieve a specific segment from your re-routed URI in the event you are
-using CodeIgniter's :doc:`URI Routing <../general/routing>` feature.
+		It helps avoid having to write code like this::
 
-$this->uri->slash_segment(n)
-=============================
+			if ($this->uri->segment(3) === FALSE)
+			{
+				$product_id = 0;
+			}
+			else
+			{
+				$product_id = $this->uri->segment(3);
+			}
 
-This function is almost identical to $this->uri->segment(), except it
-adds a trailing and/or leading slash based on the second parameter. If
-the parameter is not used, a trailing slash added. Examples::
+	.. method:: rsegment($n[, $no_result = NULL])
 
-	$this->uri->slash_segment(3);
-	$this->uri->slash_segment(3, 'leading');
-	$this->uri->slash_segment(3, 'both');
+		:param int $n: Segment index number
+		:param mixed $no_result: What to return if the searched segment is not found
+		:returns: mixed
 
-Returns:
+		This method is identical to ``segment()``, except that it lets you retrieve
+		a specific segment from your re-routed URI in the event you are
+		using CodeIgniter's :doc:`URI Routing <../general/routing>` feature.
 
-#. segment/
-#. /segment
-#. /segment/
+	.. method:: slash_segment($n[, $where = 'trailing'])
 
-$this->uri->slash_rsegment(n)
-==============================
+		:param int $n: Segment index number
+		:param string $where: Where to add the slash ('trailing' or 'leading')
+		:returns: string
 
-This function is identical to the previous one, except that it lets you
-add slashes a specific segment from your re-routed URI in the event you
-are using CodeIgniter's :doc:`URI Routing <../general/routing>`
-feature.
+		This method is almost identical to ``segment()``, except it
+		adds a trailing and/or leading slash based on the second parameter.
+		If the parameter is not used, a trailing slash added. Examples::
 
-$this->uri->uri_to_assoc(n)
-=============================
+			$this->uri->slash_segment(3);
+			$this->uri->slash_segment(3, 'leading');
+			$this->uri->slash_segment(3, 'both');
 
-This function lets you turn URI segments into and associative array of
-key/value pairs. Consider this URI::
+		Returns:
 
-	index.php/user/search/name/joe/location/UK/gender/male
+		#. segment/
+		#. /segment
+		#. /segment/
 
-Using this function you can turn the URI into an associative array with
-this prototype::
+	.. method:: slash_rsegment($n[, $where = 'trailing'])
 
-	[array]
-	(
-	    'name' => 'joe'
-	    'location'	=> 'UK'
-	    'gender'	=> 'male'
-	)
+		:param int $n: Segment index number
+		:param string $where: Where to add the slash ('trailing' or 'leading')
+		:returns: string
 
-The first parameter of the function lets you set an offset. By default
-it is set to 3 since your URI will normally contain a
-controller/function in the first and second segments. Example::
+		This method is identical to ``slash_segment()``, except that it lets you
+		add slashes a specific segment from your re-routed URI in the event you
+		are using CodeIgniter's :doc:`URI Routing <../general/routing>`
+		feature.
 
-	$array = $this->uri->uri_to_assoc(3);
+	.. method:: uri_to_assoc([$n = 3[, $default = array()]])
 
-	echo $array['name'];
+		:param int $n: Segment index number
+		:param array $default: Default values
+		:returns: array
 
-The second parameter lets you set default key names, so that the array
-returned by the function will always contain expected indexes, even if
-missing from the URI. Example::
+		This method lets you turn URI segments into and associative array of
+		key/value pairs. Consider this URI::
 
-	$default = array('name', 'gender', 'location', 'type', 'sort');
+			index.php/user/search/name/joe/location/UK/gender/male
 
-	$array = $this->uri->uri_to_assoc(3, $default);
+		Using this method you can turn the URI into an associative array with
+		this prototype::
 
-If the URI does not contain a value in your default, an array index will
-be set to that name, with a value of FALSE.
+			[array]
+			(
+				'name'		=> 'joe'
+				'location'	=> 'UK'
+				'gender'	=> 'male'
+			)
 
-Lastly, if a corresponding value is not found for a given key (if there
-is an odd number of URI segments) the value will be set to FALSE
-(boolean).
+		The first parameter lets you set an offset, which defaults to 3 since your
+		URI will normally contain a controller/method pair in the first and second segments.
+		Example::
 
-$this->uri->ruri_to_assoc(n)
-==============================
+			$array = $this->uri->uri_to_assoc(3);
+			echo $array['name'];
 
-This function is identical to the previous one, except that it creates
-an associative array using the re-routed URI in the event you are using
-CodeIgniter's :doc:`URI Routing <../general/routing>` feature.
+		The second parameter lets you set default key names, so that the array
+		returned will always contain expected indexes, even if missing from the URI.
+		Example::
 
-$this->uri->assoc_to_uri()
-============================
+			$default = array('name', 'gender', 'location', 'type', 'sort');
+			$array = $this->uri->uri_to_assoc(3, $default);
 
-Takes an associative array as input and generates a URI string from it.
-The array keys will be included in the string. Example::
+		If the URI does not contain a value in your default, an array index will
+		be set to that name, with a value of NULL.
 
-	$array = array('product' => 'shoes', 'size' => 'large', 'color' => 'red');
+		Lastly, if a corresponding value is not found for a given key (if there
+		is an odd number of URI segments) the value will be set to NULL.
 
-	$str = $this->uri->assoc_to_uri($array);
+	.. method:: ruri_to_assoc([$n = 3[, $default = array()]])
 
-	// Produces: product/shoes/size/large/color/red
+		:param int $n: Segment index number
+		:param array $default: Default values
+		:returns: array
 
-$this->uri->uri_string()
-=========================
+		This method is identical to ``uri_to_assoc()``, except that it creates
+		an associative array using the re-routed URI in the event you are using
+		CodeIgniter's :doc:`URI Routing <../general/routing>` feature.
 
-Returns a string with the complete URI. For example, if this is your
-full URL::
+	.. method:: assoc_to_uri($array)
 
-	http://example.com/index.php/news/local/345
+		:param array $array: Input array of key/value pairs
+		:returns: string
 
-The function would return this::
+		Takes an associative array as input and generates a URI string from it.
+		The array keys will be included in the string. Example::
 
-	news/local/345
+			$array = array('product' => 'shoes', 'size' => 'large', 'color' => 'red');
+			$str = $this->uri->assoc_to_uri($array);
 
-$this->uri->ruri_string()
-==========================
+			// Produces: product/shoes/size/large/color/red
 
-This function is identical to the previous one, except that it returns
-the re-routed URI in the event you are using CodeIgniter's :doc:`URI
-Routing <../general/routing>` feature.
+	.. method:: uri_string()
 
-$this->uri->total_segments()
-=============================
+		:returns: string
 
-Returns the total number of segments.
+		Returns a string with the complete URI. For example, if this is your full URL::
 
-$this->uri->total_rsegments()
-==============================
+			http://example.com/index.php/news/local/345
 
-This function is identical to the previous one, except that it returns
-the total number of segments in your re-routed URI in the event you are
-using CodeIgniter's :doc:`URI Routing <../general/routing>` feature.
+		The method would return this::
 
-$this->uri->segment_array()
-============================
+			news/local/345
 
-Returns an array containing the URI segments. For example::
+	.. method:: ruri_string()
 
-	$segs = $this->uri->segment_array();
+		:returns: string
 
-	foreach ($segs as $segment)
-	{
-	    echo $segment;
-	    echo '<br />';
-	}
+		This method is identical to ``uri_string()``, except that it returns
+		the re-routed URI in the event you are using CodeIgniter's :doc:`URI
+		Routing <../general/routing>` feature.
 
-$this->uri->rsegment_array()
-=============================
+	.. method:: total_segments()
 
-This function is identical to the previous one, except that it returns
-the array of segments in your re-routed URI in the event you are using
-CodeIgniter's :doc:`URI Routing <../general/routing>` feature.
+		:returns: int
+
+		Returns the total number of segments.
+
+	.. method:: total_rsegments()
+
+		:returns: int
+
+		This method is identical to ``total_segments()``, except that it returns
+		the total number of segments in your re-routed URI in the event you are
+		using CodeIgniter's :doc:`URI Routing <../general/routing>` feature.
+
+	.. method:: segment_array()
+
+		:returns: array
+
+		Returns an array containing the URI segments. For example::
+
+			$segs = $this->uri->segment_array();
+
+			foreach ($segs as $segment)
+			{
+				echo $segment;
+				echo '<br />';
+			}
+
+	.. method:: rsegment_array()
+
+		:returns: array
+
+		This method is identical to ``segment_array()``, except that it returns
+		the array of segments in your re-routed URI in the event you are using
+		CodeIgniter's :doc:`URI Routing <../general/routing>` feature.
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From cc042095bcce9856402cc04997f44310074716e0 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Fri, 3 Jan 2014 17:08:27 +0200
Subject: [ci skip] Some more generic user guide cleanup

---
 user_guide_src/source/libraries/caching.rst    | 38 ++++++--------------------
 user_guide_src/source/libraries/migration.rst  |  7 +++++
 user_guide_src/source/libraries/output.rst     |  7 +++++
 user_guide_src/source/libraries/pagination.rst |  7 +++++
 user_guide_src/source/libraries/parser.rst     |  7 +++++
 user_guide_src/source/libraries/security.rst   |  7 +++++
 user_guide_src/source/libraries/sessions.rst   |  9 +++++-
 user_guide_src/source/libraries/table.rst      |  8 +++---
 user_guide_src/source/libraries/trackback.rst  |  4 +--
 user_guide_src/source/libraries/typography.rst |  4 +--
 user_guide_src/source/libraries/uri.rst        |  7 +++++
 user_guide_src/source/libraries/user_agent.rst |  4 +--
 user_guide_src/source/libraries/xmlrpc.rst     |  4 +--
 user_guide_src/source/libraries/zip.rst        |  4 +--
 14 files changed, 73 insertions(+), 44 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/caching.rst b/user_guide_src/source/libraries/caching.rst
index 55fdabca3..709171dd3 100644
--- a/user_guide_src/source/libraries/caching.rst
+++ b/user_guide_src/source/libraries/caching.rst
@@ -54,17 +54,15 @@ Class Reference
 
 .. class:: CI_Cache
 
-	.. method:: is_supported ( $driver )
+	.. method:: is_supported($driver)
 
 		:param string $driver: the name of the caching driver
 		:returns: TRUE if supported, FALSE if not
-		:rtype: Boolean
 
 		This method is automatically called when accessing drivers via
-		$this->cache->get(). However, if the individual drivers are used, make
-		sure to call this method to ensure the driver is supported in the
+		``$this->cache->get()``. However, if the individual drivers are used,
+		make sure to call this method to ensure the driver is supported in the
 		hosting environment.
-
 		::
 
 			if ($this->cache->apc->is_supported()
@@ -75,71 +73,56 @@ Class Reference
 				}
 			}
 
-
-	.. method:: get ( $id )
+	.. method:: get($id)
 
 		:param string $id: name of cached item
 		:returns: The item if it exists, FALSE if it does not
-		:rtype: Mixed
 
 		This method will attempt to fetch an item from the cache store. If the
 		item does not exist, the method will return FALSE.
-
 		::
 
 			$foo = $this->cache->get('my_cached_item');
 
-
-	.. method:: save ( $id , $data [, $ttl = 60])
+	.. method:: save($id, $data[, $ttl = 60])
 
 		:param string $id: name of the cached item
 		:param mixed $data: the data to save
 		:param int $ttl: Time To Live, in seconds (default 60)
 		:returns: TRUE on success, FALSE on failure
-		:rtype: Boolean
 
 		This method will save an item to the cache store. If saving fails, the
 		method will return FALSE.
-
 		::
 
 			$this->cache->save('cache_item_id', 'data_to_cache');
 
-
-	.. method:: delete ( $id )
+	.. method:: delete($id)
 
 		:param string $id: name of cached item
 		:returns: TRUE if deleted, FALSE if the deletion fails
-		:rtype: Boolean
 
 		This method will delete a specific item from the cache store. If item
 		deletion fails, the method will return FALSE.
-
 		::
 
 			$this->cache->delete('cache_item_id');
 
-
-	.. method:: clean ( )
+	.. method:: clean()
 
 		:returns: TRUE if deleted, FALSE if the deletion fails
-		:rtype: Boolean
 
 		This method will 'clean' the entire cache. If the deletion of the
 		cache files fails, the method will return FALSE.
-
 		::
 
 			$this->cache->clean();
 
-
-	.. method:: cache_info ( )
+	.. method:: cache_info()
 
 		:returns: information on the entire cache
-		:rtype: Mixed
 
 		This method will return information on the entire cache.
-
 		::
 
 			var_dump($this->cache->cache_info());
@@ -147,16 +130,13 @@ Class Reference
 		.. note:: The information returned and the structure of the data is dependent
 			on which adapter is being used.
 
-
-	.. method:: get_metadata ( $id )
+	.. method:: get_metadata($id)
 
 		:param string $id: name of cached item
 		:returns: metadadta for the cached item
-		:rtype: Mixed
 
 		This method will return detailed information on a specific item in the
 		cache.
-
 		::
 
 			var_dump($this->cache->get_metadata('my_cached_item'));
diff --git a/user_guide_src/source/libraries/migration.rst b/user_guide_src/source/libraries/migration.rst
index a007d5be7..128796c4d 100644
--- a/user_guide_src/source/libraries/migration.rst
+++ b/user_guide_src/source/libraries/migration.rst
@@ -13,6 +13,13 @@ run so all you have to do is update your application files and
 call ``$this->migration->current()`` to work out which migrations should be run. 
 The current version is found in **application/config/migration.php**.
 
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
+
 ********************
 Migration file names
 ********************
diff --git a/user_guide_src/source/libraries/output.rst b/user_guide_src/source/libraries/output.rst
index a518f853d..76197bdc1 100644
--- a/user_guide_src/source/libraries/output.rst
+++ b/user_guide_src/source/libraries/output.rst
@@ -18,6 +18,13 @@ automatically by CodeIgniter at the end of system execution. It is
 possible, however, for you to manually intervene with the output if you
 need to.
 
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
+
 ***************
 Class Reference
 ***************
diff --git a/user_guide_src/source/libraries/pagination.rst b/user_guide_src/source/libraries/pagination.rst
index 06627cfeb..34ca22141 100644
--- a/user_guide_src/source/libraries/pagination.rst
+++ b/user_guide_src/source/libraries/pagination.rst
@@ -5,6 +5,13 @@ Pagination Class
 CodeIgniter's Pagination class is very easy to use, and it is 100%
 customizable, either dynamically or via stored preferences.
 
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
+
 If you are not familiar with the term "pagination", it refers to links
 that allows you to navigate from page to page, like this::
 
diff --git a/user_guide_src/source/libraries/parser.rst b/user_guide_src/source/libraries/parser.rst
index 5c184be58..50bde82c7 100644
--- a/user_guide_src/source/libraries/parser.rst
+++ b/user_guide_src/source/libraries/parser.rst
@@ -35,6 +35,13 @@ representations that allow you to eliminate PHP from your templates
 	template parsing solution. We've kept it very lean on purpose in order
 	to maintain maximum performance.
 
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
+
 Initializing the Class
 ======================
 
diff --git a/user_guide_src/source/libraries/security.rst b/user_guide_src/source/libraries/security.rst
index 3d0697bbe..8d7ccb1ab 100644
--- a/user_guide_src/source/libraries/security.rst
+++ b/user_guide_src/source/libraries/security.rst
@@ -5,6 +5,13 @@ Security Class
 The Security Class contains methods that help you create a secure
 application, processing input data for security.
 
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
+
 XSS Filtering
 =============
 
diff --git a/user_guide_src/source/libraries/sessions.rst b/user_guide_src/source/libraries/sessions.rst
index b3de2252c..8e117bee6 100644
--- a/user_guide_src/source/libraries/sessions.rst
+++ b/user_guide_src/source/libraries/sessions.rst
@@ -9,6 +9,13 @@ which supports usage of the native PHP Session mechanism. In addition,
 you may create your own `Custom Drivers`_ to store session data however
 you wish, while still taking advantage of the features of the Session class.
 
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
+
 Initializing a Session
 ======================
 
@@ -27,7 +34,7 @@ use the ``$this->load->driver`` function::
 
 Once loaded, the Sessions library object will be available using::
 
-$this->session
+	$this->session
 
 How do Sessions work?
 =====================
diff --git a/user_guide_src/source/libraries/table.rst b/user_guide_src/source/libraries/table.rst
index 25927800e..bfe457993 100644
--- a/user_guide_src/source/libraries/table.rst
+++ b/user_guide_src/source/libraries/table.rst
@@ -5,12 +5,12 @@ HTML Table Class
 The Table Class provides functions that enable you to auto-generate HTML
 tables from arrays or database result sets.
 
-.. content::
-	:local:
+.. contents::
+  :local:
 
 .. raw:: html
 
-	<div class="custom-index container"></div>
+  <div class="custom-index container"></div>
 
 *********************
 Using the Table Class
@@ -280,4 +280,4 @@ Class Reference
 			$this->table->add_row('Mary', 'Monday', 'Air');
 			$this->table->add_row('John', 'Saturday', 'Overnight');
 
-			echo $this->table->generate();
+			echo $this->table->generate();
\ No newline at end of file
diff --git a/user_guide_src/source/libraries/trackback.rst b/user_guide_src/source/libraries/trackback.rst
index 72958934c..a1667c79c 100644
--- a/user_guide_src/source/libraries/trackback.rst
+++ b/user_guide_src/source/libraries/trackback.rst
@@ -9,11 +9,11 @@ If you are not familiar with Trackbacks you'll find more information
 `here <http://en.wikipedia.org/wiki/Trackback>`_.
 
 .. content::
-	:local:
+  :local:
 
 .. raw:: html
 
-	<div class="custom-index container"></div>
+  <div class="custom-index container"></div>
 
 *************************
 Using the Trackback Class
diff --git a/user_guide_src/source/libraries/typography.rst b/user_guide_src/source/libraries/typography.rst
index 8dab053ba..006e77d56 100644
--- a/user_guide_src/source/libraries/typography.rst
+++ b/user_guide_src/source/libraries/typography.rst
@@ -5,11 +5,11 @@ Typography Class
 The Typography Class provides methods that help you format text.
 
 .. content::
-	:local:
+  :local:
 
 .. raw:: html
 
-	<div class="custom-index container"></div>
+  <div class="custom-index container"></div>
 
 **************************
 Using the Typography Class
diff --git a/user_guide_src/source/libraries/uri.rst b/user_guide_src/source/libraries/uri.rst
index 1256afdef..f0fa04005 100644
--- a/user_guide_src/source/libraries/uri.rst
+++ b/user_guide_src/source/libraries/uri.rst
@@ -9,6 +9,13 @@ information about the re-routed segments.
 .. note:: This class is initialized automatically by the system so there
 	is no need to do it manually.
 
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
+
 ***************
 Class Reference
 ***************
diff --git a/user_guide_src/source/libraries/user_agent.rst b/user_guide_src/source/libraries/user_agent.rst
index 3662cf3ad..9f9676828 100644
--- a/user_guide_src/source/libraries/user_agent.rst
+++ b/user_guide_src/source/libraries/user_agent.rst
@@ -8,11 +8,11 @@ addition you can get referrer information as well as language and
 supported character-set information.
 
 .. contents::
-	:local:
+  :local:
 
 .. raw:: html
 
-	<div class="custom-index container"></div>
+  <div class="custom-index container"></div>
 
 **************************
 Using the User Agent Class
diff --git a/user_guide_src/source/libraries/xmlrpc.rst b/user_guide_src/source/libraries/xmlrpc.rst
index c79f8bed9..c89c69c46 100644
--- a/user_guide_src/source/libraries/xmlrpc.rst
+++ b/user_guide_src/source/libraries/xmlrpc.rst
@@ -6,11 +6,11 @@ CodeIgniter's XML-RPC classes permit you to send requests to another
 server, or set up your own XML-RPC server to receive requests.
 
 .. contents::
-	:local:
+  :local:
 
 .. raw:: html
 
-	<div class="custom-index container"></div>
+  <div class="custom-index container"></div>
 
 ****************
 What is XML-RPC?
diff --git a/user_guide_src/source/libraries/zip.rst b/user_guide_src/source/libraries/zip.rst
index e0955e3d6..ea5b46bac 100644
--- a/user_guide_src/source/libraries/zip.rst
+++ b/user_guide_src/source/libraries/zip.rst
@@ -7,11 +7,11 @@ archives. Archives can be downloaded to your desktop or saved to a
 directory.
 
 .. contents::
-	:local:
+  :local:
 
 .. raw:: html
 
-	 <div class="custom-index container"></div>
+  <div class="custom-index container"></div>
 
 ****************************
 Using the Zip Encoding Class
-- 
cgit v1.2.3-24-g4f1b


From eb21ac8e9b85b681bc03b935955b3fbfa9b0db1e Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Fri, 3 Jan 2014 17:27:29 +0200
Subject: [ci skip] Finish updating the FTP class docs

---
 user_guide_src/source/libraries/ftp.rst | 201 ++++++++++++++++++--------------
 1 file changed, 111 insertions(+), 90 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/ftp.rst b/user_guide_src/source/libraries/ftp.rst
index fd82590b9..1b1a45e36 100644
--- a/user_guide_src/source/libraries/ftp.rst
+++ b/user_guide_src/source/libraries/ftp.rst
@@ -37,7 +37,6 @@ Usage Examples
 In this example a connection is opened to the FTP server, and a local
 file is read and uploaded in ASCII mode. The file permissions are set to
 755.
-
 ::
 
 	$this->load->library('ftp');
@@ -54,7 +53,6 @@ file is read and uploaded in ASCII mode. The file permissions are set to
 	$this->ftp->close();
 
 In this example a list of files is retrieved from the server.
-
 ::
 
 	$this->load->library('ftp');
@@ -73,7 +71,6 @@ In this example a list of files is retrieved from the server.
 	$this->ftp->close();
 
 In this example a local directory is mirrored on the server.
-
 ::
 
 	$this->load->library('ftp');
@@ -121,140 +118,164 @@ Class Reference
 
 		If you prefer you can store your FTP preferences in a config file.
 		Simply create a new file called the ftp.php, add the $config array in
-		that file. Then save the file at config/ftp.php and it will be used
-		automatically.
+		that file. Then save the file at *application/config/ftp.php* and it
+		will be used automatically.
 
 		**Available connection options**
 
 		==================		===================================
-		Option Name						Description
+		Option Name			Description
 		==================		===================================
-		**hostname**					the FTP hostname. Usually something like: ftp.example.com
-		**username**					the FTP username
-		**password**					the FTP password
-		**port**							The port number. Set to 21 by default.
-		**debug**							TRUE/FALSE (boolean). Whether to enable debugging to display error messages.
-		**passive**						TRUE/FALSE (boolean). Whether to use passive mode. Passive is set automatically by default.
+		**hostname**			the FTP hostname. Usually something like: ftp.example.com
+		**username**			the FTP username
+		**password**			the FTP password
+		**port**			The port number. Set to 21 by default.
+		**debug**			TRUE/FALSE (boolean). Whether to enable debugging to display error messages.
+		**passive**			TRUE/FALSE (boolean). Whether to use passive mode. Passive is set automatically by default.
 		==================		===================================
 
+	.. method:: upload($locpath, $rempath[, $mode = 'auto'[, $permissions = NULL]])
 
-Uploads a file to your server. You must supply the local path and the
-remote path, and you can optionally set the mode and permissions.
-Example::
+		:param string $locpath: Local file path
+		:param string $rempath: Remote file path
+		:param string $mode: FTP mode, defaults to 'auto' (options are: 'auto', 'binary', 'ascii')
+		:param int $permissions: File permissions (octal)
+		:returns: bool
 
-	$this->ftp->upload('/local/path/to/myfile.html', '/public_html/myfile.html', 'ascii', 0775);
+		Uploads a file to your server. You must supply the local path and the
+		remote path, and you can optionally set the mode and permissions.
+		Example::
 
-**Mode options are:** ascii, binary, and auto (the default). If auto is
-used it will base the mode on the file extension of the source file.
+			$this->ftp->upload('/local/path/to/myfile.html', '/public_html/myfile.html', 'ascii', 0775);
 
-If set, permissions have to be passed as an octal value.
+		If 'auto' mode is used it will base the mode on the file extension of the source file.
 
-$this->ftp->download()
-======================
+		If set, permissions have to be passed as an octal value.
 
-Downloads a file from your server. You must supply the remote path and
-the local path, and you can optionally set the mode. Example::
+	.. method:: download($rempath, $locpath[, $mode = 'auto'])
 
-	$this->ftp->download('/public_html/myfile.html', '/local/path/to/myfile.html', 'ascii');
+		:param string $rempath: Remote file path
+		:param string $locpath: Local file path
+		:param string $mode: FTP mode, defaults to 'auto' (options are: 'auto', 'binary', 'ascii')
+		:returns: bool
 
-**Mode options are:** ascii, binary, and auto (the default). If auto is
-used it will base the mode on the file extension of the source file.
+		Downloads a file from your server. You must supply the remote path and
+		the local path, and you can optionally set the mode. Example::
 
-Returns FALSE if the download does not execute successfully (including
-if PHP does not have permission to write the local file)
+			$this->ftp->download('/public_html/myfile.html', '/local/path/to/myfile.html', 'ascii');
 
-$this->ftp->rename()
-====================
+		If 'auto' mode is used it will base the mode on the file extension of the source file.
 
-Permits you to rename a file. Supply the source file name/path and the
-new file name/path.
+		Returns FALSE if the download does not execute successfully (including if PHP does not have permission to write the local file).
 
-::
+	.. method:: rename($old_file, $new_file, $move = FALSE)
 
-	// Renames green.html to blue.html
-	$this->ftp->rename('/public_html/foo/green.html', '/public_html/foo/blue.html');
+		:param string $old_file: Old file name
+		:param string $new_file: New file name
+		:param bool $move: Whether a move is being performed
+		:returns: bool
 
-$this->ftp->move()
-==================
+		Permits you to rename a file. Supply the source file name/path and the new file name/path.
+		::
 
-Lets you move a file. Supply the source and destination paths::
+			// Renames green.html to blue.html
+			$this->ftp->rename('/public_html/foo/green.html', '/public_html/foo/blue.html');
 
-	// Moves blog.html from "joe" to "fred"
-	$this->ftp->move('/public_html/joe/blog.html', '/public_html/fred/blog.html');
+	.. method:: move($old_file, $new_file)
 
-Note: if the destination file name is different the file will be
-renamed.
+		:param string $old_file: Old file name
+		:param string $new_file: New file name
+		:returns: bool
 
-$this->ftp->delete_file()
-==========================
+		Lets you move a file. Supply the source and destination paths::
 
-Lets you delete a file. Supply the source path with the file name.
+			// Moves blog.html from "joe" to "fred"
+			$this->ftp->move('/public_html/joe/blog.html', '/public_html/fred/blog.html');
 
-::
+		.. note:: If the destination file name is different the file will be renamed.
 
-	 $this->ftp->delete_file('/public_html/joe/blog.html');
+	.. method:: delete_file($filepath)
 
-$this->ftp->delete_dir()
-=========================
+		:param string $filepath: Path to file to delete
+		:returns: bool
 
-Lets you delete a directory and everything it contains. Supply the
-source path to the directory with a trailing slash.
+		Lets you delete a file. Supply the source path with the file name.
+		::
 
-**Important** Be VERY careful with this function. It will recursively
-delete **everything** within the supplied path, including sub-folders
-and all files. Make absolutely sure your path is correct. Try using the
-list_files() function first to verify that your path is correct.
+			 $this->ftp->delete_file('/public_html/joe/blog.html');
 
-::
+	.. method:: delete_dir($filepath)
 
-	 $this->ftp->delete_dir('/public_html/path/to/folder/');
+		:param string $filepath: Path to directory to delete
+		:returns: bool
 
-$this->ftp->list_files()
-=========================
+		Lets you delete a directory and everything it contains. Supply the
+		source path to the directory with a trailing slash.
 
-Permits you to retrieve a list of files on your server returned as an
-array. You must supply the path to the desired directory.
+		.. important:: Be VERY careful with this method!
+			It will recursively delete **everything** within the supplied path,
+			including sub-folders and all files. Make absolutely sure your path
+			is correct. Try using ``list_files()`` first to verify that your path is correct.
 
-::
+		::
 
-	$list = $this->ftp->list_files('/public_html/');
+			 $this->ftp->delete_dir('/public_html/path/to/folder/');
 
-	print_r($list);
+	.. method:: list_files([$path = '.'])
 
-$this->ftp->mirror()
-====================
+		:param string $path: Directory path
+		:returns: array or FALSE on failure
 
-Recursively reads a local folder and everything it contains (including
-sub-folders) and creates a mirror via FTP based on it. Whatever the
-directory structure of the original file path will be recreated on the
-server. You must supply a source path and a destination path::
+		Permits you to retrieve a list of files on your server returned as an
+		array. You must supply the path to the desired directory.
+		::
 
-	 $this->ftp->mirror('/path/to/myfolder/', '/public_html/myfolder/');
+			$list = $this->ftp->list_files('/public_html/');
+			print_r($list);
 
-$this->ftp->mkdir()
-===================
+	.. method:: mirror($locpath, $rempath)
 
-Lets you create a directory on your server. Supply the path ending in
-the folder name you wish to create, with a trailing slash. Permissions
-can be set by passed an octal value in the second parameter (if you are
-running PHP 5).
+		:param string $locpath: Local path
+		:param string $rempath: Remote path
+		:returns: bool
 
-::
+		Recursively reads a local folder and everything it contains (including
+		sub-folders) and creates a mirror via FTP based on it. Whatever the
+		directory structure of the original file path will be recreated on the
+		server. You must supply a source path and a destination path::
+
+			 $this->ftp->mirror('/path/to/myfolder/', '/public_html/myfolder/');
+
+	.. method:: mkdir($path[, $permissions = NULL])
+
+		:param string $path: Path to directory to create
+		:param int $permissions: Permissions (octal)
+		:returns: bool
+
+		Lets you create a directory on your server. Supply the path ending in
+		the folder name you wish to create, with a trailing slash.
 
-	// Creates a folder named "bar"
-	$this->ftp->mkdir('/public_html/foo/bar/', DIR_WRITE_MODE);
+		Permissions can be set by passing an octal value in the second parameter.
+		::
 
-$this->ftp->chmod()
-===================
+			// Creates a folder named "bar"
+			$this->ftp->mkdir('/public_html/foo/bar/', DIR_WRITE_MODE);
 
-Permits you to set file permissions. Supply the path to the file or
-folder you wish to alter permissions on::
+	.. method:: chmod($path, $perm)
+
+		:param string $path: Path to alter permissions for
+		:param int $perm: Permissions (octal)
+		:returns: bool
 
-	// Chmod "bar" to 777
-	$this->ftp->chmod('/public_html/foo/bar/', DIR_WRITE_MODE);
+		Permits you to set file permissions. Supply the path to the file or
+		directory you wish to alter permissions on::
 
-$this->ftp->close();
-====================
+			// Chmod "bar" to 777
+			$this->ftp->chmod('/public_html/foo/bar/', DIR_WRITE_MODE);
+
+	.. method:: close()
+
+		:returns: bool
 
-Closes the connection to your server. It's recommended that you use this
-when you are finished uploading.
+		Closes the connection to your server. It's recommended that you use this
+		when you are finished uploading.
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From a322989d6e24f381df56dea2428c29d4d185d6b5 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Fri, 3 Jan 2014 17:35:52 +0200
Subject: [ci skip] Add missing docs for CI_FTP::changedir()

---
 user_guide_src/source/libraries/ftp.rst | 11 +++++++++++
 1 file changed, 11 insertions(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/ftp.rst b/user_guide_src/source/libraries/ftp.rst
index 1b1a45e36..c587869db 100644
--- a/user_guide_src/source/libraries/ftp.rst
+++ b/user_guide_src/source/libraries/ftp.rst
@@ -273,6 +273,17 @@ Class Reference
 			// Chmod "bar" to 777
 			$this->ftp->chmod('/public_html/foo/bar/', DIR_WRITE_MODE);
 
+	.. method:: changedir($path[, $suppress_debug = FALSE])
+
+		:param string $path: Directory path
+		:param bool $suppress_debug: Whether to turn off debug messages for this command
+		:returns: bool
+
+		Changes the current working directory to the specified path.
+
+		The ``$suppress_debug`` parameter is useful in case you want to use this method
+		as an ``is_dir()`` alternative for FTP.
+
 	.. method:: close()
 
 		:returns: bool
-- 
cgit v1.2.3-24-g4f1b


From ae72dc60a833b60f9def05ff3c4bc68f5407d80d Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Fri, 3 Jan 2014 18:15:24 +0200
Subject: [ci skip] Update the Language library docs

---
 user_guide_src/source/libraries/language.rst | 39 +++++++++++++++++++++++++---
 1 file changed, 36 insertions(+), 3 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/language.rst b/user_guide_src/source/libraries/language.rst
index e772e8e27..3cee5d7f6 100644
--- a/user_guide_src/source/libraries/language.rst
+++ b/user_guide_src/source/libraries/language.rst
@@ -19,11 +19,18 @@ your **application/language/** directory.
 .. note:: Each language should be stored in its own folder. For example,
 	the English files are located at: system/language/english
 
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
+
 Creating Language Files
 =======================
 
-Language files must be named with **_lang.php** as the file extension. For
-example, let's say you want to create a file containing error messages.
+Language files must be named with **_lang.php** as the filename extension.
+For example, let's say you want to create a file containing error messages.
 You might name it: error_lang.php
 
 Within the file you will assign each line of text to an array called
@@ -89,4 +96,30 @@ If you find that you need a particular language globally throughout your
 application, you can tell CodeIgniter to :doc:`auto-load
 <../general/autoloader>` it during system initialization. This is done
 by opening the **application/config/autoload.php** file and adding the
-language(s) to the autoload array.
\ No newline at end of file
+language(s) to the autoload array.
+
+***************
+Class Reference
+***************
+
+.. class:: CI_Lang
+
+	.. method:: load($langfile[, $idiom = ''[, $return = FALSE[, $add_suffix = TRUE[, $alt_path = '']]]])
+
+		:param string $langfile: Language file to load
+		:param string $idiom: Language name (i.e. 'english')
+		:param bool $return: Whether to return the loaded array of translations
+		:param bool $add_suffix: Whether to add the '_lang' suffix to the language file name
+		:param string $alt_path: An alternative path to look in for the language file
+		:returns: void or array if the third parameter is set to TRUE
+
+		Loads a language file.
+
+	.. method:: line($line[, $log_errors = TRUE])
+
+		:param string $line: Language line key name
+		:param bool $log_errors: Whether to log an error if the line isn't found
+		:returns: string or FALSE on failure
+
+		Fetches a single translation line from the already loaded language files,
+		based on the line's name.
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From a6eae87d14efe3169156a12ad3706852ff70e2c4 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Fri, 3 Jan 2014 18:25:20 +0200
Subject: [ci skip] Some spaces & docblock fixes

---
 user_guide_src/source/changelog.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 54583e6fb..8bba39431 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -23,7 +23,7 @@ Release Date: Not Released
    -  ``$_SERVER['CI_ENV']`` can now be set to control the ``ENVIRONMENT`` constant.
    -  Added an optional backtrace to php-error template.
    -  Added Android to the list of user agents.
-   -  Added Windows 7, Windows 8, Android, Blackberry, iOS and PlayStation 3 to the list of user platforms.
+   -  Added Windows 7, Windows 8, Windows 8.1, Android, Blackberry, iOS and PlayStation 3 to the list of user platforms.
    -  Added Fennec (Firefox for mobile) to the list of mobile user agents.
    -  Ability to log certain error types, not all under a threshold.
    -  Added support for pem, p10, p12, p7a, p7c, p7m, p7r, p7s, crt, crl, der, kdb, rsa, cer, sst, csr Certs to mimes.php.
-- 
cgit v1.2.3-24-g4f1b


From fd7d9caa71e960f2bec806da423eb8d93419e24c Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Fri, 3 Jan 2014 18:44:23 +0200
Subject: [ci skip] Update the Unit testing library docs

---
 user_guide_src/source/libraries/unit_testing.rst | 97 +++++++++++++++++++++---
 1 file changed, 85 insertions(+), 12 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/unit_testing.rst b/user_guide_src/source/libraries/unit_testing.rst
index 6bd91bf88..2d4a27a25 100644
--- a/user_guide_src/source/libraries/unit_testing.rst
+++ b/user_guide_src/source/libraries/unit_testing.rst
@@ -11,6 +11,13 @@ evaluation function and two result functions. It's not intended to be a
 full-blown test suite but rather a simple mechanism to evaluate your
 code to determine if it is producing the correct data type and result.
 
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
+
 Initializing the Class
 ======================
 
@@ -19,16 +26,15 @@ initialized in your controller using the $this->load->library function::
 
 	$this->load->library('unit_test');
 
-Once loaded, the Unit Test object will be available using: $this->unit
+Once loaded, the Unit Test object will be available using ``$this->unit``
 
 Running Tests
 =============
 
-Running a test involves supplying a test and an expected result to the
-following function:
+Running a test involves supplying a test and an expected result in the
+following way:
 
-$this->unit->run( test, expected result, 'test name', 'notes');
-===============================================================
+	$this->unit->run('test', 'expected result', 'test name', 'notes');
 
 Where test is the result of the code you wish to test, expected result
 is the data type you expect, test name is an optional name you can give
@@ -114,7 +120,7 @@ Enabling/Disabling Unit Testing
 If you would like to leave some testing in place in your scripts, but
 not have it run unless you need it, you can disable unit testing using::
 
-	$this->unit->active(FALSE)
+	$this->unit->active(FALSE);
 
 Unit Test Display
 =================
@@ -150,15 +156,82 @@ template. Note the required pseudo-variables::
 
 	$str = '
 	<table border="0" cellpadding="4" cellspacing="1">
-	    {rows}
-	        <tr>
-	        <td>{item}</td>
-	        <td>{result}</td>
-	        </tr>
-	    {/rows}
+	{rows}
+		<tr>
+			<td>{item}</td>
+			<td>{result}</td>
+		</tr>
+	{/rows}
 	</table>';
 
 	$this->unit->set_template($str);
 
 .. note:: Your template must be declared **before** running the unit
 	test process.
+
+***************
+Class Reference
+***************
+
+.. class:: CI_Unit_test
+
+	.. method:: set_test_items($items)
+
+		:param array $items: List of visible test items
+		:returns: void
+
+		Sets a list of items that should be visible in tests.
+		Valid options are:
+
+		  - test_name
+		  - test_datatype
+		  - res_datatype
+		  - result
+		  - file
+		  - line
+		  - notes
+
+	.. method:: run($test[, $expected = TRUE[, $test_name = 'undefined'[, $notes = '']]])
+
+		:param mixed $test: Test data
+		:param mixed $expected: Expected result
+		:param string $test_name: Test name
+		:param string $notes: Any notes to be attached to the test
+		:returns: string
+
+		Runs unit tests.
+
+	.. method:: report([$result = array()])
+
+		:param array $result: Array containing tests results
+		:returns: string
+
+		Generates a report about already complete tests.
+
+	.. method:: use_strict([$state = TRUE])
+
+		:param bool $state: Strict state flag
+		:returns: void
+
+		Enables/disables strict type comparison in tests.
+
+	.. method:: active([$state = TRUE])
+
+		:param bool $state: Whether to enable testing
+		:returns: void
+
+		Enables/disables unit testing.
+
+	.. method:: result([$results = array()])
+
+		:param array $results: Tests results list
+		:returns: array
+
+		Returns raw tests results data.
+
+	.. method:: set_template($template)
+
+		:param string $template: Test result template
+		:returns: void
+
+		Sets the template for displaying tests results.
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 04535c7169aa9401a3cf09c256df8319a67b778e Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Mon, 6 Jan 2014 10:57:05 +0200
Subject: [ci skip] Update the Input library and Cookie helper docs

---
 user_guide_src/source/helpers/cookie_helper.rst |  43 ++-
 user_guide_src/source/libraries/input.rst       | 396 ++++++++++++++----------
 2 files changed, 247 insertions(+), 192 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/helpers/cookie_helper.rst b/user_guide_src/source/helpers/cookie_helper.rst
index e70893f2f..2e8db5f31 100644
--- a/user_guide_src/source/helpers/cookie_helper.rst
+++ b/user_guide_src/source/helpers/cookie_helper.rst
@@ -25,18 +25,17 @@ Available Functions
 The following functions are available:
 
 
-.. function:: set_cookie([$name = ''[, $value = ''[, $expire = ''[, $domain = ''[, $path = '/'[, $prefix = ''[, $secure = FALSE[, $httponly = FALSE]]]]]]]])
-
-	:param	mixed	$name: Cookie name *or* associative array of all of
-		the parameters available to this function
-	:param	string	$value: Cookie value
-	:param	int	$expire: Number of seconds until expiration
-	:param	string	$domain: Cookie domain (usually: .yourdomain.com)
-	:param	string	$path: Cookie path
-	:param	string	$prefix: Cookie name prefix
-	:param	bool	$secure: Whether to only send the cookie through HTTPS
-	:param	bool	$httponly: Whether to hide the cookie from JavaScript
-	:returns:	void
+.. function:: set_cookie($name[, $value = ''[, $expire = ''[, $domain = ''[, $path = '/'[, $prefix = ''[, $secure = FALSE[, $httponly = FALSE]]]]]]]])
+
+	:param mixed $name: Cookie name *or* associative array of all of the parameters available to this function
+	:param string $value: Cookie value
+	:param int $expire: Number of seconds until expiration
+	:param string $domain: Cookie domain (usually: .yourdomain.com)
+	:param string $path: Cookie path
+	:param string $prefix: Cookie name prefix
+	:param bool $secure: Whether to only send the cookie through HTTPS
+	:param bool $httponly: Whether to hide the cookie from JavaScript
+	:returns: void
 
 	This helper function gives you view file friendly syntax to set browser
 	cookies. Refer to the :doc:`Input Library <../libraries/input>` for a
@@ -44,28 +43,27 @@ The following functions are available:
 	``CI_Input::set_cookie()``.
 
 
-.. function:: get_cookie([$index = ''[, $xss_clean = FALSE]])
+.. function:: get_cookie($index[, $xss_clean = FALSE]])
 
-	:param	string	$index: Cookie name
-	:param	bool	$xss_clean: Whether to apply XSS filtering to the returned value
-	:returns:	mixed
+	:param string $index: Cookie name
+	:param bool $xss_clean: Whether to apply XSS filtering to the returned value
+	:returns: mixed
 
 	This helper function gives you view file friendly syntax to get browser
 	cookies. Refer to the :doc:`Input Library <../libraries/input>` for a
 	description of its use, as this function is an alias for ``CI_Input::cookie()``.
 
 
-.. function:: delete_cookie([$name = ''[, $domain = ''[, $path = '/'[, $prefix = '']]]])
+.. function:: delete_cookie($name[, $domain = ''[, $path = '/'[, $prefix = '']]]])
 
-	:param	string	$name: Cookie name
-	:param	string	$domain: Cookie domain (usually: .yourdomain.com)
-	:param	string	$path: Cookie path
-	:param	string	$prefix: Cookie name prefix
+	:param string $name: Cookie name
+	:param string $domain: Cookie domain (usually: .yourdomain.com)
+	:param string $path: Cookie path
+	:param string $prefix: Cookie name prefix
 	:returns: void
 
 	Lets you delete a cookie. Unless you've set a custom path or other
 	values, only the name of the cookie is needed.
-
 	::
 
 		delete_cookie('name');
@@ -74,7 +72,6 @@ The following functions are available:
 	does not have the value and expiration parameters. You can submit an
 	array of values in the first parameter or you can set discrete
 	parameters.
-
 	::
 
 		delete_cookie($name, $domain, $path, $prefix)
\ No newline at end of file
diff --git a/user_guide_src/source/libraries/input.rst b/user_guide_src/source/libraries/input.rst
index 177f5cb64..39a0d0628 100644
--- a/user_guide_src/source/libraries/input.rst
+++ b/user_guide_src/source/libraries/input.rst
@@ -10,6 +10,13 @@ The Input Class serves two purposes:
 .. note:: This class is initialized automatically by the system so there
 	is no need to do it manually.
 
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
+
 Security Filtering
 ==================
 
@@ -17,7 +24,7 @@ The security filtering method is called automatically when a new
 :doc:`controller <../general/controllers>` is invoked. It does the
 following:
 
--  If $config['allow_get_array'] is FALSE (default is TRUE), destroys
+-  If ``$config['allow_get_array']`` is FALSE (default is TRUE), destroys
    the global GET array.
 -  Destroys all global variables in the event register_globals is
    turned on.
@@ -33,7 +40,7 @@ XSS Filtering
 The Input class has the ability to filter input automatically to prevent
 cross-site scripting attacks. If you want the filter to run
 automatically every time it encounters POST or COOKIE data you can
-enable it by opening your application/config/config.php file and setting
+enable it by opening your *application/config/config.php* file and setting
 this::
 
 	$config['global_xss_filtering'] = TRUE;
@@ -44,7 +51,7 @@ information on using XSS Filtering in your application.
 Using POST, GET, COOKIE, or SERVER Data
 =======================================
 
-CodeIgniter comes with four helper methods that let you fetch POST, GET,
+CodeIgniter comes with helper methods that let you fetch POST, GET,
 COOKIE or SERVER items. The main advantage of using the provided
 methods rather than fetching an item directly (``$_POST['something']``)
 is that the methods will check to see if the item is set and return
@@ -58,262 +65,313 @@ With CodeIgniter's built in methods you can simply do this::
 
 	$something = $this->input->post('something');
 
-The four methods are:
+The main methods are:
 
 -  $this->input->post()
 -  $this->input->get()
 -  $this->input->cookie()
 -  $this->input->server()
 
-$this->input->post()
-====================
+Using the php://input stream
+============================
 
-The first parameter will contain the name of the POST item you are
-looking for::
+If you want to utilize the PUT, DELETE, PATCH or other exotic request
+methods, they can only be accessed via a special input stream, that
+can only be read once. This isn't as easy as just reading from e.g.
+the ``$_POST`` array, because it will always exist and you can try
+and access multiple variables without caring that you might only have
+one shot at all of the POST data.
 
-	$this->input->post('some_data');
+CodeIgniter will take care of that for you, and you can access data
+from the **php://input** stream at any time, just by calling the
+``input_stream()`` method::
 
-The method returns NULL if the item you are attempting to retrieve
-does not exist.
+	$this->input->input_stream('key');
 
-The second optional parameter lets you run the data through the XSS
-filter. It's enabled by setting the second parameter to boolean TRUE;
+Similar to other methods such as ``get()`` and ``post()``, if the
+requested data is not found, it will return NULL and you can also
+decide whether to run the data through ``xss_clean()`` by passing
+a boolean value as the second parameter::
 
-::
+	$this->input->input_stream('key', TRUE); // XSS Clean
+	$this->input->input_stream('key', FALSE); // No XSS filter
 
-	$this->input->post('some_data', TRUE);
+.. note:: You can utilize ``method()`` in order to know if you're reading
+	PUT, DELETE or PATCH data.
 
-To return an array of all POST items call without any parameters.
+***************
+Class Reference
+***************
 
-To return all POST items and pass them through the XSS filter set the
-first parameter NULL while setting the second parameter to boolean;
+.. class:: CI_Input
 
-The method returns NULL if there are no items in the POST.
+	.. method:: post([$index = NULL[, $xss_clean = FALSE]])
 
-::
+		:param string $index: POST parameter name
+		:param bool $xss_clean: Whether to apply XSS filtering
+		:returns: mixed
 
-	$this->input->post(NULL, TRUE); // returns all POST items with XSS filter
-	$this->input->post(); // returns all POST items without XSS filter
+		The first parameter will contain the name of the POST item you are
+		looking for::
 
-$this->input->get()
-===================
+			$this->input->post('some_data');
 
-This method is identical to the post method, only it fetches get data
-::
+		The method returns NULL if the item you are attempting to retrieve
+		does not exist.
 
-	$this->input->get('some_data', TRUE);
+		The second optional parameter lets you run the data through the XSS
+		filter. It's enabled by setting the second parameter to boolean TRUE.
+		::
 
-To return an array of all GET items call without any parameters.
+			$this->input->post('some_data', TRUE);
 
-To return all GET items and pass them through the XSS filter set the
-first parameter NULL while setting the second parameter to boolean;
+		To return an array of all POST items call without any parameters.
 
-The method returns NULL if there are no items in the GET.
+		To return all POST items and pass them through the XSS filter set the
+		first parameter NULL while setting the second parameter to boolean TRUE.
+		::
 
-::
+			$this->input->post(NULL, TRUE); // returns all POST items with XSS filter
+			$this->input->post(); // returns all POST items without XSS filter
 
-	$this->input->get(NULL, TRUE); // returns all GET items with XSS filter
-	$this->input->get(); // returns all GET items without XSS filtering
+	.. method:: get([$index = NULL[, $xss_clean = FALSE]])
 
+		:param string $index: GET parameter name
+		:param bool $xss_clean: Whether to apply XSS filtering
+		:returns: mixed
 
-$this->input->get_post()
-========================
+		This method is identical to ``post()``, only it fetches GET data.
+		::
 
-This method will search through both the post and get streams for
-data, looking first in post, and then in get::
+			$this->input->get('some_data', TRUE);
 
-	$this->input->get_post('some_data', TRUE);
+		To return an array of all GET items call without any parameters.
 
-$this->input->cookie()
-======================
+		To return all GET items and pass them through the XSS filter set the
+		first parameter NULL while setting the second parameter to boolean TRUE.
+		::
 
-This method is identical to the post method, only it fetches cookie data
-::
+			$this->input->get(NULL, TRUE); // returns all GET items with XSS filter
+			$this->input->get(); // returns all GET items without XSS filtering
 
-	$this->input->cookie('some_cookie');
-	$this->input->cookie('some_cookie, TRUE); // with XSS filter
+	.. method:: get_post([$index = ''[, $xss_clean = FALSE]])
 
+		:param string $index: GET/POST parameter name
+		:param bool $xss_clean: Whether to apply XSS filtering
+		:returns: mixed
 
-$this->input->server()
-======================
+		This method works the same way as ``post()`` and ``get()``, only combined.
+		It will search through both POST and GET streams for data, looking first
+		in POST, and then in GET::
 
-This method is identical to the above methods, only it fetches server
-server data::
+			$this->input->get_post('some_data', TRUE);
 
-	$this->input->server('some_data');
+	.. method:: cookie([$index = ''[, $xss_clean = FALSE]])
 
-Using the php://input stream
-============================
+		:param string $index: COOKIE parameter name
+		:param bool $xss_clean: Whether to apply XSS filtering
+		:returns: mixed
 
-If you want to utilize the PUT, DELETE, PATCH or other exotic request
-methods, they can only be accessed via a special input stream, that
-can only be read once. This isn't as easy as just reading from e.g.
-the ``$_POST`` array, because it will always exist and you can try
-and access multiple variables without caring that you might only have
-one shot at all of the POST data.
+		This method is identical to ``post()`` and ``get()``, only it fetches cookie
+		data::
 
-CodeIgniter will take care of that for you, and you can access data
-from the **php://input** stream at any time, just by calling the
-``input_stream()`` method::
+			$this->input->cookie('some_cookie');
+			$this->input->cookie('some_cookie, TRUE); // with XSS filter
 
-	$this->input->input_stream('key');
+	.. method:: server([$index = ''[, $xss_clean = FALSE]])
 
-Similar to the methods above, if the requested data is not found, it
-will return NULL and you can also decide whether to run the data
-through ``xss_clean()`` by passing a boolean value as the second
-parameter::
+		:param string $index: Value name
+		:param bool $xss_clean: Whether to apply XSS filtering
+		:returns: mixed
 
-	$this->input->input_stream('key', TRUE); // XSS Clean
-	$this->input->input_stream('key', FALSE); // No XSS filter
+		This method is identical to the ``post()``, ``get()`` and ``cookie()`` methods,
+		only it fetches server data (``$_SERVER``)::
 
-.. note:: You can utilize method() in order to know if you're reading
-	PUT, DELETE or PATCH data.
+			$this->input->server('some_data');
+
+	.. method:: input_stream([$index = ''[, $xss_clean = FALSE]])
+
+		:param string $index: Key name
+		:param bool $xss_clean: Whether to apply XSS filtering
+		:returns: mixed
+
+		This method is identical to ``get()``, ``post()`` and ``cookie()``,
+		only it fetches the *php://input* stream data.
+
+	.. method:: set_cookie($name = ''[, $value = ''[, $expire = ''[, $domain = ''[, $path = '/'[, $prefix = ''[, $secure = FALSE[, $httponly = FALSE]]]]]]])
+
+		:param mixed $name: Cookie name or an array of parameters
+		:param string $value: Cookie value
+		:param int $expire: Cookie expiration time in seconds
+		:param string $domain: Cookie domain
+		:param string $path: Cookie path
+		:param string $prefix: Cookie name prefix
+		:param bool $secure: Whether to only transfer the cookie through HTTPS
+		:param bool $httponly: Whether to only make the cookie accessible for HTTP requests (no JavaScript)
+		:returns: void
+
+		Sets a cookie containing the values you specify. There are two ways to
+		pass information to this method so that a cookie can be set: Array
+		Method, and Discrete Parameters:
+
+		Array Method
+		^^^^^^^^^^^^
+
+		Using this method, an associative array is passed to the first
+		parameter::
+
+			$cookie = array(
+				'name'   => 'The Cookie Name',
+				'value'  => 'The Value',
+				'expire' => '86500',
+				'domain' => '.some-domain.com',
+				'path'   => '/',
+				'prefix' => 'myprefix_',
+				'secure' => TRUE
+			);
 
-$this->input->set_cookie()
-==========================
+			$this->input->set_cookie($cookie);
 
-Sets a cookie containing the values you specify. There are two ways to
-pass information to this method so that a cookie can be set: Array
-Method, and Discrete Parameters:
+		**Notes:**
 
-Array Method
-^^^^^^^^^^^^
+		Only the name and value are required. To delete a cookie set it with the
+		expiration blank.
 
-Using this method, an associative array is passed to the first
-parameter::
+		The expiration is set in **seconds**, which will be added to the current
+		time. Do not include the time, but rather only the number of seconds
+		from *now* that you wish the cookie to be valid. If the expiration is
+		set to zero the cookie will only last as long as the browser is open.
 
-	$cookie = array(
-	    'name'   => 'The Cookie Name',
-	    'value'  => 'The Value',
-	    'expire' => '86500',
-	    'domain' => '.some-domain.com',
-	    'path'   => '/',
-	    'prefix' => 'myprefix_',
-	    'secure' => TRUE
-	);
+		For site-wide cookies regardless of how your site is requested, add your
+		URL to the **domain** starting with a period, like this:
+		.your-domain.com
 
-	$this->input->set_cookie($cookie);
+		The path is usually not needed since the method sets a root path.
 
-**Notes:**
+		The prefix is only needed if you need to avoid name collisions with
+		other identically named cookies for your server.
 
-Only the name and value are required. To delete a cookie set it with the
-expiration blank.
+		The secure boolean is only needed if you want to make it a secure cookie
+		by setting it to TRUE.
 
-The expiration is set in **seconds**, which will be added to the current
-time. Do not include the time, but rather only the number of seconds
-from *now* that you wish the cookie to be valid. If the expiration is
-set to zero the cookie will only last as long as the browser is open.
+		Discrete Parameters
+		^^^^^^^^^^^^^^^^^^^
 
-For site-wide cookies regardless of how your site is requested, add your
-URL to the **domain** starting with a period, like this:
-.your-domain.com
+		If you prefer, you can set the cookie by passing data using individual
+		parameters::
 
-The path is usually not needed since the method sets a root path.
+			$this->input->set_cookie($name, $value, $expire, $domain, $path, $prefix, $secure);
 
-The prefix is only needed if you need to avoid name collisions with
-other identically named cookies for your server.
 
-The secure boolean is only needed if you want to make it a secure cookie
-by setting it to TRUE.
+	.. method:: ip_address()
 
-Discrete Parameters
-^^^^^^^^^^^^^^^^^^^
+		:returns: string
 
-If you prefer, you can set the cookie by passing data using individual
-parameters::
+		Returns the IP address for the current user. If the IP address is not
+		valid, the method will return '0.0.0.0'::
 
-	$this->input->set_cookie($name, $value, $expire, $domain, $path, $prefix, $secure);
+			echo $this->input->ip_address();
 
+		.. important:: This method takes into account the ``$config['proxy_ips']``
+			setting and will return the reported HTTP_X_FORWARDED_FOR,
+			HTTP_CLIENT_IP, HTTP_X_CLIENT_IP or HTTP_X_CLUSTER_CLIENT_IP
+			address for the allowed IP addresses.
 
-$this->input->ip_address()
-==========================
+	.. method:: valid_ip($ip[, $which = ''])
 
-Returns the IP address for the current user. If the IP address is not
-valid, the method will return an IP of: 0.0.0.0
+		:param string $ip: IP address
+		:param string $which: IP protocol ('ipv4' or 'ipv6')
+		:returns: bool
 
-::
+		Takes an IP address as input and returns TRUE or FALSE (boolean) depending
+		on whether it is valid or not.
 
-	echo $this->input->ip_address();
+		.. note:: The $this->input->ip_address() method above automatically
+			validates the IP address.
 
-$this->input->valid_ip($ip)
-===========================
+		::
 
-Takes an IP address as input and returns TRUE or FALSE (boolean) if it
-is valid or not.
+			if ( ! $this->input->valid_ip($ip))
+			{
+				echo 'Not Valid';
+			}
+			else
+			{
+				echo 'Valid';
+			}
 
-.. note:: The $this->input->ip_address() method above automatically
-	validates the IP address.
+		Accepts an optional second string parameter of 'ipv4' or 'ipv6' to specify
+		an IP format. The default checks for both formats.
 
-::
+	.. method:: user_agent()
 
-	if ( ! $this->input->valid_ip($ip))
-	{
-	     echo 'Not Valid';
-	}
-	else
-	{
-	     echo 'Valid';
-	}
+		:returns: string
 
-Accepts an optional second string parameter of 'ipv4' or 'ipv6' to specify
-an IP format. The default checks for both formats.
+		Returns the user agent string (web browser) being used by the current user,
+		or NULL if it's not available.
+		::
 
-$this->input->user_agent()
-==========================
+			echo $this->input->user_agent();
 
-Returns the user agent (web browser) being used by the current user.
-Returns FALSE if it's not available.
+		See the :doc:`User Agent Class <user_agent>` for methods which extract
+		information from the user agent string.
 
-::
+	.. method:: request_headers([$xss_clean = FALSE])
 
-	echo $this->input->user_agent();
+		:param bool $xss_clean: Whether to apply XSS filtering
+		:returns: array
 
-See the :doc:`User Agent Class <user_agent>` for methods which extract
-information from the user agent string.
+		Returns an array of HTTP request headers.
+		Useful if running in a non-Apache environment where
+		`apache_request_headers() <http://php.net/apache_request_headers>`_
+		will not be supported.
+		::
 
-$this->input->request_headers()
-===============================
+			$headers = $this->input->request_headers();
 
-Useful if running in a non-Apache environment where
-`apache_request_headers() <http://php.net/apache_request_headers>`_
-will not be supported. Returns an array of headers.
+	.. method:: get_request_header($index[, $xss_clean = FALSE])
 
-::
+		:param string $index: HTTP request header name
+		:param bool $xss_clean: Whether to apply XSS filtering
+		:returns: string
 
-	$headers = $this->input->request_headers();
+		Returns a single member of the request headers array or NULL
+		if the searched header is not found.
+		::
 
-$this->input->get_request_header()
-==================================
+			$this->input->get_request_header('some-header', TRUE);
 
-Returns a single member of the request headers array.
+	.. method:: is_ajax_request()
 
-::
+		:returns: bool
 
-	$this->input->get_request_header('some-header', TRUE);
+		Checks to see if the HTTP_X_REQUESTED_WITH server header has been
+		set, and returns boolean TRUE if it is or FALSE if not.
 
-$this->input->is_ajax_request()
-===============================
+	.. method:: is_cli_request()
 
-Checks to see if the HTTP_X_REQUESTED_WITH server header has been
-set, and returns a boolean response.
+		:returns: bool
 
-$this->input->is_cli_request()
-==============================
+		Checks to see if the application was run from the command-line
+		interface.
 
-Checks to see if the STDIN constant is set, which is a failsafe way to
-see if PHP is being run on the command line.
+		.. note:: This method checks both the PHP SAPI name currently in use
+			and if the ``STDIN`` constant is defined, which is usually a
+			failsafe way to see if PHP is being run via the command line.
 
-::
+		::
 
-	$this->input->is_cli_request()
+			$this->input->is_cli_request()
 
-$this->input->method()
-======================
+	.. method:: method([$upper = FALSE])
 
-Returns the $_SERVER['REQUEST_METHOD'], optional set uppercase or lowercase (default lowercase).
+		:param bool $upper: Whether to return the request method name in upper or lower case
+		:returns: string
 
-::
+		Returns the ``$_SERVER['REQUEST_METHOD']``, with the option to set it
+		in uppercase or lowercase.
+		::
 
-	echo $this->input->method(TRUE); // Outputs: POST
-	echo $this->input->method(FALSE); // Outputs: post
-	echo $this->input->method(); // Outputs: post
\ No newline at end of file
+			echo $this->input->method(TRUE); // Outputs: POST
+			echo $this->input->method(FALSE); // Outputs: post
+			echo $this->input->method(); // Outputs: post
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From ecc7993a910bf8202ba022487288921a9c50e336 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Mon, 6 Jan 2014 11:22:31 +0200
Subject: [ci skip] Update the Form_validation library docs

---
 .../source/libraries/form_validation.rst           | 168 ++++++++-------------
 1 file changed, 61 insertions(+), 107 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/form_validation.rst b/user_guide_src/source/libraries/form_validation.rst
index 5dffb1cd1..35f745fb7 100644
--- a/user_guide_src/source/libraries/form_validation.rst
+++ b/user_guide_src/source/libraries/form_validation.rst
@@ -340,10 +340,10 @@ commonly is::
 	set_value('field name')
 
 Open your myform.php view file and update the **value** in each field
-using the ``set_value()`` function:
+using the :func:`set_value()` function:
 
-**Don't forget to include each field name in the ``set_value()``
-functions!**
+**Don't forget to include each field name in the :func:`set_value()`
+function calls!**
 
 ::
 
@@ -380,11 +380,11 @@ Now reload your page and submit the form so that it triggers an error.
 Your form fields should now be re-populated
 
 .. note:: The :ref:`class-reference` section below
-	contains functions that permit you to re-populate <select> menus,
+	contains methods that permit you to re-populate <select> menus,
 	radio buttons, and checkboxes.
 
-**Important Note:** If you use an array as the name of a form field, you
-must supply it as an array to the function. Example::
+.. important:: If you use an array as the name of a form field, you
+	must supply it as an array to the function. Example::
 
 	<input type="text" name="colors[]" value="<?php echo set_value('colors[]'); ?>" size="50" />
 
@@ -559,7 +559,7 @@ Showing Errors Individually
 ===========================
 
 If you prefer to show an error message next to each form field, rather
-than as a list, you can use the ``form_error()`` function.
+than as a list, you can use the :func:`form_error()` function.
 
 Try it! Change your form so that it looks like this::
 
@@ -933,154 +933,108 @@ Name                 Parameter Description
 Class Reference
 ***************
 
-.. class:: Form_validation
-
-The following methods are intended for use in your controller.
+.. class:: CI_Form_validation
 
-$this->form_validation->set_rules()
-===================================
-
-	.. method:: set_rules ($field, $label = '', $rules = '')
+	.. method:: set_rules($field[, $label = ''[, $rules = '']])
 
 		:param string $field: The field name
 		:param string $label: The field label
 		:param mixed $rules: The rules, as a string with rules separated by a pipe "|", or an array or rules.
-		:rtype: Object
+		:returns: object
 
 		Permits you to set validation rules, as described in the tutorial
 		sections above:
 
-	-  :ref:`setting-validation-rules`
-	-  :ref:`saving-groups`
+		-  :ref:`setting-validation-rules`
+		-  :ref:`saving-groups`
 
-$this->form_validation->run()
-=============================
-
-	.. method:: run ($group = '')
+	.. method:: run([$group = ''])
 
 		:param string $group: The name of the validation group to run
-		:rtype: Boolean
+		:returns: bool
 
 		Runs the validation routines. Returns boolean TRUE on success and FALSE
 		on failure. You can optionally pass the name of the validation group via
 		the method, as described in: :ref:`saving-groups`
 
-$this->form_validation->set_message()
-=====================================
-
-	.. method:: set_message ($lang, $val = '')
+	.. method:: set_message($lang[, $val = ''])
 
 		:param string $lang: The rule the message is for
 		:param string $val: The message
-		:rtype: Object
+		:returns: object
 
 		Permits you to set custom error messages. See :ref:`setting-error-messages`
 
-$this->form_validation->set_data()
-==================================
+	.. method:: set_error_delimiters([$prefix = '<p>'[, $suffix = '</p>']])
+
+		:param string $prefix: Error message prefix
+		:param string $suffix: Error message suffix
+		:returns: object
+
+		Sets the default prefix and suffix for error messages.
 
-	.. method:: set_data ($data = '')
+	.. method:: set_data($data)
 
 		:param array $data: The data to validate
+		:returns: void
 
 		Permits you to set an array for validation, instead of using the default
-		$_POST array.
+		``$_POST`` array.
 
-$this->form_validation->reset_validation()
-==========================================
+	.. method:: reset_validation()
 
-	.. method:: reset_validation ()
+		:returns: void
 
 		Permits you to reset the validation when you validate more than one array.
 		This method should be called before validating each new array.
 
-$this->form_validation->error_array()
-=====================================
+	.. method:: error_array()
 
-	.. method:: error_array ()
-
-		:rtype: Array
+		:returns: array
 
 		Returns the error messages as an array.
 
-.. _helper-functions:
-
-****************
-Helper Reference
-****************
-
-The following helper functions are available for use in the view files
-containing your forms. Note that these are procedural functions, so they
-**do not** require you to prepend them with $this->form_validation.
-
-form_error()
-============
-
-Shows an individual error message associated with the field name
-supplied to the function. Example::
+	.. method:: error_string([$prefix = ''[, $suffix = '']])
 
-	<?php echo form_error('username'); ?>
-
-The error delimiters can be optionally specified. See the
-:ref:`changing-delimiters` section above.
-
-validation_errors()
-===================
-
-Shows all error messages as a string: Example::
-
-	<?php echo validation_errors(); ?>
-
-The error delimiters can be optionally specified. See the
-:ref:`changing-delimiters` section above.
-
-set_value()
-===========
+		:param string $prefix: Error message prefix
+		:param string $suffix: Error message suffix
+		:returns: string
 
-Permits you to set the value of an input form or textarea. You must
-supply the field name via the first parameter of the function. The
-second (optional) parameter allows you to set a default value for the
-form. Example::
+		Returns all error messages (as returned from error_array()) formatted as a
+		string and separated by a newline character.
 
-	<input type="text" name="quantity" value="<?php echo set_value('quantity', '0'); ?>" size="50" />
+	.. method:: error($field[, $prefix = ''[, $suffix = '']])
 
-The above form will show "0" when loaded for the first time.
+		:param string $field: Field name
+		:param string $prefix: Optional prefix
+		:param string $suffix: Optional suffix
+		:returns: string
 
-set_select()
-============
+		Returns the error message for a specific field, optionally adding a
+		prefix and/or suffix to it (usually HTML tags).
 
-If you use a <select> menu, this function permits you to display the
-menu item that was selected. The first parameter must contain the name
-of the select menu, the second parameter must contain the value of each
-item, and the third (optional) parameter lets you set an item as the
-default (use boolean TRUE/FALSE).
+	.. method:: has_rule($field)
 
-Example::
+		:param string $field: Field name
+		:returns: bool
 
-	<select name="myselect">
-	<option value="one" <?php echo set_select('myselect', 'one', TRUE); ?> >One</option>
-	<option value="two" <?php echo set_select('myselect', 'two'); ?> >Two</option>
-	<option value="three" <?php echo set_select('myselect', 'three'); ?> >Three</option>
-	</select>
+		Checks to see if there is a rule set for the specified field.
 
-set_checkbox()
-==============
-
-Permits you to display a checkbox in the state it was submitted. The
-first parameter must contain the name of the checkbox, the second
-parameter must contain its value, and the third (optional) parameter
-lets you set an item as the default (use boolean TRUE/FALSE). Example::
-
-	<input type="checkbox" name="mycheck[]" value="1" <?php echo set_checkbox('mycheck[]', '1'); ?> />
-	<input type="checkbox" name="mycheck[]" value="2" <?php echo set_checkbox('mycheck[]', '2'); ?> />
+.. _helper-functions:
 
-set_radio()
-===========
+****************
+Helper Reference
+****************
 
-Permits you to display radio buttons in the state they were submitted.
-This function is identical to the **set_checkbox()** function above.
+Please refer to the :doc:`Form Helper <../helpers/form_helper>` manual for
+the following functions:
 
-::
+-  :func:`form_error()`
+-  :func:`validation_errors()`
+-  :func:`set_value()`
+-  :func:`set_select()`
+-  :func:`set_checkbox()`
+-  :func:`set_radio()`
 
-	<input type="radio" name="myradio" value="1" <?php echo set_radio('myradio', '1', TRUE); ?> />
-	<input type="radio" name="myradio" value="2" <?php echo set_radio('myradio', '2'); ?> />
+Note that these are procedural functions, so they **do not** require you
+to prepend them with ``$this->form_validation``.
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 055639673a3640fb01820ab23a56697ad2d2ffff Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Mon, 6 Jan 2014 12:28:59 +0200
Subject: [ci skip] Update the Loader class docs

---
 user_guide_src/source/libraries/loader.rst | 531 ++++++++++++++++-------------
 1 file changed, 298 insertions(+), 233 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/loader.rst b/user_guide_src/source/libraries/loader.rst
index b048f4881..20e1c1d3c 100644
--- a/user_guide_src/source/libraries/loader.rst
+++ b/user_guide_src/source/libraries/loader.rst
@@ -11,337 +11,402 @@ can be libraries (classes) :doc:`View files <../general/views>`,
 .. note:: This class is initialized automatically by the system so there
 	is no need to do it manually.
 
-The following methods are available in this class:
+.. contents::
+  :local:
 
-$this->load->library('class_name', $config, 'object name')
-==========================================================
+.. raw:: html
 
-This method is used to load core classes. Where class_name is the
-name of the class you want to load.
+  <div class="custom-index container"></div>
 
-.. note:: We use the terms "class" and "library" interchangeably.
+Application "Packages"
+======================
 
-For example, if you would like to send email with CodeIgniter, the first
-step is to load the email class within your controller::
+An application package allows for the easy distribution of complete sets
+of resources in a single directory, complete with its own libraries,
+models, helpers, config, and language files. It is recommended that
+these packages be placed in the application/third_party directory. Below
+is a sample map of an package directory.
 
-	$this->load->library('email');
+The following is an example of a directory for an application package
+named "Foo Bar".
 
-Once loaded, the library will be ready for use, using
-$this->email->*some_method*().
+::
 
-Library files can be stored in subdirectories within the main
-"libraries" directory, or within your personal application/libraries
-directory. To load a file located in a subdirectory, simply include the
-path, relative to the "libraries" directory. For example, if you have
-file located at::
+	/application/third_party/foo_bar
 
-	libraries/flavors/Chocolate.php
+	config/
+	helpers/
+	language/
+	libraries/
+	models/
 
-You will load it using::
+Whatever the purpose of the "Foo Bar" application package, it has its
+own config files, helpers, language files, libraries, and models. To use
+these resources in your controllers, you first need to tell the Loader
+that you are going to be loading resources from a package, by adding the
+package path via the ``add_package_path()`` method.
 
-	$this->load->library('flavors/chocolate');
+Package view files
+------------------
 
-You may nest the file in as many subdirectories as you want.
+By Default, package view files paths are set when ``add_package_path()``
+is called. View paths are looped through, and once a match is
+encountered that view is loaded.
 
-Additionally, multiple libraries can be loaded at the same time by
-passing an array of libraries to the load method.
+In this instance, it is possible for view naming collisions within
+packages to occur, and possibly the incorrect package being loaded. To
+ensure against this, set an optional second parameter of FALSE when
+calling ``add_package_path()``.
 
 ::
 
-	$this->load->library(array('email', 'table'));
+	$this->load->add_package_path(APPPATH.'my_app', FALSE);
+	$this->load->view('my_app_index'); // Loads
+	$this->load->view('welcome_message'); // Will not load the default welcome_message b/c the second param to add_package_path is FALSE
 
-Setting options
----------------
+	// Reset things
+	$this->load->remove_package_path(APPPATH.'my_app');
 
-The second (optional) parameter allows you to optionally pass
-configuration setting. You will typically pass these as an array::
+	// Again without the second parameter:
+	$this->load->add_package_path(APPPATH.'my_app');
+	$this->load->view('my_app_index'); // Loads
+	$this->load->view('welcome_message'); // Loads
 
-	$config = array (
-		'mailtype' => 'html',
-		'charset'  => 'utf-8,
-		'priority' => '1'
-	);
+***************
+Class Reference
+***************
 
-	$this->load->library('email', $config);
+.. class:: CI_Loader
 
-Config options can usually also be set via a config file. Each library
-is explained in detail in its own page, so please read the information
-regarding each one you would like to use.
+	.. method:: library($library[, $params = NULL[, $object_name = NULL]])
 
-Please take note, when multiple libraries are supplied in an array for
-the first parameter, each will receive the same parameter information.
+		:param mixed $library: Library name as a string or an array with multiple libraries
+		:param array $params: Optional array of parameters to pass to the loaded library's constructor
+		:param string $object_name: Optional object name to assign the library to
+		:returns: void
 
-Assigning a Library to a different object name
-----------------------------------------------
+		This method is used to load core classes.
 
-If the third (optional) parameter is blank, the library will usually be
-assigned to an object with the same name as the library. For example, if
-the library is named Calendar, it will be assigned to a variable named
-$this->calendar.
+		.. note:: We use the terms "class" and "library" interchangeably.
 
-If you prefer to set your own class names you can pass its value to the
-third parameter::
+		For example, if you would like to send email with CodeIgniter, the first
+		step is to load the email class within your controller::
 
-	$this->load->library('calendar', '', 'my_calendar');
+			$this->load->library('email');
 
-	// Calendar class is now accessed using:
-	$this->my_calendar
+		Once loaded, the library will be ready for use, using ``$this->email``.
 
-Please take note, when multiple libraries are supplied in an array for
-the first parameter, this parameter is discarded.
+		Library files can be stored in subdirectories within the main
+		"libraries" directory, or within your personal *application/libraries*
+		directory. To load a file located in a subdirectory, simply include the
+		path, relative to the "libraries" directory. For example, if you have
+		file located at::
 
-$this->load->driver('parent_name', $config, 'object name')
-==========================================================
+			libraries/flavors/Chocolate.php
 
-This method is used to load driver libraries. Where parent_name is the
-name of the parent class you want to load.
+		You will load it using::
 
-As an example, if you would like to use sessions with CodeIgniter, the first
-step is to load the session driver within your controller::
+			$this->load->library('flavors/chocolate');
 
-	$this->load->driver('session');
+		You may nest the file in as many subdirectories as you want.
 
-Once loaded, the library will be ready for use, using
-$this->session->*some_method*().
+		Additionally, multiple libraries can be loaded at the same time by
+		passing an array of libraries to the load method.
+		::
 
-Driver files must be stored in a subdirectory within the main
-"libraries" directory, or within your personal application/libraries
-directory. The subdirectory must match the parent class name. Read the
-:doc:`Drivers <../general/drivers>` description for details.
+			$this->load->library(array('email', 'table'));
 
-Additionally, multiple driver libraries can be loaded at the same time by
-passing an array of drivers to the load method.
+		Setting options
+		---------------
 
-::
+		The second (optional) parameter allows you to optionally pass
+		configuration setting. You will typically pass these as an array::
 
-	$this->load->driver(array('session', 'cache'));
+			$config = array (
+				'mailtype' => 'html',
+				'charset'  => 'utf-8,
+				'priority' => '1'
+			);
 
-Setting options
----------------
+			$this->load->library('email', $config);
 
-The second (optional) parameter allows you to optionally pass
-configuration settings. You will typically pass these as an array::
+		Config options can usually also be set via a config file. Each library
+		is explained in detail in its own page, so please read the information
+		regarding each one you would like to use.
 
-	$config = array(
-		'sess_driver' => 'cookie',
-		'sess_encrypt_cookie'  => true,
-		'encryption_key' => 'mysecretkey'
-	);
+		Please take note, when multiple libraries are supplied in an array for
+		the first parameter, each will receive the same parameter information.
 
-	$this->load->driver('session', $config);
+		Assigning a Library to a different object name
+		----------------------------------------------
 
-Config options can usually also be set via a config file. Each library
-is explained in detail in its own page, so please read the information
-regarding each one you would like to use.
+		If the third (optional) parameter is blank, the library will usually be
+		assigned to an object with the same name as the library. For example, if
+		the library is named Calendar, it will be assigned to a variable named
+		``$this->calendar``.
 
-Assigning a Driver to a different object name
----------------------------------------------
+		If you prefer to set your own class names you can pass its value to the
+		third parameter::
 
-If the third (optional) parameter is blank, the library will be assigned
-to an object with the same name as the parent class. For example, if
-the library is named Session, it will be assigned to a variable named
-``$this->session``.
+			$this->load->library('calendar', NULL, 'my_calendar');
 
-If you prefer to set your own class names you can pass its value to the
-third parameter::
+			// Calendar class is now accessed using:
+			$this->my_calendar
 
-	$this->load->library('session', '', 'my_session');
+		Please take note, when multiple libraries are supplied in an array for
+		the first parameter, this parameter is discarded.
 
-	// Session class is now accessed using:
-	$this->my_session
+	.. method:: driver($library[, $params = NULL[, $object_name]])
 
-.. note:: Driver libraries may also be loaded with the ``library()`` method,
-	but it is faster to use ``driver()``.
+		:param mixed $library: Library name as a string or an array with multiple libraries
+		:param array $params: Optional array of parameters to pass to the loaded library's constructor
+		:param string $object_name: Optional object name to assign the library to
+		:returns: void
 
-$this->load->view('file_name', $data, TRUE/FALSE)
-=================================================
+		This method is used to load driver libraries, acts very much like the
+		``library()`` method.
 
-This method is used to load your View files. If you haven't read the
-:doc:`Views <../general/views>` section of the user guide it is
-recommended that you do since it shows you how this method is
-typically used.
+		As an example, if you would like to use sessions with CodeIgniter, the first
+		step is to load the session driver within your controller::
 
-The first parameter is required. It is the name of the view file you
-would like to load.
+			$this->load->driver('session');
 
-.. note:: The .php file extension does not need to be specified unless
-	you use something other than .php.
+		Once loaded, the library will be ready for use, using ``$this->session``.
 
-The second **optional** parameter can take an associative array or an
-object as input, which it runs through the PHP
-`extract() <http://www.php.net/extract>`_ function to convert to variables
-that can be used in your view files. Again, read the
-:doc:`Views <../general/views>` page to learn how this might be useful.
+		Driver files must be stored in a subdirectory within the main
+		"libraries" directory, or within your personal *application/libraries*
+		directory. The subdirectory must match the parent class name. Read the
+		:doc:`Drivers <../general/drivers>` description for details.
 
-The third **optional** parameter lets you change the behavior of the
-method so that it returns data as a string rather than sending it to
-your browser. This can be useful if you want to process the data in some
-way. If you set the parameter to true (boolean) it will return data. The
-default behavior is false, which sends it to your browser. Remember to
-assign it to a variable if you want the data returned::
+		Additionally, multiple driver libraries can be loaded at the same time by
+		passing an array of drivers to the load method.
+		::
 
-	$string = $this->load->view('myfile', '', true);
+			$this->load->driver(array('session', 'cache'));
 
-$this->load->model('model_name');
-==================================
+		Setting options
+		---------------
 
-::
+		The second (optional) parameter allows you to optionally pass
+		configuration settings. You will typically pass these as an array::
 
-	$this->load->model('model_name');
+			$config = array(
+				'sess_driver' => 'cookie',
+				'sess_encrypt_cookie'  => true,
+				'encryption_key' => 'mysecretkey'
+			);
 
+			$this->load->driver('session', $config);
 
-If your model is located in a subdirectory, include the relative path
-from your models directory. For example, if you have a model located at
-application/models/blog/queries.php you'll load it using::
+		Config options can usually also be set via a config file. Each library
+		is explained in detail in its own page, so please read the information
+		regarding each one you would like to use.
 
-	$this->load->model('blog/queries');
+		Assigning a Driver to a different object name
+		---------------------------------------------
 
-If you would like your model assigned to a different object name you can
-specify it via the second parameter of the loading method::
+		If the third (optional) parameter is blank, the library will be assigned
+		to an object with the same name as the parent class. For example, if
+		the library is named Session, it will be assigned to a variable named
+		``$this->session``.
 
-	$this->load->model('model_name', 'fubar');
-	$this->fubar->method();
+		If you prefer to set your own class names you can pass its value to the
+		third parameter::
 
-$this->load->database('options', TRUE/FALSE)
-============================================
+			$this->load->library('session', '', 'my_session');
 
-This method lets you load the database class. The two parameters are
-**optional**. Please see the :doc:`database <../database/index>`
-section for more info.
+			// Session class is now accessed using:
+			$this->my_session
 
-$this->load->vars($array)
-=========================
+	.. method:: view($view[, $vars = array()[, return = FALSE]])
 
-This method takes an associative array as input and generates
-variables using the PHP `extract <http://www.php.net/extract>`_
-method. This method produces the same result as using the second
-parameter of the ``$this->load->view()`` method above. The reason you
-might want to use this method independently is if you would like to
-set some global variables in the constructor of your controller and have
-them become available in any view file loaded from any method. You can
-have multiple calls to this method. The data get cached and merged
-into one array for conversion to variables.
+		:param string $view: View name
+		:param array $vars: An associative array of variables
+		:param bool $return: Whether to return the loaded view
+		:returns: mixed
 
-$this->load->get_var($key)
-==========================
+		This method is used to load your View files. If you haven't read the
+		:doc:`Views <../general/views>` section of the user guide it is
+		recommended that you do since it shows you how this method is
+		typically used.
 
-This method checks the associative array of variables available to
-your views. This is useful if for any reason a var is set in a library
-or another controller method using ``$this->load->vars()``.
+		The first parameter is required. It is the name of the view file you
+		would like to load.
 
-$this->load->get_vars()
-=======================
+		.. note:: The .php file extension does not need to be specified unless
+			you use something other than .php.
 
-This method retrieves all variables available to your views.
+		The second **optional** parameter can take an associative array or an
+		object as input, which it runs through the PHP
+		`extract() <http://www.php.net/extract>`_ function to convert to variables
+		that can be used in your view files. Again, read the
+		:doc:`Views <../general/views>` page to learn how this might be useful.
 
-$this->load->helper('file_name')
-================================
+		The third **optional** parameter lets you change the behavior of the
+		method so that it returns data as a string rather than sending it to
+		your browser. This can be useful if you want to process the data in some
+		way. If you set the parameter to TRUE (boolean) it will return data. The
+		default behavior is FALSE, which sends it to your browser. Remember to
+		assign it to a variable if you want the data returned::
 
-This method loads helper files, where file_name is the name of the
-file, without the _helper.php extension.
+			$string = $this->load->view('myfile', '', TRUE);
 
-$this->load->file('filepath/filename', TRUE/FALSE)
-==================================================
+	.. method:: vars($vars[, $val = ''])
 
-This is a generic file loading method. Supply the filepath and name in
-the first parameter and it will open and read the file. By default the
-data is sent to your browser, just like a View file, but if you set the
-second parameter to true (boolean) it will instead return the data as a
-string.
+		:param mixed $vars: An array of variables or a single variable name
+		:param mixed $val: Optional variable value
+		:returns: void
 
-$this->load->language('file_name')
-==================================
+		This method takes an associative array as input and generates
+		variables using the PHP `extract() <http://www.php.net/extract>`_
+		function. This method produces the same result as using the second
+		parameter of the ``$this->load->view()`` method above. The reason you
+		might want to use this method independently is if you would like to
+		set some global variables in the constructor of your controller and have
+		them become available in any view file loaded from any method. You can
+		have multiple calls to this method. The data get cached and merged
+		into one array for conversion to variables.
 
-This method is an alias of the :doc:`language loading
-method <language>`: ``$this->lang->load()``
+	.. method:: get_var($key)
 
-$this->load->config('file_name')
-================================
+		:param string $key: Variable name key
+		:returns: mixed
 
-This method is an alias of the :doc:`config file loading
-method <config>`: ``$this->config->load()``
+		This method checks the associative array of variables available to
+		your views. This is useful if for any reason a var is set in a library
+		or another controller method using ``$this->load->vars()``.
 
-Application "Packages"
-======================
+	.. method:: get_vars()
 
-An application package allows for the easy distribution of complete sets
-of resources in a single directory, complete with its own libraries,
-models, helpers, config, and language files. It is recommended that
-these packages be placed in the application/third_party directory. Below
-is a sample map of an package directory
+		:returns: array
 
-Sample Package "Foo Bar" Directory Map
-======================================
+		This method retrieves all variables available to your views.
 
-The following is an example of a directory for an application package
-named "Foo Bar".
+	.. method:: model($model[, $name = ''[, $db_conn = FALSE]])
 
-::
+		:param mixed $model: Model name or an array containing multiple models
+		:param string $name: Optional object name to assign the model to
+		:param string $db_conn: Optional database configuration group to load
+		:returns: void
 
-	/application/third_party/foo_bar
+		::
 
-	config/
-	helpers/
-	language/
-	libraries/
-	models/
+			$this->load->model('model_name');
 
-Whatever the purpose of the "Foo Bar" application package, it has its
-own config files, helpers, language files, libraries, and models. To use
-these resources in your controllers, you first need to tell the Loader
-that you are going to be loading resources from a package, by adding the
-package path.
 
-$this->load->add_package_path()
----------------------------------
+		If your model is located in a subdirectory, include the relative path
+		from your models directory. For example, if you have a model located at
+		*application/models/blog/queries.php* you'll load it using::
 
-Adding a package path instructs the Loader class to prepend a given path
-for subsequent requests for resources. As an example, the "Foo Bar"
-application package above has a library named Foo_bar.php. In our
-controller, we'd do the following::
+			$this->load->model('blog/queries');
 
-	$this->load->add_package_path(APPPATH.'third_party/foo_bar/');
-	$this->load->library('foo_bar');
+		If you would like your model assigned to a different object name you can
+		specify it via the second parameter of the loading method::
 
-$this->load->remove_package_path()
-------------------------------------
+			$this->load->model('model_name', 'fubar');
+			$this->fubar->method();
 
-When your controller is finished using resources from an application
-package, and particularly if you have other application packages you
-want to work with, you may wish to remove the package path so the Loader
-no longer looks in that directory for resources. To remove the last path
-added, simply call the method with no parameters.
+	.. method:: database([$params = ''[, $return = FALSE[, $query_builder = NULL]]])
 
-$this->load->remove_package_path()
-------------------------------------
+		:param mixed $params: Database group name or configuration options
+		:param bool $return: Whether to return the loaded database object
+		:param bool $query_builder: Whether to load the Query Builder
+		:returns: mixed
 
-Or to remove a specific package path, specify the same path previously
-given to add_package_path() for a package.::
+		This method lets you load the database class. The two parameters are
+		**optional**. Please see the :doc:`database <../database/index>`
+		section for more info.
 
-	$this->load->remove_package_path(APPPATH.'third_party/foo_bar/');
+	.. method:: dbforge([$db = NULL[, $return = FALSE]])
 
-Package view files
-------------------
+		:param object $db: Database object
+		:param bool $return: Whether to return the Database Forge instance
+		:returns: mixed
 
-By Default, package view files paths are set when add_package_path()
-is called. View paths are looped through, and once a match is
-encountered that view is loaded.
+		Loads the :doc:`Database Forge <../database/forge>` class, please refer
+		to that manual for more info.
 
-In this instance, it is possible for view naming collisions within
-packages to occur, and possibly the incorrect package being loaded. To
-ensure against this, set an optional second parameter of FALSE when
-calling add_package_path().
+	.. method:: dbutil([$db = NULL[, $return = FALSE]])
 
-::
+		:param object $db: Database object
+		:param bool $return: Whether to return the Database Utilities instance
+		:returns: mixed
 
-	$this->load->add_package_path(APPPATH.'my_app', FALSE);
-	$this->load->view('my_app_index'); // Loads
-	$this->load->view('welcome_message'); // Will not load the default welcome_message b/c the second param to add_package_path is FALSE
+		Loads the :doc:`Database Utilities <../database/utilities>` class, please
+		refer to that manual for more info.
 
-	// Reset things
-	$this->load->remove_package_path(APPPATH.'my_app');
+	.. method:: helper($helpers)
 
-	// Again without the second parameter:
-	$this->load->add_package_path(APPPATH.'my_app');
-	$this->load->view('my_app_index'); // Loads
-	$this->load->view('welcome_message'); // Loads
\ No newline at end of file
+		:param mixed $helpers: Helper name as a string or an array containing multiple helpers
+		:returns: void
+
+		This method loads helper files, where file_name is the name of the
+		file, without the _helper.php extension.
+
+	.. method:: file($path[, $return = FALSE])
+
+		:param string $path: File path
+		:param bool $return: Whether to return the loaded file
+		:returns: mixed
+
+		This is a generic file loading method. Supply the filepath and name in
+		the first parameter and it will open and read the file. By default the
+		data is sent to your browser, just like a View file, but if you set the
+		second parameter to boolean TRUE it will instead return the data as a
+		string.
+
+	.. method:: language($files[, $lang = ''])
+
+		:param mixed $files: Language file name or an array of multiple language files
+		:param string $lang: Language name
+		:returns: void
+
+		This method is an alias of the :doc:`language loading
+		method <language>`: ``$this->lang->load()``.
+
+	.. method:: config($file[, $use_sections = FALSE[, $fail_gracefully = FALSE]])
+
+		:param string $file: Configuration file name
+		:param bool $use_sections: Whether configuration values should be loaded into their own section
+		:param bool $fail_gracefully: Whether to just return FALSE in case of failure
+		:returns: bool
+
+		This method is an alias of the :doc:`config file loading
+		method <config>`: ``$this->config->load()``
+
+	.. method:: add_package_path($path[, $view_cascade = TRUE])
+
+		:param string $path: Path to add
+		:param bool $view_cascade: Whether to use cascading views
+		:returns: void
+
+		Adding a package path instructs the Loader class to prepend a given path
+		for subsequent requests for resources. As an example, the "Foo Bar"
+		application package above has a library named Foo_bar.php. In our
+		controller, we'd do the following::
+
+			$this->load->add_package_path(APPPATH.'third_party/foo_bar/');
+			$this->load->library('foo_bar');
+
+	.. method:: remove_package_path([$path = ''])
+
+		:param string $path: Path to remove
+		:returns: void
+
+		When your controller is finished using resources from an application
+		package, and particularly if you have other application packages you
+		want to work with, you may wish to remove the package path so the Loader
+		no longer looks in that directory for resources. To remove the last path
+		added, simply call the method with no parameters.
+
+		Or to remove a specific package path, specify the same path previously
+		given to ``add_package_path()`` for a package.::
+
+			$this->load->remove_package_path(APPPATH.'third_party/foo_bar/');
+
+	.. method:: get_package_paths([$include_base = TRUE])
+
+		:param bool $include_base: Whether to include BASEPATH
+		:returns: array
+
+		Returns all currently available package paths.
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 3a18df1337752c89952527d55fa7eb027ebd976e Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Mon, 6 Jan 2014 12:59:11 +0200
Subject: [ci skip] Update the Image_lib docs

---
 user_guide_src/source/libraries/image_lib.rst | 305 +++++++++++++++-----------
 1 file changed, 171 insertions(+), 134 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/image_lib.rst b/user_guide_src/source/libraries/image_lib.rst
index dcdccbd92..73dc1f20d 100644
--- a/user_guide_src/source/libraries/image_lib.rst
+++ b/user_guide_src/source/libraries/image_lib.rst
@@ -29,7 +29,7 @@ in your controller using the $this->load->library function::
 	$this->load->library('image_lib');
 
 Once the library is loaded it will be ready for use. The image library
-object you will use to call all functions is: $this->image_lib
+object you will use to call all functions is: ``$this->image_lib``
 
 Processing an Image
 ===================
@@ -67,18 +67,17 @@ ratio. The thumbnail will be called *mypic_thumb.jpg*
 	while processing images you may need to limit their maximum size, and/or
 	adjust PHP memory limits.
 
-Processing Functions
-====================
+Processing Methods
+==================
 
-There are four available processing functions:
+There are four available processing methods:
 
 -  $this->image_lib->resize()
 -  $this->image_lib->crop()
 -  $this->image_lib->rotate()
 -  $this->image_lib->watermark()
--  $this->image_lib->clear()
 
-These functions return boolean TRUE upon success and FALSE for failure.
+These methods return boolean TRUE upon success and FALSE for failure.
 If they fail you can retrieve the error message using this function::
 
 	echo $this->image_lib->display_errors();
@@ -88,7 +87,7 @@ error upon failure, like this::
 
 	if ( ! $this->image_lib->resize())
 	{
-	    echo $this->image_lib->display_errors();
+		echo $this->image_lib->display_errors();
 	}
 
 .. note:: You can optionally specify the HTML formatting to be applied to
@@ -97,6 +96,8 @@ error upon failure, like this::
 
 	$this->image_lib->display_errors('<p>', '</p>');
 
+.. _processing-preferences:
+
 Preferences
 ===========
 
@@ -162,134 +163,10 @@ Setting preferences in a config file
 If you prefer not to set preferences using the above method, you can
 instead put them into a config file. Simply create a new file called
 image_lib.php, add the $config array in that file. Then save the file
-in: config/image_lib.php and it will be used automatically. You will
-NOT need to use the $this->image_lib->initialize function if you save
+in *config/image_lib.php* and it will be used automatically. You will
+NOT need to use the ``$this->image_lib->initialize()``method if you save
 your preferences in a config file.
 
-$this->image_lib->resize()
-===========================
-
-The image resizing function lets you resize the original image, create a
-copy (with or without resizing), or create a thumbnail image.
-
-For practical purposes there is no difference between creating a copy
-and creating a thumbnail except a thumb will have the thumbnail marker
-as part of the name (ie, mypic_thumb.jpg).
-
-All preferences listed in the table above are available for this
-function except these three: rotation_angle, x_axis, and y_axis.
-
-Creating a Thumbnail
---------------------
-
-The resizing function will create a thumbnail file (and preserve the
-original) if you set this preference to TRUE::
-
-	$config['create_thumb'] = TRUE;
-
-This single preference determines whether a thumbnail is created or not.
-
-Creating a Copy
----------------
-
-The resizing function will create a copy of the image file (and preserve
-the original) if you set a path and/or a new filename using this
-preference::
-
-	$config['new_image'] = '/path/to/new_image.jpg';
-
-Notes regarding this preference:
-
--  If only the new image name is specified it will be placed in the same
-   folder as the original
--  If only the path is specified, the new image will be placed in the
-   destination with the same name as the original.
--  If both the path and image name are specified it will placed in its
-   own destination and given the new name.
-
-Resizing the Original Image
----------------------------
-
-If neither of the two preferences listed above (create_thumb, and
-new_image) are used, the resizing function will instead target the
-original image for processing.
-
-$this->image_lib->crop()
-=========================
-
-The cropping function works nearly identically to the resizing function
-except it requires that you set preferences for the X and Y axis (in
-pixels) specifying where to crop, like this::
-
-	$config['x_axis'] = '100';
-	$config['y_axis'] = '40';
-
-All preferences listed in the table above are available for this
-function except these: rotation_angle, create_thumb, new_image.
-
-Here's an example showing how you might crop an image::
-
-	$config['image_library'] = 'imagemagick';
-	$config['library_path'] = '/usr/X11R6/bin/';
-	$config['source_image']	= '/path/to/image/mypic.jpg';
-	$config['x_axis'] = '100';
-	$config['y_axis'] = '60';
-
-	$this->image_lib->initialize($config); 
-
-	if ( ! $this->image_lib->crop())
-	{
-	    echo $this->image_lib->display_errors();
-	}
-
-.. note:: Without a visual interface it is difficult to crop images, so this
-	function is not very useful unless you intend to build such an
-	interface. That's exactly what we did using for the photo gallery module
-	in ExpressionEngine, the CMS we develop. We added a JavaScript UI that
-	lets the cropping area be selected.
-
-$this->image_lib->rotate()
-===========================
-
-The image rotation function requires that the angle of rotation be set
-via its preference::
-
-	$config['rotation_angle'] = '90';
-
-There are 5 rotation options:
-
-#. 90 - rotates counter-clockwise by 90 degrees.
-#. 180 - rotates counter-clockwise by 180 degrees.
-#. 270 - rotates counter-clockwise by 270 degrees.
-#. hor - flips the image horizontally.
-#. vrt - flips the image vertically.
-
-Here's an example showing how you might rotate an image::
-
-	$config['image_library'] = 'netpbm';
-	$config['library_path'] = '/usr/bin/';
-	$config['source_image']	= '/path/to/image/mypic.jpg';
-	$config['rotation_angle'] = 'hor';
-
-	$this->image_lib->initialize($config); 
-
-	if ( ! $this->image_lib->rotate())
-	{
-	    echo $this->image_lib->display_errors();
-	}
-
-$this->image_lib->clear()
-==========================
-
-The clear function resets all of the values used when processing an
-image. You will want to call this if you are processing images in a
-loop.
-
-::
-
-	$this->image_lib->clear();
-
-
 ******************
 Image Watermarking
 ******************
@@ -310,10 +187,12 @@ There are two types of watermarking that you can use:
    image (usually a transparent PNG or GIF) containing your watermark
    over the source image.
 
+.. _watermarking:
+
 Watermarking an Image
 =====================
 
-Just as with the other functions (resizing, cropping, and rotating) the
+Just as with the other methods (resizing, cropping, and rotating) the
 general process for watermarking involves setting the preferences
 corresponding to the action you intend to perform, then calling the
 watermark function. Here is an example::
@@ -423,3 +302,161 @@ Preference              Default Value       Options             Description
                                                                 coordinate to a pixel representative of the color you want to be
                                                                 transparent.
 ======================= =================== =================== ==========================================================================
+
+***************
+Class Reference
+***************
+
+.. class:: CI_Image_lib
+
+	.. method:: initialize([$props = array()])
+
+		:param array $props: Image processing preferences
+		:returns: void
+
+		Initializes the class for processing an image.
+
+	.. method:: resize()
+
+		:returns: bool
+
+		The image resizing method lets you resize the original image, create a
+		copy (with or without resizing), or create a thumbnail image.
+
+		For practical purposes there is no difference between creating a copy
+		and creating a thumbnail except a thumb will have the thumbnail marker
+		as part of the name (i.e. mypic_thumb.jpg).
+
+		All preferences listed in the :ref:`processing-preferences` table are available for this
+		method except these three: *rotation_angle*, *x_axis* and *y_axis*.
+
+		Creating a Thumbnail
+		--------------------
+
+		The resizing method will create a thumbnail file (and preserve the
+		original) if you set this preference to TRUE::
+
+			$config['create_thumb'] = TRUE;
+
+		This single preference determines whether a thumbnail is created or not.
+
+		Creating a Copy
+		---------------
+
+		The resizing method will create a copy of the image file (and preserve
+		the original) if you set a path and/or a new filename using this
+		preference::
+
+			$config['new_image'] = '/path/to/new_image.jpg';
+
+		Notes regarding this preference:
+
+		-  If only the new image name is specified it will be placed in the same
+		   folder as the original
+		-  If only the path is specified, the new image will be placed in the
+		   destination with the same name as the original.
+		-  If both the path and image name are specified it will placed in its
+		   own destination and given the new name.
+
+		Resizing the Original Image
+		---------------------------
+
+		If neither of the two preferences listed above (create_thumb, and
+		new_image) are used, the resizing method will instead target the
+		original image for processing.
+
+	.. method:: crop()
+
+		:returns: bool
+
+		The cropping method works nearly identically to the resizing function
+		except it requires that you set preferences for the X and Y axis (in
+		pixels) specifying where to crop, like this::
+
+			$config['x_axis'] = '100';
+			$config['y_axis'] = '40';
+
+		All preferences listed in the :ref:`processing-preferences` table are available for this
+		method except these: *rotation_angle*, *create_thumb* and *new_image*.
+
+		Here's an example showing how you might crop an image::
+
+			$config['image_library'] = 'imagemagick';
+			$config['library_path'] = '/usr/X11R6/bin/';
+			$config['source_image']	= '/path/to/image/mypic.jpg';
+			$config['x_axis'] = '100';
+			$config['y_axis'] = '60';
+
+			$this->image_lib->initialize($config); 
+
+			if ( ! $this->image_lib->crop())
+			{
+				echo $this->image_lib->display_errors();
+			}
+
+		.. note:: Without a visual interface it is difficult to crop images, so this
+			method is not very useful unless you intend to build such an
+			interface. That's exactly what we did using for the photo gallery module
+			in ExpressionEngine, the CMS we develop. We added a JavaScript UI that
+			lets the cropping area be selected.
+
+	.. method:: rotate()
+
+		:returns: bool
+
+		The image rotation method requires that the angle of rotation be set
+		via its preference::
+
+			$config['rotation_angle'] = '90';
+
+		There are 5 rotation options:
+
+		#. 90 - rotates counter-clockwise by 90 degrees.
+		#. 180 - rotates counter-clockwise by 180 degrees.
+		#. 270 - rotates counter-clockwise by 270 degrees.
+		#. hor - flips the image horizontally.
+		#. vrt - flips the image vertically.
+
+		Here's an example showing how you might rotate an image::
+
+			$config['image_library'] = 'netpbm';
+			$config['library_path'] = '/usr/bin/';
+			$config['source_image']	= '/path/to/image/mypic.jpg';
+			$config['rotation_angle'] = 'hor';
+
+			$this->image_lib->initialize($config); 
+
+			if ( ! $this->image_lib->rotate())
+			{
+				echo $this->image_lib->display_errors();
+			}
+
+	.. method:: watermark()
+
+		:returns: bool
+
+		Creates a watermark over an image, please refer to the :ref:`watermarking`
+		section for more info.		
+
+	.. method:: clear()
+
+		:returns: void
+
+		The clear method resets all of the values used when processing an
+		image. You will want to call this if you are processing images in a
+		loop.
+
+		::
+
+			$this->image_lib->clear();
+
+	.. method:: display_errors([$open = '<p>[, $close = '</p>']])
+
+		:param string $open: Error message opening tag
+		:param string $close: Error message closing tag
+		:returns: string
+
+		Returns all detected errors formatted as a string.
+		::
+
+			echo $this->image_lib->diplay_errors();
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 1ee5a997279e3f2c6fb20fb648d3620d8b1a14f5 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Mon, 6 Jan 2014 13:08:47 +0200
Subject: [ci skip] Update the Session library docs

---
 user_guide_src/source/libraries/sessions.rst | 60 +++++++++++++++-------------
 1 file changed, 33 insertions(+), 27 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/sessions.rst b/user_guide_src/source/libraries/sessions.rst
index 8e117bee6..4ce355606 100644
--- a/user_guide_src/source/libraries/sessions.rst
+++ b/user_guide_src/source/libraries/sessions.rst
@@ -506,7 +506,7 @@ Class Reference
 	.. method:: load_driver($driver)
 
 		:param string $driver: Driver name
-		:returns: object Loaded driver object
+		:returns: object
 
 		Loads a session storage driver
 
@@ -520,22 +520,26 @@ Class Reference
 	.. method:: sess_destroy()
 
 		Destroys current session
-		.. note:: This function should be the last one called, and even flash variables will no longer be available.
-		 If you only want some items destroyed and not all, use ``unset_userdata()``.
 
-	.. method:: sess_regenerate($destroy)
+		.. note:: This method should be the last one called, and even flash
+			variables will no longer be available after it is used.
+			 If you only want some items destroyed and not all, use
+			``unset_userdata()``.
 
-		:param bool $destroy: Destroy session data flag (default: false)
+	.. method:: sess_regenerate([$destroy = FALSE])
+
+		:param bool $destroy: Whether to destroy session data
 		:returns: void
 
-		Regenerate the current session data
+		Regenerate the current session data.
 
 	.. method:: userdata($item)
 
-		:param string $item: name of session item
+		:param string $item: Session item name
 		:returns: string
 
-		Returns a string containing the value of the passed item or NULL if the item is not found. Example::
+		Returns a string containing the value of the passed item or NULL if the item is not found.
+		Example::
 
 			$this->session->userdata('user');
 			//returns example@example.com considering the set_userdata example.
@@ -544,15 +548,15 @@ Class Reference
 
 		:returns: array
 
-		Retruns array of userdata session items
+		Retruns an array with all of the session userdata items.
 
 	.. method:: all_flashdata()
 
 		:returns: array
 
-		Retruns array of flashdata session items
+		Retruns an array with all of the session flashdata items.
 
-	.. method:: set_userdata($newdata = array(), $newval)
+	.. method:: set_userdata($newdata[, $newval = ''])
 
 		:param mixed $newdata: Item name or array of items
 		:param mixed $newval: Item value or empty string (not required if $newdata is array)
@@ -568,10 +572,10 @@ Class Reference
 
 	.. method:: unset_userdata($item)
 
-		:param mixed $item: name of item or array of items
+		:param mixed $item: Item name or an array containing multiple items
 		:returns: void
 
-		Unsets previously setted items from the session. Example::
+		Unsets previously set items from the session. Example::
 
 			$this->session->unset_userdata('user');
 			//unsets 'user' from session data.
@@ -581,14 +585,14 @@ Class Reference
 
 	.. method:: has_userdata($item)
 
-		:param string $item: name of item
+		:param string $item: Item name
 		:returns: bool
 
 		Checks if an item exists in the session.
 
-	.. method:: set_flashdata($newdata = array(), $newval)
+	.. method:: set_flashdata($newdata[, $newval = ''])
 
-		:param mixed $newdata: Item name or array of items
+		:param mixed $newdata: Item name or an array of items
 		:param mixed $newval: Item value or empty string (not required if $newdata is array)
 		:returns: void
 
@@ -603,26 +607,27 @@ Class Reference
 
 	.. method:: keep_flashdata($item)
 
-		:param mixed $item: name of item or array of flashdata items
+		:param mixed $item: Item name or an array containing multiple flashdata items
 		:returns: void
 
-		Keeps items into flashdata for one more request
+		Keeps items into flashdata for one more request.
 
 	.. method:: flashdata($item)
 
-		:param string $item: name of session item
+		:param string $item: Flashdata item name
 		:returns: string
 
-		Returns a string containing the value of the passed item or NULL if the item is not found. Example::
+		Returns a string containing the value of the passed item or NULL if the item is not found.
+		Example::
 
 			$this->session->flashdata('message');
 			//returns 'Test message.' considering the set_flashdata example.
 
-	.. method:: set_tempdata($newdata = array(), $newval, $expires)
+	.. method:: set_tempdata($newdata[, $newval = ''[, $expire = 0]])
 
-		:param mixed $newdata: Item name or array of items
+		:param mixed $newdata: Item name or array containing multiple items
 		:param string $newval: Item value or empty string (not required if $newdata is array)
-		:param int $expires: lifetime in seconds (0 for default)
+		:param int $expire: Lifetime in seconds (0 for default)
 		:returns: void
 
 		Sets items into session tempdata example::
@@ -636,10 +641,10 @@ Class Reference
 
 	.. method:: unset_tempdata($item)
 
-		:param mixed $item: name of item or array of items
+		:param mixed $item: Item name or an array containing multiple items
 		:returns: void
 
-		Unsets previously setted items from the tempdata. Example::
+		Unsets previously set items from tempdata. Example::
 
 			$this->session->unset_tempdata('user');
 			//unsets 'user' from tempdata.
@@ -649,10 +654,11 @@ Class Reference
 
 	.. method:: tempdata($item)
 
-		:param string $item: name of tempdata item
+		:param string $item: Tempdata item name
 		:returns: string
 
-		Returns a string containing the value of the passed item or NULL if the item is not found. Example::
+		Returns a string containing the value of the passed item or NULL if the item is not found.
+		Example::
 
 			$this->session->tempdata('message');
 			//returns 'Test message.' considering the set_tempdata example.
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 1720a6aee782b1193454e2ec172f3e89461f83f4 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Mon, 6 Jan 2014 13:50:05 +0200
Subject: Fix #2579: Query Builder's "no escape" functionality didn't work
 properly with query cache

---
 user_guide_src/source/changelog.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 8bba39431..7cc27eb5a 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -630,6 +630,7 @@ Bug fixes for 3.0
 -  Fixed a bug (#2515) - ``_exception_handler()`` used to send the 200 "OK" HTTP status code and didn't stop script exection even on fatal errors.
 -  Fixed a bug - Redis :doc:`Caching <libraries/caching>` driver didn't handle connection failures properly.
 -  Fixed a bug (#2756) - :doc:`Database Class <database/index>` executed the MySQL-specific `SET SESSION sql_mode` query for all drivers when the 'stricton' option is set.
+-  Fixed a bug (#2579) - :doc:`Query Builder <database/query_builder>`s "no escape" functionality didn't work properly with query cache.
 
 Version 2.1.4
 =============
-- 
cgit v1.2.3-24-g4f1b


From a9c7d18dc4ba53507d6e606221f06aa3fafeaa8e Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Mon, 6 Jan 2014 14:38:00 +0200
Subject: Fix #2237: Parser library failed if the same tag pair is used more
 than once within a template

(manually applying PR #2238 + updated unit tests)
---
 user_guide_src/source/changelog.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 7cc27eb5a..6d0ceb6c3 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -631,6 +631,7 @@ Bug fixes for 3.0
 -  Fixed a bug - Redis :doc:`Caching <libraries/caching>` driver didn't handle connection failures properly.
 -  Fixed a bug (#2756) - :doc:`Database Class <database/index>` executed the MySQL-specific `SET SESSION sql_mode` query for all drivers when the 'stricton' option is set.
 -  Fixed a bug (#2579) - :doc:`Query Builder <database/query_builder>`s "no escape" functionality didn't work properly with query cache.
+-  Fixed a bug (#2237) - :doc:`Parser Library <libraries/parser>` failed if the same tag pair is used more than once within a template.
 
 Version 2.1.4
 =============
-- 
cgit v1.2.3-24-g4f1b


From 9f387e7b756fc4d063a769338af6dc4ee89bc061 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Tue, 7 Jan 2014 11:50:34 +0200
Subject: [ci skip] Clean up the common functions docs

---
 user_guide_src/source/general/common_functions.rst | 165 +++++++++------------
 1 file changed, 69 insertions(+), 96 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/general/common_functions.rst b/user_guide_src/source/general/common_functions.rst
index 8a57c183e..f8e9d775b 100644
--- a/user_guide_src/source/general/common_functions.rst
+++ b/user_guide_src/source/general/common_functions.rst
@@ -6,70 +6,65 @@ CodeIgniter uses a few functions for its operation that are globally
 defined, and are available to you at any point. These do not require
 loading any libraries or helpers.
 
-is_php()
-========
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
 
 .. function:: is_php($version = '5.3.0')
 
 	:param	string	$version: Version number
 	:returns:	bool
 
-Determines of the PHP version being used is greater than the
-supplied version number.
+	Determines of the PHP version being used is greater than the
+	supplied version number.
 
-Example::
+	Example::
 
-	if (is_php('5.3'))
-	{
-		$str = quoted_printable_encode($str);
-	}
+		if (is_php('5.3'))
+		{
+			$str = quoted_printable_encode($str);
+		}
 
-Returns boolean TRUE if the installed version of PHP is equal to or
-greater than the supplied version number. Returns FALSE if the installed
-version of PHP is lower than the supplied version number.
+	Returns boolean TRUE if the installed version of PHP is equal to or
+	greater than the supplied version number. Returns FALSE if the installed
+	version of PHP is lower than the supplied version number.
 
-is_really_writable()
-====================
+	.. function:: is_really_writable($file)
 
-.. function:: is_really_writable($file)
-
-	:param	string	$file: File path
-	:returns:	bool
+		:param	string	$file: File path
+		:returns:	bool
 
-``is_writable()`` returns TRUE on Windows servers when you really can't
-write to the file as the OS reports to PHP as FALSE only if the
-read-only attribute is marked.
+	``is_writable()`` returns TRUE on Windows servers when you really can't
+	write to the file as the OS reports to PHP as FALSE only if the
+	read-only attribute is marked.
 
-This function determines if a file is actually writable by attempting
-to write to it first. Generally only recommended on platforms where
-this information may be unreliable.
+	This function determines if a file is actually writable by attempting
+	to write to it first. Generally only recommended on platforms where
+	this information may be unreliable.
 
-Example::
+	Example::
 
-	if (is_really_writable('file.txt'))
-	{
-		echo "I could write to this if I wanted to";
-	}
-	else
-	{
-		echo "File is not writable";
-	}
-
-config_item()
-=============
+		if (is_really_writable('file.txt'))
+		{
+			echo "I could write to this if I wanted to";
+		}
+		else
+		{
+			echo "File is not writable";
+		}
 
 .. function:: config_item($key)
 
 	:param	string	$key: Config item key
 	:returns:	mixed
 
-The :doc:`Config Library <../libraries/config>` is the preferred way of
-accessing configuration information, however ``config_item()`` can be used
-to retrieve single keys. See :doc:`Config Library <../libraries/config>`
-documentation for more information.
-
-show_error()
-============
+	The :doc:`Config Library <../libraries/config>` is the preferred way of
+	accessing configuration information, however ``config_item()`` can be used
+	to retrieve single keys. See :doc:`Config Library <../libraries/config>`
+	documentation for more information.
 
 .. function:: show_error($message, $status_code, $heading = 'An Error Was Encountered')
 
@@ -78,11 +73,8 @@ show_error()
 	:param	string	$heading: Error page heading
 	:returns:	void
 
-This function calls ``CI_Exception::show_error()``. For more info,
-please see the :doc:`Error Handling <errors>` documentation.
-
-show_404()
-==========
+	This function calls ``CI_Exception::show_error()``. For more info,
+	please see the :doc:`Error Handling <errors>` documentation.
 
 .. function:: show_404($page = '', $log_error = TRUE)
 
@@ -90,11 +82,8 @@ show_404()
 	:param	bool	$log_error: Whether to log the error
 	:returns:	void
 
-This function calls ``CI_Exception::show_404()``. For more info,
-please see the :doc:`Error Handling <errors>` documentation.
-
-log_message()
-=============
+	This function calls ``CI_Exception::show_404()``. For more info,
+	please see the :doc:`Error Handling <errors>` documentation.
 
 .. function:: log_message($level, $message, $php_error = FALSE)
 
@@ -103,11 +92,8 @@ log_message()
 	:param	bool	$php_error: Whether we're logging a native PHP error message
 	:returns:	void
 
-This function is an alias for ``CI_Log::write_log()``. For more info,
-please see the :doc:`Error Handling <errors>` documentation.
-
-set_status_header()
-===============================
+	This function is an alias for ``CI_Log::write_log()``. For more info,
+	please see the :doc:`Error Handling <errors>` documentation.
 
 .. function:: set_status_header($code, $text = '')
 
@@ -115,16 +101,13 @@ set_status_header()
 	:param	string	$text: A custom message to set with the status code
 	:returns:	void
 
-Permits you to manually set a server status header. Example::
-
-	set_status_header(401);
-	// Sets the header as:  Unauthorized
+	Permits you to manually set a server status header. Example::
 
-`See here <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html>`_ for
-a full list of headers.
+		set_status_header(401);
+		// Sets the header as:  Unauthorized
 
-remove_invisible_characters()
-=============================
+	`See here <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html>`_ for
+	a full list of headers.
 
 .. function:: remove_invisible_characters($str, $url_encoded = TRUE)
 
@@ -132,47 +115,37 @@ remove_invisible_characters()
 	:param	bool	$url_encoded: Whether to remove URL-encoded characters as well
 	:returns:	string
 
-This function prevents inserting NULL characters between ASCII
-characters, like Java\\0script.
+	This function prevents inserting NULL characters between ASCII
+	characters, like Java\\0script.
 
-Example::
+	Example::
 
-	remove_invisible_characters('Java\\0script');
-	// Returns: 'Javascript'
-
-html_escape()
-=============
+		remove_invisible_characters('Java\\0script');
+		// Returns: 'Javascript'
 
 .. function:: html_escape($var)
 
-	:param	mixed	$var: Variable to escape
-			(string or array)
+	:param	mixed	$var: Variable to escape (string or array)
 	:returns:	mixed
 
-This function acts as an alias for PHP's native ``htmlspecialchars()``
-function, with the advantage of being able to accept an array of strings.
-
-It is useful in preventing Cross Site Scripting (XSS).
+	This function acts as an alias for PHP's native ``htmlspecialchars()``
+	function, with the advantage of being able to accept an array of strings.
 
-get_mimes()
-===========
+	It is useful in preventing Cross Site Scripting (XSS).
 
 .. function:: get_mimes()
 
 	:returns:	array
 
-This function returns a *reference* to the MIMEs array from
-*application/config/mimes.php*.
-
-is_https()
-==========
+	This function returns a *reference* to the MIMEs array from
+	*application/config/mimes.php*.
 
 .. function:: is_https()
 
 	:returns:	bool
 
-Returns TRUE if a secure (HTTPS) connection is used and FALSE
-in any other case (including non-HTTP requests).
+	Returns TRUE if a secure (HTTPS) connection is used and FALSE
+	in any other case (including non-HTTP requests).
 
 function_usable()
 =================
@@ -182,12 +155,12 @@ function_usable()
 	:param	string	$function_name: Function name
 	:returns:	bool
 
-Returns TRUE if a function exists and is usable, FALSE otherwise.
+	Returns TRUE if a function exists and is usable, FALSE otherwise.
 
-This function runs a ``function_exists()`` check and if the
-`Suhosin extension <http://www.hardened-php.net/suhosin/>` is loaded,
-checks if it doesn't disable the function being checked.
+	This function runs a ``function_exists()`` check and if the
+	`Suhosin extension <http://www.hardened-php.net/suhosin/>` is loaded,
+	checks if it doesn't disable the function being checked.
 
-It is useful if you want to check for the availability of functions
-such as ``eval()`` and ``exec()``, which are dangerous and might be
-disabled on servers with highly restrictive security policies.
\ No newline at end of file
+	It is useful if you want to check for the availability of functions
+	such as ``eval()`` and ``exec()``, which are dangerous and might be
+	disabled on servers with highly restrictive security policies.
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From dc53d7b68adc6fdc8d0917ee2d29f5670ff82b45 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Tue, 7 Jan 2014 12:12:11 +0200
Subject: Add Basic HTTP authentication support to the XML-RPC library

(based on PR #1716)
---
 user_guide_src/source/changelog.rst | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 6d0ceb6c3..27031b941 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -342,7 +342,6 @@ Release Date: Not Released
       -  Deprecated usage of the "anchor_class" setting (use the new "attributes" setting instead).
       -  Added $config['reuse_query_string'] to allow automatic repopulation of query string arguments, combined with normal URI segments.
       -  Removed the default ``&nbsp;`` from a number of the configuration variables.
-      -  Added the ability to use a proxy with the :doc:`XML-RPC Library <libraries/xmlrpc>`.
 
    -  :doc:`Encryption Library <libraries/encryption>` changes include:
 
@@ -354,13 +353,18 @@ Release Date: Not Released
       -  Database object names are now being displayed.
       -  The sum of all queries running times in seconds is now being displayed.
       -  Added support for displaying the HTTP DNT ("Do Not Track") header.
-      -  Added support for displaying $_FILES.
+      -  Added support for displaying ``$_FILES``.
 
    -  :doc:`Migration Library <libraries/migration>` changes include:
 
       -  Added support for timestamp-based migrations (enabled by default).
       -  Added ``$config['migration_type']`` to allow switching between *sequential* and *timestamp* migrations.
 
+   -  :doc:`XML-RPC Library <libraries/xmlrpc>` changes include:
+
+      -  Added the ability to use a proxy.
+      -  Added Basic HTTP authentication support.
+
    -  :doc:`User Agent Library <libraries/user_agent>` will now check if robots are pretending to be mobile clients (helps with e.g. Google indexing mobile website versions).
    -  Added support for setting :doc:`Table <libraries/table>` class defaults in a config file.
 
-- 
cgit v1.2.3-24-g4f1b


From d192953eb39845623811486a28b777b3dda93b5c Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Tue, 7 Jan 2014 12:16:16 +0200
Subject: Add basic HTTP auth info to the XML-RPC docs

---
 user_guide_src/source/libraries/xmlrpc.rst | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/xmlrpc.rst b/user_guide_src/source/libraries/xmlrpc.rst
index c89c69c46..91d832ff6 100644
--- a/user_guide_src/source/libraries/xmlrpc.rst
+++ b/user_guide_src/source/libraries/xmlrpc.rst
@@ -476,6 +476,10 @@ Class Reference
 
 			$this->xmlrpc->server('http://www.sometimes.com/pings.php', 80);
 
+		Basic HTTP authentication is also supported, simply add it to the server URL::
+
+			$this->xmlrpc->server('http://user:pass@localhost/', 80);
+
 	.. method:: timeout($seconds = 5)
 
 		:param int $seconds: timeout in seconds
-- 
cgit v1.2.3-24-g4f1b


From 1bbc5644b0c306ff72dc1228b169db56902fc031 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Tue, 7 Jan 2014 12:45:27 +0200
Subject: Fix #2268 (manually implementing PR #2269)

---
 user_guide_src/source/changelog.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 27031b941..892bbfbdf 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -636,6 +636,7 @@ Bug fixes for 3.0
 -  Fixed a bug (#2756) - :doc:`Database Class <database/index>` executed the MySQL-specific `SET SESSION sql_mode` query for all drivers when the 'stricton' option is set.
 -  Fixed a bug (#2579) - :doc:`Query Builder <database/query_builder>`s "no escape" functionality didn't work properly with query cache.
 -  Fixed a bug (#2237) - :doc:`Parser Library <libraries/parser>` failed if the same tag pair is used more than once within a template.
+-  Fixed a bug (#2268) - :doc:`Security Library <libraries/security>` didn't properly match JavaScript events.
 
 Version 2.1.4
 =============
-- 
cgit v1.2.3-24-g4f1b


From 61a7b8f4b38bbca520c43ac100899449f73bf408 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Tue, 7 Jan 2014 13:36:50 +0200
Subject: Implement Loader method chaining

Requested in issue #2165
Supersedes PR #2319
---
 user_guide_src/source/changelog.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 892bbfbdf..32d033c9b 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -381,6 +381,7 @@ Release Date: Not Released
 
    -  :doc:`Loader Library <libraries/loader>` changes include:
 
+      -  Added method chaining support.
       -  Added method ``get_vars()`` to the Loader to retrieve all variables loaded with ``$this->load->vars()``.
       -  ``_ci_autoloader()`` is now a protected method.
       -  Added autoloading of drivers with ``$autoload['drivers']``.
-- 
cgit v1.2.3-24-g4f1b


From 0c9d08056e0816a1103b5b13b9c8e297f430d7bb Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Tue, 7 Jan 2014 13:39:23 +0200
Subject: [ci skip] Update Loader library docs for method chaining

---
 user_guide_src/source/libraries/loader.rst | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/loader.rst b/user_guide_src/source/libraries/loader.rst
index 20e1c1d3c..477639969 100644
--- a/user_guide_src/source/libraries/loader.rst
+++ b/user_guide_src/source/libraries/loader.rst
@@ -83,7 +83,7 @@ Class Reference
 		:param mixed $library: Library name as a string or an array with multiple libraries
 		:param array $params: Optional array of parameters to pass to the loaded library's constructor
 		:param string $object_name: Optional object name to assign the library to
-		:returns: void
+		:returns: object
 
 		This method is used to load core classes.
 
@@ -161,7 +161,7 @@ Class Reference
 		:param mixed $library: Library name as a string or an array with multiple libraries
 		:param array $params: Optional array of parameters to pass to the loaded library's constructor
 		:param string $object_name: Optional object name to assign the library to
-		:returns: void
+		:returns: object
 
 		This method is used to load driver libraries, acts very much like the
 		``library()`` method.
@@ -255,7 +255,7 @@ Class Reference
 
 		:param mixed $vars: An array of variables or a single variable name
 		:param mixed $val: Optional variable value
-		:returns: void
+		:returns: object
 
 		This method takes an associative array as input and generates
 		variables using the PHP `extract() <http://www.php.net/extract>`_
@@ -287,7 +287,7 @@ Class Reference
 		:param mixed $model: Model name or an array containing multiple models
 		:param string $name: Optional object name to assign the model to
 		:param string $db_conn: Optional database configuration group to load
-		:returns: void
+		:returns: object
 
 		::
 
@@ -338,7 +338,7 @@ Class Reference
 	.. method:: helper($helpers)
 
 		:param mixed $helpers: Helper name as a string or an array containing multiple helpers
-		:returns: void
+		:returns: object
 
 		This method loads helper files, where file_name is the name of the
 		file, without the _helper.php extension.
@@ -359,7 +359,7 @@ Class Reference
 
 		:param mixed $files: Language file name or an array of multiple language files
 		:param string $lang: Language name
-		:returns: void
+		:returns: object
 
 		This method is an alias of the :doc:`language loading
 		method <language>`: ``$this->lang->load()``.
@@ -378,20 +378,20 @@ Class Reference
 
 		:param string $path: Path to add
 		:param bool $view_cascade: Whether to use cascading views
-		:returns: void
+		:returns: object
 
 		Adding a package path instructs the Loader class to prepend a given path
 		for subsequent requests for resources. As an example, the "Foo Bar"
 		application package above has a library named Foo_bar.php. In our
 		controller, we'd do the following::
 
-			$this->load->add_package_path(APPPATH.'third_party/foo_bar/');
-			$this->load->library('foo_bar');
+			$this->load->add_package_path(APPPATH.'third_party/foo_bar/')
+				->library('foo_bar');
 
 	.. method:: remove_package_path([$path = ''])
 
 		:param string $path: Path to remove
-		:returns: void
+		:returns: object
 
 		When your controller is finished using resources from an application
 		package, and particularly if you have other application packages you
-- 
cgit v1.2.3-24-g4f1b


From 3b2803ef6ddd72772bf5bcb130ace207bc10d60e Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Tue, 7 Jan 2014 14:46:38 +0200
Subject: Fix #2143

When trying to load rules from a configuration file, the Form validation library matched against
ruri_string() as opposed to 'controller/method' like described in the manual. Since ruri_string()
also makes sense, now both are being checked with ruri_string() having a higher precedence.

Supersedes PR #2224
---
 user_guide_src/source/changelog.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 32d033c9b..2ad8eff0f 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -638,6 +638,7 @@ Bug fixes for 3.0
 -  Fixed a bug (#2579) - :doc:`Query Builder <database/query_builder>`s "no escape" functionality didn't work properly with query cache.
 -  Fixed a bug (#2237) - :doc:`Parser Library <libraries/parser>` failed if the same tag pair is used more than once within a template.
 -  Fixed a bug (#2268) - :doc:`Security Library <libraries/security>` didn't properly match JavaScript events.
+-  Fixed a bug (#2143) - :doc:`Form Validation Library <libraries/form_validation>` didn't check for rule groups named in a *controller/method* manner when trying to load from a config file.
 
 Version 2.1.4
 =============
-- 
cgit v1.2.3-24-g4f1b


From a20ec975e653f501cca8e1cf57a9ea244417990f Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Tue, 7 Jan 2014 15:23:10 +0200
Subject: Add ability for changing the original file path/name in
 CI_Zip::read_file()

Supersedes PR #884
---
 user_guide_src/source/changelog.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 2ad8eff0f..cf15e0fe2 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -367,6 +367,7 @@ Release Date: Not Released
 
    -  :doc:`User Agent Library <libraries/user_agent>` will now check if robots are pretending to be mobile clients (helps with e.g. Google indexing mobile website versions).
    -  Added support for setting :doc:`Table <libraries/table>` class defaults in a config file.
+   -  :doc:`Zip Library <libraries/zip>` method ``read_file()`` can now also alter the original file path/name while adding files to an archive.
 
 -  Core
 
-- 
cgit v1.2.3-24-g4f1b


From 45082b6118a9b66e48c16582f72d4499d2c290c6 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Tue, 7 Jan 2014 15:28:17 +0200
Subject: [ci skip] Update CI_Zip::read_file() docs

---
 user_guide_src/source/libraries/zip.rst | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/zip.rst b/user_guide_src/source/libraries/zip.rst
index ea5b46bac..535aa82d9 100644
--- a/user_guide_src/source/libraries/zip.rst
+++ b/user_guide_src/source/libraries/zip.rst
@@ -98,10 +98,10 @@ Class Reference
 
 			$this->zip->add_dir('myfolder'); // Creates a directory called "myfolder"
 
-	.. method:: read_file($path[, $preserve_filepath = FALSE])
+	.. method:: read_file($path[, $archive_filepath = FALSE])
 
-		:param string $path: path to file
-		:param bool $preserve_filepath: whether to maintain the original filepath
+		:param string $path: Path to file
+		:param mixed $archive_filepath: New file name/path (string) or (boolean) whether to maintain the original filepath
 		:returns: bool
 
 		Permits you to compress a file that already exists somewhere on your server.
@@ -126,6 +126,16 @@ Class Reference
 
 		In the above example, photo.jpg will be placed into the *path/to/* directory.
 
+		You can also specify a new name (path included) for the added file on the fly::
+
+			$path = '/path/to/photo.jpg';
+			$new_path = '/new/path/some_photo.jpg';
+
+			$this->zip->read_file($path, $new_path);
+
+			// Download ZIP archive containing /new/path/some_photo.jpg
+			$this->zip->download('my_archive.zip');
+
 	.. method:: read_dir($path[, $preserve_filepath = TRUE[, $root_path = NULL]])
 
 		:param string $path: path to directory
-- 
cgit v1.2.3-24-g4f1b


From ac023e10e7d9e4ad11783ff7e1154d2701a1ec18 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Tue, 7 Jan 2014 16:13:03 +0200
Subject: Change Text helper default tag from <strong> to <mark>

Supersedes PR #1497
---
 user_guide_src/source/changelog.rst                |  7 ++++---
 user_guide_src/source/installation/upgrade_300.rst | 20 +++++++++++++++++++-
 2 files changed, 23 insertions(+), 4 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index cf15e0fe2..e285ab014 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -130,9 +130,10 @@ Release Date: Not Released
       - Added *colors* configuration to allow customization for the *background*, *border*, *text* and *grid* colors.
       - Added *filename* to the returned array elements.
 
-   -  :doc:`Directory Helper <helpers/directory_helper>` :php:func:`directory_map()` will now append ``DIRECTORY_SEPARATOR`` to directory names in the returned array.
-   -  :doc:`Array Helper <helpers/array_helper>` :php:func:`element()` and :php:func:`elements()` now return NULL instead of FALSE when the required elements don't exist.
-   -  :doc:`Language Helper <helpers/language_helper>` :php:func:`lang()` now accepts an optional list of additional HTML attributes.
+   -  :doc:`Directory Helper <helpers/directory_helper>` :func:`directory_map()` will now append ``DIRECTORY_SEPARATOR`` to directory names in the returned array.
+   -  :doc:`Array Helper <helpers/array_helper>` :func:`element()` and :php:func:`elements()` now return NULL instead of FALSE when the required elements don't exist.
+   -  :doc:`Language Helper <helpers/language_helper>` :func:`lang()` now accepts an optional list of additional HTML attributes.
+   -  Changed the default tag for use in :doc:`Text Helper <helpers/text_helper>` :func:`highlight_phrase()` to ``<mark>`` (formerly ``<strong>``).
    -  Deprecated the :doc:`Email Helper <helpers/email_helper>` as its ``valid_email()``, ``send_email()`` functions are now only aliases for PHP native functions ``filter_var()`` and ``mail()`` respectively.
 
 -  Database
diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst
index ec80e8041..41153df16 100644
--- a/user_guide_src/source/installation/upgrade_300.rst
+++ b/user_guide_src/source/installation/upgrade_300.rst
@@ -488,4 +488,22 @@ The new function is both available at all times for you to use and shorter to ty
 CodeIgniter 3.1+.
 
 .. note:: This method is still available, but you're strongly encouraged to remove its usage
-	sooner rather than later.
\ No newline at end of file
+	sooner rather than later.
+
+***********************************************************
+Step 17: Check your usage of Text helper highlight_phrase()
+***********************************************************
+
+The default HTML tag used by :doc:`Text Helper <../helpers/text_helper>` function
+:func:`highlight_phrase()` has been changed from ``<strong>`` to the new HTML5
+tag ``<mark>``.
+
+Unless you've used your own highlighting tags, this might cause trouble
+for your visitors who use older web browsers such as Internet Explorer 8.
+We therefore suggest that you add the following code to your CSS files
+in order to avoid backwards compatibility with old browsers::
+
+	mark {
+		background: #ff0;
+		color: #000;
+	};
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From e0da15316d6a00334cd3c56421ad361453bd4281 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Tue, 7 Jan 2014 16:17:04 +0200
Subject: [ci skip] Update the Text helper docs

---
 user_guide_src/source/helpers/text_helper.rst | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/helpers/text_helper.rst b/user_guide_src/source/helpers/text_helper.rst
index 0cacd1b69..3c6430f3f 100644
--- a/user_guide_src/source/helpers/text_helper.rst
+++ b/user_guide_src/source/helpers/text_helper.rst
@@ -35,7 +35,7 @@ The following functions are available:
 
 		$string = "Here is a nice text string consisting of eleven words.";
 		$string = word_limiter($string, 4);
-		// Returns:  Here is a nice…
+		// Returns:  Here is a nice
 
 	The third parameter is an optional suffix added to the string. By
 	default it adds an ellipsis.
@@ -56,7 +56,7 @@ The following functions are available:
 
 		$string = "Here is a nice text string consisting of eleven words.";
 		$string = character_limiter($string, 20);
-		// Returns:  Here is a nice text string…
+		// Returns:  Here is a nice text string
 
 	The third parameter is an optional suffix added to the string, if
 	undeclared this helper uses an ellipsis.
@@ -143,7 +143,7 @@ The following functions are available:
 	colors used are the ones specified in your php.ini file.
 
 
-.. function:: highlight_phrase($str, $phrase[, $tag_open = '<strong>'[, $tag_close = '</strong>']])
+.. function:: highlight_phrase($str, $phrase[, $tag_open = '<mark>'[, $tag_close = '</mark>']])
 
 	:param	string	$str: Input string
 	:param	string	$phrase: Phrase to highlight
@@ -165,6 +165,16 @@ The following functions are available:
 
 		Here is a <span style="color:#990000;">nice text</span> string about nothing in particular.
 
+	.. note:: This function used to use the ``<strong>`` tag by default. Older browsers
+		might not support the new HTML5 mark tag, so it is recommended that you
+		insert the following CSS code into your stylesheet if you need to support
+		such browsers::
+
+			mark {
+				background: #ff0;
+				color: #000;
+			};
+
 
 .. function:: word_wrap($str[, $charlim = 76])
 
-- 
cgit v1.2.3-24-g4f1b


From 896d3e3a973d24985b61d963c9cdb086a010a74f Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Tue, 7 Jan 2014 17:13:25 +0200
Subject: Add a more clear note about query builder caching (issue #2721)

---
 user_guide_src/source/database/query_builder.rst | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/database/query_builder.rst b/user_guide_src/source/database/query_builder.rst
index 9a96db003..5bfdfdb52 100644
--- a/user_guide_src/source/database/query_builder.rst
+++ b/user_guide_src/source/database/query_builder.rst
@@ -1058,4 +1058,9 @@ run the query::
 	$data = $this->db->get()->result_array();
 
 	// Would execute and return an array of results of the following query:
-	// SELECT field1, field1 from mytable where field3 = 5;
\ No newline at end of file
+	// SELECT field1, field1 from mytable where field3 = 5;
+
+.. note:: Double calls to ``get_compiled_select()`` while you're using the
+	Query Builder Caching functionality and NOT resetting your queries
+	will results in the cache being merged twice. That in turn will
+	i.e. if you're caching a ``select()`` - select the same field twice.
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 69e1b4f054521bc055af9e2b377a3a578fc6cadc Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Tue, 7 Jan 2014 17:29:25 +0200
Subject: [ci skip] Add a PostgreSQL CREATE TABLE sample to the Session docs

From PR #2758
---
 user_guide_src/source/libraries/sessions.rst | 19 ++++++++++++++++---
 1 file changed, 16 insertions(+), 3 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/sessions.rst b/user_guide_src/source/libraries/sessions.rst
index 4ce355606..c76bccb8c 100644
--- a/user_guide_src/source/libraries/sessions.rst
+++ b/user_guide_src/source/libraries/sessions.rst
@@ -400,11 +400,24 @@ session class::
 		KEY `last_activity_idx` (`last_activity`)
 	);
 
+Or if you're using PostgreSQL::
+
+	CREATE TABLE  ci_sessions (
+		session_id varchar(40) DEFAULT '0' NOT NULL,
+		ip_address varchar(45) DEFAULT '0' NOT NULL,
+		user_agent varchar(120) NOT NULL,
+		last_activity bigint DEFAULT 0 NOT NULL,
+		user_data text NOT NULL,
+		PRIMARY KEY (session_id)
+	);
+
+	CREATE INDEX last_activity_idx ON ci_sessions(last_activity);
+
 .. note:: By default the table is called ci_sessions, but you can name
 	it anything you want as long as you update the
-	application/config/config.php file so that it contains the name you have
-	chosen. Once you have created your database table you can enable the
-	database option in your config.php file as follows::
+	*application/config/config.php* file so that it contains the name
+	you have chosen. Once you have created your database table you
+	can enable the database option in your config.php file as follows::
 
 		$config['sess_use_database'] = TRUE;
 
-- 
cgit v1.2.3-24-g4f1b


From da8c7a5bb92b928c19918632d8cb8a06d0ea747d Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Tue, 7 Jan 2014 18:08:26 +0200
Subject: Fix a few bugs in CI_Hook (based on PR #2762)

---
 user_guide_src/source/changelog.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index e285ab014..670e8d0e1 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -641,6 +641,7 @@ Bug fixes for 3.0
 -  Fixed a bug (#2237) - :doc:`Parser Library <libraries/parser>` failed if the same tag pair is used more than once within a template.
 -  Fixed a bug (#2268) - :doc:`Security Library <libraries/security>` didn't properly match JavaScript events.
 -  Fixed a bug (#2143) - :doc:`Form Validation Library <libraries/form_validation>` didn't check for rule groups named in a *controller/method* manner when trying to load from a config file.
+-  Fixed a bug (#2762) - :doc:`Hooks Class <general/hooks>` didn't properly check if the called class/function exists.
 
 Version 2.1.4
 =============
-- 
cgit v1.2.3-24-g4f1b


From 4b85e77aaf607713c9954b463b6ad3ba91012a05 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Wed, 8 Jan 2014 14:02:01 +0200
Subject: [ci skip] Add a changelog entry for PR #2800

---
 user_guide_src/source/changelog.rst | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 670e8d0e1..49ca39502 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -451,10 +451,13 @@ Release Date: Not Released
       -  Added an optional second parameter to method ``line()`` to disable error login for line keys that were not found.
       -  Language files are now loaded in a cascading style with the one in **system/** always loaded and overriden afterwards, if another one is found.
 
+   -  :doc:`Hooks Library <general/hooks>` changes include:
+      -  Renamed method ``_call_hook()`` to ``call_hook()``.
+      -  Class instances are now stored in order to maintain their state.
+
    -  Removed ``CI_CORE`` boolean constant from *CodeIgniter.php* (no longer Reactor and Core versions).
    -  Log Library will now try to create the **log_path** directory if it doesn't exist.
    -  Added support for HTTP-Only cookies with new config option *cookie_httponly* (default FALSE).
-   -  Renamed method ``_call_hook()`` to ``call_hook()`` in the :doc:`Hooks Library <general/hooks>`.
    -  ``$config['time_reference']`` now supports all timezone strings supported by PHP.
    -  Fatal PHP errors are now also passed to ``_exception_handler()``, so they can be logged.
 
-- 
cgit v1.2.3-24-g4f1b


From 5ac428bea999a332b46b17fe26ee0045e5cfd39c Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Wed, 8 Jan 2014 16:07:31 +0200
Subject: Fix #148

CI_Input::_clean_input_data() assumed that all input data is URL-encoded while sanitizing it.
However, PHP already performs URL-decoding on it, so this is either redudant or overly
intrusive as it resulted in many, many reports of data containing '%' followed by 1 numeric
characters being essentially destroyed.

Supersedes PR #1229
---
 user_guide_src/source/changelog.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 49ca39502..af9dcb0e8 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -645,6 +645,7 @@ Bug fixes for 3.0
 -  Fixed a bug (#2268) - :doc:`Security Library <libraries/security>` didn't properly match JavaScript events.
 -  Fixed a bug (#2143) - :doc:`Form Validation Library <libraries/form_validation>` didn't check for rule groups named in a *controller/method* manner when trying to load from a config file.
 -  Fixed a bug (#2762) - :doc:`Hooks Class <general/hooks>` didn't properly check if the called class/function exists.
+-  Fixed a bug (#346) - while sanitizing input data, ``CI_Input::_clean_input_data()`` assumed that it is URL-encoded, stripping certain character sequences from it.
 
 Version 2.1.4
 =============
-- 
cgit v1.2.3-24-g4f1b


From fb614478990694c3622baee2d01b414638c26508 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Wed, 8 Jan 2014 16:09:05 +0200
Subject: [ci skip] Fix a wrong issue reference from the previous commit

---
 user_guide_src/source/changelog.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index af9dcb0e8..3fa27ffa8 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -645,7 +645,7 @@ Bug fixes for 3.0
 -  Fixed a bug (#2268) - :doc:`Security Library <libraries/security>` didn't properly match JavaScript events.
 -  Fixed a bug (#2143) - :doc:`Form Validation Library <libraries/form_validation>` didn't check for rule groups named in a *controller/method* manner when trying to load from a config file.
 -  Fixed a bug (#2762) - :doc:`Hooks Class <general/hooks>` didn't properly check if the called class/function exists.
--  Fixed a bug (#346) - while sanitizing input data, ``CI_Input::_clean_input_data()`` assumed that it is URL-encoded, stripping certain character sequences from it.
+-  Fixed a bug (#148) - while sanitizing input data, ``CI_Input::_clean_input_data()`` assumed that it is URL-encoded, stripping certain character sequences from it.
 
 Version 2.1.4
 =============
-- 
cgit v1.2.3-24-g4f1b


From 80a16b1cd0d4716b5ea41497685a8fac02e34333 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Wed, 8 Jan 2014 17:19:03 +0200
Subject: Fix #346

When ['global_xss_filtering'] was turned on, the , ,  &
superglobals were automatically overwritten. This resulted in one of the following problems:

 - xss_clean() being called twice
 - Inability to retrieve the original (not filtered) value

XSS filtering is now only applied on demand by the Input class, and the default value for
the  parameter in CI_Input methods is changed to NULL. Unless a boolean value is
passed to them, whether XSS filtering is applied depends on the ['global_xss_filtering']
value.
---
 user_guide_src/source/changelog.rst                |  2 +
 user_guide_src/source/installation/upgrade_300.rst | 45 ++++++++++++++++++----
 2 files changed, 40 insertions(+), 7 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 3fa27ffa8..85cd60293 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -402,6 +402,7 @@ Release Date: Not Released
       -  Changed method ``valid_ip()`` to use PHP's native ``filter_var()`` function.
       -  Changed internal method ``_sanitize_globals()`` to skip enforcing reversal of *register_globals* in PHP 5.4+, where this functionality no longer exists.
       -  Changed methods ``get()``, ``post()``, ``get_post()``, ``cookie()``, ``server()``, ``user_agent()`` to return NULL instead of FALSE when no value is found.
+      -  Changed default value of the ``$xss_clean`` parameter to NULL for all methods that utilize it, the default value is now determined by the ``$config['global_xss_filtering']`` setting.
       -  Added method ``post_get()`` and changed ``get_post()`` to search in GET data first. Both methods' names now properly match their GET/POST data search priorities.
       -  Changed method ``_fetch_from_array()`` to parse array notation in field name.
       -  Added an option for ``_clean_input_keys()`` to return FALSE instead of terminating the whole script.
@@ -646,6 +647,7 @@ Bug fixes for 3.0
 -  Fixed a bug (#2143) - :doc:`Form Validation Library <libraries/form_validation>` didn't check for rule groups named in a *controller/method* manner when trying to load from a config file.
 -  Fixed a bug (#2762) - :doc:`Hooks Class <general/hooks>` didn't properly check if the called class/function exists.
 -  Fixed a bug (#148) - while sanitizing input data, ``CI_Input::_clean_input_data()`` assumed that it is URL-encoded, stripping certain character sequences from it.
+-  Fixed a bug (#346) - with ``$config['global_xss_filtering']`` turned on, the ``$_GET``, ``$_POST``, ``$_COOKIE`` and ``$_SERVER`` superglobals were overwritten during initialization time, resulting in XSS filtering being either performed twice or there was no possible way to get the original data, even though options for this do exist.
 
 Version 2.1.4
 =============
diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst
index 41153df16..f0759a15e 100644
--- a/user_guide_src/source/installation/upgrade_300.rst
+++ b/user_guide_src/source/installation/upgrade_300.rst
@@ -188,8 +188,39 @@ Many methods and functions now return NULL instead of FALSE when the required it
    - element()
    - elements()
 
+*******************************
+Step 11: Usage of XSS filtering
+*******************************
+
+Many functions in CodeIgniter allow you to use its XSS filtering feature
+on demand by passing a boolean parameter. The default value of that
+parameter used to be boolean FALSE, but it is now changed to NULL and it
+will be dynamically determined by your ``$config['global_xss_filtering']``
+value.
+
+If you used to manually pass a boolean value for the ``$xss_filter``
+parameter or if you've always had ``$config['global_xss_filtering']`` set
+to FALSE, then this change doesn't concern you.
+
+Otherwise however, please review your usage of the following functions:
+
+ - :doc:`Input Library <../libraries/input>`
+
+   - input->get()
+   - input->post()
+   - input->get_post()
+   - input->cookie()
+   - input->server()
+   - input->input_stream()
+
+ - :doc:`Cookie Helper <../helpers/cookie_helper>` :func:`get_cookie()`
+
+.. important:: Another related change is that the ``$_GET``, ``$_POST``,
+	``$_COOKIE`` and ``$_SERVER`` superglobals are no longer
+	automatically overwritten when global XSS filtering is turned on.
+
 ********************************************************
-Step 11: Update usage of Input Class's get_post() method
+Step 12: Update usage of Input Class's get_post() method
 ********************************************************
 
 Previously, the :doc:`Input Class <../libraries/input>` method ``get_post()``
@@ -200,14 +231,14 @@ A method has been added, ``post_get()``, which searches in POST then in GET, as
 ``get_post()`` was doing before.
 
 ***********************************************************************
-Step 12: Update usage of Directory Helper's directory_map() function
+Step 13: Update usage of Directory Helper's directory_map() function
 ***********************************************************************
 
 In the resulting array, directories now end with a trailing directory
 separator (i.e. a slash, usually).
 
 *************************************************************
-Step 13: Update usage of Database Forge's drop_table() method
+Step 14: Update usage of Database Forge's drop_table() method
 *************************************************************
 
 Up until now, ``drop_table()`` added an IF EXISTS clause by default or it didn't work
@@ -229,7 +260,7 @@ If your application relies on IF EXISTS, you'll have to change its usage.
 	all drivers with the exception of ODBC.
 
 ***********************************************************
-Step 14: Change usage of Email library with multiple emails
+Step 15: Change usage of Email library with multiple emails
 ***********************************************************
 
 The :doc:`Email Library <../libraries/email>` will automatically clear the
@@ -244,7 +275,7 @@ pass FALSE as the first parameter in the ``send()`` method:
  	}
 
 ***************************************************
-Step 15: Update your Form_validation language lines
+Step 16: Update your Form_validation language lines
 ***************************************************
 
 Two improvements have been made to the :doc:`Form Validation Library
@@ -275,7 +306,7 @@ files and error messages format:
 	later.
 
 ****************************************************************
-Step 16: Remove usage of (previously) deprecated functionalities
+Step 17: Remove usage of (previously) deprecated functionalities
 ****************************************************************
 
 In addition to the ``$autoload['core']`` configuration setting, there's a
@@ -491,7 +522,7 @@ CodeIgniter 3.1+.
 	sooner rather than later.
 
 ***********************************************************
-Step 17: Check your usage of Text helper highlight_phrase()
+Step 18: Check your usage of Text helper highlight_phrase()
 ***********************************************************
 
 The default HTML tag used by :doc:`Text Helper <../helpers/text_helper>` function
-- 
cgit v1.2.3-24-g4f1b


From 88ebdf7ad98c2d24f9ba6b9839ab50c98cf0eb65 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Wed, 8 Jan 2014 17:28:02 +0200
Subject: [ci skip] Update the Input library and Cookie helper docs

 default value is now NULL
---
 user_guide_src/source/helpers/cookie_helper.rst |  2 +-
 user_guide_src/source/libraries/input.rst       | 19 ++++++++++---------
 2 files changed, 11 insertions(+), 10 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/helpers/cookie_helper.rst b/user_guide_src/source/helpers/cookie_helper.rst
index 2e8db5f31..3b594170d 100644
--- a/user_guide_src/source/helpers/cookie_helper.rst
+++ b/user_guide_src/source/helpers/cookie_helper.rst
@@ -43,7 +43,7 @@ The following functions are available:
 	``CI_Input::set_cookie()``.
 
 
-.. function:: get_cookie($index[, $xss_clean = FALSE]])
+.. function:: get_cookie($index[, $xss_clean = NULL]])
 
 	:param string $index: Cookie name
 	:param bool $xss_clean: Whether to apply XSS filtering to the returned value
diff --git a/user_guide_src/source/libraries/input.rst b/user_guide_src/source/libraries/input.rst
index 39a0d0628..4d8fdaf15 100644
--- a/user_guide_src/source/libraries/input.rst
+++ b/user_guide_src/source/libraries/input.rst
@@ -105,7 +105,7 @@ Class Reference
 
 .. class:: CI_Input
 
-	.. method:: post([$index = NULL[, $xss_clean = FALSE]])
+	.. method:: post([$index = NULL[, $xss_clean = NULL]])
 
 		:param string $index: POST parameter name
 		:param bool $xss_clean: Whether to apply XSS filtering
@@ -120,7 +120,8 @@ Class Reference
 		does not exist.
 
 		The second optional parameter lets you run the data through the XSS
-		filter. It's enabled by setting the second parameter to boolean TRUE.
+		filter. It's enabled by setting the second parameter to boolean TRUE
+		or by setting your ``$config['global_xss_filtering']`` to TRUE.
 		::
 
 			$this->input->post('some_data', TRUE);
@@ -132,9 +133,9 @@ Class Reference
 		::
 
 			$this->input->post(NULL, TRUE); // returns all POST items with XSS filter
-			$this->input->post(); // returns all POST items without XSS filter
+			$this->input->post(NULL, FALSE); // returns all POST items without XSS filter
 
-	.. method:: get([$index = NULL[, $xss_clean = FALSE]])
+	.. method:: get([$index = NULL[, $xss_clean = NULL]])
 
 		:param string $index: GET parameter name
 		:param bool $xss_clean: Whether to apply XSS filtering
@@ -152,9 +153,9 @@ Class Reference
 		::
 
 			$this->input->get(NULL, TRUE); // returns all GET items with XSS filter
-			$this->input->get(); // returns all GET items without XSS filtering
+			$this->input->get(NULL, FALSE); // returns all GET items without XSS filtering
 
-	.. method:: get_post([$index = ''[, $xss_clean = FALSE]])
+	.. method:: get_post([$index = ''[, $xss_clean = NULL]])
 
 		:param string $index: GET/POST parameter name
 		:param bool $xss_clean: Whether to apply XSS filtering
@@ -166,7 +167,7 @@ Class Reference
 
 			$this->input->get_post('some_data', TRUE);
 
-	.. method:: cookie([$index = ''[, $xss_clean = FALSE]])
+	.. method:: cookie([$index = ''[, $xss_clean = NULL]])
 
 		:param string $index: COOKIE parameter name
 		:param bool $xss_clean: Whether to apply XSS filtering
@@ -178,7 +179,7 @@ Class Reference
 			$this->input->cookie('some_cookie');
 			$this->input->cookie('some_cookie, TRUE); // with XSS filter
 
-	.. method:: server([$index = ''[, $xss_clean = FALSE]])
+	.. method:: server([$index = ''[, $xss_clean = NULL]])
 
 		:param string $index: Value name
 		:param bool $xss_clean: Whether to apply XSS filtering
@@ -189,7 +190,7 @@ Class Reference
 
 			$this->input->server('some_data');
 
-	.. method:: input_stream([$index = ''[, $xss_clean = FALSE]])
+	.. method:: input_stream([$index = ''[, $xss_clean = NULL]])
 
 		:param string $index: Key name
 		:param bool $xss_clean: Whether to apply XSS filtering
-- 
cgit v1.2.3-24-g4f1b


From bfb635b276d880336db795f1a603de66ccfc80f6 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Wed, 8 Jan 2014 18:32:05 +0200
Subject: Make newline standardization configurable

Added ['standardize_newlines']

Also altered the Session cookie driver, which experienced issues with this
feature due to it's HMAC verification failing after the Input class alters
newlines in non-encrypted session cookies.

Supersedes PR #2470
---
 user_guide_src/source/changelog.rst       | 1 +
 user_guide_src/source/libraries/input.rst | 3 ++-
 2 files changed, 3 insertions(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 85cd60293..906c303a4 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -58,6 +58,7 @@ Release Date: Not Released
    -  Added support non-HTML error templates for CLI applications.
    -  Added availability checks where usage of dangerous functions like ``eval()`` and ``exec()`` is required.
    -  Added support for changing the file extension of log files using ``$config['log_file_extension']``.
+   -  Added support for turning newline standardization on/off via ``$config['standardize_newlines']``.
 
 -  Helpers
 
diff --git a/user_guide_src/source/libraries/input.rst b/user_guide_src/source/libraries/input.rst
index b58ed2f0d..72746c147 100644
--- a/user_guide_src/source/libraries/input.rst
+++ b/user_guide_src/source/libraries/input.rst
@@ -25,7 +25,8 @@ following:
    (and a few other) characters.
 -  Provides XSS (Cross-site Scripting Hacks) filtering. This can be
    enabled globally, or upon request.
--  Standardizes newline characters to \\n(In Windows \\r\\n)
+-  Standardizes newline characters to ``PHP_EOL`` (\\n in UNIX-based OSes,
+   \\r\\n under Windows). This is configurable.
 
 XSS Filtering
 =============
-- 
cgit v1.2.3-24-g4f1b


From 50a9d863dd56a3667d8dfb4b8c66d8035bb26956 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Wed, 8 Jan 2014 18:53:58 +0200
Subject: Deprecate the 'mysql', 'sqlite', 'mssql' and 'pdo/dblib' drivers

The 'mysql' PHP extension is notorious for it's problems and is deprecated as of PHP 5.5.

The other ones are dropped from PHP 5.3.
---
 user_guide_src/source/changelog.rst                |  2 ++
 user_guide_src/source/installation/upgrade_300.rst | 20 ++++++++++++++++++++
 2 files changed, 22 insertions(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 906c303a4..5b0187350 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -20,6 +20,7 @@ Release Date: Not Released
 
    -  PHP 5.1.6 is no longer supported. CodeIgniter now requires PHP 5.2.4.
    -  Changed filenaming convention (class file names now must be Ucfirst and everything else in lowercase).
+   -  Changed the default database driver to 'mysqli' (the old 'mysql' driver is DEPRECATED).
    -  ``$_SERVER['CI_ENV']`` can now be set to control the ``ENVIRONMENT`` constant.
    -  Added an optional backtrace to php-error template.
    -  Added Android to the list of user agents.
@@ -139,6 +140,7 @@ Release Date: Not Released
 
 -  Database
 
+   -  DEPRECATED the 'mysql', 'sqlite', 'mssql' and 'pdo/dblib' (also known as 'pdo/mssql' or 'pdo/sybase') drivers.
    -  Added **dsn** configuration setting for drivers that support DSN strings (PDO, PostgreSQL, Oracle, ODBC, CUBRID).
    -  Added **schema** configuration setting (defaults to *public*) for drivers that might need it (currently used by PostgreSQL and ODBC).
    -  Added subdrivers support (currently only used by PDO).
diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst
index f0759a15e..ca7569b57 100644
--- a/user_guide_src/source/installation/upgrade_300.rst
+++ b/user_guide_src/source/installation/upgrade_300.rst
@@ -333,6 +333,26 @@ Smiley helper js_insert_smiley()
 :doc:`Smiley Helper <../helpers/smiley_helper>` function ``js_insert_smiley()`` has been deprecated
 since CodeIgniter 1.7.2 and is now removed. You'll need to switch to ``smiley_js()`` instead.
 
+Database drivers 'mysql', 'sqlite', 'mssql', 'pdo/dblib'
+========================================================
+
+The **mysql** driver utilizes the old 'mysql' PHP extension, known for its aging code base and
+many low-level problems. The extension is deprecated as of PHP 5.5 and CodeIgniter deprecates
+it in version 3.0, switching the default configured MySQL driver to **mysqli**.
+
+Please use either the 'mysqli' or 'pdo/mysql' drivers for MySQL. The old 'mysql' driver will be
+removed at some point in the future.
+
+The **sqlite**, **mssql** and **pdo/dblib** (also known as pdo/mssql or pdo/sybase) drivers
+all depend on PHP extensions that for different reasons no longer exist since PHP 5.3.
+
+Therefore we are now deprecating these drivers as we will have to remove them in one of the next
+CodeIgniter versions. You should use the more advanced, **sqlite3**, **sqlsrv** or **pdo/sqlsrv**
+drivers respectively.
+
+.. note:: These drivers are still available, but you're strongly encouraged to switch to other ones
+	sooner rather than later.
+
 Security helper do_hash()
 =========================
 
-- 
cgit v1.2.3-24-g4f1b


From 7977e1d4859d48be00bb11250446d9abeff6ac35 Mon Sep 17 00:00:00 2001
From: Marcos SF Filho <sffmarcos142009z@gmail.com>
Date: Wed, 8 Jan 2014 15:34:11 -0200
Subject: Update the Calendar Class

---
 user_guide_src/source/changelog.rst | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 3fa27ffa8..5da0330e5 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -184,7 +184,7 @@ Release Date: Not Released
       - Server version checking is now done via ``mysqli::$server_info`` instead of running an SQL query.
       - Added persistent connections support for PHP >= 5.3.
       - Added support for ``backup()`` in :doc:`Database Utilities <database/utilities>`.
-      - Changed methods ``trans_begin()``, ``trans_commit()`` and ``trans_rollback()`` to use the PHP API instead of sending queries.	
+      - Changed methods ``trans_begin()``, ``trans_commit()`` and ``trans_rollback()`` to use the PHP API instead of sending queries.
 
    -  Improved support of the PDO driver, including:
 
@@ -278,6 +278,11 @@ Release Date: Not Released
       -  Added **file_ext_tolower** config setting.
       -  Added **mod_mime_fix** option to disable suffixing multiple file extensions with an underscore.
 
+   -  :doc:`Calendar library <libraries/calendar>` changes include:
+
+      -  Add configuration to generate days of other months instead of blank cells
+      -  Auto set the *next_prev_url* if is empty and the *show_prev_next* is set to TRUE
+
    -  :doc:`Cart library <libraries/cart>` changes include:
 
       -  ``insert()`` now auto-increments quantity for an item when inserted twice instead of resetting it, this is the default behaviour of large e-commerce sites.
-- 
cgit v1.2.3-24-g4f1b


From 42b40006fe8b740b416a8e8fd9acb0666349e222 Mon Sep 17 00:00:00 2001
From: Ahmedul Haque Abid <a_h_abid@hotmail.com>
Date: Thu, 9 Jan 2014 01:10:25 +0600
Subject: Added custom error messages functionality for individual fields.

---
 user_guide_src/source/changelog.rst                |  1 +
 .../source/libraries/form_validation.rst           | 27 ++++++++++++++++++----
 2 files changed, 23 insertions(+), 5 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 5b0187350..9e7849643 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -314,6 +314,7 @@ Release Date: Not Released
       -  Added support for named parameters in error messages.
       -  :doc:`Language <libraries/language>` line keys must now be prefixed with **form_validation_**.
       -  Added rule **alpha_numeric_spaces**.
+      -  Added custom error messages for individual fields on any rules.
 
    -  :doc:`Caching Library <libraries/caching>` changes include:
 
diff --git a/user_guide_src/source/libraries/form_validation.rst b/user_guide_src/source/libraries/form_validation.rst
index 8534175bb..f70877c02 100644
--- a/user_guide_src/source/libraries/form_validation.rst
+++ b/user_guide_src/source/libraries/form_validation.rst
@@ -200,6 +200,7 @@ The above method takes **three** parameters as input:
    message. For example, if your field is named "user" you might give it
    a human name of "Username".
 #. The validation rules for this form field.
+#. (optional) Set custom error messages on any rules given for current field. If not provided will use the default one.
 
 .. note:: If you would like the field name to be stored in a language
 	file, please see :ref:`translating-field-names`.
@@ -225,7 +226,9 @@ Your controller should now look like this::
 			$this->load->library('form_validation');
 
 			$this->form_validation->set_rules('username', 'Username', 'required');
-			$this->form_validation->set_rules('password', 'Password', 'required');
+			$this->form_validation->set_rules('password', 'Password', 'required',array(
+				'required'=>'You must provide a %s.'
+			));
 			$this->form_validation->set_rules('passconf', 'Password Confirmation', 'required');
 			$this->form_validation->set_rules('email', 'Email', 'required');
 
@@ -263,7 +266,10 @@ you use this approach, you must name your array keys as indicated::
 		array(
 			'field' => 'password',
 			'label' => 'Password',
-			'rules' => 'required'
+			'rules' => 'required',
+			'error_msg' => array(
+				'required' => 'You must provide a %s.',
+			),
 		),
 		array(
 			'field' => 'passconf',
@@ -285,7 +291,10 @@ Cascading Rules
 CodeIgniter lets you pipe multiple rules together. Let's try it. Change
 your rules in the third parameter of rule setting method, like this::
 
-	$this->form_validation->set_rules('username', 'Username', 'required|min_length[5]|max_length[12]|is_unique[users.username]');
+	$this->form_validation->set_rules('username', 'Username', 'required|min_length[5]|max_length[12]|is_unique[users.username]',array(
+		'required' => 'You have not provided %s.',
+		'is_unique' => 'The %s is unavailable.',
+	));
 	$this->form_validation->set_rules('password', 'Password', 'required');
 	$this->form_validation->set_rules('passconf', 'Password Confirmation', 'required|matches[password]');
 	$this->form_validation->set_rules('email', 'Email', 'required|valid_email|is_unique[users.email]');
@@ -469,11 +478,18 @@ Setting Error Messages
 All of the native error messages are located in the following language
 file: **system/language/english/form_validation_lang.php**
 
-To set your own custom message you can either edit that file, or use the
-following method::
+To set your own global custom message for a rule, you can either 
+edit that file, or use the following method::
 
 	$this->form_validation->set_message('rule', 'Error Message');
 
+If you need to set a custom error message for a particular field on 
+some particular rule, use the set_rules() methos::
+
+	$this->form_validation->set_rules('field_name','Field Label','rule1|rule2|rule3',array(
+		'rule2'	=> 'Error Message on rule2 for this field_name'
+	));
+
 Where rule corresponds to the name of a particular rule, and Error
 Message is the text you would like displayed.
 
@@ -946,6 +962,7 @@ $this->form_validation->set_rules()
 		:param string $field: The field name
 		:param string $label: The field label
 		:param mixed $rules: The rules, as a string with rules separated by a pipe "|", or an array or rules.
+		:param array $error_msg: Custom error message on any rules for the current field only. (optional)
 		:rtype: Object
 
 		Permits you to set validation rules, as described in the tutorial
-- 
cgit v1.2.3-24-g4f1b


From a593e3eb218002a630b7d0cf90002ec4a6fd1db3 Mon Sep 17 00:00:00 2001
From: Marcos SF Filho <sffmarcos142009z@gmail.com>
Date: Wed, 8 Jan 2014 18:22:12 -0200
Subject: Code Corrections for the Calendar Pull Request

---
 user_guide_src/source/changelog.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 5da0330e5..ff7c09b48 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -280,8 +280,8 @@ Release Date: Not Released
 
    -  :doc:`Calendar library <libraries/calendar>` changes include:
 
-      -  Add configuration to generate days of other months instead of blank cells
-      -  Auto set the *next_prev_url* if is empty and the *show_prev_next* is set to TRUE
+      -  Added configuration to generate days of other months instead of blank cells.
+      -  Auto set *next_prev_url* if it is empty and *show_prev_next* is set to TRUE.
 
    -  :doc:`Cart library <libraries/cart>` changes include:
 
-- 
cgit v1.2.3-24-g4f1b


From 0cd7c92ee59b4b03588e45229944d4b83eea3d8e Mon Sep 17 00:00:00 2001
From: Marcos SF Filho <sffmarcos142009z@gmail.com>
Date: Wed, 8 Jan 2014 19:38:00 -0200
Subject: Unnecessary rtrim and update docs for Calendar class

---
 user_guide_src/source/libraries/calendar.rst | 41 +++++++++++++++++-----------
 1 file changed, 25 insertions(+), 16 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/calendar.rst b/user_guide_src/source/libraries/calendar.rst
index 3964db25e..8b2f503b9 100644
--- a/user_guide_src/source/libraries/calendar.rst
+++ b/user_guide_src/source/libraries/calendar.rst
@@ -86,21 +86,23 @@ The above code would start the calendar on saturday, use the "long"
 month heading, and the "short" day names. More information regarding
 preferences below.
 
-======================  ===========  ===============================================  ===================================================================
-Preference              Default		Options						Description                                                    
-======================  ===========  ===============================================  ===================================================================
-**template**           	None		None                                         	A string containing your calendar template.
-											See the template section below.
-**local_time**        	time()		None						A Unix timestamp corresponding to the current time.
-**start_day**         	sunday		Any week day (sunday, monday, tuesday, etc.) 	Sets the day of the week the calendar should start on.
-**month_type**        	long          	long, short                                   	Determines what version of the month name to use in the header.
-											long = January, short = Jan.
-**day_type**		abr		long, short, abr 				Determines what version of the weekday names to use in 
-											the column headers. long = Sunday, short = Sun, abr = Su.
-**show_next_prev**	FALSE		TRUE/FALSE (boolean)				Determines whether to display links allowing you to toggle
-											to next/previous months. See information on this feature below.
-**next_prev_url**     	None     	  A URL						Sets the basepath used in the next/previous calendar links.
-======================  ===========  ===============================================  ===================================================================
+======================  ==============  ===============================================  ===================================================================
+Preference              Default         Options                                          Description
+======================  ==============  ===============================================  ===================================================================
+**template**           	None            None                                             A string containing your calendar template.
+                                                                                         See the template section below.
+**local_time**        	time()          None                                             A Unix timestamp corresponding to the current time.
+**start_day**           sunday          Any week day (sunday, monday, tuesday, etc.)     Sets the day of the week the calendar should start on.
+**month_type**          long            long, short                                      Determines what version of the month name to use in the header.
+                                                                                         long = January, short = Jan.
+**day_type**            abr             long, short, abr                                 Determines what version of the weekday names to use in
+                                                                                         the column headers. long = Sunday, short = Sun, abr = Su.
+**show_next_prev**      FALSE           TRUE/FALSE (boolean)                             Determines whether to display links allowing you to toggle
+                                                                                         to next/previous months. See information on this feature below.
+**next_prev_url**       Controller URL  A URL                                            Sets the basepath used in the next/previous calendar links.
+**show_other_days**     FALSE           TRUE/FALSE (boolean)                             Determines whether to display days of other months that shares the
+                                                                                         first or last week of the calendar month.
+======================  ==============  ===============================================  ===================================================================
 
 
 Showing Next/Previous Month Links
@@ -123,7 +125,8 @@ You'll notice a few things about the above example:
 
 -  You must set the "show_next_prev" to TRUE.
 -  You must supply the URL to the controller containing your calendar in
-   the "next_prev_url" preference.
+   the "next_prev_url" preference. The Code Igniter will try to guess
+   the link for the current controller/method if you don't supply.
 -  You must supply the "year" and "month" to the calendar generating
    function via the URI segments where they appear (Note: The calendar
    class automatically adds the year/month to the base URL you
@@ -154,6 +157,8 @@ pair of pseudo-variables as shown here::
 
 	   {cal_row_start}<tr>{/cal_row_start}
 	   {cal_cell_start}<td>{/cal_cell_start}
+	   {cal_cell_start_today}<td>{/cal_cell_start_today}
+	   {cal_cell_start_other}<td class="other-month">{/cal_cell_start_other}
 
 	   {cal_cell_content}<a href="{content}">{day}</a>{/cal_cell_content}
 	   {cal_cell_content_today}<div class="highlight"><a href="{content}">{day}</a></div>{/cal_cell_content_today}
@@ -163,7 +168,11 @@ pair of pseudo-variables as shown here::
 
 	   {cal_cell_blank}&nbsp;{/cal_cell_blank}
 
+	   {cal_cell_other}{day}{cal_cel_other}
+
 	   {cal_cell_end}</td>{/cal_cell_end}
+	   {cal_cell_end_today}</td>{/cal_cell_end_today}
+	   {cal_cell_end_other}</td>{/cal_cell_end_other}
 	   {cal_row_end}</tr>{/cal_row_end}
 
 	   {table_close}</table>{/table_close}
-- 
cgit v1.2.3-24-g4f1b


From 10925d27adac84634cc527d7298b1add0d54ba7c Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Thu, 9 Jan 2014 00:16:46 +0200
Subject: Remove preg_quote() call from CI_User_agent::_set_browser() and add
 another pattern for Opera

Input comes from a configuration file that is barely touched by anyone
and the default values only contain letters, so it is safe to not
quote them.

This enables us to add a more advanced pattern in config/user_agents.php
for Opera 10+, which ... quote:

  Opera/9.80 is hard coded at the beginning of the user agent string because of broken browser sniffing scripts which detect 'Opera/10' and above as Opera 1.

(reference: http://my.opera.com/community/openweb/idopera/)

Instead, latests versions of Opera append ' Version/<version number>'
to the end of the user agent string.

Fixes issue #555 (incorrect browser detection for Opera)
---
 user_guide_src/source/changelog.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 5b0187350..67a2685da 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -651,6 +651,7 @@ Bug fixes for 3.0
 -  Fixed a bug (#2762) - :doc:`Hooks Class <general/hooks>` didn't properly check if the called class/function exists.
 -  Fixed a bug (#148) - while sanitizing input data, ``CI_Input::_clean_input_data()`` assumed that it is URL-encoded, stripping certain character sequences from it.
 -  Fixed a bug (#346) - with ``$config['global_xss_filtering']`` turned on, the ``$_GET``, ``$_POST``, ``$_COOKIE`` and ``$_SERVER`` superglobals were overwritten during initialization time, resulting in XSS filtering being either performed twice or there was no possible way to get the original data, even though options for this do exist.
+-  Fixed an edge case (#555) - incorrect browser version was reported for Opera 10+ due to a non-standard user-agent string.
 
 Version 2.1.4
 =============
-- 
cgit v1.2.3-24-g4f1b


From 27e91a07ed66308ba02833b104ca8ca6a05e7be8 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Thu, 9 Jan 2014 01:00:48 +0200
Subject: Add CI_User_agent::parse() to allow parsing a custom user-agent
 string

Based on PR #970
---
 user_guide_src/source/changelog.rst | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 67a2685da..cbc1c6656 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -369,7 +369,11 @@ Release Date: Not Released
       -  Added the ability to use a proxy.
       -  Added Basic HTTP authentication support.
 
-   -  :doc:`User Agent Library <libraries/user_agent>` will now check if robots are pretending to be mobile clients (helps with e.g. Google indexing mobile website versions).
+   -  :doc:`User Agent Library <libraries/user_agent>` changes include:
+
+      - Added check to detect if robots are pretending to be mobile clients (helps with e.g. Google indexing mobile website versions).
+      - Added method ``parse()`` to allow parsing a custom user-agent string, different from the current visitor's.
+
    -  Added support for setting :doc:`Table <libraries/table>` class defaults in a config file.
    -  :doc:`Zip Library <libraries/zip>` method ``read_file()`` can now also alter the original file path/name while adding files to an archive.
 
-- 
cgit v1.2.3-24-g4f1b


From 1f811c3b7e6bf43b329f0f2ccdbe700c6454eac9 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Thu, 9 Jan 2014 01:02:38 +0200
Subject: Add documentation for CI_User_agent::parse()

---
 user_guide_src/source/libraries/user_agent.rst | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/user_agent.rst b/user_guide_src/source/libraries/user_agent.rst
index 9f9676828..af76cfa6e 100644
--- a/user_guide_src/source/libraries/user_agent.rst
+++ b/user_guide_src/source/libraries/user_agent.rst
@@ -223,4 +223,11 @@ Class Reference
 
 		:returns: array
 
-		Returns an array of character sets accepted by the user agent.
\ No newline at end of file
+		Returns an array of character sets accepted by the user agent.
+
+	.. method:: parse($string)
+
+		:param string $string: A custom user-agent string
+		:returns: void
+
+		Parses a custom user-agent string, different from the one reported by the current visitor.
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 0742fad5cb283693bf1ef0a63aa90bb6cb2927d8 Mon Sep 17 00:00:00 2001
From: Ahmedul Haque Abid <a_h_abid@hotmail.com>
Date: Thu, 9 Jan 2014 07:51:10 +0600
Subject: Changed $error_msg to $errors

---
 user_guide_src/source/libraries/form_validation.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/form_validation.rst b/user_guide_src/source/libraries/form_validation.rst
index f70877c02..671f97992 100644
--- a/user_guide_src/source/libraries/form_validation.rst
+++ b/user_guide_src/source/libraries/form_validation.rst
@@ -957,12 +957,12 @@ The following methods are intended for use in your controller.
 $this->form_validation->set_rules()
 ===================================
 
-	.. php:method:: set_rules ($field, $label = '', $rules = '')
+	.. php:method:: set_rules ($field, $label = '', $rules = '', $errors = array())
 
 		:param string $field: The field name
 		:param string $label: The field label
 		:param mixed $rules: The rules, as a string with rules separated by a pipe "|", or an array or rules.
-		:param array $error_msg: Custom error message on any rules for the current field only. (optional)
+		:param array $errors: Custom error message
 		:rtype: Object
 
 		Permits you to set validation rules, as described in the tutorial
-- 
cgit v1.2.3-24-g4f1b


From a0bf8295b90302f498a9c1b94a80b50ec635f85c Mon Sep 17 00:00:00 2001
From: Ahmedul Haque Abid <a_h_abid@hotmail.com>
Date: Thu, 9 Jan 2014 07:55:52 +0600
Subject: Updated change log message for form validation custrom errors.

---
 user_guide_src/source/changelog.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 9e7849643..37e568c4c 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -314,7 +314,7 @@ Release Date: Not Released
       -  Added support for named parameters in error messages.
       -  :doc:`Language <libraries/language>` line keys must now be prefixed with **form_validation_**.
       -  Added rule **alpha_numeric_spaces**.
-      -  Added custom error messages for individual fields on any rules.
+      -  Added **support** for custom error messages **per field rule**.
 
    -  :doc:`Caching Library <libraries/caching>` changes include:
 
-- 
cgit v1.2.3-24-g4f1b


From df3bda56796ae27f98cd6b9fe5c7d9d3bcb756ac Mon Sep 17 00:00:00 2001
From: Ahmedul Haque Abid <a_h_abid@hotmail.com>
Date: Thu, 9 Jan 2014 08:10:21 +0600
Subject: Added spaces between parameters and fixed the arrays to be more
 readable.

---
 .../source/libraries/form_validation.rst           | 28 ++++++++++++----------
 1 file changed, 16 insertions(+), 12 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/form_validation.rst b/user_guide_src/source/libraries/form_validation.rst
index 671f97992..00f7c4125 100644
--- a/user_guide_src/source/libraries/form_validation.rst
+++ b/user_guide_src/source/libraries/form_validation.rst
@@ -226,9 +226,9 @@ Your controller should now look like this::
 			$this->load->library('form_validation');
 
 			$this->form_validation->set_rules('username', 'Username', 'required');
-			$this->form_validation->set_rules('password', 'Password', 'required',array(
-				'required'=>'You must provide a %s.'
-			));
+			$this->form_validation->set_rules('password', 'Password', 'required',
+				array('required'=>'You must provide a %s.')
+			);
 			$this->form_validation->set_rules('passconf', 'Password Confirmation', 'required');
 			$this->form_validation->set_rules('email', 'Email', 'required');
 
@@ -291,10 +291,14 @@ Cascading Rules
 CodeIgniter lets you pipe multiple rules together. Let's try it. Change
 your rules in the third parameter of rule setting method, like this::
 
-	$this->form_validation->set_rules('username', 'Username', 'required|min_length[5]|max_length[12]|is_unique[users.username]',array(
-		'required' => 'You have not provided %s.',
-		'is_unique' => 'The %s is unavailable.',
-	));
+	$this->form_validation->set_rules(
+		'username', 'Username',
+		'required|min_length[5]|max_length[12]|is_unique[users.username]',
+		array(
+			'required'    => 'You have not provided %s.',
+			'is_unique'  => 'This %s already exists.'
+		)
+	);
 	$this->form_validation->set_rules('password', 'Password', 'required');
 	$this->form_validation->set_rules('passconf', 'Password Confirmation', 'required|matches[password]');
 	$this->form_validation->set_rules('email', 'Email', 'required|valid_email|is_unique[users.email]');
@@ -484,11 +488,11 @@ edit that file, or use the following method::
 	$this->form_validation->set_message('rule', 'Error Message');
 
 If you need to set a custom error message for a particular field on 
-some particular rule, use the set_rules() methos::
+some particular rule, use the set_rules() method::
 
-	$this->form_validation->set_rules('field_name','Field Label','rule1|rule2|rule3',array(
-		'rule2'	=> 'Error Message on rule2 for this field_name'
-	));
+	$this->form_validation->set_rules('field_name', 'Field Label', 'rule1|rule2|rule3',
+		array('rule2'	=> 'Error Message on rule2 for this field_name')
+	);
 
 Where rule corresponds to the name of a particular rule, and Error
 Message is the text you would like displayed.
@@ -962,7 +966,7 @@ $this->form_validation->set_rules()
 		:param string $field: The field name
 		:param string $label: The field label
 		:param mixed $rules: The rules, as a string with rules separated by a pipe "|", or an array or rules.
-		:param array $errors: Custom error message
+		:param array $errors: Custom error messages
 		:rtype: Object
 
 		Permits you to set validation rules, as described in the tutorial
-- 
cgit v1.2.3-24-g4f1b


From ea29488b99f28b32887f0cb1e939c5f34e418d0d Mon Sep 17 00:00:00 2001
From: Ahmedul Haque Abid <a_h_abid@hotmail.com>
Date: Thu, 9 Jan 2014 16:01:31 +0600
Subject: Changed the rest of 'error_msg' to 'errors'

---
 user_guide_src/source/libraries/form_validation.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/form_validation.rst b/user_guide_src/source/libraries/form_validation.rst
index 00f7c4125..3efdc862b 100644
--- a/user_guide_src/source/libraries/form_validation.rst
+++ b/user_guide_src/source/libraries/form_validation.rst
@@ -267,7 +267,7 @@ you use this approach, you must name your array keys as indicated::
 			'field' => 'password',
 			'label' => 'Password',
 			'rules' => 'required',
-			'error_msg' => array(
+			'errors' => array(
 				'required' => 'You must provide a %s.',
 			),
 		),
-- 
cgit v1.2.3-24-g4f1b


From e334118cef11e9565b9219587d1f45ab140c9bcd Mon Sep 17 00:00:00 2001
From: Ahmedul Haque Abid <a_h_abid@hotmail.com>
Date: Thu, 9 Jan 2014 16:10:10 +0600
Subject: Fixed coding styles in form_validation.rst

---
 user_guide_src/source/libraries/form_validation.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/form_validation.rst b/user_guide_src/source/libraries/form_validation.rst
index 3efdc862b..1076b1433 100644
--- a/user_guide_src/source/libraries/form_validation.rst
+++ b/user_guide_src/source/libraries/form_validation.rst
@@ -227,7 +227,7 @@ Your controller should now look like this::
 
 			$this->form_validation->set_rules('username', 'Username', 'required');
 			$this->form_validation->set_rules('password', 'Password', 'required',
-				array('required'=>'You must provide a %s.')
+				array('required' => 'You must provide a %s.')
 			);
 			$this->form_validation->set_rules('passconf', 'Password Confirmation', 'required');
 			$this->form_validation->set_rules('email', 'Email', 'required');
@@ -295,8 +295,8 @@ your rules in the third parameter of rule setting method, like this::
 		'username', 'Username',
 		'required|min_length[5]|max_length[12]|is_unique[users.username]',
 		array(
-			'required'    => 'You have not provided %s.',
-			'is_unique'  => 'This %s already exists.'
+			'required'	=> 'You have not provided %s.',
+			'is_unique'	=> 'This %s already exists.'
 		)
 	);
 	$this->form_validation->set_rules('password', 'Password', 'required');
-- 
cgit v1.2.3-24-g4f1b


From 7945d30c0c936a553311e7418d388acb4d3fb1af Mon Sep 17 00:00:00 2001
From: Ahmedul Haque Abid <a_h_abid@hotmail.com>
Date: Thu, 9 Jan 2014 16:50:23 +0600
Subject: Fixed the comment and array alignment.

---
 user_guide_src/source/changelog.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 314ae8ab0..22c6d8f02 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -314,7 +314,7 @@ Release Date: Not Released
       -  Added support for named parameters in error messages.
       -  :doc:`Language <libraries/language>` line keys must now be prefixed with **form_validation_**.
       -  Added rule **alpha_numeric_spaces**.
-      -  Added **support** for custom error messages **per field rule**.
+      -  Added support for custom error messages per field rule.
 
    -  :doc:`Caching Library <libraries/caching>` changes include:
 
-- 
cgit v1.2.3-24-g4f1b


From 2e914b7dc6acaf2938fac4c332ff682a033b93d7 Mon Sep 17 00:00:00 2001
From: Marcos SF Filho <sffmarcos142009z@gmail.com>
Date: Thu, 9 Jan 2014 09:20:55 -0200
Subject: Updates for the Calendar Pull Request

---
 user_guide_src/source/libraries/calendar.rst | 28 ++++++++++++++--------------
 1 file changed, 14 insertions(+), 14 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/calendar.rst b/user_guide_src/source/libraries/calendar.rst
index 8b2f503b9..e24ee80b8 100644
--- a/user_guide_src/source/libraries/calendar.rst
+++ b/user_guide_src/source/libraries/calendar.rst
@@ -86,23 +86,23 @@ The above code would start the calendar on saturday, use the "long"
 month heading, and the "short" day names. More information regarding
 preferences below.
 
-======================  ==============  ===============================================  ===================================================================
-Preference              Default         Options                                          Description
-======================  ==============  ===============================================  ===================================================================
-**template**           	None            None                                             A string containing your calendar template.
+======================  =================  ===============================================  ===================================================================
+Preference              Default            Options                                          Description
+======================  =================  ===============================================  ===================================================================
+**template**           	None               None                                             A string containing your calendar template.
                                                                                          See the template section below.
-**local_time**        	time()          None                                             A Unix timestamp corresponding to the current time.
-**start_day**           sunday          Any week day (sunday, monday, tuesday, etc.)     Sets the day of the week the calendar should start on.
-**month_type**          long            long, short                                      Determines what version of the month name to use in the header.
+**local_time**        	time()             None                                             A Unix timestamp corresponding to the current time.
+**start_day**           sunday             Any week day (sunday, monday, tuesday, etc.)     Sets the day of the week the calendar should start on.
+**month_type**          long               long, short                                      Determines what version of the month name to use in the header.
                                                                                          long = January, short = Jan.
-**day_type**            abr             long, short, abr                                 Determines what version of the weekday names to use in
+**day_type**            abr                long, short, abr                                 Determines what version of the weekday names to use in
                                                                                          the column headers. long = Sunday, short = Sun, abr = Su.
-**show_next_prev**      FALSE           TRUE/FALSE (boolean)                             Determines whether to display links allowing you to toggle
+**show_next_prev**      FALSE              TRUE/FALSE (boolean)                             Determines whether to display links allowing you to toggle
                                                                                          to next/previous months. See information on this feature below.
-**next_prev_url**       Controller URL  A URL                                            Sets the basepath used in the next/previous calendar links.
-**show_other_days**     FALSE           TRUE/FALSE (boolean)                             Determines whether to display days of other months that shares the
+**next_prev_url**       controller/method  A URL                                            Sets the basepath used in the next/previous calendar links.
+**show_other_days**     FALSE              TRUE/FALSE (boolean)                             Determines whether to display days of other months that share the
                                                                                          first or last week of the calendar month.
-======================  ==============  ===============================================  ===================================================================
+======================  =================  ===============================================  ===================================================================
 
 
 Showing Next/Previous Month Links
@@ -125,8 +125,8 @@ You'll notice a few things about the above example:
 
 -  You must set the "show_next_prev" to TRUE.
 -  You must supply the URL to the controller containing your calendar in
-   the "next_prev_url" preference. The Code Igniter will try to guess
-   the link for the current controller/method if you don't supply.
+   the "next_prev_url" preference. If you don't, it will be set to the current
+   *controller/method*.
 -  You must supply the "year" and "month" to the calendar generating
    function via the URI segments where they appear (Note: The calendar
    class automatically adds the year/month to the base URL you
-- 
cgit v1.2.3-24-g4f1b


From 40235e6890650690afeaa451738bf7f8e586cfc3 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Thu, 9 Jan 2014 14:20:57 +0200
Subject: Fix #133

---
 user_guide_src/source/changelog.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index c186781d1..40855bc68 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -662,6 +662,7 @@ Bug fixes for 3.0
 -  Fixed a bug (#148) - while sanitizing input data, ``CI_Input::_clean_input_data()`` assumed that it is URL-encoded, stripping certain character sequences from it.
 -  Fixed a bug (#346) - with ``$config['global_xss_filtering']`` turned on, the ``$_GET``, ``$_POST``, ``$_COOKIE`` and ``$_SERVER`` superglobals were overwritten during initialization time, resulting in XSS filtering being either performed twice or there was no possible way to get the original data, even though options for this do exist.
 -  Fixed an edge case (#555) - incorrect browser version was reported for Opera 10+ due to a non-standard user-agent string.
+-  Fixed a bug (#133) - :doc:`Text Helper <helpers/text_helper>` :func:`ascii_to_entities()` stripped the last character if it happens to be in the extended ASCII group.
 
 Version 2.1.4
 =============
-- 
cgit v1.2.3-24-g4f1b


From 43d7fa73534c07d10a88ec120c0938d0d00a184e Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Thu, 9 Jan 2014 17:29:45 +0200
Subject: Implement atomic increment/decrement in Cache library

Requested via issue #109
Supersedes PR #241
---
 user_guide_src/source/changelog.rst | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 40855bc68..b49ce20ba 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -281,12 +281,12 @@ Release Date: Not Released
       -  Added **file_ext_tolower** config setting.
       -  Added **mod_mime_fix** option to disable suffixing multiple file extensions with an underscore.
 
-   -  :doc:`Calendar library <libraries/calendar>` changes include:
+   -  :doc:`Calendar Library <libraries/calendar>` changes include:
 
       -  Added configuration to generate days of other months instead of blank cells.
       -  Auto set *next_prev_url* if it is empty and *show_prev_next* is set to TRUE.
 
-   -  :doc:`Cart library <libraries/cart>` changes include:
+   -  :doc:`Cart Library <libraries/cart>` changes include:
 
       -  ``insert()`` now auto-increments quantity for an item when inserted twice instead of resetting it, this is the default behaviour of large e-commerce sites.
       -  *Product Name* strictness can be disabled by switching the ``$product_name_safe`` property to FALSE.
@@ -294,7 +294,7 @@ Release Date: Not Released
       -  Added method ``get_item()`` to enable retrieving data for a single cart item.
       -  Added unicode support for product names.
 
-   -  :doc:`Image Manipulation library <libraries/image_lib>` changes include:
+   -  :doc:`Image Manipulation Library <libraries/image_lib>` changes include:
 
       -  The ``initialize()`` method now only sets existing class properties.
       -  Added support for 3-length hex color values for *wm_font_color* and *wm_shadow_color* properties, as well as validation for them.
@@ -303,7 +303,7 @@ Release Date: Not Released
       -  Property *maintain_ratio* is now taken into account when resizing images using ImageMagick library.
       -  Added support for maintaining transparency for PNG images in method ``text_watermark()``.
 
-   -  :doc:`Form Validation library <libraries/form_validation>` changes include:
+   -  :doc:`Form Validation Library <libraries/form_validation>` changes include:
 
       -  Added method ``error_array()`` to return all error messages as an array.
       -  Added method ``set_data()`` to set an alternative data array to be validated instead of the default ``$_POST``.
@@ -327,8 +327,10 @@ Release Date: Not Released
       -  Added Redis driver.
       -  Added a *key_prefix* option for cache IDs.
       -  Updated driver ``is_supported()`` methods to log at the "debug" level.
+      -  Added option to store raw values instead of CI-formatted ones (APC, Memcache).
+      -  Added atomic increment/decrement feature via ``increment()``, ``decrement()``.
 
-   -  :doc:`Email library <libraries/email>` changes include:
+   -  :doc:`Email Library <libraries/email>` changes include:
 
       -  Added custom filename to ``Email::attach()`` as ``$this->email->attach($filename, $disposition, $newname)``.
       -  Added possibility to send attachment as buffer string in ``Email::attach()`` as ``$this->email->attach($buffer, $disposition, $newname, $mime)``.
-- 
cgit v1.2.3-24-g4f1b


From d0bc7eb366610ad2e68d5921b363c665ccda1ff3 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Thu, 9 Jan 2014 17:37:06 +0200
Subject: Add documentation for raw data, increment(), decrement() in Cache
 library

Follows: 43d7fa73534c07d10a88ec120c0938d0d00a184e
---
 user_guide_src/source/libraries/caching.rst | 36 ++++++++++++++++++++++++++++-
 1 file changed, 35 insertions(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/caching.rst b/user_guide_src/source/libraries/caching.rst
index 709171dd3..5a9742378 100644
--- a/user_guide_src/source/libraries/caching.rst
+++ b/user_guide_src/source/libraries/caching.rst
@@ -84,11 +84,12 @@ Class Reference
 
 			$foo = $this->cache->get('my_cached_item');
 
-	.. method:: save($id, $data[, $ttl = 60])
+	.. method:: save($id, $data[, $ttl = 60[, $raw = FALSE]])
 
 		:param string $id: name of the cached item
 		:param mixed $data: the data to save
 		:param int $ttl: Time To Live, in seconds (default 60)
+		:param bool $raw: Whether to store the raw value
 		:returns: TRUE on success, FALSE on failure
 
 		This method will save an item to the cache store. If saving fails, the
@@ -97,6 +98,9 @@ Class Reference
 
 			$this->cache->save('cache_item_id', 'data_to_cache');
 
+		.. note:: The ``$raw`` parameter is only utilized by APC and Memcache,
+			in order to allow usage of ``increment()`` and ``decrement()``.
+
 	.. method:: delete($id)
 
 		:param string $id: name of cached item
@@ -108,6 +112,36 @@ Class Reference
 
 			$this->cache->delete('cache_item_id');
 
+	.. method:: increment($id[, $offset = 1])
+
+		:param string $id: Cache ID
+		:param int $offset: Step/value to add
+		:returns: New value on success, FALSE on failure
+
+		Performs atomic incrementation of a raw stored value.
+		::
+
+			// 'iterator' has a value of 2
+
+			$this->cache->increment('iterator'); // 'iterator' is now 3
+
+			$this->cache->increment('iterator', 3); // 'iterator' is now 6
+
+	.. method:: decrement($id[, $offset = 1])
+
+		:param string $id: Cache ID
+		:param int $offset: Step/value to reduce by
+		:returns: New value on success, FALSE on failure
+
+		Performs atomic decrementation of a raw stored value.
+		::
+
+			// 'iterator' has a value of 6
+
+			$this->cache->decrement('iterator'); // 'iterator' is now 5
+
+			$this->cache->decrement('iterator', 2); // 'iterator' is now 3
+
 	.. method:: clean()
 
 		:returns: TRUE if deleted, FALSE if the deletion fails
-- 
cgit v1.2.3-24-g4f1b


From 528591deb8f3a1b9663b43c66d75ba1a4059e8fe Mon Sep 17 00:00:00 2001
From: Connor Tumbleson <connor.tumbleson@gmail.com>
Date: Thu, 9 Jan 2014 10:04:43 -0600
Subject: fix doc warnings

---
 user_guide_src/source/changelog.rst                |  4 ++--
 user_guide_src/source/general/common_functions.rst |  6 +++---
 user_guide_src/source/libraries/calendar.rst       | 10 +++++-----
 3 files changed, 10 insertions(+), 10 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index b49ce20ba..e83598cb4 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -639,7 +639,7 @@ Bug fixes for 3.0
 -  Fixed a bug (#2380) - :doc:`URI Routing <general/routing>` method ``fetch_method()`` returned 'index' if the requested method name matches its controller name.
 -  Fixed a bug (#2388) - :doc:`Email Library <libraries/email>` used to ignore attachment errors, resulting in broken emails being sent.
 -  Fixed a bug (#2498) - :doc:`Form Validation Library <libraries/form_validation>` rule **valid_base64** only checked characters instead of actual validity.
--  Fixed a bug (#2425) - OCI8 :doc:`database <database>` driver's method ``stored_procedure()`` didn't log an error unless **db_debug** was set to TRUE.
+-  Fixed a bug (#2425) - OCI8 :doc:`database <database/index>` driver's method ``stored_procedure()`` didn't log an error unless **db_debug** was set to TRUE.
 -  Fixed a bug (#2490) - :doc:`Database Class <database/queries>` method ``query()`` returning boolean instead of a result object when the PostgreSQL-specific *RETURNING* clause is used.
 -  Fixed a bug (#249) - :doc:`Cache Library <libraries/caching>` didn't properly handle Memcache(d) configurations with missing options.
 -  Fixed a bug (#180) - :php:func:`config_item()` didn't take into account run-time configuration changes.
@@ -656,7 +656,7 @@ Bug fixes for 3.0
 -  Fixed a bug (#2515) - ``_exception_handler()`` used to send the 200 "OK" HTTP status code and didn't stop script exection even on fatal errors.
 -  Fixed a bug - Redis :doc:`Caching <libraries/caching>` driver didn't handle connection failures properly.
 -  Fixed a bug (#2756) - :doc:`Database Class <database/index>` executed the MySQL-specific `SET SESSION sql_mode` query for all drivers when the 'stricton' option is set.
--  Fixed a bug (#2579) - :doc:`Query Builder <database/query_builder>`s "no escape" functionality didn't work properly with query cache.
+-  Fixed a bug (#2579) - :doc:`Query Builder <database/query_builder>` "no escape" functionality didn't work properly with query cache.
 -  Fixed a bug (#2237) - :doc:`Parser Library <libraries/parser>` failed if the same tag pair is used more than once within a template.
 -  Fixed a bug (#2268) - :doc:`Security Library <libraries/security>` didn't properly match JavaScript events.
 -  Fixed a bug (#2143) - :doc:`Form Validation Library <libraries/form_validation>` didn't check for rule groups named in a *controller/method* manner when trying to load from a config file.
diff --git a/user_guide_src/source/general/common_functions.rst b/user_guide_src/source/general/common_functions.rst
index 2dfec9cc0..e9259795f 100644
--- a/user_guide_src/source/general/common_functions.rst
+++ b/user_guide_src/source/general/common_functions.rst
@@ -71,7 +71,7 @@ documentation for more information.
 show_error()
 ============
 
-.. php:function:: show_error($message, $status_code, $heading = 'An Error Was Encountered')
+.. php:function:: show_error($message, $status_code, $heading = 'An Error Was Encountered') :noindex:
 
 	:param	mixed	$message: Error message
 	:param	int	$status_code: HTTP Response status code
@@ -84,7 +84,7 @@ please see the :doc:`Error Handling <errors>` documentation.
 show_404()
 ==========
 
-.. php:function:: show_404($page = '', $log_error = TRUE)
+.. php:function:: show_404($page = '', $log_error = TRUE) :noindex:
 
 	:param	string	$page: URI string
 	:param	bool	$log_error: Whether to log the error
@@ -96,7 +96,7 @@ please see the :doc:`Error Handling <errors>` documentation.
 log_message()
 =============
 
-.. php:function:: log_message($level, $message)
+.. php:function:: log_message($level, $message) :noindex:
 
 	:param	string	$level: Log level: 'error', 'debug' or 'info'
 	:param	string	$message: Message to log
diff --git a/user_guide_src/source/libraries/calendar.rst b/user_guide_src/source/libraries/calendar.rst
index e24ee80b8..ed2a14c8c 100644
--- a/user_guide_src/source/libraries/calendar.rst
+++ b/user_guide_src/source/libraries/calendar.rst
@@ -90,18 +90,18 @@ preferences below.
 Preference              Default            Options                                          Description
 ======================  =================  ===============================================  ===================================================================
 **template**           	None               None                                             A string containing your calendar template.
-                                                                                         See the template section below.
+											      See the template section below.
 **local_time**        	time()             None                                             A Unix timestamp corresponding to the current time.
 **start_day**           sunday             Any week day (sunday, monday, tuesday, etc.)     Sets the day of the week the calendar should start on.
 **month_type**          long               long, short                                      Determines what version of the month name to use in the header.
-                                                                                         long = January, short = Jan.
+											      long = January, short = Jan.
 **day_type**            abr                long, short, abr                                 Determines what version of the weekday names to use in
-                                                                                         the column headers. long = Sunday, short = Sun, abr = Su.
+											      the column headers. long = Sunday, short = Sun, abr = Su.
 **show_next_prev**      FALSE              TRUE/FALSE (boolean)                             Determines whether to display links allowing you to toggle
-                                                                                         to next/previous months. See information on this feature below.
+											      to next/previous months. See information on this feature below.
 **next_prev_url**       controller/method  A URL                                            Sets the basepath used in the next/previous calendar links.
 **show_other_days**     FALSE              TRUE/FALSE (boolean)                             Determines whether to display days of other months that share the
-                                                                                         first or last week of the calendar month.
+											      first or last week of the calendar month.
 ======================  =================  ===============================================  ===================================================================
 
 
-- 
cgit v1.2.3-24-g4f1b


From 05be0879777021a73ca55548c6edd61d17012a4d Mon Sep 17 00:00:00 2001
From: Connor Tumbleson <connor.tumbleson@gmail.com>
Date: Thu, 9 Jan 2014 10:10:30 -0600
Subject: d'oh - :noindex: in wrong place

Signed-off-by: Connor Tumbleson <connor.tumbleson@gmail.com>
---
 user_guide_src/source/general/common_functions.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/general/common_functions.rst b/user_guide_src/source/general/common_functions.rst
index e9259795f..a1007cb4b 100644
--- a/user_guide_src/source/general/common_functions.rst
+++ b/user_guide_src/source/general/common_functions.rst
@@ -71,7 +71,7 @@ documentation for more information.
 show_error()
 ============
 
-.. php:function:: show_error($message, $status_code, $heading = 'An Error Was Encountered') :noindex:
+.. :noindex: php:function:: show_error($message, $status_code, $heading = 'An Error Was Encountered')
 
 	:param	mixed	$message: Error message
 	:param	int	$status_code: HTTP Response status code
@@ -84,7 +84,7 @@ please see the :doc:`Error Handling <errors>` documentation.
 show_404()
 ==========
 
-.. php:function:: show_404($page = '', $log_error = TRUE) :noindex:
+.. :noindex: php:function:: show_404($page = '', $log_error = TRUE)
 
 	:param	string	$page: URI string
 	:param	bool	$log_error: Whether to log the error
@@ -96,7 +96,7 @@ please see the :doc:`Error Handling <errors>` documentation.
 log_message()
 =============
 
-.. php:function:: log_message($level, $message) :noindex:
+.. :noindex: php:function:: log_message($level, $message)
 
 	:param	string	$level: Log level: 'error', 'debug' or 'info'
 	:param	string	$message: Message to log
-- 
cgit v1.2.3-24-g4f1b


From a0a73c977ce25911f56948d89de817b3ca83adcb Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Thu, 9 Jan 2014 19:21:26 +0200
Subject: Add HTTP response code 307 support in URL helper redirect()

---
 user_guide_src/source/changelog.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index e83598cb4..0488d9d4a 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -77,7 +77,7 @@ Release Date: Not Released
       - :php:func:`url_title()` will now trim extra dashes from beginning and end.
       - :php:func:`anchor_popup()` will now fill the *href* attribute with the URL and its JS code will return FALSE instead.
       - Added JS window name support to the :php:func:`anchor_popup()` function.
-      - Added support (auto-detection) for HTTP/1.1 response code 303 in :php:func:`redirect()`.
+      - Added support (auto-detection) for HTTP/1.1 response codes 303, 307 in :php:func:`redirect()`.
       - Changed :php:func:`redirect()` to choose the **refresh** method only on IIS servers, instead of all servers on Windows (when **auto** is used).
       - Changed :php:func:`anchor()`, :php:func:`anchor_popup()`, and :php:func:`redirect()` to support protocol-relative URLs (e.g. *//ellislab.com/codeigniter*).
 
-- 
cgit v1.2.3-24-g4f1b


From 300e3f04404e771de89351e410699e447759175a Mon Sep 17 00:00:00 2001
From: Petr Heralecky <petr@heralecky.cz>
Date: Fri, 10 Jan 2014 11:49:11 +0100
Subject: Added Email::attach_cid() returning CID

---
 user_guide_src/source/changelog.rst       |  2 ++
 user_guide_src/source/libraries/email.rst | 24 ++++++++++++++++++++++--
 2 files changed, 24 insertions(+), 2 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 0488d9d4a..e8dc880e8 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -334,6 +334,8 @@ Release Date: Not Released
 
       -  Added custom filename to ``Email::attach()`` as ``$this->email->attach($filename, $disposition, $newname)``.
       -  Added possibility to send attachment as buffer string in ``Email::attach()`` as ``$this->email->attach($buffer, $disposition, $newname, $mime)``.
+      -  Email attachments are creating in function Email::attach() - it's faster for sending many emails with same attachments
+      -  Added method Email::attach_cid() returning CID which enables to embed an attachment to html.
       -  Added dsn (delivery status notification) option.
       -  Renamed method _set_header() to set_header() and made it public to enable adding custom headers in the :doc:`Email Library <libraries/email>`.
       -  Successfully sent emails will automatically clear the parameters.
diff --git a/user_guide_src/source/libraries/email.rst b/user_guide_src/source/libraries/email.rst
index 39629ece1..90b71142b 100644
--- a/user_guide_src/source/libraries/email.rst
+++ b/user_guide_src/source/libraries/email.rst
@@ -247,8 +247,8 @@ $this->email->attach()
 ----------------------
 
 Enables you to send an attachment. Put the file path/name in the first
-parameter. Note: Use a file path, not a URL. For multiple attachments
-use the method multiple times. For example::
+parameter. For multiple attachments use the method multiple times.
+For example::
 
 	$this->email->attach('/path/to/photo1.jpg');
 	$this->email->attach('/path/to/photo2.jpg');
@@ -269,6 +269,26 @@ parameter as mime-type::
 
 	$this->email->attach($buffer, 'attachment', 'report.pdf', 'application/pdf');
 
+$this->email->attach_cid()
+ --------------------------
+ 
+ Returns CID which enables to embed an attachment to html. First parameter 
+ must be attached file.
+ 
+ ::
+ 
+   $filename = '/img/photo1.jpg';
+   $this->email->attach($filename);
+   foreach ($list as $address)
+   {
+     $this->email->to($address);
+     $cid = $this->email->attach_cid($filename);
+     $this->email->message('<img src='cid:". $cid ."' alt="photo1" />');
+     $this->email->send();
+   }
+ 
+ CID for each Email have to be create again to be unique.
+
 $this->email->print_debugger()
 ------------------------------
 
-- 
cgit v1.2.3-24-g4f1b


From de88615b7245f00d086d97a9fb5ea8b307d34c4f Mon Sep 17 00:00:00 2001
From: Petr Heralecky <petr@heralecky.cz>
Date: Fri, 10 Jan 2014 12:52:56 +0100
Subject: styleguided

---
 user_guide_src/source/changelog.rst       |  3 +--
 user_guide_src/source/libraries/email.rst | 18 +++++++++---------
 2 files changed, 10 insertions(+), 11 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index e8dc880e8..34eff5d57 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -334,8 +334,7 @@ Release Date: Not Released
 
       -  Added custom filename to ``Email::attach()`` as ``$this->email->attach($filename, $disposition, $newname)``.
       -  Added possibility to send attachment as buffer string in ``Email::attach()`` as ``$this->email->attach($buffer, $disposition, $newname, $mime)``.
-      -  Email attachments are creating in function Email::attach() - it's faster for sending many emails with same attachments
-      -  Added method Email::attach_cid() returning CID which enables to embed an attachment to html.
+      -  Added method ``Email::attach_cid()`` returning CID which enables to embed an attachment to html.
       -  Added dsn (delivery status notification) option.
       -  Renamed method _set_header() to set_header() and made it public to enable adding custom headers in the :doc:`Email Library <libraries/email>`.
       -  Successfully sent emails will automatically clear the parameters.
diff --git a/user_guide_src/source/libraries/email.rst b/user_guide_src/source/libraries/email.rst
index 90b71142b..274d88d46 100644
--- a/user_guide_src/source/libraries/email.rst
+++ b/user_guide_src/source/libraries/email.rst
@@ -277,15 +277,15 @@ $this->email->attach_cid()
  
  ::
  
-   $filename = '/img/photo1.jpg';
-   $this->email->attach($filename);
-   foreach ($list as $address)
-   {
-     $this->email->to($address);
-     $cid = $this->email->attach_cid($filename);
-     $this->email->message('<img src='cid:". $cid ."' alt="photo1" />');
-     $this->email->send();
-   }
+	$filename = '/img/photo1.jpg';
+	$this->email->attach($filename);
+	foreach ($list as $address)
+	{
+		$this->email->to($address);
+		$cid = $this->email->attach_cid($filename);
+		$this->email->message('<img src='cid:". $cid ."' alt="photo1" />');
+		$this->email->send();
+	}
  
  CID for each Email have to be create again to be unique.
 
-- 
cgit v1.2.3-24-g4f1b


From c809726558cc5364713e49c7404e43989203c4af Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Fri, 10 Jan 2014 14:45:31 +0200
Subject: Further changes related to PR #2807

---
 user_guide_src/source/changelog.rst       | 10 +++++-----
 user_guide_src/source/libraries/email.rst | 14 +++++++-------
 2 files changed, 12 insertions(+), 12 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 34eff5d57..b112da5b4 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -332,11 +332,11 @@ Release Date: Not Released
 
    -  :doc:`Email Library <libraries/email>` changes include:
 
-      -  Added custom filename to ``Email::attach()`` as ``$this->email->attach($filename, $disposition, $newname)``.
-      -  Added possibility to send attachment as buffer string in ``Email::attach()`` as ``$this->email->attach($buffer, $disposition, $newname, $mime)``.
-      -  Added method ``Email::attach_cid()`` returning CID which enables to embed an attachment to html.
+      -  Added a custom filename parameter to ``attach()`` as ``$this->email->attach($filename, $disposition, $newname)``.
+      -  Added possibility to send attachment as buffer string in ``attach()`` as ``$this->email->attach($buffer, $disposition, $newname, $mime)``.
+      -  Added method ``attachment_cid()`` to enable embedding inline attachments into HTML.
       -  Added dsn (delivery status notification) option.
-      -  Renamed method _set_header() to set_header() and made it public to enable adding custom headers in the :doc:`Email Library <libraries/email>`.
+      -  Renamed method ``_set_header()`` to ``set_header()`` and made it public to enable adding custom headers.
       -  Successfully sent emails will automatically clear the parameters.
       -  Added a *return_path* parameter to the ``from()`` method.
       -  Removed the second parameter (character limit) from internal method ``_prep_quoted_printable()`` as it is never used.
@@ -345,7 +345,7 @@ Release Date: Not Released
       -  Removed unused protected method ``_get_ip()`` (:doc:`Input Library <libraries/input>`'s ``ip_address()`` should be used anyway).
       -  Internal method ``_prep_q_encoding()`` now utilizes PHP's *mbstring* and *iconv* extensions (when available) and no longer has a second (``$from``) argument.
       -  Added an optional parameter to ``print_debugger()`` to allow specifying which parts of the message should be printed ('headers', 'subject', 'body').
-      -  Added SMTP keepalive option to avoid opening the connection for each ``Email::send()``. Accessible as ``$smtp_keepalive``.
+      -  Added SMTP keepalive option to avoid opening the connection for each ``send()`` call. Accessible as ``$smtp_keepalive``.
       -  Public method ``set_header()`` now filters the input by removing all "\\r" and "\\n" characters.
 
    -  :doc:`Pagination Library <libraries/pagination>` changes include:
diff --git a/user_guide_src/source/libraries/email.rst b/user_guide_src/source/libraries/email.rst
index 274d88d46..8e3800306 100644
--- a/user_guide_src/source/libraries/email.rst
+++ b/user_guide_src/source/libraries/email.rst
@@ -269,13 +269,13 @@ parameter as mime-type::
 
 	$this->email->attach($buffer, 'attachment', 'report.pdf', 'application/pdf');
 
-$this->email->attach_cid()
- --------------------------
+$this->email->attachment_cid()
+------------------------------
  
- Returns CID which enables to embed an attachment to html. First parameter 
- must be attached file.
+Sets and returns an attachment's Content-ID, which enables your to embed an inline
+(picture) attachment into HTML. First parameter must be attached file.
  
- ::
+::
  
 	$filename = '/img/photo1.jpg';
 	$this->email->attach($filename);
@@ -286,8 +286,8 @@ $this->email->attach_cid()
 		$this->email->message('<img src='cid:". $cid ."' alt="photo1" />');
 		$this->email->send();
 	}
- 
- CID for each Email have to be create again to be unique.
+
+CID for each Email have to be create again to be unique.
 
 $this->email->print_debugger()
 ------------------------------
-- 
cgit v1.2.3-24-g4f1b


From 155ee7231c0ef72dc362c7d6423b2e4600024d3c Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Fri, 10 Jan 2014 15:50:54 +0200
Subject: Compress output before storing it to cache, if output compression is
 enabled

Based on PR #964
---
 user_guide_src/source/changelog.rst       | 1 +
 user_guide_src/source/general/caching.rst | 3 +++
 2 files changed, 4 insertions(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 0488d9d4a..0e656a10d 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -439,6 +439,7 @@ Release Date: Not Released
       -  Added a second argument to method ``set_content_type()`` that allows setting the document charset as well.
       -  Added methods ``get_content_type()`` and ``get_header()``.
       -  Added method ``delete_cache()``.
+      -  Changed caching behavior to compress the output before storing it, if ``$config['compress_output']`` is enabled.
 
    -  :doc:`Config Library <libraries/config>` changes include:
 
diff --git a/user_guide_src/source/general/caching.rst b/user_guide_src/source/general/caching.rst
index 48385d6c9..f499f6e93 100644
--- a/user_guide_src/source/general/caching.rst
+++ b/user_guide_src/source/general/caching.rst
@@ -45,6 +45,9 @@ you. Once the tag is in place, your pages will begin being cached.
 	caching will only work if you are generating display for your
 	controller with a :doc:`view <./views>`.
 
+.. important:: If you change configuration options that might affect
+	your output, you have to manually delete your cache files.
+
 .. note:: Before the cache files can be written you must set the file
 	permissions on your *application/cache/* directory such that
 	it is writable.
-- 
cgit v1.2.3-24-g4f1b


From 232ea658e1f31d6c82a9ed9dae1bb3b292b6eb24 Mon Sep 17 00:00:00 2001
From: Petr Heralecky <petr@heralecky.cz>
Date: Fri, 10 Jan 2014 15:21:18 +0100
Subject: attach files by absolute url

---
 user_guide_src/source/changelog.rst       | 1 +
 user_guide_src/source/libraries/email.rst | 4 ++++
 2 files changed, 5 insertions(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index b112da5b4..cb70627d4 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -334,6 +334,7 @@ Release Date: Not Released
 
       -  Added a custom filename parameter to ``attach()`` as ``$this->email->attach($filename, $disposition, $newname)``.
       -  Added possibility to send attachment as buffer string in ``attach()`` as ``$this->email->attach($buffer, $disposition, $newname, $mime)``.
+      -  Added possibility attach remote file by absolute url
       -  Added method ``attachment_cid()`` to enable embedding inline attachments into HTML.
       -  Added dsn (delivery status notification) option.
       -  Renamed method ``_set_header()`` to ``set_header()`` and made it public to enable adding custom headers.
diff --git a/user_guide_src/source/libraries/email.rst b/user_guide_src/source/libraries/email.rst
index 8e3800306..476f1131d 100644
--- a/user_guide_src/source/libraries/email.rst
+++ b/user_guide_src/source/libraries/email.rst
@@ -259,6 +259,10 @@ otherwise use a custom disposition::
 
 	$this->email->attach('image.jpg', 'inline');
 
+You can use absolute url::
+
+	$this->email->attach('http://example.com/filename.pdf');
+
 If you'd like to use a custom file name, you can use the third paramater::
 
 	$this->email->attach('filename.pdf', 'attachment', 'report.pdf');
-- 
cgit v1.2.3-24-g4f1b


From 63f07cbd62ba885f003995dc7ad74bbdb28942c9 Mon Sep 17 00:00:00 2001
From: Petr Heralecky <petr@heralecky.cz>
Date: Fri, 10 Jan 2014 16:50:49 +0100
Subject: documentation repairs

---
 user_guide_src/source/changelog.rst       | 2 +-
 user_guide_src/source/libraries/email.rst | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index cb70627d4..07dee5dbd 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -334,7 +334,7 @@ Release Date: Not Released
 
       -  Added a custom filename parameter to ``attach()`` as ``$this->email->attach($filename, $disposition, $newname)``.
       -  Added possibility to send attachment as buffer string in ``attach()`` as ``$this->email->attach($buffer, $disposition, $newname, $mime)``.
-      -  Added possibility attach remote file by absolute url
+      -  Added possibility to attach remote files by passing a URL.
       -  Added method ``attachment_cid()`` to enable embedding inline attachments into HTML.
       -  Added dsn (delivery status notification) option.
       -  Renamed method ``_set_header()`` to ``set_header()`` and made it public to enable adding custom headers.
diff --git a/user_guide_src/source/libraries/email.rst b/user_guide_src/source/libraries/email.rst
index 476f1131d..86f440a74 100644
--- a/user_guide_src/source/libraries/email.rst
+++ b/user_guide_src/source/libraries/email.rst
@@ -259,7 +259,7 @@ otherwise use a custom disposition::
 
 	$this->email->attach('image.jpg', 'inline');
 
-You can use absolute url::
+You can use URL::
 
 	$this->email->attach('http://example.com/filename.pdf');
 
-- 
cgit v1.2.3-24-g4f1b


From 4e6c5281a3258b3ff530a43580d1b8dc8e34dd59 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Fri, 10 Jan 2014 19:29:49 +0200
Subject: Finally get rid of the CI_Router::_set_overrides() calls

---
 user_guide_src/source/changelog.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index b112da5b4..5da707086 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -461,6 +461,7 @@ Release Date: Not Released
       -  Added possibility to route requests using callbacks.
       -  Added a new reserved route (*translate_uri_dashes*) to allow usage of dashes in the controller and method URI segments.
       -  Deprecated methods ``fetch_directory()``, ``fetch_class()`` and ``fetch_method()`` in favor of their respective public properties.
+      -  Removed method ``_set_overrides()`` and moved its logic to the class constructor.
 
    -  :doc:`Language Library <libraries/language>` changes include:
 
-- 
cgit v1.2.3-24-g4f1b


From 75b3fb26a324c71ff18fa19b2a3caa357f8133ec Mon Sep 17 00:00:00 2001
From: Connor Tumbleson <connor.tumbleson@gmail.com>
Date: Sat, 11 Jan 2014 06:58:43 -0600
Subject: cleanup warnings

Signed-off-by: Connor Tumbleson <connor.tumbleson@gmail.com>
---
 user_guide_src/source/changelog.rst                |  2 +-
 user_guide_src/source/general/common_functions.rst |  6 +++---
 user_guide_src/source/libraries/image_lib.rst      | 11 ++++-------
 user_guide_src/source/libraries/input.rst          |  6 ++----
 user_guide_src/source/libraries/loader.rst         | 12 ++++--------
 user_guide_src/source/libraries/sessions.rst       |  3 +--
 user_guide_src/source/libraries/table.rst          | 10 +++++-----
 user_guide_src/source/libraries/trackback.rst      |  7 ++++---
 user_guide_src/source/libraries/typography.rst     |  4 ++--
 user_guide_src/source/libraries/xmlrpc.rst         |  2 +-
 10 files changed, 27 insertions(+), 36 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index f9beff36b..ba980d845 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -591,7 +591,7 @@ Bug fixes for 3.0
 -  Fixed a bug (#2380) - :doc:`URI Routing <general/routing>` method ``fetch_method()`` returned 'index' if the requested method name matches its controller name.
 -  Fixed a bug (#2388) - :doc:`Email Library <libraries/email>` used to ignore attachment errors, resulting in broken emails being sent.
 -  Fixed a bug (#2498) - :doc:`Form Validation Library <libraries/form_validation>` rule **valid_base64** only checked characters instead of actual validity.
--  Fixed a bug (#2425) - OCI8 :doc:`database <database>` driver's method ``stored_procedure()`` didn't log an error unless **db_debug** was set to TRUE.
+-  Fixed a bug (#2425) - OCI8 :doc:`database <database/index>` driver's method ``stored_procedure()`` didn't log an error unless **db_debug** was set to TRUE.
 -  Fixed a bug (#2490) - :doc:`Database Class <database/queries>` method ``query()`` returning boolean instead of a result object for PostgreSQL-specific *INSERT INTO ... RETURNING* statements.
 -  Fixed a bug (#249) - :doc:`Cache Library <libraries/caching>` didn't properly handle Memcache(d) configurations with missing options.
 -  Fixed a bug (#180) - :func:`config_item()` didn't take into account run-time configuration changes.
diff --git a/user_guide_src/source/general/common_functions.rst b/user_guide_src/source/general/common_functions.rst
index f8e9d775b..8c5166358 100644
--- a/user_guide_src/source/general/common_functions.rst
+++ b/user_guide_src/source/general/common_functions.rst
@@ -66,7 +66,7 @@ loading any libraries or helpers.
 	to retrieve single keys. See :doc:`Config Library <../libraries/config>`
 	documentation for more information.
 
-.. function:: show_error($message, $status_code, $heading = 'An Error Was Encountered')
+.. :noindex: function:: show_error($message, $status_code, $heading = 'An Error Was Encountered')
 
 	:param	mixed	$message: Error message
 	:param	int	$status_code: HTTP Response status code
@@ -76,7 +76,7 @@ loading any libraries or helpers.
 	This function calls ``CI_Exception::show_error()``. For more info,
 	please see the :doc:`Error Handling <errors>` documentation.
 
-.. function:: show_404($page = '', $log_error = TRUE)
+.. :noindex: function:: show_404($page = '', $log_error = TRUE)
 
 	:param	string	$page: URI string
 	:param	bool	$log_error: Whether to log the error
@@ -85,7 +85,7 @@ loading any libraries or helpers.
 	This function calls ``CI_Exception::show_404()``. For more info,
 	please see the :doc:`Error Handling <errors>` documentation.
 
-.. function:: log_message($level, $message, $php_error = FALSE)
+.. :noindex: function:: log_message($level, $message, $php_error = FALSE)
 
 	:param	string	$level: Log level: 'error', 'debug' or 'info'
 	:param	string	$message: Message to log
diff --git a/user_guide_src/source/libraries/image_lib.rst b/user_guide_src/source/libraries/image_lib.rst
index 73dc1f20d..ebdeaa782 100644
--- a/user_guide_src/source/libraries/image_lib.rst
+++ b/user_guide_src/source/libraries/image_lib.rst
@@ -164,7 +164,7 @@ If you prefer not to set preferences using the above method, you can
 instead put them into a config file. Simply create a new file called
 image_lib.php, add the $config array in that file. Then save the file
 in *config/image_lib.php* and it will be used automatically. You will
-NOT need to use the ``$this->image_lib->initialize()``method if you save
+NOT need to use the ``$this->image_lib->initialize()`` method if you save
 your preferences in a config file.
 
 ******************
@@ -330,8 +330,7 @@ Class Reference
 		All preferences listed in the :ref:`processing-preferences` table are available for this
 		method except these three: *rotation_angle*, *x_axis* and *y_axis*.
 
-		Creating a Thumbnail
-		--------------------
+		**Creating a Thumbnail**
 
 		The resizing method will create a thumbnail file (and preserve the
 		original) if you set this preference to TRUE::
@@ -340,8 +339,7 @@ Class Reference
 
 		This single preference determines whether a thumbnail is created or not.
 
-		Creating a Copy
-		---------------
+		**Creating a Copy**
 
 		The resizing method will create a copy of the image file (and preserve
 		the original) if you set a path and/or a new filename using this
@@ -358,8 +356,7 @@ Class Reference
 		-  If both the path and image name are specified it will placed in its
 		   own destination and given the new name.
 
-		Resizing the Original Image
-		---------------------------
+		**Resizing the Original Image**
 
 		If neither of the two preferences listed above (create_thumb, and
 		new_image) are used, the resizing method will instead target the
diff --git a/user_guide_src/source/libraries/input.rst b/user_guide_src/source/libraries/input.rst
index 4d8fdaf15..f5ab04883 100644
--- a/user_guide_src/source/libraries/input.rst
+++ b/user_guide_src/source/libraries/input.rst
@@ -215,8 +215,7 @@ Class Reference
 		pass information to this method so that a cookie can be set: Array
 		Method, and Discrete Parameters:
 
-		Array Method
-		^^^^^^^^^^^^
+		**Array Method**
 
 		Using this method, an associative array is passed to the first
 		parameter::
@@ -255,8 +254,7 @@ Class Reference
 		The secure boolean is only needed if you want to make it a secure cookie
 		by setting it to TRUE.
 
-		Discrete Parameters
-		^^^^^^^^^^^^^^^^^^^
+		**Discrete Parameters**
 
 		If you prefer, you can set the cookie by passing data using individual
 		parameters::
diff --git a/user_guide_src/source/libraries/loader.rst b/user_guide_src/source/libraries/loader.rst
index 477639969..ec5a87bb4 100644
--- a/user_guide_src/source/libraries/loader.rst
+++ b/user_guide_src/source/libraries/loader.rst
@@ -116,8 +116,7 @@ Class Reference
 
 			$this->load->library(array('email', 'table'));
 
-		Setting options
-		---------------
+		**Setting options**
 
 		The second (optional) parameter allows you to optionally pass
 		configuration setting. You will typically pass these as an array::
@@ -137,8 +136,7 @@ Class Reference
 		Please take note, when multiple libraries are supplied in an array for
 		the first parameter, each will receive the same parameter information.
 
-		Assigning a Library to a different object name
-		----------------------------------------------
+		**Assigning a Library to a different object name**
 
 		If the third (optional) parameter is blank, the library will usually be
 		assigned to an object with the same name as the library. For example, if
@@ -184,8 +182,7 @@ Class Reference
 
 			$this->load->driver(array('session', 'cache'));
 
-		Setting options
-		---------------
+		**Setting options**
 
 		The second (optional) parameter allows you to optionally pass
 		configuration settings. You will typically pass these as an array::
@@ -202,8 +199,7 @@ Class Reference
 		is explained in detail in its own page, so please read the information
 		regarding each one you would like to use.
 
-		Assigning a Driver to a different object name
-		---------------------------------------------
+		**Assigning a Driver to a different object name**
 
 		If the third (optional) parameter is blank, the library will be assigned
 		to an object with the same name as the parent class. For example, if
diff --git a/user_guide_src/source/libraries/sessions.rst b/user_guide_src/source/libraries/sessions.rst
index c76bccb8c..010b464d3 100644
--- a/user_guide_src/source/libraries/sessions.rst
+++ b/user_guide_src/source/libraries/sessions.rst
@@ -509,7 +509,6 @@ your config.php file to an array including your driver name::
 
 	$config['sess_valid_drivers'] = array('sess_driver');
 
-
 ***************
 Class Reference
 ***************
@@ -536,7 +535,7 @@ Class Reference
 
 		.. note:: This method should be the last one called, and even flash
 			variables will no longer be available after it is used.
-			 If you only want some items destroyed and not all, use
+			If you only want some items destroyed and not all, use
 			``unset_userdata()``.
 
 	.. method:: sess_regenerate([$destroy = FALSE])
diff --git a/user_guide_src/source/libraries/table.rst b/user_guide_src/source/libraries/table.rst
index bfe457993..ed085f781 100644
--- a/user_guide_src/source/libraries/table.rst
+++ b/user_guide_src/source/libraries/table.rst
@@ -241,11 +241,11 @@ Class Reference
 		Permits you to set your template. You can submit a full or partial template.
 		::
 
-		$template = array(
-			'table_open'  => '<table border="1" cellpadding="2" cellspacing="1" class="mytable">'
-		);
-
-		$this->table->set_template($template);
+			$template = array(
+				'table_open'  => '<table border="1" cellpadding="2" cellspacing="1" class="mytable">'
+			);
+		
+			$this->table->set_template($template);
 
 	.. method:: set_empty($value)
 
diff --git a/user_guide_src/source/libraries/trackback.rst b/user_guide_src/source/libraries/trackback.rst
index a1667c79c..c5b01a2ee 100644
--- a/user_guide_src/source/libraries/trackback.rst
+++ b/user_guide_src/source/libraries/trackback.rst
@@ -8,7 +8,7 @@ receive Trackback data.
 If you are not familiar with Trackbacks you'll find more information
 `here <http://en.wikipedia.org/wiki/Trackback>`_.
 
-.. content::
+.. contents::
   :local:
 
 .. raw:: html
@@ -64,11 +64,12 @@ Description of array data:
 -  **url** - The URL to YOUR site where the weblog entry can be seen.
 -  **title** - The title of your weblog entry.
 -  **excerpt** - The content of your weblog entry.
-   .. note:: the Trackback class will automatically send only the first 500 characters of your
-  	entry. It will also strip all HTML.
 -  **blog_name** - The name of your weblog.
 -  **charset** - The character encoding your weblog is written in. If omitted, UTF-8 will be used.
 
+.. note:: the Trackback class will automatically send only the first 500 characters of your 
+	entry. It will also strip all HTML.
+
 The Trackback sending method returns TRUE/FALSE (boolean) on success
 or failure. If it fails, you can retrieve the error message using::
 
diff --git a/user_guide_src/source/libraries/typography.rst b/user_guide_src/source/libraries/typography.rst
index 006e77d56..f1a825d3d 100644
--- a/user_guide_src/source/libraries/typography.rst
+++ b/user_guide_src/source/libraries/typography.rst
@@ -4,7 +4,7 @@ Typography Class
 
 The Typography Class provides methods that help you format text.
 
-.. content::
+.. contents::
   :local:
 
 .. raw:: html
@@ -35,7 +35,7 @@ Class Reference
 
 	.. attribute:: $protect_braced_quotes = FALSE
 
-		When using the Typography library in conjunction with the :doc:`Template Parser library <../parser>`
+		When using the Typography library in conjunction with the :doc:`Template Parser library <parser>`
 		it can often be desirable to protect single and double quotes within curly braces.
 		To enable this, set the ``protect_braced_quotes`` class property to TRUE.
 
diff --git a/user_guide_src/source/libraries/xmlrpc.rst b/user_guide_src/source/libraries/xmlrpc.rst
index 91d832ff6..53fe965d7 100644
--- a/user_guide_src/source/libraries/xmlrpc.rst
+++ b/user_guide_src/source/libraries/xmlrpc.rst
@@ -551,7 +551,7 @@ Class Reference
 		First parameter is the error number while the second parameter is the error message.
 		::
 
-		return $this->xmlrpc->send_error_message(123, 'Requested data not available');
+			return $this->xmlrpc->send_error_message(123, 'Requested data not available');
 
 	.. method send_response($response)
 
-- 
cgit v1.2.3-24-g4f1b


From e16b926550f736483cb11df147946c9717a1a4fe Mon Sep 17 00:00:00 2001
From: Connor Tumbleson <connor.tumbleson@gmail.com>
Date: Tue, 14 Jan 2014 07:40:50 -0600
Subject: fix lists on requirements

---
 user_guide_src/source/general/requirements.rst | 23 ++++++++++++-----------
 1 file changed, 12 insertions(+), 11 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/general/requirements.rst b/user_guide_src/source/general/requirements.rst
index 104923625..0b67e8e3a 100644
--- a/user_guide_src/source/general/requirements.rst
+++ b/user_guide_src/source/general/requirements.rst
@@ -2,14 +2,15 @@
 Server Requirements
 ###################
 
--  `PHP <http://www.php.net/>`_ version 5.2.4 or newer.
--  A Database is required for most web application programming.
-   Currently supported databases are:
-   -  MySQL (5.1+) via the *mysql* (deprecated), *mysqli* and *pdo* drivers
-   -  Oracle via the *oci8* and *pdo* drivers
-   -  PostgreSQL via the *postgre* and *pdo* drivers
-   -  MS SQL via the *mssql*, *sqlsrv* (version 2005 and above only) and *pdo* drivers
-   -  SQLite via the *sqlite* (version 2), *sqlite3* (version 3) and *pdo* drivers
-   -  CUBRID via the *cubrid* and *pdo* drivers
-   -  Interbase/Firebird via the *ibase* and *pdo* drivers
-   -  ODBC via the *odbc* and *pdo* drivers (you should know that ODBC is actually an abstraction layer)
\ No newline at end of file
+- `PHP <http://www.php.net/>`_ version 5.2.4 or newer.
+- A Database is required for most web application programming.
+
+ Currently supported databases are:
+  - MySQL (5.1+) via the *mysql* (deprecated), *mysqli* and *pdo* drivers
+  - Oracle via the *oci8* and *pdo* drivers
+  - PostgreSQL via the *postgre* and *pdo* drivers
+  - MS SQL via the *mssql*, *sqlsrv* (version 2005 and above only) and *pdo* drivers
+  - SQLite via the *sqlite* (version 2), *sqlite3* (version 3) and *pdo* drivers
+  - CUBRID via the *cubrid* and *pdo* drivers
+  - Interbase/Firebird via the *ibase* and *pdo* drivers
+  - ODBC via the *odbc* and *pdo* drivers (you should know that ODBC is actually an abstraction layer)
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From de14aa5a29b1b122bfd536f979dfda7f2fd9f53d Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Wed, 15 Jan 2014 15:51:08 +0200
Subject: CI_URI changes related to the 'permitted_uri_chars' setting

 - Initialize and cache the value in the class constructor instead of searching for it every time
 - Removed the preg_quote() call from _filter_uri() to allow more fine-tuning from configuration
 - Renamed _filter_uri() to filter_uri() - it was public anyway and using it cannot break anything

Related: issue #2799
---
 user_guide_src/source/changelog.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 43e7be41f..77378521b 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -391,6 +391,7 @@ Release Date: Not Released
 
    -  :doc:`URI Library <libraries/uri>` changes include:
 
+      -  Renamed method ``_filter_uri()`` to ``filter_uri()`` and removed the ``preg_quote()`` call from it.
       -  Changed private methods to protected so that MY_URI can override them.
       -  Renamed internal method ``_parse_cli_args()`` to ``_parse_argv()``.
       -  Renamed internal method ``_detect_uri()`` to ``_parse_request_uri()``.
-- 
cgit v1.2.3-24-g4f1b


From d8b1ad31cf7ee205ddf3cf396b1d1bfa45af49fa Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Wed, 15 Jan 2014 17:42:52 +0200
Subject: Fix #2822: Incorrect usage of fwrite()

We only used to check (and not always) if the return value of fwrite() is boolean FALSE,
while it is possible that the otherwise returned bytecount is less than the length of
data that we're trying to write. This allowed incomplete writes over network streams
and possibly a few other edge cases.
---
 user_guide_src/source/changelog.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 77378521b..a1dc3c1d1 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -669,6 +669,7 @@ Bug fixes for 3.0
 -  Fixed a bug (#346) - with ``$config['global_xss_filtering']`` turned on, the ``$_GET``, ``$_POST``, ``$_COOKIE`` and ``$_SERVER`` superglobals were overwritten during initialization time, resulting in XSS filtering being either performed twice or there was no possible way to get the original data, even though options for this do exist.
 -  Fixed an edge case (#555) - incorrect browser version was reported for Opera 10+ due to a non-standard user-agent string.
 -  Fixed a bug (#133) - :doc:`Text Helper <helpers/text_helper>` :func:`ascii_to_entities()` stripped the last character if it happens to be in the extended ASCII group.
+-  Fixed a bug (#2822) - ``fwrite()`` was used incorrectly throughout the whole framework, allowing incomplete writes when writing to a network stream and possibly a few other edge cases.
 
 Version 2.1.4
 =============
-- 
cgit v1.2.3-24-g4f1b


From 08fef7de41cb06785cdb1024769892d9510e6e6b Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Wed, 15 Jan 2014 18:37:01 +0200
Subject: Fix #2799 by adding conditional PCRE UTF-8 support to
 CI_URI::filter_uri()

Also did a tiny micro-optimization in the Utf8 class.
---
 user_guide_src/source/changelog.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index a1dc3c1d1..4712ed87d 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -391,7 +391,8 @@ Release Date: Not Released
 
    -  :doc:`URI Library <libraries/uri>` changes include:
 
-      -  Renamed method ``_filter_uri()`` to ``filter_uri()`` and removed the ``preg_quote()`` call from it.
+      -  Added conditional PCRE UTF-8 support to the "invalid URI characters" check and removed the ``preg_quote()`` call from it to allow more flexibility.
+      -  Renamed method ``_filter_uri()`` to ``filter_uri()``.
       -  Changed private methods to protected so that MY_URI can override them.
       -  Renamed internal method ``_parse_cli_args()`` to ``_parse_argv()``.
       -  Renamed internal method ``_detect_uri()`` to ``_parse_request_uri()``.
-- 
cgit v1.2.3-24-g4f1b


From 30d5324617ae136c7a91badb6ed8f7de418fd7f5 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Thu, 16 Jan 2014 14:41:46 +0200
Subject: URI Routing overhaul

 - Allow multiple levels of controller directories (supersedes PRs #390, #2439)
 - Add support for per-directory 'defaul_controller' and '404_override' (resolves issue #2611; supersedes PR #939)
 - Fixed a bug where default_controller was called instead of triggering 404 if the current route is inside a directory
 - Removed a few calls from CI_Router to CI_URI that made a necessity for otherwise internal CI_URI methods to be public:

    - Removed CI_URI::_fetch_uri_string() and moved its logic into CI_URI::__construct()
    - Removed CI_URI::_remove_url_suffix, CI_URI::_explode_segments() and moved their logic into CI_URI::_set_uri_string()
    - Removed CI_URI::_reindex_segments() altogether ( doesn't need further manipulation, while  is
      public anyway and can be properly (and more effectively) replaced on the spot)
---
 user_guide_src/source/changelog.rst | 22 ++++++++++++++--------
 1 file changed, 14 insertions(+), 8 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 4712ed87d..388bc28ce 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -389,6 +389,16 @@ Release Date: Not Released
 
 -  Core
 
+   -  :doc:`Routing <general/routing>` changes include:
+
+      -  Added support for multiple levels of controller directories.
+      -  Added support for per-directory *default_controller* and *404_override* classes.
+      -  Added possibility to route requests using HTTP verbs.
+      -  Added possibility to route requests using callbacks.
+      -  Added a new reserved route (*translate_uri_dashes*) to allow usage of dashes in the controller and method URI segments.
+      -  Deprecated methods ``fetch_directory()``, ``fetch_class()`` and ``fetch_method()`` in favor of their respective public properties.
+      -  Removed method ``_set_overrides()`` and moved its logic to the class constructor.
+
    -  :doc:`URI Library <libraries/uri>` changes include:
 
       -  Added conditional PCRE UTF-8 support to the "invalid URI characters" check and removed the ``preg_quote()`` call from it to allow more flexibility.
@@ -399,6 +409,9 @@ Release Date: Not Released
       -  Changed ``_parse_request_uri()`` to accept absolute URIs for compatibility with HTTP/1.1 as per `RFC2616 <http://www.ietf.org/rfc/rfc2616.txt>`.
       -  Added protected method ``_parse_query_string()`` to URI paths in the the **QUERY_STRING** value, like ``_parse_request_uri()`` does.
       -  Changed ``_fetch_uri_string()`` to try the **PATH_INFO** variable first when auto-detecting.
+      -  Removed methods ``_remove_url_suffix()``, ``_explode_segments()`` and moved their logic into ``_set_uri_string()``.
+      -  Removed method ``_fetch_uri_string()`` and moved its logic into the class constructor.
+      -  Removed method ``_reindex_segments()``.
 
    -  :doc:`Loader Library <libraries/loader>` changes include:
 
@@ -458,14 +471,6 @@ Release Date: Not Released
       -  Added ``$config['csrf_exclude_uris']``, which allows you list URIs which will not have the CSRF validation methods run.
       -  Modified method ``sanitize_filename()`` to read a public ``$filename_bad_chars`` property for getting the invalid characters list.
 
-   -  :doc:`URI Routing <general/routing>` changes include:
-
-      -  Added possibility to route requests using HTTP verbs.
-      -  Added possibility to route requests using callbacks.
-      -  Added a new reserved route (*translate_uri_dashes*) to allow usage of dashes in the controller and method URI segments.
-      -  Deprecated methods ``fetch_directory()``, ``fetch_class()`` and ``fetch_method()`` in favor of their respective public properties.
-      -  Removed method ``_set_overrides()`` and moved its logic to the class constructor.
-
    -  :doc:`Language Library <libraries/language>` changes include:
 
       -  Changed method ``load()`` to filter the language name with ``ctype_alpha()``.
@@ -671,6 +676,7 @@ Bug fixes for 3.0
 -  Fixed an edge case (#555) - incorrect browser version was reported for Opera 10+ due to a non-standard user-agent string.
 -  Fixed a bug (#133) - :doc:`Text Helper <helpers/text_helper>` :func:`ascii_to_entities()` stripped the last character if it happens to be in the extended ASCII group.
 -  Fixed a bug (#2822) - ``fwrite()`` was used incorrectly throughout the whole framework, allowing incomplete writes when writing to a network stream and possibly a few other edge cases.
+-  Fixed a bug where *default_controller* was called instad of triggering a 404 error if the current route is in a controller directory.
 
 Version 2.1.4
 =============
-- 
cgit v1.2.3-24-g4f1b


From a9938a09e8214b778b8ab11f60501661bb2ac623 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Fri, 17 Jan 2014 14:55:56 +0200
Subject: Minor changes related to CI_User_agent

Fixed a bug where both accept_charset() and accept_lang() improperly parsed headers
if they contained spaces between data separators (which is valid).

Also made is_referral() testable by replacing its static cache var with a class
property and added some more unit tests for the library as a whole.
---
 user_guide_src/source/changelog.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 4712ed87d..8618e5efe 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -671,6 +671,7 @@ Bug fixes for 3.0
 -  Fixed an edge case (#555) - incorrect browser version was reported for Opera 10+ due to a non-standard user-agent string.
 -  Fixed a bug (#133) - :doc:`Text Helper <helpers/text_helper>` :func:`ascii_to_entities()` stripped the last character if it happens to be in the extended ASCII group.
 -  Fixed a bug (#2822) - ``fwrite()`` was used incorrectly throughout the whole framework, allowing incomplete writes when writing to a network stream and possibly a few other edge cases.
+-  Fixed a bug where :doc:`User Agent Library <libraries/user_agent>` methods ``accept_charset()`` and ``accept_lang()`` didn't properly parse HTTP headers that contain spaces.
 
 Version 2.1.4
 =============
-- 
cgit v1.2.3-24-g4f1b


From 88cf55bd294e74c71e70406e3a48e722db224f7f Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Fri, 17 Jan 2014 15:38:30 +0200
Subject: Add autoloading library aliasing support (supersedes PR #2824)

---
 user_guide_src/source/changelog.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 8618e5efe..539c61367 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -408,7 +408,7 @@ Release Date: Not Released
       -  Added autoloading of drivers with ``$autoload['drivers']``.
       -  ``$config['rewrite_short_tags']`` now has no effect when using PHP 5.4 as ``<?=`` will always be available.
       -  Changed method ``config()`` to return whatever ``CI_Config::load()`` returns instead of always being void.
-      -  Added support for model aliasing on autoload.
+      -  Added support for library and model aliasing on autoload.
       -  Changed method ``is_loaded()`` to ask for the (case sensitive) library name instead of its instance name.
       -  Removed ``$_base_classes`` property and unified all class data in ``$_ci_classes`` instead.
       -  Added method ``clear_vars()`` to allow clearing the cached variables for views.
-- 
cgit v1.2.3-24-g4f1b


From 4b9b5074c5f4ecc4cc0494acfe26379f9a6d4317 Mon Sep 17 00:00:00 2001
From: Ahmedul Haque Abid <a_h_abid@hotmail.com>
Date: Sun, 19 Jan 2014 13:23:16 +0600
Subject: Added save_queries config setting in config/database.php

---
 user_guide_src/source/changelog.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 237e237e2..2662b451d 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -160,6 +160,7 @@ Release Date: Not Released
    -  Added support for SQLite3 database driver.
    -  Added Interbase/Firebird database support via the *ibase* driver.
    -  Added ODBC support for ``create_database()``, ``drop_database()`` and ``drop_table()`` in :doc:`Database Forge <database/forge>`.
+   -  Added **save_queries** config setting in *config/database.php*. Default is ``TRUE``.
 
    -  :doc:`Query Builder <database/query_builder>` changes include:
 
-- 
cgit v1.2.3-24-g4f1b


From 1c8245a22874051f5342824d5299d6ad55f4995c Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Mon, 20 Jan 2014 10:28:20 +0200
Subject: Polish changes from PR #2830

---
 user_guide_src/source/changelog.rst         |  2 +-
 user_guide_src/source/database/helpers.rst  | 27 ++++++++++++++-------------
 user_guide_src/source/general/profiling.rst |  6 +++++-
 3 files changed, 20 insertions(+), 15 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 2662b451d..7cc98f40c 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -160,7 +160,7 @@ Release Date: Not Released
    -  Added support for SQLite3 database driver.
    -  Added Interbase/Firebird database support via the *ibase* driver.
    -  Added ODBC support for ``create_database()``, ``drop_database()`` and ``drop_table()`` in :doc:`Database Forge <database/forge>`.
-   -  Added **save_queries** config setting in *config/database.php*. Default is ``TRUE``.
+   -  Added **save_queries** configuration setting to *application/config/database.php* (defaults to ``TRUE``).
 
    -  :doc:`Query Builder <database/query_builder>` changes include:
 
diff --git a/user_guide_src/source/database/helpers.rst b/user_guide_src/source/database/helpers.rst
index e8a5ac801..77bf1b5d2 100644
--- a/user_guide_src/source/database/helpers.rst
+++ b/user_guide_src/source/database/helpers.rst
@@ -3,7 +3,7 @@ Query Helper Functions
 ######################
 
 $this->db->insert_id()
-=======================
+======================
 
 The insert ID number when performing database inserts.
 
@@ -12,7 +12,7 @@ The insert ID number when performing database inserts.
 	appropriate sequence to check for the insert id.
 
 $this->db->affected_rows()
-===========================
+==========================
 
 Displays the number of affected rows, when doing "write" type queries
 (insert, update, etc.).
@@ -22,8 +22,8 @@ Displays the number of affected rows, when doing "write" type queries
 	affected rows. By default this hack is enabled but it can be turned off
 	in the database driver file.
 
-$this->db->count_all();
-========================
+$this->db->count_all()
+======================
 
 Permits you to determine the number of rows in a particular table.
 Submit the table name in the first parameter. Example::
@@ -47,8 +47,8 @@ Outputs the database version you are running::
 
 	echo $this->db->version();
 
-$this->db->last_query();
-=========================
+$this->db->last_query()
+=======================
 
 Returns the last query that was run (the query string, not the result).
 Example::
@@ -57,11 +57,12 @@ Example::
 	
 	// Produces:  SELECT * FROM sometable....
 
-The following two functions help simplify the process of writing
-database INSERTs and UPDATEs.
 
-$this->db->insert_string();
-============================
+.. note:: Disabling the **save_queries** setting in your database
+	configuration will render this function useless.
+
+$this->db->insert_string()
+==========================
 
 This function simplifies the process of writing database inserts. It
 returns a correctly formatted SQL insert string. Example::
@@ -77,8 +78,8 @@ array with the data to be inserted. The above example produces::
 
 .. note:: Values are automatically escaped, producing safer queries.
 
-$this->db->update_string();
-============================
+$this->db->update_string()
+==========================
 
 This function simplifies the process of writing database updates. It
 returns a correctly formatted SQL update string. Example::
@@ -95,4 +96,4 @@ array with the data to be updated, and the third parameter is the
 
 	 UPDATE table_name SET name = 'Rick', email = 'rick@example.com', url = 'example.com' WHERE author_id = 1 AND status = 'active'
 
-.. note:: Values are automatically escaped, producing safer queries.
+.. note:: Values are automatically escaped, producing safer queries.
\ No newline at end of file
diff --git a/user_guide_src/source/general/profiling.rst b/user_guide_src/source/general/profiling.rst
index 6dbd0be16..f29af8102 100644
--- a/user_guide_src/source/general/profiling.rst
+++ b/user_guide_src/source/general/profiling.rst
@@ -80,4 +80,8 @@ Key                     Description
 **session_data**        Data stored in the current session                                  TRUE
 **query_toggle_count**  The number of queries after which the query block will default to   25
                         hidden.
-======================= =================================================================== ========
\ No newline at end of file
+======================= =================================================================== ========
+
+.. note:: Disabling the **save_queries** setting in your database configuration
+	will also effectively disable profiling for database queries and render
+	the 'queries' setting above useless.
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 3aecedbbb017567925f76ae68b726bd22b4cc80c Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Mon, 20 Jan 2014 10:39:08 +0200
Subject: Fix #2737

---
 user_guide_src/source/changelog.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index d5e560f5b..4d93091f1 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -680,6 +680,7 @@ Bug fixes for 3.0
 -  Fixed a bug (#2822) - ``fwrite()`` was used incorrectly throughout the whole framework, allowing incomplete writes when writing to a network stream and possibly a few other edge cases.
 -  Fixed a bug where :doc:`User Agent Library <libraries/user_agent>` methods ``accept_charset()`` and ``accept_lang()`` didn't properly parse HTTP headers that contain spaces.
 -  Fixed a bug where *default_controller* was called instad of triggering a 404 error if the current route is in a controller directory.
+-  Fixed a bug (#2737) - :doc:`XML-RPC Library <libraries/xmlrpc>` used objects as array keys, which triggered E_NOTICE messages.
 
 Version 2.1.4
 =============
-- 
cgit v1.2.3-24-g4f1b


From 4d0571666d03511ac5b4a1f2a6882ccb1509a209 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Mon, 20 Jan 2014 11:17:34 +0200
Subject: Fix #2729

---
 user_guide_src/source/changelog.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 4d93091f1..c68258e1c 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -681,6 +681,7 @@ Bug fixes for 3.0
 -  Fixed a bug where :doc:`User Agent Library <libraries/user_agent>` methods ``accept_charset()`` and ``accept_lang()`` didn't properly parse HTTP headers that contain spaces.
 -  Fixed a bug where *default_controller* was called instad of triggering a 404 error if the current route is in a controller directory.
 -  Fixed a bug (#2737) - :doc:`XML-RPC Library <libraries/xmlrpc>` used objects as array keys, which triggered E_NOTICE messages.
+-  Fixed a bug (#2729) - ``CI_Securty::_validate_entities()`` used overly-intrusive ``preg_replace()`` patterns that produced false-positives.
 
 Version 2.1.4
 =============
-- 
cgit v1.2.3-24-g4f1b


From ba231aab2b26279f536a52bf4ccdb4af0d191570 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Mon, 20 Jan 2014 16:43:41 +0200
Subject: [ci skip] Replace incorrect usage of 'then', where it should be
 'than'

---
 user_guide_src/source/changelog.rst            |  2 +-
 user_guide_src/source/general/controllers.rst  |  2 +-
 user_guide_src/source/general/hooks.rst        |  2 +-
 user_guide_src/source/helpers/text_helper.rst  |  2 +-
 user_guide_src/source/helpers/xml_helper.rst   | 34 +++++++++++++-------------
 user_guide_src/source/libraries/cart.rst       |  2 +-
 user_guide_src/source/libraries/image_lib.rst  |  2 +-
 user_guide_src/source/libraries/typography.rst |  2 +-
 8 files changed, 24 insertions(+), 24 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index cd1998b9a..825e0f845 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -2252,7 +2252,7 @@ Bug fixes for Version 1.6.0
 -  Fixed a bug (#3003) in the Encryption Library to support modes other
    than MCRYPT_MODE_ECB
 -  Fixed a bug (#3015) in the :doc:`User Agent
-   library <./libraries/user_agent>` where more then 2 languages
+   library <./libraries/user_agent>` where more than 2 languages
    where not reported with languages().
 -  Fixed a bug (#3017) in the :doc:`Email <./libraries/email>` library
    where some timezones were calculated incorrectly.
diff --git a/user_guide_src/source/general/controllers.rst b/user_guide_src/source/general/controllers.rst
index d8ef824fb..bc8319dd8 100644
--- a/user_guide_src/source/general/controllers.rst
+++ b/user_guide_src/source/general/controllers.rst
@@ -107,7 +107,7 @@ You should see your new message.
 Passing URI Segments to your methods
 ====================================
 
-If your URI contains more then two segments they will be passed to your
+If your URI contains more than two segments they will be passed to your
 method as parameters.
 
 For example, let's say you have a URI like this::
diff --git a/user_guide_src/source/general/hooks.rst b/user_guide_src/source/general/hooks.rst
index fc5da5b80..1046c48ae 100644
--- a/user_guide_src/source/general/hooks.rst
+++ b/user_guide_src/source/general/hooks.rst
@@ -59,7 +59,7 @@ defined in your associative hook array:
 Multiple Calls to the Same Hook
 ===============================
 
-If want to use the same hook point with more then one script, simply
+If want to use the same hook point with more than one script, simply
 make your array declaration multi-dimensional, like this::
 
 	$hook['pre_controller'][] = array(
diff --git a/user_guide_src/source/helpers/text_helper.rst b/user_guide_src/source/helpers/text_helper.rst
index 3c6430f3f..788fe8b0c 100644
--- a/user_guide_src/source/helpers/text_helper.rst
+++ b/user_guide_src/source/helpers/text_helper.rst
@@ -50,7 +50,7 @@ The following functions are available:
 
 	Truncates a string to the number of *characters* specified. It
 	maintains the integrity of words so the character count may be slightly
-	more or less then what you specify.
+	more or less than what you specify.
 
 	Example::
 
diff --git a/user_guide_src/source/helpers/xml_helper.rst b/user_guide_src/source/helpers/xml_helper.rst
index 6d26c581e..7d155e192 100644
--- a/user_guide_src/source/helpers/xml_helper.rst
+++ b/user_guide_src/source/helpers/xml_helper.rst
@@ -28,27 +28,27 @@ The following functions are available:
 
 .. function:: xml_convert($str[, $protect_all = FALSE])
 
-  :param string $str: the text string to convert
-  :param bool $protect_all: Whether to protect all content that looks like a potential entity instead of just numbered entities, e.g. &foo;
-  :returns: string
+	:param string $str: the text string to convert
+	:param bool $protect_all: Whether to protect all content that looks like a potential entity instead of just numbered entities, e.g. &foo;
+	:returns: string
 
-  Takes a string as input and converts the following reserved XML
-  characters to entities:
+	Takes a string as input and converts the following reserved XML
+	characters to entities:
 
-  - Ampersands: &
-  - Less then and greater than characters: < >
-  - Single and double quotes: ' "
-  - Dashes: -
+	  - Ampersands: &
+	  - Less than and greater than characters: < >
+	  - Single and double quotes: ' "
+	  - Dashes: -
 
-  This function ignores ampersands if they are part of existing numbered
-  character entities, e.g. &#123;. Example::
+	This function ignores ampersands if they are part of existing numbered
+	character entities, e.g. &#123;. Example::
 
-    $string = '<p>Here is a paragraph & an entity (&#123;).</p>';
-    $string = xml_convert($string);
-    echo $string;
+		$string = '<p>Here is a paragraph & an entity (&#123;).</p>';
+		$string = xml_convert($string);
+		echo $string;
 
-  outputs:
+	outputs:
 
-  .. code-block:: html
+	.. code-block:: html
 
-    &lt;p&gt;Here is a paragraph &amp; an entity (&#123;).&lt;/p&gt;
+		&lt;p&gt;Here is a paragraph &amp; an entity (&#123;).&lt;/p&gt;
diff --git a/user_guide_src/source/libraries/cart.rst b/user_guide_src/source/libraries/cart.rst
index ad1955d27..0c8c0a601 100644
--- a/user_guide_src/source/libraries/cart.rst
+++ b/user_guide_src/source/libraries/cart.rst
@@ -245,7 +245,7 @@ the product ID and any options associated with it.
 
 In nearly all cases, updating the cart will be something the user does
 via the "view cart" page, so as a developer, it is unlikely that you
-will ever have to concern yourself with the "row ID", other then making
+will ever have to concern yourself with the "row ID", other than making
 sure your "view cart" page contains this information in a hidden form
 field, and making sure it gets passed to the update function when the
 update form is submitted. Please examine the construction of the "view
diff --git a/user_guide_src/source/libraries/image_lib.rst b/user_guide_src/source/libraries/image_lib.rst
index ebdeaa782..cde4e44dc 100644
--- a/user_guide_src/source/libraries/image_lib.rst
+++ b/user_guide_src/source/libraries/image_lib.rst
@@ -147,7 +147,7 @@ Preference              Default Value           Options
                                                                                 pixels. If the source image size does not allow perfect resizing to
                                                                                 those dimensions, this setting determines which axis should be used as
                                                                                 the hard value. "auto" sets the axis automatically based on whether the
-                                                                                image is taller then wider, or vice versa.
+                                                                                image is taller than wider, or vice versa.
 **rotation_angle**      None                    90, 180, 270, vrt, hor          Specifies the angle of rotation when rotating images. Note that PHP         X
                                                                                 rotates counter-clockwise, so a 90 degree rotation to the right must be
                                                                                 specified as 270.
diff --git a/user_guide_src/source/libraries/typography.rst b/user_guide_src/source/libraries/typography.rst
index f1a825d3d..c1a864a3e 100644
--- a/user_guide_src/source/libraries/typography.rst
+++ b/user_guide_src/source/libraries/typography.rst
@@ -66,7 +66,7 @@ Class Reference
 
 			$string = $this->typography->auto_typography($string);
 
-		There is one optional parameter that determines whether the parser should reduce more then two consecutive line breaks down to two.
+		There is one optional parameter that determines whether the parser should reduce more than two consecutive line breaks down to two.
 		Pass boolean TRUE to enable reducing line breaks::
 
 			$string = $this->typography->auto_typography($string, TRUE);
-- 
cgit v1.2.3-24-g4f1b


From de1fe7d504898bc6a42e24b4c73da3887a9933d6 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Mon, 20 Jan 2014 17:06:16 +0200
Subject: [ci skip] Add 'Using the X class' headings to Session & Language lib
 docs

Fixes 2 doc compile warnings
---
 user_guide_src/source/libraries/language.rst | 4 ++++
 user_guide_src/source/libraries/sessions.rst | 4 ++++
 2 files changed, 8 insertions(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/language.rst b/user_guide_src/source/libraries/language.rst
index 3cee5d7f6..10449b935 100644
--- a/user_guide_src/source/libraries/language.rst
+++ b/user_guide_src/source/libraries/language.rst
@@ -26,6 +26,10 @@ your **application/language/** directory.
 
   <div class="custom-index container"></div>
 
+************************
+Using the Language Class
+************************
+
 Creating Language Files
 =======================
 
diff --git a/user_guide_src/source/libraries/sessions.rst b/user_guide_src/source/libraries/sessions.rst
index 3e6dcf28b..c4f861620 100644
--- a/user_guide_src/source/libraries/sessions.rst
+++ b/user_guide_src/source/libraries/sessions.rst
@@ -16,6 +16,10 @@ you wish, while still taking advantage of the features of the Session class.
 
   <div class="custom-index container"></div>
 
+***********************
+Using the Session Class
+***********************
+
 Initializing a Session
 ======================
 
-- 
cgit v1.2.3-24-g4f1b


From 27f798b9d64025fecaaecbd80a8cba41d455940f Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Mon, 20 Jan 2014 18:19:13 +0200
Subject: Add support for optional table attributes to
 CI_DB_forge::create_table()

Supersedes PRs #989, #2776
Related issue: #41
---
 user_guide_src/source/changelog.rst      | 3 ++-
 user_guide_src/source/database/forge.rst | 9 +++++++++
 2 files changed, 11 insertions(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index c68258e1c..7dc358652 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -240,8 +240,9 @@ Release Date: Not Released
 
       - Added an optional second parameter to ``drop_table()`` that allows adding the **IF EXISTS** condition, which is no longer the default.
       - Added support for passing a custom database object to the loader.
-      - Deprecated ``add_column()``'s third method. *AFTER* clause should now be added to the field definition array instead.
+      - Added support for passing custom table attributes (such as ``ENGINE`` for MySQL) to ``create_table()``.
       - Added support for usage of the *FIRST* clause in ``add_column()`` for MySQL and CUBRID.
+      - Deprecated ``add_column()``'s third method. *AFTER* clause should now be added to the field definition array instead.
       - Overall improved support for all of the drivers.
 
    -  :doc:`Database Utility <database/utilities>` changes include:
diff --git a/user_guide_src/source/database/forge.rst b/user_guide_src/source/database/forge.rst
index ca904ed00..48642ad7e 100644
--- a/user_guide_src/source/database/forge.rst
+++ b/user_guide_src/source/database/forge.rst
@@ -201,6 +201,15 @@ into the definition
 	$this->dbforge->create_table('table_name', TRUE);
 	// gives CREATE TABLE IF NOT EXISTS table_name
 
+You could also pass optional table attributes, such as MySQL's ``ENGINE``::
+
+	$attributes = array('ENGINE' => 'InnoDB');
+	$this->dbforge->create_table('table_name', FALSE, $attributes);
+	// produces: CREATE TABLE `table_name` (...) ENGINE = InnoDB DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci
+
+.. note:: Unless you specify the ``CHARACTER SET`` and/or ``COLLATE`` attributes,
+	``create_table()`` will always add them with your configured *char_set*
+	and *dbcollat* values, as long as they are not empty (MySQL only).
 
 Dropping a table
 ================
-- 
cgit v1.2.3-24-g4f1b


From ba8bf563095657b8b6104ecc3d3a990f3e6ceb75 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Tue, 21 Jan 2014 19:04:18 +0200
Subject: SQLSRV improvements

Mainly for performance (issue #2474), but also added a 'scrollable' configuration flag
and auto-detection for SQLSRV_CURSOR_CLIENT_BUFFERED (only available since SQLSRV 3).
---
 user_guide_src/source/changelog.rst | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index c68258e1c..5c01d64af 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -222,6 +222,9 @@ Release Date: Not Released
       - Added port handling support for UNIX-based systems (MSSQL driver).
       - Added *OFFSET* support for SQL Server 2005 and above.
       - Added ``db_set_charset()`` support (MSSQL driver).
+      - Added a *scrollable* property to enable configuration of the cursor to use (SQLSRV driver).
+      - Added support and auto-detection for the ``SQLSRV_CURSOR_CLIENT_BUFFERED`` scrollable cursor flag (SQLSRV driver).
+      - Changed default behavior to not use ``SQLSRV_CURSOR_STATIC`` due to performance issues (SQLSRV driver).
 
    -  Improved support of the Oracle (OCI8) driver, including:
 
-- 
cgit v1.2.3-24-g4f1b


From c67c3fbb8e16b1ffb79c72bb91db04fcb005b2b1 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Wed, 22 Jan 2014 13:26:00 +0200
Subject: CI_Security::_decode_entity() to replace dangerous HTML5 entities

Related to issue #2771
---
 user_guide_src/source/changelog.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index ae2900761..513050159 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -685,7 +685,8 @@ Bug fixes for 3.0
 -  Fixed a bug where :doc:`User Agent Library <libraries/user_agent>` methods ``accept_charset()`` and ``accept_lang()`` didn't properly parse HTTP headers that contain spaces.
 -  Fixed a bug where *default_controller* was called instad of triggering a 404 error if the current route is in a controller directory.
 -  Fixed a bug (#2737) - :doc:`XML-RPC Library <libraries/xmlrpc>` used objects as array keys, which triggered E_NOTICE messages.
--  Fixed a bug (#2729) - ``CI_Securty::_validate_entities()`` used overly-intrusive ``preg_replace()`` patterns that produced false-positives.
+-  Fixed a bug (#2729) - ``CI_Security::_validate_entities()`` used overly-intrusive ``preg_replace()`` patterns that produced false-positives.
+-  Fixed a bug (#2771) - ``CI_Security::xss_clean()`` didn't take into account HTML5 entities.
 
 Version 2.1.4
 =============
-- 
cgit v1.2.3-24-g4f1b


From ecc260e0be0cdb55c4e4802b78ddd78b0d8b0ebc Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Fri, 24 Jan 2014 14:20:13 +0200
Subject: Righting a wrong in the Session library

 - Change userdata(), flashdata(), tempdata() to return all the respective data when no parameter is passed.
 - Revert the addition of all_flashdata().
 - Deprecate all_userdata().
 - Fix related changelog entries that were all inconsistent.
---
 user_guide_src/source/changelog.rst                | 29 ++++++++++------------
 user_guide_src/source/installation/upgrade_300.rst | 15 +++++++++++
 user_guide_src/source/libraries/sessions.rst       |  4 +--
 3 files changed, 30 insertions(+), 18 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 513050159..3124dea60 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -259,22 +259,18 @@ Release Date: Not Released
 
    -  :doc:`Session Library <libraries/sessions>` changes include:
 
-      -  Library changed to :doc:`Driver <general/drivers>` with classic Cookie driver as default.
-      -  Added Native PHP Session driver to work with ``$_SESSION``.
-      -  Custom drivers can be added anywhere in package paths and be loaded with the library.
-      -  Drivers interchangeable on the fly.
-      -  New **tempdata** feature allows setting user data items with an expiration time.
-      -  Added default ``$config['sess_driver']`` and ``$config['sess_valid_drivers']`` items to *config.php* file.
-      -  Cookie driver now respects php.ini's *session.gc_probability* and *session.gc_divisor* settings.
-      -  Cookie driver now uses HMAC authentication instead of the simple md5 checksum.
-      -  The Cookie driver now also checks authentication on encrypted session data.
-      -  Changed the Cookie driver to select only one row when using database sessions.
-      -  Cookie driver now only writes to database at end of request when using database.
-      -  Cookie driver now uses PHP functions for faster array manipulation when using database.
-      -  Added ``all_flashdata()`` method to session class. Returns an associative array of only flashdata.
-      -  Added ``has_userdata()`` method to verify existence of userdata item.
-      -  Added ``tempdata()``, ``set_tempdata()``, and ``unset_tempdata()`` methods for manipulating tempdata.
-      -  ``keep_flashdata()`` now accepts an array of keys.
+      -  Library changed to :doc:`Driver <general/drivers>` with classic 'cookie' driver as the default.
+      -  Added a 'native' PHP Session driver to work with ``$_SESSION``.
+      -  Added a new **tempdata** feature that allows setting userdata items with expiration time (``tempdata()``, ``set_tempdata()``, ``unset_tempdata()``). 
+      -  Added default ``$config['sess_driver']`` and ``$config['sess_valid_drivers']`` items to *application/config.php* file.
+      -  Changed 'cookie' driver to respect php.ini's *session.gc_probability* and *session.gc_divisor* settings.
+      -  Changed 'cookie' driver to use HMAC authentication instead of a simple md5 checksum.
+      -  Changed 'cookie' driver to select only one row when using database sessions.
+      -  Changed 'cookie' driver to write to only write to the database at end of page execution.
+      -  Changed method ``keep_flashdata()`` to also accept an array of keys.
+      -  Changed methods ``userdata()``, ``flashdata()`` to return an array of all userdata/flashdata when no parameter is passed.
+      -  Deprecated method ``all_userdata()`` - it is now just an alias for ``userdata()`` with no parameters.
+      -  Added method ``has_userdata()`` that verifies the existence of a userdata item.
       -  Added *debug* level log messages for key events in the session validation process.
 
    -  :doc:`File Uploading Library <libraries/file_uploading>` changes include:
@@ -687,6 +683,7 @@ Bug fixes for 3.0
 -  Fixed a bug (#2737) - :doc:`XML-RPC Library <libraries/xmlrpc>` used objects as array keys, which triggered E_NOTICE messages.
 -  Fixed a bug (#2729) - ``CI_Security::_validate_entities()`` used overly-intrusive ``preg_replace()`` patterns that produced false-positives.
 -  Fixed a bug (#2771) - ``CI_Security::xss_clean()`` didn't take into account HTML5 entities.
+-  Fixed a bug in the :doc:`Session Library <libraries/sessions>` 'cookie' driver where authentication was not performed for encrypted cookies.
 
 Version 2.1.4
 =============
diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst
index ca7569b57..88bb11178 100644
--- a/user_guide_src/source/installation/upgrade_300.rst
+++ b/user_guide_src/source/installation/upgrade_300.rst
@@ -469,6 +469,21 @@ in CodeIgniter 3.1+.
 .. note:: These options are still available, but you're strongly encouraged to remove their usage
 	sooner rather than later.
 
+Session Library method all_userdata()
+=====================================
+
+As seen in the :doc:`Change Log <../changelog>`, :doc:`Session Library <libraries/sessions>`
+method ``userdata()`` now allows you to fetch all userdata by simply omitting its parameter::
+
+	$this->session->userdata();
+
+This makes the ``all_userdata()`` method redudant and therefore it is now just an alias for
+``userdata()`` with the above shown usage and is being deprecated and scheduled for removal
+in CodeIgniter 3.1+.
+
+.. note:: This method is still available, but you're strongly encouraged to remove its usage
+	sooner rather than later.
+
 Database Forge method add_column() with an AFTER clause
 =======================================================
 
diff --git a/user_guide_src/source/libraries/sessions.rst b/user_guide_src/source/libraries/sessions.rst
index 2f8bea0b6..3368a9f5d 100644
--- a/user_guide_src/source/libraries/sessions.rst
+++ b/user_guide_src/source/libraries/sessions.rst
@@ -137,7 +137,7 @@ Retrieving All Session Data
 
 An array of all userdata can be retrieved as follows::
 
-	$this->session->all_userdata()
+	$this->session->userdata()
 
 And returns an associative array like the following::
 
@@ -194,7 +194,7 @@ To read a flashdata variable::
 
 An array of all flashdata can be retrieved as follows::
 
-	$this->session->all_flashdata();
+	$this->session->flashdata();
 
 
 If you find that you need to preserve a flashdata variable through an
-- 
cgit v1.2.3-24-g4f1b


From 8b9dd229bc58e271cba9665d26882d8c8449ac36 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Fri, 24 Jan 2014 14:41:22 +0200
Subject: [ci skip] Update Session library docs

---
 user_guide_src/source/helpers/date_helper.rst |  2 +-
 user_guide_src/source/libraries/sessions.rst  | 94 +++++++++++++++------------
 2 files changed, 54 insertions(+), 42 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/helpers/date_helper.rst b/user_guide_src/source/helpers/date_helper.rst
index e9e122f1c..e7598df14 100644
--- a/user_guide_src/source/helpers/date_helper.rst
+++ b/user_guide_src/source/helpers/date_helper.rst
@@ -82,7 +82,7 @@ The following functions are available:
 		$time = time();
 		echo standard_date($format, $time);
 
-	.. note:: This function is DEPRECATED.Use the native ``date()`` combined with
+	.. note:: This function is DEPRECATED. Use the native ``date()`` combined with
 		`DateTime's format constants
 		<http://www.php.net/manual/en/class.datetime.php#datetime.constants.types>`_
 		instead::
diff --git a/user_guide_src/source/libraries/sessions.rst b/user_guide_src/source/libraries/sessions.rst
index f63f584a6..9e23e9b60 100644
--- a/user_guide_src/source/libraries/sessions.rst
+++ b/user_guide_src/source/libraries/sessions.rst
@@ -103,6 +103,23 @@ fetch. For example, to fetch the session ID you will do this::
 .. note:: The function returns NULL if the item you are
 	trying to access does not exist.
 
+If you want to retrieve all of the existing userdata, you can simply
+omit the item key parameter::
+
+	$this->session->userdata();
+
+	/**
+	 * Produces something similar to:
+	 *
+	 *	Array
+	 *	(
+	 *		[session_id] => 4a5a5dca22728fb0a84364eeb405b601
+	 *		[ip_address] => 127.0.0.1
+	 *		[user_agent] => Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_7;
+	 *		[last_activity] => 1303142623
+	 *	)
+	 */
+
 Adding Custom Session Data
 ==========================
 
@@ -144,23 +161,6 @@ If you want to verify that a userdata value exists, call ``has_userdata()``.
 
 	$this->session->has_userdata('some_name');
 
-Retrieving All Session Data
-===========================
-
-An array of all userdata can be retrieved as follows::
-
-	$this->session->userdata()
-
-And returns an associative array like the following::
-
-	Array
-	(
-		[session_id] => 4a5a5dca22728fb0a84364eeb405b601
-		[ip_address] => 127.0.0.1
-		[user_agent] => Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_7;
-		[last_activity] => 1303142623
-	)
-
 Removing Session Data
 =====================
 
@@ -246,6 +246,10 @@ To read a tempdata variable::
 
 	$this->session->tempdata('item');
 
+And of course, if you want to retrieve all existing tempdata::
+
+	$this->session->tempdata();
+
 If you need to remove a tempdata value before it expires,
 use ``unset_tempdata()``::
 
@@ -550,12 +554,14 @@ Class Reference
 
 		Regenerate the current session data.
 
-	.. method:: userdata($item)
+	.. method:: userdata([$item = NULL])
 
 		:param string $item: Session item name
-		:returns: string
+		:returns: mixed
+
+		If no parameter is passed, it will return an associative array of all existing userdata.
 
-		Returns a string containing the value of the passed item or NULL if the item is not found.
+		Otherwise returns a string containing the value of the passed item or NULL if the item is not found.
 		Example::
 
 			$this->session->userdata('user');
@@ -565,13 +571,15 @@ Class Reference
 
 		:returns: array
 
-		Retruns an array with all of the session userdata items.
+		Returns an array with all of the session userdata items.
+
+		.. note:: This method is DEPRECATED. Use ``userdata()`` with no parameters instead.
 
-	.. method:: all_flashdata()
+	.. method:: &get_userdata()
 
 		:returns: array
 
-		Retruns an array with all of the session flashdata items.
+		Returns a reference to the userdata array.
 
 	.. method:: set_userdata($newdata[, $newval = ''])
 
@@ -607,6 +615,19 @@ Class Reference
 
 		Checks if an item exists in the session.
 
+	.. method:: flashdata([$item = NULL])
+
+		:param string $item: Flashdata item name
+		:returns: mixed
+
+		If no parameter is passed, it will return an associative array of all existing flashdata.
+
+		Otherwise returns a string containing the value of the passed item or NULL if the item is not found.
+		Example::
+
+			$this->session->flashdata('message');
+			//returns 'Test message.' considering the set_flashdata example.
+
 	.. method:: set_flashdata($newdata[, $newval = ''])
 
 		:param mixed $newdata: Item name or an array of items
@@ -629,16 +650,18 @@ Class Reference
 
 		Keeps items into flashdata for one more request.
 
-	.. method:: flashdata($item)
+	.. method:: tempdata([$item = NULL])
 
-		:param string $item: Flashdata item name
-		:returns: string
+		:param string $item: Tempdata item name
+		:returns: mixed
 
-		Returns a string containing the value of the passed item or NULL if the item is not found.
+		If no parameter is passed, it will return an associative array of all existing tempdata.
+
+		Otherwise returns a string containing the value of the passed item or NULL if the item is not found.
 		Example::
 
-			$this->session->flashdata('message');
-			//returns 'Test message.' considering the set_flashdata example.
+			$this->session->tempdata('message');
+			//returns 'Test message.' considering the set_tempdata example.
 
 	.. method:: set_tempdata($newdata[, $newval = ''[, $expire = 0]])
 
@@ -667,15 +690,4 @@ Class Reference
 			//unsets 'user' from tempdata.
 
 			$this->session->unset_tempdata(array('user', 'useremail'));
-			//unsets both 'user' and 'useremail' from the tempdata.
-
-	.. method:: tempdata($item)
-
-		:param string $item: Tempdata item name
-		:returns: string
-
-		Returns a string containing the value of the passed item or NULL if the item is not found.
-		Example::
-
-			$this->session->tempdata('message');
-			//returns 'Test message.' considering the set_tempdata example.
+			//unsets both 'user' and 'useremail' from the tempdata.
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From b8401d44036d0fbf336ba29ec2f17c82df5ea580 Mon Sep 17 00:00:00 2001
From: Connor Tumbleson <connor.tumbleson@gmail.com>
Date: Thu, 23 Jan 2014 08:48:16 -0600
Subject: fix bad url

---
 user_guide_src/source/general/styleguide.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/general/styleguide.rst b/user_guide_src/source/general/styleguide.rst
index 5613eabec..000d04e1c 100644
--- a/user_guide_src/source/general/styleguide.rst
+++ b/user_guide_src/source/general/styleguide.rst
@@ -565,7 +565,7 @@ the ability to change this in the php.ini, you can often enable it with::
 	ini_set('display_errors', 1);
 
 .. note:: Setting the `display_errors
-	<http://php.net/manual/en/ref.errorfunc.php#ini.display-errors>`_
+	<http://php.net/manual/en/function.ini-set.php>`_
 	setting with ``ini_set()`` at runtime is not identical to having
 	it enabled in the PHP environment. Namely, it will not have any
 	effect if the script has fatal errors.
-- 
cgit v1.2.3-24-g4f1b


From 1d6bddd3ef95f04795e6b3228dda6f8683bfccd7 Mon Sep 17 00:00:00 2001
From: Connor Tumbleson <connor.tumbleson@gmail.com>
Date: Fri, 24 Jan 2014 07:37:22 -0600
Subject: update to errorfunc url

---
 user_guide_src/source/general/styleguide.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/general/styleguide.rst b/user_guide_src/source/general/styleguide.rst
index 000d04e1c..6718bc342 100644
--- a/user_guide_src/source/general/styleguide.rst
+++ b/user_guide_src/source/general/styleguide.rst
@@ -565,7 +565,7 @@ the ability to change this in the php.ini, you can often enable it with::
 	ini_set('display_errors', 1);
 
 .. note:: Setting the `display_errors
-	<http://php.net/manual/en/function.ini-set.php>`_
+	<http://php.net/manual/en/errorfunc.configuration.php#ini.display-errors>`_
 	setting with ``ini_set()`` at runtime is not identical to having
 	it enabled in the PHP environment. Namely, it will not have any
 	effect if the script has fatal errors.
-- 
cgit v1.2.3-24-g4f1b


From af9aa2b5bfa9d6060b18a0df9ebb710135c6c6ee Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Sat, 25 Jan 2014 00:28:10 +0200
Subject: [ci skip] Add a note to the is_really_writable() docs

---
 user_guide_src/source/general/common_functions.rst | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/general/common_functions.rst b/user_guide_src/source/general/common_functions.rst
index 65ca026a1..e2536de4c 100644
--- a/user_guide_src/source/general/common_functions.rst
+++ b/user_guide_src/source/general/common_functions.rst
@@ -32,10 +32,10 @@ loading any libraries or helpers.
 	greater than the supplied version number. Returns FALSE if the installed
 	version of PHP is lower than the supplied version number.
 
-	.. function:: is_really_writable($file)
+.. function:: is_really_writable($file)
 
-		:param	string	$file: File path
-		:returns:	bool
+	:param	string	$file: File path
+	:returns:	bool
 
 	``is_writable()`` returns TRUE on Windows servers when you really can't
 	write to the file as the OS reports to PHP as FALSE only if the
@@ -56,6 +56,8 @@ loading any libraries or helpers.
 			echo "File is not writable";
 		}
 
+	.. note:: See also `PHP bug #54709 <https://bugs.php.net/bug.php?id=54709>`_ for more info.
+
 .. function:: config_item($key)
 
 	:param	string	$key: Config item key
-- 
cgit v1.2.3-24-g4f1b


From 6310c86f4f8e9760adb48e1df705124332b80cf8 Mon Sep 17 00:00:00 2001
From: Connor Tumbleson <connor.tumbleson@gmail.com>
Date: Fri, 24 Jan 2014 16:45:10 -0600
Subject: fix warning

---
 user_guide_src/source/installation/upgrade_300.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst
index fccaa2933..b89d4e35b 100644
--- a/user_guide_src/source/installation/upgrade_300.rst
+++ b/user_guide_src/source/installation/upgrade_300.rst
@@ -472,7 +472,7 @@ in CodeIgniter 3.1+.
 Session Library method all_userdata()
 =====================================
 
-As seen in the :doc:`Change Log <../changelog>`, :doc:`Session Library <libraries/sessions>`
+As seen in the :doc:`Change Log <../changelog>`, :doc:`Session Library <../libraries/sessions>`
 method ``userdata()`` now allows you to fetch all userdata by simply omitting its parameter::
 
 	$this->session->userdata();
-- 
cgit v1.2.3-24-g4f1b


From 1a903921473d1bedda86e758dc171233f9f69492 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Wed, 29 Jan 2014 13:51:22 +0200
Subject: [ci skip] Fix broken links

---
 user_guide_src/source/contributing/index.rst       | 2 +-
 user_guide_src/source/overview/at_a_glance.rst     | 2 +-
 user_guide_src/source/overview/getting_started.rst | 4 ++--
 user_guide_src/source/tutorial/conclusion.rst      | 6 +++---
 4 files changed, 7 insertions(+), 7 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/contributing/index.rst b/user_guide_src/source/contributing/index.rst
index 0771a4192..4d3fe6ede 100644
--- a/user_guide_src/source/contributing/index.rst
+++ b/user_guide_src/source/contributing/index.rst
@@ -33,7 +33,7 @@ PHP Style
 =========
 
 All code must meet the `Style Guide
-<http://codeigniter.com/user_guide/general/styleguide.html>`_, which is
+<http://ellislab.com/codeigniter/user-guide/general/styleguide.html>`_, which is
 essentially the `Allman indent style
 <http://en.wikipedia.org/wiki/Indent_style#Allman_style>`_, underscores and
 readable operators. This makes certain that all code is the same format as the
diff --git a/user_guide_src/source/overview/at_a_glance.rst b/user_guide_src/source/overview/at_a_glance.rst
index 6dcfdbb14..da323b907 100644
--- a/user_guide_src/source/overview/at_a_glance.rst
+++ b/user_guide_src/source/overview/at_a_glance.rst
@@ -111,4 +111,4 @@ CodeIgniter has a Friendly Community of Users
 =============================================
 
 Our growing community of users can be seen actively participating in our
-`Community Forums <http://codeigniter.com/forums/>`_.
+`Community Forums <http://ellislab.com/forums/>`_.
diff --git a/user_guide_src/source/overview/getting_started.rst b/user_guide_src/source/overview/getting_started.rst
index 5157d4860..feaad5908 100644
--- a/user_guide_src/source/overview/getting_started.rst
+++ b/user_guide_src/source/overview/getting_started.rst
@@ -19,6 +19,6 @@ Reference** and **Helper Reference** pages to learn to utilize the
 native libraries and helper files.
 
 Feel free to take advantage of our `Community
-Forums <http://codeigniter.com/forums/>`_ if you have questions or
-problems, and our `Wiki <http://codeigniter.com/wiki/>`_ to see code
+Forums <http://ellislab.com/forums/>`_ if you have questions or
+problems, and our `Wiki <https://github.com/EllisLab/CodeIgniter/wiki>`_ to see code
 examples posted by other users.
diff --git a/user_guide_src/source/tutorial/conclusion.rst b/user_guide_src/source/tutorial/conclusion.rst
index 48fbdcc8a..a5f69b4e7 100644
--- a/user_guide_src/source/tutorial/conclusion.rst
+++ b/user_guide_src/source/tutorial/conclusion.rst
@@ -20,7 +20,7 @@ CodeIgniter within a few days.
 If you still have questions about the framework or your own CodeIgniter
 code, you can:
 
--  Check out our `forums <http://codeigniter.com/forums>`_
--  Visit our `IRC chatroom <http://codeigniter.com/wiki/IRC>`_
--  Explore the `Wiki <http://codeigniter.com/wiki/>`_
+-  Check out our `forums <http://ellislab.com/forums>`_
+-  Visit our `IRC chatroom <https://github.com/EllisLab/CodeIgniter/wiki/IRC>`_
+-  Explore the `Wiki <https://github.com/EllisLab/CodeIgniter/wiki/>`_
 
-- 
cgit v1.2.3-24-g4f1b


From aaa8ddb5a48af8f37cf1015a7768957cce41acd3 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Mon, 3 Feb 2014 14:10:44 +0200
Subject: [ci skip] Update info on function_usable

---
 user_guide_src/source/changelog.rst                | 2 +-
 user_guide_src/source/general/common_functions.rst | 7 ++++++-
 2 files changed, 7 insertions(+), 2 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 3124dea60..c6d42d923 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -449,7 +449,7 @@ Release Date: Not Released
       -  Changed ``_exception_handler()`` to respect php.ini *display_errors* setting.
       -  Added function :php:func:`is_https()` to check if a secure connection is used.
       -  Added function :php:func:`is_cli()` to replace the ``CI_Input::is_cli_request()`` method.
-      -  Added function :php:func:`function_usable()` to check if a function exists and is not disabled by `Suhosin <http://www.hardened-php.net/suhosin/>`.
+      -  Added function :php:func:`function_usable()` to work around a bug in `Suhosin <http://www.hardened-php.net/suhosin/>`.
       -  Removed the third (`$php_error`) from function :php:func:`log_message()`.
 
    -  :doc:`Output Library <libraries/output>` changes include:
diff --git a/user_guide_src/source/general/common_functions.rst b/user_guide_src/source/general/common_functions.rst
index a1007cb4b..1babe5a83 100644
--- a/user_guide_src/source/general/common_functions.rst
+++ b/user_guide_src/source/general/common_functions.rst
@@ -202,4 +202,9 @@ checks if it doesn't disable the function being checked.
 
 It is useful if you want to check for the availability of functions
 such as ``eval()`` and ``exec()``, which are dangerous and might be
-disabled on servers with highly restrictive security policies.
\ No newline at end of file
+disabled on servers with highly restrictive security policies.
+
+.. note:: This function was introduced because Suhosin terminated
+	script execution, but this turned out to be a bug. A fix
+	has been available for some time (version 0.9.34), but is
+	unfortunately not released yet.
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 4a2918a33c756ac7cc9defc2e6acd371e4412af6 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Wed, 5 Feb 2014 01:03:46 +0200
Subject: Integrate CI_Encryption into the framework

TODO: Add documentation in user_guide_src/source/libraries/encryption.rst
---
 user_guide_src/source/changelog.rst                |  17 ++-
 user_guide_src/source/installation/upgrade_200.rst |   6 +-
 user_guide_src/source/installation/upgrade_300.rst |  19 ++-
 user_guide_src/source/libraries/encrypt.rst        | 164 +++++++++++++++++++++
 user_guide_src/source/libraries/encryption.rst     | 164 ---------------------
 5 files changed, 195 insertions(+), 175 deletions(-)
 create mode 100644 user_guide_src/source/libraries/encrypt.rst
 delete mode 100644 user_guide_src/source/libraries/encryption.rst

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 3124dea60..5f45f428d 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -257,6 +257,14 @@ Release Date: Not Released
 
 -  Libraries
 
+   -  Added a new :doc:`Encryption Library <libraries/encryption>` to replace the old, largely insecure :doc:`Encrypt Library <libraries/encrypt>`.
+
+   -  :doc:`Encrypt Library <libraries/encrypt>` changes include:
+
+      -  Deprecated the library in favor of the new :doc:`Encryption Library <libraries/encryption>`.
+      -  Added support for hashing algorithms other than SHA1 and MD5.
+      -  Removed previously deprecated ``sha1()`` method.
+
    -  :doc:`Session Library <libraries/sessions>` changes include:
 
       -  Library changed to :doc:`Driver <general/drivers>` with classic 'cookie' driver as the default.
@@ -358,11 +366,6 @@ Release Date: Not Released
       -  Added $config['reuse_query_string'] to allow automatic repopulation of query string arguments, combined with normal URI segments.
       -  Removed the default ``&nbsp;`` from a number of the configuration variables.
 
-   -  :doc:`Encryption Library <libraries/encryption>` changes include:
-
-      -  Added support for hashing algorithms other than SHA1 and MD5.
-      -  Removed previously deprecated ``sha1()`` method.
-
    -  :doc:`Profiler Library <general/profiling>` changes include:
 
       -  Database object names are now being displayed.
@@ -574,7 +577,7 @@ Bug fixes for 3.0
 -  Fixed a bug (#1264) - :doc:`Database Forge <database/forge>` and :doc:`Database Utilities <database/utilities>` didn't update/reset the databases and tables list cache when a table or a database is created, dropped or renamed.
 -  Fixed a bug (#7) - :doc:`Query Builder <database/query_builder>`'s ``join()`` method only escaped one set of conditions.
 -  Fixed a bug (#1321) - Core Exceptions class couldn't find the errors/ folder in some cases.
--  Fixed a bug (#1202) - :doc:`Encryption Library <libraries/encryption>` encode_from_legacy() didn't set back the encrypt mode on failure.
+-  Fixed a bug (#1202) - :doc:`Encrypt Library <libraries/encrypt>` method ``encode_from_legacy()`` didn't set back the encrypt mode on failure.
 -  Fixed a bug (#145) - compile_binds() failed when the bind marker was present in a literal string within the query.
 -  Fixed a bug in protect_identifiers() where if passed along with the field names, operators got escaped as well.
 -  Fixed a bug (#10) - :doc:`URI Library <libraries/uri>` internal method _detect_uri() failed with paths containing a colon.
@@ -1289,7 +1292,7 @@ Hg Tag: v2.0.0
    -  Documented append_output() in the :doc:`Output
       Class <libraries/output>`.
    -  Documented a second argument in the decode() function for the
-      :doc:`Encryption Class <libraries/encryption>`.
+      :doc:`Encryption Class <libraries/encrypt>`.
    -  Documented db->close().
    -  Updated the router to support a default route with any number of
       segments.
diff --git a/user_guide_src/source/installation/upgrade_200.rst b/user_guide_src/source/installation/upgrade_200.rst
index 29f44bd9e..948b1bc58 100644
--- a/user_guide_src/source/installation/upgrade_200.rst
+++ b/user_guide_src/source/installation/upgrade_200.rst
@@ -50,11 +50,11 @@ to ::
 Step 4: Update stored encrypted data
 ====================================
 
-.. note:: If your application does not use the Encryption library, does
+.. note:: If your application does not use the Encrypt library, does
 	not store Encrypted data permanently, or is on an environment that does
 	not support Mcrypt, you may skip this step.
 
-The Encryption library has had a number of improvements, some for
+The Encrypt library has had a number of improvements, some for
 encryption strength and some for performance, that has an unavoidable
 consequence of making it no longer possible to decode encrypted data
 produced by the original version of this library. To help with the
@@ -65,7 +65,7 @@ replace stale encrypted data with fresh in your applications, either on
 the fly or en masse.
 
 Please read `how to use this
-method <../libraries/encryption.html#legacy>`_ in the Encryption library
+method <../libraries/encrypt.html#legacy>`_ in the Encrypt library
 documentation.
 
 Step 5: Remove loading calls for the compatibility helper.
diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst
index 88bb11178..94385978e 100644
--- a/user_guide_src/source/installation/upgrade_300.rst
+++ b/user_guide_src/source/installation/upgrade_300.rst
@@ -318,7 +318,7 @@ The SHA1 library
 The previously deprecated SHA1 library has been removed, alter your code to use PHP's native
 ``sha1()`` function to generate a SHA1 hash.
 
-Additionally, the ``sha1()`` method in the :doc:`Encryption Library <../libraries/encryption>` has been removed.
+Additionally, the ``sha1()`` method in the :doc:`Encrypt Library <../libraries/encrypt>` has been removed.
 
 The EXT constant
 ================
@@ -333,6 +333,23 @@ Smiley helper js_insert_smiley()
 :doc:`Smiley Helper <../helpers/smiley_helper>` function ``js_insert_smiley()`` has been deprecated
 since CodeIgniter 1.7.2 and is now removed. You'll need to switch to ``smiley_js()`` instead.
 
+The Encrypt library
+===================
+
+Following numerous vulnerability reports, the :doc:`Encrypt Library <../libraries/encrypt>` has
+been deprecated and a new, :doc:`Encryption Library <../libraries/encryption>` is added to take
+its place.
+
+The new library requires either the `MCrypt extension <http://php.net/mcrypt>`_ or PHP 5.3.3 and
+the `OpenSSL extension <http://php.net/openssl>`_. While this might be rather inconvenient, it is
+a requirement that allows us to have properly implemented cryptographic functions.
+
+.. note:: The :doc:`Encrypt Library <../libraries/encrypt>` is still available for the purpose
+	of keeping backwards compatibility.
+
+.. important:: You are strongly encouraged to switch to the new :doc:`Encryption Library
+	<../libraries/encryption>` as soon as possible!
+
 Database drivers 'mysql', 'sqlite', 'mssql', 'pdo/dblib'
 ========================================================
 
diff --git a/user_guide_src/source/libraries/encrypt.rst b/user_guide_src/source/libraries/encrypt.rst
new file mode 100644
index 000000000..a38122203
--- /dev/null
+++ b/user_guide_src/source/libraries/encrypt.rst
@@ -0,0 +1,164 @@
+################
+Encryption Class
+################
+
+The Encryption Class provides two-way data encryption. It uses a scheme
+that either compiles the message using a randomly hashed bitwise XOR
+encoding scheme, or is encrypted using the Mcrypt library. If Mcrypt is
+not available on your server the encoded message will still provide a
+reasonable degree of security for encrypted sessions or other such
+"light" purposes. If Mcrypt is available, you'll be provided with a high
+degree of security appropriate for storage.
+
+Setting your Key
+================
+
+A *key* is a piece of information that controls the cryptographic
+process and permits an encrypted string to be decoded. In fact, the key
+you chose will provide the **only** means to decode data that was
+encrypted with that key, so not only must you choose the key carefully,
+you must never change it if you intend use it for persistent data.
+
+It goes without saying that you should guard your key carefully. Should
+someone gain access to your key, the data will be easily decoded. If
+your server is not totally under your control it's impossible to ensure
+key security so you may want to think carefully before using it for
+anything that requires high security, like storing credit card numbers.
+
+To take maximum advantage of the encryption algorithm, your key should
+be 32 characters in length (256 bits). The key should be as random a
+string as you can concoct, with numbers and uppercase and lowercase
+letters. Your key should **not** be a simple text string. In order to be
+cryptographically secure it needs to be as random as possible.
+
+Your key can be either stored in your **application/config/config.php**, or
+you can design your own storage mechanism and pass the key dynamically
+when encoding/decoding.
+
+To save your key to your **application/config/config.php**, open the file
+and set::
+
+	$config['encryption_key'] = "YOUR KEY";
+
+Message Length
+==============
+
+It's important for you to know that the encoded messages the encryption
+function generates will be approximately 2.6 times longer than the
+original message. For example, if you encrypt the string "my super
+secret data", which is 21 characters in length, you'll end up with an
+encoded string that is roughly 55 characters (we say "roughly" because
+the encoded string length increments in 64 bit clusters, so it's not
+exactly linear). Keep this information in mind when selecting your data
+storage mechanism. Cookies, for example, can only hold 4K of
+information.
+
+Initializing the Class
+======================
+
+Like most other classes in CodeIgniter, the Encryption class is
+initialized in your controller using the **$this->load->library** function::
+
+	$this->load->library('encrypt');
+
+Once loaded, the Encrypt library object will be available using:
+$this->encrypt
+
+$this->encrypt->encode()
+========================
+
+Performs the data encryption and returns it as a string. Example::
+
+	$msg = 'My secret message';
+
+	$encrypted_string = $this->encrypt->encode($msg);
+	
+
+You can optionally pass your encryption key via the second parameter if
+you don't want to use the one in your config file::
+
+	$msg = 'My secret message';
+	$key = 'super-secret-key';
+
+	$encrypted_string = $this->encrypt->encode($msg, $key);
+
+$this->encrypt->decode()
+========================
+
+Decrypts an encoded string. Example::
+
+	$encrypted_string = 'APANtByIGI1BpVXZTJgcsAG8GZl8pdwwa84';
+
+	$plaintext_string = $this->encrypt->decode($encrypted_string);
+
+You can optionally pass your encryption key via the second parameter if
+you don't want to use the one in your config file::
+
+	$msg = 'My secret message';
+	$key = 'super-secret-key';
+
+	$encrypted_string = $this->encrypt->decode($msg, $key);
+
+$this->encrypt->set_cipher();
+==============================
+
+Permits you to set an Mcrypt cipher. By default it uses
+**MCRYPT_RIJNDAEL_256**. Example::
+
+	$this->encrypt->set_cipher(MCRYPT_BLOWFISH);
+
+Please visit php.net for a list of `available
+ciphers <http://php.net/mcrypt>`_.
+
+If you'd like to manually test whether your server supports Mcrypt you
+can use::
+
+	echo ( ! function_exists('mcrypt_encrypt')) ? 'Nope' : 'Yup';
+
+$this->encrypt->set_mode();
+============================
+
+Permits you to set an Mcrypt mode. By default it uses **MCRYPT_MODE_CBC**.
+Example::
+
+	$this->encrypt->set_mode(MCRYPT_MODE_CFB);
+
+Please visit php.net for a list of `available
+modes <http://php.net/mcrypt>`_.
+
+$this->encrypt->encode_from_legacy($orig_data, $legacy_mode = MCRYPT_MODE_ECB, $key = '');
+==========================================================================================
+
+Enables you to re-encode data that was originally encrypted with
+CodeIgniter 1.x to be compatible with the Encryption library in
+CodeIgniter 2.x. It is only necessary to use this method if you have
+encrypted data stored permanently such as in a file or database and are
+on a server that supports Mcrypt. "Light" use encryption such as
+encrypted session data or transitory encrypted flashdata require no
+intervention on your part. However, existing encrypted Sessions will be
+destroyed since data encrypted prior to 2.x will not be decoded.
+
+.. important::
+	**Why only a method to re-encode the data instead of maintaining legacy
+	methods for both encoding and decoding?** The algorithms in the
+	Encryption library have improved in CodeIgniter 2.x both for performance
+	and security, and we do not wish to encourage continued use of the older
+	methods. You can of course extend the Encryption library if you wish and
+	replace the new methods with the old and retain seamless compatibility
+	with CodeIgniter 1.x encrypted data, but this a decision that a
+	developer should make cautiously and deliberately, if at all.
+
+::
+
+	$new_data = $this->encrypt->encode_from_legacy($old_encrypted_string);
+
+======================	===============	 =======================================================================
+Parameter		 Default	  Description
+======================	===============  =======================================================================
+**$orig_data**		n/a 		 The original encrypted data from CodeIgniter 1.x's Encryption library
+**$legacy_mode**	MCRYPT_MODE_ECB	 The Mcrypt mode that was used to generate the original encrypted data.
+					 CodeIgniter 1.x's default was MCRYPT_MODE_ECB, and it will assume that
+					 to be the case unless overridden by this parameter.
+**$key**		n/a 		 The encryption key. This it typically specified in your config file as
+					 outlined above.
+======================	===============	 =======================================================================
\ No newline at end of file
diff --git a/user_guide_src/source/libraries/encryption.rst b/user_guide_src/source/libraries/encryption.rst
deleted file mode 100644
index a38122203..000000000
--- a/user_guide_src/source/libraries/encryption.rst
+++ /dev/null
@@ -1,164 +0,0 @@
-################
-Encryption Class
-################
-
-The Encryption Class provides two-way data encryption. It uses a scheme
-that either compiles the message using a randomly hashed bitwise XOR
-encoding scheme, or is encrypted using the Mcrypt library. If Mcrypt is
-not available on your server the encoded message will still provide a
-reasonable degree of security for encrypted sessions or other such
-"light" purposes. If Mcrypt is available, you'll be provided with a high
-degree of security appropriate for storage.
-
-Setting your Key
-================
-
-A *key* is a piece of information that controls the cryptographic
-process and permits an encrypted string to be decoded. In fact, the key
-you chose will provide the **only** means to decode data that was
-encrypted with that key, so not only must you choose the key carefully,
-you must never change it if you intend use it for persistent data.
-
-It goes without saying that you should guard your key carefully. Should
-someone gain access to your key, the data will be easily decoded. If
-your server is not totally under your control it's impossible to ensure
-key security so you may want to think carefully before using it for
-anything that requires high security, like storing credit card numbers.
-
-To take maximum advantage of the encryption algorithm, your key should
-be 32 characters in length (256 bits). The key should be as random a
-string as you can concoct, with numbers and uppercase and lowercase
-letters. Your key should **not** be a simple text string. In order to be
-cryptographically secure it needs to be as random as possible.
-
-Your key can be either stored in your **application/config/config.php**, or
-you can design your own storage mechanism and pass the key dynamically
-when encoding/decoding.
-
-To save your key to your **application/config/config.php**, open the file
-and set::
-
-	$config['encryption_key'] = "YOUR KEY";
-
-Message Length
-==============
-
-It's important for you to know that the encoded messages the encryption
-function generates will be approximately 2.6 times longer than the
-original message. For example, if you encrypt the string "my super
-secret data", which is 21 characters in length, you'll end up with an
-encoded string that is roughly 55 characters (we say "roughly" because
-the encoded string length increments in 64 bit clusters, so it's not
-exactly linear). Keep this information in mind when selecting your data
-storage mechanism. Cookies, for example, can only hold 4K of
-information.
-
-Initializing the Class
-======================
-
-Like most other classes in CodeIgniter, the Encryption class is
-initialized in your controller using the **$this->load->library** function::
-
-	$this->load->library('encrypt');
-
-Once loaded, the Encrypt library object will be available using:
-$this->encrypt
-
-$this->encrypt->encode()
-========================
-
-Performs the data encryption and returns it as a string. Example::
-
-	$msg = 'My secret message';
-
-	$encrypted_string = $this->encrypt->encode($msg);
-	
-
-You can optionally pass your encryption key via the second parameter if
-you don't want to use the one in your config file::
-
-	$msg = 'My secret message';
-	$key = 'super-secret-key';
-
-	$encrypted_string = $this->encrypt->encode($msg, $key);
-
-$this->encrypt->decode()
-========================
-
-Decrypts an encoded string. Example::
-
-	$encrypted_string = 'APANtByIGI1BpVXZTJgcsAG8GZl8pdwwa84';
-
-	$plaintext_string = $this->encrypt->decode($encrypted_string);
-
-You can optionally pass your encryption key via the second parameter if
-you don't want to use the one in your config file::
-
-	$msg = 'My secret message';
-	$key = 'super-secret-key';
-
-	$encrypted_string = $this->encrypt->decode($msg, $key);
-
-$this->encrypt->set_cipher();
-==============================
-
-Permits you to set an Mcrypt cipher. By default it uses
-**MCRYPT_RIJNDAEL_256**. Example::
-
-	$this->encrypt->set_cipher(MCRYPT_BLOWFISH);
-
-Please visit php.net for a list of `available
-ciphers <http://php.net/mcrypt>`_.
-
-If you'd like to manually test whether your server supports Mcrypt you
-can use::
-
-	echo ( ! function_exists('mcrypt_encrypt')) ? 'Nope' : 'Yup';
-
-$this->encrypt->set_mode();
-============================
-
-Permits you to set an Mcrypt mode. By default it uses **MCRYPT_MODE_CBC**.
-Example::
-
-	$this->encrypt->set_mode(MCRYPT_MODE_CFB);
-
-Please visit php.net for a list of `available
-modes <http://php.net/mcrypt>`_.
-
-$this->encrypt->encode_from_legacy($orig_data, $legacy_mode = MCRYPT_MODE_ECB, $key = '');
-==========================================================================================
-
-Enables you to re-encode data that was originally encrypted with
-CodeIgniter 1.x to be compatible with the Encryption library in
-CodeIgniter 2.x. It is only necessary to use this method if you have
-encrypted data stored permanently such as in a file or database and are
-on a server that supports Mcrypt. "Light" use encryption such as
-encrypted session data or transitory encrypted flashdata require no
-intervention on your part. However, existing encrypted Sessions will be
-destroyed since data encrypted prior to 2.x will not be decoded.
-
-.. important::
-	**Why only a method to re-encode the data instead of maintaining legacy
-	methods for both encoding and decoding?** The algorithms in the
-	Encryption library have improved in CodeIgniter 2.x both for performance
-	and security, and we do not wish to encourage continued use of the older
-	methods. You can of course extend the Encryption library if you wish and
-	replace the new methods with the old and retain seamless compatibility
-	with CodeIgniter 1.x encrypted data, but this a decision that a
-	developer should make cautiously and deliberately, if at all.
-
-::
-
-	$new_data = $this->encrypt->encode_from_legacy($old_encrypted_string);
-
-======================	===============	 =======================================================================
-Parameter		 Default	  Description
-======================	===============  =======================================================================
-**$orig_data**		n/a 		 The original encrypted data from CodeIgniter 1.x's Encryption library
-**$legacy_mode**	MCRYPT_MODE_ECB	 The Mcrypt mode that was used to generate the original encrypted data.
-					 CodeIgniter 1.x's default was MCRYPT_MODE_ECB, and it will assume that
-					 to be the case unless overridden by this parameter.
-**$key**		n/a 		 The encryption key. This it typically specified in your config file as
-					 outlined above.
-======================	===============	 =======================================================================
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 8e20216f25624524d7d6e0322e85e6ccb47e3778 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Wed, 5 Feb 2014 18:59:55 +0200
Subject: More CI_Encryption improvements

 - Make OpenSSL the default driver if available (because MCrypt is stupid).
 - Require MCRYPT_DEV_URANDOM for the MCrypt availability check
   (because security; also, incidentally - it's faster that way ;)).
---
 user_guide_src/source/installation/upgrade_300.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst
index 94385978e..a88d34e39 100644
--- a/user_guide_src/source/installation/upgrade_300.rst
+++ b/user_guide_src/source/installation/upgrade_300.rst
@@ -340,9 +340,10 @@ Following numerous vulnerability reports, the :doc:`Encrypt Library <../librarie
 been deprecated and a new, :doc:`Encryption Library <../libraries/encryption>` is added to take
 its place.
 
-The new library requires either the `MCrypt extension <http://php.net/mcrypt>`_ or PHP 5.3.3 and
-the `OpenSSL extension <http://php.net/openssl>`_. While this might be rather inconvenient, it is
-a requirement that allows us to have properly implemented cryptographic functions.
+The new library requires either the `MCrypt extension <http://php.net/mcrypt>`_ (and /dev/urandom
+availability) or PHP 5.3.3 and the `OpenSSL extension <http://php.net/openssl>`_.
+While this might be rather inconvenient, it is a requirement that allows us to have properly
+implemented cryptographic functions.
 
 .. note:: The :doc:`Encrypt Library <../libraries/encrypt>` is still available for the purpose
 	of keeping backwards compatibility.
-- 
cgit v1.2.3-24-g4f1b


From f6779f5e2510811a1d4fe39864923226a475f298 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Wed, 5 Feb 2014 23:15:26 +0200
Subject: Fix #2856

---
 user_guide_src/source/changelog.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index c6d42d923..a5839a2e6 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -519,7 +519,7 @@ Bug fixes for 3.0
 -  Fixed a bug (#177) - ``CI_Form_validation::set_value()`` didn't set the default value if POST data is NULL.
 -  Fixed a bug (#68, #414) - Oracle's escape_str() didn't properly escape LIKE wild characters.
 -  Fixed a bug (#81) - ODBC's list_fields() and field_data() methods skipped the first column due to odbc_field_*() functions' index starting at 1 instead of 0.
--  Fixed a bug (#129) - ODBC's num_rows() returned -1 in some cases, due to not all subdrivers supporting the odbc_num_rows() function.
+-  Fixed a bug (#129) - ODBC's ``num_rows()`` method returned -1 in some cases, due to not all subdrivers supporting the ``odbc_num_rows()`` function.
 -  Fixed a bug (#153) - E_NOTICE being generated by getimagesize() in the :doc:`File Uploading Library <libraries/file_uploading>`.
 -  Fixed a bug (#611) - SQLSRV's error handling methods used to issue warnings when there's no actual error.
 -  Fixed a bug (#1036) - ``is_write_type()`` method in the :doc:`Database Library <database/index>` didn't return TRUE for RENAME queries.
@@ -684,6 +684,7 @@ Bug fixes for 3.0
 -  Fixed a bug (#2729) - ``CI_Security::_validate_entities()`` used overly-intrusive ``preg_replace()`` patterns that produced false-positives.
 -  Fixed a bug (#2771) - ``CI_Security::xss_clean()`` didn't take into account HTML5 entities.
 -  Fixed a bug in the :doc:`Session Library <libraries/sessions>` 'cookie' driver where authentication was not performed for encrypted cookies.
+-  Fixed a bug (#2856) - ODBC method ``affected_rows()`` passed an incorrect value to ``odbc_num_rows()``.
 
 Version 2.1.4
 =============
-- 
cgit v1.2.3-24-g4f1b


From 46145faeb1ba56417af53b0aa545ba8437717da6 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Fri, 7 Feb 2014 15:49:06 +0200
Subject: [ci skip] Some adjustments to the Javascript library docs

---
 user_guide_src/source/libraries/javascript.rst | 76 ++++++++++++++++----------
 1 file changed, 48 insertions(+), 28 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/javascript.rst b/user_guide_src/source/libraries/javascript.rst
index 393d4e321..bb901ead9 100644
--- a/user_guide_src/source/libraries/javascript.rst
+++ b/user_guide_src/source/libraries/javascript.rst
@@ -1,31 +1,51 @@
-.. note:: This driver is experimental. Its feature set and
-	implementation may change in future releases.
-
 ################
 Javascript Class
 ################
 
+.. note:: This driver is experimental. Its feature set and
+	implementation may change in future releases.
+
 CodeIgniter provides a library to help you with certain common functions
 that you may want to use with Javascript. Please note that CodeIgniter
 does not require the jQuery library to run, and that any scripting
 library will work equally well. The jQuery library is simply presented
 as a convenience if you choose to use it.
 
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
+
+**************************
+Using the Javascript Class
+**************************
+
 Initializing the Class
 ======================
 
 To initialize the Javascript class manually in your controller
-constructor, use the $this->load->library function. Currently, the only
-available library is jQuery, which will automatically be loaded like
-this::
+constructor, use the ``$this->load->library()`` method. Currently,
+the only available library is jQuery, which will automatically be
+loaded like this::
 
 	$this->load->library('javascript');
 
-The Javascript class also accepts parameters, js_library_driver
-(string) default 'jquery' and autoload (bool) default TRUE. You may
-override the defaults if you wish by sending an associative array::
+The Javascript class also accepts parameters:
+
+- js_library_driver (string) *default: 'jquery'*
+- autoload (bool) *default: TRUE*
 
-	$this->load->library('javascript', array('js_library_driver' => 'scripto', 'autoload' => FALSE));
+You may override the defaults by sending an associative array::
+
+	$this->load->library(
+		'javascript',
+		array(
+			'js_library_driver' => 'scripto',
+			'autoload' => FALSE
+		)
+	);
 
 Again, presently only 'jquery' is available. You may wish to set
 autoload to FALSE, though, if you do not want the jQuery library to
@@ -34,7 +54,8 @@ is useful if you are loading it from a location outside of CodeIgniter,
 or already have the script tag in your markup.
 
 Once loaded, the jQuery library object will be available using:
-$this->javascript
+
+	$this->javascript
 
 Setup and Configuration
 =======================
@@ -47,8 +68,8 @@ application.
 
 As Javascript is a client side language, the library must be able to
 write content into your final output. This generally means a view.
-You'll need to include the following variables in the <head> sections of
-your output.
+You'll need to include the following variables in the ``<head>``
+sections of your output.
 
 ::
 
@@ -56,17 +77,17 @@ your output.
 	<?php echo $script_head;?>
 
 
-$library_src, is where the actual library file will be loaded, as well
-as any subsequent plugin script calls; $script_head is where specific
-events, functions and other commands will be rendered.
+``$library_src``, is where the actual library file will be loaded, as
+well as any subsequent plugin script calls; $script_head is where
+specific events, functions and other commands will be rendered.
 
 Set the path to the librarys with config items
 ----------------------------------------------
 
 There are some configuration items in Javascript library. These can
-either be set in application/config.php, within its own
-config/javascript.php file, or within any controller usings the
-set_item() function.
+either be set in *application/config.php*, within its own
+*config/javascript.php* file, or within any controller usings the
+``set_item()`` function.
 
 An image to be used as an "ajax loader", or progress indicator. Without
 one, the simple text message of "loading" will appear when Ajax calls
@@ -84,7 +105,7 @@ The jQuery Class
 ================
 
 To initialize the jQuery class manually in your controller constructor,
-use the $this->load->library function::
+use the ``$this->load->library()`` method::
 
 	$this->load->library('javascript/jquery');
 
@@ -96,30 +117,29 @@ library as follows::
 	$this->load->library('javascript/jquery', FALSE);
 
 Once loaded, the jQuery library object will be available using:
-$this->jquery
+
+	$this->jquery
 
 jQuery Events
 =============
 
 Events are set using the following syntax.
-
 ::
 
 	$this->jquery->event('element_path', code_to_run());
 
-
 In the above example:
 
 -  "event" is any of blur, change, click, dblclick, error, focus, hover,
    keydown, keyup, load, mousedown, mouseup, mouseover, mouseup, resize,
    scroll, or unload.
--  "element_path" is any valid `jQuery
-   selector <http://docs.jquery.com/Selectors>`_. Due to jQuery's unique
+-  "element_path" is any valid `jQuery selector
+   <http://docs.jquery.com/Selectors>`_. Due to jQuery's unique
    selector syntax, this is usually an element id, or CSS selector. For
-   example "#notice_area" would effect <div id="notice_area">, and
+   example "#notice_area" would effect ``<div id="notice_area">``, and
    "#content a.notice" would effect all anchors with a class of "notice"
    in the div with id "content".
--  "code_to_run()" is script your write yourself, or an action such as
+-  "``code_to_run()``" is script your write yourself, or an action such as
    an effect from the jQuery library below.
 
 Effects
@@ -298,4 +318,4 @@ description to come
 calendar()
 ----------
 
-description to come
+description to come
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 1e41136bdb4fad4d81ebf892240bb72bee73ef03 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Fri, 7 Feb 2014 15:53:02 +0200
Subject: [ci skip] Replace :php:func: usage with just :func:

---
 user_guide_src/source/changelog.rst                | 10 +++++-----
 user_guide_src/source/documentation/index.rst      | 16 ++++++++--------
 user_guide_src/source/installation/upgrade_300.rst |  2 +-
 3 files changed, 14 insertions(+), 14 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 6854c9f8c..4fedc83ff 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -133,7 +133,7 @@ Release Date: Not Released
       - Added *filename* to the returned array elements.
 
    -  :doc:`Directory Helper <helpers/directory_helper>` :func:`directory_map()` will now append ``DIRECTORY_SEPARATOR`` to directory names in the returned array.
-   -  :doc:`Array Helper <helpers/array_helper>` :func:`element()` and :php:func:`elements()` now return NULL instead of FALSE when the required elements don't exist.
+   -  :doc:`Array Helper <helpers/array_helper>` :func:`element()` and :func:`elements()` now return NULL instead of FALSE when the required elements don't exist.
    -  :doc:`Language Helper <helpers/language_helper>` :func:`lang()` now accepts an optional list of additional HTML attributes.
    -  Changed the default tag for use in :doc:`Text Helper <helpers/text_helper>` :func:`highlight_phrase()` to ``<mark>`` (formerly ``<strong>``).
    -  Deprecated the :doc:`Email Helper <helpers/email_helper>` as its ``valid_email()``, ``send_email()`` functions are now only aliases for PHP native functions ``filter_var()`` and ``mail()`` respectively.
@@ -439,7 +439,7 @@ Release Date: Not Released
       -  Added method ``post_get()`` and changed ``get_post()`` to search in GET data first. Both methods' names now properly match their GET/POST data search priorities.
       -  Changed method ``_fetch_from_array()`` to parse array notation in field name.
       -  Added an option for ``_clean_input_keys()`` to return FALSE instead of terminating the whole script.
-      -  Deprecated the ``is_cli_request()`` method, it is now an alias for the new :php:func:`is_cli()` common function.
+      -  Deprecated the ``is_cli_request()`` method, it is now an alias for the new :func:`is_cli()` common function.
 
    -  :doc:`Common functions <general/common_functions>` changes include:
 
@@ -656,11 +656,11 @@ Bug fixes for 3.0
 -  Fixed a bug (#249) - :doc:`Cache Library <libraries/caching>` didn't properly handle Memcache(d) configurations with missing options.
 -  Fixed a bug (#180) - :func:`config_item()` didn't take into account run-time configuration changes.
 -  Fixed a bug (#2551) - :doc:`Loader Library <libraries/loader>` method ``library()`` didn't properly check if a class that is being loaded already exists.
--  Fixed a bug (#2560) - :doc:`Form Helper <helpers/form_helper>` function :php:func:`form_open()` set the 'method="post"' attribute only if the passed attributes equaled an empty string.
+-  Fixed a bug (#2560) - :doc:`Form Helper <helpers/form_helper>` function :func:`form_open()` set the 'method="post"' attribute only if the passed attributes equaled an empty string.
 -  Fixed a bug (#2585) - :doc:`Query Builder <database/query_builder>` methods ``min()``, ``max()``, ``avg()``, ``sum()`` didn't escape field names.
 -  Fixed an edge case (#2583) in the :doc:`Email Library <libraries/email>` where `Suhosin <http://www.hardened-php.net/suhosin/>` blocked messages sent via ``mail()`` due to trailing newspaces in headers.
--  Fixed a bug (#2590) - :php:func:`log_message()` didn't actually cache the ``CI_Log`` class instance.
--  Fixed a bug (#2609) - :php:func:`get_config()` optional argument was only effective on first function call. Also, it can now add items, in addition to updating existing items.
+-  Fixed a bug (#2590) - :func:`log_message()` didn't actually cache the ``CI_Log`` class instance.
+-  Fixed a bug (#2609) - :func:`get_config()` optional argument was only effective on first function call. Also, it can now add items, in addition to updating existing items.
 -  Fixed a bug in the 'postgre' :doc:`database <database/index>` driver where the connection ID wasn't passed to ``pg_escape_string()``.
 -  Fixed a bug (#33) - Script execution was terminated when an invalid cookie key was encountered.
 -  Fixed a bug (#2681) - ``CI_Security::entity_decode()`` used the `PREG_REPLACE_EVAL` flag, which is deprecated since PHP 5.5.
diff --git a/user_guide_src/source/documentation/index.rst b/user_guide_src/source/documentation/index.rst
index 43afe6fd3..b080c0efa 100644
--- a/user_guide_src/source/documentation/index.rst
+++ b/user_guide_src/source/documentation/index.rst
@@ -127,7 +127,7 @@ ReST:
 			:param mixed $bar: A data array that must contain aa something and something else
 			:param bool $bat: whether or not to do something
 			:returns: FALSE on failure, TRUE if successful
-			:rtype: Boolean
+			:rtype: bool
 
 			::
 
@@ -148,13 +148,13 @@ ReST:
 			.. note:: Here is something that you should be aware of when using some_method().
 					For real.
 
-			See also :php:meth:`Some_class::should_do_something`
+			See also :meth:`Some_class::should_do_something`
 
 
 		.. method:: should_do_something()
 
-			:returns: whether or something should be done or not
-			:rtype: Boolean
+			:returns: Whether or something should be done or not
+			:rtype: bool
 
 
 It creates the following display:
@@ -172,7 +172,7 @@ It creates the following display:
 		:param mixed $bar: A data array that must contain aa something and something else
 		:param bool $bat: whether or not to do something
 		:returns: FALSE on failure, TRUE if successful
-		:rtype: Boolean
+		:rtype: bool
 
 		::
 
@@ -193,10 +193,10 @@ It creates the following display:
 		.. note:: Here is something that you should be aware of when using some_method().
 				For real.
 
-		See also :php:meth:`Some_class::should_do_something`
+		See also :meth:`Some_class::should_do_something`
 
 
 	.. method:: should_do_something()
 
-		:returns: whether or something should be done or not
-		:rtype: Boolean
+		:returns: Whether or something should be done or not
+		:rtype: bool
\ No newline at end of file
diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst
index b89d4e35b..3f96a31e2 100644
--- a/user_guide_src/source/installation/upgrade_300.rst
+++ b/user_guide_src/source/installation/upgrade_300.rst
@@ -538,7 +538,7 @@ Input library method is_cli_request()
 Calls to the ``CI_Input::is_cli_request()`` method are necessary at many places
 in the CodeIgniter internals and this is often before the :doc:`Input Library
 <../libraries/input>` is loaded. Because of that, it is being replaced by a common
-function named :php:func:`is_cli()` and this method is now just an alias.
+function named :func:`is_cli()` and this method is now just an alias.
 
 The new function is both available at all times for you to use and shorter to type.
 
-- 
cgit v1.2.3-24-g4f1b


From 269021416e5be273f9510357c1994b63f77e1c64 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Fri, 7 Feb 2014 18:16:09 +0200
Subject: [ci skip] Re-format changelog entries

---
 user_guide_src/source/changelog.rst | 185 ++++++++++++++++++------------------
 1 file changed, 92 insertions(+), 93 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 4fedc83ff..e40e64acd 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -494,134 +494,133 @@ Bug fixes for 3.0
 ------------------
 
 -  Fixed a bug where ``unlink()`` raised an error if cache file did not exist when you try to delete it.
--  Fixed a bug (#181) where a mis-spelling was in the form validation language file.
--  Fixed a bug (#159, #163) - :doc:`Query Builder <database/query_builder>` nested transactions didn't work properly due to ``_trans_depth`` not being incremented.
+-  Fixed a bug (#181) - a typo in the form validation language file.
+-  Fixed a bug (#159, #163) - :doc:`Query Builder <database/query_builder>` nested transactions didn't work properly due to ``$_trans_depth`` not being incremented.
 -  Fixed a bug (#737, #75) - :doc:`Pagination <libraries/pagination>` anchor class was not set properly when using initialize method.
--  Fixed a bug (#419) - :func:`auto_link()` didn't recognize URLs that come after a word boundary.
+-  Fixed a bug (#419) - :doc:`URL Helper <helpers/url_helper>` :func:`auto_link()` didn't recognize URLs that come after a word boundary.
 -  Fixed a bug (#724) - :doc:`Form Validation Library <libraries/form_validation>` rule **is_unique** didn't check if a database connection exists.
 -  Fixed a bug (#647) - :doc:`Zip Library <libraries/zip>` internal method ``_get_mod_time()`` didn't suppress possible "stat failed" errors generated by ``filemtime()``.
 -  Fixed a bug (#157, #174) - :doc:`Image Manipulation Library <libraries/image_lib>` method ``clear()`` didn't completely clear properties.
 -  Fixed a bug where :doc:`Database Forge <database/forge>` method ``create_table()`` with PostgreSQL database could lead to fetching the whole table.
 -  Fixed a bug (#795) - :doc:`Form Helper <helpers/form_helper>` :func:`form_open()` didn't add the default form *method* and *accept-charset* when an empty array is passed to it.
--  Fixed a bug (#797) - :func:`timespan()` was using incorrect seconds for year and month.
--  Fixed a bug in CI_Cart::contents() where if called without a TRUE (or equal) parameter, it would fail due to a typo.
--  Fixed a bug (#696) - make oci_execute() calls inside num_rows() non-committing, since they are only there to reset which row is next in line for oci_fetch calls and thus don't need to be committed.
+-  Fixed a bug (#797) - :doc:`Date Helper <helpers/date_helper>` :func:`timespan()` was using incorrect seconds for year and month.
+-  Fixed a bug in :doc:`Cart Library <libraries/cart>` method ``contents()`` where if called without a TRUE (or equal) parameter, it would fail due to a typo.
+-  Fixed a bug (#696) - make ``oci_execute()`` calls inside ``num_rows()`` non-committing, since they are only there to reset which row is next in line for oci_fetch calls and thus don't need to be committed.
 -  Fixed a bug (#406) - SQLSRV DB driver not returning resource on ``db_pconnect()``.
--  Fixed a bug in CI_Image_lib::gd_loaded() where it was possible for the script execution to end or a PHP E_WARNING message to be emitted.
+-  Fixed a bug in :doc:`Image Manipulation Library <libraries/image_lib>` method ``gd_loaded()`` where it was possible for the script execution to end or a PHP E_WARNING message to be emitted.
 -  Fixed a bug in the :doc:`Pagination library <libraries/pagination>` where when use_page_numbers=TRUE previous link and page 1 link did not have the same url.
--  Fixed a bug (#561) - Errors in :doc:`XML-RPC Library <libraries/xmlrpc>` were not properly escaped.
--  Fixed a bug (#904) - ``CI_Loader::initialize()`` caused a PHP Fatal error to be triggered if error level E_STRICT is used.
--  Fixed a hosting edge case where an empty $_SERVER['HTTPS'] variable would evaluate to 'on'.
--  Fixed a bug (#154) - ``CI_Session::sess_update()`` caused the session to be destroyed on pages where multiple AJAX requests were executed at once.
--  Fixed a possible bug in ``CI_Input::is_ajax_request()`` where some clients might not send the X-Requested-With HTTP header value exactly as 'XmlHttpRequest'.
--  Fixed a bug (#1039) - MySQL's _backup() method failed due to a table name not being escaped.
--  Fixed a bug (#1070) - CI_DB_driver::initialize() didn't set a character set if a database is not selected.
--  Fixed a bug (#177) - ``CI_Form_validation::set_value()`` didn't set the default value if POST data is NULL.
--  Fixed a bug (#68, #414) - Oracle's escape_str() didn't properly escape LIKE wild characters.
--  Fixed a bug (#81) - ODBC's list_fields() and field_data() methods skipped the first column due to odbc_field_*() functions' index starting at 1 instead of 0.
+-  Fixed a bug (#561) - errors in :doc:`XML-RPC Library <libraries/xmlrpc>` were not properly escaped.
+-  Fixed a bug (#904) - :doc:`Loader Library <libraries/loader>` method ``initialize()`` caused a PHP Fatal error to be triggered if error level E_STRICT is used.
+-  Fixed a hosting edge case where an empty ``$_SERVER['HTTPS']`` variable would evaluate to 'on'.
+-  Fixed a bug (#154) - :doc:`Session Library <libraries/sessions>` method ``sess_update()`` caused the session to be destroyed on pages where multiple AJAX requests were executed at once.
+-  Fixed a possible bug in :doc:`Input Libary <libraries/input>` method ``is_ajax_request()`` where some clients might not send the X-Requested-With HTTP header value exactly as 'XmlHttpRequest'.
+-  Fixed a bug (#1039) - :doc:`Database Utilities <database/utilities>` internal method ``_backup()`` method failed for the 'mysql' driver due to a table name not being escaped.
+-  Fixed a bug (#1070) - ``CI_DB_driver::initialize()`` didn't set a character set if a database is not selected.
+-  Fixed a bug (#177) - :doc:`Form Validation Library <libraries/form_validation>`` method ``set_value()`` didn't set the default value if POST data is NULL.
+-  Fixed a bug (#68, #414) - :Oracle's ``escape_str()`` didn't properly escape LIKE wild characters.
+-  Fixed a bug (#81) - ODBC's ``list_fields()`` and ``field_data()`` methods skipped the first column due to ``odbc_field_*()`` functions' index starting at 1 instead of 0.
 -  Fixed a bug (#129) - ODBC's ``num_rows()`` method returned -1 in some cases, due to not all subdrivers supporting the ``odbc_num_rows()`` function.
--  Fixed a bug (#153) - E_NOTICE being generated by getimagesize() in the :doc:`File Uploading Library <libraries/file_uploading>`.
+-  Fixed a bug (#153) - E_NOTICE being generated by ``getimagesize()`` in the :doc:`File Uploading Library <libraries/file_uploading>`.
 -  Fixed a bug (#611) - SQLSRV's error handling methods used to issue warnings when there's no actual error.
 -  Fixed a bug (#1036) - ``is_write_type()`` method in the :doc:`Database Library <database/index>` didn't return TRUE for RENAME queries.
--  Fixed a bug in PDO's _version() method where it used to return the client version as opposed to the server one.
--  Fixed a bug in PDO's insert_id() method where it could've failed if it's used with Postgre versions prior to 8.1.
--  Fixed a bug in CUBRID's affected_rows() method where a connection resource was passed to cubrid_affected_rows() instead of a result.
--  Fixed a bug (#638) - db_set_charset() ignored its arguments and always used the configured charset instead.
+-  Fixed a bug in PDO's ``_version()`` method where it used to return the client version as opposed to the server one.
+-  Fixed a bug in PDO's ``insert_id()`` method where it could've failed if it's used with Postgre versions prior to 8.1.
+-  Fixed a bug in CUBRID's ``affected_rows()`` method where a connection resource was passed to ``cubrid_affected_rows()`` instead of a result.
+-  Fixed a bug (#638) - ``db_set_charset()`` ignored its arguments and always used the configured charset instead.
 -  Fixed a bug (#413) - Oracle's error handling methods used to only return connection-related errors.
--  Fixed a bug (#1101) - MySQL/MySQLi result method field_data() was implemented as if it was handling a DESCRIBE result instead of the actual result set.
--  Fixed a bug in Oracle's :doc:`Database Forge Class <database/forge>` method _create_table() where it failed with AUTO_INCREMENT as it's not supported.
--  Fixed a bug (#1080) - When using the SMTP protocol, the :doc:`Email Library <libraries/email>` send() method was returning TRUE even if the connection/authentication against the server failed.
--  Fixed a bug (#306) - ODBC's insert_id() method was calling non-existent function odbc_insert_id(), which resulted in a fatal error.
--  Fixed a bug in Oracle's DB_result class where the cursor id passed to it was always NULL.
--  Fixed a bug (#64) - Regular expression in DB_query_builder.php failed to handle queries containing SQL bracket delimiters in the join condition.
--  Fixed a bug in the :doc:`Session Library <libraries/sessions>` where a PHP E_NOTICE error was triggered by _unserialize() due to results from databases such as MSSQL and Oracle being space-padded on the right.
--  Fixed a bug (#501) - set_rules() to check if the request method is not 'POST' before aborting, instead of depending on count($_POST) in the :doc:`Form Validation Library <libraries/form_validation>`.
--  Fixed a bug (#136) - PostgreSQL, MySQL and MySQLi's escape_str() method didn't properly escape LIKE wild characters.
--  Fixed a bug in the library loader where some PHP versions wouldn't execute the class constructor.
+-  Fixed a bug (#1101) - :doc:`Database Result <database/results>` method ``field_data()`` for 'mysql', 'mysqli' drivers was implemented as if it was handling a DESCRIBE result instead of the actual result set.
+-  Fixed a bug in Oracle's :doc:`Database Forge <database/forge>` method ``_create_table()`` where it failed with AUTO_INCREMENT as it's not supported.
+-  Fixed a bug (#1080) - when using the SMTP protocol, :doc:`Email Library <libraries/email>` method ``send()`` was returning TRUE even if the connection/authentication against the server failed.
+-  Fixed a bug (#306) - ODBC's ``insert_id()`` method was calling non-existent function ``odbc_insert_id()``, which resulted in a fatal error.
+-  Fixed a bug in Oracle's :doc:`Database Result <database/results>` implementation where the cursor ID passed to it was always NULL.
+-  Fixed a bug (#64) - Regular expression in *DB_query_builder.php* failed to handle queries containing SQL bracket delimiters in the JOIN condition.
+-  Fixed a bug in the :doc:`Session Library <libraries/sessions>` where a PHP E_NOTICE error was triggered by ``_unserialize()`` due to results from databases such as MSSQL and Oracle being space-padded on the right.
+-  Fixed a bug (#501) - :doc:`Form Validation Library <libraries/form_validation>` method ``set_rules()`` depended on ``count($_POST)`` instead of actually checking if the request method 'POST' before aborting.
+-  Fixed a bug (#136) - PostgreSQL and MySQL's ``escape_str()`` method didn't properly escape LIKE wild characters.
+-  Fixed a bug in :doc:`Loader Library <libraries/loader>` method ``library()`` where some PHP versions wouldn't execute the class constructor.
 -  Fixed a bug (#88) - An unexisting property was used for configuration of the Memcache cache driver.
--  Fixed a bug (#14) - create_database() method in the :doc:`Database Forge Library <database/forge>` didn't utilize the configured database character set.
--  Fixed a bug (#23, #1238) - delete_all() in the `Database Caching Library <database/caching>` used to delete .htaccess and index.html files, which is a potential security risk.
--  Fixed a bug in :doc:`Trackback Library <libraries/trackback>` method validate_url() where it didn't actually do anything, due to input not being passed by reference.
--  Fixed a bug (#11, #183, #863) - CI_Form_validation::_execute() silently continued to the next rule, if a rule method/function is not found.
+-  Fixed a bug (#14) - :doc:`Database Forge <database/forge>` method ``create_database()`` didn't utilize the configured database character set.
+-  Fixed a bug (#23, #1238) - :doc:`Database Caching <database/caching>` method ``delete_all()`` used to delete .htaccess and index.html files, which is a potential security risk.
+-  Fixed a bug in :doc:`Trackback Library <libraries/trackback>` method ``validate_url()`` where it didn't actually do anything, due to input not being passed by reference.
+-  Fixed a bug (#11, #183, #863) - :doc:`Form Validation Library <libraries/form_validation>` method ``_execute()`` silently continued to the next rule, if a rule method/function is not found.
 -  Fixed a bug (#122) - routed URI string was being reported incorrectly in sub-directories.
--  Fixed a bug (#1242) - read_dir() in the :doc:`Zip Library <libraries/zip>` wasn't compatible with Windows.
--  Fixed a bug (#306) - ODBC driver didn't have an _insert_batch() method, which resulted in fatal error being triggered when insert_batch() is used with it.
--  Fixed a bug in MSSQL and SQLSrv's _truncate() where the TABLE keyword was missing.
--  Fixed a bug in PDO's trans_commit() method where it failed due to an erroneous property name.
--  Fixed a bug (#798) - update() used to ignore LIKE conditions that were set with like().
--  Fixed a bug in Oracle's and MSSQL's delete() methods where an erroneous SQL statement was generated when used with limit().
--  Fixed a bug in SQLSRV's delete() method where like() and limit() conditions were ignored.
+-  Fixed a bug (#1241) - :doc:`Zip Library <libraries/zip>` method ``read_dir()`` wasn't compatible with Windows.
+-  Fixed a bug (#306) - ODBC driver didn't have an ``_insert_batch()`` method, which resulted in fatal error being triggered when ``insert_batch()`` is used with it.
+-  Fixed a bug in MSSQL and SQLSrv's ``_truncate()`` where the TABLE keyword was missing.
+-  Fixed a bug in PDO's ``trans_commit()`` method where it failed due to an erroneous property name.
+-  Fixed a bug (#798) - :doc:`Query Builder <database/query_builder>` method ``update()`` used to ignore LIKE conditions that were set with ``like()``.
+-  Fixed a bug in Oracle's and MSSQL's ``delete()`` methods where an erroneous SQL statement was generated when used with ``limit()``.
+-  Fixed a bug in SQLSRV's ``delete()`` method where ``like()`` and ``limit()`` conditions were ignored.
 -  Fixed a bug (#1265) - Database connections were always closed, regardless of the 'pconnect' option value.
 -  Fixed a bug (#128) - :doc:`Language Library <libraries/language>` did not correctly keep track of loaded language files.
--  Fixed a bug (#1242) - Added Windows path compatibility to function read_dir of ZIP library.
--  Fixed a bug (#1349) - get_extension() in the :doc:`File Uploading Library <libraries/file_uploading>` returned the original filename when it didn't have an actual extension.
--  Fixed a bug (#1273) - E_NOTICE being generated by :doc:`Query Builder <database/query_builder>`'s set_update_batch() method.
--  Fixed a bug (#44, #110) - :doc:`Upload library <libraries/file_uploading>`'s clean_file_name() method didn't clear '!' and '#' characters.
--  Fixed a bug (#121) - ``CI_DB_result::row()`` returned an array when there's no actual result to be returned.
--  Fixed a bug (#319) - SQLSRV's affected_rows() method failed due to a scrollable cursor being created for write-type queries.
--  Fixed a bug (#356) - PostgreSQL driver didn't have an _update_batch() method, which resulted in fatal error being triggered when update_batch() is used with it.
+-  Fixed a bug (#1349) - :doc:`File Uploading Library <libraries/file_uploading>` method ``get_extension()`` returned the original filename when it didn't have an actual extension.
+-  Fixed a bug (#1273) - :doc:`Query Builder <database/query_builder>` method ``set_update_batch()`` generated an E_NOTICE message.
+-  Fixed a bug (#44, #110) - :doc:`File Uploading Library <libraries/file_uploading>` method ``clean_file_name()`` didn't clear '!' and '#' characters.
+-  Fixed a bug (#121) - :doc:`Database Results <database/results>` method ``row()`` returned an array when there's no actual result to be returned.
+-  Fixed a bug (#319) - SQLSRV's ``affected_rows()`` method failed due to a scrollable cursor being created for write-type queries.
+-  Fixed a bug (#356) - :doc:`Database <database/index>` driver 'postgre' didn't have an ``_update_batch()`` method, which resulted in fatal error being triggered when ``update_batch()`` is used with it.
 -  Fixed a bug (#784, #862) - :doc:`Database Forge <database/forge>` method ``create_table()`` failed on SQLSRV/MSSQL when used with 'IF NOT EXISTS'.
--  Fixed a bug (#1419) - libraries/Driver.php had a static variable that was causing an error.
--  Fixed a bug (#1411) - the :doc:`Email library <libraries/email>` used its own short list of MIMEs instead the one from config/mimes.php.
--  Fixed a bug where the magic_quotes_runtime setting wasn't turned off for PHP 5.3 (where it is indeed deprecated, but not non-existent).
--  Fixed a bug (#666) - :doc:`Output library <libraries/output>`'s set_content_type() method didn't set the document charset.
+-  Fixed a bug (#1419) - :doc:`Driver Library <general/creating_drivers>` had a static variable that was causing an error.
+-  Fixed a bug (#1411) - the :doc:`Email Library <libraries/email>` used its own short list of MIMEs instead the one from *config/mimes.php*.
+-  Fixed a bug where php.ini setting *magic_quotes_runtime* wasn't turned off for PHP 5.3 (where it is indeed deprecated, but not non-existent).
+-  Fixed a bug (#666) - :doc:`Output Library <libraries/output>` method ``set_content_type()`` didn't set the document charset.
 -  Fixed a bug (#784, #861) - :doc:`Database Forge <database/forge>` method ``create_table()`` used to accept constraints for MSSQL/SQLSRV integer-type columns.
--  Fixed a bug (#706) - SQLSRV/MSSSQL didn't escape field names.
--  Fixed a bug (#1452) - ``protect_identifiers()`` didn't properly detect identifiers with spaces in their names.
--  Fixed a bug where ``protect_identifiers()`` ignored its extra arguments when the value passed to it is an array.
--  Fixed a bug where ``_has_operator()`` didn't detect BETWEEN.
--  Fixed a bug in :doc:`Query Builder <database/query_builder>`'s ``join()`` method where it failed with identifiers containing dashes.
+-  Fixed a bug (#706) - SQLSRV/MSSSQL :doc:`Database <database/index>` drivers didn't escape field names.
+-  Fixed a bug (#1452) - :doc:`Query Builder <database/query_builder>` method ``protect_identifiers()`` didn't properly detect identifiers with spaces in their names.
+-  Fixed a bug where :doc:`Query Builder <database/query_builder>` method ``protect_identifiers()`` ignored its extra arguments when the value passed to it is an array.
+-  Fixed a bug where :doc:`Query Builder <database/query_builder>` internal method ``_has_operator()`` didn't detect BETWEEN.
+-  Fixed a bug where :doc:`Query Builder <database/query_builder>` method ``join()`` failed with identifiers containing dashes.
 -  Fixed a bug (#1264) - :doc:`Database Forge <database/forge>` and :doc:`Database Utilities <database/utilities>` didn't update/reset the databases and tables list cache when a table or a database is created, dropped or renamed.
--  Fixed a bug (#7) - :doc:`Query Builder <database/query_builder>`'s ``join()`` method only escaped one set of conditions.
--  Fixed a bug (#1321) - Core Exceptions class couldn't find the errors/ folder in some cases.
--  Fixed a bug (#1202) - :doc:`Encryption Library <libraries/encryption>` encode_from_legacy() didn't set back the encrypt mode on failure.
--  Fixed a bug (#145) - compile_binds() failed when the bind marker was present in a literal string within the query.
--  Fixed a bug in protect_identifiers() where if passed along with the field names, operators got escaped as well.
--  Fixed a bug (#10) - :doc:`URI Library <libraries/uri>` internal method _detect_uri() failed with paths containing a colon.
--  Fixed a bug (#1387) - :doc:`Query Builder <database/query_builder>`'s from() method didn't escape table aliases.
--  Fixed a bug (#520) - :doc:`Date Helper <helpers/date_helper>` function nice_date() failed when the optional second parameter is not passed.
+-  Fixed a bug (#7) - :doc:`Query Builder <database/query_builder>` method ``join()`` only escaped one set of conditions.
+-  Fixed a bug (#1321) - ``CI_Exceptions`` couldn't find the *errors/* directory in some cases.
+-  Fixed a bug (#1202) - :doc:`Encryption Library <libraries/encryption>` ``encode_from_legacy()`` didn't set back the encrypt mode on failure.
+-  Fixed a bug (#145) - :doc:`Database Class <database/index>` method ``compile_binds()`` failed when the bind marker was present in a literal string within the query.
+-  Fixed a bug in :doc:`Query Builder <database/query_builder>` method ``protect_identifiers()`` where if passed along with the field names, operators got escaped as well.
+-  Fixed a bug (#10) - :doc:`URI Library <libraries/uri>` internal method ``_detect_uri()`` failed with paths containing a colon.
+-  Fixed a bug (#1387) - :doc:`Query Builder <database/query_builder>` method ``from()`` didn't escape table aliases.
+-  Fixed a bug (#520) - :doc:`Date Helper <helpers/date_helper>` function :func:``nice_date()`` failed when the optional second parameter is not passed.
 -  Fixed a bug (#167) - ``$config['permitted_uri_chars']`` didn't affect URL-encoded characters.
--  Fixed a bug (#318) - :doc:`Profiling <general/profiling>` setting *query_toggle_count* was not settable as described in the manual.
+-  Fixed a bug (#318) - :doc:`Profiling Library <general/profiling>` setting *query_toggle_count* was not settable as described in the manual.
 -  Fixed a bug (#938) - :doc:`Config Library <libraries/config>` method ``site_url()`` added a question mark to the URL string when query strings are enabled even if it already existed.
 -  Fixed a bug (#999) - :doc:`Config Library <libraries/config>` method ``site_url()`` always appended ``$config['url_suffix']`` to the end of the URL string, regardless of whether a query string exists in it.
--  Fixed a bug where :doc:`URL Helper <helpers/url_helper>` function ``anchor_popup()`` ignored the attributes argument if it is not an array.
+-  Fixed a bug where :doc:`URL Helper <helpers/url_helper>` function :func:`anchor_popup()` ignored the attributes argument if it is not an array.
 -  Fixed a bug (#1328) - :doc:`Form Validation Library <libraries/form_validation>` didn't properly check the type of the form fields before processing them.
 -  Fixed a bug (#79) - :doc:`Form Validation Library <libraries/form_validation>` didn't properly validate array fields that use associative keys or have custom indexes.
 -  Fixed a bug (#427) - :doc:`Form Validation Library <libraries/form_validation>` method ``strip_image_tags()`` was an alias to a non-existent method.
 -  Fixed a bug (#1545) - :doc:`Query Builder <database/query_builder>` method ``limit()`` wasn't executed properly under Oracle.
--  Fixed a bug (#1551) - :doc:`Date Helper <helpers/date_helper>` function ``standard_date()`` didn't properly format *W3C* and *ATOM* standard dates.
--  Fixed a bug in :doc:`Query Builder <database/query_builder>` method join() where literal values were escaped as if they were fields.
+-  Fixed a bug (#1551) - :doc:`Date Helper <helpers/date_helper>` function :func:`standard_date()` didn't properly format *W3C* and *ATOM* standard dates.
+-  Fixed a bug where :doc:`Query Builder <database/query_builder>` method ``join()`` escaped literal values as if they were fields.
 -  Fixed a bug (#135) - PHP Error logging was impossible without the errors being displayed.
--  Fixed a bug (#1613) - :doc:`Form Helper <helpers/form_helper>` functions ``form_multiselect()``, ``form_dropdown()`` didn't properly handle empty array option groups.
+-  Fixed a bug (#1613) - :doc:`Form Helper <helpers/form_helper>` functions :func:`form_multiselect()`, :func:`form_dropdown()` didn't properly handle empty array option groups.
 -  Fixed a bug (#1605) - :doc:`Pagination Library <libraries/pagination>` produced incorrect *previous* and *next* link values.
 -  Fixed a bug in SQLSRV's ``affected_rows()`` method where an erroneous function name was used.
 -  Fixed a bug (#1000) - Change syntax of ``$view_file`` to ``$_ci_view_file`` to prevent being overwritten by application.
--  Fixed a bug (#1757) - :doc:`Directory Helper <helpers/directory_helper>` function ``directory_map()`` was skipping files and directories named *0*.
+-  Fixed a bug (#1757) - :doc:`Directory Helper <helpers/directory_helper>` function :func:`directory_map()` was skipping files and directories named '0'.
 -  Fixed a bug (#1789) - :doc:`Database Library <database/index>` method ``escape_str()`` escaped quote characters in LIKE conditions twice under MySQL.
 -  Fixed a bug (#395) - :doc:`Unit Testing Library <libraries/unit_testing>` method ``result()`` didn't properly check array result columns when called from ``report()``.
--  Fixed a bug (#1692) - :doc:`Database Library <database/index>` method ``display_error()`` didn't properly trace the possible error source on Windows systems.
--  Fixed a bug (#1745) - ``is_write_type()`` method in the :doc:`Database Library <database/index>` didn't return TRUE for LOAD queries.
--  Fixed a bug (#1765) - :doc:`Database Library <database/index>` didn't properly detect connection errors for MySQLi.
+-  Fixed a bug (#1692) - :doc:`Database Class <database/index>` method ``display_error()`` didn't properly trace the possible error source on Windows systems.
+-  Fixed a bug (#1745) - :doc:`Database Class <database/index>` method ``is_write_type()`` didn't return TRUE for LOAD queries.
+-  Fixed a bug (#1765) - :doc:`Database Class <database/index>` didn't properly detect connection errors for the 'mysqli' driver.
 -  Fixed a bug (#1257) - :doc:`Query Builder <database/query_builder>` used to (unnecessarily) group FROM clause contents, which breaks certain queries and is invalid for some databases.
 -  Fixed a bug (#1709) - :doc:`Email <libraries/email>` headers were broken when using long email subjects and \r\n as CRLF.
--  Fixed a bug where ``MB_ENABLED`` was only declared if ``UTF8_ENABLED`` was set to TRUE.
+-  Fixed a bug where ``MB_ENABLED`` constant was only declared if ``UTF8_ENABLED`` was set to TRUE.
 -  Fixed a bug where the :doc:`Session Library <libraries/sessions>` accepted cookies with *last_activity* values being in the future.
 -  Fixed a bug (#1897) - :doc:`Email Library <libraries/email>` triggered PHP E_WARNING errors when *mail* protocol used and ``to()`` is never called.
 -  Fixed a bug (#1409) - :doc:`Email Library <libraries/email>` didn't properly handle multibyte characters when applying Q-encoding to headers.
--  Fixed a bug where :doc:`Email Library <libraries/email>` didn't honor its *wordwrap* setting while handling alternative messages.
+-  Fixed a bug where :doc:`Email Library <libraries/email>` ignored its *wordwrap* setting while handling alternative messages.
 -  Fixed a bug (#1476, #1909) - :doc:`Pagination Library <libraries/pagination>` didn't take into account actual routing when determining the current page.
 -  Fixed a bug (#1766) - :doc:`Query Builder <database/query_builder>` didn't always take into account the *dbprefix* setting.
 -  Fixed a bug (#779) - :doc:`URI Class <libraries/uri>` didn't always trim slashes from the *uri_string* as shown in the documentation.
 -  Fixed a bug (#134) - :doc:`Database Caching <database/caching>` method ``delete_cache()`` didn't work in some cases due to *cachedir* not being initialized properly.
 -  Fixed a bug (#191) - :doc:`Loader Library <libraries/loader>` ignored attempts for (re)loading databases to ``get_instance()->db`` even when the old database connection is dead.
 -  Fixed a bug (#1255) - :doc:`User Agent Library <libraries/user_agent>` method ``is_referral()`` only checked if ``$_SERVER['HTTP_REFERER']`` exists.
--  Fixed a bug (#1146) - :doc:`Download Helper <helpers/download_helper>` function ``force_download()`` incorrectly sent *Cache-Control* directives *pre-check* and *post-check* to Internet Explorer.
+-  Fixed a bug (#1146) - :doc:`Download Helper <helpers/download_helper>` function :func:`force_download()` incorrectly sent *Cache-Control* directives *pre-check* and *post-check* to Internet Explorer.
 -  Fixed a bug (#1811) - :doc:`URI Library <libraries/uri>` didn't properly cache segments for ``uri_to_assoc()`` and ``ruri_to_assoc()``.
 -  Fixed a bug (#1506) - :doc:`Form Helpers <helpers/form_helper>` set empty *name* attributes.
 -  Fixed a bug (#59) - :doc:`Query Builder <database/query_builder>` method ``count_all_results()`` ignored the DISTINCT clause.
 -  Fixed a bug (#1624) - :doc:`Form Validation Library <libraries/form_validation>` rule **matches** didn't property handle array field names.
--  Fixed a bug (#1630) - :doc:`Form Helper <helpers/form_helper>` function ``set_value()`` didn't escape HTML entities.
--  Fixed a bug (#142) - :doc:`Form Helper <helpers/form_helper>` function ``form_dropdown()`` didn't escape HTML entities in option values.
+-  Fixed a bug (#1630) - :doc:`Form Helper <helpers/form_helper>` function :func:`set_value()` didn't escape HTML entities.
+-  Fixed a bug (#142) - :doc:`Form Helper <helpers/form_helper>` function :func:`form_dropdown()` didn't escape HTML entities in option values.
 -  Fixed a bug (#50) - :doc:`Session Library <libraries/sessions>` unnecessarily stripped slashed from serialized data, making it impossible to read objects in a namespace.
 -  Fixed a bug (#658) - :doc:`Routing <general/routing>` wildcard **:any** didn't work as advertised and matched multiple URI segments instead of all characters within a single segment.
 -  Fixed a bug (#1938) - :doc:`Email Library <libraries/email>` removed multiple spaces inside a pre-formatted plain text message.
@@ -637,11 +636,11 @@ Bug fixes for 3.0
 -  Fixed a bug (#113) - :doc:`Form Validation Library <libraries/form_validation>` didn't properly handle empty fields that were specified as an array.
 -  Fixed a bug (#2061) - :doc:`Routing Class <general/routing>` didn't properly sanitize directory, controller and function triggers with **enable_query_strings** set to TRUE.
 -  Fixed a bug - SQLSRV didn't support ``escape_like_str()`` or escaping an array of values.
--  Fixed a bug - :doc:`Database Results <database/results>` method ``list_fields()`` didn't reset its field pointer for the *mysql*, *mysqli* and *mssql* drivers.
+-  Fixed a bug - :doc:`Database Results <database/results>` method ``list_fields()`` didn't reset its field pointer for the 'mysql', 'mysqli' and 'mssql' drivers.
 -  Fixed a bug (#73) - :doc:`Security Library <libraries/security>` method ``sanitize_filename()`` could be tricked by an XSS attack.
 -  Fixed a bug (#2211) - :doc:`Migration Library <libraries/migration>` extensions couldn't execute ``CI_Migration::__construct()``.
--  Fixed a bug (#2255) - :doc:`Email Library <libraries/email>` didn't apply ``smtp_timeout`` to socket reads and writes.
--  Fixed a bug (#2239) - :doc:`Email Library <libraries/email>` improperly handled the Subject when used with ``bcc_batch_mode`` resulting in E_WARNING messages and an empty Subject.
+-  Fixed a bug (#2255) - :doc:`Email Library <libraries/email>` didn't apply *smtp_timeout* to socket reads and writes.
+-  Fixed a bug (#2239) - :doc:`Email Library <libraries/email>` improperly handled the Subject when used with *bcc_batch_mode* resulting in E_WARNING messages and an empty Subject.
 -  Fixed a bug (#2234) - :doc:`Query Builder <database/query_builder>` didn't reset JOIN cache for write-type queries.
 -  Fixed a bug (#2298) - :doc:`Database Results <database/results>` method ``next_row()`` kept returning the last row, allowing for infinite loops.
 -  Fixed a bug (#2236, #2639) - :doc:`Form Helper <helpers/form_helper>` functions :func:`set_value()`, :func:`set_select()`, :func:`set_radio()`, :func:`set_checkbox()` didn't parse array notation for keys if the rule was not present in the :doc:`Form Validation Library <libraries/form_validation>`.
@@ -651,7 +650,7 @@ Bug fixes for 3.0
 -  Fixed a bug (#2380) - :doc:`URI Routing <general/routing>` method ``fetch_method()`` returned 'index' if the requested method name matches its controller name.
 -  Fixed a bug (#2388) - :doc:`Email Library <libraries/email>` used to ignore attachment errors, resulting in broken emails being sent.
 -  Fixed a bug (#2498) - :doc:`Form Validation Library <libraries/form_validation>` rule **valid_base64** only checked characters instead of actual validity.
--  Fixed a bug (#2425) - OCI8 :doc:`database <database/index>` driver's method ``stored_procedure()`` didn't log an error unless **db_debug** was set to TRUE.
+-  Fixed a bug (#2425) - OCI8 :doc:`database <database/index>` driver method ``stored_procedure()`` didn't log an error unless **db_debug** was set to TRUE.
 -  Fixed a bug (#2490) - :doc:`Database Class <database/queries>` method ``query()`` returning boolean instead of a result object for PostgreSQL-specific *INSERT INTO ... RETURNING* statements.
 -  Fixed a bug (#249) - :doc:`Cache Library <libraries/caching>` didn't properly handle Memcache(d) configurations with missing options.
 -  Fixed a bug (#180) - :func:`config_item()` didn't take into account run-time configuration changes.
@@ -659,12 +658,12 @@ Bug fixes for 3.0
 -  Fixed a bug (#2560) - :doc:`Form Helper <helpers/form_helper>` function :func:`form_open()` set the 'method="post"' attribute only if the passed attributes equaled an empty string.
 -  Fixed a bug (#2585) - :doc:`Query Builder <database/query_builder>` methods ``min()``, ``max()``, ``avg()``, ``sum()`` didn't escape field names.
 -  Fixed an edge case (#2583) in the :doc:`Email Library <libraries/email>` where `Suhosin <http://www.hardened-php.net/suhosin/>` blocked messages sent via ``mail()`` due to trailing newspaces in headers.
--  Fixed a bug (#2590) - :func:`log_message()` didn't actually cache the ``CI_Log`` class instance.
--  Fixed a bug (#2609) - :func:`get_config()` optional argument was only effective on first function call. Also, it can now add items, in addition to updating existing items.
+-  Fixed a bug (#2590) - :doc:`Common function <general/common_functions>` :func:`log_message()` didn't actually cache the ``CI_Log`` class instance.
+-  Fixed a bug (#2609) - :doc:`Common function <general/common_functions>` :func:`get_config()` optional argument was only effective on first function call. Also, it can now add items, in addition to updating existing items.
 -  Fixed a bug in the 'postgre' :doc:`database <database/index>` driver where the connection ID wasn't passed to ``pg_escape_string()``.
 -  Fixed a bug (#33) - Script execution was terminated when an invalid cookie key was encountered.
--  Fixed a bug (#2681) - ``CI_Security::entity_decode()`` used the `PREG_REPLACE_EVAL` flag, which is deprecated since PHP 5.5.
--  Fixed a bug (#2691) - nested transactions could end in a deadlock when an error is encountered with *db_debug* set to TRUE.
+-  Fixed a bug (#2681) - :doc:`Security Library <libraries/security>` method ``entity_decode()`` used the `PREG_REPLACE_EVAL` flag, which is deprecated since PHP 5.5.
+-  Fixed a bug (#2691) - nested :doc:`database <database/index>` transactions could end in a deadlock when an error is encountered with *db_debug* set to TRUE.
 -  Fixed a bug (#2515) - ``_exception_handler()`` used to send the 200 "OK" HTTP status code and didn't stop script exection even on fatal errors.
 -  Fixed a bug - Redis :doc:`Caching <libraries/caching>` driver didn't handle connection failures properly.
 -  Fixed a bug (#2756) - :doc:`Database Class <database/index>` executed the MySQL-specific `SET SESSION sql_mode` query for all drivers when the 'stricton' option is set.
@@ -673,16 +672,16 @@ Bug fixes for 3.0
 -  Fixed a bug (#2268) - :doc:`Security Library <libraries/security>` didn't properly match JavaScript events.
 -  Fixed a bug (#2143) - :doc:`Form Validation Library <libraries/form_validation>` didn't check for rule groups named in a *controller/method* manner when trying to load from a config file.
 -  Fixed a bug (#2762) - :doc:`Hooks Class <general/hooks>` didn't properly check if the called class/function exists.
--  Fixed a bug (#148) - while sanitizing input data, ``CI_Input::_clean_input_data()`` assumed that it is URL-encoded, stripping certain character sequences from it.
+-  Fixed a bug (#148) - :doc:`Input Library <libraries/input>` internal method ``_clean_input_data()`` assumed that it data is URL-encoded, stripping certain character sequences from it.
 -  Fixed a bug (#346) - with ``$config['global_xss_filtering']`` turned on, the ``$_GET``, ``$_POST``, ``$_COOKIE`` and ``$_SERVER`` superglobals were overwritten during initialization time, resulting in XSS filtering being either performed twice or there was no possible way to get the original data, even though options for this do exist.
--  Fixed an edge case (#555) - incorrect browser version was reported for Opera 10+ due to a non-standard user-agent string.
+-  Fixed an edge case (#555) - :doc:`User Agent Library <libraries/user_agent>` reported an incorrect version Opera 10+ due to a non-standard user-agent string.
 -  Fixed a bug (#133) - :doc:`Text Helper <helpers/text_helper>` :func:`ascii_to_entities()` stripped the last character if it happens to be in the extended ASCII group.
 -  Fixed a bug (#2822) - ``fwrite()`` was used incorrectly throughout the whole framework, allowing incomplete writes when writing to a network stream and possibly a few other edge cases.
 -  Fixed a bug where :doc:`User Agent Library <libraries/user_agent>` methods ``accept_charset()`` and ``accept_lang()`` didn't properly parse HTTP headers that contain spaces.
 -  Fixed a bug where *default_controller* was called instad of triggering a 404 error if the current route is in a controller directory.
 -  Fixed a bug (#2737) - :doc:`XML-RPC Library <libraries/xmlrpc>` used objects as array keys, which triggered E_NOTICE messages.
--  Fixed a bug (#2729) - ``CI_Security::_validate_entities()`` used overly-intrusive ``preg_replace()`` patterns that produced false-positives.
--  Fixed a bug (#2771) - ``CI_Security::xss_clean()`` didn't take into account HTML5 entities.
+-  Fixed a bug (#2729) - :doc:`Security Library <libraries/security>` internal method ``_validate_entities()`` used overly-intrusive ``preg_replace()`` patterns that produced false-positives.
+-  Fixed a bug (#2771) - :doc:`Security Library <libraries/security>` method ``xss_clean()`` didn't take into account HTML5 entities.
 -  Fixed a bug in the :doc:`Session Library <libraries/sessions>` 'cookie' driver where authentication was not performed for encrypted cookies.
 -  Fixed a bug (#2856) - ODBC method ``affected_rows()`` passed an incorrect value to ``odbc_num_rows()``.
 
-- 
cgit v1.2.3-24-g4f1b


From dd536b7028c5d8e502cc7387ddb5f3fe8c8770d8 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Fri, 7 Feb 2014 21:33:56 +0200
Subject: [ci skip] Fix a wrong reference in the docs

---
 user_guide_src/source/installation/upgrade_300.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst
index 88bb11178..fe655ad14 100644
--- a/user_guide_src/source/installation/upgrade_300.rst
+++ b/user_guide_src/source/installation/upgrade_300.rst
@@ -96,7 +96,7 @@ With the change from a single Session Library to the new Session Driver, two new
    -  ``$config['sess_driver']`` selects which driver to initially load. Options are:
        -  'cookie' (the default) for classic CodeIgniter cookie-based sessions
        -  'native' for native PHP Session support
-       -  the name of a custom driver you have provided (see :doc:`Session Driver <../libraries/sessions>` for more info)
+       -  the name of a custom driver you have provided (see :doc:`Session Driver <../libraries/session>` for more info)
    -  ``$config['sess_valid_drivers']`` provides an array of additional custom drivers to make available for loading
 
 As the new Session Driver library loads the classic Cookie driver by default and always makes 'cookie' and 'native'
-- 
cgit v1.2.3-24-g4f1b


From 2cdd4836b7ff399d6cac1bfc974d9bbabab54f8c Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Fri, 7 Feb 2014 21:39:25 +0200
Subject: [ci skip] Really fix wrong doc references

---
 user_guide_src/source/changelog.rst                | 2 +-
 user_guide_src/source/installation/upgrade_300.rst | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index e40e64acd..0344b7894 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -516,7 +516,7 @@ Bug fixes for 3.0
 -  Fixed a possible bug in :doc:`Input Libary <libraries/input>` method ``is_ajax_request()`` where some clients might not send the X-Requested-With HTTP header value exactly as 'XmlHttpRequest'.
 -  Fixed a bug (#1039) - :doc:`Database Utilities <database/utilities>` internal method ``_backup()`` method failed for the 'mysql' driver due to a table name not being escaped.
 -  Fixed a bug (#1070) - ``CI_DB_driver::initialize()`` didn't set a character set if a database is not selected.
--  Fixed a bug (#177) - :doc:`Form Validation Library <libraries/form_validation>`` method ``set_value()`` didn't set the default value if POST data is NULL.
+-  Fixed a bug (#177) - :doc:`Form Validation Library <libraries/form_validation>` method ``set_value()`` didn't set the default value if POST data is NULL.
 -  Fixed a bug (#68, #414) - :Oracle's ``escape_str()`` didn't properly escape LIKE wild characters.
 -  Fixed a bug (#81) - ODBC's ``list_fields()`` and ``field_data()`` methods skipped the first column due to ``odbc_field_*()`` functions' index starting at 1 instead of 0.
 -  Fixed a bug (#129) - ODBC's ``num_rows()`` method returned -1 in some cases, due to not all subdrivers supporting the ``odbc_num_rows()`` function.
diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst
index aefe1919e..3f96a31e2 100644
--- a/user_guide_src/source/installation/upgrade_300.rst
+++ b/user_guide_src/source/installation/upgrade_300.rst
@@ -96,7 +96,7 @@ With the change from a single Session Library to the new Session Driver, two new
    -  ``$config['sess_driver']`` selects which driver to initially load. Options are:
        -  'cookie' (the default) for classic CodeIgniter cookie-based sessions
        -  'native' for native PHP Session support
-       -  the name of a custom driver you have provided (see :doc:`Session Driver <../libraries/session>` for more info)
+       -  the name of a custom driver you have provided (see :doc:`Session Driver <../libraries/sessions>` for more info)
    -  ``$config['sess_valid_drivers']`` provides an array of additional custom drivers to make available for loading
 
 As the new Session Driver library loads the classic Cookie driver by default and always makes 'cookie' and 'native'
-- 
cgit v1.2.3-24-g4f1b


From 1e584208e420d1d864de2bc686d437ecdf0ce064 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Fri, 7 Feb 2014 21:50:36 +0200
Subject: [ci skip] Fix class reference sections of Image_lib, Parser and User
 agent docs

---
 user_guide_src/source/libraries/image_lib.rst  | 7 +++++++
 user_guide_src/source/libraries/parser.rst     | 2 +-
 user_guide_src/source/libraries/user_agent.rst | 2 +-
 3 files changed, 9 insertions(+), 2 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/image_lib.rst b/user_guide_src/source/libraries/image_lib.rst
index cde4e44dc..cf23e397a 100644
--- a/user_guide_src/source/libraries/image_lib.rst
+++ b/user_guide_src/source/libraries/image_lib.rst
@@ -19,6 +19,13 @@ ImageMagick
 	order for the script to calculate the image properties. The image
 	processing, however, will be performed with the library you specify.
 
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
+
 **********************
 Initializing the Class
 **********************
diff --git a/user_guide_src/source/libraries/parser.rst b/user_guide_src/source/libraries/parser.rst
index 50bde82c7..34ad65f2b 100644
--- a/user_guide_src/source/libraries/parser.rst
+++ b/user_guide_src/source/libraries/parser.rst
@@ -147,7 +147,7 @@ function::
 Class Reference
 ***************
 
-.. class: CI_Parser
+.. class:: CI_Parser
 
 	.. method:: parse($template, $data[, $return = FALSE])
 
diff --git a/user_guide_src/source/libraries/user_agent.rst b/user_guide_src/source/libraries/user_agent.rst
index af76cfa6e..1b6a2988a 100644
--- a/user_guide_src/source/libraries/user_agent.rst
+++ b/user_guide_src/source/libraries/user_agent.rst
@@ -72,7 +72,7 @@ is available.
 Class Reference
 ***************
 
-.. class: CI_User_agent
+.. class:: CI_User_agent
 
 	.. method:: is_browser([$key = NULL])
 
-- 
cgit v1.2.3-24-g4f1b


From 3de130c2da3b93a3404f264e92d7b65354de3548 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Fri, 7 Feb 2014 23:31:49 +0200
Subject: [ci skip] Add return types to helper docs (+ some other formatting)

---
 user_guide_src/source/helpers/array_helper.rst     |   5 +-
 user_guide_src/source/helpers/captcha_helper.rst   |   1 +
 user_guide_src/source/helpers/cookie_helper.rst    |  35 ++--
 user_guide_src/source/helpers/date_helper.rst      | 181 ++++++++++-----------
 user_guide_src/source/helpers/directory_helper.rst |  10 +-
 user_guide_src/source/helpers/download_helper.rst  |   2 +-
 user_guide_src/source/helpers/email_helper.rst     |  11 +-
 user_guide_src/source/helpers/file_helper.rst      |  41 +++--
 user_guide_src/source/helpers/form_helper.rst      |  82 ++++++----
 user_guide_src/source/helpers/html_helper.rst      |  97 +++++------
 user_guide_src/source/helpers/inflector_helper.rst |  23 +--
 user_guide_src/source/helpers/language_helper.rst  |  21 +--
 user_guide_src/source/helpers/number_helper.rst    |   5 +-
 user_guide_src/source/helpers/path_helper.rst      |   3 +-
 user_guide_src/source/helpers/security_helper.rst  |  20 ++-
 user_guide_src/source/helpers/smiley_helper.rst    |  12 +-
 user_guide_src/source/helpers/string_helper.rst    |  39 +++--
 user_guide_src/source/helpers/text_helper.rst      |  40 ++---
 .../source/helpers/typography_helper.rst           |  10 +-
 user_guide_src/source/helpers/url_helper.rst       |  44 ++---
 user_guide_src/source/helpers/xml_helper.rst       |   5 +-
 21 files changed, 361 insertions(+), 326 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/helpers/array_helper.rst b/user_guide_src/source/helpers/array_helper.rst
index 20f5864a6..4805f581a 100644
--- a/user_guide_src/source/helpers/array_helper.rst
+++ b/user_guide_src/source/helpers/array_helper.rst
@@ -32,6 +32,7 @@ The following functions are available:
 	:param	array	$array: Input array
 	:param	bool	$default: What to return if the array isn't valid
 	:returns:	NULL on failure or the array item.
+	:rtype:	mixed
 
 	Lets you fetch an item from an array. The function tests whether the
 	array index is set and whether it has a value. If a value exists it is
@@ -56,6 +57,7 @@ The following functions are available:
 	:param	array	$array: Input array
 	:param	bool	$default: What to return if the array isn't valid
 	:returns:	NULL on failure or the array item.
+	:rtype:	mixed
 
 	Lets you fetch a number of items from an array. The function tests
 	whether each of the array indices is set. If an index does not exist it
@@ -112,7 +114,8 @@ The following functions are available:
 .. function:: random_element($array)
 
 	:param	array	$array: Input array
-	:returns:	string (a random element from the array)
+	:returns:	A random element from the array
+	:rtype:	mixed
 
 	Takes an array as input and returns a random element from it.
 
diff --git a/user_guide_src/source/helpers/captcha_helper.rst b/user_guide_src/source/helpers/captcha_helper.rst
index 13cf92a19..d83490b8e 100644
--- a/user_guide_src/source/helpers/captcha_helper.rst
+++ b/user_guide_src/source/helpers/captcha_helper.rst
@@ -135,6 +135,7 @@ The following functions are available:
 	:param	string	$img_url: URL to the CAPTCHA image folder
 	:param	string	$font_path: Server path to font
 	:returns:	array('word' => $word, 'time' => $now, 'image' => $img)
+	:rtype:	array
 
 	Takes an array of information to generate the CAPTCHA as input and
 	creates the image to your specifications, returning an array of
diff --git a/user_guide_src/source/helpers/cookie_helper.rst b/user_guide_src/source/helpers/cookie_helper.rst
index 3b594170d..22fd0f77f 100644
--- a/user_guide_src/source/helpers/cookie_helper.rst
+++ b/user_guide_src/source/helpers/cookie_helper.rst
@@ -27,15 +27,15 @@ The following functions are available:
 
 .. function:: set_cookie($name[, $value = ''[, $expire = ''[, $domain = ''[, $path = '/'[, $prefix = ''[, $secure = FALSE[, $httponly = FALSE]]]]]]]])
 
-	:param mixed $name: Cookie name *or* associative array of all of the parameters available to this function
-	:param string $value: Cookie value
-	:param int $expire: Number of seconds until expiration
-	:param string $domain: Cookie domain (usually: .yourdomain.com)
-	:param string $path: Cookie path
-	:param string $prefix: Cookie name prefix
-	:param bool $secure: Whether to only send the cookie through HTTPS
-	:param bool $httponly: Whether to hide the cookie from JavaScript
-	:returns: void
+	:param	mixed	$name: Cookie name *or* associative array of all of the parameters available to this function
+	:param	string	$value: Cookie value
+	:param	int	$expire: Number of seconds until expiration
+	:param	string	$domain: Cookie domain (usually: .yourdomain.com)
+	:param	string	$path: Cookie path
+	:param	string	$prefix: Cookie name prefix
+	:param	bool	$secure: Whether to only send the cookie through HTTPS
+	:param	bool	$httponly: Whether to hide the cookie from JavaScript
+	:rtype:	void
 
 	This helper function gives you view file friendly syntax to set browser
 	cookies. Refer to the :doc:`Input Library <../libraries/input>` for a
@@ -45,9 +45,10 @@ The following functions are available:
 
 .. function:: get_cookie($index[, $xss_clean = NULL]])
 
-	:param string $index: Cookie name
-	:param bool $xss_clean: Whether to apply XSS filtering to the returned value
-	:returns: mixed
+	:param	string	$index: Cookie name
+	:param	bool	$xss_clean: Whether to apply XSS filtering to the returned value
+	:returns:	The cookie value or NULL if not found
+	:rtype:	mixed
 
 	This helper function gives you view file friendly syntax to get browser
 	cookies. Refer to the :doc:`Input Library <../libraries/input>` for a
@@ -56,11 +57,11 @@ The following functions are available:
 
 .. function:: delete_cookie($name[, $domain = ''[, $path = '/'[, $prefix = '']]]])
 
-	:param string $name: Cookie name
-	:param string $domain: Cookie domain (usually: .yourdomain.com)
-	:param string $path: Cookie path
-	:param string $prefix: Cookie name prefix
-	:returns: void
+	:param	string	$name: Cookie name
+	:param	string	$domain: Cookie domain (usually: .yourdomain.com)
+	:param	string	$path: Cookie path
+	:param	string	$prefix: Cookie name prefix
+	:rtype:	void
 
 	Lets you delete a cookie. Unless you've set a custom path or other
 	values, only the name of the cookie is needed.
diff --git a/user_guide_src/source/helpers/date_helper.rst b/user_guide_src/source/helpers/date_helper.rst
index e7598df14..39a9cb325 100644
--- a/user_guide_src/source/helpers/date_helper.rst
+++ b/user_guide_src/source/helpers/date_helper.rst
@@ -27,7 +27,8 @@ The following functions are available:
 .. function:: now([$timezone = NULL])
 
 	:param	string	$timezone: Timezone
-	:returns:	int
+	:returns:	UNIX timestamp
+	:rtype:	int
 
 	Returns the current time as a UNIX timestamp, referenced either to your server's
 	local time or any PHP suported timezone, based on the "time reference" setting
@@ -35,7 +36,6 @@ The following functions are available:
 	any other PHP supported timezone (which you'll typically do if you run a site
 	that lets each user set their own timezone settings) there is no benefit to using
 	this function over PHP's ``time()`` function.
-
 	::
 
 		echo now('Australia/Victoria');
@@ -43,12 +43,12 @@ The following functions are available:
 	If a timezone is not provided, it will return ``time()`` based on the
 	**time_reference** setting.
 
-
 .. function:: mdate([$datestr = ''[, $time = '']])
 
-	:param	string 	$datestr: Date string
-	:param	int 	$time: UNIX timestamp
-	:returns:	int
+	:param	string	$datestr: Date string
+	:param	int	$time: UNIX timestamp
+	:returns:	MySQL-formatted date
+	:rtype:	string
 
 	This function is identical to PHP's `date() <http://www.php.net/date>`_
 	function, except that it lets you use MySQL style date codes, where each
@@ -67,12 +67,12 @@ The following functions are available:
 	If a timestamp is not included in the second parameter the current time
 	will be used.
 
-
 .. function:: standard_date([$fmt = 'DATE_RFC822'[, $time = NULL]])
 
 	:param	string	$fmt: Date format
-	:param	int 	$time: UNIX timestamp
-	:returns:	string
+	:param	int	$time: UNIX timestamp
+	:returns:	Formatted date or FALSE on invalid format
+	:rtype:	string
 
 	Lets you generate a date string in one of several standardized formats.
 
@@ -92,25 +92,25 @@ The following functions are available:
 	**Supported formats:**
 
 	===============	=======================	======================================
-	Constant		Description				Example
+	Constant        Description             Example
 	===============	=======================	======================================
-	DATE_ATOM	Atom			2005-08-15T16:13:03+0000
-	DATE_COOKIE	HTTP Cookies		Sun, 14 Aug 2005 16:13:03 UTC
-	DATE_ISO8601   	ISO-8601		2005-08-14T16:13:03+00:00
-	DATE_RFC822	RFC 822			Sun, 14 Aug 05 16:13:03 UTC
-	DATE_RFC850	RFC 850			Sunday, 14-Aug-05 16:13:03 UTC
-	DATE_RFC1036	RFC 1036		Sunday, 14-Aug-05 16:13:03 UTC
-	DATE_RFC1123	RFC 1123		Sun, 14 Aug 2005 16:13:03 UTC
-	DATE_RFC2822 	RFC 2822		Sun, 14 Aug 2005 16:13:03 +0000
-	DATE_RSS	RSS			Sun, 14 Aug 2005 16:13:03 UTC
-	DATE_W3C	W3C			2005-08-14T16:13:03+0000
+	DATE_ATOM       Atom                    2005-08-15T16:13:03+0000
+	DATE_COOKIE     HTTP Cookies            Sun, 14 Aug 2005 16:13:03 UTC
+	DATE_ISO8601    ISO-8601                2005-08-14T16:13:03+00:00
+	DATE_RFC822     RFC 822                 Sun, 14 Aug 05 16:13:03 UTC
+	DATE_RFC850     RFC 850                 Sunday, 14-Aug-05 16:13:03 UTC
+	DATE_RFC1036    RFC 1036                Sunday, 14-Aug-05 16:13:03 UTC
+	DATE_RFC1123    RFC 1123                Sun, 14 Aug 2005 16:13:03 UTC
+	DATE_RFC2822    RFC 2822                Sun, 14 Aug 2005 16:13:03 +0000
+	DATE_RSS        RSS                     Sun, 14 Aug 2005 16:13:03 UTC
+	DATE_W3C        W3C                     2005-08-14T16:13:03+0000
 	===============	=======================	======================================
 
-
 .. function:: local_to_gmt([$time = ''])
 
 	:param	int	$time: UNIX timestamp
-	:returns:	string
+	:returns:	UNIX timestamp
+	:rtype:	int
 
 	Takes a UNIX timestamp as input and returns it as GMT.
 
@@ -118,13 +118,13 @@ The following functions are available:
 
 		$gmt = local_to_gmt(time());
 
-
 .. function:: gmt_to_local([$time = ''[, $timezone = 'UTC'[, $dst = FALSE]]])
 
-	:param	int 	$time: UNIX timestamp
+	:param	int	$time: UNIX timestamp
 	:param	string	$timezone: Timezone
-	:param	bool 	$dst: Whether DST is active
-	:returns:	int
+	:param	bool	$dst: Whether DST is active
+	:returns:	UNIX timestamp
+	:rtype:	int
 
 	Takes a UNIX timestamp (referenced to GMT) as input, and converts it to
 	a localized timestamp based on the timezone and Daylight Saving Time
@@ -140,11 +140,11 @@ The following functions are available:
 
 	.. note:: For a list of timezones see the reference at the bottom of this page.
 
-
 .. function:: mysql_to_unix([$time = ''])
 
-	:param	int 	$time: UNIX timestamp
-	:returns:	int
+	:param	string	$time: MySQL timestamp
+	:returns:	UNIX timestamp
+	:rtype:	int
 
 	Takes a MySQL Timestamp as input and returns it as a UNIX timestamp.
 
@@ -152,13 +152,13 @@ The following functions are available:
 
 		$unix = mysql_to_unix('20061124092345');
 
-
 .. function:: unix_to_human([$time = ''[, $seconds = FALSE[, $fmt = 'us']]])
 
 	:param	int	$time: UNIX timestamp
 	:param	bool	$seconds: Whether to show seconds
 	:param	string	$fmt: format (us or euro)
-	:returns: integer
+	:returns:	Formatted date
+	:rtype:	string
 
 	Takes a UNIX timestamp as input and returns it in a human readable
 	format with this prototype::
@@ -179,11 +179,11 @@ The following functions are available:
 		echo unix_to_human($now, TRUE, 'us'); // U.S. time with seconds
 		echo unix_to_human($now, TRUE, 'eu'); // Euro time with seconds
 
-
 .. function:: human_to_unix([$datestr = ''])
 
-	:param	int 	$datestr: Date string
-	:returns:	int UNIX timestamp or FALSE on failure
+	:param	int	$datestr: Date string
+	:returns:	UNIX timestamp or FALSE on failure
+	:rtype:	int
 
 	The opposite of the :func:`unix_to_time()` function. Takes a "human"
 	time as input and returns it as a UNIX timestamp. This is useful if you
@@ -196,12 +196,12 @@ The following functions are available:
 		$human = unix_to_human($now);
 		$unix = human_to_unix($human);
 
-
 .. function:: nice_date([$bad_date = ''[, $format = FALSE]])
 
 	:param	int	$bad_date: The terribly formatted date-like string
 	:param	string	$format: Date format to return (same as PHP's ``date()`` function)
-	:returns:	string
+	:returns:	Formatted date
+	:rtype:	string
 
 	This function can take a number poorly-formed date formats and convert
 	them into something useful. It also accepts well-formed dates.
@@ -220,13 +220,13 @@ The following functions are available:
 		// Should Produce: 2001-09-11
 		$better_date = nice_date($bad_date, 'Y-m-d');
 
-
 .. function:: timespan([$seconds = 1[, $time = ''[, $units = '']]])
 
 	:param	int	$seconds: Number of seconds
 	:param	string	$time: UNIX timestamp
 	:param	int	$units: Number of time units to display
-	:returns:	string
+	:returns:	Formatted time difference
+	:rtype:	string
 
 	Formats a UNIX timestamp so that is appears similar to this::
 
@@ -252,12 +252,12 @@ The following functions are available:
 	.. note:: The text generated by this function is found in the following language
 		file: `language/<your_lang>/date_lang.php`
 
-
 .. function:: days_in_month([$month = 0[, $year = '']])
 
 	:param	int	$month: a numeric month
 	:param	int	$year: a numeric year
-	:returns:	int
+	:returns:	Count of days in the specified month
+	:rtype:	int
 
 	Returns the number of days in a given month/year. Takes leap years into
 	account.
@@ -268,14 +268,14 @@ The following functions are available:
 
 	If the second parameter is empty, the current year will be used.
 
-
 .. function:: date_range([$unix_start = ''[, $mixed = ''[, $is_unix = TRUE[, $format = 'Y-m-d']]]])
 
 	:param	int	$unix_start: UNIX timestamp of the range start date
 	:param	int	$mixed: UNIX timestamp of the range end date or interval in days
 	:param	bool	$is_unix: set to FALSE if $mixed is not a timestamp
 	:param	string	$format: Output date format, same as in ``date()``
-	:returns:	array
+	:returns:	An array of dates
+	:rtype:	array
 
 	Returns a list of dates within a specified period.
 
@@ -288,11 +288,11 @@ The following functions are available:
 			echo $date."\n";
 		}
 
-
 .. function:: timezones([$tz = ''])
 
-	:param	string	$tz: a numeric timezone
-	:returns:	string
+	:param	string	$tz: A numeric timezone
+	:returns:	Hour difference from UTC
+	:rtype:	int
 
 	Takes a timezone reference (for a list of valid timezones, see the
 	"Timezone Reference" below) and returns the number of hours offset from
@@ -305,14 +305,14 @@ The following functions are available:
 
 	This function is useful when used with :func:`timezone_menu()`.
 
-
 .. function:: timezone_menu([$default = 'UTC'[, $class = ''[, $name = 'timezones'[, $attributes = '']]]])
 
 	:param	string	$default: Timezone
 	:param	string	$class: Class name
 	:param	string	$name: Menu name
 	:param	mixed	$attributes: HTML attributes
-	:returns:	string
+	:returns:	HTML drop down menu with time zones
+	:rtype:	string
 
 	Generates a pull-down menu of timezones, like this one:
 
@@ -381,7 +381,6 @@ The following functions are available:
 	.. note:: The text contained in the menu is found in the following
 		language file: `language/<your_lang>/date_lang.php`
 
-
 Timezone Reference
 ==================
 
@@ -389,47 +388,47 @@ The following table indicates each timezone and its location.
 
 Note some of the location lists have been abridged for clarity and formatting.
 
-===========	=====================================================================
-Time Zone	Location
-===========	=====================================================================
-UM12		(UTC - 12:00) Baker/Howland Island
-UM11		(UTC - 11:00) Samoa Time Zone, Niue
-UM10		(UTC - 10:00) Hawaii-Aleutian Standard Time, Cook Islands
-UM95		(UTC - 09:30) Marquesas Islands
-UM9		(UTC - 09:00) Alaska Standard Time, Gambier Islands
-UM8		(UTC - 08:00) Pacific Standard Time, Clipperton Island
-UM7		(UTC - 11:00) Mountain Standard Time
-UM6		(UTC - 06:00) Central Standard Time
-UM5		(UTC - 05:00) Eastern Standard Time, Western Caribbean
-UM45		(UTC - 04:30) Venezuelan Standard Time
-UM4		(UTC - 04:00) Atlantic Standard Time, Eastern Caribbean
-UM35		(UTC - 03:30) Newfoundland Standard Time
-UM3		(UTC - 03:00) Argentina, Brazil, French Guiana, Uruguay
-UM2		(UTC - 02:00) South Georgia/South Sandwich Islands
-UM1		(UTC -1:00) Azores, Cape Verde Islands
-UTC		(UTC) Greenwich Mean Time, Western European Time
-UP1		(UTC +1:00) Central European Time, West Africa Time
-UP2		(UTC +2:00) Central Africa Time, Eastern European Time
-UP3		(UTC +3:00) Moscow Time, East Africa Time
-UP35		(UTC +3:30) Iran Standard Time
-UP4		(UTC +4:00) Azerbaijan Standard Time, Samara Time
-UP45		(UTC +4:30) Afghanistan
-UP5		(UTC +5:00) Pakistan Standard Time, Yekaterinburg Time
-UP55		(UTC +5:30) Indian Standard Time, Sri Lanka Time
-UP575		(UTC +5:45) Nepal Time
-UP6		(UTC +6:00) Bangladesh Standard Time, Bhutan Time, Omsk Time
-UP65		(UTC +6:30) Cocos Islands, Myanmar
-UP7		(UTC +7:00) Krasnoyarsk Time, Cambodia, Laos, Thailand, Vietnam
-UP8		(UTC +8:00) Australian Western Standard Time, Beijing Time
-UP875		(UTC +8:45) Australian Central Western Standard Time
-UP9		(UTC +9:00) Japan Standard Time, Korea Standard Time, Yakutsk
-UP95		(UTC +9:30) Australian Central Standard Time
-UP10		(UTC +10:00) Australian Eastern Standard Time, Vladivostok Time
-UP105		(UTC +10:30) Lord Howe Island
-UP11		(UTC +11:00) Magadan Time, Solomon Islands, Vanuatu
-UP115		(UTC +11:30) Norfolk Island
-UP12		(UTC +12:00) Fiji, Gilbert Islands, Kamchatka, New Zealand
-UP1275		(UTC +12:45) Chatham Islands Standard Time
-UP13		(UTC +13:00) Phoenix Islands Time, Tonga
-UP14		(UTC +14:00) Line Islands
+===========     =====================================================================
+Time Zone       Location
+===========     =====================================================================
+UM12            (UTC - 12:00) Baker/Howland Island
+UM11            (UTC - 11:00) Samoa Time Zone, Niue
+UM10            (UTC - 10:00) Hawaii-Aleutian Standard Time, Cook Islands
+UM95            (UTC - 09:30) Marquesas Islands
+UM9             (UTC - 09:00) Alaska Standard Time, Gambier Islands
+UM8             (UTC - 08:00) Pacific Standard Time, Clipperton Island
+UM7             (UTC - 11:00) Mountain Standard Time
+UM6             (UTC - 06:00) Central Standard Time
+UM5             (UTC - 05:00) Eastern Standard Time, Western Caribbean
+UM45            (UTC - 04:30) Venezuelan Standard Time
+UM4             (UTC - 04:00) Atlantic Standard Time, Eastern Caribbean
+UM35            (UTC - 03:30) Newfoundland Standard Time
+UM3             (UTC - 03:00) Argentina, Brazil, French Guiana, Uruguay
+UM2             (UTC - 02:00) South Georgia/South Sandwich Islands
+UM1             (UTC -1:00) Azores, Cape Verde Islands
+UTC             (UTC) Greenwich Mean Time, Western European Time
+UP1             (UTC +1:00) Central European Time, West Africa Time
+UP2             (UTC +2:00) Central Africa Time, Eastern European Time
+UP3             (UTC +3:00) Moscow Time, East Africa Time
+UP35            (UTC +3:30) Iran Standard Time
+UP4             (UTC +4:00) Azerbaijan Standard Time, Samara Time
+UP45            (UTC +4:30) Afghanistan
+UP5             (UTC +5:00) Pakistan Standard Time, Yekaterinburg Time
+UP55            (UTC +5:30) Indian Standard Time, Sri Lanka Time
+UP575           (UTC +5:45) Nepal Time
+UP6             (UTC +6:00) Bangladesh Standard Time, Bhutan Time, Omsk Time
+UP65            (UTC +6:30) Cocos Islands, Myanmar
+UP7             (UTC +7:00) Krasnoyarsk Time, Cambodia, Laos, Thailand, Vietnam
+UP8             (UTC +8:00) Australian Western Standard Time, Beijing Time
+UP875           (UTC +8:45) Australian Central Western Standard Time
+UP9             (UTC +9:00) Japan Standard Time, Korea Standard Time, Yakutsk
+UP95            (UTC +9:30) Australian Central Standard Time
+UP10            (UTC +10:00) Australian Eastern Standard Time, Vladivostok Time
+UP105           (UTC +10:30) Lord Howe Island
+UP11            (UTC +11:00) Magadan Time, Solomon Islands, Vanuatu
+UP115           (UTC +11:30) Norfolk Island
+UP12            (UTC +12:00) Fiji, Gilbert Islands, Kamchatka, New Zealand
+UP1275          (UTC +12:45) Chatham Islands Standard Time
+UP13            (UTC +13:00) Phoenix Islands Time, Tonga
+UP14            (UTC +14:00) Line Islands
 ===========	=====================================================================
\ No newline at end of file
diff --git a/user_guide_src/source/helpers/directory_helper.rst b/user_guide_src/source/helpers/directory_helper.rst
index 514e80c96..3004316a8 100644
--- a/user_guide_src/source/helpers/directory_helper.rst
+++ b/user_guide_src/source/helpers/directory_helper.rst
@@ -29,11 +29,11 @@ The following functions are available:
 
 .. function:: directory_map($source_dir[, $directory_depth = 0[, $hidden = FALSE]])
 
-	:param string	$source_dir: path to the ource directory
-	:param integer	$directory_depth: depth of directories to traverse (0 =
-		fully recursive, 1 = current dir, etc)
-	:param boolean	$hidden: whether to include hidden directories
-	:returns: array
+	:param	string	$source_dir: Path to the ource directory
+	:param	int	$directory_depth: Depth of directories to traverse (0 = fully recursive, 1 = current dir, etc)
+	:param	bool	$hidden: Whether to include hidden directories
+	:returns:	An array of files
+	:rtype:	array
 
 	Examples::
 
diff --git a/user_guide_src/source/helpers/download_helper.rst b/user_guide_src/source/helpers/download_helper.rst
index 17b68f454..f374d491f 100644
--- a/user_guide_src/source/helpers/download_helper.rst
+++ b/user_guide_src/source/helpers/download_helper.rst
@@ -29,7 +29,7 @@ The following functions are available:
 	:param	string	$filename: Filename
 	:param	mixed	$data: File contents
 	:param	bool	$set_mime: Whether to try to send the actual MIME type
-	:returns:	void
+	:rtype:	void
 
 	Generates server headers which force data to be downloaded to your
 	desktop. Useful with file downloads. The first parameter is the **name
diff --git a/user_guide_src/source/helpers/email_helper.rst b/user_guide_src/source/helpers/email_helper.rst
index fe3ccdda1..b665ce548 100644
--- a/user_guide_src/source/helpers/email_helper.rst
+++ b/user_guide_src/source/helpers/email_helper.rst
@@ -30,8 +30,9 @@ The following functions are available:
 
 .. function:: valid_email($email)
 
-	:param	string	$email: Email address
-	:returns:	bool
+	:param	string	$email: E-mail address
+	:returns:	TRUE if a valid email is supplied, FALSE otherwise
+	:rtype:	bool
 
 	Checks if the input is a correctly formatted e-mail address. Note that is
 	doesn't actually prove that the address will be able recieve mail, but
@@ -52,13 +53,13 @@ The following functions are available:
 
 		(bool) filter_var($email, FILTER_VALIDATE_EMAIL);
 
-
 .. function:: send_email($recipient, $subject, $message)
 
 	:param	string	$recipient: E-mail address
 	:param	string	$subject: Mail subject
 	:param	string	$message: Message body
-	:returns:	bool
+	:returns:	TRUE if the mail was successfully sent, FALSE in case of an error
+	:rtype:	bool
 
 	Sends an email using PHP's native `mail() <http://www.php.net/function.mail>`_
 	function.
@@ -70,4 +71,4 @@ The following functions are available:
 			mail($recipient, $subject, $message);
 
 	For a more robust email solution, see CodeIgniter's :doc:`Email Library
-	<../libraries/email>`.
+	<../libraries/email>`.
\ No newline at end of file
diff --git a/user_guide_src/source/helpers/file_helper.rst b/user_guide_src/source/helpers/file_helper.rst
index 4d225d278..59cabcce2 100644
--- a/user_guide_src/source/helpers/file_helper.rst
+++ b/user_guide_src/source/helpers/file_helper.rst
@@ -27,7 +27,8 @@ The following functions are available:
 .. function:: read_file($file)
 
 	:param	string	$file: File path
-	:returns:	string or FALSE on failure
+	:returns:	File contents or FALSE on failure
+	:rtype:	string
 
 	Returns the data contained in the file specified in the path.
 
@@ -48,13 +49,13 @@ The following functions are available:
 		function might not work if you are trying to access a file above the
 		calling script.
 
-
 .. function:: write_file($path, $data[, $mode = 'wb'])
 
 	:param	string	$path: File path
 	:param	string	$data: Data to write to file
 	:param	string	$mode: ``fopen()`` mode
-	:returns:	bool
+	:returns:	TRUE if the write was successful, FALSE in case of an error
+	:rtype:	bool
 
 	Writes data to the file specified in the path. If the file does not exist then the
 	function will create it.
@@ -88,13 +89,13 @@ The following functions are available:
 
 	.. note:: This function acquires an exclusive lock on the file while writing to it.
 
-
 .. function:: delete_files($path[, $del_dir = FALSE[, $htdocs = FALSE]])
 
 	:param	string	$path: Directory path
 	:param	bool	$del_dir: Whether to also delete directories
 	:param	bool	$htdocs: Whether to skip deleting .htaccess and index page files
-	:returns:	bool
+	:returns:	TRUE on success, FALSE in case of an error
+	:rtype:	bool
 
 	Deletes ALL files contained in the supplied path.
 
@@ -111,12 +112,12 @@ The following functions are available:
 
 	.. note:: The files must be writable or owned by the system in order to be deleted.
 
-
 .. function:: get_filenames($source_dir[, $include_path = FALSE])
 
 	:param	string	$source_dir: Directory path
 	:param	bool	$include_path: Whether to include the path as part of the filenames
-	:returns:	array
+	:returns:	An array of file names
+	:rtype:	array
 
 	Takes a server path as input and returns an array containing the names of all files
 	contained within it. The file path can optionally be added to the file names by setting
@@ -126,13 +127,12 @@ The following functions are available:
 
 		$controllers = get_filenames(APPPATH.'controllers/');
 
-
 .. function:: get_dir_file_info($source_dir, $top_level_only)
 
 	:param	string	$source_dir: Directory path
-	:param	bool	$top_level_only: Whether to look only at the specified directory
-			(excluding sub-directories)
-	:returns:	array
+	:param	bool	$top_level_only: Whether to look only at the specified directory (excluding sub-directories)
+	:returns:	An array containing info on the supplied directory's contents
+	:rtype:	array
 
 	Reads the specified directory and builds an array containing the filenames, filesize,
 	dates, and permissions. Sub-folders contained within the specified path are only read
@@ -143,12 +143,12 @@ The following functions are available:
 
 		$models_info = get_dir_file_info(APPPATH.'models/');
 
-
 .. function:: get_file_info($file[, $returned_values = array('name', 'server_path', 'size', 'date')])
 
 	:param	string	$file: File path
 	:param	array	$returned_values: What type of info to return
-	:returns:	array or FALSE on failure
+	:returns:	An array containing info on the specified file or FALSE on failure
+	:rtype:	array
 
 	Given a file and path, returns (optionally) the *name*, *path*, *size* and *date modified*
 	information attributes for a file. Second parameter allows you to explicitly declare what
@@ -157,14 +157,11 @@ The following functions are available:
 	Valid ``$returned_values`` options are: `name`, `size`, `date`, `readable`, `writeable`,
 	`executable` and `fileperms`.
 
-	.. note:: The *writable* attribute is checked via PHP's ``is_writeable()`` function, which
-		known to have issues on the IIS webserver. Consider using *fileperms* instead,
-		which returns information from PHP's ``fileperms()`` function.
-
 .. function:: get_mime_by_extension($filename)
 
 	:param	string	$filename: File name
-	:returns:	string or FALSE on failure
+	:returns:	MIME type string or FALSE on failure
+	:rtype:	string
 
 	Translates a filename extension into a MIME type based on *config/mimes.php*.
 	Returns FALSE if it can't determine the type, or read the MIME config file.
@@ -178,11 +175,11 @@ The following functions are available:
 		is here strictly for convenience. It should not be used for security
 		purposes.
 
-
 .. function:: symbolic_permissions($perms)
 
 	:param	int	$perms: Permissions
-	:returns:	string
+	:returns:	Symbolic permissions string
+	:rtype:	string
 
 	Takes numeric permissions (such as is returned by ``fileperms()``) and returns
 	standard symbolic notation of file permissions.
@@ -191,11 +188,11 @@ The following functions are available:
 
 		echo symbolic_permissions(fileperms('./index.php'));  // -rw-r--r--
 
-
 .. function:: octal_permissions($perms)
 
 	:param	int	$perms: Permissions
-	:returns:	string
+	:returns:	Octal permissions string
+	:rtype:	string
 
 	Takes numeric permissions (such as is returned by ``fileperms()``) and returns
 	a three character octal notation of file permissions.
diff --git a/user_guide_src/source/helpers/form_helper.rst b/user_guide_src/source/helpers/form_helper.rst
index dcb5bee21..4fa5f246b 100644
--- a/user_guide_src/source/helpers/form_helper.rst
+++ b/user_guide_src/source/helpers/form_helper.rst
@@ -30,7 +30,8 @@ The following functions are available:
 	:param	string	$action: Form action/target URI string
 	:param	array	$attributes: HTML attributes
 	:param	array	$hidden: An array of hidden fields' definitions
-	:returns:	string
+	:returns:	An HTML form opening tag
+	:rtype:	string
 
 	Creates an opening form tag with a base URL **built from your config preferences**.
 	It will optionally let you add form attributes and hidden input fields, and
@@ -87,7 +88,8 @@ The following functions are available:
 	:param	string	$action: Form action/target URI string
 	:param	array	$attributes: HTML attributes
 	:param	array	$hidden: An array of hidden fields' definitions
-	:returns:	string
+	:returns:	An HTML multipart form opening tag
+	:rtype:	string
 
 	This function is absolutely identical to :func:`form_open()` above,
 	except that it adds a *multipart* attribute, which is necessary if you
@@ -98,7 +100,8 @@ The following functions are available:
 
 	:param	string	$name: Field name
 	:param	string	$value: Field value
-	:returns:	string
+	:returns:	An HTML hidden input field tag
+	:rtype:	string
 
 	Lets you generate hidden input fields. You can either submit a
 	name/value string to create one field::
@@ -159,13 +162,13 @@ The following functions are available:
 			<input type="hidden" name="email" value="john@example.com" id="hiddenemail" class="hiddenemail" />
 		*/
 
-
 .. function:: form_input([$data = ''[, $value = ''[, $extra = '']])
 
 	:param	array	$data: Field attributes data
 	:param	string	$value: Field value
 	:param	string	$extra: Extra attributes to be added to the tag *as is*
-	:returns:	string
+	:returns:	An HTML text input field tag
+	:rtype:	string
 
 	Lets you generate a standard text input field. You can minimally pass
 	the field name and value in the first and second parameter::
@@ -198,13 +201,13 @@ The following functions are available:
 		$js = 'onClick="some_function()"';
 		echo form_input('username', 'johndoe', $js);
 
-
 .. function:: form_password([$data = ''[, $value = ''[, $extra = '']]])
 
 	:param	array	$data: Field attributes data
 	:param	string	$value: Field value
 	:param	string	$extra: Extra attributes to be added to the tag *as is*
-	:returns:	string
+	:returns:	An HTML password input field tag
+	:rtype:	string
 
 	This function is identical in all respects to the :func:`form_input()`
 	function above except that it uses the "password" input type.
@@ -215,7 +218,8 @@ The following functions are available:
 	:param	array	$data: Field attributes data
 	:param	string	$value: Field value
 	:param	string	$extra: Extra attributes to be added to the tag *as is*
-	:returns:	string
+	:returns:	An HTML file upload input field tag
+	:rtype:	string
 
 	This function is identical in all respects to the :func:`form_input()`
 	function above except that it uses the "file" input type, allowing it to
@@ -227,7 +231,8 @@ The following functions are available:
 	:param	array	$data: Field attributes data
 	:param	string	$value: Field value
 	:param	string	$extra: Extra attributes to be added to the tag *as is*
-	:returns:	string
+	:returns:	An HTML textarea tag
+	:rtype:	string
 
 	This function is identical in all respects to the :func:`form_input()`
 	function above except that it generates a "textarea" type.
@@ -235,14 +240,14 @@ The following functions are available:
 	.. note:: Instead of the *maxlength* and *size* attributes in the above example,
 		you will instead specify *rows* and *cols*.
 
-
 .. function:: form_dropdown([$name = ''[, $options = array()[, $selected = array()[, $extra = '']]]])
 
 	:param	string	$name: Field name
 	:param	array	$options: An associative array of options to be listed
 	:param	array	$selected: List of fields to mark with the *selected* attribute
 	:param	string	$extra: Extra attributes to be added to the tag *as is*
-	:returns:	string
+	:returns:	An HTML dropdown select field tag
+	:rtype:	string
 
 	Lets you create a standard drop-down field. The first parameter will
 	contain the name of the field, the second parameter will contain an
@@ -305,7 +310,8 @@ The following functions are available:
 	:param	array	$options: An associative array of options to be listed
 	:param	array	$selected: List of fields to mark with the *selected* attribute
 	:param	string	$extra: Extra attributes to be added to the tag *as is*
-	:returns:	string
+	:returns:	An HTML dropdown multiselect field tag
+	:rtype:	string
 
 	Lets you create a standard multiselect field. The first parameter will
 	contain the name of the field, the second parameter will contain an
@@ -321,7 +327,8 @@ The following functions are available:
 
 	:param	string	$legend_text: Text to put in the <legend> tag
 	:param	array	$attributes: Attributes to be set on the <fieldset> tag
-	:returns:	string
+	:returns:	An HTML fieldset opening tag
+	:rtype:	string
 
 	Lets you generate fieldset/legend fields.
 
@@ -365,7 +372,9 @@ The following functions are available:
 .. function:: form_fieldset_close([$extra = ''])
 
 	:param	string	$extra: Anything to append after the closing tag, *as is*
-	:returns:	string
+	:returns:	An HTML fieldset closing tag
+	:rtype:	string
+	
 
 	Produces a closing </fieldset> tag. The only advantage to using this
 	function is it permits you to pass data to it which will be added below
@@ -384,7 +393,8 @@ The following functions are available:
 	:param	string	$value: Field value
 	:param	bool	$checked: Whether to mark the checkbox as being *checked*
 	:param	string	$extra: Extra attributes to be added to the tag *as is*
-	:returns:	string
+	:returns:	An HTML checkbox input tag
+	:rtype:	string
 
 	Lets you generate a checkbox field. Simple example::
 
@@ -422,7 +432,8 @@ The following functions are available:
 	:param	string	$value: Field value
 	:param	bool	$checked: Whether to mark the radio button as being *checked*
 	:param	string	$extra: Extra attributes to be added to the tag *as is*
-	:returns:	string
+	:returns:	An HTML radio input tag
+	:rtype:	string
 
 	This function is identical in all respects to the :func:`form_checkbox()`
 	function above except that it uses the "radio" input type.
@@ -433,7 +444,8 @@ The following functions are available:
 	:param	string	$label_text: Text to put in the <label> tag
 	:param	string	$id: ID of the form element that we're making a label for
 	:param	string	$attributes: HTML attributes
-	:returns:	string
+	:returns:	An HTML field label tag
+	:rtype:	string
 
 	Lets you generate a <label>. Simple example::
 
@@ -459,7 +471,8 @@ The following functions are available:
 	:param	string	$data: Button name
 	:param	string	$value: Button value
 	:param	string	$extra: Extra attributes to be added to the tag *as is*
-	:returns:	string
+	:returns:	An HTML input submit tag
+	:rtype:	string
 
 	Lets you generate a standard submit button. Simple example::
 
@@ -476,7 +489,8 @@ The following functions are available:
 	:param	string	$data: Button name
 	:param	string	$value: Button value
 	:param	string	$extra: Extra attributes to be added to the tag *as is*
-	:returns:	string
+	:returns:	An HTML input reset button tag
+	:rtype:	string
 
 	Lets you generate a standard reset button. Use is identical to
 	:func:`form_submit()`.
@@ -487,7 +501,8 @@ The following functions are available:
 	:param	string	$data: Button name
 	:param	string	$content: Button label
 	:param	string	$extra: Extra attributes to be added to the tag *as is*
-	:returns:	string
+	:returns:	An HTML button tag
+	:rtype:	string
 
 	Lets you generate a standard button element. You can minimally pass the
 	button name and content in the first and second parameter::
@@ -519,7 +534,8 @@ The following functions are available:
 .. function:: form_close([$extra = ''])
 
 	:param	string	$extra: Anything to append after the closing tag, *as is*
-	:returns:	string
+	:returns:	An HTML form closing tag
+	:rtype:	string
 
 	Produces a closing </form> tag. The only advantage to using this
 	function is it permits you to pass data to it which will be added below
@@ -534,7 +550,8 @@ The following functions are available:
 
 	:param	string	$str: Value to escape
 	:param	bool	$is_textarea: Whether we're preparing for <textarea> or a regular input tag
-	:returns:	string
+	:returns:	Escaped value
+	:rtype:	string
 
 	Allows you to safely use HTML and characters such as quotes within form
 	elements without breaking out of the form.
@@ -560,7 +577,8 @@ The following functions are available:
 	:param	string	$field: Field name
 	:param	string	$default: Default value
 	:param	bool	$is_textarea: Whether we're setting <textarea> content
-	:returns:	string
+	:returns:	Field value
+	:rtype:	string
 
 	Permits you to set the value of an input form or textarea. You must
 	supply the field name via the first parameter of the function. The
@@ -579,7 +597,8 @@ The following functions are available:
 	:param	string	$field: Field name
 	:param	string	$value: Value to check for
 	:param	string	$default: Whether the value is also a default one
-	:returns:	string
+	:returns:	'selected' attribute or an empty string
+	:rtype:	string
 
 	If you use a <select> menu, this function permits you to display the
 	menu item that was selected.
@@ -596,13 +615,13 @@ The following functions are available:
 			<option value="three" <?php echo  set_select('myselect', 'three'); ?> >Three</option>
 		</select>
 
-
 .. function:: set_checkbox([$field = ''[, $value = ''[, $default = FALSE]]])
 
 	:param	string	$field: Field name
 	:param	string	$value: Value to check for
 	:param	string	$default: Whether the value is also a default one
-	:returns:	string
+	:returns:	'checked' attribute or an empty string
+	:rtype:	string
 
 	Permits you to display a checkbox in the state it was submitted.
 
@@ -615,13 +634,13 @@ The following functions are available:
 		<input type="checkbox" name="mycheck" value="1" <?php echo set_checkbox('mycheck', '1'); ?> />
 		<input type="checkbox" name="mycheck" value="2" <?php echo set_checkbox('mycheck', '2'); ?> />
 
-
 .. function:: set_radio([$field = ''[, $value = ''[, $default = FALSE]]])
 
 	:param	string	$field: Field name
 	:param	string	$value: Value to check for
 	:param	string	$default: Whether the value is also a default one
-	:returns:	string
+	:returns:	'checked' attribute or an empty string
+	:rtype:	string
 
 	Permits you to display radio buttons in the state they were submitted.
 	This function is identical to the :func:`set_checkbox()` function above.
@@ -637,13 +656,13 @@ The following functions are available:
 		defined, the control for ``set_*()`` is handed over to a method of the
 		class instead of the generic helper function.
 
-
 .. function:: form_error([$field = ''[, $prefix = ''[, $suffix = '']]])
 
 	:param	string	$field:	Field name
 	:param	string	$prefix: Error opening tag
 	:param	string	$suffix: Error closing tag
-	:returns:	string
+	:returns:	HTML-formatted form validation error message(s)
+	:rtype:	string
 
 	Returns a validation error message from the :doc:`Form Validation Library
 	<../libraries/form_validation>`, associated with the specified field name.
@@ -662,7 +681,8 @@ The following functions are available:
 
 	:param	string	$prefix: Error opening tag
 	:param	string	$suffix: Error closing tag
-	:returns:	string
+	:returns:	HTML-formatted form validation error message(s)
+	:rtype:	string
 
 	Similarly to the :func:`form_error()` function, returns all validation
 	error messages produced by the :doc:`Form Validation Library
diff --git a/user_guide_src/source/helpers/html_helper.rst b/user_guide_src/source/helpers/html_helper.rst
index 9e9d7ca62..3324da8c0 100644
--- a/user_guide_src/source/helpers/html_helper.rst
+++ b/user_guide_src/source/helpers/html_helper.rst
@@ -28,7 +28,8 @@ The following functions are available:
 .. function:: br([$count = 1])
 
 	:param	int	$count: Number of times to repeat the tag
-	:returns:	string
+	:returns:	HTML line break tag
+	:rtype:	string
 
 	Generates line break tags (<br />) based on the number you submit.
 	Example::
@@ -41,13 +42,13 @@ The following functions are available:
 
 		<br /><br /><br />
 
-
 .. function:: heading([$data = ''[, $h = '1'[, $attributes = '']]])
 
 	:param	string	$data: Content
 	:param	string	$h: Heading level
 	:param	array	$attributes: HTML attributes
-	:returns:	string
+	:returns:	HTML heading tag
+	:rtype:	string
 
 	Lets you create HTML heading tags. The first parameter will contain the
 	data, the second the size of the heading. Example::
@@ -67,13 +68,13 @@ The following functions are available:
 
 		<h3 class="pink">Welcome!<h3>
 
-
 .. function:: img([$src = ''[, $index_page = FALSE[, $attributes = '']]])
 
 	:param	string	$src: Image source data
 	:param	bool	$index_page: Whether to treat $src as a routed URI string
 	:param	array	$attributes: HTML attributes
-	:returns:	string
+	:returns:	HTML image tag
+	:rtype:	string
 
 	Lets you create HTML <img /> tags. The first parameter contains the
 	image source. Example::
@@ -106,8 +107,7 @@ The following functions are available:
 		img($image_properties);
 		// <img src="http://site.com/index.php/images/picture.jpg" alt="Me, demonstrating how to eat 4 slices of pizza at one time" class="post_images" width="200" height="200" title="That was quite a night" rel="lightbox" />
 
-
-.. function:: ling_tag([$href = ''[, $rel = 'stylesheet'[, $type = 'text/css'[, $title = ''[, $media = ''[, $index_page = FALSE]]]]]])
+.. function:: link_tag([$href = ''[, $rel = 'stylesheet'[, $type = 'text/css'[, $title = ''[, $media = ''[, $index_page = FALSE]]]]]])
 
 	:param	string	$href: What are we linking to
 	:param	string	$rel: Relation type
@@ -115,7 +115,8 @@ The following functions are available:
 	:param	string	$title: Link title
 	:param	string	$media: Media type
 	:param	bool	$index_page: Whether to treat $src as a routed URI string
-	:returns:	string
+	:returns:	HTML link tag
+	:rtype:	string
 
 	Lets you create HTML <link /> tags. This is useful for stylesheet links,
 	as well as other links. The parameters are *href*, with optional *rel*,
@@ -150,11 +151,11 @@ The following functions are available:
 		echo link_tag($link);
 		// <link href="http://site.com/css/printer.css" rel="stylesheet" type="text/css" media="print" />
 
-
 .. function:: nbs([$num = 1])
 
 	:param	int	$num: Number of space entities to produce
-	:returns:	string
+	:returns:	A sequence of non-breaking space HTML entities
+	:rtype:	string
 
 	Generates non-breaking spaces (&nbsp;) based on the number you submit.
 	Example::
@@ -172,7 +173,8 @@ The following functions are available:
 
 	:param	array	$list: List entries
 	:param	array	$attributes: HTML attributes
-	:returns:	string
+	:returns:	HTML-formatted unordered list
+	:rtype:	string
 
 	Permits you to generate ordered or unordered HTML lists from simple or
 	multi-dimensional arrays. Example::
@@ -291,19 +293,20 @@ The following functions are available:
 
 	:param	array	$list: List entries
 	:param	array	$attributes: HTML attributes
-	:returns:	string
+	:returns:	HTML-formatted ordered list
+	:rtype:	string
 
 	Identical to :func:`ul()`, only it produces the <ol> tag for
 	ordered lists instead of <ul>.
 
-
 .. function:: meta([$name = ''[, $content = ''[, $type = 'name'[, $newline = "\n"]]]])
 
 	:param	string	$name: Meta name
 	:param	string	$content: Meta content
 	:param	string	$type: Meta type
 	:param	string	$newline: Newline character
-	:returns:	string
+	:returns:	HTML meta tag
+	:rtype:	string
 
 	Helps you generate meta tags. You can pass strings to the function, or
 	simple arrays, or multidimensional ones.
@@ -355,6 +358,8 @@ The following functions are available:
 .. function:: doctype([$type = 'xhtml1-strict'])
 
 	:param	string	$type: Doctype name
+	:returns:	HTML DocType tag
+	:rtype:	string
 
 	Helps you generate document type declarations, or DTD's. XHTML 1.0
 	Strict is used by default, but many doctypes are available.
@@ -368,44 +373,26 @@ The following functions are available:
 	The following is a list of doctype choices. These are configurable, and
 	pulled from application/config/doctypes.php
 
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| Doctype                       | Option                       | Result                                                                                                                                           |
-	+===============================+==============================+==================================================================================================================================================+
-	| XHTML 1.1                     | doctype('xhtml11')           | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">                                                |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| XHTML 1.0 Strict              | doctype('xhtml1-strict')     | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">                                    |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| XHTML 1.0 Transitional        | doctype('xhtml1-trans')      | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">                        |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| XHTML 1.0 Frameset            | doctype('xhtml1-frame')      | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">                                |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| XHTML Basic 1.1               | doctype('xhtml-basic11')     | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.1//EN" "http://www.w3.org/TR/xhtml-basic/xhtml-basic11.dtd">                                    |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| HTML 5                        | doctype('html5')             | <!DOCTYPE html>                                                                                                                                  |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| HTML 4 Strict                 | doctype('html4-strict')      | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">                                                       |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| HTML 4 Transitional           | doctype('html4-trans')       | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">                                           |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| HTML 4 Frameset               | doctype('html4-frame')       | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">                                            |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| MathML 1.01                   | doctype('mathml1')	       | <!DOCTYPE math SYSTEM "http://www.w3.org/Math/DTD/mathml1/mathml.dtd">                                                                           |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| MathML 2.0                    | doctype('mathml2')           | <!DOCTYPE math PUBLIC "-//W3C//DTD MathML 2.0//EN" "http://www.w3.org/Math/DTD/mathml2/mathml2.dtd">                                             |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| SVG 1.0                       | doctype('svg10')             | <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.0//EN" "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">                                       |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| SVG 1.1 Full                  | doctype('svg11')             | <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">                                               |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| SVG 1.1 Basic                 | doctype('svg11-basic')       | <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1 Basic//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-basic.dtd">                                   |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| SVG 1.1 Tiny                  | doctype('svg11-tiny')        | <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1 Tiny//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-tiny.dtd">                                     |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| XHTML+MathML+SVG (XHTML host) | doctype('xhtml-math-svg-xh') | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd">    |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| XHTML+MathML+SVG (SVG host)   | doctype('xhtml-math-svg-sh') | <!DOCTYPE svg:svg PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd"> |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| XHTML+RDFa 1.0                | doctype('xhtml-rdfa-1')      | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML+RDFa 1.0//EN" "http://www.w3.org/MarkUp/DTD/xhtml-rdfa-1.dtd">                                          |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-	| XHTML+RDFa 1.1                | doctype('xhtml-rdfa-2')      | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML+RDFa 1.1//EN" "http://www.w3.org/MarkUp/DTD/xhtml-rdfa-2.dtd">                                          |
-	+-------------------------------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
\ No newline at end of file
+	=============================== =================== ==================================================================================================================================================
+	Document type                   Option              Result
+	=============================== =================== ==================================================================================================================================================
+	XHTML 1.1                       xhtml11             <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+	XHTML 1.0 Strict                xhtml1-strict       <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+	XHTML 1.0 Transitional          xhtml1-trans        <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+	XHTML 1.0 Frameset              xhtml1-frame        <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
+	XHTML Basic 1.1                 xhtml-basic11       <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.1//EN" "http://www.w3.org/TR/xhtml-basic/xhtml-basic11.dtd">
+	HTML 5                          html5               <!DOCTYPE html>
+	HTML 4 Strict                   html4-strict        <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+	HTML 4 Transitional             html4-trans         <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+	HTML 4 Frameset                 html4-frame         <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">
+	MathML 1.01                     mathml1             <!DOCTYPE math SYSTEM "http://www.w3.org/Math/DTD/mathml1/mathml.dtd">
+	MathML 2.0                      mathml2             <!DOCTYPE math PUBLIC "-//W3C//DTD MathML 2.0//EN" "http://www.w3.org/Math/DTD/mathml2/mathml2.dtd">
+	SVG 1.0                         svg10               <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.0//EN" "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">
+	SVG 1.1 Full                    svg11               <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+	SVG 1.1 Basic                   svg11-basic         <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1 Basic//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-basic.dtd">
+	SVG 1.1 Tiny                    svg11-tiny          <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1 Tiny//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-tiny.dtd">
+	XHTML+MathML+SVG (XHTML host)   xhtml-math-svg-xh   <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd">
+	XHTML+MathML+SVG (SVG host)     xhtml-math-svg-sh   <!DOCTYPE svg:svg PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd">
+	XHTML+RDFa 1.0                  xhtml-rdfa-1        <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML+RDFa 1.0//EN" "http://www.w3.org/MarkUp/DTD/xhtml-rdfa-1.dtd">
+	XHTML+RDFa 1.1                  xhtml-rdfa-2        <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML+RDFa 1.1//EN" "http://www.w3.org/MarkUp/DTD/xhtml-rdfa-2.dtd">
+	=============================== =================== ==================================================================================================================================================
\ No newline at end of file
diff --git a/user_guide_src/source/helpers/inflector_helper.rst b/user_guide_src/source/helpers/inflector_helper.rst
index 717ecc678..d0cb17c18 100644
--- a/user_guide_src/source/helpers/inflector_helper.rst
+++ b/user_guide_src/source/helpers/inflector_helper.rst
@@ -28,50 +28,51 @@ The following functions are available:
 .. function:: singular($str)
 
 	:param	string	$str: Input string
-	:returns:	string
+	:returns:	A singular word
+	:rtype:	string
 
 	Changes a plural word to singular. Example::
 
 		echo singular('dogs'); // Prints 'dog'
 
-
 .. function:: plural($str)
 
 	:param	string	$str: Input string
-	:returns:	string
+	:returns:	A plular word
+	:rtype:	string
 
 	Changes a singular word to plural. Example::
 
 		echo plural('dog'); // Prints 'dogs'
 
-
 .. function:: camelize($str)
 
 	:param	string	$str: Input string
-	:returns:	string
+	:returns:	Camelized string
+	:rtype:	string
 
 	Changes a string of words separated by spaces or underscores to camel
 	case. Example::
 
 		echo camelize('my_dog_spot'); // Prints 'myDogSpot'
 
-
 .. function:: underscore($str)
 
 	:param	string	$str: Input string
-	:returns:	string
+	:returns:	String containing underscores instead of spaces
+	:rtype:	string
 
 	Takes multiple words separated by spaces and underscores them.
 	Example::
 
 		echo underscore('my dog spot'); // Prints 'my_dog_spot'
 
-
 .. function:: humanize($str[, $separator = '_'])
 
 	:param	string	$str: Input string
 	:param	string	$separator: Input separator
-	:returns:	string
+	:returns:	Humanized string
+	:rtype:	string
 
 	Takes multiple words separated by underscores and adds spaces between
 	them. Each word is capitalized.
@@ -84,11 +85,11 @@ The following functions are available:
 
 		echo humanize('my-dog-spot', '-'); // Prints 'My Dog Spot'
 
-
 .. function:: is_countable($word)
 
 	:param	string	$word: Input string
-	:returns:	bool
+	:returns:	TRUE if the word is countable or FALSE if not
+	:rtype:	bool
 
 	Checks if the given word has a plural version. Example::
 
diff --git a/user_guide_src/source/helpers/language_helper.rst b/user_guide_src/source/helpers/language_helper.rst
index 9e5d9bdc9..e4d093725 100644
--- a/user_guide_src/source/helpers/language_helper.rst
+++ b/user_guide_src/source/helpers/language_helper.rst
@@ -27,16 +27,17 @@ The following functions are available:
 
 .. function:: lang($line[, $for = ''[, $attributes = array()]])
 
-  :param	string	$line: Language line key
-  :param	string	$for: HTML "for" attribute (ID of the element we're creating a label for)
-  :param	array	$attributes: Any additional HTML attributes
-  :returns:	string
+ 	:param	string	$line: Language line key
+ 	:param	string	$for: HTML "for" attribute (ID of the element we're creating a label for)
+ 	:param	array	$attributes: Any additional HTML attributes
+ 	:returns:	HTML-formatted language line label
+	:rtype:	string
 
-  This function returns a line of text from a loaded language file with
-  simplified syntax that may be more desirable for view files than
-  ``CI_Lang::line()``.
+	This function returns a line of text from a loaded language file with
+	simplified syntax that may be more desirable for view files than
+	``CI_Lang::line()``.
 
-  Example::
+	Example::
 
-  	echo lang('language_key', 'form_item_id', array('class' => 'myClass');
-  	// Outputs: <label for="form_item_id" class="myClass">Language line</label>
\ No newline at end of file
+		echo lang('language_key', 'form_item_id', array('class' => 'myClass'));
+		// Outputs: <label for="form_item_id" class="myClass">Language line</label>
\ No newline at end of file
diff --git a/user_guide_src/source/helpers/number_helper.rst b/user_guide_src/source/helpers/number_helper.rst
index 5a3d72b00..2de4457d9 100644
--- a/user_guide_src/source/helpers/number_helper.rst
+++ b/user_guide_src/source/helpers/number_helper.rst
@@ -29,7 +29,8 @@ The following functions are available:
 
 	:param	mixed	$num: Number of bytes
 	:param	int	$precision: Floating point precision
-	:returns:	string
+	:returns:	Formatted data size string
+	:rtype:	string
 
 	Formats numbers as bytes, based on size, and adds the appropriate
 	suffix. Examples::
@@ -48,4 +49,4 @@ The following functions are available:
 		 echo byte_format(45678, 2); // Returns 44.61 KB
 
 	.. note:: The text generated by this function is found in the following
-		language file: `language/<your_lang>/number_lang.php`
\ No newline at end of file
+		language file: *language/<your_lang>/number_lang.php*
\ No newline at end of file
diff --git a/user_guide_src/source/helpers/path_helper.rst b/user_guide_src/source/helpers/path_helper.rst
index 61877d75b..705ca23b9 100644
--- a/user_guide_src/source/helpers/path_helper.rst
+++ b/user_guide_src/source/helpers/path_helper.rst
@@ -29,7 +29,8 @@ The following functions are available:
 
 	:param	string	$path: Path
 	:param	bool	$check_existance: Whether to check if the path actually exists
-	:returns:	string
+	:returns:	An absolute path
+	:rtype:	string
 
 	This function will return a server path without symbolic links or
 	relative directory structures. An optional second argument will
diff --git a/user_guide_src/source/helpers/security_helper.rst b/user_guide_src/source/helpers/security_helper.rst
index 7df85d017..2e26890b0 100644
--- a/user_guide_src/source/helpers/security_helper.rst
+++ b/user_guide_src/source/helpers/security_helper.rst
@@ -28,18 +28,19 @@ The following functions are available:
 
 	:param	string	$str: Input data
 	:param	bool	$is_image: Whether we're dealing with an image
-	:returns:	string
+	:returns:	XSS-clean string
+	:rtype:	string
 
 	Provides Cross Site Script Hack filtering.
 
 	This function is an alias for ``CI_Input::xss_clean()``. For more info,
 	please see the :doc:`Input Library <../libraries/input>` documentation.
 
-
 .. function:: sanitize_filename($filename)
 
 	:param	string	$filename: Filename
-	:returns:	string
+	:returns:	Sanitized file name
+	:rtype:	string
 
 	Provides protection against directory traversal.
 
@@ -52,7 +53,8 @@ The following functions are available:
 
 	:param	string	$str: Input
 	:param	string	$type: Algorithm
-	:returns:	string
+	:returns:	Hex-formatted hash
+	:rtype:	string
 
 	Permits you to create one way hashes suitable for encrypting
 	passwords. Will use SHA1 by default.
@@ -73,8 +75,9 @@ The following functions are available:
 
 .. function:: strip_image_tags($str)
 
-	:param	string	$str: Input
-	:returns:	string
+	:param	string	$str: Input string
+	:returns:	The input string with no image tags
+	:rtype:	string
 
 	This is a security function that will strip image tags from a string.
 	It leaves the image URL as plain text.
@@ -90,8 +93,9 @@ The following functions are available:
 
 .. function:: encode_php_tags($str)
 
-	:param	string	$str: Input
-	:returns:	string
+	:param	string	$str: Input string
+	:returns:	Safely formatted string
+	:rtype:	string
 
 	This is a security function that converts PHP tags to entities.
 
diff --git a/user_guide_src/source/helpers/smiley_helper.rst b/user_guide_src/source/helpers/smiley_helper.rst
index 077c56a17..b98084089 100644
--- a/user_guide_src/source/helpers/smiley_helper.rst
+++ b/user_guide_src/source/helpers/smiley_helper.rst
@@ -116,7 +116,8 @@ Available Functions
 
 	:param	string	$image_url: URL path to the smileys directory
 	:param	string	$alias: Field alias
-	:returns:	array
+	:returns:	An array of ready to use smileys
+	:rtype:	array
 
 	Returns an array containing your smiley images wrapped in a clickable
 	link. You must supply the URL to your smiley folder and a field id or
@@ -124,14 +125,15 @@ Available Functions
 
 	Example::
 
-		$image_array = get_smiley_links("http://example.com/images/smileys/", "comment");
-
+		$image_array = get_clickable_smileys('http://example.com/images/smileys/', 'comment');
 
 .. function:: smiley_js([$alias = ''[, $field_id = ''[, $inline = TRUE]]])
 
 	:param	string	$alias: Field alias
 	:param	string	$field_id: Field ID
 	:param	bool	$inline: Whether we're inserting an inline smiley
+	:returns:	Smiley-enabling JavaScript code
+	:rtype:	string
 
 	Generates the JavaScript that allows the images to be clicked and
 	inserted into a form field. If you supplied an alias instead of an id
@@ -143,13 +145,13 @@ Available Functions
 
 		<?php echo smiley_js(); ?>
 
-
 .. function:: parse_smileys([$str = ''[, $image_url = ''[, $smileys = NULL]]])
 
 	:param	string	$str: Text containing smiley codes
 	:param	string	$image_url: URL path to the smileys directory
 	:param	array	$smileys: An array of smileys
-	:returns:	string
+	:returns:	Parsed smileys
+	:rtype:	string
 
 	Takes a string of text as input and replaces any contained plain text
 	smileys into the image equivalent. The first parameter must contain your
diff --git a/user_guide_src/source/helpers/string_helper.rst b/user_guide_src/source/helpers/string_helper.rst
index 1ca654ea6..922bc6b8d 100644
--- a/user_guide_src/source/helpers/string_helper.rst
+++ b/user_guide_src/source/helpers/string_helper.rst
@@ -29,7 +29,8 @@ The following functions are available:
 
 	:param	string	$type: Randomization type
 	:param	int	$len: Output string length
-	:returns:	string
+	:returns:	A random string
+	:rtype:	string
 
 	Generates a random string based on the type and length you specify.
 	Useful for creating passwords or generating random hashes.
@@ -52,13 +53,13 @@ The following functions are available:
 	.. note:: Usage of the *unique* and *encrypt* types is DEPRECATED. They
 		are just aliases for *md5* and *sha1* respectively.
 
-
 .. function:: increment_string($str[, $separator = '_'[, $first = 1]])
 
 	:param	string	$str: Input string
 	:param	string	$separator: Separator to append a duplicate number with
 	:param	int	$first: Starting number
-	:returns:	string
+	:returns:	An incremented string
+	:rtype:	string
 
 	Increments a string by appending a number to it or increasing the
 	number. Useful for creating "copies" or a file or duplicating database
@@ -74,7 +75,8 @@ The following functions are available:
 .. function:: alternator($args)
 
 	:param	mixed	$args: A variable number of arguments
-	:returns:	mixed
+	:returns:	Alternated string(s)
+	:rtype:	mixed
 
 	Allows two or more items to be alternated between, when cycling through
 	a loop. Example::
@@ -97,12 +99,12 @@ The following functions are available:
 	.. note:: To use multiple separate calls to this function simply call the
 		function with no arguments to re-initialize.
 
-
 .. function:: repeater($data[, $num = 1])
 
 	:param	string	$data: Input
 	:param	int	$num: Number of times to repeat
-	:returns:	string
+	:returns:	Repeated string
+	:rtype:	string
 
 	Generates repeating copies of the data you submit. Example::
 
@@ -118,7 +120,8 @@ The following functions are available:
 .. function:: reduce_double_slashes($str)
 
 	:param	string	$str: Input string
-	:returns:	string
+	:returns:	A string with normalized slashes
+	:rtype:	string
 
 	Converts double slashes in a string to a single slash, except those
 	found in URL protocol prefixes (e.g. http://).
@@ -131,10 +134,11 @@ The following functions are available:
 
 .. function:: strip_slashes($data)
 
-	:param	array	$data: Input
-	:returns:	array
+	:param	mixed	$data: Input string or an array of strings
+	:returns:	String(s) with stripped slashes
+	:rtype:	mixed
 
-Removes any slashes from an array of strings.
+	Removes any slashes from an array of strings.
 
 	Example::
 
@@ -156,11 +160,11 @@ Removes any slashes from an array of strings.
 		and handle string inputs. This however makes it just an
 		alias for ``stripslashes()``.
 
-
 .. function:: trim_slashes($str)
 
 	:param	string	$str: Input string
-	:returns:	string
+	:returns:	Slash-trimmed string
+	:rtype:	string
 
 	Removes any leading/trailing slashes from a string. Example::
 
@@ -171,13 +175,13 @@ Removes any slashes from an array of strings.
 		|
 		| trim($str, '/');
 
-
 .. function:: reduce_multiples($str[, $character = ''[, $trim = FALSE]])
 
 	:param	string	$str: Text to search in
 	:param	string	$character: Character to reduce
 	:param	bool	$trim: Whether to also trim the specified character
-	:returns:	string
+	:returns:	Reduced string
+	:rtype:	string
 
 	Reduces multiple instances of a particular character occuring directly
 	after each other. Example::
@@ -191,11 +195,11 @@ Removes any slashes from an array of strings.
 		$string = ",Fred, Bill,, Joe, Jimmy,";
 		$string = reduce_multiples($string, ", ", TRUE); //results in "Fred, Bill, Joe, Jimmy"
 
-
 .. function:: quotes_to_entities($str)
 
 	:param	string	$str: Input string
-	:returns:	string
+	:returns:	String with quotes converted to HTML entities
+	:rtype:	string
 
 	Converts single and double quotes in a string to the corresponding HTML
 	entities. Example::
@@ -207,7 +211,8 @@ Removes any slashes from an array of strings.
 .. function:: strip_quotes($str)
 
 	:param	string	$str: Input string
-	:returns:	string
+	:returns:	String with quotes stripped
+	:rtype:	string
 
 	Removes single and double quotes from a string. Example::
 
diff --git a/user_guide_src/source/helpers/text_helper.rst b/user_guide_src/source/helpers/text_helper.rst
index 788fe8b0c..88a6d0658 100644
--- a/user_guide_src/source/helpers/text_helper.rst
+++ b/user_guide_src/source/helpers/text_helper.rst
@@ -29,7 +29,8 @@ The following functions are available:
 	:param	string	$str: Input string
 	:param	int	$limit: Limit
 	:param	string	$end_char: End character (usually an ellipsis)
-	:returns:	string
+	:returns:	Word-limited string
+	:rtype:	string
 
 	Truncates a string to the number of *words* specified. Example::
 
@@ -46,7 +47,8 @@ The following functions are available:
 	:param	string	$str: Input string
 	:param	int	$n: Number of characters
 	:param	string	$end_char: End character (usually an ellipsis)
-	:returns:	string
+	:returns:	Character-limited string
+	:rtype:	string
 
 	Truncates a string to the number of *characters* specified. It
 	maintains the integrity of words so the character count may be slightly
@@ -64,11 +66,11 @@ The following functions are available:
 	.. note:: If you need to truncate to an exact number of characters please
 		see the :func:`ellipsize()` function below.
 
-
 .. function:: ascii_to_entities($str)
 
 	:param	string	$str: Input string
-	:returns:	string
+	:returns:	A string with ASCII values converted to entities
+	:rtype:	string
 
 	Converts ASCII values to character entities, including high ASCII and MS
 	Word characters that can cause problems when used in a web page, so that
@@ -82,21 +84,21 @@ The following functions are available:
 
 		$string = ascii_to_entities($string);
 
-
 .. function::entities_to_ascii($str[, $all = TRUE])
 
 	:param	string	$str: Input string
 	:param	bool	$all: Whether to convert unsafe entities as well
-	:returns:	string
+	:returns:	A string with HTML entities converted to ASCII characters
+	:rtype:	string
 
 	This function does the opposite of :func:`ascii_to_entities()`.
 	It turns character entities back into ASCII.
 
-
 .. function:: convert_accented_characters($str)
 
 	:param	string	$str: Input string
-	:returns:	string
+	:returns:	A string with accented characters converted
+	:rtype:	string
 
 	Transliterates high ASCII characters to low ASCII equivalents. Useful
 	when non-English characters need to be used where only standard ASCII
@@ -110,13 +112,13 @@ The following functions are available:
 		`application/config/foreign_chars.php` to define the to and
 		from array for transliteration.
 
-
 .. function:: word_censor($str, $censored[, $replacement = ''])
 
 	:param	string	$str: Input string
 	:param	array	$censored: List of bad words to censor
 	:param	string	$replacement: What to replace bad words with
-	:returns:	string
+	:returns:	Censored string
+	:rtype:	string
 
 	Enables you to censor words within a text string. The first parameter
 	will contain the original string. The second will contain an array of
@@ -129,11 +131,11 @@ The following functions are available:
 		$disallowed = array('darn', 'shucks', 'golly', 'phooey');
 		$string = word_censor($string, $disallowed, 'Beep!');
 
-
 .. function:: highlight_code($str)
 
 	:param	string	$str: Input string
-	:returns:	string
+	:returns:	String with code highlighted via HTML
+	:rtype:	string
 
 	Colorizes a string of code (PHP, HTML, etc.). Example::
 
@@ -149,7 +151,8 @@ The following functions are available:
 	:param	string	$phrase: Phrase to highlight
 	:param	string	$tag_open: Opening tag used for the highlight
 	:param	string	$tag_close: Closing tag for the highlight
-	:returns:	string
+	:returns:	String with a phrase highlighted via HTML
+	:rtype:	string
 
 	Will highlight a phrase within a text string. The first parameter will
 	contain the original string, the second will contain the phrase you wish
@@ -175,12 +178,12 @@ The following functions are available:
 				color: #000;
 			};
 
-
 .. function:: word_wrap($str[, $charlim = 76])
 
 	:param	string	$str: Input string
 	:param	int	$charlim: Character limit
-	:returns:	string
+	:returns:	Word-wrapped string
+	:rtype:	string
 
 	Wraps text at the specified *character* count while maintaining
 	complete words.
@@ -192,15 +195,14 @@ The following functions are available:
 
 		// Would produce:  Here is a simple string of text that will help us demonstrate this function
 
-
 .. function:: ellipsize($str, $max_length[, $position = 1[, $ellipsis = '&hellip;']])
 
 	:param	string	$str: Input string
 	:param	int	$max_length: String length limit
-	:param	mixed	$position: Position to split at
-			(int or float)
+	:param	mixed	$position: Position to split at (int or float)
 	:param	string	$ellipsis: What to use as the ellipsis character
-	:returns:	string
+	:returns:	Ellipsized string
+	:rtype:	string
 
 	This function will strip tags from a string, split it at a defined
 	maximum length, and insert an ellipsis.
diff --git a/user_guide_src/source/helpers/typography_helper.rst b/user_guide_src/source/helpers/typography_helper.rst
index d32befac1..deb3d164e 100644
--- a/user_guide_src/source/helpers/typography_helper.rst
+++ b/user_guide_src/source/helpers/typography_helper.rst
@@ -29,7 +29,8 @@ The following functions are available:
 
 	:param	string	$str: Input string
 	:param	bool	$reduce_linebreaks: Whether to reduce multiple instances of double newlines to two
-	:returns:	string
+	:returns:	HTML-formatted typography-safe string
+	:rtype: string
 
 	Formats text so that it is semantically and typographically correct
 	HTML.
@@ -51,7 +52,8 @@ The following functions are available:
 .. function:: nl2br_except_pre($str)
 
 	:param	string	$str: Input string
-	:returns:	string
+	:returns:	String with HTML-formatted line breaks
+	:rtype:	string
 
 	Converts newlines to <br /> tags unless they appear within <pre> tags.
 	This function is identical to the native PHP ``nl2br()`` function,
@@ -61,12 +63,12 @@ The following functions are available:
 
 		$string = nl2br_except_pre($string);
 
-
 .. function:: entity_decode($str, $charset = NULL)
 
 	:param	string	$str: Input string
 	:param	string	$charset: Character set
-	:returns:	string
+	:returns:	String with decoded HTML entities
+	:rtype:	string
 
 	This function is an alias for ``CI_Security::entity_decode()``.
 	Fore more info, please see the :doc:`Security Library
diff --git a/user_guide_src/source/helpers/url_helper.rst b/user_guide_src/source/helpers/url_helper.rst
index 24c7e259f..3bdcb8e17 100644
--- a/user_guide_src/source/helpers/url_helper.rst
+++ b/user_guide_src/source/helpers/url_helper.rst
@@ -27,7 +27,8 @@ Available Functions
 
 	:param	string	$uri: URI string
 	:param	string	$protocol: Protocol, e.g. 'http' or 'https'
-	:returns:	string
+	:returns:	Site URL
+	:rtype:	string
 
 	Returns your site URL, as specified in your config file. The index.php
 	file (or whatever you have set as your site **index_page** in your config
@@ -54,13 +55,12 @@ Available Functions
 	This function is an alias for ``CI_Config::site_url()``. For more info,
 	please see the :doc:`Config Library <../libraries/config>` documentation.
 
-
-
 .. function:: base_url($uri = '', $protocol = NULL)
 
 	:param	string	$uri: URI string
 	:param	string	$protocol: Protocol, e.g. 'http' or 'https'
-	:returns:	string
+	:returns:	Base URL
+	:rtype:	string
 
 	Returns your site base URL, as specified in your config file. Example::
 
@@ -88,10 +88,10 @@ Available Functions
 	This function is an alias for ``CI_Config::base_url()``. For more info,
 	please see the :doc:`Config Library <../libraries/config>` documentation.
 
-
 .. function:: current_url()
 
-	:returns:	string
+	:returns:	The current URL
+	:rtype:	string
 
 	Returns the full URL (including segments) of the page being currently
 	viewed.
@@ -103,7 +103,8 @@ Available Functions
 
 .. function:: uri_string()
 
-	:returns:	string
+	:returns:	An URI string
+	:rtype:	string
 
 	Returns the URI segments of any page that contains this function.
 	For example, if your URL was this::
@@ -120,20 +121,21 @@ Available Functions
 
 .. function:: index_page()
 
-	:returns:	string
+	:returns:	'index_page' value
+	:rtype:	mixed
 
 	Returns your site **index_page**, as specified in your config file.
 	Example::
 
 		echo index_page();
 
-
 .. function:: anchor($uri = '', $title = '', $attributes = '')
 
 	:param	string	$uri: URI string
 	:param	string	$title: Anchor title
 	:param	mixed	$attributes: HTML attributes
-	:returns:	string
+	:returns:	HTML hyperlink (anchor tag)
+	:rtype:	string
 
 	Creates a standard HTML anchor link based on your local site URL.
 
@@ -170,7 +172,8 @@ Available Functions
 	:param	string	$uri: URI string
 	:param	string	$title: Anchor title
 	:param	mixed	$attributes: HTML attributes
-	:returns:	string
+	:returns:	Pop-up hyperlink
+	:rtype:	string
 
 	Nearly identical to the :func:`anchor()` function except that it
 	opens the URL in a new window. You can specify JavaScript window
@@ -213,7 +216,8 @@ Available Functions
 	:param	string	$email: E-mail address
 	:param	string	$title: Anchor title
 	:param	mixed	$attributes: HTML attributes
-	:returns:	string
+	:returns:	A "mail to" hyperlink
+	:rtype:	string
 
 	Creates a standard HTML e-mail link. Usage example::
 
@@ -225,25 +229,25 @@ Available Functions
 		$attributes = array('title' => 'Mail me');
 		echo mailto('me@my-site.com', 'Contact Me', $attributes);
 
-
 .. function:: safe_mailto($email, $title = '', $attributes = '')
 
 	:param	string	$email: E-mail address
 	:param	string	$title: Anchor title
 	:param	mixed	$attributes: HTML attributes
-	:returns:	string
+	:returns:	A spam-safe "mail to" hyperlink
+	:rtype:	string
 
 	Identical to the :func:`mailto()` function except it writes an obfuscated
 	version of the *mailto* tag using ordinal numbers written with JavaScript to
 	help prevent the e-mail address from being harvested by spam bots.
 
-
 .. function:: auto_link($str, $type = 'both', $popup = FALSE)
 
 	:param	string	$str: Input string
 	:param	string	$type: Link type ('email', 'url' or 'both')
 	:param	bool	$popup: Whether to create popup links
-	:returns:	string
+	:returns:	Linkified string
+	:rtype:	string
 
 	Automatically turns URLs and e-mail addresses contained in a string into
 	links. Example::
@@ -274,7 +278,8 @@ Available Functions
 	:param	string	$str: Input string
 	:param	string	$separator: Word separator
 	:param	string	$lowercase: Whether to transform the output string to lower-case
-	:returns:	string
+	:returns:	URL-formatted string
+	:rtype:	string
 
 	Takes a string as input and creates a human-friendly URL string. This is
 	useful if, for example, you have a blog in which you'd like to use the
@@ -309,7 +314,8 @@ Available Functions
 .. function:: prep_url($str = '')
 
 	:param	string	$str: URL string
-	:returns:	string
+	:returns:	Protocol-prefixed URL string
+	:rtype:	string
 
 	This function will add http:// in the event that a protocol prefix
 	is missing from a URL.
@@ -324,7 +330,7 @@ Available Functions
 	:param	string	$uri: URI string
 	:param	string	$method: Redirect method ('auto', 'location' or 'refresh')
 	:param	string	$code: HTTP Response code (usually 302 or 303)
-	:returns:	void
+	:rtype:	void
 
 	Does a "header redirect" to the URI specified. If you specify the full
 	site URL that link will be built, but for local links simply providing
diff --git a/user_guide_src/source/helpers/xml_helper.rst b/user_guide_src/source/helpers/xml_helper.rst
index 7d155e192..a40ea9ad3 100644
--- a/user_guide_src/source/helpers/xml_helper.rst
+++ b/user_guide_src/source/helpers/xml_helper.rst
@@ -30,7 +30,8 @@ The following functions are available:
 
 	:param string $str: the text string to convert
 	:param bool $protect_all: Whether to protect all content that looks like a potential entity instead of just numbered entities, e.g. &foo;
-	:returns: string
+	:returns: XML-converted string
+	:rtype:	string
 
 	Takes a string as input and converts the following reserved XML
 	characters to entities:
@@ -51,4 +52,4 @@ The following functions are available:
 
 	.. code-block:: html
 
-		&lt;p&gt;Here is a paragraph &amp; an entity (&#123;).&lt;/p&gt;
+		&lt;p&gt;Here is a paragraph &amp; an entity (&#123;).&lt;/p&gt;
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From 9228f85b1b4f59cc88ba7c4addc258a7a5fd0ac0 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Fri, 7 Feb 2014 23:40:22 +0200
Subject: [ci skip] Add return types to common and error handling functions
 docs

---
 user_guide_src/source/general/common_functions.rst | 35 ++++++++++++++--------
 user_guide_src/source/general/errors.rst           | 15 ++--------
 2 files changed, 25 insertions(+), 25 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/general/common_functions.rst b/user_guide_src/source/general/common_functions.rst
index c466ca0b9..2ca7478ec 100644
--- a/user_guide_src/source/general/common_functions.rst
+++ b/user_guide_src/source/general/common_functions.rst
@@ -16,7 +16,8 @@ loading any libraries or helpers.
 .. function:: is_php([$version = '5.3.0'])
 
 	:param	string	$version: Version number
-	:returns:	bool
+	:returns:	TRUE if the running PHP version is at least the one specified or FALSE if not
+	:rtype:	bool
 
 	Determines of the PHP version being used is greater than the
 	supplied version number.
@@ -35,7 +36,8 @@ loading any libraries or helpers.
 .. function:: is_really_writable($file)
 
 	:param	string	$file: File path
-	:returns:	bool
+	:returns:	TRUE if the path is writable, FALSE if not
+	:rtype:	bool
 
 	``is_writable()`` returns TRUE on Windows servers when you really can't
 	write to the file as the OS reports to PHP as FALSE only if the
@@ -61,7 +63,8 @@ loading any libraries or helpers.
 .. function:: config_item($key)
 
 	:param	string	$key: Config item key
-	:returns:	mixed
+	:returns:	Configuration key value or FALSE if not found
+	:rtype:	mixed
 
 	The :doc:`Config Library <../libraries/config>` is the preferred way of
 	accessing configuration information, however ``config_item()`` can be used
@@ -73,7 +76,7 @@ loading any libraries or helpers.
 	:param	mixed	$message: Error message
 	:param	int	$status_code: HTTP Response status code
 	:param	string	$heading: Error page heading
-	:returns:	void
+	:rtype:	void
 
 	This function calls ``CI_Exception::show_error()``. For more info,
 	please see the :doc:`Error Handling <errors>` documentation.
@@ -82,7 +85,7 @@ loading any libraries or helpers.
 
 	:param	string	$page: URI string
 	:param	bool	$log_error: Whether to log the error
-	:returns:	void
+	:rtype:	void
 
 	This function calls ``CI_Exception::show_404()``. For more info,
 	please see the :doc:`Error Handling <errors>` documentation.
@@ -91,7 +94,7 @@ loading any libraries or helpers.
 
 	:param	string	$level: Log level: 'error', 'debug' or 'info'
 	:param	string	$message: Message to log
-	:returns:	void
+	:rtype:	void
 
 	This function is an alias for ``CI_Log::write_log()``. For more info,
 	please see the :doc:`Error Handling <errors>` documentation.
@@ -100,7 +103,7 @@ loading any libraries or helpers.
 
 	:param	int	$code: HTTP Reponse status code
 	:param	string	$text: A custom message to set with the status code
-	:returns:	void
+	:rtype:	void
 
 	Permits you to manually set a server status header. Example::
 
@@ -114,7 +117,8 @@ loading any libraries or helpers.
 
 	:param	string	$str: Input string
 	:param	bool	$url_encoded: Whether to remove URL-encoded characters as well
-	:returns:	string
+	:returns:	Sanitized string
+	:rtype:	string
 
 	This function prevents inserting NULL characters between ASCII
 	characters, like Java\\0script.
@@ -127,7 +131,8 @@ loading any libraries or helpers.
 .. function:: html_escape($var)
 
 	:param	mixed	$var: Variable to escape (string or array)
-	:returns:	mixed
+	:returns:	HTML escaped string(s)
+	:rtype:	mixed
 
 	This function acts as an alias for PHP's native ``htmlspecialchars()``
 	function, with the advantage of being able to accept an array of strings.
@@ -136,21 +141,24 @@ loading any libraries or helpers.
 
 .. function:: get_mimes()
 
-	:returns:	array
+	:returns:	An associative array of file types
+	:rtype:	array
 
 	This function returns a *reference* to the MIMEs array from
 	*application/config/mimes.php*.
 
 .. function:: is_https()
 
-	:returns:	bool
+	:returns:	TRUE if currently using HTTP-over-SSL, FALSE if not
+	:rtype:	bool
 
 	Returns TRUE if a secure (HTTPS) connection is used and FALSE
 	in any other case (including non-HTTP requests).
 
 .. function:: is_cli()
 
-	:returns:	bool
+	:returns:	TRUE if currently running under CLI, FALSE otherwise
+	:rtype:	bool
 
 	Returns TRUE if the application is run through the command line
 	and FALSE if not.
@@ -161,7 +169,8 @@ loading any libraries or helpers.
 .. function:: function_usable($function_name)
 
 	:param	string	$function_name: Function name
-	:returns:	bool
+	:returns:	TRUE if the function can be used, FALSE if not
+	:rtype:	bool
 
 	Returns TRUE if a function exists and is usable, FALSE otherwise.
 
diff --git a/user_guide_src/source/general/errors.rst b/user_guide_src/source/general/errors.rst
index 6cc8a0966..26c26bea1 100644
--- a/user_guide_src/source/general/errors.rst
+++ b/user_guide_src/source/general/errors.rst
@@ -29,15 +29,12 @@ software keep track of your scripts and the health of your application.
 
 The following functions let you generate errors:
 
-show_error()
-============
-
 .. function:: show_error($message, $status_code, $heading = 'An Error Was Encountered')
 
 	:param	mixed	$message: Error message
 	:param	int	$status_code: HTTP Response status code
 	:param	string	$heading: Error page heading
-	:returns:	void
+	:rtype:	void
 
 This function will display the error message supplied to it using the
 following error template::
@@ -52,14 +49,11 @@ be set to ``$status_code + EXIT__AUTO_MIN``. If that value is larger than
 status code will be set to ``EXIT_ERROR``. You can check in
 *application/config/constants.php* for more detail.
 
-show_404()
-==========
-
 .. function:: show_404($page = '', $log_error = TRUE)
 
 	:param	string	$page: URI string
 	:param	bool	$log_error: Whether to log the error
-	:returns:	void
+	:rtype:	void
 
 This function will display the 404 error message supplied to it using
 the following error template::
@@ -74,15 +68,12 @@ not found.
 CodeIgniter automatically logs any ``show_404()`` calls. Setting the
 optional second parameter to FALSE will skip logging.
 
-log_message()
-=============
-
 .. function:: log_message($level, $message, $php_error = FALSE)
 
 	:param	string	$level: Log level: 'error', 'debug' or 'info'
 	:param	string	$message: Message to log
 	:param	bool	$php_error: Whether we're logging a native PHP error message
-	:returns:	void
+	:rtype:	void
 
 This function lets you write messages to your log files. You must supply
 one of three "levels" in the first parameter, indicating what type of
-- 
cgit v1.2.3-24-g4f1b


From 28c2c975b118016d07212ed8e7c22ff280309f82 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Sat, 8 Feb 2014 04:27:48 +0200
Subject: [ci skip] Add return types to library docs

---
 user_guide_src/source/libraries/benchmark.rst      |  17 +--
 user_guide_src/source/libraries/caching.rst        |  51 +++++----
 user_guide_src/source/libraries/calendar.rst       |  49 ++++----
 user_guide_src/source/libraries/cart.rst           |  53 +++++----
 user_guide_src/source/libraries/config.rst         |  49 ++++----
 user_guide_src/source/libraries/email.rst          | 121 ++++++++++----------
 user_guide_src/source/libraries/encryption.rst     |  53 +++++----
 user_guide_src/source/libraries/file_uploading.rst |  60 +++++-----
 .../source/libraries/form_validation.rst           |  58 ++++++----
 user_guide_src/source/libraries/ftp.rst            | 112 ++++++++++--------
 user_guide_src/source/libraries/image_lib.rst      |  34 +++---
 user_guide_src/source/libraries/input.rst          | 115 +++++++++++--------
 user_guide_src/source/libraries/language.rst       |  20 ++--
 user_guide_src/source/libraries/loader.rst         | 127 ++++++++++++---------
 user_guide_src/source/libraries/migration.rst      |  22 ++--
 user_guide_src/source/libraries/output.rst         |  59 ++++++----
 user_guide_src/source/libraries/pagination.rst     |   7 +-
 user_guide_src/source/libraries/parser.rst         |  24 ++--
 user_guide_src/source/libraries/security.rst       |  26 +++--
 user_guide_src/source/libraries/sessions.rst       |  73 ++++++------
 user_guide_src/source/libraries/table.rst          |  35 +++---
 user_guide_src/source/libraries/trackback.rst      |  70 +++++++-----
 user_guide_src/source/libraries/typography.rst     |  17 +--
 user_guide_src/source/libraries/unit_testing.rst   |  33 +++---
 user_guide_src/source/libraries/uri.rst            |  65 ++++++-----
 user_guide_src/source/libraries/user_agent.rst     |  59 ++++++----
 user_guide_src/source/libraries/xmlrpc.rst         |  53 +++++----
 user_guide_src/source/libraries/zip.rst            |  40 ++++---
 28 files changed, 836 insertions(+), 666 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/benchmark.rst b/user_guide_src/source/libraries/benchmark.rst
index 7a0313f43..ddbe04869 100644
--- a/user_guide_src/source/libraries/benchmark.rst
+++ b/user_guide_src/source/libraries/benchmark.rst
@@ -135,18 +135,18 @@ Class Reference
 
 	.. method:: mark($name)
 
-		:param string $name: the name you wish to assign to your marker
-		:returns: void
+		:param	string	$name: the name you wish to assign to your marker
+		:rtype:	void
 
 		Sets a benchmark marker.
 
-
 	.. method:: elapsed_time([$point1 = ''[, $point2 = ''[, $decimals = 4]]])
 
-		:param string $point1: a particular marked point
-		:param string $point2: a particular marked point
-		:param int $decimals: number of decimal places for precision
-		:returns: string
+		:param	string	$point1: a particular marked point
+		:param	string	$point2: a particular marked point
+		:param	int	$decimals: number of decimal places for precision
+		:returns:	Elapsed time
+		:rtype:	string
 
 		Calculates and returns the time difference between two marked points.
 
@@ -158,7 +158,8 @@ Class Reference
 
 	.. method:: memory_usage()
 
-		:returns: string
+		:returns:	Memory usage info
+		:rtype:	string
 
 		Simply returns the ``{memory_usage}`` marker.
 
diff --git a/user_guide_src/source/libraries/caching.rst b/user_guide_src/source/libraries/caching.rst
index 30a9fed2d..caece1aee 100644
--- a/user_guide_src/source/libraries/caching.rst
+++ b/user_guide_src/source/libraries/caching.rst
@@ -56,8 +56,9 @@ Class Reference
 
 	.. method:: is_supported($driver)
 
-		:param string $driver: the name of the caching driver
-		:returns: TRUE if supported, FALSE if not
+		:param	string	$driver: the name of the caching driver
+		:returns:	TRUE if supported, FALSE if not
+		:rtype:	bool
 
 		This method is automatically called when accessing drivers via
 		``$this->cache->get()``. However, if the individual drivers are used,
@@ -75,8 +76,9 @@ Class Reference
 
 	.. method:: get($id)
 
-		:param string $id: name of cached item
-		:returns: The item if it exists, FALSE if it does not
+		:param	string	$id: Cache item name
+		:returns:	Item value or FALSE if not found
+		:rtype:	mixed
 
 		This method will attempt to fetch an item from the cache store. If the
 		item does not exist, the method will return FALSE.
@@ -86,11 +88,12 @@ Class Reference
 
 	.. method:: save($id, $data[, $ttl = 60[, $raw = FALSE]])
 
-		:param string $id: name of the cached item
-		:param mixed $data: the data to save
-		:param int $ttl: Time To Live, in seconds (default 60)
-		:param bool $raw: Whether to store the raw value
-		:returns: TRUE on success, FALSE on failure
+		:param	string	$id: Cache item name
+		:param	mixed	$data: the data to save
+		:param	int	$ttl: Time To Live, in seconds (default 60)
+		:param	bool	$raw: Whether to store the raw value
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	string
 
 		This method will save an item to the cache store. If saving fails, the
 		method will return FALSE.
@@ -103,8 +106,9 @@ Class Reference
 
 	.. method:: delete($id)
 
-		:param string $id: name of cached item
-		:returns: TRUE if deleted, FALSE if the deletion fails
+		:param	string	$id: name of cached item
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		This method will delete a specific item from the cache store. If item
 		deletion fails, the method will return FALSE.
@@ -114,9 +118,10 @@ Class Reference
 
 	.. method:: increment($id[, $offset = 1])
 
-		:param string $id: Cache ID
-		:param int $offset: Step/value to add
-		:returns: New value on success, FALSE on failure
+		:param	string	$id: Cache ID
+		:param	int	$offset: Step/value to add
+		:returns:	New value on success, FALSE on failure
+		:rtype:	mixed
 
 		Performs atomic incrementation of a raw stored value.
 		::
@@ -129,9 +134,10 @@ Class Reference
 
 	.. method:: decrement($id[, $offset = 1])
 
-		:param string $id: Cache ID
-		:param int $offset: Step/value to reduce by
-		:returns: New value on success, FALSE on failure
+		:param	string	$id: Cache ID
+		:param	int	$offset: Step/value to reduce by
+		:returns:	New value on success, FALSE on failure
+		:rtype:	mixed
 
 		Performs atomic decrementation of a raw stored value.
 		::
@@ -144,7 +150,8 @@ Class Reference
 
 	.. method:: clean()
 
-		:returns: TRUE if deleted, FALSE if the deletion fails
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		This method will 'clean' the entire cache. If the deletion of the
 		cache files fails, the method will return FALSE.
@@ -154,7 +161,8 @@ Class Reference
 
 	.. method:: cache_info()
 
-		:returns: information on the entire cache
+		:returns:	Information on the entire cache database
+		:rtype:	mixed
 
 		This method will return information on the entire cache.
 		::
@@ -166,8 +174,9 @@ Class Reference
 
 	.. method:: get_metadata($id)
 
-		:param string $id: name of cached item
-		:returns: metadadta for the cached item
+		:param	string	$id: Cache item name
+		:returns:	Metadata for the cached item
+		:rtype:	mixed
 
 		This method will return detailed information on a specific item in the
 		cache.
diff --git a/user_guide_src/source/libraries/calendar.rst b/user_guide_src/source/libraries/calendar.rst
index 3879672ce..aa10e941d 100644
--- a/user_guide_src/source/libraries/calendar.rst
+++ b/user_guide_src/source/libraries/calendar.rst
@@ -201,48 +201,49 @@ Class Reference
 
 	.. method:: initialize([$config = array()])
 
-		:param array $config: config preferences
-		:returns: void
+		:param	array	$config: Configuration parameters
+		:rtype:	void
 
 		Initializes the Calendaring preferences. Accepts an associative array as input, containing display preferences.
 
-
 	.. method:: generate([$year = ''[, $month = ''[, $data = array()]]])
 
-		:param int $year: the year
-		:param int $month: the month
-		:param array $data: the data to be shown in the calendar cells
-		:returns: string
+		:param	int	$year: Year
+		:param	int	$month: Month
+		:param	array	$data: Data to be shown in the calendar cells
+		:returns:	HTML-formatted calendar
+		:rtype:	string
 
 		Generate the calendar.
 
 
 	.. method:: get_month_name($month)
 
-		:param int $month: the numeric month
-		:returns: string
+		:param	int	$month: Month
+		:returns:	Month name
+		:rtype:	string
 
 		Generates a textual month name based on the numeric month provided.
 
-
 	.. method:: get_day_names($day_type = '')
 
-		:param string $day_type: one of 'long', 'short', or 'abr'
-		:returns: array
+		:param	string	$day_type: 'long', 'short', or 'abr'
+		:returns:	Array of day names
+		:rtype:	array
 
 		Returns an array of day names (Sunday, Monday, etc.) based on the type
 		provided. Options: long, short, abr. If no ``$day_type`` is provided (or
 		if an invalid type is provided) this method will return the "abbreviated"
 		style.
 
-
 	.. method:: adjust_date($month, $year)
 
-		:param int $month: the month
-		:param int $year: the year
-		:returns: array
+		:param	int	$month: Month
+		:param	int	$year: Year
+		:returns:	An associative array containing month and year
+		:rtype:	array
 
-		This method makes usre that you have a valid month/year. For example, if
+		This method makes sure that you have a valid month/year. For example, if
 		you submit 13 as the month, the year will increment and the month will
 		become January::
 
@@ -256,22 +257,22 @@ Class Reference
 				[year] => '2014'
 			)
 
-
 	.. method:: get_total_days($month, $year)
 
-		:param int $month: the month
-		:param int $year: the year
-		:returns: int
+		:param	int	$month: Month
+		:param	int	$year: Year
+		:returns:	Count of days in the specified month
+		:rtype:	int
 
 		Total days in a given month::
 
 			echo $this->calendar->get_total_days(2, 2012);
 			// 29
 
-
 	.. method:: default_template()
 
-		:returns: array
+		:returns:	An array of template values
+		:rtype:	array
 
 		Sets the default template. This method is used when you have not created
 		your own template.
@@ -279,7 +280,7 @@ Class Reference
 
 	.. method:: parse_template()
 
-		:returns: void
+		:rtype:	void
 
 		Harvests the data within the template ``{pseudo-variables}`` used to
 		display the calendar.
\ No newline at end of file
diff --git a/user_guide_src/source/libraries/cart.rst b/user_guide_src/source/libraries/cart.rst
index 0c8c0a601..fb92c280a 100644
--- a/user_guide_src/source/libraries/cart.rst
+++ b/user_guide_src/source/libraries/cart.rst
@@ -275,8 +275,9 @@ Class Reference
 
 	.. method:: insert([$items = array()])
 
-		:param array $items: the items to insert into the cart
-		:returns: bool
+		:param	array	$items: Items to insert into the cart
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		Insert items into the cart and save it to the session table. Returns TRUE
 		on success and FALSE on failure.
@@ -284,83 +285,85 @@ Class Reference
 
 	.. method:: update([$items = array()])
 
-		:param array $items: the items to update in the cart
-		:returns: bool
+		:param	array	$items: Items to update in the cart
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		This method permits the quantity of a given item to be changed.
 		Typically it is called from the "view cart" page if a user makes changes
 		to the quantity before checkout. That array must contain the product ID
 		and quantity for each item.
 
-
 	.. method:: remove($rowid)
 
-		:param int $rowid: the ID of the item to remove from the cart
-		:returns: bool
+		:param	int	$rowid: ID of the item to remove from the cart
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		Allows you to remove an item from the shopping cart by passing it the
 		``$rowid``.
 
-
 	.. method:: total()
 
-		:returns: int
+		:returns:	Total amount
+		:rtype:	int
 
 		Displays the total amount in the cart.
 
 
 	.. method:: total_items()
 
-		:returns: int
+		:returns:	Total amount of items in the cart
+		:rtype:	int
 
 		Displays the total number of items in the cart.
 
 
 	.. method:: contents([$newest_first = FALSE])
 
-		:param bool $newest_first: order the array with newest first?
-		:returns: array
+		:param	bool	$newest_first: Whether to order the array with newest items first
+		:returns:	An array of cart contents
+		:rtype:	array
 
 		Returns an array containing everything in the cart. You can sort the
 		order by which the array is returned by passing it TRUE where the contents
 		will be sorted from newest to oldest, otherwise it is sorted from oldest
 		to newest.
 
-
 	.. method:: get_item($row_id)
 
-		:param int $row_id: the row ID to retrieve
-		:returns: array
+		:param	int	$row_id: Row ID to retrieve
+		:returns:	Array of item data
+		:rtype:	array
 
 		Returns an array containing data for the item matching the specified row
 		ID, or FALSE if no such item exists.
 
-
 	.. method:: has_options($row_id = '')
 
-		:param int $row_id: the row ID to inspect
-		:returns: bool
+		:param	int	$row_id: Row ID to inspect
+		:returns:	TRUE if options exist, FALSE otherwise
+		:rtype:	bool
 
 		Returns TRUE (boolean) if a particular row in the cart contains options.
-		This method is designed to be used in a loop with :meth:contents:, since
+		This method is designed to be used in a loop with ``contents()``, since
 		you must pass the rowid to this function, as shown in the Displaying
 		the Cart example above.
 
-
 	.. method:: product_options([$row_id = ''])
 
-		:param int $row_id: the row ID
-		:returns: array
+		:param	int	$row_id: Row ID
+		:returns:	Array of product options
+		:rtype:	array
 
 		Returns an array of options for a particular product. This method is
-		designed to be used in a loop with :meth:contents:, since you
+		designed to be used in a loop with ``contents()``, since you
 		must pass the rowid to this method, as shown in the Displaying the
 		Cart example above.
 
-
 	.. method:: destroy()
 
-		:returns: void
+		:rtype: void
 
 		Permits you to destroy the cart. This method will likely be called
 		when you are finished processing the customer's order.
\ No newline at end of file
diff --git a/user_guide_src/source/libraries/config.rst b/user_guide_src/source/libraries/config.rst
index 8663324f2..b31815799 100644
--- a/user_guide_src/source/libraries/config.rst
+++ b/user_guide_src/source/libraries/config.rst
@@ -184,47 +184,44 @@ Class Reference
 
 	.. method:: item($item[, $index=''])
 
-		:param string $item: config item name
-		:param string $index: index name, if the item is an element in a config
-			item that is itself an array.
-		:returns: mixed - the config item or FALSE if it does not exist
+		:param	string	$item: Config item name
+		:param	string	$index: Index name
+		:returns:	Config item value or NULL if not found
+		:rtype:	mixed
 
 		Fetch a config file item.
 
-
 	.. method:: set_item($item, $value)
 
-		:param string $item: config item name
-		:param string $value: config item value
-		:returns: void
+		:param	string	$item: Config item name
+		:param	string	$value: Config item value
+		:rtype:	void
 
 		Sets a config file item to the specified value.
 
-
 	.. method:: slash_item($item)
 
-		:param string $item: config item name
-		:returns: moxied - the config item (slashed) or FALSE if it does not exist
+		:param	string	$item: config item name
+		:returns:	Config item value with a trailing forward slash or NULL if not found
+		:rtype:	mixed
 
-		This method is identical to :meth:item:, except it appends a forward
+		This method is identical to ``item()``, except it appends a forward
 		slash to the end of the item, if it exists.
 
-
 	.. method:: load([$file = ''[, $use_sections = FALSE[, $fail_gracefully = FALSE]]])
 
-		:param string $file: Configuration file name
-		:param bool $use_sections: Whether config values shoud be loaded into
-			their own section (index of the main config array)
-		:param bool $fail_gracefully: Whether to return FALSE or to display an
-			error message
-		:returns: bool
+		:param	string	$file: Configuration file name
+		:param	bool	$use_sections: Whether config values shoud be loaded into their own section (index of the main config array)
+		:param	bool	$fail_gracefully: Whether to return FALSE or to display an error message
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		Loads a configuration file.
 
-
 	.. method:: site_url()
 
-		:returns: string
+		:returns:	Site URL
+		:rtype:	string
 
 		This method retrieves the URL to your site, along with the "index" value
 		you've specified in the config file.
@@ -232,10 +229,10 @@ Class Reference
 		This method is normally accessed via the corresponding functions in the
 		:doc:`URL Helper </helpers/url_helper>`.
 
-
 	.. method:: base_url()
 
-		:returns: string
+		:returns:	Base URL
+		:rtype:	string
 
 		This method retrieves the URL to your site, plus an optional path such
 		as to a stylesheet or image.
@@ -243,9 +240,9 @@ Class Reference
 		This method is normally accessed via the corresponding functions in the
 		:doc:`URL Helper </helpers/url_helper>`.
 
-
 	.. method:: system_url()
 
-		:returns: string
+		:returns:	URL pointing at your CI system/ directory
+		:rtype:	string
 
-		This method retrieves the URL to your system folder.
+		This method retrieves the URL to your CodeIgniter system/ directory.
\ No newline at end of file
diff --git a/user_guide_src/source/libraries/email.rst b/user_guide_src/source/libraries/email.rst
index ec639846f..3f990b628 100644
--- a/user_guide_src/source/libraries/email.rst
+++ b/user_guide_src/source/libraries/email.rst
@@ -145,10 +145,11 @@ Class Reference
 
 	.. method:: from($from[, $name = ''[, $return_path = NULL]])
 
-		:param string $from: "From" email address
-		:param string $name: "From" display name
-		:param string $return_path: optional email address to redirect undelivered email
-		:returns: CI_Email object for method chaining
+		:param	string	$from: "From" e-mail address
+		:param	string	$name: "From" display name
+		:param	string	$return_path: Optional email address to redirect undelivered e-mail to
+		:returns:	CI_Email instance (method chaining)
+		:rtype:	CI_Email
 
 		Sets the email address and name of the person sending the email::
 
@@ -161,26 +162,26 @@ Class Reference
 		.. note:: Return-Path can't be used if you've configured 'smtp' as
 			your protocol.
 
-
 	.. method:: reply_to($replyto[, $name = ''])
 
-		:param string $replyto: email address for replies
-		:param string $name: display name for reply email address
-		:returns: CI_Email object for method chaining
+		:param	string	$replyto: E-mail address for replies
+		:param	string	$name: Display name for the reply-to e-mail address
+		:returns:	CI_Email instance (method chaining)
+		:rtype:	CI_Email
 
 		Sets the reply-to address. If the information is not provided the
 		information in the :meth:from method is used. Example::
 
 			$this->email->reply_to('you@example.com', 'Your Name');
 
-
 	.. method:: to($to)
 
-		:param mixed $to: comma delimited string or array of email addresses
-		:returns: CI_Email object for method chaining
+		:param	mixed	$to: Comma-delimited string or an array of e-mail addresses
+		:returns:	CI_Email instance (method chaining)
+		:rtype:	CI_Email
 
-		Sets the email address(s) of the recipient(s). Can be a single email
-		, a comma-delimited list or an array::
+		Sets the email address(s) of the recipient(s). Can be a single e-mail,
+		a comma-delimited list or an array::
 
 			$this->email->to('someone@example.com');
 
@@ -190,60 +191,60 @@ Class Reference
 
 		::
 
-			$list = array('one@example.com', 'two@example.com', 'three@example.com');
-
-			$this->email->to($list);
-
+			$this->email->to(
+				array('one@example.com', 'two@example.com', 'three@example.com')
+			);
 
 	.. method:: cc($cc)
 
-		:param mixed $cc: comma delimited string or array of email addresses
-		:returns: CI_Email object for method chaining
-
-		Sets the CC email address(s). Just like the "to", can be a single
-		email, a comma-delimited list or an array.
+		:param	mixed	$cc: Comma-delimited string or an array of e-mail addresses
+		:returns:	CI_Email instance (method chaining)
+		:rtype:	CI_Email
 
+		Sets the CC email address(s). Just like the "to", can be a single e-mail,
+		a comma-delimited list or an array.
 
-	.. method:: bcc($bcc, $limit = '')
+	.. method:: bcc($bcc[, $limit = ''])
 
-		:param mixed $bcc: comma delimited string or array of email addresses
-		:param int $limit: Maximum number of emails to send per batch
-		:returns: CI_Email object for method chaining
+		:param	mixed	$bcc: Comma-delimited string or an array of e-mail addresses
+		:param	int	$limit: Maximum number of e-mails to send per batch
+		:returns:	CI_Email instance (method chaining)
+		:rtype:	CI_Email
 
-		Sets the BCC email address(s). Just like the "to", can be a single
-		email, a comma-delimited list or an array.
+		Sets the BCC email address(s). Just like the ``to()`` method, can be a single
+		e-mail, a comma-delimited list or an array.
 
 		If ``$limit`` is set, "batch mode" will be enabled, which will send
 		the emails to batches, with each batch not exceeding the specified
 		``$limit``.
 
-
 	.. method:: subject($subject)
 
-		:param string $subject: email subject line
-		:returns: CI_Email object for method chaining
+		:param	string	$subject: E-mail subject line
+		:returns:	CI_Email instance (method chaining)
+		:rtype:	CI_Email
 
 		Sets the email subject::
 
 			$this->email->subject('This is my subject');
 
-
 	.. method:: message($body)
 
-		:param string $body: email body
-		:returns: CI_Email object for method chaining
+		:param	string	$body: E-mail message body
+		:returns:	CI_Email instance (method chaining)
+		:rtype:	CI_Email
 
-		Sets the email message body::
+		Sets the e-mail message body::
 
 			$this->email->message('This is my message');
 
-
 	.. method:: set_alt_message([$str = ''])
 
-		:param string $str: alternate email body
-		:returns: CI_Email object for method chaining
+		:param	string	$str: Alternative e-mail message body
+		:returns:	CI_Email instance (method chaining)
+		:rtype:	CI_Email
 
-		Sets the alternative email message body::
+		Sets the alternative e-mail message body::
 
 			$this->email->set_alt_message('This is the alternative message');
 
@@ -256,19 +257,21 @@ Class Reference
 
 	.. method:: set_header($header, $value)
 
-		:param string $header: header name
-		:param string $value: header value
-		:returns: void
+		:param	string	$header: Header name
+		:param	string	$value: Header value
+		:returns:	CI_Email instance (method chaining)
+		:rtype: CI_Email
 
 		Appends additional headers to the e-mail::
 
 			$this->email->set_header('Header1', 'Value1');
 			$this->email->set_header('Header2', 'Value2');
 
-
 	.. method:: clear([$clear_attachments = FALSE])
 
-		:param bool $clear_attachments: whether or not to clear attachments
+		:param	bool	$clear_attachments: Whether or not to clear attachments
+		:returns:	CI_Email instance (method chaining)
+		:rtype: CI_Email
 
 		Initializes all the email variables to an empty state. This method
 		is intended for use if you run the email sending method in a loop,
@@ -292,13 +295,13 @@ Class Reference
 
 			$this->email->clear(TRUE);
 
-
 	.. method:: send([$auto_clear = TRUE])
 
-		:param bool $auto_clear: Whether to :meth:clear automatically
-		:returns: bool
+		:param	bool	$auto_clear: Whether to clear message data automatically
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
-		The Email sending method. Returns boolean TRUE or FALSE based on
+		The e-mail sending method. Returns boolean TRUE or FALSE based on
 		success or failure, enabling it to be used conditionally::
 
 			if ( ! $this->email->send())
@@ -317,16 +320,16 @@ Class Reference
 		.. note:: In order to use the ``print_debugger()`` method, you need
 			to avoid clearing the email parameters.
 
-
 	.. method:: attach($filename[, $disposition = ''[, $newname = NULL[, $mime = '']]])
 
-		:param string $filename: name of the file
-		:param string $disposition: 'disposition' of the attachment. Most
+		:param	string	$filename: File name
+		:param	string	$disposition: 'disposition' of the attachment. Most
 			email clients make their own decision regardless of the MIME
 			specification used here. https://www.iana.org/assignments/cont-disp/cont-disp.xhtml
-		:param string $newname: custom name to use for the file in the email
-		:param string $mime: MIME type to use (useful for buffered data)
-		:returns: CI_Email object for method chaining
+		:param	string	$newname: Custom file name to use in the e-mail
+		:param	string	$mime: MIME type to use (useful for buffered data)
+		:returns:	CI_Email instance (method chaining)
+		:rtype:	CI_Email
 
 		Enables you to send an attachment. Put the file path/name in the first
 		parameter. For multiple attachments use the method multiple times.
@@ -357,8 +360,9 @@ Class Reference
 
 	.. method:: attachment_cid($filename)
 
-		:param string $filename: Existing attachment filename
-		:returns: string
+		:param	string	$filename: Existing attachment filename
+		:returns:	Attachment Content-ID or FALSE if not found
+		:rtype:	string
  
 		Sets and returns an attachment's Content-ID, which enables your to embed an inline
 		(picture) attachment into HTML. First parameter must be the already attached file name.
@@ -378,8 +382,9 @@ Class Reference
 
 	.. method:: print_debugger([$include = array('headers', 'subject', 'body')])
 
-		:param array $include: Which parts of the message to print out
-		:returns: string
+		:param	array	$include: Which parts of the message to print out
+		:returns:	Formatted debug data
+		:rtype:	string
 
 		Returns a string containing any server messages, the email headers, and
 		the email messsage. Useful for debugging.
diff --git a/user_guide_src/source/libraries/encryption.rst b/user_guide_src/source/libraries/encryption.rst
index f7235bfd2..567a1e990 100644
--- a/user_guide_src/source/libraries/encryption.rst
+++ b/user_guide_src/source/libraries/encryption.rst
@@ -81,11 +81,12 @@ Class Reference
 
 .. class:: CI_Encrypt
 
-	.. method:: encode($string, $key = '')
+	.. method:: encode($string[, $key = ''])
 
-		:param string $string: contents to be encrypted
-		:param string $key: encryption key
-		:returns: string
+		:param	string	$string: Data to encrypt
+		:param	string	$key: Encryption key
+		:returns:	Encrypted string
+		:rtype:	string
 
 		Performs the data encryption and returns it as a string. Example::
 
@@ -101,12 +102,12 @@ Class Reference
 
 			$encrypted_string = $this->encrypt->encode($msg, $key);
 
+	.. method:: decode($string[, $key = ''])
 
-	.. method:: decode($string, $key = '')
-
-		:param string $string: contents to be decrypted
-		:param string $key: encryption key
-		:returns: string
+		:param	string	$string: String to decrypt
+		:param	string	$key: Encryption key
+		:returns:	Plain-text string
+		:rtype:	string
 
 		Decrypts an encoded string. Example::
 
@@ -122,46 +123,44 @@ Class Reference
 
 			$encrypted_string = $this->encrypt->decode($msg, $key);
 
-
 	.. method:: set_cipher($cipher)
 
-		:param int $cipher: valid PHP Mcrypt cypher constant
-		:returns: CI_Encrypt object for method chaining
+		:param	int	$cipher: Valid PHP MCrypt cypher constant
+		:returns:	CI_Encrypt instance (method chaining)
+		:rtype:	CI_Encrypt
 
 		Permits you to set an Mcrypt cipher. By default it uses
-		**MCRYPT_RIJNDAEL_256**. Example::
+		``MCRYPT_RIJNDAEL_256``. Example::
 
 			$this->encrypt->set_cipher(MCRYPT_BLOWFISH);
 
-		Please visit php.net for a list of `available
-		ciphers <http://php.net/mcrypt>`_.
+		Please visit php.net for a list of `available ciphers <http://php.net/mcrypt>`_.
 
-		If you'd like to manually test whether your server supports Mcrypt you
+		If you'd like to manually test whether your server supports MCrypt you
 		can use::
 
-			echo ( ! function_exists('mcrypt_encrypt')) ? 'Nope' : 'Yup';
-
+			echo extension_loaded('mcrypt') ? 'Yup' : 'Nope';
 
 	.. method:: set_mode($mode)
 
-		:param int $mode: valid PHP Mcrypt mode constant
-		:returns: CI_Encrypt object for method chaining
+		:param	int	$mode: Valid PHP MCrypt mode constant
+		:returns:	CI_Encrypt instance (method chaining)
+		:rtype:	CI_Encrypt
 
 		Permits you to set an Mcrypt mode. By default it uses **MCRYPT_MODE_CBC**.
 		Example::
 
 			$this->encrypt->set_mode(MCRYPT_MODE_CFB);
 
-		Please visit php.net for a list of `available
-		modes <http://php.net/mcrypt>`_.
-
+		Please visit php.net for a list of `available modes <http://php.net/mcrypt>`_.
 
 	.. method:: encode_from_legacy($string[, $legacy_mode = MCRYPT_MODE_ECB[, $key = '']])
 
-		:param string $string: contents to be encrypted
-		:param int $legacy_mode: valid PHP Mcrypt cypher constant
-		:param string $key: encryption key
-		:returns: string
+		:param	string	$string: String to encrypt
+		:param	int	$legacy_mode: Valid PHP MCrypt cipher constant
+		:param	string	$key: Encryption key
+		:returns:	Newly encrypted string
+		:rtype:	string
 
 		Enables you to re-encode data that was originally encrypted with
 		CodeIgniter 1.x to be compatible with the Encryption library in
diff --git a/user_guide_src/source/libraries/file_uploading.rst b/user_guide_src/source/libraries/file_uploading.rst
index d679d8aa2..d7ba3a6c1 100644
--- a/user_guide_src/source/libraries/file_uploading.rst
+++ b/user_guide_src/source/libraries/file_uploading.rst
@@ -256,8 +256,9 @@ Class Reference
 
 	.. method:: do_upload([$field = 'userfile'])
 
-		:param string $field: name of the form field
-		:returns: bool
+		:param	string	$field: Name of the form field
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		Performs the upload based on the preferences you've set.
 
@@ -275,12 +276,12 @@ Class Reference
 			$field_name = "some_field_name";
 			$this->upload->do_upload($field_name);
 
-
 	.. method:: display_errors([$open = '<p>'[, $close = '</p>']])
 
-		:param string $open: Opening markup
-		:param string $close: Closing markup
-		:returns: string
+		:param	string	$open: Opening markup
+		:param	string	$close: Closing markup
+		:returns:	Formatted error message(s)
+		:rtype:	string
 
 		Retrieves any error messages if the ``do_upload()`` method returned
 		false. The method does not echo automatically, it returns the data so
@@ -296,8 +297,9 @@ Class Reference
 
 	.. method:: data([$index = NULL])
 
-		:param string $data: element to return instead of the full array
-		:returns: mixed
+		:param	string	$data: Element to return instead of the full array
+		:returns:	Information about the uploaded file
+		:rtype:	mixed
 
 		This is a helper method that returns an array containing all of the
 		data related to the file you uploaded. Here is the array prototype::
@@ -324,25 +326,23 @@ Class Reference
 
 			$this->upload->data('file_name');	// Returns: mypic.jpg
 
-		**Explanation**
-
-			Here is an explanation of the above array items.
-
-			================	================================================
-			Item							Description
-			================	================================================
-			file_name					The name of the file that was uploaded including the file extension.
-			file_type					The file's Mime type
-			file_path					The absolute server path to the file
-			full_path					The absolute server path including the file name
-			raw_name					The file name without the extension
-			orig_name					The original file name. This is only useful if you use the encrypted name option.
-			client_name				The file name as supplied by the client user agent, prior to any file name preparation or incrementing.
-			file_ext					The file extension with period
-			file_size					The file size in kilobytes
-			is_image					Whether the file is an image or not. 1 = image. 0 = not.
-			image_width				Image width.
-			image_height			Image height
-			image_type				Image type. Typically the file extension without the period.
-			image_size_str		A string containing the width and height. Useful to put into an image tag.
-			================	================================================
+		Here's a table explaining the above-displayed array items:
+
+		================ ====================================================================================================
+		Item             Description
+		================ ====================================================================================================
+		file_name        Name of the file that was uploaded, including the filename extension
+		file_type        File MIME type identifier
+		file_path        Absolute server path to the file
+		full_path        Absolute server path, including the file name
+		raw_name         File name, without the extension
+		orig_name        Original file name. This is only useful if you use the encrypted name option.
+		client_name      File name as supplied by the client user agent, prior to any file name preparation or incrementing
+		file_ext         Filename extension, period included
+		file_size        File size in kilobytes
+		is_image         Whether the file is an image or not. 1 = image. 0 = not.
+		image_width      Image width
+		image_height     Image height
+		image_type       Image type (usually the file name extension without the period)
+		image_size_str   A string containing the width and height (useful to put into an image tag)
+		================ ====================================================================================================
\ No newline at end of file
diff --git a/user_guide_src/source/libraries/form_validation.rst b/user_guide_src/source/libraries/form_validation.rst
index 42422f9d7..ae66cefb3 100644
--- a/user_guide_src/source/libraries/form_validation.rst
+++ b/user_guide_src/source/libraries/form_validation.rst
@@ -958,10 +958,11 @@ Class Reference
 
 	.. method:: set_rules($field[, $label = ''[, $rules = '']])
 
-		:param string $field: The field name
-		:param string $label: The field label
-		:param mixed $rules: The rules, as a string with rules separated by a pipe "|", or an array or rules.
-		:returns: object
+		:param	string	$field: Field name
+		:param	string	$label: Field label
+		:param	mixed	$rules: Validation rules, as a string list separated by a pipe "|", or as an array or rules
+		:returns:	CI_Form_validation instance (method chaining)
+		:rtype:	CI_Form_validation
 
 		Permits you to set validation rules, as described in the tutorial
 		sections above:
@@ -971,8 +972,9 @@ Class Reference
 
 	.. method:: run([$group = ''])
 
-		:param string $group: The name of the validation group to run
-		:returns: bool
+		:param	string	$group: The name of the validation group to run
+		:returns:	TRUE on success, FALSE if validation failed
+		:rtype:	bool
 
 		Runs the validation routines. Returns boolean TRUE on success and FALSE
 		on failure. You can optionally pass the name of the validation group via
@@ -980,64 +982,70 @@ Class Reference
 
 	.. method:: set_message($lang[, $val = ''])
 
-		:param string $lang: The rule the message is for
-		:param string $val: The message
-		:returns: object
+		:param	string	$lang: The rule the message is for
+		:param	string	$val: The message
+		:returns:	CI_Form_validation instance (method chaining)
+		:rtype:	CI_Form_validation
 
 		Permits you to set custom error messages. See :ref:`setting-error-messages`
 
 	.. method:: set_error_delimiters([$prefix = '<p>'[, $suffix = '</p>']])
 
-		:param string $prefix: Error message prefix
-		:param string $suffix: Error message suffix
-		:returns: object
+		:param	string	$prefix: Error message prefix
+		:param	string	$suffix: Error message suffix
+		:returns:	CI_Form_validation instance (method chaining)
+		:rtype:	CI_Form_validation
 
 		Sets the default prefix and suffix for error messages.
 
 	.. method:: set_data($data)
 
-		:param array $data: The data to validate
-		:returns: void
+		:param	array	$data: Array of data validate
+		:rtype:	void
 
 		Permits you to set an array for validation, instead of using the default
 		``$_POST`` array.
 
 	.. method:: reset_validation()
 
-		:returns: void
+		:rtype: void
 
 		Permits you to reset the validation when you validate more than one array.
 		This method should be called before validating each new array.
 
 	.. method:: error_array()
 
-		:returns: array
+		:returns:	Array of error messages
+		:rtype:	array
 
 		Returns the error messages as an array.
 
 	.. method:: error_string([$prefix = ''[, $suffix = '']])
 
-		:param string $prefix: Error message prefix
-		:param string $suffix: Error message suffix
-		:returns: string
+		:param	string	$prefix: Error message prefix
+		:param	string	$suffix: Error message suffix
+		:returns:	Error messages as a string
+		:rtype:	string
 
 		Returns all error messages (as returned from error_array()) formatted as a
 		string and separated by a newline character.
 
 	.. method:: error($field[, $prefix = ''[, $suffix = '']])
 
-		:param string $field: Field name
-		:param string $prefix: Optional prefix
-		:param string $suffix: Optional suffix
-		:returns: string
+		:param	string $field: Field name
+		:param	string $prefix: Optional prefix
+		:param	string $suffix: Optional suffix
+		:returns:	Error message string
+		:rtype:	string
 
 		Returns the error message for a specific field, optionally adding a
 		prefix and/or suffix to it (usually HTML tags).
 
 	.. method:: has_rule($field)
 
-		:param string $field: Field name
-		:returns: bool
+		:param	string	$field: Field name
+		:returns:	TRUE if the field has rules set, FALSE if not
+		:rtype:	bool
 
 		Checks to see if there is a rule set for the specified field.
 
diff --git a/user_guide_src/source/libraries/ftp.rst b/user_guide_src/source/libraries/ftp.rst
index c587869db..dd9440443 100644
--- a/user_guide_src/source/libraries/ftp.rst
+++ b/user_guide_src/source/libraries/ftp.rst
@@ -94,8 +94,9 @@ Class Reference
 
 	.. method:: connect([$config = array()])
 
-		:param array $config: Connection values
-		:returns: bool
+		:param	array	$config: Connection values
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		Connects and logs into to the FTP server. Connection preferences are set
 		by passing an array to the function, or you can store them in a config
@@ -123,24 +124,25 @@ Class Reference
 
 		**Available connection options**
 
-		==================		===================================
-		Option Name			Description
-		==================		===================================
-		**hostname**			the FTP hostname. Usually something like: ftp.example.com
-		**username**			the FTP username
-		**password**			the FTP password
-		**port**			The port number. Set to 21 by default.
-		**debug**			TRUE/FALSE (boolean). Whether to enable debugging to display error messages.
-		**passive**			TRUE/FALSE (boolean). Whether to use passive mode. Passive is set automatically by default.
-		==================		===================================
+		============== =============== =============================================================================
+		Option name    Default value   Description
+		============== =============== =============================================================================
+		**hostname**   n/a             FTP hostname (usually something like: ftp.example.com)
+		**username**   n/a             FTP username
+		**password**   n/a             FTP password
+		**port**       21              FTP server port number
+		**debug**      FALSE           TRUE/FALSE (boolean): Whether to enable debugging to display error messages
+		**passive**    TRUE            TRUE/FALSE (boolean): Whether to use passive mode
+		============== =============== =============================================================================
 
 	.. method:: upload($locpath, $rempath[, $mode = 'auto'[, $permissions = NULL]])
 
-		:param string $locpath: Local file path
-		:param string $rempath: Remote file path
-		:param string $mode: FTP mode, defaults to 'auto' (options are: 'auto', 'binary', 'ascii')
-		:param int $permissions: File permissions (octal)
-		:returns: bool
+		:param	string	$locpath: Local file path
+		:param	string	$rempath: Remote file path
+		:param	string	$mode: FTP mode, defaults to 'auto' (options are: 'auto', 'binary', 'ascii')
+		:param	int	$permissions: File permissions (octal)
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		Uploads a file to your server. You must supply the local path and the
 		remote path, and you can optionally set the mode and permissions.
@@ -154,10 +156,11 @@ Class Reference
 
 	.. method:: download($rempath, $locpath[, $mode = 'auto'])
 
-		:param string $rempath: Remote file path
-		:param string $locpath: Local file path
-		:param string $mode: FTP mode, defaults to 'auto' (options are: 'auto', 'binary', 'ascii')
-		:returns: bool
+		:param	string	$rempath: Remote file path
+		:param	string	$locpath: Local file path
+		:param	string	$mode: FTP mode, defaults to 'auto' (options are: 'auto', 'binary', 'ascii')
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		Downloads a file from your server. You must supply the remote path and
 		the local path, and you can optionally set the mode. Example::
@@ -166,14 +169,16 @@ Class Reference
 
 		If 'auto' mode is used it will base the mode on the file extension of the source file.
 
-		Returns FALSE if the download does not execute successfully (including if PHP does not have permission to write the local file).
+		Returns FALSE if the download does not execute successfully
+		(including if PHP does not have permission to write the local file).
 
-	.. method:: rename($old_file, $new_file, $move = FALSE)
+	.. method:: rename($old_file, $new_file[, $move = FALSE])
 
-		:param string $old_file: Old file name
-		:param string $new_file: New file name
-		:param bool $move: Whether a move is being performed
-		:returns: bool
+		:param	string	$old_file: Old file name
+		:param	string	$new_file: New file name
+		:param	bool	$move: Whether a move is being performed
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		Permits you to rename a file. Supply the source file name/path and the new file name/path.
 		::
@@ -183,9 +188,10 @@ Class Reference
 
 	.. method:: move($old_file, $new_file)
 
-		:param string $old_file: Old file name
-		:param string $new_file: New file name
-		:returns: bool
+		:param	string	$old_file: Old file name
+		:param	string	$new_file: New file name
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		Lets you move a file. Supply the source and destination paths::
 
@@ -196,8 +202,9 @@ Class Reference
 
 	.. method:: delete_file($filepath)
 
-		:param string $filepath: Path to file to delete
-		:returns: bool
+		:param	string	$filepath: Path to file to delete
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		Lets you delete a file. Supply the source path with the file name.
 		::
@@ -206,8 +213,9 @@ Class Reference
 
 	.. method:: delete_dir($filepath)
 
-		:param string $filepath: Path to directory to delete
-		:returns: bool
+		:param	string	$filepath: Path to directory to delete
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		Lets you delete a directory and everything it contains. Supply the
 		source path to the directory with a trailing slash.
@@ -223,8 +231,9 @@ Class Reference
 
 	.. method:: list_files([$path = '.'])
 
-		:param string $path: Directory path
-		:returns: array or FALSE on failure
+		:param	string	$path: Directory path
+		:returns:	An array list of files or FALSE on failure
+		:rtype:	array
 
 		Permits you to retrieve a list of files on your server returned as an
 		array. You must supply the path to the desired directory.
@@ -235,9 +244,10 @@ Class Reference
 
 	.. method:: mirror($locpath, $rempath)
 
-		:param string $locpath: Local path
-		:param string $rempath: Remote path
-		:returns: bool
+		:param	string	$locpath: Local path
+		:param	string	$rempath: Remote path
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		Recursively reads a local folder and everything it contains (including
 		sub-folders) and creates a mirror via FTP based on it. Whatever the
@@ -248,9 +258,10 @@ Class Reference
 
 	.. method:: mkdir($path[, $permissions = NULL])
 
-		:param string $path: Path to directory to create
-		:param int $permissions: Permissions (octal)
-		:returns: bool
+		:param	string	$path: Path to directory to create
+		:param	int	$permissions: Permissions (octal)
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		Lets you create a directory on your server. Supply the path ending in
 		the folder name you wish to create, with a trailing slash.
@@ -263,9 +274,10 @@ Class Reference
 
 	.. method:: chmod($path, $perm)
 
-		:param string $path: Path to alter permissions for
-		:param int $perm: Permissions (octal)
-		:returns: bool
+		:param	string	$path: Path to alter permissions for
+		:param	int	$perm: Permissions (octal)
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		Permits you to set file permissions. Supply the path to the file or
 		directory you wish to alter permissions on::
@@ -275,9 +287,10 @@ Class Reference
 
 	.. method:: changedir($path[, $suppress_debug = FALSE])
 
-		:param string $path: Directory path
-		:param bool $suppress_debug: Whether to turn off debug messages for this command
-		:returns: bool
+		:param	string	$path: Directory path
+		:param	bool	$suppress_debug: Whether to turn off debug messages for this command
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		Changes the current working directory to the specified path.
 
@@ -286,7 +299,8 @@ Class Reference
 
 	.. method:: close()
 
-		:returns: bool
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		Closes the connection to your server. It's recommended that you use this
 		when you are finished uploading.
\ No newline at end of file
diff --git a/user_guide_src/source/libraries/image_lib.rst b/user_guide_src/source/libraries/image_lib.rst
index cf23e397a..16acf090b 100644
--- a/user_guide_src/source/libraries/image_lib.rst
+++ b/user_guide_src/source/libraries/image_lib.rst
@@ -318,14 +318,16 @@ Class Reference
 
 	.. method:: initialize([$props = array()])
 
-		:param array $props: Image processing preferences
-		:returns: void
+		:param	array	$props: Image processing preferences
+		:returns:	TRUE on success, FALSE in case of invalid settings
+		:rtype:	bool
 
 		Initializes the class for processing an image.
 
 	.. method:: resize()
 
-		:returns: bool
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		The image resizing method lets you resize the original image, create a
 		copy (with or without resizing), or create a thumbnail image.
@@ -371,14 +373,15 @@ Class Reference
 
 	.. method:: crop()
 
-		:returns: bool
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		The cropping method works nearly identically to the resizing function
 		except it requires that you set preferences for the X and Y axis (in
 		pixels) specifying where to crop, like this::
 
-			$config['x_axis'] = '100';
-			$config['y_axis'] = '40';
+			$config['x_axis'] = 100;
+			$config['y_axis'] = 40;
 
 		All preferences listed in the :ref:`processing-preferences` table are available for this
 		method except these: *rotation_angle*, *create_thumb* and *new_image*.
@@ -388,8 +391,8 @@ Class Reference
 			$config['image_library'] = 'imagemagick';
 			$config['library_path'] = '/usr/X11R6/bin/';
 			$config['source_image']	= '/path/to/image/mypic.jpg';
-			$config['x_axis'] = '100';
-			$config['y_axis'] = '60';
+			$config['x_axis'] = 100;
+			$config['y_axis'] = 60;
 
 			$this->image_lib->initialize($config); 
 
@@ -406,7 +409,8 @@ Class Reference
 
 	.. method:: rotate()
 
-		:returns: bool
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		The image rotation method requires that the angle of rotation be set
 		via its preference::
@@ -437,14 +441,15 @@ Class Reference
 
 	.. method:: watermark()
 
-		:returns: bool
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		Creates a watermark over an image, please refer to the :ref:`watermarking`
 		section for more info.		
 
 	.. method:: clear()
 
-		:returns: void
+		:rtype:	void
 
 		The clear method resets all of the values used when processing an
 		image. You will want to call this if you are processing images in a
@@ -456,9 +461,10 @@ Class Reference
 
 	.. method:: display_errors([$open = '<p>[, $close = '</p>']])
 
-		:param string $open: Error message opening tag
-		:param string $close: Error message closing tag
-		:returns: string
+		:param	string	$open: Error message opening tag
+		:param	string	$close: Error message closing tag
+		:returns:	Error messages
+		:rtype:	string
 
 		Returns all detected errors formatted as a string.
 		::
diff --git a/user_guide_src/source/libraries/input.rst b/user_guide_src/source/libraries/input.rst
index 8a83207af..7ebf0e1c7 100644
--- a/user_guide_src/source/libraries/input.rst
+++ b/user_guide_src/source/libraries/input.rst
@@ -68,10 +68,10 @@ With CodeIgniter's built in methods you can simply do this::
 
 The main methods are:
 
--  $this->input->post()
--  $this->input->get()
--  $this->input->cookie()
--  $this->input->server()
+-  ``$this->input->post()``
+-  ``$this->input->get()``
+-  ``$this->input->cookie()``
+-  ``$this->input->server()``
 
 Using the php://input stream
 ============================
@@ -108,9 +108,10 @@ Class Reference
 
 	.. method:: post([$index = NULL[, $xss_clean = NULL]])
 
-		:param string $index: POST parameter name
-		:param bool $xss_clean: Whether to apply XSS filtering
-		:returns: mixed
+		:param	string	$index: POST parameter name
+		:param	bool	$xss_clean: Whether to apply XSS filtering
+		:returns:	$_POST if no parameters supplied, otherwise the POST value if found or NULL if not
+		:rtype:	mixed
 
 		The first parameter will contain the name of the POST item you are
 		looking for::
@@ -138,9 +139,10 @@ Class Reference
 
 	.. method:: get([$index = NULL[, $xss_clean = NULL]])
 
-		:param string $index: GET parameter name
-		:param bool $xss_clean: Whether to apply XSS filtering
-		:returns: mixed
+		:param	string	$index: GET parameter name
+		:param	bool	$xss_clean: Whether to apply XSS filtering
+		:returns:	$_GET if no parameters supplied, otherwise the GET value if found or NULL if not
+		:rtype:	mixed
 
 		This method is identical to ``post()``, only it fetches GET data.
 		::
@@ -158,9 +160,10 @@ Class Reference
 
 	.. method:: post_get([$index = ''[, $xss_clean = NULL]])
 
-		:param string $index: POST/GET parameter name
-		:param bool $xss_clean: Whether to apply XSS filtering
-		:returns: mixed
+		:param	string	$index: POST/GET parameter name
+		:param	bool	$xss_clean: Whether to apply XSS filtering
+		:returns:	POST/GET value if found, NULL if not
+		:rtype:	mixed
 
 		This method works the same way as ``post()`` and ``get()``, only combined.
 		It will search through both POST and GET streams for data, looking in POST
@@ -170,9 +173,10 @@ Class Reference
 
 	.. method:: get_post([$index = ''[, $xss_clean = NULL]])
 
-		:param string $index: GET/POST parameter name
-		:param bool $xss_clean: Whether to apply XSS filtering
-		:returns: mixed
+		:param	string	$index: GET/POST parameter name
+		:param	bool	$xss_clean: Whether to apply XSS filtering
+		:returns:	GET/POST value if found, NULL if not
+		:rtype:	mixed
 
 		This method works the same way as ``post_get()`` only it looks for GET
 		data first.
@@ -184,9 +188,10 @@ Class Reference
 
 	.. method:: cookie([$index = ''[, $xss_clean = NULL]])
 
-		:param string $index: COOKIE parameter name
-		:param bool $xss_clean: Whether to apply XSS filtering
-		:returns: mixed
+		:param	string	$index: COOKIE parameter name
+		:param	bool	$xss_clean: Whether to apply XSS filtering
+		:returns:	$_COOKIE if no parameters supplied, otherwise the COOKIE value if found or NULL if not
+		:rtype:	mixed
 
 		This method is identical to ``post()`` and ``get()``, only it fetches cookie
 		data::
@@ -196,9 +201,10 @@ Class Reference
 
 	.. method:: server([$index = ''[, $xss_clean = NULL]])
 
-		:param string $index: Value name
-		:param bool $xss_clean: Whether to apply XSS filtering
-		:returns: mixed
+		:param	string	$index: Value name
+		:param	bool	$xss_clean: Whether to apply XSS filtering
+		:returns:	$_SERVER item value if found, NULL if not
+		:rtype:	mixed
 
 		This method is identical to the ``post()``, ``get()`` and ``cookie()`` methods,
 		only it fetches server data (``$_SERVER``)::
@@ -207,24 +213,26 @@ Class Reference
 
 	.. method:: input_stream([$index = ''[, $xss_clean = NULL]])
 
-		:param string $index: Key name
-		:param bool $xss_clean: Whether to apply XSS filtering
-		:returns: mixed
+		:param	string	$index: Key name
+		:param	bool	$xss_clean: Whether to apply XSS filtering
+		:returns:	Input stream array if no parameters supplied, otherwise the specified value if found or NULL if not
+		:rtype:	mixed
 
 		This method is identical to ``get()``, ``post()`` and ``cookie()``,
 		only it fetches the *php://input* stream data.
 
 	.. method:: set_cookie($name = ''[, $value = ''[, $expire = ''[, $domain = ''[, $path = '/'[, $prefix = ''[, $secure = FALSE[, $httponly = FALSE]]]]]]])
 
-		:param mixed $name: Cookie name or an array of parameters
-		:param string $value: Cookie value
-		:param int $expire: Cookie expiration time in seconds
-		:param string $domain: Cookie domain
-		:param string $path: Cookie path
-		:param string $prefix: Cookie name prefix
-		:param bool $secure: Whether to only transfer the cookie through HTTPS
-		:param bool $httponly: Whether to only make the cookie accessible for HTTP requests (no JavaScript)
-		:returns: void
+		:param	mixed	$name: Cookie name or an array of parameters
+		:param	string	$value: Cookie value
+		:param	int	$expire: Cookie expiration time in seconds
+		:param	string	$domain: Cookie domain
+		:param	string	$path: Cookie path
+		:param	string	$prefix: Cookie name prefix
+		:param	bool	$secure: Whether to only transfer the cookie through HTTPS
+		:param	bool	$httponly: Whether to only make the cookie accessible for HTTP requests (no JavaScript)
+		:rtype:	void
+
 
 		Sets a cookie containing the values you specify. There are two ways to
 		pass information to this method so that a cookie can be set: Array
@@ -247,7 +255,7 @@ Class Reference
 
 			$this->input->set_cookie($cookie);
 
-		**Notes:**
+		**Notes**
 
 		Only the name and value are required. To delete a cookie set it with the
 		expiration blank.
@@ -276,10 +284,10 @@ Class Reference
 
 			$this->input->set_cookie($name, $value, $expire, $domain, $path, $prefix, $secure);
 
-
 	.. method:: ip_address()
 
-		:returns: string
+		:returns:	Visitor's IP address or '0.0.0.0' if not valid
+		:rtype:	string
 
 		Returns the IP address for the current user. If the IP address is not
 		valid, the method will return '0.0.0.0'::
@@ -293,9 +301,10 @@ Class Reference
 
 	.. method:: valid_ip($ip[, $which = ''])
 
-		:param string $ip: IP address
-		:param string $which: IP protocol ('ipv4' or 'ipv6')
-		:returns: bool
+		:param	string	$ip: IP address
+		:param	string	$which: IP protocol ('ipv4' or 'ipv6')
+		:returns:	TRUE if the address is valid, FALSE if not
+		:rtype:	bool
 
 		Takes an IP address as input and returns TRUE or FALSE (boolean) depending
 		on whether it is valid or not.
@@ -319,7 +328,8 @@ Class Reference
 
 	.. method:: user_agent()
 
-		:returns: string
+		:returns:	User agent string or NULL if not set
+		:rtype:	mixed
 
 		Returns the user agent string (web browser) being used by the current user,
 		or NULL if it's not available.
@@ -332,8 +342,9 @@ Class Reference
 
 	.. method:: request_headers([$xss_clean = FALSE])
 
-		:param bool $xss_clean: Whether to apply XSS filtering
-		:returns: array
+		:param	bool	$xss_clean: Whether to apply XSS filtering
+		:returns:	An array of HTTP request headers
+		:rtype:	array
 
 		Returns an array of HTTP request headers.
 		Useful if running in a non-Apache environment where
@@ -345,9 +356,10 @@ Class Reference
 
 	.. method:: get_request_header($index[, $xss_clean = FALSE])
 
-		:param string $index: HTTP request header name
-		:param bool $xss_clean: Whether to apply XSS filtering
-		:returns: string
+		:param	string	$index: HTTP request header name
+		:param	bool	$xss_clean: Whether to apply XSS filtering
+		:returns:	An HTTP request header or NULL if not found
+		:rtype:	string
 
 		Returns a single member of the request headers array or NULL
 		if the searched header is not found.
@@ -357,14 +369,16 @@ Class Reference
 
 	.. method:: is_ajax_request()
 
-		:returns: bool
+		:returns:	TRUE if it is an Ajax request, FALSE if not
+		:rtype:	bool
 
 		Checks to see if the HTTP_X_REQUESTED_WITH server header has been
 		set, and returns boolean TRUE if it is or FALSE if not.
 
 	.. method:: is_cli_request()
 
-		:returns: bool
+		:returns:	TRUE if it is a CLI request, FALSE if not
+		:rtype:	bool
 
 		Checks to see if the application was run from the command-line
 		interface.
@@ -382,8 +396,9 @@ Class Reference
 
 	.. method:: method([$upper = FALSE])
 
-		:param bool $upper: Whether to return the request method name in upper or lower case
-		:returns: string
+		:param	bool	$upper: Whether to return the request method name in upper or lower case
+		:returns:	HTTP request method
+		:rtype:	string
 
 		Returns the ``$_SERVER['REQUEST_METHOD']``, with the option to set it
 		in uppercase or lowercase.
diff --git a/user_guide_src/source/libraries/language.rst b/user_guide_src/source/libraries/language.rst
index 10449b935..3014d8f09 100644
--- a/user_guide_src/source/libraries/language.rst
+++ b/user_guide_src/source/libraries/language.rst
@@ -110,20 +110,22 @@ Class Reference
 
 	.. method:: load($langfile[, $idiom = ''[, $return = FALSE[, $add_suffix = TRUE[, $alt_path = '']]]])
 
-		:param string $langfile: Language file to load
-		:param string $idiom: Language name (i.e. 'english')
-		:param bool $return: Whether to return the loaded array of translations
-		:param bool $add_suffix: Whether to add the '_lang' suffix to the language file name
-		:param string $alt_path: An alternative path to look in for the language file
-		:returns: void or array if the third parameter is set to TRUE
+		:param	string	$langfile: Language file to load
+		:param	string	$idiom: Language name (i.e. 'english')
+		:param	bool	$return: Whether to return the loaded array of translations
+		:param	bool	$add_suffix: Whether to add the '_lang' suffix to the language file name
+		:param	string	$alt_path: An alternative path to look in for the language file
+		:returns:	Array of language lines if $return is set to TRUE, otherwise void
+		:rtype:	mixed
 
 		Loads a language file.
 
 	.. method:: line($line[, $log_errors = TRUE])
 
-		:param string $line: Language line key name
-		:param bool $log_errors: Whether to log an error if the line isn't found
-		:returns: string or FALSE on failure
+		:param	string	$line: Language line key name
+		:param	bool	$log_errors: Whether to log an error if the line isn't found
+		:returns:	Language line string or FALSE on failure
+		:rtype:	string
 
 		Fetches a single translation line from the already loaded language files,
 		based on the line's name.
\ No newline at end of file
diff --git a/user_guide_src/source/libraries/loader.rst b/user_guide_src/source/libraries/loader.rst
index 15d9d80fc..107b3ece3 100644
--- a/user_guide_src/source/libraries/loader.rst
+++ b/user_guide_src/source/libraries/loader.rst
@@ -80,10 +80,11 @@ Class Reference
 
 	.. method:: library($library[, $params = NULL[, $object_name = NULL]])
 
-		:param mixed $library: Library name as a string or an array with multiple libraries
-		:param array $params: Optional array of parameters to pass to the loaded library's constructor
-		:param string $object_name: Optional object name to assign the library to
-		:returns: object
+		:param	mixed	$library: Library name as a string or an array with multiple libraries
+		:param	array	$params: Optional array of parameters to pass to the loaded library's constructor
+		:param	string	$object_name: Optional object name to assign the library to
+		:returns:	CI_Loader instance (method chaining)
+		:rtype:	CI_Loader
 
 		This method is used to load core classes.
 
@@ -156,10 +157,11 @@ Class Reference
 
 	.. method:: driver($library[, $params = NULL[, $object_name]])
 
-		:param mixed $library: Library name as a string or an array with multiple libraries
-		:param array $params: Optional array of parameters to pass to the loaded library's constructor
-		:param string $object_name: Optional object name to assign the library to
-		:returns: object
+		:param	mixed	$library: Library name as a string or an array with multiple libraries
+		:param	array	$params: Optional array of parameters to pass to the loaded library's constructor
+		:param	string	$object_name: Optional object name to assign the library to
+		:returns:	CI_Loader instance (method chaining)
+		:rtype:	CI_Loader
 
 		This method is used to load driver libraries, acts very much like the
 		``library()`` method.
@@ -216,10 +218,11 @@ Class Reference
 
 	.. method:: view($view[, $vars = array()[, return = FALSE]])
 
-		:param string $view: View name
-		:param array $vars: An associative array of variables
-		:param bool $return: Whether to return the loaded view
-		:returns: mixed
+		:param	string	$view: View name
+		:param	array	$vars: An associative array of variables
+		:param	bool	$return: Whether to return the loaded view
+		:returns:	View content string if $return is set to TRUE, otherwise CI_Loader instance (method chaining)
+		:rtype:	mixed
 
 		This method is used to load your View files. If you haven't read the
 		:doc:`Views <../general/views>` section of the user guide it is
@@ -249,9 +252,10 @@ Class Reference
 
 	.. method:: vars($vars[, $val = ''])
 
-		:param mixed $vars: An array of variables or a single variable name
-		:param mixed $val: Optional variable value
-		:returns: object
+		:param	mixed	$vars: An array of variables or a single variable name
+		:param	mixed	$val: Optional variable value
+		:returns:	CI_Loader instance (method chaining)
+		:rtype:	CI_Loader
 
 		This method takes an associative array as input and generates
 		variables using the PHP `extract() <http://www.php.net/extract>`_
@@ -265,8 +269,9 @@ Class Reference
 
 	.. method:: get_var($key)
 
-		:param string $key: Variable name key
-		:returns: mixed
+		:param	string	$key: Variable name key
+		:returns:	Value if key is found, NULL if not
+		:rtype:	mixed
 
 		This method checks the associative array of variables available to
 		your views. This is useful if for any reason a var is set in a library
@@ -274,22 +279,25 @@ Class Reference
 
 	.. method:: get_vars()
 
-		:returns: array
+		:returns:	An array of all assigned view variables
+		:rtype:	array
 
 		This method retrieves all variables available to your views.
 
 	.. method:: clear_vars()
 
-		:returns: object
+		:returns:	CI_Loader instance (method chaining)
+		:rtype:	CI_Loader
 
 		Clears cached view variables.
 
 	.. method:: model($model[, $name = ''[, $db_conn = FALSE]])
 
-		:param mixed $model: Model name or an array containing multiple models
-		:param string $name: Optional object name to assign the model to
-		:param string $db_conn: Optional database configuration group to load
-		:returns: object
+		:param	mixed	$model: Model name or an array containing multiple models
+		:param	string	$name: Optional object name to assign the model to
+		:param	string	$db_conn: Optional database configuration group to load
+		:returns:	CI_Loader instance (method chaining)
+		:rtype:	CI_Loader
 
 		::
 
@@ -310,10 +318,11 @@ Class Reference
 
 	.. method:: database([$params = ''[, $return = FALSE[, $query_builder = NULL]]])
 
-		:param mixed $params: Database group name or configuration options
-		:param bool $return: Whether to return the loaded database object
-		:param bool $query_builder: Whether to load the Query Builder
-		:returns: mixed
+		:param	mixed	$params: Database group name or configuration options
+		:param	bool	$return: Whether to return the loaded database object
+		:param	bool	$query_builder: Whether to load the Query Builder
+		:returns:	Loaded CI_DB instance or FALSE on failure if $return is set to TRUE, otherwise CI_Loader instance (method chaining)
+		:rtype:	mixed
 
 		This method lets you load the database class. The two parameters are
 		**optional**. Please see the :doc:`database <../database/index>`
@@ -321,35 +330,39 @@ Class Reference
 
 	.. method:: dbforge([$db = NULL[, $return = FALSE]])
 
-		:param object $db: Database object
-		:param bool $return: Whether to return the Database Forge instance
-		:returns: mixed
+		:param	object	$db: Database object
+		:param	bool	$return: Whether to return the Database Forge instance
+		:returns:	Loaded CI_DB_forge instance if $return is set to TRUE, otherwise CI_Loader instance (method chaining)
+		:rtype:	mixed
 
 		Loads the :doc:`Database Forge <../database/forge>` class, please refer
 		to that manual for more info.
 
 	.. method:: dbutil([$db = NULL[, $return = FALSE]])
 
-		:param object $db: Database object
-		:param bool $return: Whether to return the Database Utilities instance
-		:returns: mixed
+		:param	object	$db: Database object
+		:param	bool	$return: Whether to return the Database Utilities instance
+		:returns:	Loaded CI_DB_utility instance if $return is set to TRUE, otherwise CI_Loader instance (method chaining)
+		:rtype:	mixed
 
 		Loads the :doc:`Database Utilities <../database/utilities>` class, please
 		refer to that manual for more info.
 
 	.. method:: helper($helpers)
 
-		:param mixed $helpers: Helper name as a string or an array containing multiple helpers
-		:returns: object
+		:param	mixed	$helpers: Helper name as a string or an array containing multiple helpers
+		:returns:	CI_Loader instance (method chaining)
+		:rtype:	CI_Loader
 
 		This method loads helper files, where file_name is the name of the
 		file, without the _helper.php extension.
 
 	.. method:: file($path[, $return = FALSE])
 
-		:param string $path: File path
-		:param bool $return: Whether to return the loaded file
-		:returns: mixed
+		:param	string	$path: File path
+		:param	bool	$return: Whether to return the loaded file
+		:returns:	File contents if $return is set to TRUE, otherwise CI_Loader instance (method chaining)
+		:rtype:	mixed
 
 		This is a generic file loading method. Supply the filepath and name in
 		the first parameter and it will open and read the file. By default the
@@ -359,27 +372,30 @@ Class Reference
 
 	.. method:: language($files[, $lang = ''])
 
-		:param mixed $files: Language file name or an array of multiple language files
-		:param string $lang: Language name
-		:returns: object
+		:param	mixed	$files: Language file name or an array of multiple language files
+		:param	string	$lang: Language name
+		:returns:	CI_Loader instance (method chaining)
+		:rtype:	CI_Loader
 
 		This method is an alias of the :doc:`language loading
 		method <language>`: ``$this->lang->load()``.
 
 	.. method:: config($file[, $use_sections = FALSE[, $fail_gracefully = FALSE]])
 
-		:param string $file: Configuration file name
-		:param bool $use_sections: Whether configuration values should be loaded into their own section
-		:param bool $fail_gracefully: Whether to just return FALSE in case of failure
-		:returns: bool
+		:param	string	$file: Configuration file name
+		:param	bool	$use_sections: Whether configuration values should be loaded into their own section
+		:param	bool	$fail_gracefully: Whether to just return FALSE in case of failure
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		This method is an alias of the :doc:`config file loading
 		method <config>`: ``$this->config->load()``
 
 	.. method:: is_loaded($class)
 
-		:param string $class: Class name
-		:returns: mixed
+		:param	string	$class: Class name
+		:returns:	Singleton property name if found, FALSE if not
+		:rtype:	mixed
 
 		Allows you to check if a class has already been loaded or not.
 
@@ -405,9 +421,10 @@ Class Reference
 
 	.. method:: add_package_path($path[, $view_cascade = TRUE])
 
-		:param string $path: Path to add
-		:param bool $view_cascade: Whether to use cascading views
-		:returns: object
+		:param	string	$path: Path to add
+		:param	bool	$view_cascade: Whether to use cascading views
+		:returns:	CI_Loader instance (method chaining)
+		:rtype:	CI_Loader
 
 		Adding a package path instructs the Loader class to prepend a given path
 		for subsequent requests for resources. As an example, the "Foo Bar"
@@ -419,8 +436,9 @@ Class Reference
 
 	.. method:: remove_package_path([$path = ''])
 
-		:param string $path: Path to remove
-		:returns: object
+		:param	string	$path: Path to remove
+		:returns:	CI_Loader instance (method chaining)
+		:rtype:	CI_Loader
 
 		When your controller is finished using resources from an application
 		package, and particularly if you have other application packages you
@@ -435,7 +453,8 @@ Class Reference
 
 	.. method:: get_package_paths([$include_base = TRUE])
 
-		:param bool $include_base: Whether to include BASEPATH
-		:returns: array
+		:param	bool	$include_base: Whether to include BASEPATH
+		:returns:	An array of package paths
+		:rtype:	array
 
 		Returns all currently available package paths.
\ No newline at end of file
diff --git a/user_guide_src/source/libraries/migration.rst b/user_guide_src/source/libraries/migration.rst
index 4143609bb..e8ea1d977 100644
--- a/user_guide_src/source/libraries/migration.rst
+++ b/user_guide_src/source/libraries/migration.rst
@@ -142,25 +142,30 @@ Class Reference
 
 	.. method:: current()
 
-		:returns: mixed
+		:returns:	TRUE if no migrations are found, current version string on success, FALSE on failure
+		:rtype:	mixed
 
-		Migrates up to the current version (whatever is set for ``$config['migration_version']`` in *application/config/migration.php*).
+		Migrates up to the current version (whatever is set for
+		``$config['migration_version']`` in *application/config/migration.php*).
 
 	.. method:: error_string()
 
-		:returns: string
+		:returns:	Error messages
+		:rtype:	string
 
 		This returns a string of errors that were detected while performing a migration.
 
 	.. method:: find_migrations()
 
-		:returns: array
+		:returns:	An array of migration files
+		:rtype:	array
 
 		An array of migration filenames are returned that are found in the **migration_path** property.
 
 	.. method:: latest()
 
-		:returns: mixed
+		:returns:	TRUE if no migrations are found, current version string on success, FALSE on failure
+		:rtype:	mixed
 
 		This works much the same way as ``current()`` but instead of looking for 
 		the ``$config['migration_version']`` the Migration class will use the very 
@@ -168,11 +173,12 @@ Class Reference
 
 	.. method:: version($target_version)
 
-		:param mixed $target_version: Migration version to process
-		:returns: mixed
+		:param	mixed	$target_version: Migration version to process
+		:returns:	TRUE if no migrations are found, current version string on success, FALSE on failure
+		:rtype:	mixed
 
 		Version can be used to roll back changes or step forwards programmatically to 
 		specific versions. It works just like ``current()`` but ignores ``$config['migration_version']``.
 		::
 
-			$this->migration->version(5);
+			$this->migration->version(5);
\ No newline at end of file
diff --git a/user_guide_src/source/libraries/output.rst b/user_guide_src/source/libraries/output.rst
index 76197bdc1..e49ea5366 100644
--- a/user_guide_src/source/libraries/output.rst
+++ b/user_guide_src/source/libraries/output.rst
@@ -43,8 +43,9 @@ Class Reference
 
 	.. method:: set_output($output)
 
-		:param string $output: String to set the output to
-		:returns: object
+		:param	string	$output: String to set the output to
+		:returns:	CI_Output instance (method chaining)
+		:rtype:	CI_Output
 
 		Permits you to manually set the final output string. Usage example::
 
@@ -52,13 +53,14 @@ Class Reference
 
 		.. important:: If you do set your output manually, it must be the last thing done
 			in the function you call it from. For example, if you build a page in one
-			of your controller functions, don't set the output until the end.
+			of your controller methods, don't set the output until the end.
 
 	.. method:: set_content_type($mime_type[, $charset = NULL])
 
-		:param string $mime_type: MIME Type idenitifer string
-		:param string $charset: Character set
-		:returns: object
+		:param	string	$mime_type: MIME Type idenitifer string
+		:param	string	$charset: Character set
+		:returns:	CI_Output instance (method chaining)
+		:rtype:	CI_Output
 
 		Permits you to set the mime-type of your page so you can serve JSON data, JPEG's, XML, etc easily.
 		::
@@ -80,7 +82,8 @@ Class Reference
 
 	.. method:: get_content_type()
 
-		:returns: string
+		:returns:	Content-Type string
+		:rtype:	string
 
 		Returns the Content-Type HTTP header that's currently in use, excluding the character set value.
 		::
@@ -91,8 +94,9 @@ Class Reference
 
 	.. method:: get_header($header)
 
-		:param string $header: HTTP header name
-		:returns: string
+		:param	string	$header: HTTP header name
+		:returns:	HTTP response header or NULL if not found
+		:rtype:	mixed
 
 		Returns the requested HTTP header value, or NULL if the requested header is not set.
 		Example::
@@ -107,7 +111,8 @@ Class Reference
 
 	.. method:: get_output()
 
-		:returns: string
+		:returns:	Output string
+		:rtype:	string
 
 		Permits you to manually retrieve any output that has been sent for
 		storage in the output class. Usage example::
@@ -120,8 +125,9 @@ Class Reference
 
 	.. method:: append_output($output)
 
-		:param string $output: Additional output data to append
-		:returns: object
+		:param	string	$output: Additional output data to append
+		:returns:	CI_Output instance (method chaining)
+		:rtype:	CI_Output
 
 		Appends data onto the output string.
 		::
@@ -130,9 +136,10 @@ Class Reference
 
 	.. method:: set_header($header[, $replace = TRUE])
 
-		:param string $header: HTTP Header
-		:param bool $replace: Whether to replace the old header value, if it is already set
-		:returns: object
+		:param	string	$header: HTTP response header
+		:param	bool	$replace: Whether to replace the old header value, if it is already set
+		:returns:	CI_Output instance (method chaining)
+		:rtype:	CI_Output
 
 		Permits you to manually set server headers, which the output class will
 		send for you when outputting the final rendered display. Example::
@@ -146,9 +153,10 @@ Class Reference
 
 	.. method:: set_status_header([$code = 200[, $text = '']])
 
-		:param int $code: HTTP status code
-		:param string $text: Optional message
-		:returns: object
+		:param	int	$code: HTTP status code
+		:param	string	$text: Optional message
+		:returns:	CI_Output instance (method chaining)
+		:rtype:	CI_Output
 
 		Permits you to manually set a server status header. Example::
 
@@ -162,8 +170,9 @@ Class Reference
 
 	.. method:: enable_profiler([$val = TRUE])
 
-		:param bool $val: Whether to enable or disable the Profiler
-		:returns: object
+		:param	bool	$val: Whether to enable or disable the Profiler
+		:returns:	CI_Output instance (method chaining)
+		:rtype:	CI_Output
 
 		Permits you to enable/disable the :doc:`Profiler <../general/profiling>`, which will display benchmark
 		and other data at the bottom of your pages for debugging and optimization purposes.
@@ -181,16 +190,18 @@ Class Reference
 
 	.. method:: set_profiler_sections($sections)
 
-		:param array $sections: Profiler sections
-		:returns: object
+		:param	array	$sections: Profiler sections
+		:returns:	CI_Output instance (method chaining)
+		:rtype:	CI_Output
 
 		Permits you to enable/disable specific sections of the Profiler when it is enabled.
 		Please refer to the :doc:`Profiler <../general/profiling>` documentation for further information.
 
 	.. method:: cache($time)
 
-		:param int $time: Cache expiration time in seconds
-		:returns: object
+		:param	int	$time: Cache expiration time in seconds
+		:returns:	CI_Output instance (method chaining)
+		:rtype:	CI_Output
 
 		Caches the current page for the specified amount of seconds.
 
diff --git a/user_guide_src/source/libraries/pagination.rst b/user_guide_src/source/libraries/pagination.rst
index 34ca22141..222436f46 100644
--- a/user_guide_src/source/libraries/pagination.rst
+++ b/user_guide_src/source/libraries/pagination.rst
@@ -307,13 +307,14 @@ Class Reference
 
 	.. method:: initialize([$params = array()])
 
-		:param array $params: Configuration parameters
-		:returns: void
+		:param	array	$params: Configuration parameters
+		:rtype:	void
 
 		Initializes the Pagination class with your preferred options.
 
 	.. method:: create_links()
 
-		:returns: string
+		:returns:	HTML-formatted pagination
+		:rtype:	string
 
 		Returns a "pagination" bar, containing the generated links or an empty string if there's just a single page.
\ No newline at end of file
diff --git a/user_guide_src/source/libraries/parser.rst b/user_guide_src/source/libraries/parser.rst
index 34ad65f2b..5af504a03 100644
--- a/user_guide_src/source/libraries/parser.rst
+++ b/user_guide_src/source/libraries/parser.rst
@@ -151,27 +151,29 @@ Class Reference
 
 	.. method:: parse($template, $data[, $return = FALSE])
 
-		:param string $template: Path to view file
-		:param array $data: Variable data
-		:param bool $return: Whether to return the parsed template
-		:returns: mixed
+		:param	string	$template: Path to view file
+		:param	array	$data: Variable data
+		:param	bool	$return: Whether to only return the parsed template
+		:returns:	Parsed template string
+		:rtype:	string
 
 		Parses a template from the provided path and variables.
 
 	.. method:: parse_string($template, $data[, $return = FALSE])
 
-		:param string $template: Path to view file
-		:param array $data: Variable data
-		:param bool $return: Whether to return the parsed template
-		:returns: mixed
+		:param	string	$template: Path to view file
+		:param	array	$data: Variable data
+		:param	bool	$return: Whether to only return the parsed template
+		:returns:	Parsed template string
+		:rtype:	string
 
 		This method works exactly like ``parse()``, only it accepts the template as a
 		string instead of loading a view file.
 
 	.. method:: set_delimiters([$l = '{'[, $r = '}']])
 
-		:param string $l: Left delimiter
-		:param string $r: Right delimiter
-		:returns: void
+		:param	string	$l: Left delimiter
+		:param	string	$r: Right delimiter
+		:rtype: void
 
 		Sets the delimiters (opening and closing) for a value "tag" in a template.
\ No newline at end of file
diff --git a/user_guide_src/source/libraries/security.rst b/user_guide_src/source/libraries/security.rst
index 451fadf93..fb875a0d9 100644
--- a/user_guide_src/source/libraries/security.rst
+++ b/user_guide_src/source/libraries/security.rst
@@ -105,17 +105,19 @@ Class Reference
 
 	.. method:: xss_clean($str[, $is_image = FALSE])
 
-		:param string $str: Input string
-		:returns: mixed
+		:param	mixed	$str: Input string or an array of strings
+		:returns:	XSS-clean data
+		:rtype:	mixed
 
 		Tries to remove XSS exploits from the input data and returns the cleaned string.
 		If the optional second parameter is set to true, it will return boolean TRUE if the image is safe to use and FALSE if malicious data was detected in it.
 
 	.. method:: sanitize_filename($str[, $relative_path = FALSE])
 
-		:param string $str: File name/path
-		:param bool $relative_path: Whether to preserve any directories in the file path
-		:returns: string
+		:param	string	$str: File name/path
+		:param	bool	$relative_path: Whether to preserve any directories in the file path
+		:returns:	Sanitized file name/path
+		:rtype:	string
 
 		Tries to sanitize filenames in order to prevent directory traversal attempts
 		and other security threats, which is particularly useful for files that were supplied via user input.
@@ -131,23 +133,27 @@ Class Reference
 
 	.. method:: get_csrf_token_name()
 
-		:returns: string
+		:returns:	CSRF token name
+		:rtype:	string
 
 		Returns the CSRF token name (the ``$config['csrf_token_name']`` value).
 
 	.. method:: get_csrf_hash()
 
-		:returns: string
+		:returns:	CSRF hash
+		:rtype:	string
 
 		Returns the CSRF hash value. Useful in combination with ``get_csrf_token_name()``
 		for manually building forms or sending valid AJAX POST requests.
 
 	.. method:: entity_decode($str[, $charset = NULL])
 
-		:param string $str: Input string
-		:param string $charset: Character set of the input string
+		:param	string	$str: Input string
+		:param	string	$charset: Character set of the input string
+		:returns:	Entity-decoded string
+		:rtype:	string
 
 		This method acts a lot like PHP's own native ``html_entity_decode()`` function in ENT_COMPAT mode, only
 		it tries to detect HTML entities that don't end in a semicolon because some browsers allow that.
 
-		If the ``$charset`` parameter is left empty, then your configured ``$config['charset']`` value will be used.
+		If the ``$charset`` parameter is left empty, then your configured ``$config['charset']`` value will be used.
\ No newline at end of file
diff --git a/user_guide_src/source/libraries/sessions.rst b/user_guide_src/source/libraries/sessions.rst
index 9e23e9b60..f05f86af1 100644
--- a/user_guide_src/source/libraries/sessions.rst
+++ b/user_guide_src/source/libraries/sessions.rst
@@ -526,20 +526,23 @@ Class Reference
 
 	.. method:: load_driver($driver)
 
-		:param string $driver: Driver name
-		:returns: object
+		:param	string	$driver: Driver name
+		:returns:	Instance of currently loaded session driver
+		:rtype:	mixed
 
 		Loads a session storage driver
 
 	.. method:: select_driver($driver)
 
-		:param string $driver: Driver name
-		:returns: void
+		:param	string	$driver: Driver name
+		:rtype:	void
 
 		Selects default session storage driver.
 
 	.. method:: sess_destroy()
 
+		:rtype:	void
+
 		Destroys current session
 
 		.. note:: This method should be the last one called, and even flash
@@ -549,15 +552,16 @@ Class Reference
 
 	.. method:: sess_regenerate([$destroy = FALSE])
 
-		:param bool $destroy: Whether to destroy session data
-		:returns: void
+		:param	bool	$destroy: Whether to destroy session data
+		:rtype:	void
 
 		Regenerate the current session data.
 
 	.. method:: userdata([$item = NULL])
 
-		:param string $item: Session item name
-		:returns: mixed
+		:param	string	$item: Session item name
+		:returns:	Item value if found, NULL if not or an array of all userdata if $item parameter is not used
+		:rtype:	mixed
 
 		If no parameter is passed, it will return an associative array of all existing userdata.
 
@@ -569,7 +573,8 @@ Class Reference
 
 	.. method:: all_userdata()
 
-		:returns: array
+		:returns:	An array of all userdata
+		:rtype:	array
 
 		Returns an array with all of the session userdata items.
 
@@ -577,15 +582,16 @@ Class Reference
 
 	.. method:: &get_userdata()
 
-		:returns: array
+		:returns:	A reference to the userdata array
+		:rtype:	&array
 
 		Returns a reference to the userdata array.
 
 	.. method:: set_userdata($newdata[, $newval = ''])
 
-		:param mixed $newdata: Item name or array of items
-		:param mixed $newval: Item value or empty string (not required if $newdata is array)
-		:returns: void
+		:param	mixed	$newdata: Item name or array of items
+		:param	mixed	$newval: Item value or empty string (not required if $newdata is array)
+		:rtype:	void
 
 		Sets items into session example usages::
 
@@ -597,8 +603,8 @@ Class Reference
 
 	.. method:: unset_userdata($item)
 
-		:param mixed $item: Item name or an array containing multiple items
-		:returns: void
+		:param	mixed	$item: Item name or an array containing multiple items
+		:rtype:	void
 
 		Unsets previously set items from the session. Example::
 
@@ -610,15 +616,17 @@ Class Reference
 
 	.. method:: has_userdata($item)
 
-		:param string $item: Item name
-		:returns: bool
+		:param	string	$item: Item name
+		:returns:	TRUE if item exists, FALSE if not
+		:rtype:	bool
 
 		Checks if an item exists in the session.
 
 	.. method:: flashdata([$item = NULL])
 
-		:param string $item: Flashdata item name
-		:returns: mixed
+		:param	string	$item: Flashdata item name
+		:returns:	Item value if found, NULL if not or an array of all flashdata if $item parameter is not used
+		:rtype:	mixed
 
 		If no parameter is passed, it will return an associative array of all existing flashdata.
 
@@ -630,9 +638,9 @@ Class Reference
 
 	.. method:: set_flashdata($newdata[, $newval = ''])
 
-		:param mixed $newdata: Item name or an array of items
-		:param mixed $newval: Item value or empty string (not required if $newdata is array)
-		:returns: void
+		:param	mixed	$newdata: Item name or an array of items
+		:param	mixed	$newval: Item value or empty string (not required if $newdata is array)
+		:rtype: void
 
 		Sets items into session flashdata example usages::
 
@@ -645,15 +653,16 @@ Class Reference
 
 	.. method:: keep_flashdata($item)
 
-		:param mixed $item: Item name or an array containing multiple flashdata items
-		:returns: void
+		:param	mixed	$item: Item name or an array containing multiple flashdata items
+		:rtype:	void
 
 		Keeps items into flashdata for one more request.
 
 	.. method:: tempdata([$item = NULL])
 
-		:param string $item: Tempdata item name
-		:returns: mixed
+		:param	string	$item: Tempdata item name
+		:returns:	Item value if found, NULL if not or an array of all tempdata if $item parameter is not used
+		:rtype:	mixed
 
 		If no parameter is passed, it will return an associative array of all existing tempdata.
 
@@ -665,10 +674,10 @@ Class Reference
 
 	.. method:: set_tempdata($newdata[, $newval = ''[, $expire = 0]])
 
-		:param mixed $newdata: Item name or array containing multiple items
-		:param string $newval: Item value or empty string (not required if $newdata is array)
-		:param int $expire: Lifetime in seconds (0 for default)
-		:returns: void
+		:param	mixed	$newdata: Item name or array containing multiple items
+		:param	string	$newval: Item value or empty string (not required if $newdata is array)
+		:param	int	$expire: Lifetime in seconds (0 for default)
+		:rtype:	void
 
 		Sets items into session tempdata example::
 
@@ -681,8 +690,8 @@ Class Reference
 
 	.. method:: unset_tempdata($item)
 
-		:param mixed $item: Item name or an array containing multiple items
-		:returns: void
+		:param	mixed	$item: Item name or an array containing multiple items
+		:rtype:	void
 
 		Unsets previously set items from tempdata. Example::
 
diff --git a/user_guide_src/source/libraries/table.rst b/user_guide_src/source/libraries/table.rst
index ed085f781..ea0c417c4 100644
--- a/user_guide_src/source/libraries/table.rst
+++ b/user_guide_src/source/libraries/table.rst
@@ -158,15 +158,16 @@ Class Reference
 
 	.. method:: generate([$table_data = NULL])
 
-		:param mixed $table_data: data to populate the table rows with
-		:returns: string
+		:param	mixed	$table_data: Data to populate the table rows with
+		:returns:	HTML table
+		:rtype:	string
 
 		Returns a string containing the generated table. Accepts an optional parameter which can be an array or a database result object.
 
 	.. method:: set_caption($caption)
 
-		:param string $caption: table caption
-		:returns: void
+		:param	string	$caption: Table caption
+		:rtype:	void
 
 		Permits you to add a caption to the table.
 		::
@@ -175,8 +176,8 @@ Class Reference
 
 	.. method:: set_heading([$args = array()[, ...]])
 
-		:param mixed $args: an array or multiple strings containing the table column titles
-		:returns: void
+		:param	mixed	$args: An array or multiple strings containing the table column titles
+		:rtype:	void
 
 		Permits you to set the table heading. You can submit an array or discrete params::
 
@@ -186,8 +187,8 @@ Class Reference
 
 	.. method:: add_row([$args = array()[, ...]])
 
-		:param mixed $args: an array or multiple strings containing the row values
-		:returns: void
+		:param	mixed	$args: An array or multiple strings containing the row values
+		:rtype:	void
 
 		Permits you to add a row to your table. You can submit an array or discrete params::
 
@@ -206,9 +207,10 @@ Class Reference
 
 	.. method:: make_columns([$array = array()[, $col_limit = 0]])
 
-		:param array $array: an array containing multiple rows' data
-		:param int $col_limit: count of columns in the table
-		:returns: array
+		:param	array	$array: An array containing multiple rows' data
+		:param	int	$col_limit: Count of columns in the table
+		:returns:	An array of HTML table columns
+		:rtype:	array
 
 		This method takes a one-dimensional array as input and creates a multi-dimensional array with a depth equal to the number of columns desired.
 		This allows a single array with many elements to be displayed in a table that has a fixed column count. Consider this example::
@@ -235,8 +237,9 @@ Class Reference
 
 	.. method:: set_template($template)
 
-		:param array $template: associative array containing template values
-		:returns: bool
+		:param	array	$template: An associative array containing template values
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		Permits you to set your template. You can submit a full or partial template.
 		::
@@ -249,8 +252,8 @@ Class Reference
 
 	.. method:: set_empty($value)
 
-		:param mixed $value: value to put in empty cells
-		:returns: void
+		:param	mixed	$value: Value to put in empty cells
+		:rtype:	void
 
 		Lets you set a default value for use in any table cells that are empty.
 		You might, for example, set a non-breaking space::
@@ -259,7 +262,7 @@ Class Reference
 
 	.. method:: clear()
 
-		:returns: void
+		:rtype:	void
 
 		Lets you clear the table heading and row data. If you need to show multiple tables with different data you should to call this method
 		after each table has been generated to clear the previous table information. Example::
diff --git a/user_guide_src/source/libraries/trackback.rst b/user_guide_src/source/libraries/trackback.rst
index c5b01a2ee..22859a13d 100644
--- a/user_guide_src/source/libraries/trackback.rst
+++ b/user_guide_src/source/libraries/trackback.rst
@@ -225,22 +225,24 @@ Class Reference
 
 	.. method:: send($tb_data)
 
-		:param array $tb_data: trackback data
-		:returns: bool
+		:param	array	$tb_data: Trackback data
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		Send trackback.
 
 	.. method:: receive()
 
-		:returns: bool
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		This method simply validates the incoming TB data, returning TRUE on success and FALSE on failure.
 		If the data is valid it is set to the ``$this->data`` array so that it can be inserted into a database.
 
 	.. method:: send_error([$message = 'Incomplete information')
 
-		:param string $message: error message
-		:returns: void
+		:param	string	$message: Error message
+		:rtype: void
 
 		Responses to a trackback request with an error message.
 
@@ -248,7 +250,7 @@ Class Reference
 
 	.. method:: send_success()
 
-		:returns: void
+		:rtype:	void
 
 		Responses to a trackback request with a success message.
 
@@ -256,74 +258,82 @@ Class Reference
 
 	.. method:: data($item)
 
-		:param string $item: data key
-		:returns: string
+		:param	string	$item: Data key
+		:returns:	Data value or empty string if not found
+		:rtype:	string
 
 		Returns a single item from the reponse data array.
 
 	.. method:: process($url, $data)
 
-		:param string $url: target url
-		:param string $data: raw post data
-		:returns: bool
+		:param	string	$url: Target url
+		:param	string	$data: Raw POST data
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		Opens a socket connection and passes the data to the server, returning TRUE on success and FALSE on failure.
 
 	.. method:: extract_urls($urls)
 
-		:param string $urls: comma-separated url list
-		:returns: string
+		:param	string	$urls: Comma-separated URL list
+		:returns:	Array of URLs
+		:rtype:	array
 
 		This method lets multiple trackbacks to be sent. It takes a string of URLs (separated by comma or space) and puts each URL into an array.
 
 	.. method:: validate_url(&$url)
 
-		:param string $url: trackback url
-		:returns: void
+		:param	string	$url: Trackback URL
+		:rtype:	void
 
 		Simply adds the *http://* prefix it it's not already present in the URL.
 
 	.. method:: get_id($url)
 
-		:param string $url: trackback url
-		:returns: string
+		:param	string	$url: Trackback URL
+		:returns:	URL ID or FALSE on failure
+		:rtype:	string
 
 		Find and return a trackback URL's ID or FALSE on failure.
 
 	.. method:: convert_xml($str)
 
-		:param string $str: input string
-		:returns: string
+		:param	string	$str: Input string
+		:returns:	Converted string
+		:rtype:	string
 
 		Converts reserved XML characters to entities.
 
 	.. method:: limit_characters($str[, $n = 500[, $end_char = '&#8230;']])
 
-		:param string $str: input string
-		:param int $n: max characters number
-		:param string $end_char: character to put at end of string
-		:returns: string
+		:param	string	$str: Input string
+		:param	int	$n: Max characters number
+		:param	string	$end_char: Character to put at end of string
+		:returns:	Shortened string
+		:rtype:	string
 
 		Limits the string based on the character count. Will preserve complete words.
 
 	.. method:: convert_ascii($str)
 
-		:param string $str: input string
-		:returns: string
+		:param	string	$str: Input string
+		:returns:	Converted string
+		:rtype:	string
 
 		Converts high ASCII text and MS Word special characterss to HTML entities.
 
 	.. method:: set_error($msg)
 
-		:param string $msg: error message
-		:returns: void
+		:param	string	$msg: Error message
+		:rtype:	void
 
 		Set an log an error message.
 
 	.. method:: display_errors([$open = '<p>'[, $close = '</p>']])
 
-		:param string $open: open tag
-		:param string $close: close tag
-		:returns: string
+		:param	string	$open: Open tag
+		:param	string	$close: Close tag
+		:returns:	HTML formatted error messages
+		:rtype:	string
 
 		Returns error messages formatted in HTML or an empty string if there are no errors.
\ No newline at end of file
diff --git a/user_guide_src/source/libraries/typography.rst b/user_guide_src/source/libraries/typography.rst
index c1a864a3e..65fea9d8e 100644
--- a/user_guide_src/source/libraries/typography.rst
+++ b/user_guide_src/source/libraries/typography.rst
@@ -46,9 +46,10 @@ Class Reference
 
 	.. method auto_typography($str[, $reduce_linebreaks = FALSE])
 
-		:param string $str: input string
-		:param bool $reduce_linebreaks: whether to reduce consequitive linebreaks
-		:returns: string
+		:param	string	$str: Input string
+		:param	bool	$reduce_linebreaks: Whether to reduce consequitive linebreaks
+		:returns:	HTML typography-safe string
+		:rtype:	string
 
 		Formats text so that it is semantically and typographically correct HTML.
 		Takes a string as input and returns it with the following formatting:
@@ -76,8 +77,9 @@ Class Reference
 
 	.. method:: format_characters($str)
 
-		:param string $str: input string
-		:returns: string
+		:param	string	$str: Input string
+		:returns:	Formatted string
+		:rtype:	string
 
 		This method is similar to ``auto_typography()`` above, except that it only does character conversion:
 
@@ -93,8 +95,9 @@ Class Reference
 
 	.. method:: nl2br_except_pre($str)
 
-		:param string $str: input string
-		:returns: string
+		:param	string	$str: Input string
+		:returns:	Formatted string
+		:rtype:	string
 
 		Converts newlines to <br /> tags unless they appear within <pre> tags.
 		This method is identical to the native PHP :php:func:`nl2br()` function, except that it ignores <pre> tags.
diff --git a/user_guide_src/source/libraries/unit_testing.rst b/user_guide_src/source/libraries/unit_testing.rst
index 2d4a27a25..0bc860f61 100644
--- a/user_guide_src/source/libraries/unit_testing.rst
+++ b/user_guide_src/source/libraries/unit_testing.rst
@@ -193,45 +193,48 @@ Class Reference
 
 	.. method:: run($test[, $expected = TRUE[, $test_name = 'undefined'[, $notes = '']]])
 
-		:param mixed $test: Test data
-		:param mixed $expected: Expected result
-		:param string $test_name: Test name
-		:param string $notes: Any notes to be attached to the test
-		:returns: string
+		:param	mixed	$test: Test data
+		:param	mixed	$expected: Expected result
+		:param	string	$test_name: Test name
+		:param	string	$notes: Any notes to be attached to the test
+		:returns:	Test report
+		:rtype:	string
 
 		Runs unit tests.
 
 	.. method:: report([$result = array()])
 
-		:param array $result: Array containing tests results
-		:returns: string
+		:param	array	$result: Array containing tests results
+		:returns:	Test report
+		:rtype:	string
 
 		Generates a report about already complete tests.
 
 	.. method:: use_strict([$state = TRUE])
 
-		:param bool $state: Strict state flag
-		:returns: void
+		:param	bool	$state: Strict state flag
+		:rtype:	void
 
 		Enables/disables strict type comparison in tests.
 
 	.. method:: active([$state = TRUE])
 
-		:param bool $state: Whether to enable testing
-		:returns: void
+		:param	bool	$state: Whether to enable testing
+		:rtype:	void
 
 		Enables/disables unit testing.
 
 	.. method:: result([$results = array()])
 
-		:param array $results: Tests results list
-		:returns: array
+		:param	array	$results: Tests results list
+		:returns:	Array of raw result data
+		:rtype:	array
 
 		Returns raw tests results data.
 
 	.. method:: set_template($template)
 
-		:param string $template: Test result template
-		:returns: void
+		:param	string	$template: Test result template
+		:rtype:	void
 
 		Sets the template for displaying tests results.
\ No newline at end of file
diff --git a/user_guide_src/source/libraries/uri.rst b/user_guide_src/source/libraries/uri.rst
index f0fa04005..7db758ce7 100644
--- a/user_guide_src/source/libraries/uri.rst
+++ b/user_guide_src/source/libraries/uri.rst
@@ -24,9 +24,10 @@ Class Reference
 
 	.. method:: segment($n[, $no_result = NULL])
 
-		:param int $n: Segment index number
-		:param mixed $no_result: What to return if the searched segment is not found
-		:returns: mixed
+		:param	int	$n: Segment index number
+		:param	mixed	$no_result: What to return if the searched segment is not found
+		:returns:	Segment value or $no_result value if not found
+		:rtype:	mixed
 
 		Permits you to retrieve a specific segment. Where n is the segment
 		number you wish to retrieve. Segments are numbered from left to right.
@@ -60,9 +61,10 @@ Class Reference
 
 	.. method:: rsegment($n[, $no_result = NULL])
 
-		:param int $n: Segment index number
-		:param mixed $no_result: What to return if the searched segment is not found
-		:returns: mixed
+		:param	int	$n: Segment index number
+		:param	mixed	$no_result: What to return if the searched segment is not found
+		:returns:	Routed segment value or $no_result value if not found
+		:rtype:	mixed
 
 		This method is identical to ``segment()``, except that it lets you retrieve
 		a specific segment from your re-routed URI in the event you are
@@ -70,9 +72,10 @@ Class Reference
 
 	.. method:: slash_segment($n[, $where = 'trailing'])
 
-		:param int $n: Segment index number
-		:param string $where: Where to add the slash ('trailing' or 'leading')
-		:returns: string
+		:param	int	$n: Segment index number
+		:param	string	$where: Where to add the slash ('trailing' or 'leading')
+		:returns:	Segment value, prepended/suffixed with a forward slash, or a slash if not found
+		:rtype:	string
 
 		This method is almost identical to ``segment()``, except it
 		adds a trailing and/or leading slash based on the second parameter.
@@ -90,9 +93,10 @@ Class Reference
 
 	.. method:: slash_rsegment($n[, $where = 'trailing'])
 
-		:param int $n: Segment index number
-		:param string $where: Where to add the slash ('trailing' or 'leading')
-		:returns: string
+		:param	int	$n: Segment index number
+		:param	string	$where: Where to add the slash ('trailing' or 'leading')
+		:returns:	Routed segment value, prepended/suffixed with a forward slash, or a slash if not found
+		:rtype:	string
 
 		This method is identical to ``slash_segment()``, except that it lets you
 		add slashes a specific segment from your re-routed URI in the event you
@@ -101,9 +105,10 @@ Class Reference
 
 	.. method:: uri_to_assoc([$n = 3[, $default = array()]])
 
-		:param int $n: Segment index number
-		:param array $default: Default values
-		:returns: array
+		:param	int	$n: Segment index number
+		:param	array	$default: Default values
+		:returns:	Associative URI segments array
+		:rtype:	array
 
 		This method lets you turn URI segments into and associative array of
 		key/value pairs. Consider this URI::
@@ -142,9 +147,10 @@ Class Reference
 
 	.. method:: ruri_to_assoc([$n = 3[, $default = array()]])
 
-		:param int $n: Segment index number
-		:param array $default: Default values
-		:returns: array
+		:param	int	$n: Segment index number
+		:param	array	$default: Default values
+		:returns:	Associative routed URI segments array
+		:rtype:	array
 
 		This method is identical to ``uri_to_assoc()``, except that it creates
 		an associative array using the re-routed URI in the event you are using
@@ -152,8 +158,9 @@ Class Reference
 
 	.. method:: assoc_to_uri($array)
 
-		:param array $array: Input array of key/value pairs
-		:returns: string
+		:param	array	$array: Input array of key/value pairs
+		:returns:	URI string
+		:rtype:	string
 
 		Takes an associative array as input and generates a URI string from it.
 		The array keys will be included in the string. Example::
@@ -165,7 +172,8 @@ Class Reference
 
 	.. method:: uri_string()
 
-		:returns: string
+		:returns:	URI string
+		:rtype:	string
 
 		Returns a string with the complete URI. For example, if this is your full URL::
 
@@ -177,7 +185,8 @@ Class Reference
 
 	.. method:: ruri_string()
 
-		:returns: string
+		:returns:	Routed URI string
+		:rtype:	string
 
 		This method is identical to ``uri_string()``, except that it returns
 		the re-routed URI in the event you are using CodeIgniter's :doc:`URI
@@ -185,13 +194,15 @@ Class Reference
 
 	.. method:: total_segments()
 
-		:returns: int
+		:returns:	Count of URI segments
+		:rtype:	int
 
 		Returns the total number of segments.
 
 	.. method:: total_rsegments()
 
-		:returns: int
+		:returns:	Count of routed URI segments
+		:rtype:	int
 
 		This method is identical to ``total_segments()``, except that it returns
 		the total number of segments in your re-routed URI in the event you are
@@ -199,7 +210,8 @@ Class Reference
 
 	.. method:: segment_array()
 
-		:returns: array
+		:returns:	URI segments array
+		:rtype:	array
 
 		Returns an array containing the URI segments. For example::
 
@@ -213,7 +225,8 @@ Class Reference
 
 	.. method:: rsegment_array()
 
-		:returns: array
+		:returns:	Routed URI segments array
+		:rtype:	array
 
 		This method is identical to ``segment_array()``, except that it returns
 		the array of segments in your re-routed URI in the event you are using
diff --git a/user_guide_src/source/libraries/user_agent.rst b/user_guide_src/source/libraries/user_agent.rst
index 1b6a2988a..517382a65 100644
--- a/user_guide_src/source/libraries/user_agent.rst
+++ b/user_guide_src/source/libraries/user_agent.rst
@@ -76,8 +76,9 @@ Class Reference
 
 	.. method:: is_browser([$key = NULL])
 
-		:param string $key: optional browser name
-		:returns: bool
+		:param	string	$key: Optional browser name
+		:returns:	TRUE if the user agent is a (specified) browser, FALSE if not
+		:rtype:	bool
 
 		Returns TRUE/FALSE (boolean) if the user agent is a known web browser.
 		::
@@ -97,8 +98,9 @@ Class Reference
 
 	.. method:: is_mobile([$key = NULL])
 
-		:param string $key: optional mobile device name
-		:returns: bool
+		:param	string	$key: Optional mobile device name
+		:returns:	TRUE if the user agent is a (specified) mobile device, FALSE if not
+		:rtype:	bool
 
 		Returns TRUE/FALSE (boolean) if the user agent is a known mobile device.
 		::
@@ -118,8 +120,9 @@ Class Reference
 
 	.. method:: is_robot([$key = NULL])
 
-		:param string $key: optional robot name
-		:returns: bool
+		:param	string	$key: Optional robot name
+		:returns:	TRUE if the user agent is a (specified) robot, FALSE if not
+		:rtype:	bool
 
 		Returns TRUE/FALSE (boolean) if the user agent is a known robot.
 
@@ -130,43 +133,50 @@ Class Reference
 
 	.. method:: is_referral()
 
-		:returns: bool
+		:returns:	TRUE if the user agent is a referral, FALSE if not
+		:rtype:	bool
 
 		Returns TRUE/FALSE (boolean) if the user agent was referred from another site.
 
 	.. method:: browser()
 
-		:returns: string
+		:returns:	Detected browser or an empty string
+		:rtype:	string
 
 		Returns a string containing the name of the web browser viewing your site.
 
 	.. method:: version()
 
-		:returns: string
+		:returns:	Detected browser version or an empty string
+		:rtype:	string
 
 		Returns a string containing the version number of the web browser viewing your site.
 
 	.. method:: mobile()
 
-		:returns: string
+		:returns:	Detected mobile device brand or an empty string
+		:rtype:	string
 
 		Returns a string containing the name of the mobile device viewing your site.
 
 	.. method:: robot()
 
-		:returns: string
+		:returns:	Detected robot name or an empty string
+		:rtype:	string
 
 		Returns a string containing the name of the robot viewing your site.
 
 	.. method:: platform()
 
-		:returns: string
+		:returns:	Detected operating system or an empty string
+		:rtype:	string
 
 		Returns a string containing the platform viewing your site (Linux, Windows, OS X, etc.).
 
 	.. method:: referrer()
 
-		:returns: string
+		:returns:	Detected referrer or an empty string
+		:rtype:	string
 
 		The referrer, if the user agent was referred from another site. Typically you'll test for this as follows::
 
@@ -177,7 +187,8 @@ Class Reference
 
 	.. method:: agent_string()
 
-		:returns: string
+		:returns:	Full user agent string or an empty string
+		:rtype:	string
 
 		Returns a string containing the full user agent string. Typically it will be something like this::
 
@@ -185,8 +196,9 @@ Class Reference
 
 	.. method:: accept_lang([$lang = 'en'])
 
-		:param string $lang: language key
-		:returns: bool
+		:param	string	$lang: Language key
+		:returns:	TRUE if provided language is accepted, FALSE if not
+		:rtype:	bool
 
 		Lets you determine if the user agent accepts a particular language. Example::
 
@@ -200,14 +212,16 @@ Class Reference
 
 	.. method:: languages()
 
-		:returns: array
+		:returns:	An array list of accepted languages
+		:rtype:	array
 
 		Returns an array of languages supported by the user agent.
 
 	.. method:: accept_charset([$charset = 'utf-8'])
 
-		:param string $charset: character set
-		:returns: bool
+		:param	string	$charset: Character set
+		:returns:	TRUE if the character set is accepted, FALSE if not
+		:rtype:	bool
 
 		Lets you determine if the user agent accepts a particular character set. Example::
 
@@ -221,13 +235,14 @@ Class Reference
 
 	.. method:: charsets()
 
-		:returns: array
+		:returns:	An array list of accepted character sets
+		:rtype:	array
 
 		Returns an array of character sets accepted by the user agent.
 
 	.. method:: parse($string)
 
-		:param string $string: A custom user-agent string
-		:returns: void
+		:param	string	$string: A custom user-agent string
+		:rtype:	void
 
 		Parses a custom user-agent string, different from the one reported by the current visitor.
\ No newline at end of file
diff --git a/user_guide_src/source/libraries/xmlrpc.rst b/user_guide_src/source/libraries/xmlrpc.rst
index d9b2dfb1a..2cf548750 100644
--- a/user_guide_src/source/libraries/xmlrpc.rst
+++ b/user_guide_src/source/libraries/xmlrpc.rst
@@ -459,18 +459,18 @@ Class Reference
 
 	.. method:: initialize([$config = array()])
 
-		:param array $config: configuration data
-		:returns: void
+		:param	array	$config: Configuration data
+		:rtype:	void
 
 		Initializes the XML-RPC library. Accepts an associative array containing your settings.
 
 	.. method:: server($url[, $port = 80[, $proxy = FALSE[, $proxy_port = 8080]]])
 
-		:param string $url: XML-RPC server URL
-		:param int $port: server port
-		:param string $proxy: optional proxy
-		:param int $proxy_port: proxy listening port
-		:returns: void
+		:param	string	$url: XML-RPC server URL
+		:param	int	$port: Server port
+		:param	string	$proxy: Optional proxy
+		:param	int	$proxy_port: Proxy listening port
+		:rtype:	void
 
 		Sets the URL and port number of the server to which a request is to be sent::
 
@@ -482,8 +482,8 @@ Class Reference
 
 	.. method:: timeout($seconds = 5)
 
-		:param int $seconds: timeout in seconds
-		:returns: void
+		:param	int	$seconds: Timeout in seconds
+		:rtype:	void
 
 		Set a time out period (in seconds) after which the request will be canceled::
 
@@ -491,8 +491,8 @@ Class Reference
 
 	.. method:: method($function)
 
-		:param string $function: method name
-		:returns: void
+		:param	string	$function: Method name
+		:rtype:	void
 
 		Sets the method that will be requested from the XML-RPC server::
 
@@ -502,8 +502,8 @@ Class Reference
 
 	.. method:: request($incoming)
 
-		:param array $incoming: request data
-		:returns: void
+		:param	array	$incoming: Request data
+		:rtype:	void
 
 		Takes an array of data and builds request to be sent to XML-RPC server::
 
@@ -512,20 +512,22 @@ Class Reference
 
 	.. method:: send_request()
 
-		:returns: bool
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		The request sending method. Returns boolean TRUE or FALSE based on success for failure, enabling it to be used conditionally.
 
 	.. method set_debug($flag = TRUE)
 
-		:param bool $flag: debug status flag
-		:returns: void
+		:param	bool	$flag: Debug status flag
+		:rtype:	void
 
 	Enables or disables debugging, which will display a variety of information and error data helpful during development.
 
 	.. method:: display_error()
 
-		:returns: string
+		:returns:	Error message string
+		:rtype:	string
 
 		Returns an error message as a string if your request failed for some reason.
 		::
@@ -534,7 +536,8 @@ Class Reference
 
 	.. method:: display_response()
 
-		:returns: mixed
+		:returns:	Response
+		:rtype:	mixed
 
 		Returns the response from the remote server once request is received. The response will typically be an associative array.
 		::
@@ -543,9 +546,10 @@ Class Reference
 
 	.. method:: send_error_message($number, $message)
 
-		:param int $number: error number
-		:param string $message: error message
-		:returns: object
+		:param	int	$number: Error number
+		:param	string	$message: Error message
+		:returns:	XML_RPC_Response instance
+		:rtype:	XML_RPC_Response
 
 		This method lets you send an error message from your server to the client.
 		First parameter is the error number while the second parameter is the error message.
@@ -555,8 +559,9 @@ Class Reference
 
 	.. method send_response($response)
 
-		:param array $response: response data
-		:returns: object
+		:param	array	$response: Response data
+		:returns:	XML_RPC_Response instance
+		:rtype:	XML_RPC_Response
 
 		Lets you send the response from your server to the client. An array of valid data values must be sent with this method.
 		::
@@ -569,4 +574,4 @@ Class Reference
 				'struct'
 			);
 
-		return $this->xmlrpc->send_response($response);
+		return $this->xmlrpc->send_response($response);
\ No newline at end of file
diff --git a/user_guide_src/source/libraries/zip.rst b/user_guide_src/source/libraries/zip.rst
index 535aa82d9..5ff7d07d6 100644
--- a/user_guide_src/source/libraries/zip.rst
+++ b/user_guide_src/source/libraries/zip.rst
@@ -54,9 +54,9 @@ Class Reference
 
 	.. method:: add_data($filepath[, $data = NULL])
 
-		:param mixed $filepath: a single file path or an array of file => data pairs
-		:param array $data: single file contents
-		:returns: void
+		:param	mixed	$filepath: A single file path or an array of file => data pairs
+		:param	array	$data: File contents (ignored if $filepath is an array)
+		:rtype:	void
 
 		Adds data to the Zip archive. Can work both in single and multiple files mode.
 
@@ -90,8 +90,8 @@ Class Reference
 
 	.. method:: add_dir($directory)
 
-		:param mixed $directory: string directory name or an array of multiple directories
-		:returns: void
+		:param	mixed	$directory: Directory name string or an array of multiple directories
+		:rtype:	void
 
 		Permits you to add a directory. Usually this method is unnecessary since you can place your data into directories when using
 		``$this->zip->add_data()``, but if you would like to create an empty directory you can do so::
@@ -100,9 +100,10 @@ Class Reference
 
 	.. method:: read_file($path[, $archive_filepath = FALSE])
 
-		:param string $path: Path to file
-		:param mixed $archive_filepath: New file name/path (string) or (boolean) whether to maintain the original filepath
-		:returns: bool
+		:param	string	$path: Path to file
+		:param	mixed	$archive_filepath: New file name/path (string) or (boolean) whether to maintain the original filepath
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		Permits you to compress a file that already exists somewhere on your server.
 		Supply a file path and the zip class will read it and add it to the archive::
@@ -138,10 +139,11 @@ Class Reference
 
 	.. method:: read_dir($path[, $preserve_filepath = TRUE[, $root_path = NULL]])
 
-		:param string $path: path to directory
-		:param bool $preserve_filepath: whether to maintain the original path
-		:param string $root_path: part of the path to exclude from the archive directory
-		:returns: bool
+		:param	string	$path: Path to directory
+		:param	bool	$preserve_filepath: Whether to maintain the original path
+		:param	string	$root_path: Part of the path to exclude from the archive directory
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		Permits you to compress a directory (and its contents) that already exists somewhere on your server.
 		Supply a path to the directory and the zip class will recursively read and recreate it as a Zip archive.
@@ -166,8 +168,9 @@ Class Reference
 
 	.. method:: archive($filepath)
 
-		:param string $filepath: path to target zip archive
-		:returns: bool
+		:param	string	$filepath: Path to target zip archive
+		:returns:	TRUE on success, FALSE on failure
+		:rtype:	bool
 
 		Writes the Zip-encoded file to a directory on your server. Submit a valid server path ending in the file name.
 		Make sure the directory is writable (660 or 666 is usually OK). Example::
@@ -176,8 +179,8 @@ Class Reference
 
 	.. method:: download($filename = 'backup.zip')
 
-		:param string $filename: the archive file name
-		:returns: void
+		:param	string	$filename: Archive file name
+		:rtype:	void
 
 		Causes the Zip file to be downloaded from your server. You must pass the name you would like the zip file called. Example::
 
@@ -189,7 +192,8 @@ Class Reference
 
 	.. method:: get_zip()
 
-		:returns: string
+		:returns:	Zip file content
+		:rtype:	string
 
 		Returns the Zip-compressed file data. Generally you will not need this method unless you want to do something unique with the data. Example::
 
@@ -202,7 +206,7 @@ Class Reference
 
 	.. method:: clear_data()
 
-		:returns: void
+		:rtype:	void
 
 		The Zip class caches your zip data so that it doesn't need to recompile the Zip archive for each method you use above.
 		If, however, you need to create multiple Zip archives, each with different data, you can clear the cache between calls. Example::
-- 
cgit v1.2.3-24-g4f1b


From 505b3d6b42d608b8555b62b78134f697a1f6d09f Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Sat, 8 Feb 2014 18:24:00 +0200
Subject: Make CI_Email::set_alt_message() parameter mandatory (optional
 doesn't make sense)

---
 user_guide_src/source/changelog.rst       | 2 +-
 user_guide_src/source/libraries/email.rst | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 0344b7894..a6fabe16b 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -331,7 +331,7 @@ Release Date: Not Released
       -  Added option to store raw values instead of CI-formatted ones (APC, Memcache).
       -  Added atomic increment/decrement feature via ``increment()``, ``decrement()``.
 
-   -  :doc:`Email Library <libraries/email>` changes include:
+   -  :doc:`E-mail Library <libraries/email>` changes include:
 
       -  Added a custom filename parameter to ``attach()`` as ``$this->email->attach($filename, $disposition, $newname)``.
       -  Added possibility to send attachment as buffer string in ``attach()`` as ``$this->email->attach($buffer, $disposition, $newname, $mime)``.
diff --git a/user_guide_src/source/libraries/email.rst b/user_guide_src/source/libraries/email.rst
index 3f990b628..ebfde809b 100644
--- a/user_guide_src/source/libraries/email.rst
+++ b/user_guide_src/source/libraries/email.rst
@@ -238,7 +238,7 @@ Class Reference
 
 			$this->email->message('This is my message');
 
-	.. method:: set_alt_message([$str = ''])
+	.. method:: set_alt_message($str)
 
 		:param	string	$str: Alternative e-mail message body
 		:returns:	CI_Email instance (method chaining)
-- 
cgit v1.2.3-24-g4f1b


From 7c60b12da3260cb3046f3f500431a1b7a5fb766d Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Sat, 8 Feb 2014 18:47:19 +0200
Subject: CI_Input tweaks

 - Make get_post(), post_get() and server()'s  parameter mandatory.
 - Change default value of  parameter to NULL for cookie(), input_stream() and _fetch_from_array()
   (for consistency with get(), post()).
 - Delegate Array-vs-single and  parameter detection to _fetch_from_array() to overall simplify the code.
---
 user_guide_src/source/libraries/input.rst | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/input.rst b/user_guide_src/source/libraries/input.rst
index 7ebf0e1c7..6162a6664 100644
--- a/user_guide_src/source/libraries/input.rst
+++ b/user_guide_src/source/libraries/input.rst
@@ -158,20 +158,20 @@ Class Reference
 			$this->input->get(NULL, TRUE); // returns all GET items with XSS filter
 			$this->input->get(NULL, FALSE); // returns all GET items without XSS filtering
 
-	.. method:: post_get([$index = ''[, $xss_clean = NULL]])
+	.. method:: post_get($index[, $xss_clean = NULL])
 
 		:param	string	$index: POST/GET parameter name
 		:param	bool	$xss_clean: Whether to apply XSS filtering
 		:returns:	POST/GET value if found, NULL if not
 		:rtype:	mixed
 
-		This method works the same way as ``post()`` and ``get()``, only combined.
-		It will search through both POST and GET streams for data, looking in POST
-		first, and then in GET::
+		This method works pretty much the same way as ``post()`` and ``get()``,
+		only combined. It will search through both POST and GET streams for data,
+		looking in POST first, and then in GET::
 
 			$this->input->post_get('some_data', TRUE);
 
-	.. method:: get_post([$index = ''[, $xss_clean = NULL]])
+	.. method:: get_post($index[, $xss_clean = NULL])
 
 		:param	string	$index: GET/POST parameter name
 		:param	bool	$xss_clean: Whether to apply XSS filtering
@@ -186,7 +186,7 @@ Class Reference
 		.. note:: This method used to act EXACTLY like ``post_get()``, but it's
 			behavior has changed in CodeIgniter 3.0.
 
-	.. method:: cookie([$index = ''[, $xss_clean = NULL]])
+	.. method:: cookie([$index = NULL[, $xss_clean = NULL]])
 
 		:param	string	$index: COOKIE parameter name
 		:param	bool	$xss_clean: Whether to apply XSS filtering
@@ -199,19 +199,19 @@ Class Reference
 			$this->input->cookie('some_cookie');
 			$this->input->cookie('some_cookie, TRUE); // with XSS filter
 
-	.. method:: server([$index = ''[, $xss_clean = NULL]])
+	.. method:: server($index[, $xss_clean = NULL])
 
 		:param	string	$index: Value name
 		:param	bool	$xss_clean: Whether to apply XSS filtering
 		:returns:	$_SERVER item value if found, NULL if not
 		:rtype:	mixed
 
-		This method is identical to the ``post()``, ``get()`` and ``cookie()`` methods,
-		only it fetches server data (``$_SERVER``)::
+		This method is identical to the ``post()``, ``get()`` and ``cookie()``
+		methods, only it fetches server data (``$_SERVER``)::
 
 			$this->input->server('some_data');
 
-	.. method:: input_stream([$index = ''[, $xss_clean = NULL]])
+	.. method:: input_stream([$index = NULL[, $xss_clean = NULL]])
 
 		:param	string	$index: Key name
 		:param	bool	$xss_clean: Whether to apply XSS filtering
-- 
cgit v1.2.3-24-g4f1b


From a89c1dabd11e8628106b1629f76ec9fc65c20085 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Sat, 8 Feb 2014 19:03:35 +0200
Subject: Method chaining support for FV set_data(), reset_validation()

---
 user_guide_src/source/libraries/form_validation.rst | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/form_validation.rst b/user_guide_src/source/libraries/form_validation.rst
index ae66cefb3..988d6fa25 100644
--- a/user_guide_src/source/libraries/form_validation.rst
+++ b/user_guide_src/source/libraries/form_validation.rst
@@ -1001,14 +1001,16 @@ Class Reference
 	.. method:: set_data($data)
 
 		:param	array	$data: Array of data validate
-		:rtype:	void
+		:returns:	CI_Form_validation instance (method chaining)
+		:rtype:	CI_Form_validation
 
 		Permits you to set an array for validation, instead of using the default
 		``$_POST`` array.
 
 	.. method:: reset_validation()
 
-		:rtype: void
+		:returns:	CI_Form_validation instance (method chaining)
+		:rtype:	CI_Form_validation
 
 		Permits you to reset the validation when you validate more than one array.
 		This method should be called before validating each new array.
-- 
cgit v1.2.3-24-g4f1b


From 6f6102c805198101fad36024b82692ebce20f2c8 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Sat, 8 Feb 2014 19:11:40 +0200
Subject: Add method chaining support to Calendar & Pagination libs

---
 user_guide_src/source/changelog.rst            | 2 ++
 user_guide_src/source/libraries/calendar.rst   | 6 ++++--
 user_guide_src/source/libraries/pagination.rst | 3 ++-
 3 files changed, 8 insertions(+), 3 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index a6fabe16b..f90fa42bf 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -284,6 +284,7 @@ Release Date: Not Released
 
    -  :doc:`Calendar Library <libraries/calendar>` changes include:
 
+      -  Added method chaining support.
       -  Added configuration to generate days of other months instead of blank cells.
       -  Auto set *next_prev_url* if it is empty and *show_prev_next* is set to TRUE.
 
@@ -352,6 +353,7 @@ Release Date: Not Released
 
    -  :doc:`Pagination Library <libraries/pagination>` changes include:
 
+      -  Added method chaining support to ``initialize()`` method.
       -  Added support for the anchor "rel" attribute.
       -  Added support for setting custom attributes.
       -  Deprecated usage of the "anchor_class" setting (use the new "attributes" setting instead).
diff --git a/user_guide_src/source/libraries/calendar.rst b/user_guide_src/source/libraries/calendar.rst
index aa10e941d..65a447a3d 100644
--- a/user_guide_src/source/libraries/calendar.rst
+++ b/user_guide_src/source/libraries/calendar.rst
@@ -202,7 +202,8 @@ Class Reference
 	.. method:: initialize([$config = array()])
 
 		:param	array	$config: Configuration parameters
-		:rtype:	void
+		:returns:	CI_Calendar instance (method chaining)
+		:rtype:	CI_Calendar
 
 		Initializes the Calendaring preferences. Accepts an associative array as input, containing display preferences.
 
@@ -280,7 +281,8 @@ Class Reference
 
 	.. method:: parse_template()
 
-		:rtype:	void
+		:returns:	CI_Calendar instance (method chaining)
+		:rtype:	CI_Calendar
 
 		Harvests the data within the template ``{pseudo-variables}`` used to
 		display the calendar.
\ No newline at end of file
diff --git a/user_guide_src/source/libraries/pagination.rst b/user_guide_src/source/libraries/pagination.rst
index 222436f46..ee12d9e6f 100644
--- a/user_guide_src/source/libraries/pagination.rst
+++ b/user_guide_src/source/libraries/pagination.rst
@@ -308,7 +308,8 @@ Class Reference
 	.. method:: initialize([$params = array()])
 
 		:param	array	$params: Configuration parameters
-		:rtype:	void
+		:returns:	CI_Pagination instance (method chaining)
+		:rtype:	CI_Pagination
 
 		Initializes the Pagination class with your preferred options.
 
-- 
cgit v1.2.3-24-g4f1b


From 1f5909527f5a4984d4fa0a1f3bd51aa5bd850406 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Sat, 8 Feb 2014 19:50:26 +0200
Subject: Add method chaining support to CI_Table

---
 user_guide_src/source/changelog.rst       |  6 +++++-
 user_guide_src/source/libraries/table.rst | 15 ++++++++++-----
 2 files changed, 15 insertions(+), 6 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index f90fa42bf..4a54593f0 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -387,7 +387,11 @@ Release Date: Not Released
       - Added check to detect if robots are pretending to be mobile clients (helps with e.g. Google indexing mobile website versions).
       - Added method ``parse()`` to allow parsing a custom user-agent string, different from the current visitor's.
 
-   -  Added support for setting :doc:`Table <libraries/table>` class defaults in a config file.
+   -  :doc:`HTML Table Library <libraries/table>` changes include:
+
+      - Added method chaining support.
+      - Added support for setting table class defaults in a config file.
+
    -  :doc:`Zip Library <libraries/zip>` method ``read_file()`` can now also alter the original file path/name while adding files to an archive.
 
 -  Core
diff --git a/user_guide_src/source/libraries/table.rst b/user_guide_src/source/libraries/table.rst
index ea0c417c4..6e011083e 100644
--- a/user_guide_src/source/libraries/table.rst
+++ b/user_guide_src/source/libraries/table.rst
@@ -167,7 +167,8 @@ Class Reference
 	.. method:: set_caption($caption)
 
 		:param	string	$caption: Table caption
-		:rtype:	void
+		:returns:	CI_Table instance (method chaining)
+		:rtype:	CI_Table
 
 		Permits you to add a caption to the table.
 		::
@@ -177,7 +178,8 @@ Class Reference
 	.. method:: set_heading([$args = array()[, ...]])
 
 		:param	mixed	$args: An array or multiple strings containing the table column titles
-		:rtype:	void
+		:returns:	CI_Table instance (method chaining)
+		:rtype:	CI_Table
 
 		Permits you to set the table heading. You can submit an array or discrete params::
 
@@ -188,7 +190,8 @@ Class Reference
 	.. method:: add_row([$args = array()[, ...]])
 
 		:param	mixed	$args: An array or multiple strings containing the row values
-		:rtype:	void
+		:returns:	CI_Table instance (method chaining)
+		:rtype:	CI_Table
 
 		Permits you to add a row to your table. You can submit an array or discrete params::
 
@@ -253,7 +256,8 @@ Class Reference
 	.. method:: set_empty($value)
 
 		:param	mixed	$value: Value to put in empty cells
-		:rtype:	void
+		:returns:	CI_Table instance (method chaining)
+		:rtype:	CI_Table
 
 		Lets you set a default value for use in any table cells that are empty.
 		You might, for example, set a non-breaking space::
@@ -262,7 +266,8 @@ Class Reference
 
 	.. method:: clear()
 
-		:rtype:	void
+		:returns:	CI_Table instance (method chaining)
+		:rtype:	CI_Table
 
 		Lets you clear the table heading and row data. If you need to show multiple tables with different data you should to call this method
 		after each table has been generated to clear the previous table information. Example::
-- 
cgit v1.2.3-24-g4f1b


From e4e1091d42e854e96706c153c71410301b3c3047 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Sat, 8 Feb 2014 19:58:48 +0200
Subject: Deprecate CI_Config::system_url()

---
 user_guide_src/source/installation/upgrade_300.rst | 13 +++++++++++++
 user_guide_src/source/libraries/config.rst         |  6 +++++-
 2 files changed, 18 insertions(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst
index 3f96a31e2..75aeea715 100644
--- a/user_guide_src/source/installation/upgrade_300.rst
+++ b/user_guide_src/source/installation/upgrade_300.rst
@@ -553,6 +553,19 @@ The new function is both available at all times for you to use and shorter to ty
 ``CI_Input::is_cli_request()`` is now now deprecated and scheduled for removal in
 CodeIgniter 3.1+.
 
+.. note:: This method is still available, but you're strongly encouraged to remove its usage
+	sooner rather than later.
+
+Config library method system_url()
+==================================
+
+Usage of ``CI_Config::system_url()`` encourages insecure coding practices.
+Namely, your CodeIgniter *system/* directory shouldn't be publicly accessible
+from a security point of view.
+
+Because of this, this method is now deprecated and scheduled for removal in
+CodeIgniter 3.1+.
+
 .. note:: This method is still available, but you're strongly encouraged to remove its usage
 	sooner rather than later.
 
diff --git a/user_guide_src/source/libraries/config.rst b/user_guide_src/source/libraries/config.rst
index b31815799..3116b768a 100644
--- a/user_guide_src/source/libraries/config.rst
+++ b/user_guide_src/source/libraries/config.rst
@@ -245,4 +245,8 @@ Class Reference
 		:returns:	URL pointing at your CI system/ directory
 		:rtype:	string
 
-		This method retrieves the URL to your CodeIgniter system/ directory.
\ No newline at end of file
+		This method retrieves the URL to your CodeIgniter system/ directory.
+
+		.. note:: This method is DEPRECATED because it encourages usage of
+			insecure coding practices. Your *system/* directory shouldn't
+			be publicly accessible.
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From d8a561a9cd12317342dd2f28aea8d76e93efce0d Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Sat, 8 Feb 2014 20:14:52 +0200
Subject: [ci skip] Deprecate the Javascript library

---
 user_guide_src/source/installation/upgrade_300.rst | 12 ++++++++++++
 user_guide_src/source/libraries/javascript.rst     |  5 +++--
 2 files changed, 15 insertions(+), 2 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/installation/upgrade_300.rst b/user_guide_src/source/installation/upgrade_300.rst
index 75aeea715..292c1de9d 100644
--- a/user_guide_src/source/installation/upgrade_300.rst
+++ b/user_guide_src/source/installation/upgrade_300.rst
@@ -569,6 +569,18 @@ CodeIgniter 3.1+.
 .. note:: This method is still available, but you're strongly encouraged to remove its usage
 	sooner rather than later.
 
+======================
+The Javascript library
+======================
+
+The :doc:`Javascript Library <../libraries/javascript>` has always had an
+'experimental' status and was never really useful, nor a proper solution.
+
+It is now deprecated and scheduled for removal in CodeIgniter 3.1+.
+
+.. note:: This library is still available, but you're strongly encouraged to remove its usage
+	sooner rather than later.
+
 ***********************************************************
 Step 18: Check your usage of Text helper highlight_phrase()
 ***********************************************************
diff --git a/user_guide_src/source/libraries/javascript.rst b/user_guide_src/source/libraries/javascript.rst
index bb901ead9..9d0237e57 100644
--- a/user_guide_src/source/libraries/javascript.rst
+++ b/user_guide_src/source/libraries/javascript.rst
@@ -2,8 +2,9 @@
 Javascript Class
 ################
 
-.. note:: This driver is experimental. Its feature set and
-	implementation may change in future releases.
+.. note:: This library is DEPRECATED and should not be used. It has always
+	been with an 'experimental' status and is now no longer supported.
+	Currently only kept for backwards compatibility.
 
 CodeIgniter provides a library to help you with certain common functions
 that you may want to use with Javascript. Please note that CodeIgniter
-- 
cgit v1.2.3-24-g4f1b


From fc1e2780b2e559b596d6a86257c62c030c6e3cc7 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Sun, 9 Feb 2014 17:36:24 +0200
Subject: [ci skip] Some adjustments to the old Encrypt library docs

---
 user_guide_src/source/libraries/encrypt.rst | 32 +++++++++++++++++------------
 1 file changed, 19 insertions(+), 13 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/encrypt.rst b/user_guide_src/source/libraries/encrypt.rst
index 567a1e990..faff39975 100644
--- a/user_guide_src/source/libraries/encrypt.rst
+++ b/user_guide_src/source/libraries/encrypt.rst
@@ -1,8 +1,8 @@
-################
-Encryption Class
-################
+#############
+Encrypt Class
+#############
 
-The Encryption Class provides two-way data encryption. It uses a scheme
+The Encrypt Class provides two-way data encryption. It uses a scheme
 that either compiles the message using a randomly hashed bitwise XOR
 encoding scheme, or is encrypted using the Mcrypt library. If Mcrypt is
 not available on your server the encoded message will still provide a
@@ -10,6 +10,10 @@ reasonable degree of security for encrypted sessions or other such
 "light" purposes. If Mcrypt is available, you'll be provided with a high
 degree of security appropriate for storage.
 
+.. important:: This library has been DEPRECATED and is only kept for
+	backwards compatibility. Please use the new :doc:`Encryption Library
+	<encryption>`.
+
 .. contents::
   :local:
 
@@ -17,9 +21,9 @@ degree of security appropriate for storage.
 
   <div class="custom-index container"></div>
 
-****************************
-Using the Encryption Library
-****************************
+*************************
+Using the Encrypt Library
+*************************
 
 Setting your Key
 ================
@@ -67,13 +71,15 @@ information.
 Initializing the Class
 ======================
 
-Like most other classes in CodeIgniter, the Encryption class is
-initialized in your controller using the **$this->load->library** function::
+Like most other classes in CodeIgniter, the Encrypt class is
+initialized in your controller using the ``$this->load->library()``
+method::
 
 	$this->load->library('encrypt');
 
-Once loaded, the Encrypt library object will be available using
-``$this->encrypt``
+Once loaded, the Encrypt library object will be available using::
+
+	$this->encrypt
 
 ***************
 Class Reference
@@ -163,7 +169,7 @@ Class Reference
 		:rtype:	string
 
 		Enables you to re-encode data that was originally encrypted with
-		CodeIgniter 1.x to be compatible with the Encryption library in
+		CodeIgniter 1.x to be compatible with the Encrypt library in
 		CodeIgniter 2.x. It is only necessary to use this method if you have
 		encrypted data stored permanently such as in a file or database and are
 		on a server that supports Mcrypt. "Light" use encryption such as
@@ -174,7 +180,7 @@ Class Reference
 		.. important::
 			**Why only a method to re-encode the data instead of maintaining legacy
 			methods for both encoding and decoding?** The algorithms in the
-			Encryption library have improved in CodeIgniter 2.x both for performance
+			Encrypt library have improved in CodeIgniter 2.x both for performance
 			and security, and we do not wish to encourage continued use of the older
 			methods. You can of course extend the Encryption library if you wish and
 			replace the new methods with the old and retain seamless compatibility
-- 
cgit v1.2.3-24-g4f1b


From 4b450651ed3b9413be0245401da706c218850f53 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Mon, 10 Feb 2014 06:59:54 +0200
Subject: CI_Encryption: Rename 'base64' parameter to 'raw_data' and add docs

---
 user_guide_src/source/libraries/encryption.rst | 555 +++++++++++++++++++++++++
 1 file changed, 555 insertions(+)
 create mode 100644 user_guide_src/source/libraries/encryption.rst

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/encryption.rst b/user_guide_src/source/libraries/encryption.rst
new file mode 100644
index 000000000..cedc8d381
--- /dev/null
+++ b/user_guide_src/source/libraries/encryption.rst
@@ -0,0 +1,555 @@
+##################
+Encryption Library
+##################
+
+The Encryption Library provides two-way data encryption. To do so in
+a cryptographically secure way, it utilizes PHP extensions that are
+unfortunately not always available on all systems.
+You must meet one of the following dependancies in order to use this
+library:
+
+- `OpenSSL <http://php.net/openssl>`_ (and PHP 5.3.3)
+- `MCrypt <http://php.net/mcrypt>`_ (and `MCRYPT_DEV_URANDOM` availability)
+
+If neither of the above dependancies is met, we simply cannot offer
+you a good enough implementation to meet the high standards required
+for proper cryptography.
+
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
+
+****************************
+Using the Encryption Library
+****************************
+
+Initializing the Class
+======================
+
+Like most other classes in CodeIgniter, the Encryption library is
+initialized in your controller using the ``$this->load->library()``
+method::
+
+	$this->load->library('encrypt');
+
+Once loaded, the Encryption library object will be available using::
+
+	$this->encrypt
+
+Default behavior
+================
+
+By default, the Encryption Library will use the AES-128 cipher in CBC
+mode, using your configured *encryption_key* and SHA512 HMAC authentication.
+
+.. note:: AES-128 is chosen both because it is proven to be strong and
+	because of its wide availability across different cryptographic
+	software and programming languages' APIs.
+
+However, the *encryption_key* is not used as is.
+
+If you are somewhat familiar with cryptography, you should already know
+that a HMAC also requires a secret key and using the same key for both
+encryption and authentication is a bad practice.
+
+Because of that, two separate keys are derived from your already configured
+*encryption_key*: one for encryption and one for authentication. This is
+done via a technique called `HMAC-based Key Derivation Function
+<http://en.wikipedia.org/wiki/HKDF>`_ (HKDF).
+
+Setting your encryption_key
+===========================
+
+An *encryption key* is a piece of information that controls the
+cryptographic process and permits a plain-text string to be encrypted,
+and afterwards - decrypted. It is the secret "ingredient" in the whole
+process that allows you to be the only one who is able to decrypt data
+that you've decided to hide from the eyes of the public.
+After one key is used to encrypt data, that same key provides the **only**
+means to decrypt it, so not only must you chose one carefully, but you
+must not lose it or you will also use the encrypted data.
+
+It must be noted that to ensure maximum security, such key *should* not
+only be as strong as possible, but also often changed. Such behavior
+however is rarely practical or possible to implement, and that is why
+CodeIgniter gives you the ability to configure a single key that is to be
+used (almost) every time.
+
+It goes without saying that you should guard your key carefully. Should
+someone gain access to your key, the data will be easily decrypted. If
+your server is not totally under your control it's impossible to ensure
+key security so you may want to think carefully before using it for
+anything that requires high security, like storing credit card numbers.
+
+Your encryption key should be as long as the encyption algorithm in use
+allows. For AES-128, that's 128 bits or 16 bytes (charcters) long. The
+key should be as random as possible and it should **not** be a simple
+text string.
+
+You will find a table below that shows the supported key lengths of
+different ciphers.
+
+The key can be either stored in your *application/config/config.php*, or
+you can design your own storage mechanism and pass the key dynamically
+when encrypting/decrypting.
+
+To save your key to your *application/config/config.php*, open the file
+and set::
+
+	$config['encryption_key'] = 'YOUR KEY';
+
+.. _ciphers-and-modes:
+
+Supported encryption ciphers and modes
+======================================
+
+.. note:: The terms 'cipher' and 'encryption algorithm' are interchangeable.
+
+Portable ciphers
+----------------
+
+Because MCrypt and OpenSSL (also called drivers throughout this document)
+each support different sets of encryption algorithms and often implement
+them in different ways, our Encryption library is designed to use them in
+a portable fashion, or in other words - it enables you to use them
+interchangeably, at least for the ciphers supported by both drivers.
+
+It is also implemented in a way that aims to match the standard
+implementations in other programming languages and libraries.
+
+Here's a list of the so called "portable" ciphers, where
+"CodeIgniter name" is the string value that you'd have to pass to the
+Encryption library to use that cipher:
+
+======================== ================== ============================ ===============================
+Cipher name              CodeIgniter name   Key lengths (bits / bytes)   Supported modes
+======================== ================== ============================ ===============================
+AES-128 / Rijndael-128   aes-128            128 / 16                     CBC, CTR, CFB, CFB8, OFB, ECB
+AES-192                  aes-192            192 / 24                     CBC, CTR, CFB, CFB8, OFB, ECB
+AES-256                  aes-256            256 / 32                     CBC, CTR, CFB, CFB8, OFB, ECB
+DES                      des                56 / 7                       CBC, CFB, CFB8, OFB, ECB
+TripleDES                tripledes          56 / 7, 112 / 14, 168 / 21   CBC, CFB, CFB8, OFB
+Blowfish                 blowfish           128-448 / 16-56              CBC, CFB, OFB, ECB
+CAST5 / CAST-128         cast5              40-128 / 5-16                CBC, CFB, OFB, ECB
+RC4 / ARCFour            rc4                40-2048 / 5-256              Stream
+======================== ================== ============================ ===============================
+
+.. important:: Because of how MCrypt works, if you fail to provide a key
+	with the appropriate length, you might end up using a different
+	algorithm than the one configured, so be really careful with that!
+
+.. note:: In case it isn't clear from the above table, Blowfish, CAST5
+	and RC4 support variable length keys. That is, any number in the
+	shown ranges is valid, although in bit terms that only happens
+	in 8-bit increments.
+
+.. note:: Even though CAST5 supports key lengths lower than 128 bits
+	(16 bytes), in fact they will just be zero-padded to the
+	maximum length, as specified in `RFC 2144
+	<http://tools.ietf.org/rfc/rfc2144.txt>`_.
+
+.. note:: Blowfish supports key lengths as small as 32 bits (4 bytes), but
+	our tests have shown that only lengths of 128 bits (16 bytes) or
+	higher are properly supported by both MCrypt and OpenSSL. It is
+	also a bad practice to use such low-length keys anyway.
+
+Driver-specific ciphers
+-----------------------
+
+As noted above, MCrypt and OpenSSL support different sets of encryption
+ciphers. For portability reasons and because we haven't tested them
+properly, we do not advise you to use the ones that are driver-specific,
+but regardless, here's a list of most of them:
+
+
+============== ========= ============================== =========================================
+Cipher name    Driver    Key lengths (bits / bytes)     Supported modes
+============== ========= ============================== =========================================
+AES-128        OpenSSL   128 / 16                       CBC, CTR, CFB, CFB8, OFB, ECB, GCM, XTS
+AES-192        OpenSSL   192 / 24                       CBC, CTR, CFB, CFB8, OFB, ECB, GCM, XTS
+AES-256        OpenSSL   256 / 32                       CBC, CTR, CFB, CFB8, OFB, ECB, GCM, XTS
+Rijndael-128   MCrypt    128 / 16, 192 / 24, 256 / 32   CBC, CTR, CFB, CFB8, OFB, OFB8, ECB
+Rijndael-192   MCrypt    128 / 16, 192 / 24, 256 / 32   CBC, CTR, CFB, CFB8, OFB, OFB8, ECB
+Rijndael-256   MCrypt    128 / 16, 192 / 24, 256 / 32   CBC, CTR, CFB, CFB8, OFB, OFB8, ECB
+GOST           MCrypt    256 / 32                       CBC, CTR, CFB, CFB8, OFB, OFB8, ECB
+Twofish        MCrypt    128 / 16, 192 / 24, 256 / 32   CBC, CTR, CFB, CFB8, OFB, OFB8, ECB
+CAST-256       MCrypt    128 / 16, 192 / 24, 256 / 32   CBC, CTR, CFB, CFB8, OFB, OFB8, ECB
+Loki97         MCrypt    128 / 16, 192 / 24, 256 / 32   CBC, CTR, CFB, CFB8, OFB, OFB8, ECB
+SaferPlus      MCrypt    128 / 16, 192 / 24, 256 / 32   CBC, CTR, CFB, CFB8, OFB, OFB8, ECB
+Serpent        MCrypt    128 / 16, 192 / 24, 256 / 32   CBC, CTR, CFB, CFB8, OFB, OFB8, ECB
+XTEA           MCrypt    128 / 16                       CBC, CTR, CFB, CFB8, OFB, OFB8, ECB
+RC2            MCrypt    8-1024 / 1-128                 CBC, CTR, CFB, CFB8, OFB, OFB8, ECB
+RC2            OpenSSL   8-1024 / 1-128                 CBC, CFB, OFB, ECB
+Camellia-128   OpenSSL   128 / 16                       CBC, CFB, CFB8, OFB, ECB
+Camellia-192   OpenSSL   192 / 24                       CBC, CFB, CFB8, OFB, ECB
+Camellia-256   OpenSSL   256 / 32                       CBC, CFB, CFB8, OFB, ECB
+Seed           OpenSSL   128 / 16                       CBC, CFB, OFB, ECB
+============== ========= ============================== =========================================
+
+.. note:: If you wish to use one of those ciphers, you'd have to pass
+	its name in lower-case to the Encryption library.
+
+.. note:: You've probably noticed that all AES cipers (and Rijndael-128)
+	are also listed in the portable ciphers list. This is because
+	drivers support different modes for these ciphers. Also, it is
+	important to note that AES-128 and Rijndael-128 are actually
+	the same cipher, but **only** when used with a 128-bit key.
+
+.. note:: RC2 is listed as supported by both MCrypt and OpenSSL.
+	However, both drivers implement them differently and they
+	are not portable. It is probably worth noting that we only
+	found one obscure source confirming that it is MCrypt that
+	is not properly implementing it.
+
+.. _encryption-modes:
+
+Encryption modes
+----------------
+
+Different modes of encryption have different characteristics and serve
+for different purposes. Some are stronger than others, some are faster
+and some offer extra features.
+We are not going in depth into that here, we'll leave that to the
+cryptography experts. The table below is to provide brief informational
+reference to our more experienced users. If you are a beginner, just
+stick to the CBC mode - it is widely accepted as strong and secure for
+general purposes.
+
+=========== ================== ================= ===================================================================================================================================================
+Mode name   CodeIgniter name   Driver support    Additional info
+=========== ================== ================= ===================================================================================================================================================
+CBC         cbc                MCrypt, OpenSSL   A safe default choice
+CTR         ctr                MCrypt, OpenSSL   Considered as theoretically better than CBC, but not as widely available
+CFB         cfb                MCrypt, OpenSSL   N/A
+CFB8        cfb8               MCrypt, OpenSSL   Same as CFB, but operates in 8-bit mode (not recommended).
+OFB         ofb                MCrypt, OpenSSL   N/A
+OFB8        ofb8               MCrypt            Same as OFB, but operates in 8-bit mode (not recommended).
+ECB         ecb                MCrypt, OpenSSL   Ignores IV (not recommended).
+GCM         gcm                OpenSSL           Provides authentication and therefore doesn't need a HMAC.
+XTS         xts                OpenSSL           Usually used for encrypting random access data such as RAM or hard-disk storage.
+Stream      stream             MCrypt, OpenSSL   This is not actually a mode, it just says that a stream cipher is being used. Required because of the general cipher+mode initialization process.
+=========== ================== ================= ===================================================================================================================================================
+
+Message Length
+==============
+
+It's probably important for you to know that an encrypted string is usually
+longer than the original, plain-text string (depending on the cipher).
+
+This is influenced by the cipher algorithm itself, the IV prepended to the
+cipher-text and (unless you are using GCM mode) the HMAC authentication
+message that is also prepended. Furthermore, the encrypted message is also
+Base64-encoded so that it is safe for storage and transmission, regardless
+of a possible character set in use.
+
+Keep this information in mind when selecting your data storage mechanism.
+Cookies, for example, can only hold 4K of information.
+
+.. _configuration:
+
+Configuring the library
+=======================
+
+For usability, performance, but also historical reasons tied to our old
+:doc:`Encrypt Class <encrypt>`, the Encryption library is designed to
+use repeatedly the same driver, encryption cipher, mode and key.
+
+As noted in the "Default behavior" section above, this means using an
+auto-detected driver (OpenSSL has a higher priority), the AES-128 ciper
+in CBC mode, and your ``$config['encryption_key']`` value.
+
+If you wish to change that however, you need to use the ``initialize()``
+method. It accepts an associative array of parameters, all of which are
+optional:
+
+======== ===============================================
+Option   Possible values
+======== ===============================================
+driver   'mcrypt', 'openssl'
+cipher   Cipher name (see :ref:`ciphers-and-modes`)
+mode     Encryption mode (see :ref:`encryption-modes`)
+key      Encryption key 
+======== ===============================================
+
+For example, if you were to change the encryption algorithm and
+mode to AES-256 in CTR mode, this is what you should do::
+
+	$this->encryption->initialize(
+		array(
+			'cipher' => 'aes-256',
+			'mode' => 'ctr',
+			'key' => '<a 32-character random string>'
+		)
+	);
+
+Note that we only mentioned that you want to change the ciper and mode,
+but we also included a key in the example. As previously noted, it is
+important that you choose a key with a proper size for the used algorithm.
+
+There's also the ability to change the driver, if for some reason you
+have both, but want to use MCrypt instead of OpenSSL::
+
+	// Switch to the MCrypt driver
+	$this->encryption->initialize(array('driver' => 'mcrypt'));
+
+	// Switch back to the OpenSSL driver
+	$this->encryption->initialize(array('driver' => 'openssl'));
+
+Encrypting and decrypting data
+==============================
+
+Encrypting and decrypting data with the already configured library
+settings is simple. As simple as just passing the string to the
+``encrypt()`` and/or ``decrypt()`` methods::
+
+	$plain_text = 'This is a plain-text message!';
+	$ciphertext = $this->encryption->encrypt($plain_text);
+
+	// Outputs: This is a plain-text message!
+	echo $this->encryption->decrypt($ciphertext);
+
+And that's it! The Encryption library will do everything necessary
+for the whole process to be cryptographically secure out-of-the-box.
+You don't need to worry about it.
+
+.. important:: Both methods will return FALSE in case of an error.
+	While for ``encrypt()`` this can only mean incorrect
+	configuration, you should always check the return value
+	of ``decrypt()`` in production code.
+
+How it works
+------------
+
+If you must know how the process works, here's what happens under
+the hood:
+
+- ``$this->encryption->encrypt($plain_text)``
+
+  #. Derive an encryption key and a HMAC key from your configured
+     *encryption_key* via HKDF, using the SHA-512 digest algorithm.
+
+  #. Generate a random initialization vector (IV).
+
+  #. Encrypt the data via AES-128 in CBC mode (or another previously
+     configured cipher and mode), using the above-mentioned derived
+     encryption key and IV.
+
+  #. Prepend said IV to the resulting cipher-text.
+
+  #. Base64-encode the resulting string, so that it can be safely
+     stored or transferred without worrying about character sets.
+
+  #. Create a SHA-512 HMAC authentication message using the derived
+     HMAC key to ensure data integrity and prepend it to the Base64
+     string.
+
+- ``$this->encryption->decrypt($ciphertext)``
+
+  #. Derive an encryption key and a HMAC key from your configured
+     *encryption_key* via HKDF, using the SHA-512 digest algorithm.
+     Because your configured *encryption_key* is the same, this
+     will produce the same result as in the ``encrypt()`` method
+     above - otherwise you won't be able to decrypt it.
+
+  #. Check if the string is long enough, separate the HMAC out of
+     it and validate if it is correct (this is done in a way that
+     prevents timing attacks agains it). Return FALSE if either of
+     the checks fails.
+
+  #. Base64-decode the string.
+
+  #. Separate the IV out of the cipher-text and decrypt the said
+     cipher-text using that IV and the derived encryption key.
+
+.. _custom-parameters:
+
+Using custom parameters
+-----------------------
+
+Let's say you have to interact with another system that is out
+of your control and uses another method to encrypt data. A
+method that will most certainly not match the above-described
+sequence and probably not use all of the steps either.
+
+The Encryption library allows you to change how its encryption
+and decryption processes work, so that you can easily tailor a
+custom solution for such situations.
+
+.. note:: It is possible to use the library in this way, without
+	setting an *encryption_key* in your configuration file.
+
+All you have to do is to pass an associative array with a few
+parameters to either the ``encrypt()`` or ``decrypt()`` method.
+Here's an example::
+
+	// Assume that we have $ciphertext, $key and $hmac_key
+	// from on outside source
+
+	$message = $this->encryption->decrypt(
+		$ciphertext,
+		array(
+			'cipher' => 'blowfish',
+			'mode' => 'cbc',
+			'key' => $key,
+			'hmac_digest' => 'sha256',
+			'hmac_key' => $hmac_key
+		)
+	);
+
+In the above example, we are decrypting a message that was encrypted
+using the Blowfish cipher in CBC mode and authenticated via a SHA-256
+HMAC.
+
+.. important:: Note that both 'key' and 'hmac_key' are used in this
+	example. When using custom parameters, encryption and HMAC keys
+	are not derived like the default behavior of the library is.
+
+Below is a list of the available options.
+
+However, unless you really need to and you know what you are doing,
+we advise you to not change the encryption process as this could
+impact security, so please do so with caution.
+
+============= =============== ============================= ======================================================
+Option        Default value   Mandatory / Optional          Description
+============= =============== ============================= ======================================================
+cipher        N/A             Yes                           Encryption algorithm (see :ref:`ciphers-and-modes`).
+mode          N/A             Yes                           Encryption mode (see :ref:`encryption-modes`).
+key           N/A             Yes                           Encryption key.
+iv            N/A             No                            Initialization vector (IV).
+                                                            If not provided it will be automatically generated
+                                                            during encryption and looked for during decryption.
+hmac          TRUE            No                            Whether to use a HMAC.
+                                                            Boolean. If set to FALSE, then *hmac_digest* and
+                                                            *hmac_key* will be ignored.
+hmac_digest   sha512          No                            HMAC message digest algorithm (see :ref:`digests`).
+hmac_key      N/A             Yes, unless *hmac* is FALSE   HMAC key.
+raw_data      FALSE           No                            Whether the cipher-text should be raw.
+                                                            Boolean. If set to TRUE, then Base64 encoding and
+                                                            decoding will not be performed and HMAC will not
+                                                            be a hexadecimal string.
+============= =============== ============================= ======================================================
+
+.. important:: ``encrypt()`` and ``decrypt()`` will return FALSE if
+	a mandatory parameter is not provided or if a provided
+	value is incorrect. This includes *hmac_key*, unless *hmac*
+	is set to FALSE.
+
+.. note:: If GCM mode is used, *hmac* will always be FALSE. This is
+	because GCM mode itself provides authentication.
+
+.. _digests:
+
+Supported HMAC authentication algorithms
+----------------------------------------
+
+For HMAC message authentication, the Encryption library supports
+usage of the SHA-2 family of algorithms:
+
+=========== ==================== ============================
+Algorithm   Raw length (bytes)   Hex-encoded length (bytes)
+=========== ==================== ============================
+sha512      64                   128
+sha384      48                   96
+sha256      32                   64
+sha224      28                   56
+=========== ==================== ============================
+
+The reason for not including other popular algorithms, such as
+MD5 or SHA1 is that they are no longer considered secure enough
+and as such, we don't want to encourage their usage.
+If you absolutely need to use them, it is easy to do so via PHP's
+native `hash_hmac() <http://php.net/hash_hmac()>`_ function.
+
+Stronger algorithms of course will be added in the future as they
+appear and become widely available.
+
+***************
+Class Reference
+***************
+
+.. class:: CI_Encryption
+
+	.. method:: initialize($params)
+
+		:param	array	$params: Configuration parameters
+		:returns:	CI_Encryption instance (method chaining)
+		:rtype:	CI_Encryption
+
+		Initializes (configures) the library to use a different
+		driver, cipher, mode or key.
+
+		Example::
+
+			$this->encryption->initialize(
+				array('mode' => 'ctr')
+			);
+
+		Please refer to the :ref:`configuration` section for detailed info.
+
+	.. method:: encrypt($data[, $params = NULL])
+
+		:param	string	$data: Data to encrypt
+		:param	array	$params: Optional parameters
+		:returns:	Encrypted data or FALSE on failure
+		:rtype:	string
+
+		Encrypts the input data and returns its ciphertext.
+
+		Example::
+
+			$ciphertext = $this->encryption->encrypt('My secret message');
+
+		Please refer to the :ref:`custom-parameters` section for information
+		on the optional parameters.
+
+	.. method:: decrypt($data[, $params = NULL])
+
+		:param	string	$data: Data to decrypt
+		:param	array	$params: Optional parameters
+		:returns:	Decrypted data or FALSE on failure
+		:rtype:	string
+
+		Decrypts the input data and returns it in plain-text.
+
+		Example::
+
+			echo $this->encryption->decrypt($ciphertext);
+
+		Please refer to the :ref:`custom-parameters` secrion for information
+		on the optional parameters.
+
+	.. method:: hkdf($key[, $digest = 'sha512'[, $salt = NULL[, $length = NULL[, $info = '']]]])
+
+		:param	string	$key: Input key material
+		:param	string	$digest: A SHA-2 family digest algorithm
+		:param	string	$salt: Optional salt
+		:param	int	$length: Optional output length
+		:param	string	$info: Optional context/application-specific info
+		:returns:	A pseudo-random key or FALSE on failure
+
+		Derives a key from another, presumably weaker key.
+
+		This method is used internally to derive an encryption and HMAC key
+		from your configured *encryption_key*.
+
+		It is publicly available due to its otherwise general purpose. It is
+		described in `RFC 5869 <https://tools.ietf.org/rfc/rfc5869.txt>`_.
+
+		However, as opposed to the description in RFC 5869, this implementation
+		doesn't support SHA1.
+
+		Example::
+
+			$hmac_key = $this->encryption->hkdf(
+				$key,
+				'sha512',
+				NULL,
+				NULL,
+				'authentication'
+			);
+
+			// $hmac_key is a pseudo-random key with a length of 64 bytes
\ No newline at end of file
-- 
cgit v1.2.3-24-g4f1b


From e52fc267a93fd3627951ddc7c5109b573a871727 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Tue, 11 Feb 2014 13:27:01 +0200
Subject: Fix issue #43

---
 user_guide_src/source/changelog.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 1e43ab23c..e08b7fee0 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -693,6 +693,7 @@ Bug fixes for 3.0
 -  Fixed a bug (#2771) - :doc:`Security Library <libraries/security>` method ``xss_clean()`` didn't take into account HTML5 entities.
 -  Fixed a bug in the :doc:`Session Library <libraries/sessions>` 'cookie' driver where authentication was not performed for encrypted cookies.
 -  Fixed a bug (#2856) - ODBC method ``affected_rows()`` passed an incorrect value to ``odbc_num_rows()``.
+-  Fixed a bug (#43) :doc:`Image Manipulation Library <libraries/image_lib>` method ``text_watermark()`` didn't properly determine watermark placement.
 
 Version 2.1.4
 =============
-- 
cgit v1.2.3-24-g4f1b


From 05983fcb5b8f04fb895c025e28ef6ffc44a5f602 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Tue, 11 Feb 2014 16:51:43 +0200
Subject: A bug fix and optimizations in CI_Table

---
 user_guide_src/source/changelog.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index e08b7fee0..9e63a6885 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -694,6 +694,7 @@ Bug fixes for 3.0
 -  Fixed a bug in the :doc:`Session Library <libraries/sessions>` 'cookie' driver where authentication was not performed for encrypted cookies.
 -  Fixed a bug (#2856) - ODBC method ``affected_rows()`` passed an incorrect value to ``odbc_num_rows()``.
 -  Fixed a bug (#43) :doc:`Image Manipulation Library <libraries/image_lib>` method ``text_watermark()`` didn't properly determine watermark placement.
+-  Fixed a bug where :doc:`HTML Table Library <libraries/table>` ignored its *auto_heading* setting if headings were not already set.
 
 Version 2.1.4
 =============
-- 
cgit v1.2.3-24-g4f1b


From a49c8adbc24d904b3473cc301f0f56818acdddcb Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Tue, 11 Feb 2014 17:15:07 +0200
Subject: Change CI_Table:: to NULL

Because semantics
---
 user_guide_src/source/libraries/table.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/table.rst b/user_guide_src/source/libraries/table.rst
index 6e011083e..9d95eddfc 100644
--- a/user_guide_src/source/libraries/table.rst
+++ b/user_guide_src/source/libraries/table.rst
@@ -139,7 +139,7 @@ Class Reference
 
 .. class:: CI_Table
 
-	.. attribute:: $function = FALSE
+	.. attribute:: $function = NULL
 
 		Allows you to specify a native PHP function or a valid function array object to be applied to all cell data.
 		::
-- 
cgit v1.2.3-24-g4f1b


From 871754af60251993d640981e107d2def5f2db396 Mon Sep 17 00:00:00 2001
From: darwinel <kmorssink@gmail.com>
Date: Tue, 11 Feb 2014 17:34:57 +0100
Subject: 2013 > 2014

Update copyright notices from 2013 to 2014.
And update one calendar example in user_guide from year 2013/2014 to
2014/2015.
---
 user_guide_src/source/_themes/eldocs/static/asset/css/common.css | 2 +-
 user_guide_src/source/conf.py                                    | 4 ++--
 user_guide_src/source/libraries/calendar.rst                     | 4 ++--
 user_guide_src/source/tutorial/static_pages.rst                  | 2 +-
 4 files changed, 6 insertions(+), 6 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/_themes/eldocs/static/asset/css/common.css b/user_guide_src/source/_themes/eldocs/static/asset/css/common.css
index 962380b50..f0ce8c80c 100644
--- a/user_guide_src/source/_themes/eldocs/static/asset/css/common.css
+++ b/user_guide_src/source/_themes/eldocs/static/asset/css/common.css
@@ -16,7 +16,7 @@ If you did not receive a copy of the license and are unable to obtain it
 through the world wide web, please send an email to
 licensing@ellislab.com so we can send you a copy immediately.
 
-Copyright (c) 2008 - 2013, EllisLab, Inc. (http://ellislab.com/)
+Copyright (c) 2008 - 2014, EllisLab, Inc. (http://ellislab.com/)
 http://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
 */
 
diff --git a/user_guide_src/source/conf.py b/user_guide_src/source/conf.py
index 6d77db060..3f9b2e476 100644
--- a/user_guide_src/source/conf.py
+++ b/user_guide_src/source/conf.py
@@ -41,7 +41,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'CodeIgniter'
-copyright = u'2013, EllisLab, Inc.'
+copyright = u'2014, EllisLab, Inc.'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -224,7 +224,7 @@ man_pages = [
 epub_title = u'CodeIgniter'
 epub_author = u'EllisLab, Inc.'
 epub_publisher = u'EllisLab, Inc.'
-epub_copyright = u'2013, EllisLab, Inc.'
+epub_copyright = u'2014, EllisLab, Inc.'
 
 # The language of the text. It defaults to the language option
 # or en if the language is not set.
diff --git a/user_guide_src/source/libraries/calendar.rst b/user_guide_src/source/libraries/calendar.rst
index 65a447a3d..2263aa404 100644
--- a/user_guide_src/source/libraries/calendar.rst
+++ b/user_guide_src/source/libraries/calendar.rst
@@ -248,14 +248,14 @@ Class Reference
 		you submit 13 as the month, the year will increment and the month will
 		become January::
 
-			print_r($this->calendar->adjust_date(13, 2013));
+			print_r($this->calendar->adjust_date(13, 2014));
 
 		outputs::
 
 			Array
 			(    
 				[month] => '01'
-				[year] => '2014'
+				[year] => '2015'
 			)
 
 	.. method:: get_total_days($month, $year)
diff --git a/user_guide_src/source/tutorial/static_pages.rst b/user_guide_src/source/tutorial/static_pages.rst
index 330a50ecf..36bcd2df9 100644
--- a/user_guide_src/source/tutorial/static_pages.rst
+++ b/user_guide_src/source/tutorial/static_pages.rst
@@ -72,7 +72,7 @@ includes the following code:
 
 ::
 
-            <em>&copy; 2013</em>
+            <em>&copy; 2014</em>
         </body>
     <html>
 
-- 
cgit v1.2.3-24-g4f1b


From 25f119cef588a01651cec7c59d3b03924b2dd81c Mon Sep 17 00:00:00 2001
From: darwinel <kmorssink@gmail.com>
Date: Tue, 11 Feb 2014 18:29:58 +0100
Subject: Writing style fix based on style guide
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

„Use of || is discouraged as its clarity on some output devices is low
(looking like the number 11 for instance). && is preferred over AND but
either are acceptable, and a space should always precede and follow !.”
---
 user_guide_src/source/libraries/xmlrpc.rst | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/xmlrpc.rst b/user_guide_src/source/libraries/xmlrpc.rst
index 2cf548750..115b4e680 100644
--- a/user_guide_src/source/libraries/xmlrpc.rst
+++ b/user_guide_src/source/libraries/xmlrpc.rst
@@ -223,17 +223,17 @@ email address, etc.). Here is how the processing function might look::
 
 	        $parameters = $request->output_parameters();
 
-	        if ($parameters['1'] != $username AND $parameters['2'] != $password)
+	        if ($parameters['1'] != $username && $parameters['2'] != $password)
 	        {
 	            return $this->xmlrpc->send_error_message('100', 'Invalid Access');
 	        }
 
-	        $response = array(array('nickname'  => array('Smitty','string'),
-	                                'userid'    => array('99','string'),
-	                                'url'       => array('http://yoursite.com','string'),
-	                                'email'     => array('jsmith@yoursite.com','string'),
-	                                'lastname'  => array('Smith','string'),
-	                                'firstname' => array('John','string')
+	        $response = array(array('nickname'  => array('Smitty', 'string'),
+	                                'userid'    => array('99', 'string'),
+	                                'url'       => array('http://yoursite.com', 'string'),
+	                                'email'     => array('jsmith@yoursite.com', 'string'),
+	                                'lastname'  => array('Smith', 'string'),
+	                                'firstname' => array('John', 'string')
 	                                ),
 	                         'struct');
 
-- 
cgit v1.2.3-24-g4f1b


From d8bef8a878238c6974f01758469af1c13ac8b8d7 Mon Sep 17 00:00:00 2001
From: darwinel <kmorssink@gmail.com>
Date: Tue, 11 Feb 2014 20:13:22 +0100
Subject: "BASEPATH check" consistency
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

As described in issue #2870

+ A change in the „How to create a library” example in the user_guide
---
 user_guide_src/source/general/creating_libraries.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/general/creating_libraries.rst b/user_guide_src/source/general/creating_libraries.rst
index 4beb600da..a1e1b3e78 100644
--- a/user_guide_src/source/general/creating_libraries.rst
+++ b/user_guide_src/source/general/creating_libraries.rst
@@ -44,7 +44,8 @@ The Class File
 
 Classes should have this basic prototype::
 
-	<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed'); 
+	<?php
+	defined('BASEPATH') OR exit('No direct script access allowed'); 
 
 	class Someclass {
 
-- 
cgit v1.2.3-24-g4f1b


From 053d5d6e8dff0f1af9c33330960a1085628b3930 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Tue, 11 Feb 2014 21:45:39 +0200
Subject: [ci skip] Update the XML-RPC lib docs

---
 user_guide_src/source/libraries/xmlrpc.rst | 131 +++++++++++++++--------------
 1 file changed, 66 insertions(+), 65 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/xmlrpc.rst b/user_guide_src/source/libraries/xmlrpc.rst
index 115b4e680..c2e9a1113 100644
--- a/user_guide_src/source/libraries/xmlrpc.rst
+++ b/user_guide_src/source/libraries/xmlrpc.rst
@@ -123,12 +123,12 @@ If you use data types other than strings, or if you have several
 different data types, you will place each parameter into its own array,
 with the data type in the second position::
 
-	$request = array (
-	                   array('John', 'string'),
-	                   array('Doe', 'string'),
-	                   array(FALSE, 'boolean'),
-	                   array(12345, 'int')
-	                 ); 
+	$request = array(
+		array('John', 'string'),
+		array('Doe', 'string'),
+		array(FALSE, 'boolean'),
+		array(12345, 'int')
+	); 
 	$this->xmlrpc->request($request);
 
 The `Data Types <#datatypes>`_ section below has a full list of data
@@ -171,7 +171,7 @@ not part of the CodeIgniter super object.
 In other words, if an XML-RPC Client sends a request for the new_post
 method, your server will load the My_blog class and call the new_entry
 function. If the request is for the update_post method, your server
-will load the My_blog class and call the update_entry function.
+will load the My_blog class and call the ``update_entry()`` method.
 
 The function names in the above example are arbitrary. You'll decide
 what they should be called on your server, or if you are using
@@ -181,7 +181,7 @@ function names.
 There are two additional configuration keys you may make use of when
 initializing the server class: debug can be set to TRUE in order to
 enable debugging, and xss_clean may be set to FALSE to prevent sending
-data through the Security library's xss_clean function.
+data through the Security library's ``xss_clean()`` method.
 
 Processing Server Requests
 ==========================
@@ -207,49 +207,52 @@ have access to the *request parameters* enabling you to process the
 request. When you are done you will send a Response back to the Client.
 
 Below is a real-world example, using the Blogger API. One of the methods
-in the Blogger API is getUserInfo(). Using this method, an XML-RPC
+in the Blogger API is ``getUserInfo()``. Using this method, an XML-RPC
 Client can send the Server a username and password, in return the Server
 sends back information about that particular user (nickname, user ID,
 email address, etc.). Here is how the processing function might look::
 
 	class My_blog extends CI_Controller {
 
-	    function getUserInfo($request)
-	    {
-	        $username = 'smitty';
-	        $password = 'secretsmittypass';
+		public function getUserInfo($request)
+		{
+			$username = 'smitty';
+			$password = 'secretsmittypass';
 
-	        $this->load->library('xmlrpc');
+			$this->load->library('xmlrpc');
 
-	        $parameters = $request->output_parameters();
+			$parameters = $request->output_parameters();
 
-	        if ($parameters['1'] != $username && $parameters['2'] != $password)
-	        {
-	            return $this->xmlrpc->send_error_message('100', 'Invalid Access');
-	        }
+			if ($parameters[1] != $username && $parameters[2] != $password)
+			{
+				return $this->xmlrpc->send_error_message('100', 'Invalid Access');
+			}
 
-	        $response = array(array('nickname'  => array('Smitty', 'string'),
-	                                'userid'    => array('99', 'string'),
-	                                'url'       => array('http://yoursite.com', 'string'),
-	                                'email'     => array('jsmith@yoursite.com', 'string'),
-	                                'lastname'  => array('Smith', 'string'),
-	                                'firstname' => array('John', 'string')
-	                                ),
-	                         'struct');
+			$response = array(
+				array(
+					'nickname'  => array('Smitty', 'string'),
+					'userid'    => array('99', 'string'),
+					'url'       => array('http://yoursite.com', 'string'),
+					'email'     => array('jsmith@yoursite.com', 'string'),
+					'lastname'  => array('Smith', 'string'),
+					'firstname' => array('John', 'string')
+				),
+	                         'struct'
+			);
 
-	        return $this->xmlrpc->send_response($response);
-	    }
+			return $this->xmlrpc->send_response($response);
+		}
 	}
 
 Notes:
 ------
 
-The output_parameters() function retrieves an indexed array
+The ``output_parameters()`` method retrieves an indexed array
 corresponding to the request parameters sent by the client. In the above
 example, the output parameters will be the username and password.
 
 If the username and password sent by the client were not valid, and
-error message is returned using send_error_message().
+error message is returned using ``send_error_message()``.
 
 If the operation was successful, the client will be sent back a response
 array containing the user's info.
@@ -263,22 +266,22 @@ single item**. This item can be an array with several additional arrays,
 but there can be only one primary array index. In other words, the basic
 prototype is this::
 
-	$response = array('Response data',  'array');
+	$response = array('Response data', 'array');
 
 Responses, however, usually contain multiple pieces of information. In
 order to accomplish this we must put the response into its own array so
 that the primary array continues to contain a single piece of data.
 Here's an example showing how this might be accomplished::
 
-	$response = array (
-	                   array(
-	                         'first_name' => array('John', 'string'),
-	                         'last_name' => array('Doe', 'string'),
-	                         'member_id' => array(123435, 'int'),
-	                         'todo_list' => array(array('clean house', 'call mom', 'water plants'), 'array'),
-	                        ),
-	                 'struct'
-	                 );
+	$response = array(
+		array(
+			'first_name' => array('John', 'string'),
+			'last_name' => array('Doe', 'string'),
+			'member_id' => array(123435, 'int'),
+			'todo_list' => array(array('clean house', 'call mom', 'water plants'), 'array'),
+		),
+		'struct'
+	);
 
 Notice that the above array is formatted as a struct. This is the most
 common data type for responses.
@@ -373,17 +376,16 @@ folder::
 			$parameters = $request->output_parameters();
 
 			$response = array(
-						array(
-							'you_said'  => $parameters[0],
-							'i_respond' => 'Not bad at all.'
-						),
-						'struct'
-					);
+				array(
+					'you_said'  => $parameters[0],
+					'i_respond' => 'Not bad at all.'
+				),
+				'struct'
+			);
 
 			return $this->xmlrpc->send_response($response);
 		}
 	}
-	?>
 
 
 Try it!
@@ -398,7 +400,7 @@ back to you.
 
 The client you created sends a message ("How's is going?") to the
 server, along with a request for the "Greetings" method. The Server
-receives the request and maps it to the "process" function, where a
+receives the request and maps it to the ``process()`` method, where a
 response is sent back.
 
 Using Associative Arrays In a Request Parameter
@@ -408,22 +410,21 @@ If you wish to use an associative array in your method parameters you
 will need to use a struct datatype::
 
 	$request = array(
-	                 array(
-	                       // Param 0
-	                       array(
-	                             'name'=>'John'
-	                            	),
-	                             'struct'
-	                       ),
-	                       array(
-	                             // Param 1
-	                             array(
-	                                  	'size'=>'large',
-	                                   'shape'=>'round'
-	                                  	),
-	                             'struct'
-	                       )
-	                 );
+		array(
+			// Param 0
+			array('name' => 'John'),
+			'struct'
+		),
+		array(
+			// Param 1
+			array(
+				'size' => 'large',
+				'shape'=>'round'
+			),
+			'struct'
+		)
+	);
+
 	$this->xmlrpc->request($request);
 
 You can retrieve the associative array when processing the request in
-- 
cgit v1.2.3-24-g4f1b


From be1496d1a8618ef186047468009c7e3e0640183b Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Tue, 11 Feb 2014 22:48:45 +0200
Subject: Utf8/iconv/mbstring-related changes

---
 user_guide_src/source/changelog.rst              | 7 +++++++
 user_guide_src/source/general/reserved_names.rst | 3 +++
 2 files changed, 10 insertions(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 9e63a6885..b5b31dcc2 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -396,6 +396,7 @@ Release Date: Not Released
       - Added support for setting table class defaults in a config file.
 
    -  :doc:`Zip Library <libraries/zip>` method ``read_file()`` can now also alter the original file path/name while adding files to an archive.
+   -  :doc:`Trackback Library <libraries/trackback>` method ``receive()`` will now utilize ``iconv()`` if it is available but ``mb_convert_encoding()`` is not.
 
 -  Core
 
@@ -489,9 +490,15 @@ Release Date: Not Released
       -  Language files are now loaded in a cascading style with the one in **system/** always loaded and overriden afterwards, if another one is found.
 
    -  :doc:`Hooks Library <general/hooks>` changes include:
+
       -  Renamed method ``_call_hook()`` to ``call_hook()``.
       -  Class instances are now stored in order to maintain their state.
 
+   -  UTF-8 Library changes include:
+
+      -  ``UTF8_ENABLED`` now requires only one of `Multibyte String <http://php.net/mbstring>`_ or `iconv <http://php.net/iconv>`_ to be available instead of both.
+      -  Changed method ``clean_string()`` to utilize ``mb_convert_encoding()`` if it is available but ``iconv()`` is not.
+
    -  Removed ``CI_CORE`` boolean constant from *CodeIgniter.php* (no longer Reactor and Core versions).
    -  Log Library will now try to create the **log_path** directory if it doesn't exist.
    -  Added support for HTTP-Only cookies with new config option *cookie_httponly* (default FALSE).
diff --git a/user_guide_src/source/general/reserved_names.rst b/user_guide_src/source/general/reserved_names.rst
index a767651fb..81a05ace6 100644
--- a/user_guide_src/source/general/reserved_names.rst
+++ b/user_guide_src/source/general/reserved_names.rst
@@ -61,6 +61,9 @@ Constants
 -  APPPATH
 -  VIEWPATH
 -  CI_VERSION
+-  MB_ENABLED
+-  ICONV_ENABLED
+-  UTF8_ENABLED
 -  FILE_READ_MODE
 -  FILE_WRITE_MODE
 -  DIR_READ_MODE
-- 
cgit v1.2.3-24-g4f1b


From 7d16de620a46f84ffeb52a54ae82439a06f89c74 Mon Sep 17 00:00:00 2001
From: Ahmad Anbar <aanbar@gmail.com>
Date: Thu, 13 Feb 2014 01:45:27 +0200
Subject: Fixed code style & added few extra checks. Updated cart
 documentation.

---
 user_guide_src/source/libraries/cart.rst | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/cart.rst b/user_guide_src/source/libraries/cart.rst
index fb92c280a..015f1c90e 100644
--- a/user_guide_src/source/libraries/cart.rst
+++ b/user_guide_src/source/libraries/cart.rst
@@ -194,7 +194,9 @@ Updating The Cart
 
 To update the information in your cart, you must pass an array
 containing the Row ID and quantity to the $this->cart->update()
-function:
+function, you may also update any property you have previously 
+defined when inserting the item such like (options, price 
+or other custom fields you defined).
 
 .. note:: If the quantity is set to zero, the item will be removed from
 	the cart.
@@ -289,10 +291,10 @@ Class Reference
 		:returns:	TRUE on success, FALSE on failure
 		:rtype:	bool
 
-		This method permits the quantity of a given item to be changed.
+		This method permits changing the properties of a given item.
 		Typically it is called from the "view cart" page if a user makes changes
-		to the quantity before checkout. That array must contain the product ID
-		and quantity for each item.
+		to the quantity before checkout. That array must contain the rowid
+		and qty for each item.
 
 	.. method:: remove($rowid)
 
-- 
cgit v1.2.3-24-g4f1b


From 3fd1b384273b7b6d56950bbad3e1fac18f5f82e4 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Thu, 13 Feb 2014 03:01:31 +0200
Subject: Introducing compatibility layers

 - Limited support for mbstring (mb_strlen(), mb_strpos(), mb_substr() only) via iconv.
   Falls back to regular strlen(), strpos(), substr() if iconv is not available.
 - Password hashing, dependant on CRYPT_BLOWFISH (2y version, available since PHP 5.3.7) availability.
---
 user_guide_src/source/changelog.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index b5b31dcc2..ce84b7f54 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -499,6 +499,7 @@ Release Date: Not Released
       -  ``UTF8_ENABLED`` now requires only one of `Multibyte String <http://php.net/mbstring>`_ or `iconv <http://php.net/iconv>`_ to be available instead of both.
       -  Changed method ``clean_string()`` to utilize ``mb_convert_encoding()`` if it is available but ``iconv()`` is not.
 
+   -  Added compatibility layers for PHP's `Multibyte string <http://php.net/mbstring>`_ (limited support) and `Password Hashing <http://php.net/password>` extensions.
    -  Removed ``CI_CORE`` boolean constant from *CodeIgniter.php* (no longer Reactor and Core versions).
    -  Log Library will now try to create the **log_path** directory if it doesn't exist.
    -  Added support for HTTP-Only cookies with new config option *cookie_httponly* (default FALSE).
-- 
cgit v1.2.3-24-g4f1b


From 6ce4746474ddf050f7f4df61b7a22b7f5854d533 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Thu, 13 Feb 2014 03:28:00 +0200
Subject: Update Text and Inflector helpers to utilize mbstring, if available

Text: word_wrap(), ellipsize()
Inflector: humanize(), underscore() (rel #2855)
---
 user_guide_src/source/changelog.rst | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index ce84b7f54..16c30b795 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -90,7 +90,8 @@ Release Date: Not Released
    -  :doc:`Inflector Helper <helpers/inflector_helper>` changes include:
 
       - Changed :func:`humanize()` to allow passing an input separator as its second parameter.
-      - Refactored :func:`plural()` and :func:`singular()` to avoid double pluralization and support more words.
+      - Changed :func:`humanize()` and :func:`underscore()` to utilize `mbstring <http://php.net/mbstring>`_, if available.
+      - Changed :func:`plural()` and :func:`singular()` to avoid double pluralization and support more words.
 
    -  :doc:`Download Helper <helpers/download_helper>` changes include:
 
@@ -132,10 +133,14 @@ Release Date: Not Released
       - Added *colors* configuration to allow customization for the *background*, *border*, *text* and *grid* colors.
       - Added *filename* to the returned array elements.
 
+   -  :doc:`Text Helper <helpers/text_helper>` changes include:
+
+      - Changed the default tag for use in :func:`highlight_phrase()` to ``<mark>`` (formerly ``<strong>``).
+      - Changed :func:`character_limiter()`, :func:`word_wrap()` and :func:`ellipsize()` to utilize `mbstring <http://php.net/mbstring>`_ or `iconv <http://php.net/iconv>`_, if available.
+
    -  :doc:`Directory Helper <helpers/directory_helper>` :func:`directory_map()` will now append ``DIRECTORY_SEPARATOR`` to directory names in the returned array.
    -  :doc:`Array Helper <helpers/array_helper>` :func:`element()` and :func:`elements()` now return NULL instead of FALSE when the required elements don't exist.
    -  :doc:`Language Helper <helpers/language_helper>` :func:`lang()` now accepts an optional list of additional HTML attributes.
-   -  Changed the default tag for use in :doc:`Text Helper <helpers/text_helper>` :func:`highlight_phrase()` to ``<mark>`` (formerly ``<strong>``).
    -  Deprecated the :doc:`Email Helper <helpers/email_helper>` as its ``valid_email()``, ``send_email()`` functions are now only aliases for PHP native functions ``filter_var()`` and ``mail()`` respectively.
 
 -  Database
@@ -499,7 +504,7 @@ Release Date: Not Released
       -  ``UTF8_ENABLED`` now requires only one of `Multibyte String <http://php.net/mbstring>`_ or `iconv <http://php.net/iconv>`_ to be available instead of both.
       -  Changed method ``clean_string()`` to utilize ``mb_convert_encoding()`` if it is available but ``iconv()`` is not.
 
-   -  Added compatibility layers for PHP's `Multibyte string <http://php.net/mbstring>`_ (limited support) and `Password Hashing <http://php.net/password>` extensions.
+   -  Added compatibility layers for PHP's `mbstring <http://php.net/mbstring>`_ (limited support) and `password <http://php.net/password>`_ extensions.
    -  Removed ``CI_CORE`` boolean constant from *CodeIgniter.php* (no longer Reactor and Core versions).
    -  Log Library will now try to create the **log_path** directory if it doesn't exist.
    -  Added support for HTTP-Only cookies with new config option *cookie_httponly* (default FALSE).
-- 
cgit v1.2.3-24-g4f1b


From 576439fda03d4e81cb5b0cfed371f7776a73fe3a Mon Sep 17 00:00:00 2001
From: Ahmad Anbar <aanbar@gmail.com>
Date: Thu, 13 Feb 2014 06:16:31 +0200
Subject: Added changelog entry. An example to the docs. Tidy code a little
 bit.

---
 user_guide_src/source/changelog.rst      |  1 +
 user_guide_src/source/libraries/cart.rst | 17 +++++++++++++++--
 2 files changed, 16 insertions(+), 2 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index b5b31dcc2..76ee7ed31 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -303,6 +303,7 @@ Release Date: Not Released
       -  Added method ``remove()`` to remove a cart item, updating with quantity of 0 seemed like a hack but has remained to retain compatibility.
       -  Added method ``get_item()`` to enable retrieving data for a single cart item.
       -  Added unicode support for product names.
+      -	 ``update()`` now supports updating all properties attached to an item.
 
    -  :doc:`Image Manipulation Library <libraries/image_lib>` changes include:
 
diff --git a/user_guide_src/source/libraries/cart.rst b/user_guide_src/source/libraries/cart.rst
index 015f1c90e..6d0dd2e3a 100644
--- a/user_guide_src/source/libraries/cart.rst
+++ b/user_guide_src/source/libraries/cart.rst
@@ -88,6 +88,18 @@ array will be stored in the session. However, it is best to standardize
 your data among all your products in order to make displaying the
 information in a table easier.
 
+::
+
+	$data = array(
+	               'id'      => 'sku_123ABC',
+	               'qty'     => 1,
+	               'price'   => 39.95,
+	               'name'    => 'T-Shirt',
+	               'coupon'	 => 'XMAS-50OFF'
+	            );
+
+	$this->cart->insert($data);
+
 The insert() method will return the $rowid if you successfully insert a
 single item.
 
@@ -195,8 +207,8 @@ Updating The Cart
 To update the information in your cart, you must pass an array
 containing the Row ID and quantity to the $this->cart->update()
 function, you may also update any property you have previously 
-defined when inserting the item such like (options, price 
-or other custom fields you defined).
+defined when inserting the item such as options, price 
+or other custom fields you defined.
 
 .. note:: If the quantity is set to zero, the item will be removed from
 	the cart.
@@ -205,6 +217,7 @@ or other custom fields you defined).
 
 	$data = array(
 	               'rowid' => 'b99ccdf16028f015540f341130b6d8ec',
+	               'price' => 10,
 	               'qty'   => 3
 	            );
 
-- 
cgit v1.2.3-24-g4f1b


From da2bdf2b95a55f03aadfb6a1d21a90a0fff627db Mon Sep 17 00:00:00 2001
From: Ahmad Anbar <aanbar@gmail.com>
Date: Thu, 13 Feb 2014 12:59:18 +0200
Subject: Re-arranged documentation, fixed comment.

---
 user_guide_src/source/libraries/cart.rst | 19 +++++++++++++++----
 1 file changed, 15 insertions(+), 4 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/cart.rst b/user_guide_src/source/libraries/cart.rst
index 6d0dd2e3a..a0870e34a 100644
--- a/user_guide_src/source/libraries/cart.rst
+++ b/user_guide_src/source/libraries/cart.rst
@@ -206,9 +206,7 @@ Updating The Cart
 
 To update the information in your cart, you must pass an array
 containing the Row ID and quantity to the $this->cart->update()
-function, you may also update any property you have previously 
-defined when inserting the item such as options, price 
-or other custom fields you defined.
+function.
 
 .. note:: If the quantity is set to zero, the item will be removed from
 	the cart.
@@ -217,7 +215,6 @@ or other custom fields you defined.
 
 	$data = array(
 	               'rowid' => 'b99ccdf16028f015540f341130b6d8ec',
-	               'price' => 10,
 	               'qty'   => 3
 	            );
 
@@ -242,6 +239,20 @@ or other custom fields you defined.
 
 	$this->cart->update($data);
 
+You may also update any property you have previously 
+defined when inserting the item such as options, price 
+or other custom fields you defined.
+
+::
+	$data = array(
+		       'rowid'	 => 'b99ccdf16028f015540f341130b6d8ec',
+	               'qty'     => 1,
+		       'price'	 => 49.95,
+	               'coupon'	 => NULL
+	            );
+
+	$this->cart->update($data);
+
 What is a Row ID?
 *****************
 
-- 
cgit v1.2.3-24-g4f1b


From c09b953be9d14158cc21cecc676f7e992c16f752 Mon Sep 17 00:00:00 2001
From: Ahmad Anbar <aanbar@gmail.com>
Date: Thu, 13 Feb 2014 13:05:41 +0200
Subject: Added Missing new line.

---
 user_guide_src/source/libraries/cart.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/libraries/cart.rst b/user_guide_src/source/libraries/cart.rst
index a0870e34a..74e791554 100644
--- a/user_guide_src/source/libraries/cart.rst
+++ b/user_guide_src/source/libraries/cart.rst
@@ -244,6 +244,7 @@ defined when inserting the item such as options, price
 or other custom fields you defined.
 
 ::
+
 	$data = array(
 		       'rowid'	 => 'b99ccdf16028f015540f341130b6d8ec',
 	               'qty'     => 1,
-- 
cgit v1.2.3-24-g4f1b


From 0bd390c660290b7dc478955da6a8a7fbb3ca9fd6 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Thu, 13 Feb 2014 14:26:50 +0200
Subject: [ci skip] Polish changes from #2874

---
 user_guide_src/source/changelog.rst      |   6 +-
 user_guide_src/source/libraries/cart.rst | 125 +++++++++++++++----------------
 2 files changed, 65 insertions(+), 66 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index c8cbbb9e5..029bf61cb 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -303,12 +303,12 @@ Release Date: Not Released
 
    -  :doc:`Cart Library <libraries/cart>` changes include:
 
-      -  ``insert()`` now auto-increments quantity for an item when inserted twice instead of resetting it, this is the default behaviour of large e-commerce sites.
-      -  *Product Name* strictness can be disabled by switching the ``$product_name_safe`` property to FALSE.
       -  Added method ``remove()`` to remove a cart item, updating with quantity of 0 seemed like a hack but has remained to retain compatibility.
       -  Added method ``get_item()`` to enable retrieving data for a single cart item.
       -  Added unicode support for product names.
-      -	 ``update()`` now supports updating all properties attached to an item.
+      -  Added support for disabling product name strictness via the ``$product_name_safe`` property.
+      -  Changed ``insert()`` method to auto-increment quantity for an item when inserted twice instead of resetting it.
+      -	 Changed ``update()`` method to support updating all properties attached to an item.
 
    -  :doc:`Image Manipulation Library <libraries/image_lib>` changes include:
 
diff --git a/user_guide_src/source/libraries/cart.rst b/user_guide_src/source/libraries/cart.rst
index 74e791554..8a473b49d 100644
--- a/user_guide_src/source/libraries/cart.rst
+++ b/user_guide_src/source/libraries/cart.rst
@@ -33,7 +33,7 @@ Initializing the Shopping Cart Class
 	utilize a database.
 
 To initialize the Shopping Cart Class in your controller constructor,
-use the $this->load->library function::
+use the ``$this->load->library()`` method::
 
 	$this->load->library('cart');
 
@@ -49,16 +49,16 @@ Adding an Item to The Cart
 ==========================
 
 To add an item to the shopping cart, simply pass an array with the
-product information to the $this->cart->insert() function, as shown
+product information to the ``$this->cart->insert()`` method, as shown
 below::
 
 	$data = array(
-	               'id'      => 'sku_123ABC',
-	               'qty'     => 1,
-	               'price'   => 39.95,
-	               'name'    => 'T-Shirt',
-	               'options' => array('Size' => 'L', 'Color' => 'Red')
-	            );
+		'id'      => 'sku_123ABC',
+		'qty'     => 1,
+		'price'   => 39.95,
+		'name'    => 'T-Shirt',
+		'options' => array('Size' => 'L', 'Color' => 'Red')
+	);
 
 	$this->cart->insert($data);
 
@@ -91,16 +91,16 @@ information in a table easier.
 ::
 
 	$data = array(
-	               'id'      => 'sku_123ABC',
-	               'qty'     => 1,
-	               'price'   => 39.95,
-	               'name'    => 'T-Shirt',
-	               'coupon'	 => 'XMAS-50OFF'
-	            );
+		'id'      => 'sku_123ABC',
+		'qty'     => 1,
+		'price'   => 39.95,
+		'name'    => 'T-Shirt',
+		'coupon'	 => 'XMAS-50OFF'
+	);
 
 	$this->cart->insert($data);
 
-The insert() method will return the $rowid if you successfully insert a
+The ``insert()`` method will return the $rowid if you successfully insert a
 single item.
 
 Adding Multiple Items to The Cart
@@ -148,15 +148,15 @@ helper </helpers/form_helper>`.
 
 ::
 
-	<?php echo form_open('path/to/controller/update/function'); ?>
+	<?php echo form_open('path/to/controller/update/method'); ?>
 
 	<table cellpadding="6" cellspacing="1" style="width:100%" border="0">
 
 	<tr>
-	  <th>QTY</th>
-	  <th>Item Description</th>
-	  <th style="text-align:right">Item Price</th>
-	  <th style="text-align:right">Sub-Total</th>
+		<th>QTY</th>
+		<th>Item Description</th>
+		<th style="text-align:right">Item Price</th>
+		<th style="text-align:right">Sub-Total</th>
 	</tr>
 
 	<?php $i = 1; ?>
@@ -166,9 +166,9 @@ helper </helpers/form_helper>`.
 		<?php echo form_hidden($i.'[rowid]', $items['rowid']); ?>
 
 		<tr>
-		  <td><?php echo form_input(array('name' => $i.'[qty]', 'value' => $items['qty'], 'maxlength' => '3', 'size' => '5')); ?></td>
-		  <td>
-			<?php echo $items['name']; ?>
+			<td><?php echo form_input(array('name' => $i.'[qty]', 'value' => $items['qty'], 'maxlength' => '3', 'size' => '5')); ?></td>
+			<td>
+				<?php echo $items['name']; ?>
 
 				<?php if ($this->cart->has_options($items['rowid']) == TRUE): ?>
 
@@ -182,9 +182,9 @@ helper </helpers/form_helper>`.
 
 				<?php endif; ?>
 
-		  </td>
-		  <td style="text-align:right"><?php echo $this->cart->format_number($items['price']); ?></td>
-		  <td style="text-align:right">$<?php echo $this->cart->format_number($items['subtotal']); ?></td>
+			</td>
+			<td style="text-align:right"><?php echo $this->cart->format_number($items['price']); ?></td>
+			<td style="text-align:right">$<?php echo $this->cart->format_number($items['subtotal']); ?></td>
 		</tr>
 
 	<?php $i++; ?>
@@ -192,9 +192,9 @@ helper </helpers/form_helper>`.
 	<?php endforeach; ?>
 
 	<tr>
-	  <td colspan="2"> </td>
-	  <td class="right"><strong>Total</strong></td>
-	  <td class="right">$<?php echo $this->cart->format_number($this->cart->total()); ?></td>
+		<td colspan="2"> </td>
+		<td class="right"><strong>Total</strong></td>
+		<td class="right">$<?php echo $this->cart->format_number($this->cart->total()); ?></td>
 	</tr>
 
 	</table>
@@ -205,8 +205,8 @@ Updating The Cart
 =================
 
 To update the information in your cart, you must pass an array
-containing the Row ID and quantity to the $this->cart->update()
-function.
+containing the Row ID and quantity to the ``$this->cart->update()``
+method::
 
 .. note:: If the quantity is set to zero, the item will be removed from
 	the cart.
@@ -214,53 +214,52 @@ function.
 ::
 
 	$data = array(
-	               'rowid' => 'b99ccdf16028f015540f341130b6d8ec',
-	               'qty'   => 3
-	            );
+		'rowid' => 'b99ccdf16028f015540f341130b6d8ec',
+		'qty'   => 3
+	);
 
 	$this->cart->update($data);
 
 	// Or a multi-dimensional array
 
 	$data = array(
-	               array(
-	                       'rowid'   => 'b99ccdf16028f015540f341130b6d8ec',
-	                       'qty'     => 3
-	                    ),
-	               array(
-	                       'rowid'   => 'xw82g9q3r495893iajdh473990rikw23',
-	                       'qty'     => 4
-	                    ),
-	               array(
-	                       'rowid'   => 'fh4kdkkkaoe30njgoe92rkdkkobec333',
-	                       'qty'     => 2
-	                    )
-	            );
+		array(
+			'rowid'   => 'b99ccdf16028f015540f341130b6d8ec',
+			'qty'     => 3
+		),
+		array(
+			'rowid'   => 'xw82g9q3r495893iajdh473990rikw23',
+			'qty'     => 4
+		),
+		array(
+			'rowid'   => 'fh4kdkkkaoe30njgoe92rkdkkobec333',
+			'qty'     => 2
+		)
+	);
 
 	$this->cart->update($data);
 
-You may also update any property you have previously 
-defined when inserting the item such as options, price 
-or other custom fields you defined.
+You may also update any property you have previously defined when
+inserting the item such as options, price or other custom fields.
 
 ::
 
 	$data = array(
-		       'rowid'	 => 'b99ccdf16028f015540f341130b6d8ec',
-	               'qty'     => 1,
-		       'price'	 => 49.95,
-	               'coupon'	 => NULL
-	            );
+		'rowid'  => 'b99ccdf16028f015540f341130b6d8ec',
+		'qty'    => 1,
+		'price'	 => 49.95,
+		'coupon' => NULL
+	);
 
 	$this->cart->update($data);
 
 What is a Row ID?
 *****************
 
-The row ID is a unique identifier that is
-generated by the cart code when an item is added to the cart. The reason
-a unique ID is created is so that identical products with different
-options can be managed by the cart.
+The row ID is a unique identifier that is generated by the cart code
+when an item is added to the cart. The reason a unique ID is created
+is so that identical products with different options can be managed
+by the cart.
 
 For example, let's say someone buys two identical t-shirts (same product
 ID), but in different sizes. The product ID (and other attributes) will
@@ -274,9 +273,9 @@ In nearly all cases, updating the cart will be something the user does
 via the "view cart" page, so as a developer, it is unlikely that you
 will ever have to concern yourself with the "row ID", other than making
 sure your "view cart" page contains this information in a hidden form
-field, and making sure it gets passed to the update function when the
-update form is submitted. Please examine the construction of the "view
-cart" page above for more information.
+field, and making sure it gets passed to the ``update()`` method when
+the update form is submitted. Please examine the construction of the
+"view cart" page above for more information.
 
 
 ***************
@@ -374,7 +373,7 @@ Class Reference
 
 		Returns TRUE (boolean) if a particular row in the cart contains options.
 		This method is designed to be used in a loop with ``contents()``, since
-		you must pass the rowid to this function, as shown in the Displaying
+		you must pass the rowid to this method, as shown in the Displaying
 		the Cart example above.
 
 	.. method:: product_options([$row_id = ''])
-- 
cgit v1.2.3-24-g4f1b


From aef63e532bcede1d455bc27f0fc6f369ab74f203 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Thu, 13 Feb 2014 14:49:55 +0200
Subject: Add language translation support to CI_Pagination (#1589)

---
 user_guide_src/source/changelog.rst            | 5 +++--
 user_guide_src/source/libraries/pagination.rst | 8 ++++++++
 2 files changed, 11 insertions(+), 2 deletions(-)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 029bf61cb..3bb88a779 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -367,11 +367,12 @@ Release Date: Not Released
 
    -  :doc:`Pagination Library <libraries/pagination>` changes include:
 
+      -  Deprecated usage of the "anchor_class" setting (use the new "attributes" setting instead).
       -  Added method chaining support to ``initialize()`` method.
       -  Added support for the anchor "rel" attribute.
       -  Added support for setting custom attributes.
-      -  Deprecated usage of the "anchor_class" setting (use the new "attributes" setting instead).
-      -  Added $config['reuse_query_string'] to allow automatic repopulation of query string arguments, combined with normal URI segments.
+      -  Added support for language translations of the *first_link*, *next_link*, *prev_link* and *last_link* values.
+      -  Added ``$config['reuse_query_string']`` to allow automatic repopulation of query string arguments, combined with normal URI segments.
       -  Removed the default ``&nbsp;`` from a number of the configuration variables.
 
    -  :doc:`Profiler Library <general/profiling>` changes include:
diff --git a/user_guide_src/source/libraries/pagination.rst b/user_guide_src/source/libraries/pagination.rst
index ee12d9e6f..d8d31f8c5 100644
--- a/user_guide_src/source/libraries/pagination.rst
+++ b/user_guide_src/source/libraries/pagination.rst
@@ -165,6 +165,8 @@ $config['first_link'] = 'First';
 The text you would like shown in the "first" link on the left. If you do
 not want this link rendered, you can set its value to FALSE.
 
+.. note:: This value can also be translated via a language file.
+
 $config['first_tag_open'] = '<div>';
 ====================================
 
@@ -185,6 +187,8 @@ $config['last_link'] = 'Last';
 The text you would like shown in the "last" link on the right. If you do
 not want this link rendered, you can set its value to FALSE.
 
+.. note:: This value can also be translated via a language file.
+
 $config['last_tag_open'] = '<div>';
 ===================================
 
@@ -205,6 +209,8 @@ $config['next_link'] = '&gt;';
 The text you would like shown in the "next" page link. If you do not
 want this link rendered, you can set its value to FALSE.
 
+.. note:: This value can also be translated via a language file.
+
 $config['next_tag_open'] = '<div>';
 ===================================
 
@@ -225,6 +231,8 @@ $config['prev_link'] = '&lt;';
 The text you would like shown in the "previous" page link. If you do not
 want this link rendered, you can set its value to FALSE.
 
+.. note:: This value can also be translated via a language file.
+
 $config['prev_tag_open'] = '<div>';
 ===================================
 
-- 
cgit v1.2.3-24-g4f1b


From b1616b8c3370d59135275b6945ed1b80cfe99653 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Thu, 13 Feb 2014 15:12:43 +0200
Subject: Fix #2364

---
 user_guide_src/source/changelog.rst | 1 +
 1 file changed, 1 insertion(+)

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 3bb88a779..d4f882064 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -710,6 +710,7 @@ Bug fixes for 3.0
 -  Fixed a bug (#2856) - ODBC method ``affected_rows()`` passed an incorrect value to ``odbc_num_rows()``.
 -  Fixed a bug (#43) :doc:`Image Manipulation Library <libraries/image_lib>` method ``text_watermark()`` didn't properly determine watermark placement.
 -  Fixed a bug where :doc:`HTML Table Library <libraries/table>` ignored its *auto_heading* setting if headings were not already set.
+-  Fixed a bug (#2364) - :doc:`Pagination Library <libraries/pagination>` appended the query string (if used) multiple times when there are successive calls to ``create_links()`` with no ``initialize()`` in between them.
 
 Version 2.1.4
 =============
-- 
cgit v1.2.3-24-g4f1b


From 81f036753272391360ba5b64e6dd93c4101a8733 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@devilix.net>
Date: Thu, 13 Feb 2014 17:57:41 +0200
Subject: [ci skip] Add compatibility functions documentation + Sphinx build
 fixes for Cart

---
 user_guide_src/source/changelog.rst                |   2 +-
 .../source/general/compatibility_functions.rst     | 157 +++++++++++++++++++++
 user_guide_src/source/general/index.rst            |   1 +
 user_guide_src/source/libraries/cart.rst           |  42 +++---
 4 files changed, 180 insertions(+), 22 deletions(-)
 create mode 100644 user_guide_src/source/general/compatibility_functions.rst

(limited to 'user_guide_src/source')

diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index d4f882064..ca31669e8 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -506,7 +506,7 @@ Release Date: Not Released
       -  ``UTF8_ENABLED`` now requires only one of `Multibyte String <http://php.net/mbstring>`_ or `iconv <http://php.net/iconv>`_ to be available instead of both.
       -  Changed method ``clean_string()`` to utilize ``mb_convert_encoding()`` if it is available but ``iconv()`` is not.
 
-   -  Added compatibility layers for PHP's `mbstring <http://php.net/mbstring>`_ (limited support) and `password <http://php.net/password>`_ extensions.
+   -  Added `compatibility layers <general/compatibility_functions>` for PHP's `mbstring <http://php.net/mbstring>`_ (limited support) and `password <http://php.net/password>`_ extensions.
    -  Removed ``CI_CORE`` boolean constant from *CodeIgniter.php* (no longer Reactor and Core versions).
    -  Log Library will now try to create the **log_path** directory if it doesn't exist.
    -  Added support for HTTP-Only cookies with new config option *cookie_httponly* (default FALSE).
diff --git a/user_guide_src/source/general/compatibility_functions.rst b/user_guide_src/source/general/compatibility_functions.rst
new file mode 100644
index 000000000..e025d2aa3
--- /dev/null
+++ b/user_guide_src/source/general/compatibility_functions.rst
@@ -0,0 +1,157 @@
+#######################
+Compatibility Functions
+#######################
+
+CodeIgniter provides a set of compatibility functions that enable
+you to use functions what are otherwise natively available in PHP,
+but only in higher versions or depending on a certain extension.
+
+Being custom implementations, these functions will also have some
+set of dependancies on their own, but are still useful if your
+PHP setup doesn't offer them natively.
+
+.. note:: Much like the `common functions <common_functions>`, the
+	compatibility functions are always available, as long as
+	their dependancies are met.
+
+.. contents::
+  :local:
+
+.. raw:: html
+
+  <div class="custom-index container"></div>
+
+****************
+Password Hashing
+****************
+
+This set of compatibility functions offers a "backport" of PHP's
+standard `Password Hashing extension <http://php.net/password>`_
+that is otherwise available only since PHP 5.5.
+
+Dependancies
+============
+
+- PHP 5.3.7
+- ``CRYPT_BLOWFISH`` support for ``crypt()``
+
+Constants
+=========
+
+- ``PASSWORD_BCRYPT``
+- ``PASSWORD_DEFAULT``
+
+Function reference
+==================
+
+.. function:: password_get_info($hash)
+
+	:param	string	$hash: Password hash
+	:returns:	Information about the hashed password
+	:rtype:	array
+
+	For more information, please refer to the `PHP manual for
+	password_get_info() <http://php.net/password_get_info>`_.
+
+.. function:: password_hash($password, $algo[, $options = array()])
+
+	:param	string	$password: Plain-text password
+	:param	int	$algo: Hashing algorithm
+	:param	array	$options: Hashing options
+	:returns:	Hashed password or FALSE on failure
+	:rtype:	string
+
+	For more information, please refer to the `PHP manual for
+	password_hash() <http://php.net/password_hash>`_.
+
+	.. note:: Unless you provide your own (and valid) salt, this function
+		has a further dependancy on an available CSPRNG source. Each
+		of the following would satisfy that:
+		- ``mcrypt_create_iv()`` with ``MCRYPT_DEV_URANDOM``
+		- ``openssl_random_pseudo_bytes()``
+		- /dev/arandom
+		- /dev/urandom
+
+.. function:: password_needs_rehash()
+
+	:param	string	$hash: Password hash
+	:param	int	$algo: Hashing algorithm
+	:param	array	$options: Hashing options
+	:returns:	TRUE if the hash should be rehashed to match the given algorithm and options, FALSE otherwise
+	:rtype:	bool
+
+	For more information, please refer to the `PHP manual for
+	password_needs_rehash() <http://php.net/password_needs_rehash>`_.
+
+.. function:: password_verify($password, $hash)
+
+	:param	string	$password: Plain-text password
+	:param	string	$hash: Password hash
+	:returns:	TRUE if the password matches the hash, FALSE if not
+	:rtype:	bool
+
+	For more information, please refer to the `PHP manual for
+	password_verify() <http://php.net/password_verify>`_.
+
+****************
+Multibyte String
+****************
+
+This set of compatibility functions offers limited support for PHP's
+`Multibyte String extension <http://php.net/mbstring>`_. Because of
+the limited alternative solutions, only a few functions are available.
+
+.. note:: When a character set parameter is ommited,
+	``$config['charset']`` will be used.
+
+Dependancies
+============
+
+- `iconv <http://php.net/iconv>`_ extension
+
+.. important:: This dependancy is optional and these functions will
+	always be declared. If iconv is not available, they WILL
+	fall-back to their non-mbstring versions.
+
+.. important:: Where a character set is supplied, it must be
+	supported by iconv and in a format that it recognizes.
+
+.. note:: For you own dependancy check on the actual mbstring
+	extension, use the ``MB_ENABLED`` constant.
+
+Function reference
+==================
+
+.. function:: mb_strlen($str[, $encoding = NULL])
+
+	:param	string	$str: Input string
+	:param	string	$encoding: Character set
+	:returns:	Number of characters in the input string or FALSE on failure
+	:rtype:	string
+
+	For more information, please refer to the `PHP manual for
+	mb_strlen() <http://php.net/mb_strlen>`_.
+
+.. function:: mb_strpos($haystack, $needle[, $offset = 0[, $encoding = NULL]])
+
+	:param	string	$haystack: String to search in
+	:param	string	$needle: Part of string to search for
+	:param	int	$offset: Search offset
+	:param	string	$encoding: Character set
+	:returns:	Numeric character position of where $needle was found or FALSE if not found
+	:rtype:	mixed
+
+	For more information, please refer to the `PHP manual for
+	mb_strpos() <http://php.net/mb_strpos>`_.
+
+.. function:: mb_substr($str, $start[, $length = NULL[, $encoding = NULL]])
+
+	:param	string	$str: Input string
+	:param	int	$start: Position of first character
+	:param	int	$length: Maximum number of characters
+	:param	string	$encoding: Character set
+	:returns:	Portion of $str specified by $start and $length or FALSE on failure
+	:rtype:	string
+
+	For more information, please refer to the `PHP manual for
+	mb_substr() <http://php.net/mb_substr>`_.
\ No newline at end of file
diff --git a/user_guide_src/source/general/index.rst b/user_guide_src/source/general/index.rst
index 2bc684a1d..195c4a98a 100644
--- a/user_guide_src/source/general/index.rst
+++ b/user_guide_src/source/general/index.rst
@@ -20,6 +20,7 @@ General Topics
 	hooks
 	autoloader
 	common_functions
+	compatibility_functions
 	routing
 	errors
 	Caching <caching>
diff --git a/user_guide_src/source/libraries/cart.rst b/user_guide_src/source/libraries/cart.rst
index 8a473b49d..d7d495967 100644
--- a/user_guide_src/source/libraries/cart.rst
+++ b/user_guide_src/source/libraries/cart.rst
@@ -114,26 +114,26 @@ same page.
 ::
 
 	$data = array(
-	               array(
-	                       'id'      => 'sku_123ABC',
-	                       'qty'     => 1,
-	                       'price'   => 39.95,
-	                       'name'    => 'T-Shirt',
-	                       'options' => array('Size' => 'L', 'Color' => 'Red')
-	                    ),
-	               array(
-	                       'id'      => 'sku_567ZYX',
-	                       'qty'     => 1,
-	                       'price'   => 9.95,
-	                       'name'    => 'Coffee Mug'
-	                    ),
-	               array(
-	                       'id'      => 'sku_965QRS',
-	                       'qty'     => 1,
-	                       'price'   => 29.95,
-	                       'name'    => 'Shot Glass'
-	                    )
-	            );
+		array(
+			'id'      => 'sku_123ABC',
+			'qty'     => 1,
+			'price'   => 39.95,
+			'name'    => 'T-Shirt',
+			'options' => array('Size' => 'L', 'Color' => 'Red')
+		),
+		array(
+			'id'      => 'sku_567ZYX',
+			'qty'     => 1,
+			'price'   => 9.95,
+			'name'    => 'Coffee Mug'
+		),
+		array(
+			'id'      => 'sku_965QRS',
+			'qty'     => 1,
+			'price'   => 29.95,
+			'name'    => 'Shot Glass'
+		)
+	);
 
 	$this->cart->insert($data);
 
@@ -206,7 +206,7 @@ Updating The Cart
 
 To update the information in your cart, you must pass an array
 containing the Row ID and quantity to the ``$this->cart->update()``
-method::
+method.
 
 .. note:: If the quantity is set to zero, the item will be removed from
 	the cart.
-- 
cgit v1.2.3-24-g4f1b