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