vbarzokas / greek-utils

A JavaScript library for Greek language with utilities such as replacement of accented and other diacritics characters, conversion from Greek to phonetic, transliterated or greeklish Latin and more.

Greek Utilities

A JavaScript library for Greek language with utilities such as replacement of accented and other diacritics characters, conversion from Greek to phonetic, transliterated or greeklish Latin and more, like Greek stopwords removal.

Installation

npm install --save greek-utils

Usage

Node.js

var greekUtils = require('greek-utils');

- sanitizeDiacritics(text, [ignoreCharacters])

Convert all diacritics symbols to their simple equivalent

Example 1 (modern Greek):

var sanitized = greekUtils.sanitizeDiacritics('Αρνάκι άσπρο και παχύ');
console.log(sanitized); //Αρνακι ασπρο και παχυ

Example 2 (ancient Greek):

var sanitized = greekUtils.sanitizeDiacritics('Ἐξ οὗ καὶ δῆλον ὅτι οὐδεμία τῶν ἠθικῶν ἀρετῶν φύσει ἡμῖν ἐγγίνεται');
console.log(sanitized); //Εξ ου και δηλον οτι ουδεμια των ηθικων αρετων φυσει ημιν εγγινεται

- toGreek(text, [ignoreCharacters])

Convert a Latin character text to its modern Greek equivalent

Example:

var greek = greekUtils.toGreek('kalhmera, pws eiste?');
console.log(greek); //καλημερα, πως ειστε;

- toGreeklish(text, [ignoreCharacters])

Convert a modern Greek character text to its greeklish equivalent

Example:

var greeklish = greekUtils.toGreeklish('Εύηχο: αυτό που ακούγεται ωραία.');
console.log(greeklish); //Euhxo: auto pou akougetai wraia.

- toPhoneticLatin(text, [ignoreCharacters])

Convert a modern Greek character text to its phonetically equivalent Latin (sound mapping).

Example:

var phoneticLatin = greekUtils.toPhoneticLatin('Εύηχο: αυτό που ακούγεται ωραία.');
console.log(phoneticLatin); //Évikho: aftó pou akoúyete oréa.

- toTransliteratedLatin(text, [ignoreCharacters])

Convert a modern Greek character text to its transliterated equivalent Latin (letter mapping).

Example:

var transliteratedLatin = greekUtils.toTransliteratedLatin('Εύηχο: αυτό που ακούγεται ωραία.');
console.log(transliteratedLatin); //Eúēkho: autó pou akoúgetai ōraía.

Ignoring characters

All of the above functions accept an optional second parameter as a string with characters you don't wish to be converted.

Example:

var greeklish = greekUtils.toGreeklish('καλημερα, πως ειστε;', 'ε');
console.log(greeklish); //kalhmεra, pws εistε?

- removeStopWords(text, [shouldRemoveMultipleWhiteSpaces])

Remove all stop words from the given text, for both ancient and modern Greek. Also accepts an optional flag, which when set to true will remove the multiple whitespaces that probably have occurred in the text after removing the stop words.

Note: The default value for that flag is false, so multiple whitespaces are expected to be returned.

Examples:

• Without stripping the extra white spaces:

  var withPreservedWhitespace = greekUtils.removeStopWords('Αυτή είναι μια απλή πρόταση, που δείχνει την αφαίρεση όλων των stopwords της αρχαίας και νέας Ελληνικής γλώσσας και επιστρέφει το καθαρό κείμενο.', false);
  
  console.log(withPreservedWhitespace); //μια απλή πρόταση,  δείχνει  αφαίρεση όλων  stopwords  αρχαίας  νέας Ελληνικής γλώσσας  επιστρέφει  καθαρό κείμενο.

• With stripping the extra white spaces:

  var withoutPreservedWhitespace = greekUtils.removeStopWords('Αυτή είναι μια απλή πρόταση, που δείχνει την αφαίρεση όλων των stopwords της αρχαίας και νέας Ελληνικής γλώσσας και επιστρέφει το καθαρό κείμενο.', true);
  
  console.log(withoutPreservedWhitespace); //μια απλή πρόταση, δείχνει αφαίρεση όλων stopwords αρχαίας νέας Ελληνικής γλώσσας επιστρέφει καθαρό κείμενο.

greek-utils's Issues

Suggestion - ELOT 743

Hello everyone,

I want to suggest a new function based on the Greek Standard, ELOT 743 which is recognised by the EU.

Current Function

var greeklish = greekUtils.toGreeklish('Εύηχο: αυτό που ακούγεται ωραία.');
console.log(greeklish); //Euhxo: auto pou akougetai wraia.

Suggested Function (to Add)

var greeklish = greekUtils.toGreeklishELOT743('Εύηχο: αυτό που ακούγεται ωραία.');
console.log(greeklish); // Evicho: afto pou akougetai oraia.

Goverment App for Translation

Standard Documentation (in greek)

---

If i understand correctly, the mapping is working based on find/replace objects.
We also need to sanitize the string which is already a function.

I will do my best to provide a greek-to-greeklish-elot743-map.js.

Regards,
Alex

Suggestion

Can you do a greek to English translation method?

Capital Π is replaced with lower p (greek to greeklish)

The capital Π is replaced with lower p when converted from greek to greelish.
The capital Π must be replaced with capital P.
Thanks you.
Nice project.

Doesn't covert punctuation and translation isn't quite right

Hey love your work, would like the punctation to change too though:

const greekUtils = require('greek-utils')
const text = greekUtils.toGreeklish('Παρακαλώ;')
console.log(text)

Expected: parakaló?
Actual: parakalw;

I had a quick search for this as reference: https://billmounce.com/greekalphabet/greek-punctuation-syllabification as well as google translate