Version:   2.7.6
Location:  http://www.yudit.org/
Author:    Gaspar Sinai <gsinai@yudit.org>
Copyright: Released under the GNU General Public License, version 2, 
           dated June 1991, worded by the Free Software Foundation.
           Please read the file COPYING. (GNU)
           
Features
========
 o The kinput2 method is directly supported for Japanese. </li>
 o X Input Method</strong> support. 
 o Handwriting recognition support.
 o Easy-to-make key-input maps that can be
   created to input scripts with a two-way English transliteration
   scheme. Yudit comes with more than 100 keyboard maps
   contributed by Yudit users from all over the World.
 o Built-in printing support
   High quality and locale independent postscript is generated.
 o Direct True Type / Open Type font support.
   Yudit does not need X11 TTF support to show your text. 
 o Yudit can display and print your text with a
   mixture of X11 fonts/True Type fonts.
   Unicode glyphs are widely available these days but still there are
   some scripts that need this feature. 
 o Cut and paste, load and save your text with various encodings. 
   It is possible to create a unicode text file in Linux and read 
   it in MS Notepad on NT. (utf-16)
 o Keyboard input maps can be used as text converters. This means that
  you can make instant transliterations of your scripts.
  If the transliterations is reversible, it is possible to read it
  back get the original text back. 
 o Unlinimted  undo/redo.
 o Overstriking and OTF <strong> composing-character support. 
 o 31-bit Unicode support.
 o Drag-and-Drop </strong> (xdnd and Dnd) support. 
 o Full Bidirectional text support.
 o Hagul Jamos with mslvt encoder (hardwired for ogulim.ttf) and X11 fonts 
 o Arabic, Syriac,... shaping support. 
 o Indic scripts: Tamil,Devanagari,Bengali,Gujarati,Gurmukhi,
   Oriya,Malayalam,Kannada and Telugu
 o Hungarian Runes (rovásírás) support in Private Use Area
 o Software glyph mirroring (Hungarian Runes,Old Italic)

How to Install
==============
Prerequisites:
--needed: gcc-2.96 or better  http://gcc.gnu.org/
--needed: gmake 3.75 or greater ftp://prep.ai.mit.edu/
--needed: X11R5 or greater (www.xfree86.org)
--recommended gettext 0.10 or better for multi-language message support
  From version-2.4.8 it is only needed when making your own messages.
  Reading gettext generated files are internally supported.
--optional: a lot of True Type fonts are available for free:
  From www.microsoft.com you can get gulim (Hangul), msgothic (Japanese) for IE.
  From www.bitstream.com you can get cyberbit that contains a lot of glyphs.
  From ftp://ftp.cs.indiana.edu/pub/fidel/fonts/ 
      you can get Ethiopic fonts (gfzemenu).
--recommended:
  Several UCS fonts:
    http://www.cl.cam.ac.uk/~mgk25/ucs-fonts.html
  Unifont:
    http://www.czyborra.com/unifont/
--recommened literature:
  http://www.cl.cam.ac.uk/~mgk25/unicode.html

Installation Process
====================
Linux:

1. configure --prefix=/usr/local
2. make
3. make install

Solaris:

1. configure --prefix=/opt/Misc
2. make
3. make install

FreeBSD:

1. ./configure --prefix=/usr/local
2. gmake
3. gmake install

Windows:

1. run setup.exe
2. install into a directory, like:
   C:\Yudit
   * Good to know: if you don't have setup.exe or you want to move 
     yudit manually to another directory you just need mytool to 
     change installdir:
      C:\NewInstallBaseDir\bin\mytool -installdir "C:\NewInstallBaseDir"
3. install ghostview from, for instance, http://www.ghostgum.com.au/
   into, like:
   C:\Ghostgum
4. If you install ghostview into any other directory, modify
      %HOME%\.yudit\yudit.properties
   and
      C:\Yudit\config\yudit.properties
   * Note: there is an editor that can edit unix files called yudit :)
      yudit C:/Yudit/config/yudit.properties
   and set yudit.default.preview.command to the command to execute:
      yudit.default.preview.command="C:/Ghostgum/gsview/gsview32.exe"
5. If you don't have HOME environment set, Yudit will use C:\HOME

How to make an rpm package form Yudit sources
=============================================
1. rpm -tb yudit-2.7.6.tar.gz
  This will tell you where to put the compresed source code.Put it there.
  Most likely:
  Suse: /usr/src/packages/SOURCES/yudit-2.7.6.tar.gz
  or
  Redhat: /usr/src/redhat/SOURCES/yudit-2.7.6.tar.gz
2. rpm -i [binary rpm]

Does the GUI speak my language?
==============================
Yudit menus can be displayed in several languages.

