Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Unicode algorithms for Ruby 1.9
Ruby
branch: each_word_rege…

This branch is 1 commit ahead, 100 commits behind master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bench
cdata
data
docsrc
lib
test
.gitignore
INSTALL.txt
LICENSE.txt
README.txt
Rakefile
install.rb
unicode_utils.gemspec

README.txt

= Unicode Utils - Unicode algorithms for Ruby 1.9

Install with RubyGems:

    gem install unicode_utils

Or get the source from Github: http://github.com/lang/unicode_utils

For a non-RubyGems installation, read
INSTALL.txt[link:files/INSTALL_txt.html].

UnicodeUtils works with Ruby 1.9.1-preview2 or later.

== Synopsis

    require "unicode_utils"

    UnicodeUtils.char_name("æ") => "LATIN SMALL LETTER AE"
    
    UnicodeUtils.upcase("weiß") => "WEISS"

    UnicodeUtils.upcase("i", :tr) => "İ"

    UnicodeUtils.downcase("Ümit") => "ümit"

    UnicodeUtils.nfkc("fi") => "fi"

Start with the UnicodeUtils module in the API documentation for
complete documentation.

Since some functions need significant amounts of data that is loaded
at require time, the library is split up into separate files for
each function. The +unicode_utils+ library loads them all. If you
need only a specific function, e.g. +upcase+, you can require only
the file <tt>unicode_utils/upcase</tt> to save memory and reduce
startup time. Methods that end in a ? are in a file suffixed with
+_q+, e.g. <tt>lowercase_char?</tt> can be required with
<tt>unicode_utils/lowercase_char_q</tt>.

There is also a shortcut for IRB usage. See
U[link:files/lib/unicode_utils/u_rb.html].

== License

unicode_utils is licensed under the BSD license. Read the file
LICENSE.txt in the unicode_utils package for details.

== Links

Sources on Github:: http://github.com/lang/unicode_utils
Rubyforge project:: http://rubyforge.org/projects/unicode-utils
Online documentation:: http://unicode-utils.rubyforge.org
Home of the Unicode Consortium:: http://unicode.org

== Who?

UnicodeUtils is written by Stefan Lang. You can contact me at
<tt>langstefan AT gmx.at</tt>. Contributions welcome!
Something went wrong with that request. Please try again.