[ci skip] Clean up the common functions docs

1 files changed, 69 insertions, 96 deletions

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