Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ikeikeikeike/exromaji
A Elixir library for translating between hiragana, katakana, romaji and sound.
https://github.com/ikeikeikeike/exromaji
elixir katakana romaji
Last synced: 7 days ago
JSON representation
A Elixir library for translating between hiragana, katakana, romaji and sound.
- Host: GitHub
- URL: https://github.com/ikeikeikeike/exromaji
- Owner: ikeikeikeike
- License: mit
- Created: 2016-01-23T10:31:55.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-05-13T13:06:31.000Z (over 6 years ago)
- Last Synced: 2024-10-29T08:42:23.643Z (10 days ago)
- Topics: elixir, katakana, romaji
- Language: Elixir
- Homepage: https://github.com/ikeikeikeike/exromaji
- Size: 87.9 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - A Elixir library for translating between hiragana, katakana and romaji. (Translations and Internationalizations)
- fucking-awesome-elixir - exromaji - A Elixir library for translating between hiragana, katakana and romaji. (Translations and Internationalizations)
- awesome-elixir - exromaji - A Elixir library for translating between hiragana, katakana and romaji. (Translations and Internationalizations)
README
# Exromaji
[](http://travis-ci.org/ikeikeikeike/exromaji)
[](https://hex.pm/packages/exromaji)
[](https://hex.pm/packages/exromaji)
[](http://inch-ci.org/github/ikeikeikeike/exromaji)
[](https://github.com/ikeikeikeike/exromaji/blob/master/LICENSE)
A Elixir library for translating between hiragana, katakana, romaji and sound.
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed as:
1. Add exromaji to your list of dependencies in `mix.exs`:
```elixir
def deps do
[{:exromaji, "~> x.x"}]
end
```
2. Exromaji package needs `nkf` command and it needs to install that in your environment when you don't have `nkf`.
```zsh
$ brew install nkf
```
## Usage
Exromaji provides some convinient functions in Exromaji module through Exromaji.Translator and Exromaji.Table.
Those provided functions are able to translate into hiragana(ひらがな), katakana(カタカナ), romaji(ローマ字) and sound(五十音).
Into hiragana(ひらがな)
```Elixir
iex(1)> Exromaji.hiragana "ａ a A ア ｱ ァ ｧ あ ぁ 亜"
"あ あ あ あ あ ぁ ぁ あ ぁ 亜"
iex(2)> Exromaji.hiragana "ヒラガナ hiragana"
"ひらがな ひらがな"
```
Into katakana(カタカナ)
```Elixir
iex(3)> Exromaji.katakana "ａ a A ア ｱ ァ ｧ あ ぁ 亜"
"ア ア ア ア ア ァ ァ ア ァ 亜"
iex(4)> Exromaji.katakana "かたかな katakana"
"カタカナ カタカナ"
```
Into romaji(ローマ字)
```Elixir
iex(5)> Exromaji.romaji "ａ a A ア ｱ ァ ｧ あ ぁ 亜"
"a a a a a ァ ァ a ァ 亜"
iex(6)> Exromaji.romaji "ローマジ ろーまじ"
"ro-maji ro-maji"
```
Into sound(五十音)
```Elixir
iex(7)> Exromaji.sound "よろしく"
"や"
```
Those provided functions cannot detect Kanji(漢字) in translation working, like this.
```Elixir
iex(9)> Exromaji.romaji "ローマ字"
"ro-ma字"
```
```Elixir
iex(10)> Exromaji.sound "夜露死苦"
nil
```
However [exkanji package](https://github.com/ikeikeikeike/exkanji) are detecting Kanji(漢字). It also inspires a imitational interfaces from exromaji.
I suppose that you'll install [exkanji package](https://github.com/ikeikeikeike/exkanji) in your development as required.
```Elixir
iex(11)> Exkanji.romaji "ローマ字"
"ro-maji"
```
```Elixir
iex(12)> Exkanji.sound "夜露死苦"
"や"
```
[API Reference](http://hexdocs.pm/exromaji/api-reference.html).
## Inspiration
- [mojinizer](https://github.com/ikayzo/mojinizer)
- [romaji](https://github.com/makimoto/romaji)
- [kana](https://github.com/gojp/kana)