@vm75/inditrans 0.13.0 → 0.14.0

package/README.md

@@ -22,10 +22,17 @@ Khmer, Malayalam, Oriya, Sinhala, Tamil, Tamil-Extended, Telugu, Thai, Tibetan
 [IAST](https://en.wikipedia.org/wiki/International_Alphabet_of_Sanskrit_Transliteration) ·
 [IPA](https://en.wikipedia.org/wiki/International_Phonetic_Alphabet) ·
 [ISO 15919](https://en.wikipedia.org/wiki/ISO_15919) ·
-[ITRANS](https://en.wikipedia.org/wiki/ITRANS) ·
+[ITRANS](https://www.aczoom.com/itrans/) ·
 [TITUS](https://titus.uni-frankfurt.de/indexe.htm) ·
 ReadableLatin
 
+### ITRANS notation notes
+
+`inditrans` implements uniform phonemic vowel mapping adhering to the [ITRANS specification](https://www.aczoom.com/itrans/):
+- **Short vowels**: `e` and `o` encode short vowels (e.g. Kannada `ಎ` / `ೆ`, Telugu `ఎ` / `ె`, Tamil `எ` / `ெ`, Malayalam `എ` / `െ`, Devanagari `ऎ` / `ॆ`). `^e` and `^o` remain supported as aliases.
+- **Long vowels**: `E` and `O` encode long vowels (e.g. Kannada `ಏ` / `ೇ`, Telugu `ఏ` / `ే`, Tamil `ஏ` / `ே`, Malayalam `ഏ` / `േ`, Devanagari `ए` / `े`).
+- Examples: `te` $\to$ `तॆ` / `ತೆ`, `tE` $\to$ `ते` / `ತೇ`; `tere bina` $\to$ `ತೆರೆ ಬಿನ` (Kannada), `tErE bina` $\to$ `ತೇರೇ ಬಿನ` (Kannada) / `तेरे बिन` (Devanagari).
+
 ## Requirements
 
 - Node.js ≥ 18.3 (or modern browser with WebAssembly support)
@@ -91,6 +98,9 @@ Returns `true` when the given script name is recognised.
 | `Option.IgnoreVedicAccents` | `8` | Strip Vedic accent markers |
 | `Option.RetainSpecialMarkers` | `16` | Keep non-standard character markers |
 | `Option.NoXMLTagHandling` | `32` | Treat XML/HTML tags as plain text |
+| `Option.DisableInference` | `64` | Disable anuswara assimilation and contextual Tamil pronunciation/letter inference |
+
+For Tamil **source** text, `Option.TamilSuperscripted` automatically enables `DisableInference`. The same flag on Tamil **output** does not disable inference. When disabled, a mapped anuswara spelling is emitted rather than assimilated to the next consonant.
 
 Combine flags with the bitwise OR operator: `Option.IgnoreVedicAccents | Option.TamilSuperscripted`.
 

package/dist/src/Option.d.ts

@@ -5,5 +5,6 @@ export declare enum Option {
     ASCIINumerals = 4,
     IgnoreVedicAccents = 8,
     RetainSpecialMarkers = 16,
-    NoXMLTagHandling = 32
+    NoXMLTagHandling = 32,
+    DisableInference = 64
 }

package/dist/src/Option.js

@@ -20,5 +20,7 @@ var Option;
     Option[Option["RetainSpecialMarkers"] = 16] = "RetainSpecialMarkers";
     /// Do not check for xml/html tags, and treat them as normal text
     Option[Option["NoXMLTagHandling"] = 32] = "NoXMLTagHandling";
+    /// Disable contextual pronunciation inference (including anuswara assimilation and Tamil reading/writing rules)
+    Option[Option["DisableInference"] = 64] = "DisableInference";
 })(Option || (exports.Option = Option = {}));
 //# sourceMappingURL=Option.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vm75/inditrans",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "description": "A functional transliterator library for the most common Indic/Brahmic scripts.",
   "main": "./dist/src/index.js",
   "author": "VM75",