path: root/language/hebrew/makor/tex/makor2/refcard.tex

%% doc to print out references for Makor conventions.
%% This is part of the Makor2 package (Nov-Dec, 2002).
\def\thinspace{$\,$}
\input makor2 \input epsf

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%
%% USERS: Adjust here values/sizes for the Hebrew Makor fonts

\def\myhfont{ezra2}
\def\myhfontsize{11pt}
\def\mytinyfontsize{8pt} % for reduced sizes...

%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%
%% Adjust these other fonts, if you like...
\input zmtmjn
\def\b{\fam\sffam\sansrm}
\def\tiny{\notefonts\rm}
\def\tinyit{\notefonts\it}

%% The following are all Computer Modern def's...
%% \font\b=cmssbx10 
%% \font\tiny=cmr8
%% \font\tinyit=cmti8 

\font\tinymi=cmmi8
\font\ttt=cmtt8 % (a small tt)
%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\dimen0=6pc
\advance \voffset by-\dimen0 \advance\voffset by 6pc
\advance\vsize by 2\dimen0
 \nopagenumbers 
\overfullrule=0pt

%\baselineskip=\myhfontsize
\newcount\n \n=5 % number of columns
\newdimen\mycolwidth \mycolwidth=\hsize
\newdimen\columnsep \columnsep=1pc
        {\advance\n by-1 \global\advance\mycolwidth by-\n\columnsep}%
        \divide\mycolwidth by\n
\newdimen\mytabskip \mytabskip=1pc
\let\CHAR=\char

\hfontdef{hrm}{\myhfont}{\myhfontsize}
\hfontdef{hl}{\myhfont}{8pt}\hfontdef{TINY}{\myhfont}{\mytinyfontsize}

%% \boxme{stuff} put a box around stuff.
\newdimen\Vthickness \Vthickness=.5pt
\def\boxme#1{\vbox{\hrule height\Vthickness
        \hbox{\vrule width\Vthickness#1\vrule width\Vthickness}%
        \hrule height\Vthickness}}
