Debian Codegraph @

texmf-dist/source/latex/ieeeconf/IEEEconf.dtx

raw
1 % \iffalse meta-comment
2 %
3 % Copyright (C) 2009 by Scott Pakin <[email protected]>
4 % ---------------------------------------------------------
5 %
6 % This file may be distributed and/or modified under the conditions of
7 % the LaTeX Project Public License, either version 1.3c of this license
8 % or (at your option) any later version. The latest version of this
9 % license is in:
10 %
11 % http://www.latex-project.org/lppl.txt
12 %
13 % and version 1.3c or later is part of all distributions of LaTeX
14 % version 2006/05/20 or later.
15 %
16 % \fi
17 %
18 % \iffalse
19 %<*driver>
20 \ProvidesFile{IEEEconf.dtx}
21 %</driver>
22 %<class>\NeedsTeXFormat{LaTeX2e}[1999/12/01]
23 %<class>\ProvidesClass{IEEEconf}
24 %<*class>
25 [2009/04/05 v1.4 IEEE Computer Society 8.5x11" conference proceedings]
26 %</class>
27 %
28 %<*driver>
29 \documentclass{ltxdoc}
30 \usepackage{textcomp}
31 \usepackage{needspace}
32 \usepackage[hyperindex=false,bookmarksopen=true]{hyperref}
33 \EnableCrossrefs
34 \CodelineIndex
35 \RecordChanges
36 \begin{document}
37 \DocInput{IEEEconf.dtx}
38 \end{document}
39 %</driver>
40 % \fi
41 %
42 % \CheckSum{360}
43 %
44 % \CharacterTable
45 % {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
46 % Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
47 % Digits \0\1\2\3\4\5\6\7\8\9
48 % Exclamation \! Double quote \" Hash (number) \#
49 % Dollar \$ Percent \% Ampersand \&
50 % Acute accent \' Left paren \( Right paren \)
51 % Asterisk \* Plus \+ Comma \,
52 % Minus \- Point \. Solidus \/
53 % Colon \: Semicolon \; Less than \<
54 % Equals \= Greater than \> Question mark \?
55 % Commercial at \@ Left bracket \[ Backslash \\
56 % Right bracket \] Circumflex \^ Underscore \_
57 % Grave accent \` Left brace \{ Vertical bar \|
58 % Right brace \} Tilde \~}
59 %
60 %
61 % \changes{v1.0}{2004/01/14}{Initial version}
62 % \changes{v1.0a}{2004/09/18}{Clarified the documentation as per Ming
63 % Kin Lai's suggestions}
64 % \changes{v1.3}{2005/08/28}{Added a paragraph about formatting
65 % reference lists as per Rennie deGraaf's suggestion}
66 %
67 % \GetFileInfo{IEEEconf.dtx}
68 %
69 % \DoNotIndex{\.,\@arabic,\@beginparpenalty,\@clubpenalty,\@empty}
70 % \DoNotIndex{\@endparpenalty,\@gobble,\@lowpenalty,\@M,\@m,\@minipagefalse}
71 % \DoNotIndex{\@mkboth,\@noitemerr,\@openbib@code,\@plus,\@tempboxa}
72 % \DoNotIndex{\advance,\baselineskip,\begin,\bfseries,\box,\c@enumiv}
73 % \DoNotIndex{\centering,\clubpenalty,\crcr,\CurrentOption,\def,\else}
74 % \DoNotIndex{\end,\endieee@thebibitemlist,\endlist,\endquotation}
75 % \DoNotIndex{\endthebibitemlist,\endtitlepage,\fi,\fontsize,\footnote}
76 % \DoNotIndex{\global,\hb@xt@,\hfil,\hsize,\hskip,\ifdim,\ifx,\itshape,\let}
77 % \DoNotIndex{\list,\long,\mdseries,\newcommand,\newenvironment,\newif}
78 % \DoNotIndex{\newlength,\newpage,\next,\null,\p@enumiv,\par,\ProcessOptions}
79 % \DoNotIndex{\quotation,\refname,\relax,\renewcommand,\renewenvironment}
80 % \DoNotIndex{\rmfamily,\rule,\sbox,\setlength,\settowidth,\sfcode}
81 % \DoNotIndex{\sffamily,\sloppy,\small,\upshape,\usecounter,\vfil,\vskip}
82 % \DoNotIndex{\vspace,\wd,\widowpenalty,\z@}
83 %
84 % ^^A Define a macro for indexing package names.
85 % \DeclareRobustCommand{\indexpkgname}[1]{^^A
86 % \index{#1\actualchar\textsf{#1} (package)\encapchar usage}^^A
87 % \index{packages:\levelchar#1\actualchar\textsf{#1}\encapchar usage}^^A
88 % }
89 %
90 % ^^A Define a macro for typesetting and indexing package names.
91 % \DeclareRobustCommand{\pkgname}[1]{^^A
92 % \textsf{#1}^^A
93 % \indexpkgname{#1}^^A
94 % }
95 %
96 % ^^A Define a macro for typesetting "IEEEconf" and one for typesetting
97 % ^^A "IEEE Computer Society Press".
98 % \newcommand{\iecnf}{\pkgname{IEEEconf}}
99 % \newcommand{\ICSP}{IEEE Computer Society Press}
100 %
101 % \title{The \iecnf{} class\thanks{This document
102 % corresponds to \iecnf{}~\fileversion, dated \filedate.}}
103 % \author{Scott Pakin \\
104 % \href{mailto:[email protected]}{\texttt{[email protected]}}}
105 %
106 % \hypersetup{^^A
107 % pdftitle={The IEEEconf class},
108 % pdfauthor={Scott Pakin <[email protected]>},
109 % pdfsubject={Format papers for IEEE Computer Society Press conference
110 % proceedings},
111 % pdfkeywords={conference proceedings, formatting requirements, IEEE
112 % Computer Society Press}
113 % }
114 %
115 % \maketitle
116 %
117 % \section{Introduction}
118 %
119 % The \iecnf{} class implements the formatting dictated by the \ICSP{}
120 % for conference proceedings. |IEEEconf.cls| replaces |latex8.sty| and
121 % is compatible with any \BibTeX{} style, not just |latex8.bst|. The
122 % goal was to produce a more faithful implementation of the formatting
123 % rules and to do so with cleaner \LaTeX{} code than that provided by
124 % the |latex8.*| files:
125 %
126 % \begin{itemize}
127 % \item \iecnf{} is written as a class, which makes more sense than
128 % implementing it as a style file.
129 %
130 % \item \iecnf{} uses the \pkgname{titlesec} package to redefine
131 % |\section|, |\subsection|, and |\subsubsection| as dictated by the
132 % guidelines. \pkgname{latex8} requires that authors use
133 % |\Section|, which internally calls |\section| then backspaces to
134 % add the required period after the section number. Yuck! By using
135 % proper sectioning, \iecnf{} is compatible with the
136 % \pkgname{hyperref} package. (Examine the PDF bookmarks produced
137 % when using \pkgname{latex8} with \pkgname{hyperref}.)
138 %
139 % \item \iecnf{} changes bibliography formatting by redefining the
140 % |thebibliography| environment instead of by requiring the author to
141 % use a particular \BibTeX{} style file.
142 %
143 % \item \iecnf{} selects fonts using the \LaTeXe{} font commands
144 % instead of \TeX{} primitives. This lets an author redefine
145 % |\rmdefault|, |\sfdefault|, and |\ttdefault| and have those changes
146 % honored by \iecnf.
147 %
148 % \item \iecnf{} uses the \pkgname{geometry} package to construct the
149 % page layout rather than setting \LaTeX{} registers directly.
150 % \end{itemize}
151 %
152 % Note that \iecnf{} is intended specifically for preparing manuscripts
153 % for \ICSP{} conference proceedings. Most other IEEE
154 % publications---including other IEEE conference proceedings---specify
155 % different formatting requirements. Unless you were instructed
156 % explicitly to follow \ICSP's conference-proceedings guidelines, you
157 % may find the \pkgname{IEEEtran} package more appropriate than \iecnf.
158 %
159 % \paragraph{Caveats} First, as of this writing, \iecnf{} has been neither
160 % validated nor endorsed by the \ICSP{}\@. Second, some of the \ICSP's
161 % guidelines are outside of \iecnf's scope. See
162 % Section~\ref{sec:limitations} for details. Third, the \ICSP{}
163 % occasionally changes their guidelines; \iecnf~\fileversion{}
164 % implements the guidelines that were current on~2007/01/15. In fact,
165 % the \ICSP{} Web site provides two sets of guidelines:
166 %
167 % \begin{itemize}
168 % \item
169 % \url{ftp://pubftp.computer.org/press/outgoing/proceedings/instruct8.5x11.pdf}.
170 % \iecnf{} relies on this document for its primary set of
171 % guidelines.
172 %
173 % \item
174 % \url{http://www.computer.org/portal/site/ieeecs/index.jsp?pageID=ieeecs_level1&path=ieeecs/publications/cps&file=cps_forms.xml&xsl=generic.xsl}.
175 % This Web page contains almost the same contents as the preceding
176 % PDF file except that the ``Footnotes'' section has nothing to do
177 % with footnotes but rather with column formatting. Footnote
178 % guidance is taken from the other set of guidelines.
179 %
180 % \item
181 % \url{ftp://pubftp.computer.org/press/outgoing/proceedings/INSTRUCT.HTM}
182 % and
183 % \url{ftp://pubftp.computer.org/press/outgoing/proceedings/instruct.txt}.
184 % This document provides guidance on footnote formatting. However,
185 % it contradicts the previous documents by specifying that paragraphs
186 % be indented by 1~pica while the preceding document says to indent
187 % paragraphs by 1/4~inch (1.5~picas). It limits the abstract to
188 % 3~inches (7.62\,cm) while the previous document dictates a
189 % 150-word limit. \iecnf{} follows the previous document in the
190 % case of any conflict.
191 %
192 % This document contains an additional section about illustrations
193 % that says not to use color figures unless instructed to do so and
194 % presents a few prehistoric guidelines about penciling in page
195 % numbers and how to use rub-on symbols.
196 % \end{itemize}
197 %
198 % Pages on the IEEE Computer Society Web site are frequently moved
199 % and/or renamed. You may need to search a bit to find the latest
200 % versions of the documents described above.
201 %
202 %
203 % \section{Usage}
204 %
205 % Unlike \pkgname{latex8}, \iecnf\ is a proper \LaTeXe\ class. Also
206 % unlike \pkgname{latex8}, it automatically loads the packages it needs
207 % and sets all of the correct formatting options by default.
208 %
209 % \subsection{Class options}
210 %
211 % \DescribeMacro{\documentclass}
212 % Begin your document by loading the \iecnf{} class:
213 %
214 % \begin{verbatim}
215 % \documentclass{IEEEconf}
216 % \end{verbatim}
217 %
218 % \noindent
219 % Although \iecnf\ is derived from \textsf{article} and accepts the
220 % same class options, you should not, in general, pass any extra options
221 % to |\documentclass|. \iecnf\ will automatically set two-column mode
222 % and a 10\,pt.\ Times Roman font. \iecnf\ honors the user's default
223 % paper size because the \ICSP\ now allows both U.S.~Letter- and
224 % A4-sized paper. The default paper size can be overridden by the
225 % |letterpaper| or |a4paper| class options if a conference dictates a
226 % particular paper size.
227 %
228 % \iecnf\ introduces one class option of its own: |latex8|. The
229 % |latex8| option instructs \iecnf\ to violate the \ICSP\ guidelines in
230 % the same manner that the \pkgname{latex8} package provided by the
231 % \ICSP\ violates them. The advantage of using the |latex8| option is
232 % that \pkgname{latex8}'s incorrect formatting provides a larger text
233 % block (27\,pt.\ wider) than the guidelines allow. Hence, if you need
234 % to squeeze a little extra text into your paper, the |latex8| option
235 % lets you do that without violating the rules any more than the
236 % \pkgname{latex8} package does.
237 %
238 %
239 % \subsection{User commands}
240 %
241 % \DescribeMacro{\title}
242 % The |\title| command behaves identically to the one in the
243 % \textsf{article} class. Just remember to follow what the guidelines
244 % say about capitalization of words in the title.
245 %
246 % \DescribeMacro{\author}
247 % \DescribeEnv{affiliation}
248 % \DescribeMacro{\email}
249 % The guidelines specify different formatting for an author's name and
250 % for an author's affiliation and e-mail address. For convenience,
251 % \iecnf\ provides an |affiliation| environment for
252 % typesetting affiliations and an |\email| macro for typesetting e-mail
253 % addresses. The following examples show how to format an author list:
254 %
255 % \begin{verbatim}
256 % % Individual author
257 % \author{%
258 % Amy Author \\
259 % \begin{affiliation}
260 % Fancy Text Processing Department \\
261 % University of Llanfairpwllgwyngyllgogerychwyrndrobwllllantysiliogogogoch
262 % \end{affiliation} \\
263 % \email{[email protected]}
264 % }
265 % \end{verbatim}
266 %
267 % \begin{verbatim}
268 % % Multiple authors
269 % \author{%
270 % Ray Writer \\
271 % \begin{affiliation}
272 % International Giant Mega-Corporation, Inc.
273 % \end{affiliation} \\
274 % \email{[email protected]}
275 % \and
276 % Kim Composer \\
277 % \begin{affiliation}
278 % Department of Reading, 'Riting, and 'Rithmetic
279 % \LaTeX{} State University
280 % \end{affiliation} \\
281 % \email{[email protected]}
282 % }
283 % \end{verbatim}
284 %
285 % There is not currently any special support in \iecnf\ for typesetting
286 % multiple affiliations per author.
287 %
288 % \DescribeMacro{\date}
289 % The date macro is implemented but doesn't actually typeset anything.
290 %
291 % \DescribeMacro{\callout}
292 % A \emph{callout} is a piece of text referring to a figure or table.
293 % When the \ICSP\ re-typesets a document they supposedly want the ``See
294 % Figure\dots'' and ``See Table\dots'' text to stand out to help the
295 % typesetter ensure that figures and tables are placed as close as
296 % possible to their references. The |\callout| macro simply typesets
297 % its argument in 9-point Helvetica as per the guidelines and is
298 % typically used as follows: ``\texttt{For details, see}
299 % |\callout{Figure~\ref{myfigure}}|''. My understanding is that
300 % |\callout| should be used only when a paper will be re-typeset and not
301 % when producing camera-ready copy.
302 %
303 % \DescribeMacro{\dobeforekey}
304 % The \ICSP\ guidelines say, ``If the last page of your paper is only
305 % partially filled, arrange the columns so that they are evenly balanced
306 % if possible, rather than having one long column.'' While the
307 % \pkgname{balance} and \pkgname{multicol} packages may help, this is a
308 % fairly tricky requirement in the general case for \LaTeXe\@. Because
309 % the last page of a conference paper typically contains only
310 % references, \iecnf\ provides a simple command, |\dobeforekey|, to help
311 % with that specific case. |\dobeforekey| takes two arguments: a
312 % bibliography key (i.e.,~a string passed to the |\cite| command) and a
313 % command to execute before typesetting the corresponding bibliography
314 % entry. When preparing the final version of your paper, put
315 % ``|\dobeforekey{|\meta{key}|}{\newpage}|'' anywhere before the
316 % |\bibliography| command and use trial-and-error to find the key that
317 % best balances the columns on the last page of the paper.
318 %
319 % \paragraph{Reference lists}
320 % The \ICSP\ provides little guidance about typesetting reference
321 % lists. Apparently, the author is granted some flexibility. \iecnf{}
322 % uses the specified font but leaves the rest of the formatting
323 % decisions to the author's chosen bibliography style. As the \ICSP's
324 % two sample references both use abbreviated author names, it's probably
325 % best to use |\bibliographystyle{abbrv}| when including a \BibTeX{}
326 % bibliography.\footnote{\texttt{latex8.bst} is in fact identical to
327 % \texttt{abbrv.bst} except that it injects
328 % ``\texttt{\cs{setlength}\linebreak[0]\string{\cs{itemsep}\string}\linebreak[0]\string{-1ex\string}\linebreak[0]\cs{small}}''
329 % into its generated \texttt{thebibliography} environment.} \iecnf{}
330 % also supports the |\thebibliography| environment for authors who
331 % prefer to typeset their reference lists manually.
332 %
333 % \DescribeMacro{\extrareflistcode}
334 % Previous versions of the \ICSP\ guidelines stated that bibliographic
335 % references must be single-spaced, and that's how \iecnf\ formats the
336 % list of references. The current guidelines say nothing about
337 % inter-reference spacing but their two sample references are in fact
338 % separated by a blank line. To provide the author with both
339 % alternatives, \iecnf\ provides a ``hook'' macro called
340 % |\extrareflistcode| that enables one to alter the line spacing---or
341 % any other aspect of reference-list spacing.
342 %
343 % As in most \LaTeXe\ classes, references are typeset within a \LaTeX{}
344 % |list| environment. The |\extrareflistcode| macro specifies extra
345 % code to execute as part of the second argument to |\begin{list}| when
346 % typesetting the document's References section. |\extrareflistcode| is
347 % initially empty but can be redefined by the author with
348 % |\renewcommand|. For example, the following code instructs \iecnf{}
349 % to insert a blank line between entries in the references list:
350 %
351 % \begin{verbatim}
352 % \renewcommand{\extrareflistcode}{\setlength{\itemsep}{\baselineskip}}
353 % \end{verbatim}
354 %
355 %
356 % \section{Limitations}
357 % \label{sec:limitations}
358 %
359 % There are some requirements in the Computer Society's guidelines that
360 % \iecnf\ is unable to enforce:
361 %
362 % \begin{itemize}
363 % \item ``All manuscripts must be in English.''
364 %
365 % \item ``Capitalize the first letter of nouns, pronouns, verbs,
366 % adjectives, and adverbs; do not capitalize articles, coordinate
367 % conjunctions, or prepositions (unless the title begins with such a
368 % word).''
369 %
370 % \item ``Avoid the use of academic degrees and society affiliations.''
371 %
372 % \item ``Avoid using bit-mapped fonts if possible. True--Type~1
373 % fonts are preferred.''
374 %
375 % \item ``Use footnotes sparingly (or not at all!)''. The guidelines
376 % do specify how to format footnotes if you're desperate and \iecnf{}
377 % honors the those requirements.
378 %
379 % \item ``Where appropriate, include the name(s) of editors of
380 % referenced books.''
381 % \end{itemize}
382 %
383 % \noindent
384 % Furthermore, there are also some requirements the \iecnf{}
385 % does not currently implement:
386 %
387 % \begin{itemize}
388 % \item ``The abstract is to be\dots up to 150~words in length.''
389 % \iecnf\ currently allows abstracts of any length.
390 %
391 % \item In the author list, ``[m]ultiple authors may be shown in a
392 % two- or three-column format''. Like \textsf{article}, \iecnf{}
393 % packs as many authors as possible onto a line.
394 %
395 % \item ``Initially capitalize only the first word of each figure
396 % caption and table title~\dots\ Figure captions are to be centered
397 % below the figures. Table titles are to be centered above the
398 % tables.'' Consider using the \pkgname{topcapt} package to help with
399 % this captioning requirement.
400 %
401 % \item ``If the last page of your paper is only partially filled,
402 % arrange the columns so that they are evenly balanced if possible,
403 % rather than having one long column.'' Consider using either
404 % \iecnf's |\doafterkey| macro or the \pkgname{balance} package to
405 % help with this formatting requirement.
406 % \end{itemize}
407 %
408 % \noindent
409 % Some of the above shortcomings may be fixed in a future release of
410 % \iecnf\ if I figure out a good way to do so.
411 %
412 % Also note that currently, only $8\mbox{\textonehalf} \times 11''$
413 % proceedings are supported, not $6 \times 9''$ proceedings.
414 %
415 %
416 % \StopEventually{%
417 % \section{License}
418 %
419 % Copyright \textcopyright\ 2009 by Scott Pakin
420 %
421 % \bigskip
422 %
423 % This file may be distributed and/or modified under the conditions of
424 % the \LaTeX\ Project Public License, either version~1.3c of this
425 % license or (at your option) any later version. The latest version of
426 % this license is in:
427 %
428 % \begin{center}
429 % \texttt{http://www.latex-project.org/lppl.txt}
430 % \end{center}
431 %
432 % \noindent
433 % and version~1.3c or later is part of all distributions of \LaTeX{}
434 % version 2006/05/20 or later.
435 %
436 % \needspace{3cm}
437 % \phantomsection
438 % \addcontentsline{toc}{section}{Change History}
439 % \PrintChanges
440 %
441 % \needspace{3cm}
442 % \phantomsection
443 % \addcontentsline{toc}{section}{Index}
444 % \PrintIndex
445 % }
446 %
447 %
448 % \section{Implementation}
449 %
450 % This section contains the complete source code to \iecnf.
451 % If you're not a \LaTeX\ hacker you probably won't find it
452 % particularly interesting or useful. However, if you're comfortable
453 % reading \TeX\ and \LaTeX\ code, you can see exactly what
454 % \iecnf\ is doing and how.
455 %
456 % \subsection{Initialization}
457 %
458 % \changes{v1.4}{2009/03/21}{Introduced a \texttt{onecolumn} class option
459 % in case a document needs to use the \pkgname{multicol} package}
460 % \begin{macro}{\ieee@column@spec}
461 % The guidelines require that all text be in a two-column format.
462 % However, there may be some special cases in which a single-column
463 % format is desirable, for example if the \pkgname{multicol} package is
464 % needed anywhere in the document. We therefore provide a |onecolumn|
465 % option to suppress the default two-column formatting.
466 % \begin{macrocode}
467 \def\ieee@column@spec{twocolumn}
468 \DeclareOption{onecolumn}{\def\ieee@column@spec{onecolumn}}
469 % \end{macrocode}
470 % \end{macro}
471 %
472 % \begin{macro}{\if@ieee@correct@geometry@}
473 % \begin{macro}{\@ieee@correct@geometry@true}
474 % \begin{macro}{\@ieee@correct@geometry@false}
475 % \iecnf\ lays out the page geometry according to the \ICSP\ guidelines.
476 % However, as \iecnf\ is not yet recognized by the IEEE Computer
477 % Society, virtually all IEEE Computer Society conferences point authors
478 % wanting to use \LaTeX\ to the old, broken \pkgname{latex8} package,
479 % which fails to honor the \ICSP's formatting guidelines. However,
480 % because of its incorrectness, \pkgname{latex8} actually gives authors
481 % a little more space for text. \iecnf\ therefore provides a |latex8|
482 % option to give authors the extra space provided by the
483 % \pkgname{latex8} package without sacrificing compatibility with other
484 % \LaTeXe\ packages and flexibility as would using the \pkgname{latex8}
485 % package directly.
486 % \begin{macrocode}
487 \newif\if@ieee@correct@geometry@
488 \@ieee@correct@geometry@true
489 \DeclareOption{latex8}{\@ieee@correct@geometry@false}
490 % \end{macrocode}
491 % \end{macro}
492 % \end{macro}
493 % \end{macro}
494 %
495 % For simplicity, we'll derive everything from the standard |article|
496 % class but force the |10pt| and, unless overridden, |twocolumn| options.
497 % \begin{macrocode}
498 \DeclareOption*{\PassOptionsToClass{\CurrentOption}{article}}
499 \ProcessOptions\relax
500 \PassOptionsToClass{\ieee@column@spec,10pt}{article}
501 \LoadClass{article}
502 % \end{macrocode}
503 %
504 % \begin{macro}{\ieee@old@maketitle}
505 % \begin{macro}{\maketitle}
506 % The guidelines say not to paginate.
507 % \begin{macrocode}
508 \let\ieee@old@maketitle=\maketitle
509 \renewcommand{\maketitle}{%
510 \ieee@old@maketitle
511 \thispagestyle{empty}%
512 }
513 \pagestyle{empty}
514 % \end{macrocode}
515 % \end{macro}
516 % \end{macro}
517 %
518 % ``All paragraphs should be indented 1/4~inch (approximately 0.5\,cm).''
519 % \changes{v1.3}{2005/08/28}{Updated the paragraph indentation to match
520 % the new \ICSP\ specifications.}
521 % \begin{macrocode}
522 \setlength{\parindent}{0.25in}
523 % \end{macrocode}
524 %
525 %
526 % \subsection{Page layout}
527 %
528 % Define the page layout as per the following instructions:
529 %
530 % \begin{quotation}
531 % All printed material, including text, illustrations, and charts,
532 % must be kept within a print area of 6-1/2 inches (16.51\,cm) wide by
533 % 8-7/8 inches (22.51\,cm) high. Do not write or print anything
534 % outside the print area. All \emph{text} must be in a two-column
535 % format. Columns are to be 3-1/16 inches (7.85\,cm) wide, with a
536 % 3/8~inch (0.81\,cm) space between them. Text must be fully
537 % justified.
538 % \end{quotation}
539 %
540 % \noindent
541 % We set the top margin to 1~inch and let the bottom margin define
542 % itself based on the top margin and the text height as per the
543 % following instructions:
544 %
545 % \begin{quotation}
546 % The second and following pages should begin 1.0~inch (2.54\,cm) from
547 % the top edge. On all pages, the bottom margin should be
548 % \mbox{1-1/8~inches} (2.86\,cm) from the bottom edge of the page for
549 % \mbox{8.5~$\times$~11-inch} paper; for A4~paper, approximately
550 % \mbox{1-5/8~inches} (4.13\,cm) from the bottom edge of the page.
551 % \end{quotation}
552 % \changes{v1.3}{2005/08/28}{Updated the page layout to match the new
553 % \ICSP\ specifications.}
554 % \changes{v1.4}{2009/03/21}{Introduced a \texttt{latex8} class option
555 % as per Oliver Kopp's suggestion}
556 % \begin{macrocode}
557 \if@ieee@correct@geometry@
558 \RequirePackage[%
559 noheadfoot,
560 textwidth=6.5in,
561 textheight=8.875in,
562 tmargin=1in
563 ]{geometry}
564 \setlength{\columnsep}{0.375in}
565 \else
566 % \end{macrocode}
567 % The following was copied verbatim from |latex8.sty|:
568 % \begin{macrocode}
569 \setlength{\textheight}{8.875in}
570 \setlength{\textwidth}{6.875in}
571 \setlength{\columnsep}{0.3125in}
572 \setlength{\topmargin}{0in}
573 \setlength{\headheight}{0in}
574 \setlength{\headsep}{0in}
575 \setlength{\parindent}{1pc}
576 \setlength{\oddsidemargin}{-.304in}
577 \setlength{\evensidemargin}{-.304in}
578 \fi
579 % \end{macrocode}
580 %
581 %
582 % \subsection{Font selection}
583 %
584 % The guidelines specify Times (or similar) as the default font and
585 % Helvetica as the sans-serif font. While we're at it, we specify
586 % Courier as the fixed-width font.
587 % \indexpkgname{mathptmx}\indexpkgname{helvet}\indexpkgname{courier}
588 % \begin{macrocode}
589 \RequirePackage{mathptmx}
590 \RequirePackage{helvet}
591 \RequirePackage{courier}
592 % \end{macrocode}
593 %
594 % Next, we define commands to set the fonts we'll need later in this
595 % file.
596 %
597 % \begin{macro}{\ieee@times@xiv@bold}
598 % Set Times 14\,pt.\ bold.
599 % \begin{macrocode}
600 \newcommand{\ieee@times@xiv@bold}{%
601 \rmfamily\bfseries\upshape\fontsize{14}{16}\selectfont}
602 % \end{macrocode}
603 % \end{macro}
604 %
605 % \begin{macro}{\ieee@times@xii@bold}
606 % Set Times 12\,pt.\ bold.
607 % \begin{macrocode}
608 \newcommand{\ieee@times@xii@bold}{%
609 \rmfamily\bfseries\upshape\fontsize{12}{14}\selectfont}
610 % \end{macrocode}
611 % \end{macro}
612 %
613 % \begin{macro}{\ieee@times@xi@bold}
614 % Set Times 11\,pt.\ bold.
615 % \begin{macrocode}
616 \newcommand{\ieee@times@xi@bold}{%
617 \rmfamily\bfseries\upshape\fontsize{11}{13}\selectfont}
618 % \end{macrocode}
619 % \end{macro}
620 %
621 % \begin{macro}{\ieee@times@x@bold}
622 % Set Times 10\,pt.\ bold.
623 % \begin{macrocode}
624 \newcommand{\ieee@times@x@bold}{%
625 \rmfamily\bfseries\upshape\fontsize{10}{12}\selectfont}
626 % \end{macrocode}
627 % \end{macro}
628 %
629 % \begin{macro}{\ieee@times@xii@roman}
630 % Set Times 12\,pt.\ roman.
631 % \begin{macrocode}
632 \newcommand{\ieee@times@xii@roman}{%
633 \rmfamily\mdseries\upshape\fontsize{12}{14}\selectfont}
634 % \end{macrocode}
635 % \end{macro}
636 %
637 % \begin{macro}{\ieee@times@xii@italic}
638 % Set Times 12\,pt.\ italic.
639 % \begin{macrocode}
640 \newcommand{\ieee@times@xii@italic}{%
641 \rmfamily\mdseries\itshape\fontsize{12}{14}\selectfont}
642 % \end{macrocode}
643 % \end{macro}
644 %
645 % \begin{macro}{\ieee@times@ix@roman}
646 % Set Times 9\,pt.\ roman.
647 % \begin{macrocode}
648 \newcommand{\ieee@times@ix@roman}{%
649 \rmfamily\mdseries\upshape\fontsize{9}{11}\selectfont}
650 % \end{macrocode}
651 % \end{macro}
652 %
653 % \begin{macro}{\ieee@helv@ix@roman}
654 % Set Helvetica 9\,pt.\ roman.
655 % \begin{macrocode}
656 \newcommand{\ieee@helv@ix@roman}{%
657 \sffamily\mdseries\upshape\fontsize{9}{11}\selectfont}
658 % \end{macrocode}
659 % \end{macro}
660 %
661 % \begin{macro}{\ieee@helv@x@bold}
662 % Set Helvetica 10\,pt.\ bold.
663 % \changes{v1.1}{2005/02/12}{Converted figure/table captions from roman
664 % to boldface. Thanks to Thomas J. Hacker for pointing out the
665 % formatting violation.}
666 % \begin{macrocode}
667 \newcommand{\ieee@helv@x@bold}{%
668 \sffamily\bfseries\upshape\fontsize{10}{12}\selectfont}
669 % \end{macrocode}
670 % \end{macro}
671 %
672 % \subsection{Title formatting}
673 %
674 % We use the \pkgname{array} package to help center the text within
675 % |tabular| ``|p|'' columns.
676 % \begin{macrocode}
677 \RequirePackage{array}
678 % \end{macrocode}
679 %
680 % \begin{macro}{\ieee@author@width}
681 % |\@maketitle| sets this \meta{dimen} to the width of the widest author
682 % block.
683 % \begin{macrocode}
684 \newlength{\ieee@author@width}
685 % \end{macrocode}
686 % \end{macro}
687 %
688 % \begin{macro}{\and}
689 % Redefine the |\and| macro used in titles to force some blank space
690 % above each author block. (Other than the |\rule| line, this version
691 % of |\and| is identical to the one in |ltsect.dtx|.)
692 % \changes{v1.2}{2005/03/26}{Introduced this macro in order to insert
693 % blank space between author blocks.}
694 % \begin{macrocode}
695 \def\and{%
696 \end{tabular}%
697 \hskip 1em \@plus 0.17fil%
698 \rule{0pt}{1.5\baselineskip}%
699 \begin{tabular}[t]{@{}>{\centering}p{\ieee@author@width}@{}}%
700 }
701 % \end{macrocode}
702 % \end{macro}
703 %
704 % \begin{macro}{\@maketitle}
705 % The guidelines say that the ``title (on the first page) should begin
706 % 1-3/8 inches (3.49~cm) from the top edge of the page, centered, and in
707 % Times 14-point, boldface type\dots Leave two blank lines after the title.''
708 % \changes{v1.3b}{2007/01/15}{Corrected the spacing between lines of multiline
709 % titles.}
710 % \begin{macrocode}
711 \def\@maketitle{%
712 \newpage
713 \null
714 \vskip 0.375in%
715 \begin{center}%
716 \let\footnote=\thanks
717 {\ieee@times@xiv@bold\@title\par}%
718 \vskip 24pt
719 \ieee@times@xii@roman
720 % \end{macrocode}
721 % Set |\ieee@author@width| to the width of the widest author block.
722 % \changes{v1.2}{2005/03/26}{Modified to place author blocks in a more
723 % aesthetic manner. Thanks to Joey Lawrance for drawing my attention
724 % to the unusual-looking formatting used in the previous version of
725 % \iecnf.}
726 % \begin{macrocode}
727 \settowidth{\ieee@author@width}{%
728 \let\and=\crcr
729 % \end{macrocode}
730 % We temporarily let-bind both |\thanks| and |\footnote| to |\@gobble|.
731 % If we didn't, \iecnf\ would output each footnote twice: once when
732 % calculating the width of the author blocks and once when typesetting
733 % them. Note that we use |\@gobble| instead of, say, |\footnotemark|
734 % because |\@ieee@old@maketitle| (a.k.a.\ the \pkgname{article} class's
735 % |\maketitle| macro) places footnote markers within an |\rlap| so they
736 % occupy no horizontal space.
737 % \changes{v1.2a}{2005/05/20}{Fixed a bug that caused
738 % \texttt{\string\string\string\thanks} and
739 % \texttt{\string\string\string\footnote} to produce duplicate
740 % footnotes. Thanks to M. Rasit Eskicioglu for reporting the
741 % duplicate-footnote problem.}
742 % \begin{macrocode}
743 \let\thanks=\@gobble
744 \let\footnote=\@gobble
745 \begin{tabular}[t]{@{}c@{}}%
746 \@author
747 \end{tabular}%
748 }%
749 % \end{macrocode}
750 % Typeset all author blocks with columns exactly of width
751 % |\ieee@author@width|.
752 % \begin{macrocode}
753 \begin{tabular}[t]{@{}>{\hfil}p{\ieee@author@width}<{\hfil}@{}}%
754 \@author
755 \end{tabular}%
756 \end{center}%
757 % \end{macrocode}
758 % ``Author information should be followed by two 12-point blank lines.''
759 % The old, broken \pkgname{latex8} package incorrectly follows the
760 % author information with only \emph{one} 12-point blank line, so we do
761 % likewise when the |latex8| package option is specified.
762 % \changes{v1.4}{2009/03/22}{Corrected the spacing between the title block
763 % and the document text}
764 % \begin{macrocode}
765 \if@ieee@correct@geometry@
766 \vskip -\baselineskip
767 \vskip 24pt%
768 \else
769 \vspace*{0.5em}%
770 \vspace*{12pt}%
771 \fi
772 }
773 % \end{macrocode}
774 % \end{macro}
775 %
776 % \begin{environment}{affiliation}
777 % Affiliations are supposed to be in Times~12\,pt.\ italic type. We
778 % define an environment to help out with that. In \pkgname{latex8}
779 % compatibility mode we introduce an extra, unnecessary half~em of
780 % vertical space between the author name and affiliation.
781 % \begin{macrocode}
782 \newenvironment{affiliation}{%
783 \ieee@times@xii@italic
784 \if@ieee@correct@geometry@
785 \else
786 \rule[10pt]{0pt}{0.5em}%
787 \fi
788 \begin{tabular}[t]{c}%
789 }{%
790 \end{tabular}%
791 }
792 % \end{macrocode}
793 % \end{environment}
794 %
795 % \begin{macro}{email}
796 % E-mail addresses are supposed to be in Times~12\,pt.\ italic type. We
797 % define a macro to help out with that.
798 % \begin{macrocode}
799 \newcommand*{\email}[1]{%
800 {\ieee@times@xii@italic#1}}
801 % \end{macrocode}
802 % \end{macro}
803 %
804 % \subsection{Abstract}
805 %
806 % \begin{environment}{abstract}
807 % The guidelines have a lot to say about formatting abstracts:
808 %
809 % \begin{quotation}
810 % The abstract is to be in fully-justified italicized text, at the top
811 % of the left-hand column as it is here, below the author information.
812 % Use the word ``Abstract'' as the title, in 12-point Times, boldface
813 % type, centered relative to the column, initially capitalized. The
814 % abstract is to be in 10-point, single-spaced type, and up to
815 % 150~words in length. Leave two blank lines after the abstract, then
816 % begin the main text.
817 % \end{quotation}
818 %
819 % Most of the following code was taken verbatim from |classes.dtx|.
820 % \changes{v1.4}{2009/03/21}{Modified the abstract-handling code to use
821 % the same formatting in both one- and two-column mode}
822 % \changes{v1.4}{2009/04/05}{Added \texttt{\char`\\par}
823 % after the abstract title to force paragraph indentation in the
824 % first paragraph of the abstract}
825 % \begin{macrocode}
826 \if@titlepage
827 \renewenvironment{abstract}{%
828 \titlepage
829 \null\vfil
830 \@beginparpenalty\@lowpenalty
831 \begin{center}%
832 \bfseries \abstractname
833 \@endparpenalty\@M
834 \end{center}%
835 \par}%
836 {\par\vfil\null\endtitlepage}
837 \else
838 \renewenvironment{abstract}{%
839 \begin{center}%
840 \ieee@times@xii@bold \abstractname
841 \end{center}%
842 \par
843 \itshape}%
844 {\vspace*{\baselineskip}}%
845 \fi
846 % \end{macrocode}
847 % \end{environment}
848 %
849 %
850 % \subsection{Figures and tables}
851 %
852 % Format figure and table captions as follows:
853 %
854 % \begin{quotation}
855 % Figure and table captions should be 10-point Helvetica (or a similar
856 % sans-serif font), boldface. Callouts should be 9-point Helvetica,
857 % non-boldface. Initially capitalize only the first word of each
858 % figure caption and table title. Figures and tables must be numbered
859 % separately. For example: ``Figure~1. Database contexts'',
860 % ``Table~1. Input data''. Figure captions are to be below the
861 % figures. Table titles are to be centered above the tables.
862 % \end{quotation}
863 %
864 % Currently, the author is responsible for putting captions above tables
865 % and below figures. The \pkgname{topcapt} package is useful for
866 % ensuring proper spacing when captions are placed above a table.
867 %
868 % \begin{macro}{\@makecaption}
869 % Modify |\@makecaption| to typeset everything in 10 pt.\ Helvetica and
870 % to put a period instead of a colon after the figure number. See the
871 % definition of |\@makecaption| in |classes.dtx| for additional
872 % commentary.
873 % \begin{macrocode}
874 \long\def\@makecaption#1#2{%
875 \vskip\abovecaptionskip
876 \sbox\@tempboxa{\ieee@helv@x@bold #1. #2}%
877 \ifdim \wd\@tempboxa >\hsize
878 \ieee@helv@x@bold #1. #2\par
879 \else
880 \global \@minipagefalse
881 \hb@xt@\hsize{\hfil\box\@tempboxa\hfil}%
882 \fi
883 \vskip\belowcaptionskip}
884 % \end{macrocode}
885 % \end{macro}
886 %
887 % \begin{macro}{\callout}
888 % When the \ICSP\ re-typesets a document they supposedly want the ``See
889 % Figure'' and ``See Table'' callouts to stand out to help the
890 % typesetter ensure that figures and tables are placed as close as
891 % possible to their callouts. The |\callout| macro simply typesets its
892 % argument in 9-point Helvetica as per the \ICSP\ guidelines.
893 % \changes{v1.3}{2005/08/28}{Introduced this macro. Thanks to Ming Kin Lai
894 % for finding out what a ``callout'' is.}
895 % \begin{macrocode}
896 \DeclareRobustCommand{\callout}[1]{%
897 {\ieee@helv@ix@roman#1}%
898 }
899 % \end{macrocode}
900 % \end{macro}
901 %
902 %
903 % \subsection{Section headers}
904 %
905 % The \pkgname{titlesec} package makes it easy to modify section headers.
906 % \begin{macrocode}
907 \RequirePackage{titlesec}
908 % \end{macrocode}
909 %
910 % Format sections as follows:
911 %
912 % \begin{quotation}
913 % For example, ``1.~Introduction'', should be Times 12-point boldface,
914 % initially capitalized, flush left, with one blank line before, and
915 % one blank line after. Use a period~(``.'') after the Arabic heading
916 % number, not a colon.
917 % \end{quotation}
918 %
919 % \begin{macrocode}
920 \titleformat{\section}{\ieee@times@xii@bold}{\thesection.}{0.5em}%
921 {}\relax
922 \titlespacing{\section}{0pt}{12pt}{12pt}
923 % \end{macrocode}
924 %
925 % Format subsections as follows:
926 %
927 % \begin{quotation}
928 % As in this heading, they should be Times 11-point boldface, initially
929 % capitalized, flush left, with one blank line before, and one after.
930 % \end{quotation}
931 %
932 % \begin{macrocode}
933 \titleformat{\subsection}{\ieee@times@xi@bold}{\thesubsection.}%
934 {0.5em}{}\relax
935 \titlespacing{\subsection}{0pt}{11pt}{11pt}
936 % \end{macrocode}
937 %
938 % Format subsubsections as follows:
939 %
940 % \begin{quotation}
941 % Third-order headings, as in this paragraph, are discouraged. However,
942 % if you must use them, use 10-point Times, boldface, initially
943 % capitalized, flush left, preceded by one blank line, followed by a
944 % period and your text on the same line.
945 % \end{quotation}
946 %
947 % \changes{v1.0b}{2004/10/10}{Corrected a formatting problem with
948 % \texttt{\string\string\string\subsubsection} identified by
949 % Ben Ochoa.}
950 %
951 % \begin{macrocode}
952 \titleformat{\subsubsection}[runin]{\ieee@times@x@bold}%
953 {\thesubsubsection.}{0.5em}{}[.]
954 \titlespacing{\subsubsection}{0pt}{10pt}{0.5em}
955 % \end{macrocode}
956 %
957 % \subsection{References}
958 %
959 % \begin{environment}{thebibliography}
960 % In order to make \iecnf\ play nicely with the \pkgname{tocbibind}
961 % package we need to separate the code that outputs the word
962 % ``References'' (or whatever |\refname| is defined as) from the code
963 % that typesets the bibliography in a list. Hence, our
964 % |thebibliography| definition is rather short.
965 % \begin{macrocode}
966 \renewenvironment{thebibliography}[1]{%
967 \section*{\refname}%
968 \@mkboth{\MakeUppercase\refname}{\MakeUppercase\refname}%
969 \begin{ieee@thebibitemlist}{#1}%
970 }{%
971 \end{ieee@thebibitemlist}%
972 }
973 % \end{macrocode}
974 % \end{environment}
975 %
976 % \begin{environment}{ieee@thebibitemlist}
977 % The IEEE guidelines provide very little guidance when it comes to
978 % formatting a bibliography. All they insist upon is that it be typeset
979 % in 9\,pt.\ Times and use square brackets. The following is almost
980 % identical to the definition of |thebibliography| in |classes.dtx| but
981 % sets the appropriate font size and---as a courtesy to authors
982 % struggling to meet page-length requirements---eliminates blank lines
983 % between entries. The user can reinstate blank lines by redefining the
984 % |\extrareflistcode| hook.
985 % \begin{macrocode}
986 \newenvironment{ieee@thebibitemlist}[1]
987 {\list{\@biblabel{\@arabic\c@enumiv}}%
988 {\ieee@times@ix@roman
989 \setlength{\itemsep}{0pt}%
990 \setlength{\parsep}{0pt}%
991 \settowidth\labelwidth{\@biblabel{#1}}%
992 \leftmargin\labelwidth
993 \advance\leftmargin\labelsep
994 \@openbib@code
995 \usecounter{enumiv}%
996 \let\p@enumiv\@empty
997 \renewcommand\theenumiv{\@arabic\c@enumiv}%
998 \extrareflistcode}%
999 \sloppy
1000 \clubpenalty4000
1001 \@clubpenalty \clubpenalty
1002 \widowpenalty4000%
1003 \sfcode`\.\@m}
1004 {\def\@noitemerr
1005 {\@latex@warning{Empty `thebibliography' environment}}%
1006 \endlist}
1007 % \end{macrocode}
1008 % \end{environment}
1009 %
1010 % At the beginning of the document, after the author has finished
1011 % loading packages, we check to see if the \pkgname{tocbibind} package
1012 % was loaded. If it was, we replace its |thebibitemlist| environment
1013 % with our |ieee@thebibitemlist| environment.
1014 % \begin{macrocode}
1015 \AtBeginDocument{%
1016 \@ifpackageloaded{tocbibind}{%
1017 \let\thebibitemlist=\ieee@thebibitemlist
1018 \let\endthebibitemlist=\endieee@thebibitemlist
1019 }%
1020 {}%
1021 }
1022 % \end{macrocode}
1023 %
1024 % \begin{macro}{\ieee@pre@bibitem@key}
1025 % \begin{macro}{\ieee@pre@bibitem@cmd}
1026 % The commands defined by the user in |\ieee@pre@bibitem@cmd| are
1027 % executed before \iecnf\ typesets a bibliographic entry with key
1028 % |\ieee@pre@bibitem@key|.
1029 % \begin{macrocode}
1030 \newcommand{\ieee@pre@bibitem@key}{IEEEconf}
1031 \newcommand{\ieee@pre@bibitem@cmd}{}
1032 % \end{macrocode}
1033 % \end{macro}
1034 % \end{macro}
1035 %
1036 % \begin{macro}{\dobeforekey}
1037 % Store a command to execute before a given bibliography key.
1038 % \changes{v1.3}{2005/05/28}{Introduced this macro.}
1039 % \begin{macrocode}
1040 \newcommand{\dobeforekey}[2]{%
1041 \def\ieee@pre@bibitem@key{#1}%
1042 \def\ieee@pre@bibitem@cmd{#2}%
1043 }
1044 % \end{macrocode}
1045 % \end{macro}
1046 %
1047 % \begin{macro}{\ieee@old@bibitem}
1048 % \begin{macro}{\bibitem}
1049 % Redefine |\bibitem| to insert |\ieee@pre@bibitem@cmd| before a
1050 % citation or reference label designated by the user.
1051 % \begin{macrocode}
1052 \let\ieee@old@bibitem=\bibitem
1053 \renewcommand{\bibitem}[2][]{%
1054 \def\ieee@biblabel{#1}%
1055 \def\ieee@bibkey{#2}%
1056 \ifx\ieee@bibkey\ieee@pre@bibitem@key
1057 \ieee@pre@bibitem@cmd
1058 \fi
1059 \ifx\ieee@biblabel\@empty
1060 \def\next{\ieee@old@bibitem{#2}}%
1061 \else
1062 \def\next{\ieee@old@bibitem[#1]{#2}}%
1063 \fi
1064 \next
1065 }
1066 % \end{macrocode}
1067 % \end{macro}
1068 % \end{macro}
1069 %
1070 % \begin{macro}{\extrareflistcode}
1071 % Provide a hook for the user to inject arbitrary code into the |list|
1072 % environment's spacing argument (i.e.,~the second argument to
1073 % |\begin{list}|) when producing a reference list.
1074 % \changes{v1.3a}{2005/09/03}{Introduced this macro.}
1075 % \begin{macrocode}
1076 \newcommand{\extrareflistcode}{}
1077 % \end{macrocode}
1078 % \end{macro}
1079 %
1080 %
1081 % \Finale
1082 %
1083 \endinput