AUCTeX -- Rewrite some defface avoiding 'min-colors'. [OK For Upstream]
[packages] / xemacs-packages / auctex / RELEASE
1 Release notes for AUCTeX 11.84 with preview-latex
2 =================================================
3
4 AUCTeX provides by far the most wide-spread and sophisticated
5 environment for editing LaTeX, TeX, ConTeXt and Texinfo documents with
6 Emacs or XEmacs.  Combined with packages like RefTeX, flyspell and
7 others it is pretty much without peer as a comprehensive authoring
8 solution for a large variety of operating system platforms and TeX
9 distributions.  It supports document-dependent completion and syntax
10 highlighting, easily accessible menus, jumping to error locations in
11 the source file, a number of editing shortcuts, intelligent
12 indentation and filling of text during entry, and WYSIWYG previews of
13 graphical elements like math formulas right in the Emacs source
14 buffer, by virtue of its preview-latex component.
15
16 One part of the preview-latex subsystem is the central `preview.sty'
17 file that is independently useful for a number of applications and is
18 available in unbundled form from CTAN.[1]
19
20 Interfaces and installation procedures in this release remain a moving
21 target.  If you feel you need to consult third-party installation
22 instructions for some reason, be sure that they refer to the same
23 version of AUCTeX as you are installing.  For installing AUCTeX
24 itself, the installation instructions in the AUCTeX package should be
25 preferred.
26
27 AUCTeX needs volunteers in particular for non-programming tasks:
28 documentation writing, tutorials, translations, reference material,
29 sleuth work, testing.
30
31
32 New features and fixed bugs in this release
33 -------------------------------------------
34
35 There have been problems with the `-without-texmf-dir' option to
36 `configure' when the value of `-with-kpathsea-sep' was set or
37 determined for an installation system with a default different from
38 that of the runtime system.  `with-kpathsea-sep' has been removed; the
39 setting is now usually determined at runtime.
40
41 Due to this and other problems, preview-latex in the released XEmacs
42 package failed under Windows or with anything except recent 21.5
43 XEmacsen.
44
45 AUCTeX and preview-latex have been changed in order to accommodate
46 file names containing spaces.  preview-latex now tolerates bad
47 PostScript code polluting the stack (like some Omega fonts).
48
49 `preview.sty' had in some cases failed to emit PostScript header
50 specials.
51
52 Support for folding of comments was added.
53
54 The `polish' language option of the babel LaTeX package as well as the
55 `polski' LaTeX package are now supported.  Most notably this means
56 that AUCTeX will help to insert quotation marks as defined by
57 polish.sty ("`..."') and polski.sty (,,...'').
58
59 There has been quite a number of bug fixes to various features and
60 documentation across the board, most critical probably the tool bar.
61
62 IMPORTANT: Many of the new features in the 11.x series rely on special
63 properties in the variable `TeX-command-list' and will not work if you
64 customized this variable for a pre-11.5x release of AUCTeX.  If this
65 is the case for you, please re-initialize the variable by erasing the
66 customization, thereby setting the variable to the new default, and
67 re-adding your changes afterwards.
68
69
70 Requirements
71 ------------
72
73 It is required that you use at least GNU Emacs 21 or XEmacs 21.4.
74 XEmacs requires at least version 1.84 of the xemacs-base package
75 (released on 01/27/2004) or a sumo tarball dated 02/02/2004 or newer
76 for compiling AUCTeX: please use the XEmacs package system for
77 upgrading if necessary.  Warning: release 21.4.16 of XEmacs is
78 severely broken.  This leads to crashes and hangs; don't use it.
79
80 The preview-latex subsystem requires image support.  This is available
81 with GNU Emacs 21.3 under the X window system.  For Windows[2], MacOS
82 Carbon[3] or native GTK+ toolkit support[4], a developer version[5] of
83 GNU Emacs (to be released as 22.1) is definitely required.  A recent
84 developer version of GNU Emacs appears like the best choice even on
85 X11, however.  If you prefer XEmacs-21, it will work in version
86 21.4.10 or later.
87
88 You'll also need a working LaTeX installation and Ghostscript.
89 dvipng[6] (version 1.4 or later: teTeX-3.0 works, TeXlive2004 not), a
90 very fast dvi converter, can be used to speed up the conversion.
91
92 Availability
93 ------------
94
95 AUCTeX can be downloaded in various formats from
96 <URL:ftp://ftp.gnu.org/pub/gnu/auctex/>.  At release time, we provide
97 the source tarball, source and binary RPMs for Emacs under Fedora and
98 SUSE, and a platform-independent XEmacs package file (which you have
99 to install yourself using XEmacs' own package system, after using it
100 for removing the previous version of AUCTeX).  There are also RPMs
101 just for installing the LaTeX part of preview (AUCTeX itself does not
102 need them, but possibly other applications).  The easiest way for
103 using AUCTeX, of course, is using versions of Emacs that already
104 include AUCTeX (check the footnotes below).
105
106 RPMs with minor version 1 are built from the spec file in the tarball
107 which should work on both SUSE as well as Fedora.  The source RPMs
108 should also work for rebuilding RPMs on other RPM-based distributions.
109 (We have only tested SUSE and Fedora, though.)
110
111 The XEmacs package file can be discerned by `pkg' in its name.  It is
112 usually more recent and functional than what gets distributed from
113 XEmacs servers and as part of the Sumo tarball.
114
115 A separate directory for each release contains some stuff from the
116 tarball, such as ChangeLog, printable manuals, and a reference sheet.
117 The download area is mirrored to the directory support/auctex on CTAN.
118 AUCTeX is licensed under the GNU General Public License version 2.
119
120 You'll find more information at the web site of AUCTeX
121 <URL:http://www.gnu.org/software/auctex/>, including its mailing list
122 addresses.
123
124
125 Future development and additional information
126 ---------------------------------------------
127
128 AUCTeX is proceeding as a GNU project with the long-term intent of
129 merging it into Emacs.  For that reason, all new contributors need to
130 assign copyright to their contributions to the FSF (the usual
131 procedure for Emacs contributors).  The same holds for past
132 contributors.  The principal authors and maintainers have already done
133 so, but it would require a diligent and diplomatic volunteer to find
134 and ask the rest.
135
136 Current project manager is David Kastrup.  Paypal contributions to
137 <URL:mailto:auctex@gnu.org> would be appreciated in order to
138 compensate for time, money and hardware required for presenting AUCTeX
139 at conferences.  Extensions may be commissioned: enquire on the
140 developer list (see above).  Other than that, volunteering for tasks
141 remains the most effective way of helping AUCTeX development.
142
143 The following people contributed to this release series (in
144 alphabetical order): Ralf Angeli, Masayuki Ataka, Thomas Baumann,
145 Berend de Boer, Joshua Buhl, Miguel Frasson, Peter S. Galbraith,
146 Patrick Gundlach, Yvon Hevel, Arne Jørgensen, David Kastrup, Ikumi
147 Keita, Frank Küster, Jan-Åke Larsson, Dan Nicolaescu, Piet van
148 Oostrum, Davide G. M. Salvetti, Mike Sperber, Reiner Steib, Christian
149 Schlauer, Shiro Takeda, Mark Trettin (Please accept our apologies if
150 we forgot somebody.)
151
152 Footnotes: 
153
154 [1]  <URL:ftp://ftp.dante.de/tex-archive/macros/latex/contrib/preview/>
155
156 [2]  You can get a precompiled version of CVS Emacs for Windows e.g. at
157 <URL:http://ourcomments.org/Emacs/EmacsW32.html>.  A version with
158 AUCTeX preinstalled can be found at
159 <URL:ftp://alpha.gnu.org/gnu/auctex/>.
160
161 [3]  Precompiled versions of Emacs for Mac OS X can be found e.g. at
162 <URL:http://yaced.sf.net/> (including AUCTeX) and
163 <URL:http://homepage.mac.com/zenitani/emacs-e.html>.
164
165 [4]  Debian provides precompiled GTK+ Emacs packages in its `unstable'
166 distribution (look for `emacs-snapshot-gtk').  Packages for Fedora can
167 be found at <URL:http://people.redhat.com/coldwell/bugs/emacs/176171/>.
168
169 [5]  If making use of the precompiled variants is not an option for
170 you, instructions for checking out the CVS version straight from the
171 GNU's mouth can be found at
172 <URL:http://savannah.gnu.org/cvs/?group=emacs>
173
174 [6]  dvipng is available via its project page
175 <URL:http://savannah.nongnu.org/projects/dvipng> and from CTAN.