small typo!
[ess.git] / doc / newfeat.texi
blob333bdd6617f590453f3d0a6cd43ef06c02cf677c
1 Changes/New Features in 5.2.11:
2 @itemize @bullet
3 @item Info menu file, @file{dir}, handled, hopefully, more sanely
4 for GNU Emacs users
5 @item ESS[SAS]: temporary files created for batch submission of a
6 region are now named based on the current file; see @code{ess-sas-file-root}
7 for details
8 @item @ESS{[S]}: Support for running other versions of Splus has been
9 added for unix.  Two new variables, @code{ess-s-versions} and
10 @code{ess-s-versions-list}, are used to tell ESS what other versions of
11 Splus you would like to run.
12 @end itemize
14 Changes/New Features in 5.2.10:
15 @itemize @bullet
16 @item @ESS{[R]}: ess-r-versions can no longer be customized (since the
17 customization was not taking effect unless customizations were loaded
18 before ESS).  Its value has been changed so that it will also find R
19 executables beginning ``R-devel'' and ``R-patched''.  If you wish to
20 change this variable, it must be set in your @file{.emacs} before ESS is
21 loaded.
22 @item Installation with GNU Make enhanced:  unix and unix-like
23 operating systems will now be able to install @ESS{} for all
24 users in either a GNU Emacs site-lisp or an XEmacs package
25 configuration by editing @file{lisp/ess-site.el} and @file{Makeconf}
26 accordingly, then issuing @code{make install}
27 @item @ESS{[S]}: Filename completion (inside strings) now also works in
28 XEmacs for R and S-plus.
29 @c working around a bug in Xemacs
30 @end itemize
32 Changes/New Features in 5.2.9:
33 @itemize @bullet
34 @item @ESS{[R]} for Windows:  the \ directory character bug
35 with respect to ess-load-file has been eradicated.
36 @item @iESS{[SAS]}: @kbd{C-c C-r} and @kbd{C-c C-b} once again
37 work as intended and documented.
38 @item @ESS{[S]}: M-x ess-fix-EQ-assign is a bit more agressive.
39 @item @ESS{[S]}: Imenu now also shows setAs(), etc.
40 @item @ESS{[R]}: R function pattern enhanced with underlying code such that
41  @kbd{M-C-a} (@code{ess-beginning-of-function}) etc now work for many more
42  cases, including S4 method definitions.
43 @item @iESS{[R]}: myOwnhelp(1) no longer wrongly triggers help(1).
44 @item @ESS{[R]}: Improved detection of bogus help buffers: valid help
45  buffers containing with the string ``no documentation''(e.g. contour)
46  were being treated as bogus.
47 @item @ESS{[R]}: In R help buffers, if @code{options("help.try.all.packages" =
48  TRUE)} then @code{?rlm} will list which packages rlm is defined in.  This help
49  buffer is not bogus, but instead is now relabelled ``*help[R](rlm in
50  packages)*''.
51 @item @ESS{[STA]}: add ``//'' as comment starting character to syntax-table.
52 @end itemize
54 Changes/New Features in 5.2.8:
55 @itemize @bullet
56 @item iESS: [Tab] completes @strong{file} names ``inside string'' as in
57 earlier (<= 5.2.3) ESS versions.
58 @end itemize
60 Changes/New Features in 5.2.7:
61 @itemize @bullet
62 @item If you use Custom to change the variable ess-toolbar-items,
63 the new toolbar is used in all subsequent ESS buffers.
64 @item @ESS{[SAS]}: new feature:  if ess-sas-log-max >0 and
65 your .log grows to more than ess-sas-log-max bytes, just
66 the first ess-sas-log-max bytes are refreshed; this is helpful when your .sas program
67 generates lots of error messages and gets too big for emacs to display
68 @item @ESS{[R/S]}: @kbd{M-;} in R/S editing modes will now indent with
69 either one or two hashes depending on context.
70 @item @ESS{[R]}: David Whiting's Sweave extensions (to 'noweb')
71 are now available (from ess-swv.el loaded by default).
72 @end itemize
74 Changes/New Features in 5.2.6:
75 @itemize @bullet
76 @item Removed non-ASCII characters in a few files.
77 @item @ESS{[R]}: now works better when UTF-8 locale is active; in
78  particular, you get correct directional quotes in R's startup message
79  for R-devel (unstable development version of R 2.1.0) when using
80  environment variables LANGUAGE=en@@quot LC_ALL=en_US.UTF-8
81 @item @ESS{[SAS]}: toggling of .log mode improved (@kbd{F10}); toggling of
82 .lst mode now also available (@kbd{C-F10}); killing all buffers associated
83 with .sas program no longer bound to @kbd{C-F10} since its a bit overzealous.
84 @item S-Plus 7 for Windows is now recognized.
85 @item @ESS{[S]} (incl.@: R): in auto-fill mode, strings are not wrapped anymore.
86 @item @ESS{[S]} (incl.@: R): font-lock now correctly differs between R and S,
87 e.g., for "_"; both now fontify warning(.) and S does terminate() additionally.
88 @item Support for `bell' aka `beep' aka `ding' aka `alarm' in all inferior
89 modes: When \a is output ``to the the console'' at the beginning of a line,
90 the bell is rung.
91 @end itemize
93 Changes/New Features in 5.2.5:
94 @itemize @bullet
95 @item @ESS{[R]}: @kbd{C-c C-q} or @samp{Quit S} from the menu now should work
96 (again and less klunkily) and do not append @samp{-exited} to the
97 buffer name.  Further, the behavior of @code{(ess-cleanup)}, called from
98 ess-quit, now depends on the new customizable variable
99 @code{ess-S-quit-kill-buffers-p} which defaults to @code{nil}.
100 Consequently, the question @emph{``Delete all buffers associated
101 with ..?''} will not be asked anymore by default.
102 @item @ESS{[SAS]} -- ess-ebcdic-to-ascii-search-and-replace will now work
103 with the @code{recode} application as well which is available on many platforms
104 @item @ESS{[S]} (incl.@: R): Name completion for slots of S4 objects now works!
105 @end itemize
107 Changes/New Features in 5.2.4:
108 @itemize @bullet
109 @item The documentation now includes an overview of how to use the emacs
110 TAGS facility for S functions.  (The distribution also used to contain a
111 directory @file{etc/other/Tags} where a ~1990 version of @file{etags.c} was
112 distributed; this is no longer relevant and so has been deleted.)
113 @item @ESS{[SAS]} -- When you are working with EBCDIC files on an ASCII
114 platform, .log NOTEs may display as gibberish since the EBCDIC
115 characters are not converted to ASCII prior to their display.  So,
116 the function ess-ebcdic-to-ascii-search-and-replace is provided for
117 convenience and is bound to @kbd{C-F11}.  This function requires the
118 @code{dd} command (only available on unix or unix-like platforms).
119 @item ESS: Completion of object names is now always done dynamically rather
120 than allowing the option of using a pre-computed database (by
121 @code{ess-create-object-name-db}) since modern computers seem fast
122 enough for dynamic completion.  (We expect few users, if any, have
123 been using the pre-computed database method.)
124 @item ESS: object completion in iESS buffers running on Windows was
125 very slow (for GNU Emacs, but not XEmacs) and has now been fixed.
126 Further, it was more or less broken for all versions of S-plus 6.x,
127 and has been fixed to work everywhere but with the Windows' GUI of
128 S-plus.  The list of objects now shows unique names also when an
129 object appears more than once in the search path.
130 @item @ESS{[R]}: Completion of object names now also includes those
131 starting with ``.''.
132 @end itemize
134 Changes/New Features in 5.2.3:
135 @itemize @bullet
136 @item ESS: When new inferior ESS processes are created, by default they
137 will replace the current buffer (this restores behavior from pre
138 5.2.0). If you wish new ESS processes to start in another window of the
139 current frame, set inferior-ess-same-window to nil.
140 @item New variables inferior-Splus-args and inferior-R-args provide a
141 way to pass command line arguments to starting S and R processes.
142 @end itemize
144 Changes/New Features in 5.2.2:
145 @itemize @bullet
146 @item bug-fixes for 5.2.1 (require 'executable), html docs, etc.
147 @item ess-lisp-directory/../doc/info added to Info-directory-list
148 if ess-info not found by info
149 @item @ESS{[R]}: If you have other versions of R on your
150 exec-path, such as "R-1.8.1" with Unix or "rw1081" with Windows,
151 ESS will find them and create appropriate functions, such as
152 @kbd{M-x R-1.8.1} or @kbd{M-x rw1081}, for calling them.
153 By default only Unix programs beginning "R-1" and
154 "R-2" and Windows programs parallel to the
155 version of R in your exec-path will be found,
156 but see ess-r-versions and ess-rterm-versions for ways to find other
157 versions of R.
158 @item @ESS{[R]}: Other versions of R, such as "R-1.8.1" on Unix and "rw1081" on
159 Windows, are added to the
160 "ESS / Start Process / Other" menu.
161 @item @ESS{[S]}: If you have other versions of S-Plus on your Windows computer,
162 such as S-Plus 6.1 or S-Plus 4.5, ESS will find them and create appropriate
163 functions, such as @kbd{M-x splus61}, for calling the console version (Sqpe)
164 inside an emacs buffer.  By default only
165 programs installed in the default location will be found, but see
166 ess-SHOME-versions for ways to find other versions of S-Plus.
167 @item @ESS{[S]}: Other versions of Sqpe on Windows, such as "splus61",
168 are added to the
169 "ESS / Start Process / Other" menu.
170 @item @ESS{[R]}: (bug fix) ess-quit (bound to @kbd{C-c C-q}) should now quit the
171 inferior R process, when issued from either the inferior buffer, or from
172 a .R buffer.
173 @end itemize
175 Changes/New Features in 5.2.1:
176 @itemize @bullet
177 @item @ESS{[S]} (R and S-plus): now have toolbar support
178 with icons to evaluate code in the inferior process or to switch
179 there.  This code is experimental and likely to change as XEmacs/Emacs
180 issues get resolved. The toolbar should be enabled if your Emacs
181 displays images, but can be disabled with the variable ess-use-toolbar.
182 Thanks to David Smith from Insightful for the S-plus logo.
183 @item @ESS{[SAS]}: ess-sas-graph-view (@kbd{F12}) enhanced; you can specify
184 external file viewers for each graphics file type via the alist
185 ess-sas-graph-view-viewer-alist; also .jpg/.gif are now handled
186 by image-mode on XEmacs, if available, otherwise by graphics
187 primitives as before
188 @end itemize
190 Changes/New Features in 5.2.0:
191 @itemize @bullet
192 @item @ESS{[BUGS]}:  new info documentation!  now supports interactive
193 processing thanks to @uref{mailto:Aki.Vehtari@@hut.fi, Aki Vehtari};
194 new architecture-independent unix support as well as support for BUGS v. 0.5
195 @item @ESS{[SAS]}:  convert .log to .sas with ess-sas-transcript;
196 info documentation improved; Local Variable bug fixes;
197 SAS/IML statements/functions now highlighted; files edited
198 remotely by ange-ftp/EFS/tramp are recognized and pressing
199 SUBMIT opens a buffer on the remote host via the local variable
200 ess-sas-shell-buffer-remote-init which defaults to "ssh";
201 changed the definition of the variable ess-sas-edit-keys-toggle
202 to boolean rather than 0/1; added the function ess-electric-run-semicolon
203 which automatically reverse indents lines containing only "run;";
204 @kbd{C-F1} creates MS RTF portrait from the current buffer;
205 @kbd{C-F2} creates MS RTF landscape from the current buffer;
206 @kbd{C-F9} opens a SAS DATASET with PROC INSIGHT rather than PROC FSVIEW;
207 "inferior" aliases for SAS batch:  @kbd{C-c C-r} for submit region,
208 @kbd{C-c C-b} for submit buffer, @kbd{C-c C-x} for goto .log; @kbd{C-c C-y} for goto .lst
209 @item @ESS{[S]}: Pressing underscore ("_") once inserts " <- " (as before);
210 pressing underscore twice inserts a literal underscore.  To stop this
211 smart behaviour, add "(ess-toggle-underscore nil)" to your .emacs after
212 ess-site has been loaded;
213 ess-dump-filename-template-proto (new name!) now can be
214 customized successfully (for S language dialects);
215 Support for Imenu has been improved; set ess-imenu-use-S to non-nil to
216 get an "Imenu-S" item on your menubar;
217 ess-help: Now using nice underlines (instead of `nuke-* ^H_')
218 @item @ESS{[R]}:  After (require 'essa-r), @kbd{M-x ess-r-var} allows to load
219 numbers from any Emacs buffer into an existing *R* process;
220 @kbd{M-x ess-rdired} gives a ``directory editor'' of R objects;
221 fixed ess-retr-lastvalue-command, i.e. .Last.value bug
222 (thanks to David Brahm)
223 @item ESS: Support for creating new window frames has been added to
224 ESS.  Inferior ESS processes can be created in dedicated frames by
225 setting inferior-ess-own-frame to t.  ESS help buffers can also open in
226 new frames; see the documentation for ess-help-own-frame for details.
227 (Thanks to Kevin Rodgers for contributing code.)
228 @end itemize
230 Changes/New Features in 5.1.24:
231 @itemize @bullet
232 @item The version number is now correct even inside ESS/Emacs
233 @end itemize
235 Changes/New Features in 5.1.23:
236 @itemize @bullet
237 @item Minor more Makefile clean up.
238 @end itemize
240 Changes/New Features in 5.1.22:
241 @itemize @bullet
242 @item Besides info documentation, PDF and HTML
243 documentation are also provided (instead of built using "make") and available
244 on the web as well; see @uref{http://ess.r-project.org/,
245  ESS web page} and @uref{http://lib.stat.cmu.edu/general/ESS/doc, StatLib}
246 @item Now that info documentation is available, the
247 README.* files are no longer supported.  However, they
248 are still distributed for what it's worth.
249 @item ESS is now an XEmacs package!  See
250 @uref{http://www.xemacs.org/Install/index.html, XEmacs Installation HOWTO}
251 for details (specifically, items 10-15).
252 @item @ESS{[SAS]}: more user-friendly enhancements for remote
253 SAS batch jobs with Kermit file transfers (LOG and OUTPUT
254 function key features now supported).  Multiple shells
255 now supported so you can run SAS on different computers
256 from different buffers by setting the buffer-local variable
257 ess-sas-shell-buffer to unique buffer names.
258 @item Major re-vamping of Makefile/Makeconf.
259 @end itemize
261 Changes/New Features in 5.1.21:
262 @itemize @bullet
263 @item @ESS{[SAS]}: info documentation now available!, see
264 ESS->Help for SAS; @kbd{F12} opens GSASFILE nearest point for viewing
265 either within emacs, when available, or via an external viewer;
266 more syntax highlighting keywords; more enhancements for remote
267 SAS batch jobs with Kermit; new framework for remote SAS interactive
268 jobs, see ess-remote
269 @item @ESS{[S]}: info documentation now available!, see
270 ESS->Help for the S family
271 @item Makefile: tag now independent of rel; info files
272 made by doc/Makefile and installed in new info sub-directory
273 @end itemize
275 Changes/New Features in 5.1.20:
276 @itemize @bullet
277 @item New `options()$STERM' in the S dialects (S, S-Plus, R).
278 The S program can determine the environment in which it is
279 currently running.  ESS sets the option to `iESS' or `ddeESS'
280 when it starts an S language process.  We recommend other specific
281 values for S language processes that ESS does not start.
282 @item New `ess-mouse-me' function, assigned to S-mouse-3 by default.
283 User may click on a word or region and then choose from the
284 menu to display the item, or a summary, or a plot, etc.
285 This feature is still under development.
286 @item GNU Emacs 21.1 is now supported (fixed for S dialects, SAS & BUGS),
287 (some from Stephen Eglen).
288 @item XEmacs 21.x is now supported (fixed w32-using-nt bug)
289 @item XEmacs on Win (NT) is better supported.
290 @item Workaround for bug in Sqpe+6 (S-PLUS 6 for Win).
291 @item should now work even when imenu is not available (for old XEmacsen).
292 @item @ESS{[SAS]}: XEmacs-Imenu fix; @kbd{C-TAB} is globalized along with your
293 function-key definitions, if specified; you can specify your SAS
294 library definitions outside of autoexec.sas for ess-sas-data-view
295 with SAS code placed in the variable ess-sas-data-view-libname,
296 also the dataset name is defaulted to the nearest permanent dataset
297 to point; Speedbar support now works for permanent datasets, please
298 ignore first./last.; new font-locking is now the default with more
299 improvements for font-locking PROCs, macro statements, * ; and %* ;
300 comments; you can toggle sas-log-mode with @kbd{F10} which will font-lock
301 your .log (if it isn't too big); submit remote .sas files accessed
302 with ange-ftp, EFS or Tramp (Kermit is experimental) by setting
303 ess-sas-submit-method to 'sh; ess-sas-submit-command and
304 ess-sas-submit-command-options are buffer-local so you can have
305 local file variable sections at the end of your .sas files to
306 request different executables or specify special options and the
307 local file variables are re-read at submit instead of only at file
308 open so that if you make a change it is picked up immediately;
309 @item @ESS{[BUGS]}: font-lock with `in' fixed.
310 @item for STATA: font-lock bug fixed.
311 @item for Rd mode: @kbd{C-c C-v} and `switch-process' in menu.
312 further, @kbd{C-c C-f} prefix (Rd-font) for inserting or surrounding a word
313 by things such as \code@{.@}, \code@{\link@{.@}@}, \emph@{.@} etc.
314 @item new functions (ess-directory-function) and (ess-narrow-to-defun)
315 ess-directory <-> default-directory logic (Jeff Mincy).
316 @item Re-organized Makefile and fixed a few bugs.
317 @end itemize
319 Changes/New Features in 5.1.19:
320 @itemize @bullet
321 @item S+6 now supported (Tony Rossini (Unix) and Rich Heiberger (Windows))
322 @item New BUGS support through @ESS{[BUGS]} mode (Rodney Sparapani)
323 Templates assist you in writing .bug and .cmd code (.cmd and .log
324 are replaced by .bmd and .bog to avoid emacs extension collisions).
325 Substitution" parameters facilitate "automagic" generation of
326 data...in" and "init...in" filenames, "const N=" from your data
327 file and "monitor()/stats()" commands.  Activated by pressing @kbd{F12}.
328 @item Fixes for `ess-smart-underscore' SAS breakage (Rich Heiberger)
329 @item You can change between PC and Unix, local and global SAS function-key
330 definitions interactively (Rich Heiberger)
331 @item @kbd{C-Submit} a highlighted region to SAS batch (Rodney Sparapani)
332 @item New and improved SAS syntax highlighting (Rodney Sparapani)
333 To get the new functionality, set ess-sas-run-make-regexp to nil.
334 Also available in .log files via @kbd{F10}.
335 @item Open a permanent SAS dataset for viewing via @kbd{F9} (Rodney Sparapani)
336 You must have the library defined in autoexec.sas for it to work.
337 @item User-friendly defaults for `sas-program', `ess-sas-batch-pre-command'
338 and `ess-sas-batch-post-command' as well Customize support for these
339 and other @ESS{[SAS]} variables (Rodney Sparapani)
340 @item `ess-sas-suffix-2' now defaults to .dat via @kbd{F11} (Rodney Sparapani)
341 @item Emacs/XEmacs, Unix/Windows issues collectively handled in ess-emcs.el
342 @item defadvice solves problem of missing *ESS* (thanks to Jeff Mincy)
343 @item Improved manual a bit by including things that were only in `README'.
344 @end itemize
346 Changes/New Features in 5.1.18:
347 @itemize @bullet
348 @item New `ess-smart-underscore' function, now assigned to "_" by default.
349 Inserts `ess-S-assign' (customizable " <- "), unless inside string
350 and comments where plain "_" is used instead. (MM)
351 @item Fixes for longstanding interactive SAS breakage (RMH)
352 @end itemize
354 Changes/New Features in 5.1.17:
355 @itemize @bullet
356 @item Documentation for Windows Installation (Rich Heiberger)
357 @item removal of ess-vars, finalization of customize support (in the
358 sense that there is no more use of ess-vars, but that we need to
359 fix ess-cust) (AJ Rossini)
360 @item Many small (and large) fixes/contributions (MMaechler)
361 @item addition of the "S-equal" variable and provide @kbd{M-x ess-add-MM-keys}
362 a way to remap "_" to `ess-S-assign', typically " <- ", but
363 customizable. (MMaechler)
364 @end itemize
366 Changes/New Features in 5.1.16:
367 @itemize @bullet
368 @item BUG FIXES
369 @item Better SAS support
370 @end itemize
372 Changes/New Features in 5.1.15:
373 @itemize @bullet
374 @item BUG FIXES
375 @end itemize
377 Changes/New Features in 5.1.14:
378 @itemize @bullet
379 @item Yet more fixes to SAS mode, (Rich Heiberger and Rodney Sparapani)
380 @item Customize support (for most Emacsen which support it) (AJRossini)
381 @item ARC and ViSta support out of the box, and fixes for XLispStat (AJRossini)
382 @end itemize
384 Changes/New Features in 5.1.13:
385 @itemize @bullet
386 @item Version numbering finally all depending on the ./VERSION file,
387 thanks to Martin Maechler.
388 @item Yet more fixes to SAS mode, thanks to Rich Heiberger.
389 @end itemize
391 Changes/New Features in 5.1.12:
392 @itemize @bullet
393 @item Splus 5.1 stabilized, thanks to Martin Maechler, Bill Venables,
394 Chuck Taylor, and others.
395 @item More fixes to SAS mode, thanks to Rodney Sparapani
396 and Rich Heiberger.
397 @end itemize
399 Changes/New Features in 5.1.11:
400 @itemize @bullet
401 @item More fixes to Stata mode, thanks to
402 @uref{mailto:brendan@@essex.ac.uk, Brendan Halpin}.
403 @item fixed bugs in ESS-elsewhere, thanks to many testers
404 @item README.SPLUS4WIN has DETAILED instructions for S-PLUS 2000, thanks
405 to @uref{mailto:brahm@@alum.mit.edu, David Brahm}.
406 @item Fixes to SAS mode, thanks to Rodney Sparapani
407 @end itemize
409 Changes/New Features in 5.1.10:
410 @itemize @bullet
411 @item More fixes to Stata mode
412 @item primitive generic version of ESS-elsewhere
413 @item Small fixes to SAS/Stata.
414 @end itemize
416 Changes/New Features in 5.1.9:
417 @itemize @bullet
418 @item Stata mode works
419 @item Literate Data Analysis using Noweb works
420 @end itemize
422 Changes/New Features in 5.1.8:
423 @itemize @bullet
424 @item Bug fixes
425 @item R documentation mode defaults changed
426 @end itemize
428 Changes/New Features in 5.1.2:
429 @itemize @bullet
430 @item  able to use inferior iESS mode to
431 communicate directly with a running S-Plus 4.x process using the
432 Microsoft DDE protocol.  We use the familiar (from Unix ESS) @kbd{C-c C-n}
433 and related key sequences to send lines from the S-mode file to the
434 inferior S process.  We continue to edit S input files in @ESS{[S]} mode
435 and transcripts of previous S sessions in ESS Transcript mode.  All
436 three modes know the S language, syntax, and indentation patterns and
437 provide the syntactic highlighting that eases the programming tasks.
438 @end itemize