In  ~/.yudit/yudit.properties file you can specify:

    yudit.default.language=language_code

The following languages are supported:

Tag Country/Language      Translated and contributed by 
=== ===================   =============================
am  Amharic/Ethiopia      Daniel Yacob <locales@geez.org>
ar  Arabic/               Mohamed kebdani <kebdani1@iam.net.ma>
az  Azerbaijani Turkish   Vasif İsmailoglu <azerb_linux@hotmail.com>
bn  Bengali               Anirban Mitra <mitra_anirban@yahoo.co.in>
bg  Bulgaria/Bulgarian    Alexander Shopov <al_shopov@web.bg>
de  Germany/German        Thomas Wohlfarth <Thomas.Wohlfarth@gmx.net>
cs  Czechia/Czech         Lubos Stanek <stanekl@atlas.cz>
en  US/English            Gáspár Sinai <gsinai@yudit.org>
el  Greece/Greek          Velonis Petros <velonis@freemail.gr>
es  Spain/Spanish         Juan Rafael Fernández García <jrfern@bigfoot.com>
fi  Finland/Finnish       Miikka-Markus Alhonen <Miikka-Markus.Alhonen@tigatieto.com>
fr  France/French         Olivier Faucheux <olivier.faucheux@etu.enseeiht.fr>
hi  Hindi                 Sanjay Khatri <sk_ind@vsnl.net>
hu  Hungary/Hungarian     Gáspár Sinai <gsinai@yudit.org>
ja  Japan/Japanese        Inui Yuko / Gáspár Sinai <yuko@yudit.org>
ko  Korea/Korean          Jungshik Shin <jshin@mailaps.org> 
mn  Mongolia/Mongolian    Natsagdorj Shagdar <natsagdorj@t-online.de>
pa  Punjabi               Madhusudan Singh <chhabra@eecs.umich.edu>
pl  Polish/Poland         Pawel Zawila-Niedzwiecki <zawel@wgt.com.pl>
ru  Russian/Russia        Вячеслав Диконов Vyacheslav Dikonov <sdiconov@mail.ru>
sl  Slovenia/Slovenian    Roman Maurer <roman.maurer@amis.net>
sr  Yugoslavia/Serbian    Slobodan Marković <twiddle@eunet.yu> 
ta  Tamil                 Thuraiappah Vaseeharan <t_vasee@yahoo.com>
uk  Ukrainian             Solotskyy Mykola <salo@tokyo.email.ne.jp>
ur  Urdu/Pakistan         S H A N <shanali@singnet.com.sg>
vi  Vietnamese/Vietnam    Hoan <hoan@wanadoo.fr>
yi  Israel/Yiddish        Raphael Finkel <raphael@cs.uky.edu>
zh  Chinese/HongKong      Joe Man <trmetal@yahoo.com.hk>

If you specify 

    yudit.default.language=default

The environment variable LANG will be used to determine the 
language. Use this option sparingly - it is not guaranteed that
the font is available.

If your language does not appear properly, you might need to
change 
 yudit.default.font=default
to
 yudit.default.font=MyVirtualFont

The default font is internally defined in swindow/SFont.ttf as:

  "yudit.hex,arabforms.hex,syriacforms.hex,unifont.hex,"
  "markus9x18.bdf,markus18x18ja.bdf,"
  "-*-*-medium-r-normal--16-*-*-*-c-*-iso8859-1,"
  "-*-*-*-*-*--16-*-*-*-c-*-iso8859-1,"
  "THOOLIUC.TTF:mlym,"
  "ani.ttf:beng,"
  "pothana2000.ttf:telu,"
  "TCRCYoutsoUnicode.ttf:tibt,"
  "raghu.ttf:deva,"
  "mangal.ttf:deva,tunga.ttf:knda,code2000.ttf:taml,"
  "raavi.ttf:guru,shruti.ttf:gujr,"
  "arialuni.ttf,cyberbit.ttf,"
  "code2000.ttf,code2001.ttf:unicode:RL,arial.ttf,"
  "yudit.ttf"

How to translate yudit messages to my language
==============================================

1. cd gui
2. mkdir -p locale/country_and_variant/LC_MESSAGES/
3. make messages
4. yudit -e utf-8 locale/country_and_variant/LC_MESSAGES/messages.po
5. make messages
6. make install
7. mail -s locale/country_and_variant \
     gsinai@yudit.org < locale/country_and_variant/LC_MESSAGES/messages.po
