Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/michaeltroger/latin-to-cyrillic
A Kotlin Multiplatform Library for Latin to Cyrillic transliteration
https://github.com/michaeltroger/latin-to-cyrillic
converter cyrillic-scripts kotlin kotlin-android kotlin-multiplatform latin-script library transliteration transliterator
Last synced: 16 days ago
JSON representation
A Kotlin Multiplatform Library for Latin to Cyrillic transliteration
- Host: GitHub
- URL: https://github.com/michaeltroger/latin-to-cyrillic
- Owner: michaeltroger
- License: mit
- Created: 2021-10-08T22:48:23.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-03-05T15:43:07.000Z (almost 3 years ago)
- Last Synced: 2024-05-01T19:59:50.195Z (8 months ago)
- Topics: converter, cyrillic-scripts, kotlin, kotlin-android, kotlin-multiplatform, latin-script, library, transliteration, transliterator
- Language: Kotlin
- Homepage:
- Size: 130 KB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Latin To Cyrillic Kotlin Multiplatform Library
## Cyrillic Transliteration
[](https://github.com/michaeltroger/latin-to-cyrillic/actions/workflows/ci.yml) [](https://repo1.maven.org/maven2/com/michaeltroger/)
A library for converting text from Latin script to Cyrillic script and vice versa. Can be compiled for JVM/Android, JavaScript, Desktop Native and iOS.
Simple to use and modern Coroutine based API. Used by the popular [Cyrillic Transliterator Android app](https://github.com/michaeltroger/latintocyrillic-android).
Supported alphabets:
- Serbian Azbuka
- Belarusian (ISO 9:1995)
- Bulgarian (ISO 9:1995)
- Macedonian (ALA-LC)
- Macedonian (ISO 9:1995)
- Russian (ISO 9:1995)
- Ukrainian (ISO 9:1995)
- Custom alphabet (see further down for details)
### Add dependency for your platform:
```
dependencies {
// Android / Kotlin Multiplatform (commonMain):
implementation 'com.michaeltroger:latin-to-cyrillic:1.0.0'
// Java Virtual Machine:
implementation 'com.michaeltroger:latin-to-cyrillic-jvm:1.0.0'
// JavaScript:
implementation 'com.michaeltroger:latin-to-cyrillic-js:1.0.0'
// Kotlin Native:
implementation 'com.michaeltroger:latin-to-cyrillic-native:1.0.0'
}
```
Note that you will also need to add a dependency to [Coroutines](https://github.com/Kotlin/kotlinx.coroutines).
### Usage in Kotlin Android:
```
val latinCyrillic = LatinCyrillicFactory.create(Alphabet.Serbian)
// Inside a Coroutine:
val cyrillic = latinCyrillic.latinToCyrillic("Bolje") // returns "Боље"
val latin = latinCyrillic.cyrillicToLatin("Боље") // returns "Bolje"
```
You can also check whether a text is considered Cyrillic:
```
latinCyrillic.isCyrillic("Bolje") // returns false
latinCyrillic.isCyrillic("Боље") // returns true
```
Furthermore you can print the entire, active conversion table:
```
latinCyrillic.getLatinAlphabet() // returns listOf("A","B","C", ...)
latinCyrillic.getCyrillicAlphabet() // returns listOf("А","Б","Ц", ...)
```
You can make use of the custom alphabet factory to use a fully custom conversion table:
```
LatinCyrillicFactory.create(latin = listOf("A","B","C"), cyrillic = listOf('А','Б','Ц'))
```
The limitation here is that a latin letter may be described by 1 or 2 characters and a cyrillic letter by 1 character.
### Adding new alphabets
You are free to open Pull requests for adding more alphabets, but I ask for your understanding that I only integrate unambiguous conversion tables. E.g. with transcription tables you can only transcript from one script to the other, but not back to the original one! That's why this lib only includes a limited set of transliteration alphabets.
Any new alphabet should be an official standard and allow conversion forth and back. This is mostly only possible for ISO 9:1995 standards. Another limitation coming from the business logic is that Latin letters may have 1 or 2 characters, while Cyrillic letters may only have 1. In doubts please contact me upfront before investing too much time. Anyways you can always use a custom alphabet, so the alphabet you use doesn't necessarilly need to be part of the lib here.
Author:
[Michael Troger](https://michaeltroger.com)