Esperanto docs (#71)

* Create README.eo-eo.md * Update README.jp.md * Update README.md * Update README.eo-eo.md * Update README.zh-cn.md * Update README.zh-tw.md Co-authored-by: Hexen Qi <hexenq@gmail.com>
hexenq · Jun 6, 2021 · 6518d17 · 6518d17
1 parent 737d6bf
commit 6518d17
Show file tree

Hide file tree

Showing 5 changed files with 246 additions and 7 deletions.
diff --git a/README.eo-eo.md b/README.eo-eo.md
@@ -0,0 +1,239 @@
+![kuroshiro](https://kuroshiro.org/kuroshiro.png)
+
+# Kuroshiro
+
+[![Build Status](https://travis-ci.org/hexenq/kuroshiro.svg?branch=master)](https://travis-ci.org/hexenq/kuroshiro)
+[![Coverage Status](https://coveralls.io/repos/hexenq/kuroshiro/badge.svg)](https://coveralls.io/r/hexenq/kuroshiro)
+[![npm version](https://badge.fury.io/js/kuroshiro.svg)](http://badge.fury.io/js/kuroshiro)
+[![Join the chat at https://gitter.im/hexenq/kuroshiro](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/hexenq/kuroshiro)
+[![License](https://img.shields.io/github/license/lassjs/lass.svg)](LICENSE)
+
+la Kuroshiro estas Japanalingvo kodlibrejo por konverti Japanajn frazojn al Hiraganao, Katakanao aŭ Romaĝio, kaj ankaŭ subtenas furiganaon kaj okuriganaon.
+
+*Legi ĉi tion per aliaj lingvoj: [English](README.md), [日本語](README.jp.md), [简体中文](README.zh-cn.md), [繁體中文](README.zh-tw.md), [Esperanto](README.eo-eo.md).*
+
+## Ekzempla Paĝo
+Vidi la ekzemplan paĝon [ĉi tie](https://kuroshiro.org/#demo).
+
+## Elementoj
+- Japanalingva Frazo => Hiraganao, Katakanao aŭ Romaĝio
+- Furiganao kaj okuriganao modoj
+- 🆕Multaj lingvastrukturaj metodoj
+- 🆕Multaj romanaskriptkonvertaj sistemoj
+- Utilaj Japanalingvaj iloj
+
+## Gravaj Ŝanĝoj je 1.x
+- Aparta lingvasttrukturametoda ilo kaj fonetika notacia logiko por eblegi la uzaton de multaj lingvastrukturaj metodoj. ([finitaj iloj](#ready-made-analyzer-plugins) or [personigitaj iloj](CONTRIBUTING.md#how-to-submit-new-analyzer-plugins))
+- ES8/ES2017 por uzi "async/await" funkciojn
+- Uzu la modulon ES6 anstataŭ CommonJS
+
+## Finitaj Analizilaj (Lingvastrukturaj) Iloj
+*Antaŭ uzi ilon, bonvolu certiĝi pri mediakongrueco*
+| Analizilo | Node.js Uzadeblo | Retumilo Uzadeblo | Plugin Repo | Programisto |
+|---|---|---|---|---|
+|Kuromoji|✓|✓|[kuroshiro-analyzer-kuromoji](https://github.com/hexenq/kuroshiro-analyzer-kuromoji)|[Hexen Qi](https://github.com/hexenq)|
+|Mecab|✓|✗|[kuroshiro-analyzer-mecab](https://github.com/hexenq/kuroshiro-analyzer-mecab)|[Hexen Qi](https://github.com/hexenq)|
+|Yahoo Web API|✓|✗|[kuroshiro-analyzer-yahoo-webapi](https://github.com/hexenq/kuroshiro-analyzer-yahoo-webapi)|[Hexen Qi](https://github.com/hexenq)|
+
+## Uzado
+### Node.js (aŭ per "module bundler"-ilo (kiel Webpack))
+Instali per npm pako-administrilo:
+```sh
+$ npm install kuroshiro
+```
+
+Ŝargi la kodotekon:
+
+*Subtenas ambaŭ "ES6 Module" `import` kaj "CommonJS" `require`*
+```js
+import Kuroshiro from "kuroshiro";
+```
+
+Generi:
+```js
+const kuroshiro = new Kuroshiro();
+```
+
+Iniciati kuroshiro kun genero de analizilo (Rigardu la dokumenton [apidoc](#initanalyzer) por vidi pli da informo):
+```js
+// Por ĉi tiu ekzemplo, vi devus fari npm install kaj importi la "kuromoji" analizilon unue.
+import KuromojiAnalyzer from "kuroshiro-analyzer-kuromoji";
+
+// ...
+
+// Ŝargi
+// Ĉi tio uzas async/await, sed vi ankaŭ povus uzi Promise
+await kuroshiro.init(new KuromojiAnalyzer());
+```
+
+Konverti frazon:
+```js
+const result = await kuroshiro.convert("感じ取れたら手を繋ごう、重なるのは人生のライン and レミリア最高！", { to: "hiragana" });
+```
+
+### Retumilo
+Aldoni `dist/kuroshiro.min.js` al via "frontend-a projekto" (vi povas antaŭe kompili la originalan kodon per `npm run build` post `npm install`), kaj en via HTML:
+```html
+<script src="url/to/kuroshiro.min.js"></script>
+```
+
+Por fari kiel en ĉi ekzemplo, vi devas ankaŭ inkluzivi `kuroshiro-analyzer-kuromoji.min.js` kiu vi povas preni ĉe [kuroshiro-analyzer-kuromoji](https://github.com/hexenq/kuroshiro-analyzer-kuromoji)
+```html
+<script src="url/to/kuroshiro-analyzer-kuromoji.min.js"></script>
+```
+
+Ŝargi:
+```js
+var kuroshiro = new Kuroshiro();
+```
+
+Iniciati kuroshiro per ŝargo de analizilo, poste konverti:
+```js
+kuroshiro.init(new KuromojiAnalyzer({ dictPath: "url/to/dictFiles" }))
+    .then(function () {
+        return kuroshiro.convert("感じ取れたら手を繋ごう、重なるのは人生のライン and レミリア最高！", { to: "hiragana" });
+    })
+    .then(function(result){
+        console.log(result);
+    })
+```
+
+## API
+### Konstruilo
+__Ekzemploj__
+
+```js
+const kuroshiro = new Kuroshiro();
+```
+
+### Instancometodoj
+#### init(analyzer)
+Iniciati kuroshiro per instanco de analizilo. Vi devus unue importi analizilon kaj iniciati ĝin. Vi povas uzi la [finitaj-iloj](#ready-made-analyzer-plugins) skribita supre. Bonvole rigardu la analizilan dokumentaron por vidi instrukciojn.
+
+__Argumentoj__
+
+* `analyzer` - Instanco de Analizilo.
+
+__Ekzemploj__
+
+```js
+await kuroshiro.init(new KuromojiAnalyzer());
+```
+
+#### convert(str, [options])
+Konverti frazon al cela skribsistemo (kun agordoj)
+
+__Argumentoj__
+
+* `str` - Konvertvola Frazo.
+* `options` - *Optional* kuroshiro havas multajn frazajn konvertagordojn.
+
+| Agordoj | Tipo | Defaŭlto | Informo |
+|---|---|---|---|
+| to | String | "hiragana" | Target syllabary [`hiragana`, `katakana`, `romaji`] |
+| mode | String | "normal" | Convert mode [`normal`, `spaced`, `okurigana`, `furigana`] |
+| romajiSystem<sup>*</sup> | String | "hepburn" | Romanization system [`nippon`, `passport`, `hepburn`] |
+| delimiter_start | String | "(" | Delimiter(Start) |
+| delimiter_end | String | ")" | Delimiter(End) |
+
+**: Param `romajiSystem` estas uzata sole kiam parametro `to` estas `romaji`. Por vidi plie, rigardu [Romanaskriptkonvertaj Sistemoj](#romanization-system)*
+
+__Ekzemploj__
+
+```js
+// normal
+await kuroshiro.convert("感じ取れたら手を繋ごう、重なるのは人生のライン and レミリア最高！", {mode:"okurigana", to:"hiragana"});
+// rezulto：かんじとれたらてをつなごう、かさなるのはじんせいのライン and レミリアさいこう！
+```
+
+```js
+// spaced
+await kuroshiro.convert("感じ取れたら手を繋ごう、重なるのは人生のライン and レミリア最高！", {mode:"okurigana", to:"hiragana"});
+// rezulto：かんじとれ たら て を つなご う 、 かさなる の は じんせい の ライン   and   レミ リア さいこう ！
+```
+
+```js
+// okurigana
+await kuroshiro.convert("感じ取れたら手を繋ごう、重なるのは人生のライン and レミリア最高！", {mode:"okurigana", to:"hiragana"});
+// rezulto: 感(かん)じ取(と)れたら手(て)を繋(つな)ごう、重(かさ)なるのは人生(じんせい)のライン and レミリア最高(さいこう)！
+```
+
+<pre>
+// furigana
+await kuroshiro.convert("感じ取れたら手を繋ごう、重なるのは人生のライン and レミリア最高！", {mode:"furigana", to:"hiragana"});
+// rezulto: <ruby>感<rp>(</rp><rt>かん</rt><rp>)</rp></ruby>じ<ruby>取<rp>(</rp><rt>と</rt><rp>)</rp></ruby>れたら<ruby>手<rp>(</rp><rt>て</rt><rp>)</rp></ruby>を<ruby>繋<rp>(</rp><rt>つな</rt><rp>)</rp></ruby>ごう、<ruby>重<rp>(</rp><rt>かさ</rt><rp>)</rp></ruby>なるのは<ruby>人生<rp>(</rp><rt>じんせい</rt><rp>)</rp></ruby>のライン and レミリア<ruby>最高<rp>(</rp><rt>さいこう</rt><rp>)</rp></ruby>！
+</pre>
+
+### Utilaĵoj
+
+__Ekzemploj__
+```js
+const result = Kuroshiro.Util.isHiragana("あ"));
+```
+#### isHiragana(char)
+Determini se enigita litero estas hiragana.
+
+#### isKatakana(char)
+Determini se enigita litero estas katakana.
+
+#### isKana(char)
+Determini se enigita litero estas kana.
+
+#### isKanji(char)
+Determini se enigita litero estas kanĵio.
+
+#### isJapanese(char)
+Determini se enigita litero estas Japanolingva.
+
+#### hasHiragana(str)
+Determini se enigita frazo enhavas hiraganan.
+
+#### hasKatakana(str)
+Determini se enigita frazo enhavas katakanan.
+
+#### hasKana(str)
+Determini se enigita frazo enhavas kanan.
+
+#### hasKanji(str)
+Determini se enigita frazo enhavas kanĵion.
+
+#### hasJapanese(str)
+Determini se enigita frazo enhavas Japanolingvajn Frazojn.
+
+#### kanaToHiragna(str)
+Konverti enigitan kanan frazon al hiragana
+
+#### kanaToKatakana(str)
+Konverti enigitan kanan frazon al katakana.
+
+#### kanaToRomaji(str, system)
+Konverti enigitan kanan frazon al romaĝio. Param `system` povas enhavi `"nippon"`, `"passport"`, `"hepburn"` (Defaŭlta: "hepburn").
+
+## Romanaskriptkonvertaj Sistemoj
+kuroshiro povas uzi tri da Romanaskriptkonvertajn Sistemojn.
+
+`nippon`: Nippon-shiki sistemo. Rigardu [ISO 3602 Strict](http://www.age.ne.jp/x/nrs/iso3602/iso3602.html).
+
+`passport`: Passport-shiki sistemo. Rigardu [Japanese romanization table](https://www.ezairyu.mofa.go.jp/passport/hebon.html) de la "Japana Ministerio de Eksteraj Aferoj".
+
+`hepburn`: Hepburn sistemo. Rigardu [BS 4812 : 1972](https://archive.is/PiJ4).
+
+Por vidi la malsamecoj de la tri sistemoj, rigardu [webpage](http://jgrammar.life.coocan.jp/ja/data/rohmaji2.htm).
+
+### Informo pri Romaĝia Konvertado
+Ne eblas tute konverti __furigana__ precize al __romaĝio__ ĉar furigana ne enhavas kompletan prononcan informon, (Rigardu [なぜ フリガナでは ダメなのか？](https://green.adam.ne.jp/roomazi/onamae.html#naze)) do kuroshiro ne konvertas chōon dum konvertado el furigana (kana) -> romaĝio je ĉiom da sistemoj (Sed, Chōonpu ĉiam konvertas) 
+
+*Ekzemple, vi vidos "kousi", "koushi", "koushi" dum kana konvertado de "こうし" al romaĝio 
+kiam vi uzas `nippon`, `passport`, `hepburn` sistemojn respektive*
+
+Kanĝip -> romaĝio konvertado __ne estas afektita__.
+
+## Kontribui
+Rigardu [CONTRIBUTING](CONTRIBUTING.md).
+
+## Inspiroj
+- kuromoji
+- wanakana
+
+## Licenco
+MIT
diff --git a/README.jp.md b/README.jp.md
@@ -10,7 +10,7 @@
 
 kuroshiroは日本語文をローマ字や仮名なとに変換できるライブラリです。フリガナ・送り仮名の機能も搭載します。
 
-*ほかの言語：[English](README.md), [日本語](README.jp.md), [简体中文](README.zh-cn.md), [繁體中文](README.zh-tw.md)。*
+*ほかの言語：[English](README.md), [日本語](README.jp.md), [简体中文](README.zh-cn.md), [繁體中文](README.zh-tw.md), [Esperanto](README.eo-eo.md)。*
 
 ## デモ
 オンラインデモは[こちら](https://kuroshiro.org/#demo)です。
@@ -237,4 +237,4 @@ kuroshiroは三種類のローマ字表記法をサポートします。
 - wanakana
 
 ## ライセンス
-MIT
+MIT
diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@
 
 kuroshiro is a Japanese language library for converting Japanese sentence to Hiragana, Katakana or Romaji with furigana and okurigana modes supported.
 
-*Read this in other languages: [English](README.md), [日本語](README.jp.md), [简体中文](README.zh-cn.md), [繁體中文](README.zh-tw.md).*
+*Read this in other languages: [English](README.md), [日本語](README.jp.md), [简体中文](README.zh-cn.md), [繁體中文](README.zh-tw.md), [Esperanto](README.eo-eo.md).*
 
 ## Demo
 You can check the demo [here](https://kuroshiro.org/#demo).

diff --git a/README.zh-cn.md b/README.zh-cn.md
@@ -11,7 +11,7 @@
 kuroshiro是一款十分方便使用的日文转换注音工具，主要针对日文文本，进行到平假名、片假名及罗马字的转换，并支持注音假名、送假名
 （旁注音）等注音模式。
 
-*其他说明语言：[English](README.md), [日本語](README.jp.md), [简体中文](README.zh-cn.md), [繁體中文](README.zh-tw.md)。*
+*其他说明语言：[English](README.md), [日本語](README.jp.md), [简体中文](README.zh-cn.md), [繁體中文](README.zh-tw.md), [Esperanto](README.eo-eo.md)。*
 
 ## 演示
 你可以在[这里](https://kuroshiro.org/#demo)查看在线演示。
@@ -238,4 +238,4 @@ kuroshiro支持三种罗马字体系。
 - wanakana
 
 ## 版权说明
-MIT
+MIT
diff --git a/README.zh-tw.md b/README.zh-tw.md
@@ -11,7 +11,7 @@
 kuroshiro是一款十分方便使用的日文轉換注音工具，主要針對日文文本，進行到平假名、片假名及羅馬字的轉換，並支持注音假名、送假名
 （旁註音）等注音模式。
 
-*其他說明語言：[English](README.md), [日本語](README.jp.md), [簡體中文](README.zh-cn.md), [繁體中文](README.zh-tw.md)。*
+*其他說明語言：[English](README.md), [日本語](README.jp.md), [簡體中文](README.zh-cn.md), [繁體中文](README.zh-tw.md), [Esperanto](README.eo-eo.md)。*
 
 ## 演示
 你可以在[這裡](https://kuroshiro.org/#demo)查看在線演示。
@@ -238,4 +238,4 @@ kuroshiro支持三種羅馬字體系。
 - wanakana
 
 ## 版權說明
-MIT
+MIT