8. add 
    yudit.default.language=country_and_variant
   to ~/.yudit/yudit.properties
   you may want to add:
    yudit.default.font=yourfont
    yudit.default.fontsize=yourfontsize
  A good result can be achieved if you download and install the 

   http://www.cl.cam.ac.uk/~mgk25/download/ucs-fonts.tar.gz

  - mkdir x11fonts   (or re-use .yudit/fonts)
  - cd x11fonts
  - wget http://www.cl.cam.ac.uk/~mgk25/download/ucs-fonts.tar.gz
  - tar xfz ucs-fonts.tar.gz
  - xset fp+ ~/x11fonts 
  - (optional) put the line above into ~/.Xinitrc
  - change ~/.yudit/yudit.properties

         yudit.default.font=Misc
         yudit.default.fontsze=15

9. Sometimes you may have a translation but it does not appear.
  Possible and not obvious reasons:
  - if the original message has \n at the end the translation should
    have it too.
  - if you see the fuzzy keyword in a comment preceeding the message
    it won't be included. Remove the fuzzy comment.
   
     
Japanese Input
==============
If you have built the Motif version you can also use Kinput2 to input Japanese.

If you want to use free packages and you have an English environment
you need to do the following:

o Get a conversion server, 'canna' from X11 contrib directory.
  This server can be built in Linux. It is usually started when the machine
  boots and keeps running. Make sure it uses its own wide text library.
  No Japanese environment is needed.

o Get a 'kinput2' X front-end for X11 from the same place you got canna.
  If you do not have Japanese environment, make sure it links with libcanna16.
  Kinput is started after X in .xinitrc and it provides the input windows
  for the applications.

  The current version of kinput2 has a bug - it thinks that long is 32 bit,
  which is true on a pentium machine. On an alpha machine you should make
  sure you have a version number set to less than 2.02 in your .yuditrc so
  that yudit knows that it should deal with a buggy kinput2. If you have a
  value of zero, yudit tries to determine the version number itself.

Hangul Input
============
Yudit comes with kmap files for Roman transliteration, 2-set and 3-set
keyboards. I expect yudit to improve on this area.

Adding New Mappings
===================
Please read the man page for mytool. FAQ.TXT also has some information.
For clues on how to create an Handwriting input please read the
mytool/hwd/hiragana.hwd utf-8 encoded file, or the same file in
/usr/share/yudit/data/hiragana.hwd.

Undocumented Features
=====================

There is a Yudit command-area command 

  configure

that brings up the configuration file.
When the configuration file is edited, Yudit will not save 
the current settings when it exits, so that you can save 
the config file safely. (Unless another editor session is 
running...)

This is documented: you should know that you can use
the keyboard maps as text converters. So you convert a 
Devanagari transliterated text into unicode like this:

uniconv -decode Devanagari < in_itrans.txt > out_utf8.txt

There are many converters for ISCII character conversion
written by Anirban Mitra <mitra_anirban@yahoo.co.in> and
included in this Yudit package. They all start with IS_.

There is a plan to make a more extensive documentation but
there are too many features and not enough time :)

Acknowledgements
================
乾優子 <yuko@yudit.org> for her support, and her hiragana and katakana 
handwriting data.
Andrew Weeks at the University of Bath for releasing his True Type 
  to postscript (ttf2pfa) program.
Anirban Mitra <mitra_anirban@yahoo.co.in> Indic (Bengali), IS_XX.mys 
  transliteration maps.
Grisha Mokhin <mokhin@bog.msu.ru> Tibetan support.
Hosszú, Gábor <hosszu@Nimrud.eet.bme.hu> Old Hungarian Support
Jungshik Shin <jshin@pantheon.yale.edu> Korean support
Jim Breen <jwb@dgs.monash.edu.au> for the extensive tests and
 bug reports.
Mark E. Shoulson <mark@kli.org> for helping to test the 
  diactritical marks.
Maarten van Gompel <proycon@anaproy.homeip.net> 
  - syntax higlighting, word wrapping and other fixes
Markus Kuhn <Markus.Kuhn@cl.cam.ac.uk> for the unicode FAQ and the good
  advise.
Mohammed Elzubeir <elzubeir@fakkir.net> for helping me with Arabic.
Miikka-Markus Alhonen <Miikka-Markus.Alhonen@tigatieto.com> for the
 huge amount of help in many scripts.
Peter Soos <sp@osb.hu> - cp-1251 encoded vector font (TTF).
Raphael Finkel <rfinkel@mail.csse.monash.edu.au> - extensive debugging
Rajkumar S. <raj2569@yahoo.com> - Malayalam, contributor of dc-font.ttf
Ričardas Čepas <rch@richard.eu.org> - FreeBSD port
Robert Wells for JStroke
Roman Czyborra <czyborra@dds.nl> kmap files, web-page, unifont
Thomas Wohlfarth <thomas.wohlfart@usa.net>, <thomas.wohlfarth@gmx.net> 
  - translations, tests
