]> AND Private Git Repository - mpi-energy2.git/blob - IEEEtran/changelog.txt
Logo AND Algorithmique Numérique Distribuée

Private GIT Repository
adding reviewers remarks
[mpi-energy2.git] / IEEEtran / changelog.txt
1
2
3  Changelog history of the IEEEtran LaTeX class.
4  
5
6  v1.8 -- 2012/11/21
7  by Harald Hanche-Olsen and Anders Christensen (IEEE Computational Intelligence Society)
8
9 *******
10 11/2012 v1.8 changes:
11
12 1335c1335
13 <                 \itemindent 0em%
14 ---
15 >                 \itemindent 0.3em%
16 1386c1386
17 <                 \itemindent 0em%
18 ---
19 >                 \itemindent .3em%
20 1436c1436
21 <                 \itemindent 0em%
22 ---
23 >                 \itemindent .3em%
24 1524c1524
25 < \def\unnumberedfootnote{\gdef\@thefnmark{}\@footnotetext}
26 ---
27 > \def\unnumberedfootnote{\gdef\@thefnmark{\quad}\@footnotetext}
28 1526c1526
29 < \skip\@mpfootins = \skip\footins
30 ---
31 > \skip\@mpfootins 0.3\baselineskip
32 1531a1532
33 > %\long\def\@makefnmark{\scriptsize\normalfont\@thefnmark}
34 1541c1542
35 < \def\footnoterule{\vskip-2pt \hrule height 0.4pt depth \z@ \vskip1.6pt\relax}
36 ---
37 > \def\footnoterule{\vskip-2pt \hrule height 0.6pt depth \z@ \vskip1.6pt\relax}
38 1652c1653
39 < \def\figurename{Figure}
40 ---
41 > \def\figurename{Fig.}
42 1740c1741
43 < \setlength\abovecaptionskip{0.25\baselineskip}
44 ---
45 > \setlength\abovecaptionskip{0.65\baselineskip}
46 1799c1800
47 < \footnotesize{\centering\normalfont\footnotesize#1.\quad\scshape #2\par}%
48 ---
49 > \footnotesize{\centering\normalfont\footnotesize#1.\qquad\scshape #2\par}%
50 1812c1813
51 < \ifCLASSOPTIONconference \hbox to\hsize{\normalfont\footnotesize\hfil\box\@tempboxa\hfil}%
52 ---
53 > \ifCLASSOPTIONconference \hbox to\hsize{\normalfont\footnotesize\box\@tempboxa\hfil}%
54 1856c1857
55 < \def\table{\def\@floatboxreset{\reset@font\footnotesize\@setminipage}%
56 ---
57 > \def\table{\def\@floatboxreset{\reset@font\scriptsize\@setminipage}%
58 1861c1862
59 < \@namedef{table*}{\def\@floatboxreset{\reset@font\footnotesize\@setminipage}\@dblfloat{table}}
60 ---
61 > \@namedef{table*}{\def\@floatboxreset{\reset@font\scriptsize\@setminipage}\@dblfloat{table}}
62 3747c3748
63 < \def\endIEEEkeywords{\relax\ifCLASSOPTIONtechnote\vspace{1.34ex}\else\vspace{1.67ex}\fi
64 ---
65 > \def\endIEEEkeywords{\relax\ifCLASSOPTIONtechnote\vspace{1.34ex}\else\vspace{0.5ex}\fi
66 3826,3827c3827,3829
67
68 < \def\@seccntformat#1{\csname the#1dis\endcsname\hskip 1em\relax}
69 ---
70 > \def\@seccntformat#1{\hb@xt@ 1.4em{\csname the#1dis\endcsname\hss\relax}}
71 > \def\@seccntformatinl#1{\hb@xt@ 1.1em{\csname the#1dis\endcsname\hss\relax}}
72 > \def\@seccntformatch#1{\csname the#1dis\endcsname\hskip 1em\relax}
73 3843c3845,3853
74 <      \protected@edef\@svsec{\@seccntformat{#1}\relax}%
75 ---
76 >      \ifnum #2=1
77 >         \protected@edef\@svsec{\@seccntformatch{#1}\relax}%
78 >      \else
79 >         \ifnum #2>2
80 >            \protected@edef\@svsec{\@seccntformatinl{#1}\relax}%
81 >         \else
82 >            \protected@edef\@svsec{\@seccntformat{#1}\relax}%
83 >         \fi
84 >      \fi
85
86
87
88
89
90
91 *****************************************
92
93 2007/03/05
94  by Michael Shell (MDS)
95  http://www.michaelshell.org/
96
97 *******
98  3/2007 V1.7a (MDS) changes:
99
100  1) Corrected problem of unwanted two column peer review title page format.
101     Thanks to Virgilio Rodriguez for reporting this bug.
102
103  2) "depreciated" -> "deprecated". Thanks to Virgilio Rodriguez for
104     suggesting this change.
105
106 *******
107  1/2007 V1.7 (MDS) changes:
108
109  1) New class option compsoc to support the IEEE Computer Society format.
110
111  2) New class option captionsoff disables the display of figure/table
112     captions. endfloat.sty is now mentioned in the docs. Thanks to Geoff
113     Walker for suggesting these changes.
114
115  3) Fixed compatibility issues with subfig.sty and caption.sty. Thanks to
116     Steven Douglas Cochran and Axel Sommerfeldt for suggesting this change.
117
118  4) New \CLASSINPUT, \CLASSOPTION and \CLASSINFO interface allows for more
119     user control and conditional compilation.
120
121  5) \ifcenterfigcaptions (\centerfigcaptionstrue, \centerfigcaptionsfalse),
122     \CMPARstart and \overrideIEEEmargins have been removed and no are
123     longer supported. The effect of \overrideIEEEmargins can be mimicked
124     via the more general \CLASSINPUT interface:
125     % US letter paper:
126     \newcommand{\CLASSINPUTinnersidemargin}{0.775in}
127     \newcommand{\CLASSINPUToutersidemargin}{0.585in}
128     % A4 paper:
129     \newcommand{\CLASSINPUTinnersidemargin}{17mm}
130     \newcommand{\CLASSINPUToutersidemargin}{11.647mm}
131
132  6) Several commands and environments have been deprecated in favor of
133     replacements with IEEE prefixes to better avoid potential future name
134     clashes with other packages. Legacy code retained to allow the use of
135     the obsolete forms (for now), but with a warning message to the console
136     during compilation:
137     \IEEEauthorblockA, \IEEEauthorblockN, \IEEEauthorrefmark,
138     \IEEEbiography, \IEEEbiographynophoto, \IEEEkeywords, \IEEEPARstart,
139     \IEEEproof, \IEEEpubid, \IEEEpubidadjcol, \IEEEQED, \IEEEQEDclosed,
140     \IEEEQEDopen, \IEEEspecialpapernotice. IEEEtran.cls now redefines
141     \proof in way to avoid problems with the amsthm.sty package.
142     For IED lists:
143     \IEEEiedlabeljustifyc, \IEEEiedlabeljustifyl, \IEEEiedlabeljustifyr,
144     \IEEEnocalcleftmargin, \IEEElabelindent, \IEEEsetlabelwidth,
145     \IEEEusemathlabelsep
146
147  7) These commands/lengths now require the IEEE prefix and do not have
148     legacy support: \IEEEnormaljot.
149     For IED lists: \ifIEEEnocalcleftmargin, \ifIEEEnolabelindentfactor,
150     \IEEEiedlistdecl, \IEEElabelindentfactor
151
152  8) \normalsizebaselineskip skip replaced by
153     \CLASSINFOnormalsizebaselineskip (nonrubber dimen) length.
154     Also, new \CLASSINFOnormalsizeunitybaselineskip (nonrubber dimen)
155     provided.
156
157  9) Now defaults to using Alpha numbering rather than Roman for appendices
158     numbering. This is because Alpha numbering is more common and avoids
159     problems with theorem numbering. \ifuseRomanappendices
160     (\useRomanappendicestrue, \useRomanappendicesfalse) is no longer
161     supported. Instead, use the new class option romanappendices if Roman
162     appendices numbering is desired. Thanks to Leonid Mirkin for reporting
163     the problem with theorems in appendices and suggesting changes.
164
165 10) Improved paper size setting code for pdflatex.
166
167 11) Better handling of theorem numbering when using the section counter
168     within the appendix(cies). Thanks to Leonid Mirkin for suggesting
169     this change.
170
171 12) Fixed bug that caused equations at the end of theorems to be too
172     close to the line below them.
173
174 13) Provided hook to conference mode console notice and changed notice to
175     better support conferences that use A4 paper. Thanks to Volker Kuhlmann
176     for suggesting this change.
177
178 14) \IEEEauthorrefmark made robust to allow it to be used in \thanks
179     without a leading \protect
180
181 15) Improved \textunderscore to provide a much better fake _ when used with
182     OT1 encoding. Under OT1, detect use of pcr or cmtt \ttfamily and use
183     available true _ glyph for those two typewriter fonts.
184
185 16) Revised internal \@sect command to be more robust for users who employ
186     modified section heading formats. Thanks to Zarko F. Cucej for
187     suggesting this change.
188
189 17) Improved \thesubsubsection definition to prevent breaks at the hyphen.
190     Thanks to Moritz Borgmann for suggesting this change. Thanks to
191     Dan Luecking and Heiko Oberdiek for explaining some of the various
192     alternatives and techniques to fix it.
193
194 18) No longer provide \NAT@parse hack to get cite.sty to play (somewhat)
195     with hyperref.sty as this is already included in cite.sty version
196     4.0 (2003-05-27) and later.
197
198 19) At the beginning of document, set the default style of url.sty to be
199     the same as the current text font - as is done in IEEE journals.
200
201 20) Corrected excessive line spacing in journal table captions. Thanks to
202     Moritz Borgmann for suggesting this change.
203
204 21) Corrected \thesubsubsection to use the "I-A1" format IEEE uses rather
205     than "I-A.1" as was done before. Ditto for \theparagraph. Thanks to
206     Moritz Borgmann for suggesting this change.
207
208 22) Enclose papersize specials within \AtBeginDvi in case someone wants
209     to make a format with IEEEtran. Thanks to Moritz Borgmann for
210     suggesting this change.
211
212 23) Eliminated the small space after abstract and keywords dash as IEEE
213     now does. Thanks to Moritz Borgmann for suggesting this change.
214
215 24) IEEEkeywords is no longer locked out in conference mode
216
217 25) Increase defaults of \binoppenalty and \relpenalty to discourage
218     breaks within equations. Thanks to Moritz Borgmann for suggesting
219     this change.
220
221 26) Support optional argument for IEEEproof. Thanks to Ingo Steinwart for
222     suggesting this change. Also, start a new \par with \IEEEproof.
223
224 27) Add support for an optional argument to \bstctlcite.
225
226 28) Changed \topfraction and \dbltopfraction from 1.0 to 0.9. Thanks to
227     Donald Arseneau for suggesting this change.
228
229
230 *******
231  09/2005 V1.6c (MDS) changes:
232
233  1) Changed endfigure/endfloat definitions so as not to cause problems with
234     preview-LaTeX and other packages. Thanks to Stephan Heuel and David
235     Kastrup for reporting this problem.
236
237
238
239 *******
240  11/2002 V1.6b (MDS) changes:
241
242  1) Fixed problem with figure captions when using hyperref. Thanks to 
243     Leandro Barajas and Michael Bassetti for reporting this bug.
244
245  2) Provide a fake nabib command \NAT@parse so that hyperref will not
246     interfere with the operation of cite.sty. However, as a result citation
247     numbers will not be hyperlinked. Also, natbib will not be able to work
248     with IEEEtran. However, this is perhaps the best solution until
249     cite.sty and hyperref.sty are able to co-exist with each other.
250     It easy enough to override the fake command via:
251     \makeatletter
252     \let\NAT@parse\undefined
253     \makeatother
254
255  3) Revised font selection method so as not to have problems when used
256     with setspace.sty. Thanks to Zhang Yan for reporting this bug.
257
258  4) Added \special to feed papersize to dvips. Thanks to Moritz Borgmann 
259     for suggesting this feature.
260
261  5) In addition to the IEEE IED lists, the original IED style list
262     environments (as is done in article.cls) are now provided as
263     LaTeXitemize, LaTeXenumerate, and LaTeXdescription. Also, users can
264     now redefine \makelabel within IEEE IED list controls. There may be
265     some use for this in specialized applications. Thanks to Eli Barzilay
266     for suggesting this feature.
267
268  6) \table* now defaults to \footnotesize text like \table.
269
270  7) The draft modes now no longer force a pagebreak after the title.
271     Thanks to Christian Peel for suggesting this change.
272
273  8) New draftclsnofoot mode is like draftcls, but does not display the
274     date and the word "DRAFT" at the foot of the page. Thanks to
275     Christian Peel for suggesting this feature.
276
277  9) New peerreview and peerreviewca modes with \IEEEpeerreviewmaketitle
278     command allows for a "cover" titlepage for anonymous peer review.
279     Except for the cover titlepage, peerreview is much like journal mode.
280     peerreviewca is like peerreview, but allows the author names to be
281     entered and formatted as under conference mode so that author
282     affiliations and contact information can be easily seen on the cover
283     page. Thanks to Eric Benedict for suggesting this feature.
284
285
286
287 *******
288  7/2002 V1.6 (MDS) changes:
289  
290  1) Added conference mode via conference option. Defaults to the
291     traditional journal mode. e.g., \documentclass[conference]{IEEEtran}
292  
293  2) Added support for A4 paper via new a4paper option. Pdflatex's paper
294     size lengths are now automatically set to the proper paper size being
295     used.
296  
297  3) Revised margins again. Page text is now horizontally centered.
298     Conference mode increases the top and bottom margins with the bottom
299     margin being slightly larger. For A4 paper, the top margin and text
300     typesetting will not change from those of US letter paper, but the side
301     margins will be smaller and the bottom margin will be larger than that
302     of US letter. All per IEEE specs.
303
304  4) Fixed footnote line spacing anomaly in draft mode. 
305     Thanks to Alberto Rodriguez for reporting this bug.
306     
307     Also, slightly revised footnote and \thanks note spacing.
308     Set \interfootnotelinepenalty=10000 to prevent LaTeX
309     from breaking footnotes across multiple pages or columns.
310
311  5) Fixed bug that caused overwritten photo areas and sometimes anomalous
312     spacing when a new paragraph was started within a biography. Also,
313     the presence of \par's, new lines or spaces at the beginning of
314     abstract, keywords, biography, or biographynophoto will no longer
315     affect the first word spacing.
316     Thanks to Eric Durant for reporting this bug.
317     
318     The biography environment now does a better job in preventing
319     a biography photo area from being broken across pages or columns.
320
321  6) Fixed whitespace between \cite entries bug. i.e.,
322     both \cite{einstein24, knuth84} and \cite{einstein24,knuth84}
323     are now valid. \cite is now a robust command as it should be.
324     IEEEtran now no longer defines the old non-standard \shortcite or 
325     \citename.
326     
327     The base IEEEtran.cls does not sort citation numbers or produce ranges
328     for three or more consecutive numbers. However, V1.6 of IEEEtran.cls 
329     now pre-defines the following format control macros to facilitate easy
330     use with Donald Arseneau's cite.sty package (tested with cite.sty V3.9):  
331
332     \def\citepunct{], [}
333     \def\citedash{]--[}
334     
335     cite.sty is standard on most LaTeX sytems and can be obtained from
336     www.ctan.org. Thanks to Donald Arseneau for creating cite.sty,
337     providing the required format arguments to produce the IEEE style
338     and designing a cite interface capable of handling the IEEE citation
339     style.
340     
341     Note: Historically, IEEE has wanted authors to "hardcode" symbolics.
342     (i.e., replace all \cite{} with fixed [x]). However, it now seems that
343     most electronic manuscript submissions to IEEE are in .pdf format, and 
344     as such, do not require the LaTeX document reference numbers to be hard
345     coded. If an author is required to submit actual LaTeX files, I do
346     recommend that the bibliography file (.bbl) be copied into the .tex
347     document and the \bibliographystyle{} and \bibliography{} commands be
348     commented out so that the .tex file does not depend on (potentially
349     lengthy and/or confidential) external bibliography database files
350
351  7) Adjusted some spacing parameters. The spacing above and below equations
352     has been revised (to a typical IEEE value). \jot now has a decent value.
353     The title text is now exactly 24pt. (On a related note, \fontsubfuzz has
354     been increased to 0.9pt to prevent annoying font substitution warnings
355     when using the Computer Modern fonts that use the 24.88pt size.)
356     In V1.6, \small is now 8.5pt in 9pt docs because \footnotesize is 8pt.
357     For 9pt docs, you should probably go ahead and use \footnotesize when
358     you need text a little smaller than \normalsize.
359     The interword spacing has been adjusted to be extremely close to that
360     which IEEE uses. You can use a new class option, nofonttune, if you need
361     to disable the adjusting of the interword spacing. This adjustment and
362     an increase to \hyphenpenalty have greatly reduced the amount of
363     hyphenation in a typical paper.
364        The baselineskip for the normalsize fonts has been tweaked to reduce
365     underfull vboxes on journal paper columns with only paragraphs. 
366     Conference mode does the same thing but by also tweaking the \textheight
367     slightly off 9.25in (IEEE spec) to ensure an integer number of lines per
368     page. Draft (also draftcls) mode has also been revised to reduce
369     underfull vbox warnings. However, draft mode can still produce underfull
370     vboxes (a direct result of the increase in line spacing and margins) if:
371     A non-normalsize font occupies an entire column (abstract and index
372     terms take up a whole column by themselves); or the beginning of a
373     section occurs near the end of a column and cannot be squeezed into the
374     bottom, etc. This is normal as draft mode's liberal spacings cannot
375     guarantee perfect formatting.
376
377  8) New biographynophoto environment for biographies without photos.
378     Usage: 
379     
380     \begin{biographynophoto}{author name}
381     biography text here 
382     \end{biographynophoto}
383     
384  9) Fixed bug that produced multiple table of contents entries for papers
385     with more than one biography. Also, biography now works better with
386     hyperref.
387  
388 10) New \sublargesize font size command provides for 11pt text in a 10pt
389     document. (Needed for things like author names.) For documents not
390     using 10pt normal size text, \sublargesize is currently identical 
391     to \large.
392
393 11) New \IEEEmembership command to provide correct font to indicate IEEE
394     membership for journal papers.
395
396 12) Fixed author name line overflow problem when in journal mode. This
397     problem had been introduced in V1.5 in my rush to get \and to work for
398     conferences. \and is unneeded (and invalid) in journal mode. For 
399     conference mode, \and will work as expected and features an optional
400     spacing argument. i.e., \and[\hspace{5ex}] 
401     \and will default (recommended) to using \hfill which will result in
402     equal spacing between author blocks.
403  
404 13) New \authorblockN, \authorblockA and \authorrefmark commands to 
405     facilitate easy formatting of author names, affiliations and cross
406     reference symbols, respectively, when in conference mode. These 
407     three commands are to be used only for conference papers.
408     In conference mode, \author text is placed within a modified tabular
409     environment (somewhat like article.cls). So, within \author in
410     conference mode, you should not try to enclose multiple \\ within an
411     environment or command (other than the argument braces of
412     \authorblockX{}). For example:
413     
414     \author{\authorblockN{{John Doe \\ Jane Doe}}} % WRONG!
415     
416     will generate an error. 
417   
418     Note that font size/attribute changes will now persists across \\
419     within \author. (But, not across author blocks nor across \and.)
420     However, with the new commands, there should be no need to alter any
421     font attributes within \author. All text sizing and spacing within 
422     \author{} and the author block commands is per IEEE specs for both 
423     conference and journal modes. (In conference mode, the author names
424     are only very slightly larger than the affiliations which are in normal
425     size.) For specialized applications you can alter the justification of
426     author lines by placing \hfill at the beginning or at the end of a line.
427     The interline spacing within \author is determined by the font
428     attributes that are in effect at the end of each line within author.
429  
430 14) Because the titles and author name blocks use different font
431     sizes/styles from the main text, it was possible that two column papers
432     with titles that span both columns (standard journal and conference
433     papers, but not technotes) with certain numbers of lines for the title
434     and authors' name/affiliations can cause underfull vbox problems
435     (paragraphs with large spacings between them) in the second column of
436     the main text on the title page - if there were no new sections,
437     equations or figures in this column (they would provide some needed
438     rubber spacing). The use of things like special paper notices and
439     publisher ID marks also affected this issue. The problem could not
440     happen in the first column because the first column has a rubber length
441     around the heading of the first section. Furthermore, problems seldom
442     occurred on pages after the first as the margins had been chosen not to
443     cause it with the popular font sizes. Rubber lengths after the author
444     names would not fix this problem.
445        Auto-calculating a "good" spacing after the title is a tad difficult
446     to do in LaTeX. However, I am pleased to report that V1.6 has this new
447     capability - "dynamically determined title spacing". IEEEtran will now
448     measure the height of all the title and author text in \maketitle
449     and then calculate a rigid (non-rubber) spacer to follow that meets
450     IEEE specs and also produces a \textheight on the title page that
451     ensures an integer number of normalsized lines on the rest of the page.
452     Single column  papers, and two column papers with the title entirely in
453     column one (technotes) do not need dynamic rigid spacing and therefore
454     use standard rubber spacers.
455     
456     Note: This problem can still crop up if you use floats that span both
457     columns (i.e., figure*). It has been a decade+ long limitation with
458     LaTeX that the stretchable portion of \dbltextfloatsep is ignored. 
459     If you get a problem with underful vbox warnings and paragraphs that
460     "are pulled apart" on page with a float that spans both columns, tweak
461     the space between the figure and the main text a little:
462     
463     \vskip 5pt
464     \end{figure*}
465     
466     If you can't find a value that fixes both columns, you are going to
467     have to put a rubber spacer somewhere in one or both of the columns.
468 15) Because of change #14 above, those of you using \pubid will, as of V1.6,
469     have to place it *before* \maketitle in order for it have the intended 
470     affect. The dynamic spacer algorithm must see if you are using \pubid
471     when \maketitle is called. \pubidadjcol works as before except that it
472     now has additional logic to prevent it from doing anything if \pubid
473     was never called.
474     
475 16) In some unusual, non-standard circumstances, an author may desire to
476     alter the spacing after the title area or put some unusual text above
477     the main text. For instance, to stop a bad break when a new section
478     occurs right at the start of the second page. This is difficult to do
479     when the title spans both columns of two column text since LaTeX treats
480     such title text as a type of float. A new command,
481     \IEEEaftertitletext{}, gives access to the end of that produced by
482     \maketitle. The types of things that can go into \IEEEaftertitletext
483     are the same as those into \twocolumn[] - no \par, but \\ are OK. There
484     is no restriction on the range of spacings that can be used. e.g.,
485     \IEEEaftertitletext{\vspace{-100pt}} will push the main text well into
486     the title and \IEEEaftertitletext{\vspace{100pt}} will push it far down
487     the page. You will have complete control. If used, place
488     \IEEEaftertitletext{} before \maketitle like \title and \author.
489     IEEEtran's dynamic title spacing intentionally does not take into
490     consideration the contents of \IEEEaftertitletext{} when determining
491     the spacer after the title area (otherwise it would try to second
492     guess you), so the user will have manually adjust the height of the
493     contents in \IEEEaftertitletext{} if the problem discussed in #14 above
494     should develop. A safe bet is to keep the height of contents of
495     \IEEEaftertitletext{} to integer multiples of \baselineskip, e.g.,
496     \IEEEaftertitletext{\vspace{-1\baselineskip}} 
497     
498     Because it can result in an IEEE nonstandard format, the use of
499     \IEEEaftertitletext{} is discouraged. Possible uses include (1) the use
500     of IEEEtran for non-IEEE work with different title spacing requirements,
501     or (2) as an emergency manual override if a problem should develop in 
502     IEEEtran's automatic spacing algorithm.
503  
504 17) completely rewritten \PARstart to:
505     a. no longer have problems when the user begins an environment
506        within the paragraph that uses \PARstart.
507     b. auto-detect and use the current font family
508     c. revise handling of the space at the end of the first word so that
509        interword glue will now work as normal.
510     d. produce correctly aligned edges for the (two) indented lines.
511
512     Because the current font family is now auto-detected, there is no
513     longer any need for \CMPARstart - it is now the same as \PARstart.
514    
515 18) There is now a new "open box" Q.E.D. symbol (\QEDopen) as well as the
516     original default (\QED) closed one (\QEDclosed). Some journals use
517     the open form. To make \proof use the open form, just do:
518     \renewcommand{\QED}{\QEDopen}
519
520 19) Additional \typeout{} notices added to warn the user when unusual 
521     settings/commands are detected or as reminders to avoid common errors
522     when in conference mode.
523
524 20) IEEEtran now provides \abovecaptionskip and \belowcaptionskip skip
525     registers because article class provides them and some packages
526     may error if they are missing. However, IEEEtran only uses 
527     \abovecaptionskip for actual caption spacing.
528
529 21) Fixed bug that prevented users from redefining the section headings
530     to use arabic digits. Thanks to Richardt H. Wilkinson for reporting
531     this bug.
532
533 22) Code cleaned up to be more efficient with the use of TeX registers;
534     removed some old LaTeX 2.09 code; revised option processing to 
535     LaTeX2e standard; eliminated unwanted "phantom" spaces in some
536     environments.
537
538 23) Added new \IEEEeqnarray, \IEEEeqnarraybox, \IEEEeqnarrayboxm and 
539     \IEEEeqnarrayboxt environments to provide superior alternatives to the
540     standard LaTeX \eqnarray, \array and \tabular. Additional new support
541     commands include \IEEEeqnarraydecl, \IEEEeqnarrayboxdecl,
542     \IEEEeqnarraymathstyle, \IEEEeqnarraytextstyle, \yesnumber.
543     \IEEEnonumber, \IEEEyesnumber, \IEEEyessubnumber, \IEEEeqnarraynumspace,
544     \IEEEeqnarraymulticol, \IEEEeqnarrayomit, \IEEEeqnarraydefcol,
545     \IEEEeqnarraydefcolsep, \IEEEeqnarrayseprow, \IEEEeqnarrayseprowcut,
546     \IEEEeqnarrayrulerow, \IEEEeqnarraydblrulerowcut,
547     \IEEEeqnarraystrutmode, \IEEEeqnarraystrutsize,
548     \IEEEeqnarraystrutsizeadd, \IEEEvisiblestrutstrue,
549     \IEEEvisiblestrutsfalse and \IEEEstrut.
550     These are documented in the user's guide.
551     
552 24) V1.6 changed back to using () around theorem names (which are also now
553     in italics) as this is what IEEE is using now. Thanks to Christian Peel
554     for reporting this. Also, when section numbers are used as the first
555     part of theorem numbers, display them in arabic, not Roman.
556     
557 25) New \IEEEtriggeratref{X} command allows a page break to be triggered
558     just before the given reference number "X". This is most useful when
559     balancing the columns on the last page and a \newpage between references
560     is desired. \IEEEtriggercmd{X} allows a different command to be executed
561     at trigger.
562
563
564
565 *******
566  7/2001 V1.5 (MDS) changes:
567
568
569  1) Fixed \and within \author bug: (! Misplaced \crcr. \endtabular ->\crcr)
570     Thanks to Rainer Dorsch for discovering and reporting that \and 
571     did not work.
572     
573  2) Fixed the biography environment so that if a biography's text is shorter
574     than the area allocated for the photo, a collision with the next
575     biography does not occur. You can now put real graphics (using the
576     graphicx package) into the biography photo box with a new optional 
577     argument of the biography command! For example:
578     
579     \begin{biography}[{\includegraphics[width=1in,height=1.25in,clip,
580                       keepaspectratio]{./tux.eps}}]{Linux Penguin}
581     
582     will use the specified graphic as the author's photo. The photo area is
583     exactly 1in wide by 1.25in high - as is done in IEEE Transactions. Try
584     to keep the same 4:5 aspect ratio if scanning/cropping your photos. 
585     Note the need for the extra set of enclosing braces around the
586     \includegraphics. Without it, The LaTeX parser may get confused when it
587     sees the \includegraphics's brackets within the biography's optional
588     argument. Due to the length of the \includegraphics command, you may
589     wish to define your own shorthand form of it. I have not done so with
590     IEEEtran to prevent dependence on the graphicx package. If you do not
591     use the optional argument, or leave it empty, a standard frame box
592     with the words "Place Photo Here" will be used. If you want the space
593     to remain completely empty, you can do:
594     
595     \begin{biography}[\mbox{}]{The Invisible Man} 
596     
597     The interface to biography's optional argument is into a
598     1in X 1.25in minipage in which the argument text is centered both 
599     horizontally and vertically:
600     
601     \begin{minipage}[b][1.25in][c]{1in}%
602     \centering
603     #1%
604     \end{minipage}
605     
606     Within the biography environment, \unitlength is set to 1in.
607     With this in mind, you can even design your own custom frameboxes.
608     For instance:
609     
610     \begin{biography}[\framebox(1,1.25){\parbox[][\height
611                      ][c]{0.9in}{\centering PLACE\\ PHOTO\\
612                                   HERE}}]{Author Name}
613     
614     will yield the same type of result as the default photo box.
615     
616     Thanks to Herbert Voss for discovering the collision bug, suggesting
617     the ability to handle graphics and providing some prototype code.
618
619
620
621 *******
622  3/2001 V1.4 (MDS) changes:
623
624
625  1) New "draftcls" and "final" options have been added.
626     Thanks to Dragan Cvetkovic for suggesting an option like draftcls.
627     
628  2) Documentation changes to reflect the fact that this IEEEtran.cls 
629     is no longer beta test.
630
631  3) Slightly revised caption sizes. Figure and table captions are now 
632     in \footnotesize, not \small as before.
633
634  4) Allow user to control figure caption justification. IEEEtran.cls 
635     normally defaults to left justified as is done in Transactions.
636     However, for conferences, you may wish to issue the command:
637     \centerfigcaptionstrue
638     in the preamble. Short (less than one line long) figure captions
639     will then be centered. Multi-line figure captions will always be 
640     properly left justified. V1.6: This is already done for you when
641     using the conference mode.
642
643
644
645 *******
646  1/2001 V1.3 
647  Michael Shell (MDS) made extensive changes and additions:
648
649
650  BUGS FIXED (and many others too numerous to mention!):
651  1) Fixed improper alignment with itemized, enumerated and
652     description lists. Added new controls to these three
653     environments so that it is easy to get the alignment IEEE
654     uses. Furthermore, the itemize, enumerate and description lists
655     no longer force a new paragraph to begin at the end the list
656     (\par). (Sometimes lists are used within paragraphs.) 
657  
658  2) JVH's fixes now allow things like $\mathbf{N}(0,P(0))$
659     to work properly without needing the extra braces:
660     ${\mathbf{N}}(0,P(0))$. There is no longer any dependence
661     on the "rawfonts" and "oldlfont" packages. Thanks Juergen! 
662  
663  3) Fixed underfull hbox errors and incorrect reference number
664     alignment when the number of references in the bibliography
665     exceeded 9 entries (which is almost every paper!).
666   
667  4) Removed dependence on the LaTeX sizexx.clo files.
668     Now, 9pt documents should work correctly even on systems that
669     lack a size9.clo file. This is most often used in conjunction
670     with the option "technote" for "correspondence" papers like those
671     in IEEE Transactions on Information Theory. For virtually all
672     other papers, 10pt is used and so it is the default.
673     Some improper font sizes have been corrected. \footnotesize is
674     now 8pt in 9pt docs, so footnotes in technotes should be the
675     correct size now. 
676  
677  5) Added \interlinepenalty within the bibliography section to discourage
678     LaTeX from breaking within a reference. IEEE almost never breaks within
679     a reference and when they do it is usually in technotes
680     (correspondence papers). You may get an underfull vbox warning in the
681     bibliography indicating that the spacing just before the "REFERENCES" 
682     section is larger than normal, but the final result will be more like 
683     what IEEE will publish. See the comments in the BIBLIOGRAPHY section
684     around line 2034 below if you want to change this behavior.
685
686  6) No longer "blows up" when you use \paragraph and have a table
687     of contents.
688  
689  7) Theorem environment changed, (but for V1.6, back to the old way, sigh).
690  
691  8) Figure captions adjusted: IEEE left (not center) justifies
692     figure captions (for journals) and does not indent figure caption text.
693  
694  9) Adjusted some spacings in the table of contents(TOC))/list-of-figures/
695     list-of-tables so that section/table numbers will not so easily 
696     collide with the titles. Section VIII was usually the worst offender.
697     Still doesn't right justify the section numbers, but neither does 
698     article.cls (This must be why LaTeX likes the x.y.z section numbering
699     scheme unlike I, II, III, etc. of IEEE. )
700     It may be "normal" as it is (left justified). sigh.
701  
702 10) Now uses "index terms" now as a heading instead of "keywords".
703     Furthermore, the "index terms" and "abstract" headings are in bold
704     italic. This is how IEEE does things.
705
706 11) \thebibliography and \biography now put entries into
707     the table of contents for you.
708
709 *******
710
711
712
713
714
715
716  *******
717  9/2000 (JVH) changes: (now designated as V1.2)
718  
719  made some corrections to get closer to LaTeX2e
720  20000906 Juergen v.Hagen
721  vonhagen@ihefiji.etec.uni-karlsruhe.de
722
723  Permission to redistribute granted as of December 2000.
724  *******
725
726
727
728
729
730  *******
731  
732  1996 (JWD) LaTeX2e version: (now designated as V1.1)
733   
734  In the most recent TeXhax digest, there was a request for a copy of
735  IEEEtrans.sty modified to work with LaTeX2e.  I have a version I
736  modified to make it IEEEtrans.cls, which I have sent to the person
737  making the request and am now sending to you to consider posting to
738  the archives.
739  --
740  Jon Dixon
741  dixonj@colorado.edu
742  http://spot.colorado.edu/~dixonj/
743
744 *******
745
746
747
748
749
750 *******
751
752  30-August-1993 original LaTeX 2.09 version (IEEEtran.sty),
753  (now designated as V1.0):
754
755  by Gerry Murray and Silvano Balemi
756  Automatic Control Lab, ETH Zurich, Switzerland
757  balemi@aut.ee.ethz.ch
758
759 *******
760
761
762