README

Introduction

Sanscript.php is a transliteration library for Indian languages written in PHP. 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.

Requirements

Sanscript requires PHP 5.4.8 and up. PHP versions before 5.4.8 have a version of mb_substr() that is known to be broken. These versions will not work with Sanscript.

Usage

Sanscript is simple to use.

First install the Composer package manager, then install Sanscript with:

composer require sanskrit/sanscript

then invoke Sanscript like this:

<?php

use Sanskrit\Sanscript;

$sanscript = new Sanscript();
$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:

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

By default, Sanscript supports the following Brahmic schemes:

bengali
devanagari
gujarati
gurmukhi
kannada
malayalam
oriya
tamil
telugu

and the following 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)

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 array:

$output = $sanscript->t($input, $from, $to, $options);

$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.

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.

Running tests

Running tests is facilitated with Composer:

1. cd /path/to/sanscript
2. composer install
3. ./vendor/bin/phpunit

sanskrit / sanscript

Maintainers

Details