Tagged 0.7.5
[scuttle] / includes / utf8 / README
diff --git a/includes/utf8/README b/includes/utf8/README
new file mode 100644 (file)
index 0000000..8b533c2
--- /dev/null
@@ -0,0 +1,82 @@
+++PHP UTF-8++\r
+\r
+Version 0.5\r
+\r
+++DOCUMENTATION++\r
+\r
+Documentation in progress in ./docs dir\r
+\r
+http://www.phpwact.org/php/i18n/charsets\r
+http://www.phpwact.org/php/i18n/utf-8\r
+\r
+Important Note: DO NOT use these functions without understanding WHY\r
+you are using them. In particular, do not blindly replace all use of PHP's\r
+string functions which functions found here - most of the time you will\r
+not need to, and you will be introducing a significant performance\r
+overhead to your application. You can get a good idea of when to use what\r
+from reading: http://www.phpwact.org/php/i18n/utf-8\r
+\r
+Important Note: For sake of performance most of the functions here are\r
+not "defensive" (e.g. there is not extensive parameter checking, well\r
+formed UTF-8 is assumed). This is particularily relevant when is comes to\r
+catching badly formed UTF-8 - you should screen input on the "outer\r
+perimeter" with help from functions in the utf8_validation.php and\r
+utf8_bad.php files.\r
+\r
+Important Note: this library treats ALL ASCII characters as valid, including ASCII control characters. But if you use some ASCII control characters in XML, it will render the XML ill-formed. Don't be a bozo: http://hsivonen.iki.fi/producing-xml/#controlchar\r
+\r
+++BUGS / SUPPORT / FEATURE REQUESTS ++\r
+\r
+Please report bugs to:\r
+http://sourceforge.net/tracker/?group_id=142846&atid=753842\r
+- if you are able, please submit a failing unit test\r
+(http://www.lastcraft.com/simple_test.php) with your bug report.\r
+\r
+For feature requests / faster implementation of functions found here,\r
+please drop them in via the RFE tracker: http://sourceforge.net/tracker/?group_id=142846&atid=753845\r
+Particularily interested in faster implementations!\r
+\r
+For general support / help, use:\r
+http://sourceforge.net/tracker/?group_id=142846&atid=753843\r
+\r
+In the VERY WORST case, you can email me: hfuecks gmail com - I tend to be slow to respond though so be warned.\r
+\r
+Important Note: when reporting bugs, please provide the following \r
+information;\r
+\r
+PHP version, whether the iconv extension is loaded (in PHP5 it's \r
+there by default), whether the mbstring extension is loaded. The\r
+following PHP script can be used to determine this information;\r
+\r
+<?php\r
+print "PHP Version: " .phpversion()."<br>";\r
+if ( extension_loaded('mbstring') ) {\r
+    print "mbstring available<br>";\r
+} else {\r
+    print "mbstring not available<br>";\r
+}\r
+if ( extension_loaded('iconv') ) {\r
+    print "iconv available<br>";\r
+} else {\r
+    print "iconv not available<br>";\r
+}\r
+?>\r
+\r
+++LICENSING++\r
+\r
+Parts of the code in this library come from other places, under different\r
+licenses.\r
+The authors involved have been contacted (see below). Attribution for\r
+which code came from elsewhere can be found in the source code itself.\r
+\r
++Andreas Gohr / Chris Smith - Dokuwiki\r
+There is a fair degree of collaboration / exchange of ideas and code\r
+beteen Dokuwiki's UTF-8 library;\r
+http://dev.splitbrain.org/view/darcs/dokuwiki/inc/utf8.php\r
+and phputf8. Although Dokuwiki is released under GPL, its UTF-8\r
+library is released under LGPL, hence no conflict with phputf8\r
+\r
++Henri Sivonen (http://hsivonen.iki.fi/php-utf8/ / \r
+http://hsivonen.iki.fi/php-utf8/) has also given permission for his\r
+code to be released under the terms of the LGPL. He ported a Unicode / UTF-8\r
+converter from the Mozilla codebase to PHP, which is re-used in phputf8\r

Benjamin Mako Hill || Want to submit a patch?