CHANGES                                                        06.08.1997
--------------------------------------------------------------------------
                             ArabTeX Version 3
                             =================
--------------------------------------------------------------------------
        Note: Version management:

        - We distinguish major versions "m.00", minor versions "m.nn"
          with nn > 0, and patch versions "m.nnx" with "x" nonempty.

        - to update from an older major version: reinstall completely.

        - to update from an older minor version: replace the contents of
          "TEXINPUT" and, if so indicated, "REPORT".

        - to update from an older patch version: replace the ASCII files 
          "apatch.sty" and, if you use Hebrew, "hepatch.sty". These files 
          are accessible as unpacked text files.

        - Patches within the same minor version are cumulative. To undo
          a patch, edit out the current additions from "apatch.sty" and,
          if applicable, "hepatch.sty" (save a copy first!)
        
--------------------------------------------------------------------------
06.08.97: Version 3.06

	Status:
        
        - This is a new minor version. All existing patches have been 
          merged into the respective macro files.
        - This doc file has been trimmed down; history information up to
          version 3.00 has been moved to "changes2.txt".
        - Several file names of the mini-documentation have been changed 
          to lower case and carry the suffix ".txt", for the benefit of
          certain web-browsers. See also the file "arabtex.htm".

	Fixes:

        - some minor bugs have been fixed that had introduced spurious
          spaces or newlines when switching between Arabic and Hebrew.
        - "kashida" (--) between a consonant and a (long or short) vowel 
          will no more split the vowel indicator from the consonant glyph.

	Additions:

        - the new command "\setsindhi" will switch to a language mode for
          Sindhi in an extended Arabic script. For details, process and
          read the file "sindhi.tex".
        - the new command "\setuighur" will switch to a language mode for
          Uighuric in an extended Arabic script. For details, process and
          read the file "uighur.tex".
        - the new command "\setmalay" will switch to a language mode for
          Old Malay (Jawi) in an extended Arabic script. For details, 
          process and read the file "malay.tex".
        - These new language modes are strictly experimental and just a
          starting point. As the author speaks none of these languages,         
          feedback and comments by interested users are badly needed.

--------------------------------------------------------------------------
19.06.97: Version 3.05h

	Fixes:

	- some ligatures with "kaf" have been improved.
        - "quoting" of "wasla" works in all vowel modes.
        - "kashida" works also before long vowels.
        - breaking of ligatures works correctly also with long vowels
          and in combination with "quoting".
                
--------------------------------------------------------------------------
12.06.97: Version 3.05g

	Fixes:
                
        - a bug fix for the new Sindhi module has been introduced (this
          mode is in alpha status and not yet publicly available; if you
          are interested in testing it: enquire)
                
--------------------------------------------------------------------------
10.06.97: Version 3.05f

	Fixes:
        
        - a spurious error message about a "missing character" has been
          eliminated.
        - "\settrans{english}" switches again to the transliteration
          conventions of the Library of Congress.
        - ArabTeX will no more overwrite a user macro "\x".

	Additions:

        - the new command "\arabfootnotes" makes LaTeX footnotes run from
          right to left, and their text is considered Arabic by default. 
          There is as yet no command to switch back to the default mode
          (left to right, Roman). With Plain TeX the new command is not
          yet available.

--------------------------------------------------------------------------
28.05.97: Version 3.05e

	Fixes:

        - <U> in the Urdu mode works again.
        - some errors in the transliteration have been corrected.
        - some ligatures have been corrected.

--------------------------------------------------------------------------
22.05.97: Version 3.05d

	Fixes:

        - \tabular structures within the Arabic document classes are now
          correctly aligned.
        - a few ligatures have been improved.
        - some internal routines have been updated preparing for some
          planned extensions. No visible effect.
        - a new test for version clashes has been introduced.

--------------------------------------------------------------------------
14.05.97: Version 3.05c

	Fixes:  The patching routine seems to work again.

--------------------------------------------------------------------------
14.05.97: Version 3.05b

        Problems:

        - LaTeX is too clever and interferes with the patching routine.
          Therefore the existing patches for Hebrew have been moved to
          the file "hepatch.sty". Arabic mode is presently not affected.

--------------------------------------------------------------------------
13.05.97: Version 3.05a

	Fixes:

        - in Hebrew mode when using HED encoding, Thet and Maqqef did
          not work correctly.
        - in EDMAC mode with Plain TeX the list of modules was missing.
        - some internal interfaces have been updated. This has no effect
          on the external operation but helps stability.