\def\fbox#1{\dimen0=\hsize \advance\dimen0 by-2\Vthickness
  \noindent\boxme{\hbox to\dimen0{\vrule width0pt depth4pt height10pt
  \hss\b #1\hss}}\vskip0pt\kern6pt}

\newdimen\tdim \tdim = \mycolwidth \divide\tdim by2
% \def\startformat{\noindent\hbox to\tdim\bgroup\hskip\mytabskip\hss}
% \def\endformat#1.{\ \ \egroup\hbox to\tdim{\tt #1\hss}\smallskip}
\def\active{13 }\let\ACTIVE=\active
% \let\(=( \let\)=) 
% \catcode`\(=\active \catcode`\)=\active
% \def({\startformat\[\hfont{hrm}} \def){\noboundary\]\endformat}
\def\explain#1{\vbox{\vskip2pt\noindent\raggedright\tolerance=7500
  \hyphenpenalty=0
  \tiny\baselineskip8.5pt \lineskip=.5pt
  #1\endgraf\vskip3pt}}
\def\mkrangles#1{{\tinymi\char`\<}{\tinyit #1}{\tinymi\char`\>}}\let\angles=\mkrangles
\def\\{\char`\\}\def\{{\char`\{}\def\}{\char`\}}

\def\C#1#2{\line{{\ttt\llap{\char`\\}#1\ }\tiny #2\hss}}
\def\CC#1#2{\C{#1}{}\line{\tiny\quad #2\hss}}

\def\C#1#2{\setbox0=\hbox{\ttt #1}\dimen0=\wd0
  \vtop{\hsize=\mycolwidth \raggedright \baselineskip=8.5pt
      \advance\dimen0 by6pt 
      \ifdim\dimen0 > .5\hsize \message{*****}
      \parindent=0pt \leftskip=6pt
      \else \parindent=\dimen0 \leftskip=6pt
      \fi
      \noindent\ttt\llap{\char`\\}\box0\kern6pt
      \ifdim\parindent=6pt \endgraf\fi
      \tiny #2\vrule width0pt depth4pt\endgraf}}
\let\CC=\C
\def\{{{\ttt\char`\{}}\def\}{{\ttt\char`\}}}

\catcode`\`=12 \catcode`\^=11 \catcode`\+=11 \catcode`\$=11
  \catcode`\#=11 \let\SUPERSCRIPT=\LETTER \let\SUBSCRIPT=\LETTER
  \catcode`\>=\LETTER \catcode`\<=\LETTER

%% Boxes
\newbox\consbox  \newbox\specbox  \newbox\defbox
\newbox\eowbox   \newbox\astbox   \newbox\combox
\newbox\dblsbox  \newbox\convbox  \newbox\vowbox \newbox\vowbbox
\newbox\oddbox   \newbox\tropbox  \newbox\tunebox


\fbox{\bf Reference Card for Makor (Version\thinspace 2.1;
        August 2003)}
\centerline{\rm To typeset the character on the left, type the sequence on
the right.}
\smallskip

\let\NB=\noboundary
\def\1{\noindent\hbox to\tdim\bgroup\hskip\mytabskip\hss\[}
\def\2{\NB\ \]\ \ \egroup\hbox to\tdim\bgroup\tt }
\def\3{\hss\egroup\smallskip}
\setbox\consbox = \vtop{\hsize=\mycolwidth
\fbox{Consonants}
\1v\2v\3
\1g\2g\3
\1d\2d\3
\1h\2h\3
\1w\2w\3
\1z\2z\3
\1ch\2ch\3
\1{.t}\2{.t}\3
\1y\2y\3
\1kh_\2kh\3
\1l\2l\3
\1m_\2m\3
\1n_\2n\3
\1.s\2{.s}\3
\1`\2`\3
\1f_\2f\3
\1ts_\2ts\3
\1q\2q\3
\1r\2r\3
\1sh\2sh\3
\1sh^\2sh^\3
\1^s\2^s, ^sh\3
\1s\2s\3
\1th\2th\3}
\setbox\specbox = \vtop{\hsize=\mycolwidth
\fbox{Special Dagesh}
\1b\2b\3
\1k_\2k\3
\1p_\2p\3
\1t\2t\3}
\setbox\astbox = \vtop{\hsize=\mycolwidth
\fbox{Star Convention}
\1'*\2'*\3
\1v*\2v*\3
\1g*\2g*\3
\1d*\2d*\3
\1h*\2h*\3
\1w*\2w*\3
\1z*\2z*\3
\1ch*\2ch*\3
\1.t*\2{.t*}\3
\1y*\2y*\3
\1kh*_\2kh*\3
\1l*\2l*\3
\1m*_\2m*\3
\1n*_\2n*\3
\1.s*\2{.s*}\3
\1`*\2`*\3
\1f*_\2f*\3
\1ts*_\2ts*\3
\1q*\2q*\3
\1r*\2r*\3
\1sh*\2sh*\3
\1sh^*\2sh^*\3
\1^s*\2^s*\3
\1th*\2th*\3
\1s*\2s*\3}
\setbox\dblsbox = \vtop{\hsize=\mycolwidth
\fbox{`Doubles'}
\1'^'\2'^'\3
\1vv\2vv\3
\1gg\2gg\3
\1dd\2dd\3
\1hh\2hh\3
\1ww\2ww\3
\1zz\2zz\3
\1chch\2chch\3
\1.t.t\2{.t.t}\3
\1yy\2yy\3
\1khkh_\2khkh\3
\1ll\2ll\3
\1mm_\2mm\3
\1nn_\2nn\3
\1.s.s\2{.s.s}\3
\1``\2``\3
\1ff_\2ff\3
\1tsts_\2tsts\3
\1qq\2qq\3
\1rr\2rr\3
\1shsh\2shsh\3
\1shsh^\2shsh^\3
\1^shsh\2^shsh\3
\1thth\2thth\3
\1ss\2ss\3}
\setbox\vowbox = \vtop{\hsize=\mycolwidth
\fbox{Basic Vowels}
\1'ae\2'ae\3
\1vei\2vei\3
\1g'\2g'\3
\1da\2da\3
\1he\2he\3
\1wi\2wi\3
\1zu\2zu\3
\1cho\2cho\3
\1.tau\2{.tau}\3
\1.t+\2{.t+}\3
\1oo\2oo\3
\1w*\2w*\3
\1O\2O\3
}
\setbox\vowbbox = \vtop{\hsize=\mycolwidth
\fbox{More Vowels}
\1y:a\2y:a\3
\1kh_:e\2kh:e\3
\1l:+\2l:+\3
\1m_|\2m|\3
\1n_|"\2n|"\3
\1.s|i\2{.s|i}\3
\1`|a\2`|a\3
\1f_|e\2f|e\3
\1ts_|+\2ts|+\3
\1q|'\2q|'\3
}

\setbox\oddbox = \vtop{\hsize=\mycolwidth
\fbox{Miscellanea}
\1-\2-\3
\1=\2=\3
\1---\2---\3
\1"\2"\3
\1\'\2\'\3
\1ts' \2ts'\3
\1'123th\2'123th\3
\1!?\2!?, ?!\3
\1**\2**\3
}

\setbox\eowbox = \vtop{\hsize=\mycolwidth
\fbox{End of Word}
\explain{{\tinyit Makor\/} automatically selects these letterforms at
  word endings.}%
\1kh \2kh\3
\1k \2k\3
\1m \2m\3
\1mm\2mm, m*\3
\1n \2n\3
\1nn\2nn, n*\3
\1f \2f\3
\1p \2p\3
\1ts \2ts\3
\1tsts \2tsts, ts*\3
\1ts' \2ts'\3
}
\setbox\defbox = \vtop{\hsize=\mycolwidth
\fbox{Defective Cholam}
\1bo'\2bo'\3
\1bo\/'aum \2bo\string\/'aum\3
}
\setbox\combox = \vtop{\hsize=\mycolwidth
\fbox{Commands}
\C{[}{start Heb.\ typesetting}
\C{]}{finish Hebrew}
\C{/}{pattern breaker}
\CC{noindent}{suppresses indentation}
\CC{HINDENT}{enforces a Hebrew indentation}
\C{HPAR}{terminates a Hebrew paragraph}
\CC{CENTERLASTLINE}{centers last line of paragraph}
\C{<}{unskip command}
\C{>}{synonym for unskip}
\CC{hfontdef\{HH\}\{ezra2\}\{9pt\}}{defines a Hebrew font for use}
\CC{hfont\{HH\}}{uses the named font}
\C{PrintChar\{242\}}{identifies a character by slot, and prints it}
\C{MakorEnvironment\{MKR\}}{selects typesetting environment}
}
\setbox\convbox = \vtop{\hsize=\mycolwidth
\fbox{Conventions}
\line{{\ttt char^\ }\tiny force final letter\hss}
\line{{\ttt char_\ }\tiny suppress final\hss}
\line{{\ttt ^'\ }\tiny forces \[\hfont{hl}^'\]\hss}
\line{{\ttt _'\ }\tiny forces \[\hfont{hl}_'\]\hss}
}

\setbox\tropbox = \vtop{\hsize=2\mycolwidth \advance\hsize by
  \columnsep \tabskip=3pt plus 6pt minus 3pt
  \fbox{Cantorial Accents}
    \halign to\hsize{%
    \[\hfont{hl}#\]\hfill&\ttt#\hfill&\qquad\[\hfont{hl}#\]\hfill
    &\ttt#\hfill\cr
    %\multispan4\fbox{Cantorial Accents}\cr
    h[etnahta]&       h[etnahta]&       h[telishagedola]& h[telishagedola]\cr
    h[segol]&         h[segol]&         h[pazer]&         h[pazer]\cr
    h[shalshelet]&    h[shalshelet]&    h[munah]&         h[munah]\cr
    h[zaqefqatan]&    h[zaqefqatan]&    h[mahapakh]&      h[mahapakh]\cr
    h[zaqefgadol]&    h[zaqefgadol]&    h[merkha]&        h[merkha]\cr
    h[tipeha]&        h[tipeha]&        h[merhkhakefula]& h[merhkhakefula]\cr
    h[revia]&         h[revia]&         h[darga]&         h[darga]\cr
    h[zarqa]&         h[zarqa]&         h[qadma]&         h[qadma]\cr
    h[pashta]&        h[pashta]&        h[telishaqetana]& h[telishaqetana]\cr
    h[yetiv]&         h[yetiv]&         h[yerahbenyomo]&  h[yerahbenyomo]\cr
    h[tevir]&         h[tevir]&         h[ole]&           h[ole]\cr
    h[geresh]&        h[geresh]&        h[iluy]&          h[iluy]\cr
    h[gereshmuqdam]&  h[gereshmuqdam]&  h[dehi]&          h[dehi]\cr                 
    h[gershayim]&     h[gershayim]&     h[zinor]&         h[zinor]\cr
    h[qarneypara]&    h[qarneypara]&    h[masoracircle]&
    h[masoracircle]\cr}}

\setbox\tunebox = \vtop{\hsize=2\mycolwidth \advance\hsize by
  \columnsep \leftskip = 0pt \parindent = -\leftskip \parskip=4pt \tiny
  \fbox{Adjusting Vowel Placement}
  {\ttt _.4_rau} moves the {\ttt au} vowel 40\% of the width of the glyph
  starting at the left and moving to the right.

  {\ttt _3.5pt,-3.5pt_rau} displaces the {\ttt au} vowel
  3.5\kern1.5ptpt to the {\tinyit left\/} of where it should be and
  3.3\kern1.5ptpt {\tinyit up\/} from where it should be.

  {\ttt ^.9^r[shalshelet]} puts the upper cantorial accent 90\% of the way
  to the right of the left edge.

  {\ttt ^3pt,1.5pt^r[shalshelet]} displaces the upper accent by
  3\kern1.5ptpt to the left and 1.5\kern1.5ptpt up.

{\ttt _1pt,1pt;3pt,3pt_zau[etnahta]} to displace the pair of vowels and
the increase the offset between them. 

}
  
\line{%
  \vtop{\box\consbox \medskip \box\convbox}\hss 
  \vtop{\box\astbox \medskip \box\specbox}\hss 
  \vtop{\box\dblsbox \medskip \box\defbox}\hss 
  \vtop{\box\vowbox \medskip \box\eowbox}\hss
  \vtop{\box\vowbbox \medskip \box\combox}}

\line{\box\tropbox\hss\box\oddbox\hss\box\tunebox}

\bigskip 
\fbox{Creating Makor Documents} 
\tiny\baselineskip=8.5pt 
\noindent
You get:

\noindent\[laukhaen chakoo-liy n''um-ydwd l'yOm qoomiy lau`ad kiy 
mish^'pau.tiy l|e':e.sof gOyim l'qauv'tsiy mam'laukhOs lish^'pokh'
`:alaeyhem za`'miy kol ch:arOn 'apiy kiy b''eish^ qin''ausiy
t|"'+khael k+l-h+'|+rets.\CENTERLASTLINE\]

\noindent{\tinyit(Continued on overleaf.)}
\vfill\eject
\noindent{\tinyit(Continued from overleaf.)}\smallskip
\setbox6=\vtop{\divide\hsize by2 \advance\hsize by-3pt 
\centerline{\b La\TeX/Lambda Documents}\smallskip
\noindent
by running the Lambda file {\ttt ltest.tex} whose contents are
{\ttt\obeylines
\\documentclass\{article\}\\usepackage\{makor2\} 
\\begin{document}
\\noindent\\[laukhaen chakoo-liy n''um-ydwd l'yOm 
qoomiy lau`ad kiy mish^'pau.tiy l|e':e.sof gOyim 
l'qauv'tsiy mam'laukhOs lish^'pokh' `:alaeyhem 
za`'miy kol ch:arOn 'apiy kiy b''eish^ 
qin''ausiy t|"'+khael k+l-h+'|+rets.
\\CENTERLASTLINE\\]\\end\{document\}
}

\noindent through the commands 

{\ttt
lambda ltest

odvips ltest }

\noindent and then printing or displaying the resulting file {\ttt
ltest.ps}.}
\setbox8=\vtop{\divide\hsize by2 \advance\hsize by-3pt 
\centerline{\b Plain \TeX/Omega Documents}\smallskip
\noindent
by running the file {\ttt otest.tex} whose contents are

{\ttt\obeylines
\\input makor2
\\nopagenumbers
\\noindent\\[laukhaen chakoo-liy n''um-ydwd l'yOm 
qoomiy lau`ad kiy mish^'pau.tiy l|e':e.sof gOyim 
l'qauv'tsiy mam'laukhOs lish^'pokh' `:alaeyhem 
za`'miy kol ch:arOn 'apiy kiy b''eish^ 
qin''ausiy t|"'+khael k+l-h+'|+rets.
\\CENTERLASTLINE\\]
}

\noindent through the commands 
{\ttt
omega otest

odvips ltest }

\noindent and then printing or displaying the resulting file {\ttt
otest.ps}.}
\noindent\line{\box6\hss\vrule\hss\box8}
\medskip
\fbox{Makor Fonts}\bigskip
\centerline{\epsfysize=38pc \epsffile{reffonts.eps}}

\baselineskip9pt\bigskip
\def\4#1#2#3#4{\line{\hbox to.5\hsize{{\b #1}\quad\tiny(#2)\hss}%
        \hbox to.5\hsize{{\b #3}\quad(#4)\hss}}}
\fbox{Standard Makor Environments}\smallskip
\4{MKR}{Standard {\tinyit Makor\/} environment}{Lagally}{Arab\TeX\ conventions}
\4{MKRbl}{Standard environment with bent lamed's}{BHS}{Biblia Hebraica Stuttgartensia}
\4{MKRnv}{Standard environment with no vowels}{BHSbl}{Biblia Hebraica Stuttgartensia with bent lamed's}
\4{MKRalt}{Alternative vowel placement on final letters}{BHSnv}{Biblia Hebraica Stuttgartensia without vowels}
\4{MKRdeu}{German {\tinyit Makor\/} environment}{YID}{Yiddish environment}
\bigskip
\noindent 
\line{The main Hebrew font here is {\ttt\myhfont}\ at \myhfontsize. \hss
        Author: Alan Hoenig ({\ttt ahoenig@suffolk.lib.ny.us})}\smallskip
\centerline{You can always download the current version from 
        {\ttt http://www.ctan.org/tex-archive/language/hebrew/makor}}
\centerline{or search for the file {\ttt mkr2man.pdf}, 
the {\it Makor\/} manual.}
\bye


%%% Local Variables: 
%%% mode: plain-tex
%%% TeX-master: t
%%% End: