Convert traditional orthography into Latin or pronunciation text.

Text is a TypeScript library which transforms traditional orthography into Latin/Romanized text, using the Talk spec. TalkText can be used to render Tone, which is a unique and modern rune-like writing system for pronunciations.

Caveat: It's not always possible to do transform traditional orthography into pronunciation text across every language, especially on a language like English, where it is impossible to generate pronunciation based on written words. You must memorize individual cases in English, and in some other languages. However, some languages do have the ability to get pretty close to correct pronunciation based purely on the native spelling, which is pretty cool. Taking advantage of that fact here!

• Script detection.
• Romanization transliterations of scripts/languages in various forms.
• Structured script data, such as what are the vowels, etc..
• Keyboard layout data for various languages.

npm install @termsurf/text

Here are some API examples.

import detect from '@termsurf/text/detect'

detect([...'美丽的']) //=> { form: 'chinese', rank: 1 }

For these languages you can currently call make:

import make, {
  symbols,
  vowels,
  boundVowels,
  consonants,
} from '@termsurf/text/arabic'

make('جَمِيل') //=> "djami_l"

vowels.forEach(console.log)

import make from '@termsurf/text/chinese'

make('měi lì de') //=> "me\\/i li\\ tO"

import toWylie from '@termsurf/text/tibetan/wylie/to'
import fromWylie from '@termsurf/text/tibetan/wylie/from'

toWylie('རིག་པ་') //=> "rig pa"
fromWylie('rig pa') //=> "རིག་པ"

Take the generated TalkText (the ASCII output from the base make calls), and convert it into a more compact, human readable, "simplified" form.

import talk from '@termsurf/talk'

talk('rIg ph~a') //=> "ṙịg pɦa"

Take the generated TalkText and convert it into a format compatible with ToneText fonts.

import talk from '@termsurf/text/chinese'
import tone from '@termsurf/tone'

tone(talk('měi lì de')) //=> "me8i li6 tO"

...which is rendered as:

Here is a table explaining which languages we've looked at so far which can and can't have pronunciations automatically done.

MIT

This is being developed by the folks at TermSurf, a California-based project for helping humanity master information and computation. Find us on Twitter, LinkedIn, and Facebook. Check out our other GitHub projects as well!