README.302                                                      14.07.1994
--------------------------------------------------------------------------
                           ArabTeX Version 3.02
                           ====================
--------------------------------------------------------------------------
          Additional features not described in the User Manual
--------------------------------------------------------------------------

	1. Bidirectional linebreaking
	-----------------------------
	Within a Roman paragraph, Arabic insertions may be included
	by the construct \<Arabic text> ( <Arabic text> initially does
	the same but may be redefined by the user for other purposes).
	This construct, though efficient, has the inherent limitation
	that the contents must fit on the current line, or else the
	user has to break the text by \| or \break at some reasonable
	place. Likewise, within an Arabic paragraph Roman insertions
	may be included by <Roman text>, with the same limitations.

	In many cases, as e.g. in the User Manual, insertions are very
	short by nature, so the limitations pose no problem. For other
	applications where the included quotations are much longer than
	part of a line, some additional commands are provided. These are
	much less efficient and also have a high demand on storage, so
	they are not automatically provided, and should only be used with
	care. For accessing these additions, install an additional module
	by the LaTeX option "abidir", or with Plain TeX \input abidir.sty.

	- \RL {Arabic text} allows an insertion of arbitrary length; the
	lines will be broken automatically. Due to some limitations that
	are inherent in TeX's algorithm, the line containing the start of
	the insertion may come out underfull, and also its baseline may be 
	broken. Whenever this happens (only in main vertical mode, never 
	within footnotes, parboxes, or minipages), use of the command
	\goodpar {paragraphs} may help (see below.)

	- \LR {Roman text} does the same for long Roman insertions in an
	Arabic paragraph. Here there is no problem with the baseline.

	- \goodpar {Roman paragraphs} will fix the problems with \RL for 
	insertions within the included paragraphs, but might lead to main 
	memory overflow; so use it with care, or use Big TeX.

	- \mbox {\RL {Arabic text}} is equivalent to \<Arabic text>: no
	line-breaking, as usual.

	- \RL in Arabic mode, and \LR in Roman mode, do no harm but are
	redundant.

	- the user may, at her/his own risk, include \LR portions within
	\RL portions, and vice versa. This may lead to some interesting
	effects (for details, see: Donald E. Knuth and Pierre MacKay,
	Mixing right-to-left texts with left-to-right texts, TUGboat,
	Volume 8(1987), No. 1, p. 14 - 25)

--------------------------------------------------------------------------

	2. Processing Hebrew with ArabTeX
	---------------------------------
	An experimental extension that (partially) supports Hebrew may
	be installed by the LaTeX option "hebtex", or \input hebtex.sty.
	It provides an additional language mode \setheb, which is also
	the default after loading, and several common encodings of texts
	in Hebrew, that may be switched by the \setcode command. The
	default encoding is compatible with Dov Grobgeld's editor HED,
	so files prepared for HebrewTeX are supposed to be compatible,
	if they do not use any special HebrewTeX commands except \R, 
	which is equivalent to \RL, and \L, which is equivalent to \LR, 
	see above. If these commands are used the option "abidir" must
	be added. Hebrew "newcode" encoding probably works too, but has 
	not yet been tested. In addition, the standard ArabTeX encoding 
	is also available, see below.
	
	- \setheb switches to Hebrew (also default), \setarab to Arabic.
	Remember to switch the encoding and the vowelization mode too!

	- \setcode {heb} or \setcode {newcode} activates the reading
	module for the Hebrew characters in code positions 128 .. 154 
	as generated by HED, and also in code positions 224 .. 250. 

	- \setcode {standard} or \setcode {arabtex} switches to the
	standard encoding, defined as follows:

	'   aleph	b   beth	g   gimel	d   daleth
	.h  he		w   waw		z   zayin	_h  chet
	.t  teth	y   yod		k   kaph	l   lamed
	m   mem		n   nun		s   samekh	`   ayin
	p   pe		.s  sade	q   qof		r   resh
	,s  sin		^s  shin	S   s(h)in	t   taw

	Note: without punctuation, sin, shin and s(h)in look identical;
	otherwise "sin" has a dot to the left, "shin" a dot to the right,
	"s(h)in" is the form without a dot.

	Vowels (in preparation) are coded as follows:

	a pathach	_a qames    A qames 	  .a chateph patach
 	e segol	 	_e sere	    E sere yod	  .e chateph segol
	i chireq	_i chireq   I chireq yod  .i shewa
	o qames chatuph _o cholem   O cholem waw  .o chateph qames
	u qibbus	_u shureq   U shureq waw

	Note that there are some alternative encodings.

	- \transtrue activates the standard ZDMG transcription, if the
	option "atrans" is given. Adding the option "hetrans" provides
	for additional transcription systems:

	- \settrans {zaw) switches to the conventions of "Zeitschrift
	fuer die Alttestamentliche Wissenschaft";

	- \settrans {gesenius} activates the system used in W. Gesenius'
	Hebrew Grammar, 26th edition.

	- \settrans {standard} restores the standard ZDMG transcription.

	Restrictions:

	- Presently ArabTeX provides no own Hebrew font but uses the font
	"deadsea" available at many places, and which can be downloaded
	e.g. from "noa.huji.ac.il", /tex/fonts. This font contains no
	vowels, and thus vowelization can be neither used nor tested.

	- For the same reason, punctuation is not yet available, and not
	described here.

--------------------------------------------------------------------------

	3. Support for Arabic Windows
	-----------------------------
	Isam G. Ishaq programmed, and donated, a new reading module for 
	the Arabic encoding supported by Arabic Windows. It is installed
	as a LaTeX option "arabwin" and activated by \setcode {arabwin}.
	Some documentation is contained in the file "arwindoc.tex"; try
	to process it with ArabTeX, or just read the ASCII text.

	As we had no opportunity to test it, this module is supplied as
	is, without any warranty or support.

--------------------------------------------------------------------------

	4. Support for EDMAC
	--------------------
	In the transition from EDMAC 3.00 to EDMAC 3.15, some internal
	interfaces have changed. ArabTeX 3.02 will adjust itself to the
	version used automatically.

	The EDMAC commands \pstart, \pend, and \autopar can now also be
	used within an Arabic paragraph.

--------------------------------------------------------------------------
	    Prof. Klaus Lagally
	    Institut fuer Informatik
	    Universitaet Stuttgart
	    Breitwiesenstrasse 20-22
	    D-70565 Stuttgart
	    GERMANY

	    lagally@informatik.uni-stuttgart.de
--------------------------------------------------------------------------
	Copyright (c) 1990 - 1994, Klaus Lagally
--------------------------------------------------------------------------
