# Module unidecode

This module is based on Python's Unidecode module by Tomaz Solc, which in turn is based on the `Text::Unidecode` Perl module by Sean M. Burke (http://search.cpan.org/~sburke/Text-Unidecode-0.04/lib/Text/Unidecode.pm ).

It provides a single proc that does Unicode to ASCII transliterations: It finds the sequence of ASCII characters that is the closest approximation to the Unicode string.

For example, the closest to string "Äußerst" in ASCII is "Ausserst". Some information is lost in this transformation, of course, since several Unicode strings can be transformed in the same ASCII representation. So this is a strictly one-way transformation. However a human reader will probably still be able to guess what original string was meant from the context.

This module needs the data file "unidecode.dat" to work: You can either ship this file with your application and initialize this module with the loadUnidecodeTable proc or you can define the `embedUnidecodeTable` symbol to embed the file as a resource into your application.

# Imports

unicode

# Procs

    proc loadUnidecodeTable(datafile = "unidecode.dat") {.raises: [E_Base, EIO],
        tags: [FReadIO].}

  loads the datafile that unidecode to work. Unless this module is compiled with the `embedUnidecodeTable` symbol defined, this needs to be called by the main thread before any thread can make a call to unidecode.

    proc unidecode(s: string): string {.raises: [], tags: [].}

  Finds the sequence of ASCII characters that is the closest approximation to the UTF-8 string s.

  Example:

  > unidecode("x53x17x4ExB0")

  Results in: "Bei Jing"

Generated: 2013-05-21 09:55:16 UTC