See the COPYRIGHT file.

This directory holds some of the package for preparing Yiddish.
Other parts are in 
	../ivd2dvi	left-right reversal program: *** run make there ***
	../hebrew	defining files (in metafont) for the hclassic font, and
				tex macros for accessing that font easily
				*** see HOWTO there ***.
	../hebcalig	same as ../hebrew, but Raphael Finkel's calligraphic font.

Perl scripts in this directory:
	addgender.pl: adds gender indicator for dictionary if guessable
	conv.pl:  replace non-Ascii with \xFF notation.
	e2i.pl: convert Romanization into internal form
	expand.pl: take dictionary and format it in various ways
	extractwords.pl: show individual words without punctuation
	fixmuw.pl: convert Universal Word to Mac representation
	fixspell.pl: attempt simple spelling fixes on UTF-8
	fixup.pl: attempt OCR fixup based on spelling; in transcribed form
	fixutf8.pl: introduce ligatures, remove precomposed, make YIVO in UTF-8 form
	genspell.pl: create QText table of definitions
	i2ipa.pl: convert internal form to IPA
	i2y.pl: convert internal form to YIVO Romanization
	k2u.pl: convert 4-hexit codes to UTF-8
	l2i.pl: Ladino: convert Romanization to internal form
	laszloconvert.pl: convert Laszlo Romanization to UTF-8
	mac2ascii.pl: convert Mac to Romanization
	marsha.pl: take dictionary, output UTF-8 + definitions
	noXML.pl: remove markup from text (any encoding)
	p2u.pl: convert Yugntruf PDF to UTF-8
	reversesort.pl: sort by ending to make rhyming dictionary; UTF-8
	reyzl2uyid.pl: convert Reyzl's text to UTF-8
	soffice.dict.pl: create soffice dictionary from Romanized word list
	spelledbad.fix.pl: filter out non-Yiddish from list of Romanized words
	tei.pl: create TEI XML from dictionary
	u16.to.utf8.pl: convert UCS-2 to UTF-8
	unmark.pl: remove UPenn POS markup, leaving only Romanization
	y2h.pl: convert Romanization to HTML
	y2i.pl: convert Romanization to internal form
	y.reverse.pl: reverse only English component of a file

How to use this package:

	Make a file, called <whatever>.yid.  Enter text into it in Yivo
	transcription.  See sample.yid.

		Hebrew words should be put in phonetically.  Check the file
		respell.data to make sure your Hebrew word is on the list.
		If not, add it (alphabetically!) with a transcription based
		on the guidelines in intermediate.doc.  Use | to prevent
		combinations like sh from becoming shin.  s|h is samekh heh.
		Separate Hebrew and other commponents of a word with |, too:
		far|kholem|t.

		If you want to put in TeX or LaTeX stuff, make sure that it
		is on a line by itself.  Lines containing the \ character do
		not get translated through respelling (for Hebrew) or Yivo
		transcription.

		There are two Hebrew fonts available; you can switch between
		them at any time by \calig or \classic (on a line by
		itself).  For a larger size, use \Calig or \Classic.

		If you want thinner margins or more lines on a page, I suggest

			\hsize=7in \vsize=10in

		at the place marked in driver.tex, although the
		line-reversing code will not keep the margins identical.

	Then run "make GOAL=whatever MACH=machinetype" (the MACH part
	is optional.  I run the same code on several kinds of machines and need to
	keep things separate.  You may want to set your environment variable MACH
	to i486 or sparc or whatever.)

		The package will produce a file <whatever>.dvi ready
		for proofing on the screen or to paper.

	You can say "make XXX GOAL=yourfile.yid" to get other kinds of output.
	If you leave off the GOAL= part, the file tmp.yid will be assumed.
	Here are things you can use for XXX:

		see:	builds dvi, then calls xdvi to see the result
		ps:		builds dvi, then from it a printable postscript file.
		pdf:	builds ps, then from it a pdf file.
		print:  builds dvi, then postscript, then sends to printer
		dvi:    just dvi, which is the device-independent TeX output.
		spell:  a list of doubtfully spelled words, all on one line
		sp:     a list of doubtfully spelled words, one per line, with suggestions
		unicode:  outputs Yiddish Unicode.
		utf:  	outputs Yiddish Unicode in UTF format.

