%(c) 1991 by Joel M. Hoffman
%readme.tex file for hclassic fonts and supporting TeX macros.
%This file uses the fonts hclassic and hcaption.  MetaFont them before
%processing this file.  It also uses the macro files:  hletter1, dots,
%and vowels.  Process this file with plain TeX.

%Use of this material in a commercial venture of any sort requires
%permission from me.  Otherwise, you are free to use this for any
%legal, non-destructive purpose.  If you find this font useful, a
%contribution to charity will be most appreciated.

%Send comments or complaints to:
%
%BITNET:      hoffman@nyuacf.BITNET  <-- this will change soon
%CompuServe:  72700,402 -or- 72700.402@compuserve.com
%SNAIL:       Joel M. Hoffman
%             19 Hillcrest Lane
%             Rye, NY 10580
%             U.S.A.                            


\tolerance10000

\input hletter1              % load the letter macros
\input vowels                % load the vowel macros
\input dots                  % load the dot macros

\font\Hebrew=hclassic        % Use hclassic for Hebrew text
\font\HebrewCaption=hcaption % Use hcaption for captions.
\font\EnglishCaption=cmbx12  % Use cmbx12 for English Caption.

\def\part#1{\bigskip\noindent{\EnglishCaption #1}\par\nobreak\medskip}
\def\\{$\backslash$}
\def\cmd#1#2{\\#1{$\{$}{\it #2}{$\}$}}

\headline{\rm May 1991\hfill\tt hclassic\rm\hfill\copyright 1991 by Joel M.\ Hoffman}

\advance\baselineskip by .25\baselineskip

\part{Introduction}

{\tt Hclassic} is a modernized Classical Hebrew font (in the same way
that Knuth's {\tt cmr} family is a modernized Roman font --- but his
fonts are much nicer).  It contains all of the Hebrew consonants, the
(rarely used) ligature {\it aleph-lamed} (as seen in
``{\Hebrew\alephlamed\resh\shin\yud}'') and two versions of the letter
\hbox{\it ayin}: ``{\Hebrew\ayin}'' and ``{\Hebrew\vowelayin}.''  The latter is
for use with vowels.  {\tt Hclassic} also contains all of the vowels
found in Hebrew, a symbol for {\it meteg}, and dots for use as a {\it
dagesh} and for differentiating ``{\Hebrew\shinwithdot}'' and
``{\Hebrew\sinwithdot}.'' 

Also included is a set of macros, in the files {\tt hletter1.tex}, {\tt
vowels.tex} and {\tt dots.tex} for using the {\tt hclassic} font.  Here
is an example of what {\tt hclassic} looks like:

\centerline{\Hebrew:\ftzadi\segol{\resh}\Kamatz{\aleph}\kamatz{\heh}\
\taf\tzere{\aleph}\shva{\vav}\
\fmem\chiriq{\yud}\patach{\mem}\kamatz{\Shinwithdot}\patach{\heh}\
\taf\tzere{\aleph}
\fmem\yud\chiriq{\heh}\odot\lamed\chatafsegol{\aleph}\
\aleph\kamatz{\resh}\kamatz{\Bet}\
\taf\yud\chiriq{\shinwithdot}\aleph\tzere{\resh}\shva{\Bet}}
\medskip

The only punctuation included is as follows:  period, comma, exlamation
mark, dash; all except the comma look rather Biblical.

\part{Using the Font}

