transliteration-3.4
						------------------
transliteration-3.4
------------------


Requirements:
------------
Operating System		:    LINUX/UNIX system

Compiler/Interpreter/Librarie(s):    Perl and SSF API's

Description:
------------
Transliteration module is working for both SSF and TEXT Format input file

a.If the input file is in SSF :
	The program transliterate only the words starting with "@" symbol which are in the source language mentioned by the user. Transliteration module will not touch any third language( other than source language) Unicode character .( i.e) while processing. The fields which are converting is TKN ,lex,vib,name and head in SSF.After transliteration we got the output in utf corresponding to the target language.

b. If the input file is in TEXT Format :
	The program transliterate only the words which are in the source language mentioned by the user irrespective of them starting with or without "@" symbol.The transliteration module will not touch any third language(other than source language) Unicode character .( i.e) while processing.

For installation on Linux, please refer to the file INSTALL.


Directory Structure:
--------------------

transliteration
     |
     |---bin (functional source code of the transliteration)
     |
     |---API (SSF API's)
     |
     |---tests (contains the referenece input and output)
     |
     |---doc (documentaion files of the transliteration)
     |
     |---README (How to run/use the module)
     |
     |---INSTALL (How to install in sampark directory structure)
     |
     |---ChangeLog (version inforamation)
     |
     |---Makefile (first level make file for copying the module source in sampark system)
     |
     |---Makefile.stage2 (2nd level make file for actual installation/copying in the bin and data_bin directory)
     |
     |---transliteration_hin2tel_ssf_run.sh (to run the transliteration module for Hindi-Telugu .But the input file must be in SSF)
     |
     |---transliteration_hin2tel_text_run.sh (to run the transliteration module for Hindi-Telugu .But the input file must be in TEXT Format)
     |
     |---transliteration_hin2tel_ssf.sh (for the use of dashboard spec file for Hindi-Telugu .But the input file must be in SSF)
     |
     |---transliteration_hin2tel_text.sh (for the use of dashboard spec file for Hindi-Telugu .But the input file must be in TEXT Format)
     |
     |---transliteration.spec (individual transliteration module run with dashboard)
     |
     |---transliteration.pl (main file of transliteration)
     |
     |---trans.pl (main file neede it)




How to Use??
------------

1. perl $setu/bin/sl_tl/transliteration/transliteration.pl --path=$setu/bin/sl_tl/transliteration --stype=ssf --slang=hin --tlang=tel < tests/hin/hin_sent_6.rin
	OR
   perl $setu/bin/sl_tl/transliteration/transliteration.pl --path=$setu/bin/sl_tl/transliteration --stype=text --slang=hin --tlang=tel < tests/hin/hin_text_4.rin

   * --stype=ssf or SSF similarly --stype=text or TEXT
   *sample input and output files are provided in the tests dir namely transliteration.rin transliteration.rout

2. perl $setu/bin/sl_tl/transliteration/transliteration --help
   for display the help

   * transliteration_hin2tel_ssf_run.sh,transliteration_hin2tel_text_run.sh,transliteration_hin2tel_ssf.sh,transliteration_hin2tel_text.sh are working only  for Hindi to Telugu transliteration.For using other languages transliteration, please edit those files for that language pair.



Author: Litha
	LTRC
	IIIT Hyderabad	
Any Quries or suggestions mail to
lithathampan@gmail.com