module_unicode.html revision 7d9dd27c758ee750e3ea3b2cf2932691378d5cdd
<head>
<title>API: unicode (YUI Library)</title>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<h3>unicode <span class="subtitle">3.3.0</span></h3>
<form onsubmit="return false">
<div id="propertysearch">
Search: <input autocomplete="off" id="searchinput" />
<div id="searchresults">
</div>
</div>
</form>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form">
<fieldset>
<legend>Filters</legend>
<span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span>
<span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span>
<span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span>
</fieldset>
</form>
<h3>Module: unicode
</h3>
<div class="description summary">
Unicode utilities.
</div>
<div class="yui-gc">
<div class="yui-u first">
<p>This module contains the following classes:</p>
<script>
//var YUI_CLASS_LIST = [{"extends": {"superclass": {}, "events": {}, "configs": {}, "properties": {}, "methods": {}}, "description": "<p>\nProvides a basic Unicode accent folding implementation that converts common\naccented letters (like \"á\") to their non-accented forms (like \"a\").\n</p>\n<p>\nThis implementation is not comprehensive, and should only be used as a last\nresort when accent folding can't be done on the server. A comprehensive\naccent folding implementation would require much more character data to be\nsent to the browser, resulting in a significant performance penalty. This\nimplementation strives for a compromise between usefulness and performance.\n</p>\n<p>\nAccent folding is a destructive operation that can't be reversed, and may\nchange or destroy the actual meaning of the text depending on the language.\nIt should not be used on strings that will later be displayed to a user,\nunless this is done with the understanding that linguistic meaning may be\nlost and that you may in fact confuse or insult the user by doing so.\n</p>", "guessedname": "Unicode.AccentFold", "name": "Unicode.AccentFold"}, {"extends": {"superclass": {}, "events": {}, "configs": {}, "properties": {}, "methods": {}}, "description": "<p>\nAn imperfect, incomplete reverse mapping of ASCII characters to\ncase-insensitive regexes that match their most common accented forms.\n</p>\n<p>\nThe goal of this module is to provide a pragmatic and generally useful set of\naccent folding data, since serving and performing lookups on a complete\ndataset would be impractical in client-side JavaScript.\n</p>\n<p>\nWhenever possible, accent folding should be done on the server, where it's\npossible to use tools that are both more complete and more performant. It\nshould only be done on the client as an absolute last resort.\n</p>", "guessedname": "Unicode.Data.AccentFold", "name": "Unicode.Data.AccentFold"}, {"extends": {"superclass": {}, "events": {}, "configs": {}, "properties": {}, "methods": {}}, "description": "<p>\nUnicode data used by the word breaking algorithm.\n</p>\n<p>\nWhenever possible, word breaking should be done on the server, where it's\npossible to use tools that are both more complete and more performant. It\nshould only be done on the client as an absolute last resort.\n</p>", "guessedname": "Unicode.Data.WordBreak", "name": "Unicode.Data.WordBreak"}, {"extends": {"superclass": {}, "events": {}, "configs": {}, "properties": {}, "methods": {}}, "description": "Provides utility methods for splitting strings on word breaks and determining\nwhether a character represents a word boundary, using the algorithm defined\nin the Unicode Text Segmentation guidelines\n(<a href=\"http://unicode.org/reports/tr29/#Word_Boundaries\">Unicode Standard\nAnnex #29</a>).", "guessedname": "Unicode.WordBreak", "name": "Unicode.WordBreak"}];
</script>
<div id="splash_classList">
<ul>
<li><a href="Unicode.AccentFold.html" title="Unicode.AccentFold" id="class_0">Unicode.AccentFold</a></li>
<li><a href="Unicode.Data.AccentFold.html" title="Unicode.Data.AccentFold" id="class_1">Unicode.Data.AccentFold</a></li>
<li><a href="Unicode.Data.WordBreak.html" title="Unicode.Data.WordBreak" id="class_2">Unicode.Data.WordBreak</a></li>
<li><a href="Unicode.WordBreak.html" title="Unicode.WordBreak" id="class_3">Unicode.WordBreak</a></li>
</ul>
</div>
</div>
<div class="yui-u">
<div class="submodules">
<h4>Submodules:</h4>
<dl>
<dt><code>unicode-accentfold</code></dt>
<dd><p>
Provides a basic Unicode accent folding implementation that converts common
accented letters (like "á") to their non-accented forms (like "a").
</p>
<p>
This implementation is not comprehensive, and should only be used as a last
resort when accent folding can't be done on the server. A comprehensive
accent folding implementation would require much more character data to be
sent to the browser, resulting in a significant performance penalty. This
implementation strives for a compromise between usefulness and performance.
</p>
<p>
Accent folding is a destructive operation that can't be reversed, and may
change or destroy the actual meaning of the text depending on the language.
It should not be used on strings that will later be displayed to a user,
unless this is done with the understanding that linguistic meaning may be
lost and that you may in fact confuse or insult the user by doing so.
</p></dd>
<dt><code>unicode-data-accentfold</code></dt>
<dd><p>
An imperfect, incomplete reverse mapping of ASCII characters to
case-insensitive regexes that match their most common accented forms.
</p>
<p>
The goal of this module is to provide a pragmatic and generally useful set of
accent folding data, since serving and performing lookups on a complete
dataset would be impractical in client-side JavaScript.
</p>
<p>
Whenever possible, accent folding should be done on the server, where it's
possible to use tools that are both more complete and more performant. It
should only be done on the client as an absolute last resort.
</p></dd>
<dt><code>unicode-data-wordbreak</code></dt>
<dd><p>
Unicode data used by the word breaking algorithm.
</p>
<p>
Whenever possible, word breaking should be done on the server, where it's
possible to use tools that are both more complete and more performant. It
should only be done on the client as an absolute last resort.
</p></dd>
<dt><code>unicode-wordbreak</code></dt>
<dd>Provides utility methods for splitting strings on word breaks and determining
whether a character represents a word boundary, using the algorithm defined
in the Unicode Text Segmentation guidelines
(<a href="http://unicode.org/reports/tr29/#Word_Boundaries">Unicode Standard
Annex #29</a>).</dd>
</dl>
</div>
</div>
</div>
</div>
</div>
<div class="yui-b">
<div class="nav">
<div id="moduleList" class="module">
<h4>Modules</h4>
<ul class="content">
<li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li>
<li class=""><a href="module_event-valuechange.html" title="event-valuechange">event-valuechange</a></li>
<li class=""><a href="module_history-deprecated.html" title="history-deprecated">history-deprecated</a></li>
<li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li>
<li class=""><a href="module_scrollview-paginator.html" title="scrollview-paginator">scrollview-paginator</a></li>
<li class=""><a href="module_scrollview-scrollbars.html" title="scrollview-scrollbars">scrollview-scrollbars</a></li>
<li class=""><a href="module_widget-position-align.html" title="widget-position-align">widget-position-align</a></li>
<li class=""><a href="module_widget-position-constrain.html" title="widget-position-constrain">widget-position-constrain</a></li>
</ul>
</div>
<div id="classList" class="module">
<h4>Classes</h4>
<ul class="content">
<li class=""><a href="Unicode.AccentFold.html" title="Unicode.AccentFold">Unicode.AccentFold</a></li>
<li class=""><a href="Unicode.Data.AccentFold.html" title="Unicode.Data.AccentFold">Unicode.Data.AccentFold</a></li>
<li class=""><a href="Unicode.Data.WordBreak.html" title="Unicode.Data.WordBreak">Unicode.Data.WordBreak</a></li>
</ul>
</div>
<div id="fileList" class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="unicode-accentfold.js.html" title="unicode-accentfold.js">unicode-accentfold.js</a></li>
<li class=""><a href="unicode-data-accentfold.js.html" title="unicode-data-accentfold.js">unicode-data-accentfold.js</a></li>
<li class=""><a href="unicode-data-wordbreak.js.html" title="unicode-data-wordbreak.js">unicode-data-wordbreak.js</a></li>
<li class=""><a href="unicode-wordbreak.js.html" title="unicode-wordbreak.js">unicode-wordbreak.js</a></li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright © 2010 Yahoo! Inc. All rights reserved.
</div>
</div>
<script type="text/javascript">
var ALL_YUI_PROPS = [{"access": "", "host": "Unicode.AccentFold", "name": "canFold", "url": "Unicode.AccentFold.html#method_canFold", "type": "method"}, {"access": "protected", "host": "Unicode.WordBreak", "name": "_classify", "url": "Unicode.WordBreak.html#method__classify", "type": "method"}, {"access": "", "host": "Unicode.AccentFold", "name": "compare", "url": "Unicode.AccentFold.html#method_compare", "type": "method"}, {"access": "", "host": "Unicode.AccentFold", "name": "filter", "url": "Unicode.AccentFold.html#method_filter", "type": "method"}, {"access": "", "host": "Unicode.AccentFold", "name": "fold", "url": "Unicode.AccentFold.html#method_fold", "type": "method"}, {"access": "", "host": "Unicode.WordBreak", "name": "getUniqueWords", "url": "Unicode.WordBreak.html#method_getUniqueWords", "type": "method"}, {"access": "", "host": "Unicode.WordBreak", "name": "getWords", "url": "Unicode.WordBreak.html#method_getWords", "type": "method"}, {"access": "protected", "host": "Unicode.WordBreak", "name": "_isWordBoundary", "url": "Unicode.WordBreak.html#method__isWordBoundary", "type": "method"}, {"access": "", "host": "Unicode.WordBreak", "name": "isWordBoundary", "url": "Unicode.WordBreak.html#method_isWordBoundary", "type": "method"}];
</script>
</body>
</html>