Nine Parsecs from Milwaukee

    @sanskrit-coders/sanscript

    1.2.0 • Public • Published

    Sanscript.js

    Introduction

    Sanscript is a transliteration library for Indian languages. It supports the most popular Indian scripts and several different romanization schemes. Although Sanscript focuses on Sanskrit transliteration, it has partial support for other languages and is easy to extend.

    Setup

    The package is officially distributed at npm here, whereas a variant due to Vikram Iyer is separately available here. So one can use commands such as:

    • npm install @sanskrit-coders/sanscript

    Usage

    Sanscript is simple to use:

    var output = Sanscript.t(input, from, to);

    Here, from and to are the names of different schemes. In Sanscript, the word "scheme" refers to both scripts and romanizations. These schemes are of two types:

    1. Brahmic schemes, which are abugidas. All Indian scripts are Brahmic schemes.
    2. Roman schemes, which are alphabets. All romanizations are Roman schemes.

    By default, Sanscript supports the following Brahmic schemes:

    ahom, assamese, avestan, balinese, bengali, bhaisuki, brahmi, brahmi_tamil, burmese, chakma, cham, cyrillic, devanagari, dogra, gondi_gunjala, gondi_masaram, grantha, grantha_pandya, gujarati, gurmukhi, hk, iast, itrans, itrans_dravidian, javanese, kannada, khamti_shan, kharoshti, khmer, khom_thai, khudawadi, kolkata, lao, lao_pali, lepcha, limbu, mahajani, malayalam, manipuri, marchen, modi, mon, mro, multani, newa, ol_chiki, oriya, persian_old, phags_pa, ranjana, rejang, rohingya, sanskritOCR, shan, sharada, siddham, sinhala, slp1, sora_sompeng, sundanese, syloti_nagari, tagalog, tagbanwa, tai_laing, takri, tamil, tamil_extended, tamil_superscripted, telugu, thai, tibetan, tirhuta_maithili, urdu, vattelutu, velthuis, wancho, warang_citi, wx, zanbazar_square

    of which the following are Roman schemes:

    • hk (Harvard-Kyoto)
    • iast (International Alphabet of Sanskrit Transliteration)
    • itrans (ITRANS)
    • itrans_dravidian (ITRANS with support for Dravidian short "e" and "o")
    • kolkata (National Library at Kolkata)
    • slp1 (Sanskrit Library Phonetic Basic)
    • velthuis (Velthuis)
    • wx (WX)
    • cyrillic

    Disabling transliteration

    When Sanscript sees the token ##, it toggles the transliteration state:

    Sanscript.t('ga##Na##pa##te', 'hk', 'devanagari'); // गNaपte
    Sanscript.t('ध##र्म##क्षेत्रे', 'devanagari', 'hk'); // dhaर्मkSetre

    When Sanscript sees the token \, it disables transliteration on the character that immediately follows. \ is used for ITRANS compatibility; we recommend always using ## instead.

    Sanscript.t('a \\a', 'itrans', 'devanagari'); // अ a
    Sanscript.t('\\##aham', 'itrans', 'devanagari'); // ##अहम्

    Transliterating to lossy schemes

    A lossy scheme does not have the letters needed to support lossless translation. For example, Bengali is a lossy scheme because it uses for both ba and va. In future releases, Sanscript might let you choose how to handle lossiness. For the time being, it makes some fairly bad hard-coded assumptions. Corrections and advice are always welcome.

    Transliteration options

    You can tweak the transliteration function by passing an options object:

    <script src="node_modules/@sanskrit-coders/sanscript/sanscript.js"></script>
    <script>
      var output = Sanscript.t(input, from, to, options);
    </script>

    options maps options to values. Currently, these options are supported:

    • skip_sgml - If true, transliterate SGML tags as if they were ordinary words (<b>iti</b><ब्>इति</ब्>). Defaults to false.
    • syncope - If true, use Hindi-style transliteration (ajayअजय). In linguistics, this behavior is known as schwa syncope. Defaults to false.

    Contributing

    Installing repo submodules

    If it is the first time you're cloning down the repo, you need to initialize the submodules. This only needs to be run once and never again.

    git submodule update --init --recursive

    If you want to pull in updates after this, you can just run:

    git submodule update --recursive

    Installing package dependencies

    npm install

    Adding new schemes

    Adding a new scheme is simple:

    Sanscript.addBrahmicScheme(schemeName, schemeData);
    Sanscript.addRomanScheme(schemeName, schemeData);

    For help in creating schemeData, see the comments on the addBrahmicScheme and addRomanScheme functions.

    Testing

    Prior to testing, run npm install so that the distribution file sanscript.js is generated at the root folder.

    We use qunit for testing. After installing dependencies, you can either:

    • run npm run test to run tests from the command line
    • open test/index.html to run tests in the browser

    Publishing to npm

    npm publish --access public

    Install

    npm i @sanskrit-coders/sanscript

    DownloadsWeekly Downloads

    50

    Version

    1.2.0

    License

    MIT

    Unpacked Size

    362 kB

    Total Files

    97

    Last publish

    Collaborators

    • vvasuki
    • vikramb
    • mbykov
    • akprasad