Latinizer

v0.4.0

Latinizer v0.4.0 Latinizer View Source

A module allowing one to replace regional characters in strings with their closest latin equivalents.

The module takes care of both transcription and removal of diacritical signs.

Link to this section Summary

Functions

latinize(string, opts \\ [])

Replaces regional characters in the given string with their closest latin equivalents

remove_diacritics(string)

See Latinizer.Diacritics.remove_diacritics/1

remove_diacritics(string, opts)

See Latinizer.Diacritics.remove_diacritics/2

transcribe(string)

See Latinizer.Transcriptions.transcribe/1

transcribe(string, opts)

See Latinizer.Transcriptions.transcribe/2

Link to this section Functions

Link to this function latinize(string, opts \\ []) View Source 
latinize(binary(), list()) :: binary()

Replaces regional characters in the given string with their closest latin equivalents.

Returns a string with replaced letters. If the :only argument is specified, only the letters provided in this argument will be replaced.

Examples

Translating with no characters specified:

iex> Latinizer.latinize ""
""

iex> Latinizer.latinize "хорошо"
"horosho"

iex> Latinizer.latinize "gżegżółka"
"gzegzolka"

iex> Latinizer.latinize "Pchnij w tę łódź jeża lub ośm skrzyń fig."
"Pchnij w te lodz jeza lub osm skrzyn fig"

iex> Latinizer.latinize "В начале было Слово, и Слово было у Бога, и Слово было Бог."
"V nachale bylo Slovo i Slovo bylo u Boga i Slovo bylo Bog"

You can pass the :only option to replace only the specified characters:

iex> Latinizer.latinize "łódeczka", only: ["ł"]
"lódeczka"

iex> Latinizer.latinize "łódeczka", only: ["ł", "ó"]
"lodeczka"

iex> Latinizer.latinize "łódeczka", only: ["ł", "ó", "Ą", "a"]
"lodeczka"