Documente Academic
Documente Profesional
Documente Cultură
(Invited Paper)
Abstract—Our premise is that a researcher should be able different macros, the author could immediately transform
to use his or her time doing research, and not fighting with a the style of a document from a draft manuscript into a fi-
text formatter. Modern formatters have macro capability.
If the proper macros are written, the text formatting for nal camera-ready format, and so forth, without the need
all IEEE publications may be accomplished automatically. for manual formatting. In this document we summarize
We propose that proponents of various text-processing sys- our expectations for such macro packages, and introduce
tems write macro packages for their own systems. The
scientific community would benefit greatly. One example
a candidate solution for the LATEX2ε typesetting system.
is provided for users of the LATEX2ε system. It is avail- This package, which we call ieee.cls, replaces both the
able at http://www–isl.stanford.edu/ieee/ or at the ftp site old IEEEtran.sty by Murray and Balemi, and the updated
ftp://isl.stanford.edu/pub/ieee/. A similar macro package IEEEtran.cls by Nüchter. A similar solution is currently
is being developed for users of Microsoft Word, and can be
found at the world-wide-web addresses given in the Conclu- being written for users of Microsoft Word.
sion.
II. The Document Life-Cycle
Index Terms—Style file, LATEX2ε , Microsoft Word, IEEE
Publications, Instrumentation and Measurement Technol- Each document to be published, regardless of whether
ogy Conference, IMTC.
it is destined to be a journal article or a conference paper,
goes through a certain life-cycle. At each stage of the life-
I. Introduction cycle, there are different formatting needs. This may be
summarized as follows:
A N important aspect of research is the writing and sub-
mission of papers for publication. Depending on how
the paper is to be published, there are various typesetting
Draft: The first stage in the life-cycle is the draft stage.
This is when the author is initially writing and edit-
ing the manuscript. The formatting of the document
formats for various purposes, and it is frustrating and time-
should help the author with this task. For example,
consuming to have to manually format a paper to follow
the main text should be double-spaced, the margins
all of the guidelines.
should be wide enough to allow written comments,
A much better solution is to have the formatting done
and a date-and-time stamp should be placed on each
automatically. Modern text processors and document-
page to help with version control.
typesetting systems offer this possibility by allowing user-
Internal Review: After the draft version is finalized, the
defined macro packages or style files. Sets of macros may
next stage in the life-cycle might be to give the paper
be defined to automatically present a document in any re-
to one or more colleagues for review. This stage is
quired format. Only one person, or a team of people, has
an internal review process, as opposed to the formal
to write the macro package, and then the entire scientific
review done upon submission to the IEEE (see the
community will benefit. The only question is how to make
next stage). Suggestions and criticism at this stage
such styles globally available.
can very much improve the quality of the paper and
Each researcher has his or her own favorite text proces-
can save much time in getting the paper published.
sor. We believe that if the proponents of the main text
The formatting for an internal review is fairly flexible.
processors (e.g., LATEX2ε , Microsoft Word, Framemaker,
One requirement is that the paper contain a phrase to
WordPerfect, and so forth1 ) cooperate, such macro pack-
the effect that the document is preliminary and should
ages could be created. This would spare a lot of work for
not be circulated without permission of the author(s).
both the authors and the editors of the paper. By invoking
This can appear in the header or footer of the paper,
for example.
Manuscript received September 27, 1997.
G. L. Plett is with the Department of Electrical Engineering, Stan-
Submission for Review: The next stage in the life-cycle
ford University, Stanford, CA 94305–9510. Phone: +1 650 723–4769, is to submit the paper to the IEEE for formal review
e-mail: glp@simoon.stanford.edu by anonymous reviewers. This review requires that
I. Kollár is with the Department of Measurement and Informa- the paper be formatted differently. In some cases, the
tion Systems, Technical University of Budapest, 1521 Budapest,
Hungary. Phone: + 36 1 463–1774, fax: + 36 1 463–4112, e-mail: title of the paper, and especially the authors’ names,
kollar@mmt.bme.hu must be printed on a separate title page to ensure
Publisher Item Identifier S 0018–9456(97)09426–6. anonymity of the authors. Double-spacing of the main
1 Microsoft Word is a trademark of Microsoft Corporation; Frame-
maker is a trademark of Frame Technology Corporation; WordPerfect text is usually required, but not time stamps, and so
is a trademark of Corel Corporation. forth.
0018–9456/97$10.00
c 1997 IEEE
1218 REPRINTED FROM: IEEE TRANS. ON INSTRUM. MEAS., VOL. 46, NO. 6, DECEMBER 1997
conference, the format of the paper is defined by the version for evaluation: Please do not circulate without
specifications used in the “Final Form” stage of the the permission of the author(s)”
life-cycle. However, if the paper is to be submitted to • The figures should be included in the text, rather than
a journal, there are different formatting requirements at the end of the document.
for the submitted document. • The text should be double-spaced, single-column, with
Final Distribution: After the paper is published, it is wide enough margins to allow for reviewers’ correc-
beneficial to have an electronic version of the paper tions.
(e.g., for distribution on the world-wide-web). This • The date should be added to the header of each page.
In this section, we give specifications which we feel must E. Submission for Publication in a Journal
be satisfied by a macro package to aid a researcher in This could be nearly identical to the case in Section C.
preparing papers for publication. We have followed this list A mark should be placed in the text to show about where
very closely when writing the example package ieee.cls. each figure should go. Figures may optionally be printed at
PLETT AND KOLLÁR: SPECIFICATION FOR COMMON IEEE STYLES 1219
a larger scale to allow better photographic reproduction. some of the above desires. It was written for the now-
The date of submission and possibly the editor’s paper obsolete LATEX2.09, and has been modified for LATEX2ε by
number should be added. Nüchter. The latter, called IEEEtran.cls, may be found
on the IEEE world-wide-web site. It implements much of
F. Camera-ready Form for Conference Submission the functionality required for the “Final Form” stage of
This is the only format that has a very strict and exactly the document life-cycle. We found it helpful as a start-
defined layout. This layout will be defined separately for ing point for this project. Our modified version, called
each conference, on the basis of the its author’s guide. ieee.cls, satisfies all of the requirements for each stage
of the document life-cycle.
G. Electronic Distribution (Initial and Final)
A. Choosing the Paper’s Style
A hardcopy or electronic version of the paper can be
useful for distribution during various stages in its life-cycle, Documents written for LATEX2ε are written as plain
but improper information in this distributed form can lead text. The LATEX2ε system converts the text into format-
to misunderstanding. The format should provide some spe- ted pages. To tell LATEX2ε how to format your document,
cific information. certain commands need to be entered into the text.
• If the paper is currently submitted for review, the text The ieee.cls class file makes this very easy. The first
“Submitted to (journal or conference name) for pub- line of your document needs to specify a command of the
lication,” along with the date, should appear on the form
title page.
\documentclass[main-mode,
• If the paper has been accepted for publication, but
sub-mode,
is not yet printed, the text “Accepted for publication
misc-options]{ieee}
by (journal or conference name), (in-press)” should
appear. where one “main-mode” is chosen from the following:
• In addition, for both of the above situations, the fol- draft Double-spaced, single-column, with date and
lowing text should be included: “Preliminary version: time stamp.
Please do not circulate without the permission of the submission Double-spaced, suitable for submitting the
author(s).” paper for review, or for submitting the paper for pub-
• If the version is a reprint, the text “Reprinted from lishing.
(journal or conference name)” should be included. Ad- compressed Same as “submission,” only single-spaced.
ditionally, the page numbers should match the printed This is suitable for archival, internal review, and for
version, and the volume number, issue number and some conference proceedings.
IEEE copyright information should be included. final For IEEE journals, this mode approximates the
• To facilitate the paper’s distribution on the world- journal’s final form. For IEEE conferences, it formats
wide-web, the height should be set in a way that it the paper for a camera-ready printout.
can be printed both on A4 and U.S. letter-size pa- The optional “sub-mode” is chosen from the following:
per. A “full” A4 page cannot usually be printed in internal The internal sub-mode can modify either the
the United States; the top lines will be missing. “submission,” “compressed,” or “final” modes. It
This form should allow a lot of freedom, such as one- or changes the header to notify the reader that this is
two-column formatting, the inclusion of a cover page, and an evaluation preprint, and not to be distributed.
so on. submitted The submitted sub-mode can modify either
the “compressed” or “final” modes. It changes the
IV. The LATEX2ε Class header to notify the reader that this paper has been
One text-formatting package in common use by re- submitted to a certain journal for publication, and
searchers is the LATEX2ε system [1]. Some of its features that it is not to be distributed.
include a very flexible macro capability, excellent format- inpress The inpress sub-mode is similar to the submit-
ting of mathematical equations, seamless integration of ted sub-mode. It can modify either the “compressed”
text into graphics (using the psfrag.sty package; see [2]), or “final” modes. It changes the header to notify the
and affordable price (it’s free!). reader that this paper has been accepted by a certain
Documents formatted with LATEX2ε must belong to a journal for publication, but that it has not yet been
certain “class.” A class file is a set of macros which tells published. It specifies that the paper is not to be dis-
LATEX2ε how to format the document. For example, the tributed.
standard classes which are available include an article class, reprint The reprint sub-mode can modify only the
a report class, a book class and a letter class. “final” mode. It changes the header to state that
For the purpose of writing IEEE papers, we have de- the paper is reprinted from a certain journal. It in-
veloped a special LATEX2ε “class” file. Users of LATEX cludes proper page numbers, IEEE copyright informa-
probably know about IEEEtran.sty, written by Murray tion and the IEEE log number.
and Balemi. This style was originally devised for evalu- technote When used in combination with “final,” this
ation and length measurement, but it is close to meeting sub-mode produces a two-column technical note.
1220 REPRINTED FROM: IEEE TRANS. ON INSTRUM. MEAS., VOL. 46, NO. 6, DECEMBER 1997
The optional “misc-options” are chosen from the following: specifies the style needed for the IEEE Instrumentation
titlepage/notitlepage The titlepage option causes a and Measurement Technology Conference.
separate title page to be produced. The notitlepage At the moment, plug-in files exist for almost all of the
option (default) does not produce a separate title IEEE journals (see the world-wide-web site mentioned in
page. the Conclusion for up-to-date information on which are
anonymous By default, all author information is in- supported), but only a few conferences. However, as the
cluded in the typeset paper. However, if the “anony- use of the ieee.cls package increases, additional plug-ins
mous” option is selected, author information is omit- will be created.
ted from the paper (except for on the optional title
C. More Definitions
page). Author information is omitted from the title
line on the first page of the paper and from the header In addition to specification of the modes and options for
on all pages. The author’s affiliation is omitted from the paper, several more things need to be defined. For a
the first page, and the author’s biography is also omit- regular IEEE journal submission, define the journal name
ted. Anonymity may be required when submitting a in the form
paper for review. \journal{IEEE Trans.\ Something}
invited If the paper is an invited paper (as this one
is), the “invited” option prints (Invited Paper) under The journal name is used to compose the header for each
the authors’ names on the first page of the paper. page. To add any other information after the journal name,
9pt,10pt,11pt,12pt You may manually choose the use \titletext. For example, to indicate the editor’s
paper’s type size. You should not need to do this since manuscript number on a preprint, you would type some-
the “correct” size is automatically chosen. However, thing like
if you want, you may use these to change the type size \titletext{, TN\#9999.}
of the main text. (“9pt” is a bit of a hack to retain
backward-compatibility.) The date is printed in the header for certain combina-
narroweqnarray This fixes a LATEX bug. The spacing tions of document options (e.g., for the submission mode).
around the “=” sign in equation arrays is changed to If you would like to pre-date or post-date the article, type,
be the same as in displayed math. for example,
inline Compresses the horizontal spacing of in-text \renewcommand{\today}{July 4, 1776}
math equations. The authors think that the resulting
equations look better than those normally produced To specify the IEEE copyright information on the first page
by LATEX2ε . of a reprint, type
Already we can see the power of ieee.cls. By changing \ieeecopyright{xxx--xxxx/97\$10.00
a single parameter in the first line of the document, the \copyright\ 1997 IEEE}
user can change the entire format of the paper!
Reprints also contain either an “IEEE log number,” a
“publisher item identifier,” or similar publishing informa-
B. Plug-Ins tion in the lower left column on the first page. This can
The main ieee.cls file specifies the formatting required be entered as
for a generic IEEE journal. However, some journals have \lognumber{xxxxxxx}
their own formatting particularities. For example, jour-
nals of the IEEE Signal Processing Society have centered or
figure captions, and all other journals have left-justified \pubitemident{S xxxx--xxxx(97)xxxxx--x}
captions. Journals of the IEEE Computer Society are for-
matted very differently from journals of all other societies. or
Furthermore, each conference has its own style. \loginfo{Manuscript received... }
Rather than burdening the main ieee.cls file with
To specify the first page of a reprint of a paper beginning
the definitions required for each journal, we have placed
on page 103 of a journal, you would type
this task on small “plug-in” files designed to work with
ieee.cls. For example, to format a document for \firstpage{103}
the IEEE Transactions on Computers, specify (after the
Finally, for a conference, the location and date are specified
\documentclass command):
as, for example,
\usepackage{ieeetc} \confplacedate{Ottawa, Canada,
Plug-in files are also used to format papers for conferences. May 19--21, 1997}
The main mode of the paper should be “final,” and the D. The Title Information
conference style-file should be loaded. For example,
The title-and-author information for a paper is entered
\usepackage{ieeeimtc} as follows. Define:
PLETT AND KOLLÁR: SPECIFICATION FOR COMMON IEEE STYLES 1221
This can be especially useful for preprints and reprints of VI. Figures
the document. If you do not specify this first parameter, Figures in the text require special attention. First, when
a framed empty box is printed; however, any file that is submitting a paper for printing, it is often required that
recognized by \includegraphics may be used. The aspect the figures and tables be at the end of the paper. This can
ratio of the photograph should be approximately 25 by 32. be handled by the endfloat.sty package, which is part of
If it is a few percent away from the desired aspect ratio, the standard LATEX2ε distribution.
the picture is re-sized non-proportionally. Otherwise, it is
The documentation for the “endfloat” package is some-
shrunk proportionally to fit the space and is then placed,
what daunting, but all that should be required is to specify
centered, in a box of the correct size; a warning message
“Too wide/tall” is printed. \usepackage{endfloat}
Note that a single blank line in the biography environ- before the \begin{document} command in the paper. The
ment causes paragraph separation. But beware: Multiple default options should work well.
blank lines in a row will leave a larger vertical space be- Whether or not you use the endfloat.sty package, en-
tween paragraphs. capsulated postscript (EPS) files may be included simply
in the text by
V. Putting it all Together
\includegraphics{figname.eps}
To be perfectly clear, Fig. 1 summarizes the commands Partial documentation for the \includegraphics com-
necessary to format a document using the ieee.cls file. mand is available in the LATEX2ε user’s guide [1], [2],
The LATEX2ε source for this paper is also available at the and complete documentation is available in epslatex.ps,
world-wide-web site mentioned in the Conclusion, furnish- included in the standard distribution of LATEX2ε . The
ing a more complete example. reader should note that the new \includegraphics com-
mand supersedes the older style-packages epsfig.sty and
psfig.sty, which are no longer required.
\documentclass[final]{ieee} The reader may also wish to investigate the very power-
ful psfrag.sty package, which is again part of the stan-
\begin{document}
dard distribution. It allows one to change labels in EPS
\title[Specification for ...]{% files to use LATEX’s fonts, and it produces a very polished
Specification for ...} looking paper.
\author[PLETT AND KOLL\’{A}R]{%
Gregory L. Plett\member{Student A. Figure Management with ieeefig.sty
Member},\authorinfo{G.\ L.\
Plett is ...}
Finally, we have developed another package to aid in fig-
\and{}and Istv\’{a}n ure preparation. It is called ieeefig.sty, and is especially
Koll\’{a}r\member{Fellow}\authorinfo{I.\ suited for use with the psfrag.sty package. It provides
Koll\’{a}r is ...} a practical method to manage a large number of figures
}
efficiently. It is designed to work with ieee.cls, but will
\journal{IEEE Transactions on ...} also work with all of the standard LATEX2ε classes (e.g.,
for writing reports, writing books, or creating presenta-
\maketitle
tion transparencies). The ieeefig.sty package is loaded
\begin{abstract} by specifying (after the \documentclass command)
Our premise...
\end{abstract} \usepackage[options]{ieeefig}
It is automatically centered in its column. (The optional figures from that point in the paper onward. If it is inside
argument in square brackets, “dim,” is the vertical size of of an individual figname.tex file, then it applies only to
the figure. It defines the amount of vertical space to be that figure.
skipped if the “blank” option is used.)
Through separation of the figure-generating commands VII. Wish List for ieee.cls
from the main paper, the figure is portable and may be The LATEX2ε class package, ieee.cls, used in conjunc-
re-used in other papers, reports or presentations. It also tion with the endfloat.sty and ieeefig.sty packages
permits ieeefig.sty to perform some useful tasks. These provides nearly all the desired functionality of a package
tasks are controlled either by the options used when load- to format IEEE papers. Several things remain outstand-
ing the style or by a series of commands. The available ing, however.
options may be chosen from the following:
The biggest omission is that “plug-ins” exist for only
draft Displays the filename figname.tex in the mar- a few conferences. We hope that researchers who have
gin. Also displays the height of the figure. In this developed styles for other IEEE conferences will modify
way, you can determine the correct value of the op- their styles to fit within the ieee.cls framework, and will
tional argument “dim” of the \figdef command. then contribute their work to the scientific community.
final Does not display the filename or height of the
A more subtle issue is that none of the two-column
figure.
modes balance the columns on the last page of the pa-
blank Instead of displaying figures, \figdef will leave
per. The standard package multicol.sty may be able to
a vertical space on the page. The height of the vertical
help, but it apparently does not allow single-column fig-
space is specified by the optional argument “dim” of
ures and tables. Perhaps some TEXpert out there can fix
the \figdef command. By omitting figures, you will
this. Right now, the only work-around is for the user to
allow LATEX2ε to compile your document more quickly.
manually insert a \newpage at the appropriate place to try
This option may also be selected in the document by
to balance the columns on the last page of the paper. This
the command \draftfigstrue.
is a poor solution at best.
noblank This is the complement of the blank option.
Finally, the multi-blank-line bug in the biography en-
Figures are shown. This option may also be selected
vironment should be fixed. Until it is, the work-around
in the document via the command \draftfigsfalse.
is to be careful to leave only a single blank line between
frame This option causes each figure to be surrounded
paragraphs.
by a box, which can help determine whether the
bounding box on an EPS file is correct. The bounding
VIII. Conclusion
box often must be adjusted if the psfrag.sty pack-
age is being used and labels go outside the boundary We have outlined a specification for macro packages to
of the figure. If the bounding box is incorrect, the aid an author of papers for IEEE publications. Addition-
figure will not be centered properly, and the spacing ally, we have provided a LATEX2ε class which accomplishes
before and after the figure will be incorrect. To adjust most of these goals. Users of other text-formatting sys-
the bounding box, see the trim command below. This tems are encouraged to write similar macro packages for
option may also be selected in the document using the the benefit of the research community. Anyone interested
command \figframestrue. in this task should contact the second author via e-mail.
noframe Frames are not drawn around figures. This The LATEX2ε class, which was used as an example here,
option may also be selected in the document through is provided on an “as-is” basis at
the command \framefigsfalse.
If EPS files are being loaded in the figname.tex file, http://www-isl.stanford.edu/ieee/
they should be loaded using the command or at
\inserteps[trim=a b c d]{figname.eps} ftp://isl.stanford.edu/pub/ieee/
This command inserts the EPS file figname.eps at the Any bug report is welcome, especially if accompanied by
correct scale. It also adjusts the bounding box by trimming the solution! Reports should be made, via e-mail, to the
off a , b , c , and d points from the left, bottom, right first author.
and top edges of the figure, respectively. Negative trim A similar macro package is under development for users
amounts increase the size of the bounding box. If any of Microsoft Word. It is available at
\psfrag statements have been made for this figure, they
will take effect with this command. http://www.ifm.liu.se/Meastech/Bjorn/IMTC.html
Finally, to scale all EPS figures by a constant “num” use
At the present time, it is able to format papers for the
\setfigscale{num} IEEE Instrumentation and Measurement Technology Con-
ference. References to both packages can also be found on
This is very useful for specifying different scales for presen- the IM Society page
tation transparencies and for reports. If the \setfigscale
command is in the main paper text, then it applies to all http://www.ieee.org/society/im/im.htm
1224 REPRINTED FROM: IEEE TRANS. ON INSTRUM. MEAS., VOL. 46, NO. 6, DECEMBER 1997
References
[1] Leslie Lamport, A Document Preparation System: LATEX User’s
Guide and Reference Manual, Addison-Wesley, Reading, MA,
2nd edition, 1994. Be sure to get the updated version for LATEX2ε !
[2] Michel Goossens, Frank Mittelbach, and Alexander Samarin, The
LATEX Companion, Addison-Wesley, Reading, MA, 1994.