https://github.com/trismegiste/hiragana

A converter from Hepburn notation (or approximation) to Hiragana
https://github.com/trismegiste/hiragana

Last synced: 4 days ago
JSON representation

A converter from Hepburn notation (or approximation) to Hiragana

• Host: GitHub
• URL: https://github.com/trismegiste/hiragana
• Owner: Trismegiste
• Created: 2013-09-12T10:25:37.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2013-10-19T09:11:19.000Z (about 11 years ago)
• Last Synced: 2024-11-10T15:16:14.740Z (2 months ago)
• Language: Prolog
• Size: 148 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Hepburn to Hiragana

A converter from Hepburn notation (or approximation) to Hiragana

## What

This is a PHP 5.4 library for converting japanese words written in **Hepburn** notation(s) 

(i.e in western letters) to **hiragana** phonetic letters.

```

nippon => にっぽん

toukyou => とうきょう

shinjuku => しんじゅく

shinjyuku => しんじゅく

taishakuten => たいしゃくてん

```

## Why

This tool was primarily designed for massive conversion of japanese first and last names from

a database, it is NOT intended to convert or translate full text with foreign words.

It does not support katakana nor foreign phonem like 'fa', 'va' or old stuff

like 'wi' or 'we'. If you have single quote in word (like the first name 

Jun'ichiro), split the string. Convert all letters to lower case.

Since Hepburn translation is not a bijection, the converter returns an array 

with zero, one or many solutions. 

## How

### Install it

git clone & composer install are your friends

### Using it

```php

use Trismegiste\Hiragana\Converter;

use Trismegiste\WamBundle\Prolog\WAMService;

$obj = new Converter(new WAMService());

$result = $obj->toHiragana("suiseiseki");

echo $result[0];

// outputs 'すいせいせき'

```

The initialisation of this Converter is very slow because it compiles a **Prolog**

program, but for a batch converter, it's not an issue. If you want to convert

names within a web environment, I suggest you to compile the prolog code into WAM

code and cache it.

There is a CLI demo :

```

$ php demo.php sakurazukamori

Array

(

    [0] => さくらづかもり

    [1] => さくらずかもり

)

```

## Where

Since this tool is full utf-8, don't expect to output hiragana in the crappy

console of Windows(c)(r)(tm).

## Unit tests

Simply run with :

```

$ phpunit

```