This set of files should be placed in ~/.vim in order to enable Yiddish.
It is all copyleft under the GPL.
Version 1.08 18 Jan 2002
Author:  Raphael Finkel <raphael@cs.uky.edu> 4/2001
Purpose: Yiddish editing

-- Getting started: Unix

To get the features produced by these files, will want the following in your
~/.vimrc:

    syntax on
    set encoding=utf-8 fileencodings=cp1255,utf-8,latin1 guifont=8x13bold
    filetype plugin on

-- Getting started: Win32 (that means Windows 95, 98, 2000, NT, ...)

In c:\autoexec.bat, set your home directory:

	set home=c:\yourHomeFolder

Then install the Win32 version of Vim.   It will make a folder

	c:\yourHomeFolder\vimfiles

and populate it with startup stuff.  Take all the stuff you unpacked from
the set of files you are reading now and move it to that folder and its
subfolders.

Make a file c:\yourHomeFolder\_vimrc with this content:

    syntax on
    set encoding=utf-8 fileencodings=cp1255,utf-8,latin1
    filetype plugin on
	set guifont=Courier_New:b:h11 

Now change all hardwired mentions of .vim in the files in the
vimfiles\ folder to say "vimfiles" instead of ".vim"; this change applies
to yidspell.vim, uyidspell.vim, ftplugin\*.vim.

--- What you get

When you edit Yiddish files, the startup scripts here directory will
establish nice things for you if you name your Romanized-Yiddish files *.yid
and your Unicode Yiddish files *.uyid.

1.  Spellcheck.  By default it is not enabled, but you can bring in the
spelling list by typing the introduced command \eo (in any buffer that you want
to check spelling in; spellcheck is buffer-specific).  It takes a few seconds
to load the spelling list.  Spellcheck colors all bad words and introduces
these new commands:

    \et : add  word under cursor into database (temporarily)
    \es : save word under cursor into database (permanently)
    \en : move cursor to the next spelling error
    \ep : move cursor to the previous spelling error
    \ea : look for alternative spellings of word under cursor
    A list will be shown in an alternatives window.
    Maps for Alternatives Window Only:
        <cr> : on alternatives line, will put word under cursor in
            searchword's stead
        :q   : will quit the alternate-word window
    :EE <file> : switch to given file in same buffer (so the word list need
        not be re-read).  Requires :EE! if you want to discard changes.

2.  Dictionary-based word completion.  You complete a partially-written word by
the Vim command ^X^K.

3.  For Unicode Yiddish files:

    The Yiddish keymap is loaded when you edit a *.uyid buffer.  To revert to a
	normal keymap temporarily, type <control-^>.  To revert permanently, type

		:set keymap=<enter>
	
	You can manually establish Yiddish unicode by either of these:

		:set keymap=yi
		:set keymap=yic

	The second one uses precombined codes; the first uses combining characters,
	which I think are more appropriate.

	Right-to-left mode is set when you edit a *.uyid buffer.  To return to
	left-to-right, type

        :set norl<enter>

    Either use gvim or a version of xterm (for console Vim) that understands
        Unicode, as well as at least one Unicode font.  See
        http://www.cs.uky.edu/~raphael/yiddish/unix.html

    Printing:  If your printer doesn't understand UTF-8 (most won't), you can
        get the Yudit distribution and use its "uniprint" program as follows:

	uniprint -out outfile.ps -font font.ttf -size 12 -hsize 0 -in infile.uyid

        The font should be a full path name to a true-type font 
        You can include several -font parameters if one of your
        fonts is incomplete.  -hsize 0 avoids a header.  Uniprint does not do
        left-right reversal; you may want to insert RLO (right-left override:
        u202e) and PDF (pop directional format: u202c) codes at start and end
        of each line.  Much of this work is done for you in the \ep macro
		that you can find in ftplugin/uyid.vim, but you may need to play with
		it some.  In particular, for Win32, you need to make make sure
		uniprint.exe is in your path and you should name the font something
		like C:\WINNT\fonts\COUR.TTF .  You will also need to set the
		environment variable HOME to a directory where you have a .yudit
		subdirectory with your Yudit configuration.