--------------------------------------------------------------------------
07.05.97: Version 3.05

	Status:

	- The internal structure has changed extensively; this need not
	  trouble the user.
        - Warning: NEVER MIX old and new files; they may be incompatible!

	Fixes:

	- A number of minor and some major bugs have been fixed.

	Modifications:

	- With EDMAC, the first argument of \text need not fit on the
          current line. All arguments are assumed to be Roman text; they
          may contain (or consist of) \<Arabic insertions>.

	Additions:

	- The ISIRI 3342 encoding is supported; load the reading module 
          by \input isiri.sty or \usepackage {isiri}. Activate it by the
	  command \setcode {isiri}.
        - Hebrew support has been expanded; read the file "hebrew.305".
          ArabTeX will try to use fonts locally available, irrespective
          of their encoding.
        - the file "verses.sty" supports typesetting poetry in two blocks. 
          For a description, see the file itself.
	- See also the comments on Version 3.04 below.

	Hints:

	- If you want to process the manual "arabdoc.tex" under LaTeX 2e
          and get error messages, delete the *.aux, *.toc, and *.lot file
          and try again. These files depend on the LaTeX version used.
        - see also version 3.04.

	Complaints:

	- There is STILL no Nasta`liq font.
        - the user manual "arabdoc.tex" is outdated.

	Known bugs:

	- None as yet.

	How to move from earlier minor versions to version 3.05:

        - replace the contents of "TEXINPUT" and "REPORT".
	- read and/or print "README.305"
	- if interested, process the user manual "arabdoc.tex"; see the
	  hints above.

==========================================================================
05.10.96: Version 3.04e

	Fixes:

	- removed many small bugs in Persian (thanks, Ivan Derszanski!)
	- initial <alif> coded <A> in verbatim mode may carry a vowel
	- <yah> without dots coded <Y> acts like a consonant except at the
	  end of a word
	- <aNy> denotes <fathatan> on <alif maqsura> erroneously written
	  with dots

	Modifications:

	- removed quoted hamza ("') from verbatim mode (was ambiguous!)

--------------------------------------------------------------------------
18.05.96: Version 3.04d
10.05.96: Version 3.04c (not distributed)

	Fixes:

	- in "arabart.cls" (twocolumn) the right column is output first 
	  to get correct numbering of sectional units
	- corrected the vertical position of "marginpar"
	- a space is assumed after a new command defined via \allowarab

--------------------------------------------------------------------------
08.04.96: Version 3.04b

	Fixes:

	- \footnote works again within an Arabic environment

	Known bugs:

	- \footnote is incompatible with "arabart.cls"

--------------------------------------------------------------------------
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 earlier minor versions to version 3.04:

	- read and/or print "README.303"

==========================================================================
04.07.95: Version 3.03e

	Fixes:

	- Final yah before hamza works again

--------------------------------------------------------------------------
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

--------------------------------------------------------------------------
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.
	- <tanwIn> on <'alif maqsUraT> works again.
	- In \setverb mode, a <harakaT> on <'alif> now works.
	- In \setverb mode, <A> may be used to produce <'alif>.
	- The ligature <lm|a> is produced instead of <l|ma>.
	- <ba'>, <ya'> etc. before <lAm> 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.

--------------------------------------------------------------------------
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.

--------------------------------------------------------------------------
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 <Arabic insertion> 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 earlier minor versions 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"

==========================================================================
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
	- <hamza> in rare cases had the wrong carrier
	- if an Arabic word starts with a vowel, "quoting" toggles 
	  <wasla> 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

--------------------------------------------------------------------------
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!

--------------------------------------------------------------------------
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 <text> 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 earlier minor versions 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"

==========================================================================
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.

--------------------------------------------------------------------------
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 <hah> 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
	  <sukUn>) 
	- In "abjad.sty", the <gIm> 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 <sukUn> except in \fullvocalize mode
	  where it deletes a <sukUn> 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 earlier minor versions to version 3.01:

	- completely replace the contents of the directory TEXINPUT
	- observe that there is a new file "acmd.sty"

==========================================================================
07.12.93: Version 3.00b

	Fixes:

	- corrected handling of <tanween fatha> in \setverb mode.
	- improved error handling for illegal commands.
	- ligature <geem>-<meem> 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.

--------------------------------------------------------------------------
26.11.93: Version 3.00a

	Fixes:

	- the <hamza> carrier is now <ya'> the before diphthong <ay>

	Additions:

	- more Qur'anic writing variants provided
	- \hfil is allowed in Arabic text

--------------------------------------------------------------------------
20.11.93: Major 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.

==========================================================================
        For information on older versions see the file "changes2.txt".
==========================================================================
    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 - 1997, Klaus Lagally
--------------------------------------------------------------------------

