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/changelog.html           | 1 +
 user_guide/helpers/text_helper.html | 7 +++++++
 2 files changed, 8 insertions(+)

(limited to 'user_guide')

diff --git a/user_guide/changelog.html b/user_guide/changelog.html
index 95b1e6ccd..bd2099937 100644
--- a/user_guide/changelog.html
+++ b/user_guide/changelog.html
@@ -100,6 +100,7 @@ Hg Tag: </p>
 	</li>
 	<li>Helpers
 		<ul>
+			<li>Added <kbd>convert_accented_characters()</kbd> function to  <a href="./helpers/text_helper.html">text helper</a>.</li>
 			<li>Added accept-charset to the list of inserted attributes of <kbd>form_open()</kbd> in the <a href="helpers/form_helper.html">Form Helper</a>.</li>
 			<li>Deprecated the <kbd>dohash()</kbd> function in favour of <kbd>do_hash()</kbd> for naming consistency.</li>
 			<li>Non-backwards compatible change made to <kbd>get_dir_file_info()</kbd> in the <a href="helpers/file_helper.html">File Helper</a>.  No longer recurses
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