Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/foreverbell/parakeet
Hepburn Romaji + Japanese lexical analysis & texifier.
https://github.com/foreverbell/parakeet
haskell hepburn-romanization japanese
Last synced: about 2 months ago
JSON representation
Hepburn Romaji + Japanese lexical analysis & texifier.
- Host: GitHub
- URL: https://github.com/foreverbell/parakeet
- Owner: foreverbell
- License: mit
- Created: 2015-08-10T01:12:19.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-07-01T14:22:15.000Z (over 8 years ago)
- Last Synced: 2023-04-05T20:07:44.983Z (almost 2 years ago)
- Topics: haskell, hepburn-romanization, japanese
- Language: Haskell
- Homepage: https://foreverbell.github.io/parakeet/
- Size: 1.05 MB
- Stars: 10
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# parakeet
## Disclaimer
I know **nothing** about parsing, Haskell and Japanese. This repository is purely for fun, and serving as a test-bed for some Haskell experiments.
## Introduction
Build the most convenient tool for Japanese beginners!
Input:
* https://raw.githubusercontent.com/foreverbell/parakeet/master/test-suite/Butter-fly/Butter-fly.j
* https://raw.githubusercontent.com/foreverbell/parakeet/master/test-suite/Butter-fly/Butter-fly.r
Output:
Full output:
* tex: https://raw.githubusercontent.com/foreverbell/miscellaneous/master/resource/parakeet/Butter-fly.tex
* pdf: https://raw.githubusercontent.com/foreverbell/miscellaneous/master/resource/parakeet/Butter-fly.pdf
Romaji should follow [Hepburn romanization](https://en.wikipedia.org/wiki/Hepburn_romanization).
For an experimential online demo powered by GHCJS, see [here](https://foreverbell.github.io/parakeet) for more details.
## Installation
To build, at least ghc **7.10.2** is required.
```bash
$ cabal install parakeet.cabal
```
For stack users,
```bash
$ stack init
$ stack install
```
or
```bash
$ stack install --stack-yaml=stack-ghcjs.yaml
```
if you want to compile to JavaScript.
## Development
```bash
$ cabal sandbox init
$ cabal install --only-dependencies
$ cabal build
```
## Usage
* XeLaTex package dependencies: xeCJK, ruby
* Font dependencies: MS Mincho, MS Gothic
```bash
$ parakeet -j Butter-fly.j -r Butter-fly.r -o Butter-fly.tex
$ xelatex Butter-fly.tex
```
or directly,
```bash
$ parakeet -j Buffer-fly.j -r Buffer-fly.r -o Buffer-fly.pdf
```
You should guarantee that the two input files are encoded in UTF-8.
## Limitations
* The parsing algorithm is essentially LL(infinity), it is an exponential algorithm of course! So the program may get extremely slow when there is a mistake in a long line of romaji. A proper use of separator `$` can avoid this trap.
* The long vowel `ō` is ambiguous in Hepburn romanization, which is interpreted to `ou` or `oo`. To resolve this, we always pick the former one. For example, `東京(Tōkyō)` is correctly translated to `とうきょう`, while `大阪(Ōsaka)` is wrongly translated to `おうさか`.
* There are two `zu`s and `ji`s in romanization, namely `ずづ` and `じぢ` in hiragana respectively. We always pick `ずじ` when translating `zu` and `ji` into furigana. If you want `づぢ`, use `du(dzu)` and `di(dji)` instead.
* Unfriendly parse error message.
## Document
Since I haven't find any potential users, so there will be no document available, please create an issue if you have trouble using it.
## TODO List
* Ambiguous `ō` warning.
* Extended katakana support.
* Wiki for Japanese lexical rules.