This is Version 2.2.
	changes from 1.1: properly handles initial 'yi' without adding aleph.
	changes from 1.2:
		fixes bug in recast.sed for continuation lines.
		introduces ' and " characters.
		introduces -- and --- ligatures.
	changes from 1.3:
		introduces 'zh', 'dj', 'tsh' yivo-transcription forms.
		improves ' and " characters slightly
		improves (lightens) : . and !
		introduces '?' in the font
		puts proper final forms before hyphens
		lets % pass unchanged so TeX comments can be inserted
		fixes transcription translation for initial 'yo'.
	changes from 1.4:
		introduces 'P' transcription to mean a pe without raphe, without dagesh.
		introduces the calligraphic font hebc10.
		removed \alephwidth from yiddish.texinsert, now that font_quad defined
			in the Hebrew fonts.
		understands that comma can start a word (for an under-quote)
		two commas next to each other have reduced spacing to look more like an
			under-quote.  Works fine in calligraphic font; not so great in the
			classic font.
		added respell program to allow Hebrew words to be entered phonetically
		placed recast.sed in the distribution; it was inadvertently left out
			before.
	changes from 1.5:
		added pretolerance setting in driver.tex to avoid hyphenations.
			Should actually build a set of hyphenation patterns.
		fonts need not be installed (if using TeX3.14 or later); driver.tex
			refers to fonts by relative path, and ivd2dvi fixed to include
			the current directory in the default path.
		enhanced Makefile in hebcalig to build mag1 and mag2 directly.
		each of the two fonts exists in two sizes now.
		put pre-quote and postquote ligatures in classic font.  Use ,, and ''.
		fixed the problem causing paragraphs starting with dots to misformat.
	changes from 1.6:
		none yet.
	changes from 1.7:
		switched to Perl from sed for respelling rules.
		added spellcheck and related tools.
		added outputs in Unicode and variants (yid2html.c)
	changes from 1.8:
		more fonts (Jerusalem, DeadSea, OldJaffa, TelAviv, FrankRuehl)
		cleaner code for building rofe and pasakh marks.
		added program mac2ascii.pl to convert Mac code to Yivo transcription
		added \spell lines to respell.pl
	changes from 1.9:
		spellcheck ignores TeX comments.
		pdf files can now be generated.
		qtext-format Hebrew can now be generated.
		\spell lines that respell things already in respell.data with | marks
			are now treated correctly
		respell.c now avoids respelling anything after \ in a line.
		Renamed: recast.pl => y2i.pl.  (YIVO -> Intermediate)
		Added:  e2i.pl (External -> Intermediate) with -q, -m, -u for
			QText, Mac, UTF-8
		Added:  i2y.pl (Internal -> YIVO)
	Changes from 2.0:
		Added partial support for nekudes (vowels), including Unicode,
			intermediate code, and YIVO code.
	Changes from 2.1:
		Extra comments in driver.tex to document some TeX possibilities.
		transform.c:
			Added one more Unicode nekude.
			Added Mac and MS codes for nekudes.
			Added ifdef for sparc to avoid compiler warning	
		e2i.pl:
			added some more Mac codes to accomodate some users.
			splits long lines to prevent TeX overflow.
			understands \english in QText input better.
			allows << ... >> for HTML tags in QText input.
		y2i.pl: added the \exact command to preserve line breaks, initial space
		i2y.pl, y2i.pl: new rule for "ureynikl" to introduce shtumer alef.
		i2y.pl: understands \spell lines and uses them.
		Added u16.to.utf8.pl as a utility to be called manually if needed.

This directory has the following files:
	intermediate.doc
				documents the internal format for letters and the Yivo
				transcription.  
	transform	converts internal format to Tex macros
	respell 	fixes spelling of Hebrew words so you can write them
				phonetically in the input
	respell.data
				list of respellings for Hebrew words.  Must be alphabetical.
	Makefile	prepares .dvi file from a .yid file.
	driver.tex	Latex source file to establish environment.
	spellcheck.c  Spelling checker.
	yid2html.c	Converter to Unicode and various other formats.
	e2i.pl		Converter from external forms (like QText, Macintosh) to
					internal form
	y2i.pl		Converter from Yivo to internal form
	i2y.pl		Converter from internal form to Yivo transcription
