README.303 02.05.1995 -------------------------------------------------------------------------- ArabTeX Version 3.03 ==================== -------------------------------------------------------------------------- Additional features not described in the User Manual | For changes after version 3.02 see change bar in the margin -------------------------------------------------------------------------- 1. Bidirectional linebreaking ----------------------------- Within a Roman paragraph, Arabic insertions may be included by the construct \ ( 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 , 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 activated, 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 \: 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 \sethebrew, and several | common encodings of texts in Hebrew, that may be switched by | the \setcode command. One of the encodings 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. | For use with Plain TeX, say "\input hebtex"; ArabTeX and the | Hebrew extension will be loaded. | - \sethebrew switches to Hebrew, \setarab back to Arabic. Remember to switch the encoding and the vowelization mode too! - \setcode {hed} 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 ("newcode"). | If this encoding is used, vowel points, dagesh and meteg cannot | be used as they cannot be coded in the input. Abbreviations may | be expressed by a single or double apostrophe (right quote). | The final and the medial forms of characters are equivalent, | as ArabTeX chooses the appropriate shape automatically. - \setcode {standard} or \setcode {arabtex} switches to the standard encoding, defined as follows: ' aleph b beth g gimel d daleth .h heh w waw z zayin _h chet .t teth y yod k kaph l lamed m mem n nun s samekh ` ayin p peh .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" has a dot to the right, "s(h)in" is the form without a dot. | There are some alternative encodings for soft consonants: | | v for b f for p h for .h | - \vocalize (default) switches on vowels and special punctuation; | \novocalize switches them off again: Vowels 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. | "dagesh" is coded by doubling the consonant; thus two equal | consonants in sequence must be separated by some | short vowel indicator even in \novocalize mode. | This only applies to the standard encoding. | "meteg" is indicated by | after the vowel. | "maqqef" is -- (en-dash; a single hyphen will be ignored) | "raphe" and cantillation marks are not supported. | Abbreviations may not be used in this mode as we know of no | obvious way of coding them (sorry; any ideas ?). | - setcode {bhs} switches to the encoding used in the machine- | readable version of BHS. Add "bhs" as a LaTeX style option, | or say \input bhs.sty. The line-breaks of the source are | (usually) respected. BHS line numbers and comments are only | partially supported. - \transtrue activates the standard ZDMG transcription, if the LaTeX 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 "dclassic" available at many places, and which can be | downloaded e.g. from "noa.huji.ac.il", /tex/fonts. || This font has been derived from the font "hclassic" designed || by Joel Hoffman, who also wrote some macro packages from which || we took some ideas for positioning punctuation. | For using other fonts, ask the author. -------------------------------------------------------------------------- 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 (as usual) nor support. -------------------------------------------------------------------------- 4. Support for EDMAC -------------------- In the transition from EDMAC 3.00 to EDMAC 3.15, some internal | interfaces have changed. ArabTeX 3.03 will adjust itself to the version used automatically. The EDMAC commands \pstart, \pend, and \autopar can now also be used within an Arabic paragraph. -------------------------------------------------------------------------- | 5. Module Reporting | ------------------- | A complete list of the modules loaded in a particular run will | be put into the log file (before the run statistics), if LaTeX | is used. This is believed to be useful when tracing down errors. | This list is also available to the user, also with Plain TeX, | as the contents of the new control sequence \arabtexconfig. | This feature may disappear again. -------------------------------------------------------------------------- | 6. Running ArabTeX with LaTeX2e | ------------------------------- | Up to now we experienced no problems; the only changes we found | necessary are loading ArabTeX and its suboptions not as class | options but by using the command \usepackage. -------------------------------------------------------------------------- Prof. Klaus Lagally Institut fuer Informatik Universitaet Stuttgart Breitwiesenstrasse 20-22 D-70565 Stuttgart GERMANY lagally@informatik.uni-stuttgart.de -------------------------------------------------------------------------- Copyright (c) 1990 - 1995, Klaus Lagally --------------------------------------------------------------------------