Docs
Documentation
Guides for integrating Interscript, writing maps, and running the phonological layer.
Getting started
Interscript runs in Ruby, TypeScript, and Python. All consume the same authority-backed maps. An optional phonological layer (secryst crystals + the interscript-ml contract) recovers vowels and phonemes when a map needs vocalized input.
Ruby
gem install interscript
interscript -s bgnpcgn-ukr-Cyrl-Latn-2019 <<< "Антон"
# => AntonTypeScript
npm install interscript-tsimport { transliterate } from "interscript-ts"
transliterate("bgnpcgn-ukr-Cyrl-Latn-2019", "Антон")
// => "Anton"Phonological layer
gem install secryst
# or: pip install secryst / npm i secrystAll docs
- Integration with Ruby Applications Interscript can be used as a Ruby Gem library to be integrated with other Ruby applications. == Gemfile
- Interscript Map format syntax This document describes the DSL-based files with an extension `.iml` or `.imp`. An `.imp` file is a file containing a standalone transliteration map. For instance, a map that can transliterate a Korea…
- Maintainers This is a documentation intended for Interscript maintainers. It covers all possible tasks one may need to execute. == Releasing
- Interscript map editing guide Transliteration systems stored in a `maps/maps/` directory as Interscript Map files. You can create a new file and add it to the directory. The file should be named as `<system-code>.imp`, where `syst…
- Usage with Rababa RABABA is the Arabic Diacritization Library that uses Machine Learning to predict missing diactricts. It is well integrated with Interscript.
- Usage with Secryst Secryst is a seq2seq transformer suited for transliteration. Written in Ruby. It's installation is a bit tricky, you should consult its own installation guide (at GitHub). By default we don't use Secr…
Source
GitHub monorepo tracks the project architecture and TODO list.
Map corpus holds the 300+ `.imp` files; each one is human-readable Ruby DSL.