Bugs / Feature Requests can be send to [[ ajit.krishnan@gmail.com ]]


--------
Question: What is the Mudgala-IME?
--------

This tool is _like_ an "Input Method Editor", which allows users of Windows XP/Vista
to type directly in devanagari / other unicode supported phoenitic scripts. 
Basic features --

(a) Take text in user defined format (eg. itrans) and convert it to devanagari.
    This is "itranslator 2003" like behaviour.

(b) Take text which was previous output by this tool, and convert it back to a
    lossless ascii representation. i.e. the reverse of (a)

(c) User specified key-sequences, and output sequences

(d) user specified key-sequences even with sequences that are prefixes of others


--------
Question: Why yet another one? We have Itranslator, Baraha, gumpad, bhoomiyo, googlepad etc.
--------


No tool that I have come across can 

(a) allow direct IME style devanagari input into word xp etc.
(b) provide unicode output, which is portable
(c) allow use of a font's private area to typeset svaras
    (i.e. make use of "advanced functionality") of sanskrit 2003 & chandas fonts.
(d) retain ascii encoding such that "advanced functionality" is portable.

i.e. I want to typeset, WSYIWYG style, vedic suktas using Chandas / Sanskrit 2003 fonts.
There is no other tool that provides for this. 

An experiment into the feasibility, turned into this tool :-)


--------
Question: Where do I get the devenagari IME [Input Method Editor]?
--------

The tool and this FAQ are available from http://www.mudgala.com/ime


--------
Question: What is required to run this tool?
--------

(1) Windows XP / Windows Vista.

(2) .NET Framework 2.0
http://www.microsoft.com/downloads/details.aspx?familyid=0856eacb-4362-4b0d-8edd-aab15c5e04f5

(3) Compatible fonts (see next question)



--------
Question: What fonts do I need to use this tool?
--------

Devanagari fonts:
Chandas - http://www.sanskritweb.org/cakram/chandas.ttf
Sanskrit 2003 - http://www.omkarananda-ashram.org/Sanskrit/sanskrit2003.zip

Grantha font:
e-Grantha OT - http://www.uni-hamburg.de/Wiss/FB/10/IndienS/Kniprath/INDOLIPI/Package.zip

Malayalam font:
AnjaliOldLipi - http://varamozhi.sourceforge.net/fonts/AnjaliOldLipi.ttf

Gujarati font:
Arial Unicode MS - Built into Windows XP / Vista

Manipravala font:
e-Grantamil - http://www.uni-hamburg.de/Wiss/FB/10/IndienS/Kniprath/INDOLIPI/Package.zip

http://www.uni-hamburg.de/Wiss/FB/10/IndienS/Kniprath/INDOLIPI/Package.zip



--------
Question: How do I start / stop typing in devanagari / other indian script ?
--------

Hit "F11" to start / stop typing directly in devanagari / other indian script.

You can toggle to scripts using #dev, #rom, ## etc. These sequences are defined in config_output.txt



--------
Question: I see boxes when typing directly in devanagari
--------

Ensure that you are using a compatible font, and then continue typing.
For example, if you are in Microsoft Word, change the font to Chandas, Sanskrit 2003,
or another devanagari unicode font. Now, you should indian script.



--------
Question: Is there a sample walkthrough / tutorial?
--------

(1) Unzip the contents of mudgala-ime.zip into a single folder. Make sure
    that mudgala-ime.exe and the various itrans-*.txt files are in the same 
    folder.

(2) Go to the unzipped folder, and run mudgala-ime.exe

(3) If you don't see "saMskritam" in devanagari lipi in the top window, you 
    don't have a compatible devanagari font installed. Find the location of
    fonts at the beginning of this file.

(4) Type something in itrans notation in the bottom window, like "mama nAma rAmaH"
    Click on the "Convert to Samskrit button", the top window will be updated.

(5) Click on the F11 button. Now, in the _TOP WINDOW_ type directly in samskritam.
    Type using itrans notation eg. "sarvaM kushalaM vA". 

(6) Click on "Convert from Samskrit" and itrans notation will be shown in
    the bottom window.

(7) Change the script in the bottom right from "devanagari" to "grantha" or "malayalam".
    Click on "Convert to Samskrit". Matching indic script will show in the top window.
    You can type directly in the top window.

(8) Use F11 to toggle back and forth from "sanskrit" / "non-sanskrit" mode.
    (Note: There are some bug here).


--------
Question: What are the licensing restrictions.
--------

This is freeware, and can be used for personal / commercial ventures.

I plan to release the sources under an open-source license. However, for various
reasons, there may be a delay of several weeks before this is possible.


--------
Question: What else is planned?
--------

Please see the file TODO.txt.


--------
Question: I found a bug / have comments / feature requests. What do I do?
--------

Great! Please send it to  [[ ajit.krishnan@gmail.com ]].

Known bugs are are captured in BUGS.txt