Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/greenlikeorange/knayi-myscript

Myanmar Language Script Library
https://github.com/greenlikeorange/knayi-myscript

burmese-nlp fontconvert fontdetect myanmar text-normalization unicode zawgyi

Last synced: about 2 months ago
JSON representation

Myanmar Language Script Library

Lists

README 

        
Knayi Myanmar Script

====================



[![NPM version][npm-image]][npm-url]

![][travis-url]

[![][david-image]][david-url]

![][dt-url]

![][license-url]



> Standalone Myanmar languages js library, to build Myanmar **Unicode** standard web.



## Announce on breaking API changes from 2.4.2 -> 2.5.0

- All throw Error are now become console.warn and console.error

- If _content not_ found happens, #fontConvert, #spellingCheck, #syllBreak all return empty string

- If _content not_ found happens, #fontDetect return fallback_font_type or 'en'

- You can set silent by setting `knayi.setGlobalOptions({silent_mode: true})`



## Node Version

 - Required node version >= 4  

 Note: From version >=2.3.0 build step will only support for node >=6



## Features

 - Detector (Unicode and Zawgyi)

 Detection now

 - Converter (Unicode and Zawgyi)

 - SyallBreak (Unicode and Zawgyi)

 - Spelling Check (Unicode and Zawgyi)

 - Truncate (Unicode and Zawgyi)

 - Normalization (Unicode only)



## Installation

Using npm

```bash

npm install knayi-myscript --save

```



Using yarn

```bash

yarn add knayi-myscript

```



Using CDN

```html



```



## API

|Method Name | Arguments | Return | Note |

| --- | --- | --- | --- |

| `fontDetect` | `content: String(require)`, 
`fallbackFontType:, options fontName(options)`, 
`options: Object(options)` | `String` | Font Detector, it will detect unicode/zawgyi of the **content** Text. If nothing is matched or possibility are equal, it will return as 'zawgyi' or specified font type in **fallbackFontType*, options* params. |

| `fontConvert` | `content: String(require)`,
`targetFontType: fontName(require)`,
`orignalFontType: fontName(optional)`| `String` | Converting font to target font type. This method need spelling fix, so it gonna use **spellingFix** in default. **convertFrom** will be detect by **fontDetect** when you don't described.
 `fontName` must be one of `unicode` or `zawgyi`. |

| `syllBreak` | `content: String(require)`,
`fontType: fontName(optional)`,
`breakPoint: String(optional)` | `String` |To make systematic word break of Myanmar text. convertFrom will be detect by fontDetect when you don't described.
 `fontName` must be one of `unicode` or `zawgyi`. |

| `spellingFix` | `content: String(require)`,
`fontType: fontName(optional)` | `String` | **convertFrom** will be detect by **fontDetect** when you don't described. It fix spelling on Myanmar Text.
 `fontName` must be one of `unicode` or `zawgyi`. |

| `truncate` | `content: String(require)`,
`options: Object` | `String` | Like lodash.truncate, it truncate word syllable and space. Default truncate length is 30 and you can change it in `options.length` |

| `normalize` | `content: String(require)` | `String` | Normalization solve some typing errors. Unlike `spellingFix`, this offer more appropriate way of doing so. But this function can only solve some level of normalization. |



## Usage



```javascript

// ES5 Way

var knayi = require('knayi-myscript')



// ES6 Way

import knayi from 'knayi-myscript'

```



## Example



- **fontDetect(content [, fallbackFontType [, options]])**

```javascript

knayi.fontDetect('မဂၤလာပါ') // zawgyi

knayi.fontDetect('မင်္ဂလာပါ') // unicode

```



- **fontConvert(content, targetFontType [, orignalFontType])**

```javascript

knayi.fontConvert('မဂၤလာပါ', 'unicode', 'zawgyi') // မင်္ဂလာပါ

knayi.fontConvert('မဂၤလာပါ', 'unicode') // မင်္ဂလာပါ

```



- **syllBreak(content [, fontType [, breakWord]])**

```javascript

knayi.syllBreak('မင်္ဂလာပါ', null, '$$')

// output: 'မင်္ဂလာ$$ပါ'

knayi.syllBreak('မင်္ဂလာပါ')

// output: 'မင်္ဂလာ\u200bပါ'

```



- **spellingFix(content [, fontType])**  

```javascript

knayi.spellingFix('မင်္ဂလာာပါါ') 

// output: 'မင်္ဂလာပါ'

```



- **truncate(content [, options])**

```javascript

knayi.truncate('အာယုဝဍ်ဎနဆေးညွှန်းစာကို ဇလွန်ဈေးဘေးဗာဒံပင်ထက် အဓိဋ္ဌာန်လျက် ဂဃနဏဖတ်ခဲ့သည်။', { length: 30, omission: '...' });

// output: "အာယုဝဍ်ဎနဆေးညွှန်းစာကို ဈေး..."

```

**options of truncate**

- `length: Number` default is 30

- `omission:String` default is '...'

- `fontType: String` it automatically detect if it not specified



- **normalize(content)**

```javascript

knayi.normalize('မိြုင်မိြုင်\nဆိုင်ဆုိင်')

// output: မြိုင်မြိုင်\nဆိုင်ဆိုင်

```



## Using googlei18n/myanmartools in detector.js



In default, knayi use own logic font dector rules, but you can choose knayi to use googlei18n/myanmartools`  

To do that, set `use_myanmartools` option to true. By default `use_myanmartools` option is set to `false`.



Example:: 

```javascript

// Add options for single process

knayi.fontDetect('မဂၤလာပါ', null, {use_myanmartools: true}) // this will use myanmartools

knayi.fontDetect('မင်္ဂလာပါ') // this will use default



// OR set for whole project

knayi.setGlobalOptions({

  detector: {

    use_myanmartools: true

  }

})

```



You can also set Probability threshold percentages of zawgyi predicting by

`myanmartools_zg_threshold` as `[lower, higher]`. Which mean if predicting

result of myanmartools is < 0.05 detector.js assume as **unicode** or > 0.95

it assume as **zawgyi**.



```javascript

knayi.fontDetect('မင်္ဂလာပါ', null, {

  use_myanmartools: true,

  myanmartools_zg_threshold: [0.05, 0.95]

})

```



## Debugging of font converting



Visit [http://greenlikeorange.github.io/knayi-myscript/#debug-mode](http://greenlikeorange.github.io/knayi-myscript/#debug-mode)

and select text to track how converting happened in background.



## Build



 - Required node >=6  

 - `npm run build`  

 To build production run `webpack -p`  



## License

[MIT](./LICENSE)



[npm-url]:https://npmjs.org/package/knayi-myscript

[npm-image]:https://badge.fury.io/js/knayi-myscript.png

[travis-url]:https://api.travis-ci.org/greenlikeorange/knayi-myscript.svg?branch=master

[david-url]:https://david-dm.org/greenlikeorange/knayi-myscript

[david-image]:https://david-dm.org/greenlikeorange/knayi-myscript.png

[dt-url]:https://img.shields.io/npm/dt/knayi-myscript.svg

[license-url]:https://img.shields.io/npm/l/knayi-myscript.svg