Skip to content

A simple, Unified English Braille (UEB) Grade 1 library [Old WIP]

License

Notifications You must be signed in to change notification settings

djalilhebal/br6

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Br6

A simple, Unified English Braille (UEB) Grade 1 library [old WIP]

Br6 = 6-dot Braille

Usage

Installing:

npm install br6

Example:

const {toBrailleText, toAlphabetText} = require('br6');

const sentence = 'Lewis CARROLL published "ALICE IN WONDERLAND" in 1865. ^~^';
const inBraille = toBrailleText(sentence);
// '⠠⠇⠑⠺⠊⠎⠀⠠⠠⠉⠁⠗⠗⠕⠇⠇⠀⠏⠥⠃⠇⠊⠎⠓⠑⠙⠀⠦⠠⠠⠠⠁⠇⠊⠉⠑⠀⠊⠝⠀⠺⠕⠝⠙⠑⠗⠇⠁⠝⠙⠠⠄⠴⠀⠊⠝⠀⠼⠁⠓⠋⠑⠲⠀⠤⠤⠤'
const inAlphabet = toAlphabetText(inBraille);
// 'Lewis CARROLL published “ALICE IN WONDERLAND” in 1865. ---'

Learning Braille

These are the resources I used and liked:

How It Works

Legend: ORANGE MEANS CHANGE; GREEN MEANS ADDITION. The GitHub Pages' version displays colors correctly.

  • Starting with a text like this:

Lewis CARROLL published "ALICE IN WONDERLAND" in 1865. ^~^

  • Convert straight quotation marks to curly ones

Lewis CARROLL published ALICE IN WONDERLAND in 1865. ^~^

  • Replace (yet) unsupported characters with "-"

Lewis CARROLL published “ALICE IN WONDERLAND” in 1865. ---

  • Add capital indicators and terminators, then lowercase everything

Lewis CARROLL published “⠠⠠⠠alice in wonderland⠠⠄” in 1865. ---

Lewis ⠠⠠carroll published “⠠⠠⠠alice in wonderland⠠⠄” in 1865. ---

lewis ⠠⠠carroll published “⠠⠠⠠alice in wonderland⠠⠄” in 1865. ---

  • Add numeric indicators and translate numbers

⠠lewis ⠠⠠carroll published “⠠⠠⠠alice in wonderland⠠⠄” in ⠁⠓⠋⠑. ---

  • Using a map, convert the remaining characters to Braille

⠇⠑⠺⠊⠎⠀⠠⠠⠉⠁⠗⠗⠕⠇⠇⠀⠏⠥⠃⠇⠊⠎⠓⠑⠙⠀⠦⠠⠠⠠⠁⠇⠊⠉⠑⠀⠊⠝⠀⠺⠕⠝⠙⠑⠗⠇⠁⠝⠙⠠⠄⠴⠀⠊⠝⠀⠼⠁⠓⠋⠑⠲⠀⠤⠤⠤

  • And there you have it:

⠠⠇⠑⠺⠊⠎⠀⠠⠠⠉⠁⠗⠗⠕⠇⠇⠀⠏⠥⠃⠇⠊⠎⠓⠑⠙⠀⠦⠠⠠⠠⠁⠇⠊⠉⠑⠀⠊⠝⠀⠺⠕⠝⠙⠑⠗⠇⠁⠝⠙⠠⠄⠴⠀⠊⠝⠀⠼⠁⠓⠋⠑⠲⠀⠤⠤⠤

TODO

  • Either handle letters with accents/diacritics, or remove them (Téle -> Tele)
  • Support contractions and wordsigns
  • ...

License

CC0

About

A simple, Unified English Braille (UEB) Grade 1 library [Old WIP]

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published