The file {\tt hletter1}\footnote{*}{ I have named the file {\tt
hletter1} because you may want to have other mappings for other fonts
(several public domain fonts in the U.S.\ use `b' for {\it bet}, `g' for
{\it gimel}, etc.  {\tt Hclassic} uses the character mapping I've seen in
use in Israel.  I have not yet had a chance to look at \TeX\ 3.0, but I
suspect 3.0 introduces a more elegant way of using two character sets.}
defines macros for all of the Hebrew letters: {\tt \\aleph, \\bet,
\\gimel, $\ldots$ \\taf}; the final letters: {\tt \\fchaf, \\fmem,} etc.;
the ligature {\it aleph-lamed}: {\tt \\alephlamed}; and the variant form
of the letter {\it ayin} for use with vowels: {\tt \\vowelayin}.  It
also contains definitions for letters with a {\it dagesh}:  {\tt
\\Aleph, \\Bet,} etc.  I realize there is no reason to put a {\it
dagesh} in an {\it aleph}, but you can.  Use {\tt\\Heh} for a {\it
mappiq}.  You must include the file {\tt dots.tex} (q.v.\ below) to use
a {\it dagesh}.

The files {\tt dots.tex} and {\tt vowels.tex} define macros for all of
the diacritic marks included with {\tt hclassic}.  The following macros
are available for vowels: {\tt \cmd{patach}{letter},
\cmd{kamatz}{letter}, \cmd{segol}{letter}, \cmd{kibutz}{letter},
\cmd{chiriq}{letter}, \cmd{kamatzkatan}{letter} and \cmd{shva}{letter}},
where ``letter'' is any Hebrew letter.  For example,
{\tt\\segol$\{$\\aleph$\}$} will produce ``{\Hebrew\segol{\aleph}}.'' Unlike
most Hebrew fonts, a {\it kamatz katan} is slightly larger than an
ordinary {\it kamatz}.  So: {\Hebrew \fmem\yud\daled\kamatz{\lamed}\yud\heh\
\lamed\kamatzkatan{\Kaf}}.  The command {\tt \cmd{meteg}{letter}} places
a {\it meteg} under the letter ``letter.''  For each vowel command is a
corresponding {\it chataf} vowel command ({\tt \cmd{chatafkamatz}{letter},
\cmd{chatafsegol}{letter},} etc.) and a command for adding a {\it meteg}
({\tt \cmd{Kamatz}{letter}, \cmd{Segol}{letter},} etc.).

The above macros automatically adjust the location of some vowels, 
substitute {\tt\\vowelayin} for {\tt\\ayin}, and adjust the location of
the {\it dagesh}.  So  {\tt\\shva$\{$\\resh$\}$} will produce
``{\Hebrew\shva{\resh}},'' with the {\it shva} not centered but under
the stem, where it belongs.  Likewise, {\tt\\kamatz$\{$\\fchaf$\}$} and
{\tt\\kamatz$\{$\\Fkaf$\}$} produce ``{\Hebrew\kamatz{\fchaf}}'' and
``{\Hebrew\kamatz{\Fkaf}}'' respectively.  Also, {\tt\\ayin} produces
``{\Hebrew\ayin}'' but {\tt\\patach$\{$\\ayin$\}$} produces
``{\Hebrew\patach{\ayin}}.''

The commands {\tt\\shinwithdot} and {\tt\\sinwithdot} produce
``{\Hebrew\shinwithdot}'' and ``{\Hebrew\sinwithdot}'' respectively; they
both have a corresponding version with a {\it dagesh}.  The command
{\tt\\vavwithdot} yields ``{\Hebrew\vavwithdot}.''  Use {\tt\\odot} for
a {\it cholem chaseir}.


\part{I Have to Type All of THAT?!}

I realize that typing
{\tt
\\taf\\yud\\chiriq$\{$\\shinwithdot$\}$\\aleph\\tzere$\{$\\resh$\}$\\shva$\{$\\Bet$\}$}
is a difficult way to produce
``{\Hebrew\taf\yud\chiriq{\shinwithdot}\aleph\tzere{\resh}\shva{\Bet}}.''  
You will doubtless notice that I have not included any better mechanism
for entering Hebrew with ease.

There are two problems.  First, you have to enter Hebrew left-to-right
(in what is called ``screen order''); second, typing all the vowel-commands
is difficult.  There are several solutions to the first problem,
reviewed elsewhere; the {\tt IVRITEX} group managed at {\tt TAUNIVM} is
a good place to start. 

For my own use, I have found that escape sequences are fine for
including occasional Hebrew words in English documents.  For more
extensive Hebrew, I use my {\tt ibelbe}\footnote{**}{Itty-bitty
Emacs-Like Bidirectional Editor --- it looks a lot like Emacs and has
provisions for bidirectional editing.} program to enter Hebrew text in
screen order, and then my {\tt addvowel} program to add the necessary
escape sequences.  {\tt Addvowel} is an interactive program that
facilitates the pointing of Hebrew.  Both programs require an EGA Hebrew
font, and {\tt addvowel} requires that that EGA font have vowels.  I
will release my EGA Hebrew font, {\tt addvowel} and {\tt ibelbe} Real
Soon Now; I still want to fix a few letters on the font, and {\tt
ibelbe} isn't quite stable yet. 

\part{The MetaFont Files}

{\tt Hclassic} is programmed in MetaFont.  I have divided the font into
two files, {\tt hclassic.mf} and {\tt base.mf}, the latter containing
routines for all of the characters, and the former dealing with the
parameters of the font: serif-size; character height, depth and width;
line size; etc.  Variations can be created simply by modifying the
parameter file ({\tt hclassic.mf}).  The file {\tt hcaption} is such a
variation; it is a fancier font, slanted, and looks good in captions:

\medskip
\centerline{\HebrewCaption \alephlamed\resh\shin\yud\
\ftzadi\resh\aleph}
\medskip

\part{Bugs}

This is my first MetaFont attempt, and I have ``cheated'' in making many
of the letters.  That is, I have allowed minute errors to remain in
several letters.  At 300 dpi, I have found that both {\tt hclassic} and
{\tt hcaption} look good up to {\tt \\magstep4}, and I suspect perhaps
higher.  By {\tt \\magstep15} (which I have used for posters), many
problems are readily apparent.  Some lines don't join the way they
should, for example.  Also, the serif routine isn't quite right, and
this becomes noticeable.

The letter {\it mem} looks awful; it will be changed when I get a chance.

There is also a bug in the \TeX\ routine in {\tt vowels.tex} that
adjusts vowel placement.  It fails to recognize that {\tt \\Daled} is
really just a {\it daled} with a {\it dagesh}, and so vowels under it
should be shifted to the right.  (The same problem would appear with {\it
resh}, but {\tt\\Resh} is never used.)  This should not be hard to fix.

Please report any additional bugs, or, especially, suggestions for
improvement, to me at:

\vbox{\tt\obeylines
hoffman@nyuacf.BITNET $\leftarrow$~{\it This will change soon.}
\centerline{\rm -OR-}
72700.402@compuserve.com {\it or from within CompuServe just:  }72700,402
\centerline{\rm -OR-}
Joel M.\ Hoffman
19 Hillcrest Lane
Rye, NY 10580
U.S.A.}

\part{Command Summary}

\vbox{Here is a complete list of the commands defined in the \TeX\ files that
you're likely to use:

{\tt\settabs5\columns
\+\\aleph&\\bet&\\gimel&\\dalet&\\daled\cr
\+\\he&\\heh&\\vav&\\zion&\\chet\cr
\+\\tet&\\yud&\\fkaf&\\fchaf&\\kaf\cr
\+\\chaf&\\lamed&\\fmem&\\mem&\\fnun\cr
\+\\nun&\\samech&\\ayin&\\fpe&\\fpeh\cr
\+\\ffe&\\ffeh&\\pe&\\peh&\\fe\cr
\+\\feh&\\ftzadi&\\ftzadik&\\kuf&\\koof\cr
\+\\resh&\\shin&\\sin&\\tav&\\taf\cr
\+\\Aleph&\\Bet&\\Gimel&\\Dalet&\\Daled\cr
\+\\He&\\Heh&\\Vav&\\Zion&\\Chet\cr
\+\\Tet&\\Yud&\\Fkaf&\\Fchaf&\\Kaf\cr
\+\\Chaf&\\Lamed&\\Fmem&\\Mem&\\Fnun\cr
\+\\Nun&\\Samech&\\Ayin&\\Fpe&\\Fpeh\cr
\+\\Ffe&\\Ffeh&\\Pe&\\Peh&\\Fe\cr
\+\\Feh&\\Ftzadi&\\Ftzadik&\\Kuf&\\Koof\cr
\+\\Resh&\\Shin&\\Sin&\\Tav&\\Taf\cr
\+\\alephlamed&\\vowelayin&\\dagesh&\\odot&\\shinwithdot\cr
\+\\sinwithdot&\\Shinwithdot&\\Sinwithdot&\\vavwithdot&\\Vavwithdot\cr
\+\\patach&\\kamatz&\\segol&\\kibutz&\\chiriq\cr
\+\\kamatzkatan&\\shva&\\meteg&\\tzere&\\chatafpatach\cr
\+\\chatafkamatz&\\chatafsegol&\\chatafkibutz&\\chatafchiriq
	&\\chatafkamatzkatan\cr
\+\\chataftzere&\\Patach&\\Kamatz&\\Segol&\\Kibutz\cr
\+\\Chiriq&\\Kamatzkatan&\\Tzere\cr}}


\part{Copyright Information}

All of the files in this package are copyrighted by myself.  Use of the
material contained therein in a commercial venture of any sort requires
permission from me.  Otherwise, you are free to use this for any legal,
non-destructive purpose.  If you find this material useful, a
contribution to charity will be most appreciated.


\end



