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