Thuraiappah Vaseeharan <t_vasee@yahoo.com> for his help and contributions
 to Tamil in Yudit. 
Richard Tebb <richard.tebb@convergys.com> - for 'remote debugging' on Sparc
Todd David Rudick for his program JavaDict, and the kanji hwd.
Tony Laszlo <laszlo@gol.com> - extensive debugging 
...
and you know who you are....

Useful Links
============
+Unicode
*Unicode Consortium *http://www.unicode.org/
*Unicode FAQ *http://www.cl.cam.ac.uk/~mgk25/unicode.html
*Unicode Tools*http://eyegene.ophthy.med.umich.edu/unicode/
*Sampler*http://www.unicode.org/cgi-bin/GetUnihanData.pl
*Linux HOWTO* ftp://ftp.ilog.fr/pub/Users/haible/utf8/Unicode-HOWTO.html
*Czyborra.com *http://www.czyborra.com/
*ICU*http://oss.software.ibm.com/icu/overview.html
*QEmacs*http://fabrice.bellard.free.fr/qemacs/
*Indic*http://indic-computing.sourceforge.net/
*Brahmi*http://brahmi.sourceforge.net
*Lekho*http://lekho.sourceforge.net/
*interxim*http://www.oksid.ch/interxim/index.html

+Unicode?
*UAX#9*http://www.yudit.org/bidi/surprise.html
*Limitations*http://www.hastingsresearch.com/net/04-unicode-limitations.shtml
*Problems*http://www.debian.or.jp/~kubota/unicode-symbols.html
*Drawbacks*http://www-106.ibm.com/developerworks/unicode/library/u-secret.html?dwzone=unicode
*Alphabet Soup*http://www.theory.org/artprojects/alphabetsoup/
*Bytext*http://www.bytext.org/
*Rosetta*http://www.kotovnik.com/~avg/rosetta/
*Metacode*http://www.cs.fit.edu/~satkin/docs/dissertation.pdf

+X11 Fonts
*HOW-TO*http://en.tldp.org/HOWTO/mini/FDU/index.html
*UCS fonts *http://www.cl.cam.ac.uk/~mgk25/ucs-fonts.html
*GNU Unifont*http://czyborra.com/unifont/HEADER.html
*Local Copy*http://www.yudit.org/download/fonts/bitmap/
*ETL Unicode *ftp://ftp.x.org/contrib/fonts/
*Fonts in X*http://www.math.utah.edu/~beebe/fonts/X-Window-System-fonts.html

+TTF Fonts
*Freetype Library*http://www.freetype.org/
*PfaEdit*http://pfaedit.sourceforge.net/
*GNU Free Font*http://savannah.gnu.org/projects/freefont/
*Alan Wood*http://www.alanwood.net/unicode/fonts.html
*Unicode TTF*http://www.ccss.de/slovo/unifonts.htm
*Cyberbit font *ftp://ftp8.netscape.com/pub/communicator/extras/fonts/windows/
*MS TTF*http://corefonts.sourceforge.net/
*Unicode fonts*http://www.hclrss.demon.co.uk/unicode/fonts.html
*TTF Archive*http://hopi.dtcc.edu/~berlin/fonts.html
*TheFreeSite.com*http://www.thefreesite.com/Free_Fonts/
*Free foreign fonts*http://www.omniglot.com/links/fonts.htm
*Raghu.ttf*http://rohini.ncst.ernet.in/indix/download/font/
*Bangla*http://www.nongnu.org/freebangfont/
*K.Micho*http://www.on.cs.keio.ac.jp/~yasu/jp_fonts.html
*W.Mincho*http://www.asahi-net.or.jp/~sd5a-ucd/freefonts/extended-watanabe-mincho/index.html.ja.sjis
*Local*http://www.yudit.org/download/fonts

+Postscript
*First Guide*http://www.cs.indiana.edu/docproject/programming/postscript/postscript.html
*WPrint*http://ttt.esperanto.org.uy/programoj/angle/wprint.html
*Cedilla*http://www.pps.jussieu.fr/~jch/software/cedilla/
*XPrint*http://xprint.mozdev.org/

+People
*utf-8 List*http://mail.nl.linux.org/linux-utf8/
*Europe*http://petition.eurolinux.org/
*Humour*http://www.cs.stir.ac.uk/~scu/Humour/index.html
*Gaspar Sinai*http://www.yudit.org/gaspar/
*Hungarian Grammar*http://www.yudit.org/magyar
*Hungarian Alphabet*http://www.yudit.org/ipa/
*Hungarian Club - Tokyo*http://www.yudit.org/club/

==============================================================================
Gáspár Sinai <gsinai@yudit.org>
Tokyo 2003-09-02

