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