From 1a19592c5dca055b857177ed35a10294dded78ee Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Wed, 10 Mar 2010 14:22:59 -0600
Subject: added docs for convert_accented_characters() in the Text Helper

---
 user_guide/helpers/text_helper.html | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'user_guide/helpers/text_helper.html')

diff --git a/user_guide/helpers/text_helper.html b/user_guide/helpers/text_helper.html
index c80300c8b..9e8f8f5e1 100644
--- a/user_guide/helpers/text_helper.html
+++ b/user_guide/helpers/text_helper.html
@@ -115,6 +115,13 @@ part it should correctly identify characters outside the normal range (like acce
 
 <p>This function does the opposite of the previous one; it turns character entities back into ASCII.</p>
 
+<h2>convert_accented_characters()</h2>
+
+<p>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.</p>
+
+<code>$string = convert_accented_characters($string);</code>
+	
+<p>This function uses a companion config file <dfn>system/application/config/foreign_chars.php</dfn> to define the to and from array for transliteration.</p>
 
 <h2>word_censor()</h2>
 
-- 
cgit v1.2.3-24-g4f1b