CHANGES 21.03.1996 -------------------------------------------------------------------------- ArabTeX Version 3 ================= -------------------------------------------------------------------------- 21.03.96: Version 3.04a Fixes: - \baselineskip works correctly with EDMAC - \emphasize puts the overbar at uniform height in \novocalize Necessary action: If required, download the ASCII file "apatch.sty" again. This is a patch for version 3.04! See also version 3.04 below. -------------------------------------------------------------------------- 19.03.96: Version 3.04 Status: - ArabTeX now cooperates well with LaTeX 2e (June 1995 and later) and also still with Plain TeX and LaTeX 2.09. The configuration is determined automatically. With LaTeX 2e ArabTeX and all its suboptions are packages. - The internal structure has changed extensively; this need not trouble the user. Fixes: - \baselineskup, \parskip, \baselinestretch now work correctly in the Arabic modes. - The TeX special characters \#, \$, \%, \& can now be used (they just had been forgotten). - A number of minor bugs have been fixed. Modifications: - Digits and punctuation have been raised to the writing line. We feel this looks better. - The handling of numbers (= digit sequences) has been improved. Within a number, the decimal separator is the comma. - Bidirectional line-breaking has again been much improved. The command \goodpar still works but is rarely required. - The option "abidir" is no more necessary. - The option "nashbf" is no more necessary. - The option "abjad" is no more necessary. Additions: - User defined macros can be made known to ArabTeX by the declaration \allowarab {\macro_name} (previous to their use within an Arabic environment). The replacement text after substituting the parameters must be legal ArabTeX input and may contain further macro calls. The macro must be previously defined via \newcommand or \def. - The Arabic Windows encoding is supported; load the reading module by \input arabwin.sty, \usepackage {arabwin} or by adding the LaTeX 2.09 option "arabwin". Activate it by the command \setcode {arabwin}. - There are some additional transliteration modes for Persian and Urdu; in case of interest: inquire directly. - The package "raw.sty" defines the command \setraw to switch off all special processing for numbers, special characters and parentheses. This may be helpful for OCR work. Switch back by \unsetraw. - The (experimental) LaTeX 2e class file "arabart.cls" provides an Arabic article format. Within Arabic environments a number of LaTeX commands are enabled: sectioning, list environments, page headers and footers, table of contents, footnotes, quote, quotation, verse, center, twocolumn. All text arguments are considered to be Arabic text in the chosen encoding. Some of the LaTeX environments are missing, e.g., tabular and tabbing, minipages, pictures. They can usually be simulated by leaving the Arabic environment and reverting to the standard LaTeX commands. We are working on extensions to this format; suggestions and bug reports are welcome. We do not intend to supply a version for LaTeX 2.09. - See also the comments on Version 3.03 below. - The notes in README.303 still apply. Hints: - Uniform baselines may be obtained by setting \lineskiplimit to -\baselineskip and adjusting \baselinestretch to 1.4 (with LaTeX) or \baselineskip to 1.4\baselineskip with Plain TeX. Some experimenting is advised. - If you want to process the manual "arabdoc.tex" under LaTeX 2e first move the file "arabimax.tex" to the REPORT subdirectory. You will get some error messages on the first run. Forget them and process the file again; LaTeX 2e is to blame. Warning: the report is not quite up to date. - Put any local macro definitions into the LaTeX preamble or else precede them by \setnone; thus the < sign can be used in the normal meaning as a comparison operator. Activate short Arabic insertions again by \setarab or any other of the commands for language choice. - PiCTeX users may use Arabic labels within diagrams if and only if these are included in \< and > (NOT < and >). - If you use MlTeX and the output looks broken, note the version number of MlTeX and inform us. Complaints: - There is STILL no Nasta`liq font. Known bugs: - None as yet. How to move from versions 3.00, 3.01, 3.02, 3.03 to version 3.04: - completely replace the contents of the subdirectory TEXINPUT - read and/or print "README.303" - if interested, process the user manual "arabdoc.tex"; see the hints above. How to move from earlier versions to version 3.04: - proceed as with version 3.00 below. -------------------------------------------------------------------------- 04.07.95: Version 3.03e Fixes: - Final yah before hamza works again Necessary action: If required, download the ASCII file "apatch.sty" again. See also version 3.03d -------------------------------------------------------------------------- 24.05.95: Version 3.03d Fixes: - After switching to other encodings switching back to the standard encoding works again. - An empty \RL {} insertion will no more blow the system. Problems: - see version 3.03c Necessary action: If required, download the ASCII file "apatch.sty" again. See also version 3.03c -------------------------------------------------------------------------- 02.05.95: Version 3.03c Fixes: - The METAFONT routines for the fonts "nash14" and "nash14bf" used a file "asymbols.mf" that conflicted with the AMS-Fonts. This file has been renamed to "arabsymb.mf". To use the new version, download "arabsymb.mf" and "nashbase.mf" from the subdirectory ARABTEX/MFINPUT and delete "asymbols.mf". This only concerns users who need to regenerate the fonts locally. Problems: - The font "dclassic" used by the Hebrew mode of ArabTeX has on the archive "noa.huji.ac.il" been replaced by a new version that is incompatible to the previous version while keeping the same name. We are working on a solution to resolve the ensuing compatibility problems. Users of the previous version are not affected. Acknowledgment: - The routines for building up punctuated Hebrew characters have profited from macros written by Joel Hoffmann and contained in his packages "dots.sty" and "hvowel1.sty". We apologize for not pointing out this fact clearly. Necessary action: - Normally none, except if indicated above. -------------------------------------------------------------------------- 24.04.95: Version 3.03b Fixes: - The handling of single and double quotes, and of other special characters, in the ASMO 449 and ISO 8859-6 encodings has been improved. - After a punctuation character inside a word (usually an error) no space will be produced. - on <'alif maqsUraT> works again. - In \setverb mode, a on <'alif> now works. - In \setverb mode, may be used to produce <'alif>. - The ligature is produced instead of . - , etc. before now have the short form. Known bugs in ArabTeX: - \begin{arabtext} inside a minipage will produce a spurious empty line; the reason is unknown. Hints: - Numbers after quotes will not be recognized as such and thus will be reversed; as a workaround, leave a space around the digits, e.g., <`` 1234 ''> or use a \nospace command, e.g., <`` \nospace 1234 \nospace ''>. Mind the spaces before the \nospace commands in the example! - With LaTeX2e, load ArabTeX and its suboptions by the command \usepackage. Necessary action: If required, download the ASCII file "apatch.sty" again. -------------------------------------------------------------------------- 28.03.95: Version 3.03a Fixes: - A workaround for an error in some versions of ML-TeX has been tentatively introduced. Non-ML-TeX users may safely ignore this. Known bugs in ArabTeX: - None as yet. If required, download the ASCII file "apatch.sty" again. -------------------------------------------------------------------------- 10.03.95: Version 3.03 Fixes: - A number of minor bugs have been fixed, nothing dramatic. - The spacing of punctuation has been improved. Modifications: - Hebrew vowel points are provided. Hebrew mode now uses the font "dclassic". It can be downloaded e.g. from "noa.huji.ac.il". Additions: - The Hebrew encoding used in the machine readable version of BHS is supported. See README.303! - \obeylines and \obeyspaces also work for Arabic text. They however must be used in a group that contains the Arabic text AND this group must be followed by at least one space. - An inside a \verbatim environment will be typeset in Arabic. Big TeX may be necessary. An Arabic environment will be typeset verbatim. - \vskip, \hskip, \vspace, \hspace, \newpage, \vfill are legal in Arabic mode. - A list of the loaded modules is put into the log file. Known bugs: - None as yet. How to move from version 3.00, 3.01 or 3.02 to version 3.03: - completely replace the contents of the subdirectory TEXINPUT - move the updated files "arabdoc?.tex" from the outermost level to the subdirectory "REPORT" - read and/or print "README.303" How to move from earlier versions to version 3.03: - proceed as with version 3.00 below. -------------------------------------------------------------------------- 12.08.94: Version 3.02b Fixes: - \fullvocalize mode uses somewhat less TeX main memory than before but might still overflow; using \newpage explicitly could help - some ligatures have been improved - spacing has been improved in short insertions when the transliteration is also generated - in Hebrew mode, HED encoding, double letters work again - explicit spreading works again correctly - in rare cases had the wrong carrier - if an Arabic word starts with a vowel, "quoting" toggles if no vowel is given in the input - bidirectional line-breaking has been much improved. The command \goodpar is rarely necessary Hints: - etrans.sty is no more necessary; load atrans.sty - \settrans{english} switches to the romanization conventions of the Library of Congress If required, download the ASCII file "apatch.sty" again. -------------------------------------------------------------------------- 19.07.94: Version 3.02a Fixes: - in Arabic, alif maqsura after tanwin works again - in Hebrew, before an apostrophe the medial form is used - in Hebrew, hyphen/maqqef works correctly Hints: - with Plain TeX (and/or EDMAC) only: load the ASCII file "apatch.sty" explicitly as the last file! If required, download the ASCII file "apatch.sty" again. -------------------------------------------------------------------------- 14.07.94: Version 3.02 Fixes: - some minor bugs have been corrected - the User Manual has been slightly updated, but is otherwise somewhat out of date. Modifications: - for storage reasons the transcription module is not loaded automatically; add the LaTeX option "atrans" if required, or say "\input atrans.sty". Additions: - EDMAC 3.00 and EDMAC 3.15 are both supported. - the LaTeX option "abidir" provides the new command \RL {text} for right-to-left insertions; it is used like which is still provided, and which should be used wherever possible for reasons of efficiency. - the LaTeX option "hebtex" loads the modules for processing text in Hebrew. Switch to Hebrew by \sethebrew, and back to Arabic by \setarab. Hebrew text can be coded in the standard ArabTeX input notation, or in the encoding used by the editor HED; the latter coding is activated by \setcode {hed}. The reading module is supposed to also process texts in "newcode" (not tested!) - For using the Hebrew mode, the font "deadsea" must be available; it can be downloaded e.g. from "noa.huji.ac.il". Vowels are presently not provided. - For details see the ASCII file "readme.302". Hints: - only load the modules really required, or you might have to use a Big TeX! Known bugs: - None. How to move from version 3.00 or 3.01 to version 3.02: - completely replace the contents of the subdirectory TEXINPUT - move the updated files "arabdoc?.tex" from the outermost level to the subdirectory "REPORT" - read and/or print "README.302" How to move from earlier versions to version 3.02: - proceed as with version 3.00 below. -------------------------------------------------------------------------- 05.05.94: Version 3.01a Fixes: - \parskip now has effect also inside Arabic environments. Additions: - The EDMAC commands \pstart, \pend, \autopar are allowed inside an Arabic environment, IF properly nested. If required, download the ASCII file "apatch.sty" again. -------------------------------------------------------------------------- 28.04.94: Version 3.01 There has been extensive internal rewriting but the external effects are minor. - \setarab is the language default again. It will no more break the user's macro definitions IF these are put into the LaTeX preamble, or before "\input arabtex.sty" when using Plain TeX. Fixes: - Spaces are normally ignored after allowed control sequences inside Arabic text, (if not produced by the command itself.) - The spacing between a final silent in Persian and the next word has been improved. - An error in "twoblocks.sty" has been corrected that produced a spurious vertical space. - An error in "asmo449.sty" has been corrected that produced nonsense from the combination "Gdr" (article with an explicit ) - In "abjad.sty", the for the numeral 3 has no dot. Additions: - The commands \smallskip, \medskip, \bigskip, \newpage, \clearpage, \pagebreak, \hskip {glue}, \vskip {glue}, \today now work inside Arabic text. - there is a new language mode: \setturk for Ottoman. The input notation has been extended to cover both the standard and the modern Turkish transliteration. The documentation remains to be written :-( - there is a new language mode: \setkurdish for Kurdish. The documentation remains to be written :-( - "" produces an explicit except in \fullvocalize mode where it deletes a otherwise present. - The new commands \setarabfont {\nash} or \setarabfont {\nashbf} supersede \setnash and \setnashbf (which are still supported). Known bugs: - None. Hints: - The LaTeX style option "atrans" is redundant. - After changing the input coding, select the language mode and the vowelization mode anew (this is a feature :-). How to move from version 3.00(-, a, b) to version 3.01: - completely replace the contents of the directory TEXINPUT - observe that there is a new file "acmd.sty" How to move from earlier versions to version 3.01: - proceed as with version 3.00 below. -------------------------------------------------------------------------- 07.12.93: Version 3.00b Fixes: - corrected handling of in \setverb mode. - improved error handling for illegal commands. - ligature - also in spreading mode. Additions: - \setspace{rubber_length} changes the default for spaces in Arabic text; 3pt plus .5fil is recommended for \spreadbox. Known bugs: - arguments of boxing commands may not contain insertions. - in ASMO449, the combination Gdr (article with an explicit sukoon) will produce nonsense. Hints: - There is no language default. Do not forget \setarab etc. or otherwise you might get strange results. - After changing the input coding, select the language and the vowelization mode anew (this is a feature). These are in the manual but easily overlooked. If required, download the ASCII file "apatch.sty" again. -------------------------------------------------------------------------- 26.11.93: Version 3.00a Fixes: - the carrier is now the before diphthong Additions: - more Qur'anic writing variants provided - \hfil is allowed in Arabic text -------------------------------------------------------------------------- 20.11.93: Version 3.00 Status: - large portions of the code have been rearranged and partly rewritten - The User Manual has been extensively updated and describes all (supported) ArabTeX features currently implemented - Version 3.00 seems to be compatible with Version 2 files - NFSS and NFSS2 can be used but are not required - all known bugs have been removed - Version 3.00 still can be run (slowly) on a standard PC XT Additions: - texts coded in ASMO 449 or ISO 8859-6 can now be processed - several historic writing variants are additionally supported - details of Farsi support are now described in the User Manual - many new commands are valid inside Arabic text; a complete list appears in the log file of each ArabTeX run, and also in the new User Manual - see also versions 2.00 - 2.08 below -------------------------------------------------------------------------- How to move from version 2.0x, 0 <= x <= 8, to version 3.00: - completely replace the contents of the directory TEXINPUT - completely replace the contents of the directory REPORT - process AND READ the new User Manual "arabdoc.tex" - leave the fonts alone How to move from version 1 (or none at all) to version 3.00: - Do as above; install the fonts "nash14" and "nash14bf" first according to local TeX conventions. - If the font "nash10" is still there, delete it. -------------------------------------------------------------------------- ArabTeX Version 2 ================= -------------------------------------------------------------------------- 25.10.93: Version 2.08 (not widely distributed) Status: - all corrections in version 2.07 have been incorporated; there has been extensive rearrangement of code - all known bugs have been removed - some details in the manual have been rearranged; otherwise the manual is slightly out of date Additions: - \footnote in Arabic text now also works inside a minipage - more commands are valid inside Arabic text; a complete list appears in the log file - see also versions 2.07a - d below How to move from version 2.0x, 0 <= x <= 7d: - install all files in the directory TEXINPUT anew - replace "arabdoc.tex", "arabdoc0.tex", "arabdoc.ind" in the directory REPORT - leave the fonts alone How to move from version 1 (or none at all) to version 2.08: - Do as above; install the fonts "nash14" and "nash14bf" first according to local TeX conventions. - If the font "nash10" is still there, delete it. -------------------------------------------------------------------------- 01.07.93: Version 2.07d Fixes: - "quoting" for and works now correctly. - for silent in Persian works as described. Additions: - instead of <^g> for , and instead of <_h> for are now legal, but not recommended. If required, download the ASCII file "apatch.sty" again. -------------------------------------------------------------------------- 04.05.93: Version 2.07c Fixes: - a modification that will usually prevent a known bug in Ml-TeX from doing too much harm. May be ignored by non-Ml-TeX-users; otherwise download the new version of "apatch.sty". -------------------------------------------------------------------------- 26.03.93: Version 2.07b New features: - The commands \smallskip, \medskip, \bigskip, \input filename work also inside an arabic environment - works like : is like . There always was for , for . - Download the "apatch.sty" ASCII file again if you have already installed the version 2.07. -------------------------------------------------------------------------- 25.03.93: Version 2.07a Fixes: - There was a subtle interaction with the \tabular environment which prevented printing of the user manual. - Download the "apatch.sty" ASCII file again if you have already installed the version 2.07. - The compressed versions have been corrected. -------------------------------------------------------------------------- 22.03.93: Version 2.07 Policy: - ArabTeX is still free for scientific purposes, but we should appreciate receiving an offprint of any publication produced by using ArabTeX, for our collection. This does not apply to any personal correspondence. Status: - There have been extensive changes to all "*.sty" files. - Many minor errors have been fixed. - There is a new file "aedpatch.sty". - The tentative features of version 2.06 have been incorporated. - The command processing has been completely reworked and is believed to be more robust. - The font has not changed. - The user manual has not yet been updated; visible changes are minor. New features: - ArabTeX is now compatible with the EDMAC package for critical editions (see TUGboat 11/1, 623-643 (1990)). Just load ArabTeX *after* loading EDMAC. The necessary extensions will be loaded automatically via "aedpatch.sty". - All arguments of EDMAC commands are considered "Roman" text but may contain arabic insertions. Changes and extensions: - Arabic insertions may now also contain commands. - Most Plain TeX or LaTeX commands that make sense in an arabic environment are now allowed, as well as in arabic insertions. - Font, mode and size changing commands obey the normal grouping rules. - The commands \footnote and \marginpar work now both in Plain TeX and LaTeX mode; observe the different calling conventions! - The \marginpar command inside arabic text works also with Plain TeX, analogous to the LaTeX \marginpar command; marginal notes always go to the right margin. If this feature is used, the user may have to adjust the parameters \marginparwidth, \marginparsep, and \hsize accordingly. - The new options \accentshigh and \accentslow influence the positioning of the diacritical marks. \accentslow is the default. - The new options \oldtanwin and \newtanwin influence the position of : on the last consonant or on the final if applicable. Defaults are language dependent. - A group of arabic words can be emphasized by overlining; this is effected by \emphasize {arabic words}. - A group of arabic words, if enclosed in curly braces, is not split across a line boundary. - A final silent in Persian can be denoted , , or . Known problems: - None at present. How to move from versions 2.05 - 2.06 to version 2.07: - Replace all "*.sty" files - The fonts "nash14" and "nash14bf" are unchanged. How to move from versions 2.00 - 2.04 to version 2.07: - As above; add the manual files "arabdoc*.*" in the directory "report" and process them to get the User Manual. How to move from version 1 (or none at all) to version 2.07: - Do as above; install the fonts "nash14" and "nash14bf" first according to local TeX conventions. - If the font "nash10" is still there, delete it. ----------------------------------------------------------------------- 02.12.92: Version 2.06 Status: - This is an experimental version processing some Persian features differently; otherwise identical to version 2.05. - This version is NOT part of the packages "arabtex.zip" and "arabtex.tar.Z"; instead there are additional ASCII files "apatch25.sty", "apatch26.sty", and "arab2-06.doc". Thus installing it does not destroy a working version 2.05. - This version has not been extensively tested. - Moving back and forth between versions 2.05 and 2.06 is easy. - For details: see the file "arab2-06.doc". -------------------------------------------------------------------------- 05.11.92: Version 2.05 Status: - There is a new User Manual "arabdoc.tex" in the subdirectory "report". It contains many examples for the use of ArabTeX; some of them also show several small extensions for special cases which are not otherwise documented, but supported. - The new User Manual is in ArabTeX format for local printing, so it serves at the same time as an extensive installation test. A hard-copy version is available on request; write to the author and enclose DM 10 (outside of Europe US$ 10) to cover printing and mailing expenses. For additional DM 5 (US$ 5) you can also get the software on diskette (please indicate computer system, TeX implementation version, and desired diskette format). - The "*.sty" files have been updated so that the system works (apparently) exactly as described in the User Manual; some small bugs that have shown up in the meantime have been fixed. Changes and extensions: - The vowel marks, if shown, are now positioned at about the same height from the baseline. - Arabic words can be emphasized by overlining. - A group of arabic words, if enclosed in curly braces, is not split across a line boundary. - A final mute "hah" in Persian can be denoted , , or . How to move from versions 2.00 - 2.04 to version 2.05: - Replace all "*.sty" files - Add the manual files "arabdoc*.*" in the directory "report" and process them to get the new User Manual. - The fonts "nash14" and "nash14bf" are unchanged. How to move from version 1 (or none at all) to version 2.05: - Do as above; install the fonts "nash14" and "nash14bf" first according to local TeX conventions. - If the font "nash10" is still there, delete it. Known problems: - The non-arabic language modes have not been extensively tested. - The text file "arabtex.doc" can be used as a first introduction, but does not describe all features. For full details, see the User Manual. -------------------------------------------------------------------------- 05.08.92: Version 2.04 Status and fixes: - see also Version 2.03 below - "awrite.sty" has been extensively restructured to ease further maintenance - the storage utilization is somewhat better, the running time is about the same as with version 2.02 Changes: only format and contents of THIS file How to move from version 2.02: - replace aparse.sty, awrite.sty, aligs.sty or: reinstall all *.sty files if that is easier - the font has NOT changed, leave it alone How to move from version 2.00: - replace all *.sty files, including "apatch.sty" (new) - the font has NOT changed, leave it alone - there is a new demo for Farsi: "omar.tex" -------------------------------------------------------------------------- 01.08.92: Version 2.03 (not distributed) Status and fixes: - a rare but grave bug has been fixed; it made ArabTeX explode on and a few related words. - to fix the bug, the internal interface of "aparse.sty", "awrite.sty", and "aligs.sty" had to be altered drastically. Changes: none -------------------------------------------------------------------------- 03.05.92: Version 2.02 Status and fixes: - there have been extensive changes to nearly all "*.sty" files - the Nasta'liq font is still missing; sorry, but at the moment there is no free time to design it. For the meantime, Naskh will be substituted automatically, and should be readable. - the problem with ^ and _ has been fixed; they now work correctly in all modes - the <~n> problem has been fixed - the prefix before with below now works, as e.g. in - short Arabic quotations may be used in moving arguments in LaTeX, e.g. section names, frameboxes, captions, margin notes and the like - Farsi and related languages: and now seem to work correctly. Changes: - in Farsi and related languages, the final after and is NO MORE generated automatically; you have to write it explicitly if you want it. THIS IS NO BUG: the old strategy was found to be inconsistent. - the additional option \showtrue will echo the ASCII input verbatim; \showfalse will switch this mode off again. This feature is intended for test purposes; it might not work in all contexts, and could disappear again. - there is a new file "apatch.sty" which is loaded automatically and will contain last minute corrections (none at the moment) Open problems: - see "bugs" and "fixes" below Hints: - with LaTeX, the option "arabtex" should ONLY be followed by its local sub-options like "nashbf" or "atrans"; put other options BEFORE it and DON'T define any own commands that use "<"; use ">" instead. - with Plain TeX, define your own macros BEFORE "\input arabtex". How to move from version 2.00 or 2.01: - replace all *.sty files, including "apatch.sty" (new) - the font has NOT changed, leave it alone - there is a new demo for Farsi: "omar.tex" -------------------------------------------------------------------------- 15.04.92: Version 2.01 (was available on direct request) Status and fixes: - Temporary patch for the ^ and _ problem (thanks, Bernd Raichle!) but still does not work in moving arguments More known bugs: - \footnote does not work (we never promised it would, but will think about it) - \footnotemark may put the mark into unexpected places if used within an Arabic Environment; however: \footnotetext works outside Arabic Environments even with Arabic text in angle brackets - the prefix as in will produce garbage - <~n> will blow up How to get the version: DON'T, this version is obsolete -------------------------------------------------------------------------- 10.04.92: Version 2.0 Version 2.00 is here at last. See "README". Changes from version 1: - now compatible with Plain TeX - new (hopefully) better looking font - many ligatures generated automatically - support for Farsi, Urdu, Pashto, Ottoman, Maghribi - some more documentation - the input coding has changed slightly Implementation status: - all macro files have version number 2.00 - only fonts nash14 and nash14bf, no nasta`liq font yet available - ArabTeX was developed on a PC AT with emTeX and is known also to run on a PC XT and a U*IX work station; therefore it is supposed to be easily portable - language options other than Arabic have not been extensively tested Known bugs: - control sequences inside of curly braces do not work - arabic insertions may still be started with < - < is an active character and may conflict with the user's macros - ^ and _ do not work correctly in math environments - some troubles with in Farsi -------------------------------------------------------------------------- Prof. Klaus Lagally Institut fuer Informatik Universitaet Stuttgart Breitwiesenstrasse 20-22 D-70565 Stuttgart GERMANY lagally@informatik.uni-stuttgart.de FAX: +49 - 711 - 7816 370 -------------------------------------------------------------------------- Copyright (c) 1990 - 1996, Klaus Lagally --------------------------------------------------------------------------