Signal Processing Society
Electronic Publication Experiment





Table Of Contents

E-Pub Main Page

Submission Info

Reviewer Info

Author Info

Examples

Links

Project Documentation

Daily Work Log

Personnel

E-Publishing Documentation for the Authors

by Douglas Bortzfield and Laura Balzano

Last edited June 21, 1999


Table of Contents

  1. Introduction

  2. How to use ieee.cls

  3. TeX Color

  4. TeX Hyperlinks

  5. Downloadable Signals and Software

  6. Word Hyperlinks

  7. Acrobat Reader


Introduction


This page will hopefully provide all of the information necessary for the smooth creation of articles by the authors. We have provided the basic information on each of the following topics: the use of ieee.cls, the use of color in .tex documents, and how to support links in both .tex and word. There are links to complete documentation where available, as well as links to download files where applicable. If there are any further questions, or any other information which you would like for us to provide, please let us know.

top

How to Use ieee.cls


Usage:
\documentclass[main-mode,sub-mode,misc-options]{ieee}
\usepackage{your own packages}
\begin{document}
\bibliographystyle{IEEEbib}
\title[short]{regular}
\author[short]{full}
\maketitle
\begin{abstract}...\end{abstract}
\begin{keywords}...\end{keywords}
\section{...}
\PARstart ... or \PARstartCal ...
...
\begin{biography}[picname.ps]{Author's name}...\end{biography}
\end{document}

The document class options are:

main-mode:
One of the following is required. (draft is the default)
draft: Double-spaced, single column with date/time stamp.
submission: Double-spaced, suitable for submission for review.
compressed: Same as "submission", only single spaced.
final: Double-column, for assessing page-length and format of final version.
sub-mode:
techreport: This can modify "final" to produce a two-col technical report.
internal: This can modify "submission", "compressed" or "final". It changes the header to notify the reader that this is a version of the manuscript to be used for internal review processes only, and not to be distributed.
submitted: This can modify "compressed" or "final". It changes the header to notify the reader that this is a preprint and not to be distributed.
inpress: This can modify "compressed" or "final". It changes the header to notify the reader that this paper has been accepted for publishing, but it is not yet to be distributed.
reprint: This can modify "final". It changes the header to notify the reader where the paper is reprinted from.
misc-options:
narroweqnarray: Changes the spacing around the "=" sign in equation arrays to make it the same as in displayed math.
inline: Compresses the horizontal spacing of inline math equations.
notitlepage: No separate title page. (default)
titlepage: Separate title page.
anonymous: Omit all author information from main part of paper. Author info only prints on titlepage.
9pt,10pt,11pt,12pt: Choose the appropriate type size. You should not need to do this as the "correct" size is automatically chosen. However, if you want, you may use these to change the type size of the main text. "9pt" is a bit of a hack to retain backward-compatibility.
invited: If the paper is an "invited" paper, then this option prints "(Invited Paper)" under the authors' names.
For regular IEEE submissions, define the journal name as:
\journal{IEEE Trans. Signal Processing}

To specify the conference place and date:
\confplacedate{Ottawa, Canada, May 19--21, 1997}

Before \maketitle, define:
\title{Title of paper}
\author{Author1\member{Fellow}\authorinfo{Department of Electrical Engineering\\ Some University, Somewhere, CA 94305 USA} \and Author2\member{Senior Member}\authorinfo{Deptartment of Measurement and Instrument Eng., Another University, ...}}

Note, the contents of \authorinfo tends to vary depending on if it is a conference or journal paper. The amount of manual changes are small, and must be done by a human anyway. The example given is for an IMTC conference.

See also IEEEbib.bst and ieeefig.sty
Also very useful for document preparation is the style file "endfloat", available on all CTAN TeX archives.

Get ieee.cls

click here to download ieee.cls

top


Color in TeX

From "The color package" by D. P. Carlisle, version 1.0f, last revised 9/9/1997.


This package implements LaTeX support for color, for those dvi drivers that can produce colored text.

Options
1 <*package>

First we save the catcodes of some characters, and set them to fixed values whilst this file is being read.

2 \edef\Gin@codes{%
3  \catcode`\noexpand\^^A\the\catcode`\^^A\relax
4  \catcode`\noexpand\"\the\catcode`\"\relax
5  \catcode`\noexpand\*\the\catcode`\*\relax
6  \catcode`\noexpand\!\the\catcode`\!\relax
7  \catcode`\noexpand\:\the\catcode`\:\relax}
8 \catcode`\^^A=\catcode`\%
9 \catcode`\"=12
10 \catcode`\*=11
11 \catcode`\!=12
12 \catcode`\:=12

\Gin@driver Initialize the macro to hold the driver file name.

13 \providecommand\Gin@driver{}

\c@lor@error Helper macro for error handling (redefined by the monochrome option to make errors warnings).

14 \def\c@lor@error#1{%
15  \@latex@error{Undefined color #1}\@ehd}

\ds@monochrome The monochrome option should be used in addition to one of the standard driver options.

16 \DeclareOption{monochrome}{%
17  \def\c@lor@error#1{\PackageInfo{color}{Undefined color #1}}%
18  \AtEndOfPackage{%
19   \colors@false
20   \def\set@color{%
21    \c@lor@special\m@ne
22     {color push \current@color}\aftergroup\reset@color}%
23   \def\reset@color{\c@lor@special\m@ne{color pop}}%
24   \def\set@page@color{%
25    \c@lor@special\m@ne{background \current@color}}%
26   \def\define@color#1#2{%
27    \c@lor@special\m@ne{define #1 #2}}}}

\ds@debugshow The debugshow option turns on debugging info (perhaps).

28 \DeclareOption{debugshow}{\catcode`\^^A=9 \let\Gdebug\typeout}

\ds@usenames The usenames option modifies the behavior of \DefineNamedColor so that it declares the same name as a "user's color" for use in a \colorcommand, as well as a name in the named color model. The normal behavior is just to declare the name in the named color model.

55 \let\c@lor@usename\@gobble
56 \DeclareOption{usenames}{%
57  \def\c@lor@usename#1{%
58   \expandafter\color@named\csname\string\color @#1/endcsname {#1}}}

Using colors
Declarative Form
\color \color{declared-color} switches to the color declared-color, which must previously have been defined using \definecolor. This color will stay in effect until the end of the current TeX group.

\color[model]{color-specification} is similar to above, but uses a color not declared by \definecolor. The allowed models vary depending on the driver. The syntax of the color-specification argument depends on the model.

59 \DeclareRobustCommand\color{%
60  \@ifnextchar{\@undeclaredcolor\@declaredcolor}

\@undeclaredcolor Call the driver-dependent command \color@<model> to define\current@color, then call \set@color to change the current color accordingly.

61 \def\@undeclaredcolor[#1]#2{%
62  \@ifundefined{color@#1}%
63   {\c@lor@error{model `#1'}}%
64   {\expandafter\let\expandafter\current@color
71    \csname\string\color @#1\endcsname
72    \set@color}%
73  \ignorespaces}

Command (Argument) Form
\textcolor \textcolor{declare-color}{text} and \textcolor[model]{color-spec}{text} are just alternative syntax for \color, in which the groups are added implicitly. Thus text appears in the specified color, but then the color reverts to its previous value. The naming is by analogy with \textrm(as opposed to \rm and \rmfamily) although it is slightly a misnomer as the command also works in math-mode.
Since December 95, in fact this command has one other difference from \color. It calls \leavemode to ensure the start of horizontal mode. Specifically this means that a construction such as
xxx\parbox[t]{1cm}{\textcolor{red}{a}.....
now works as expected, with the xxx and the red a lining up correctly.

74 \def\textcolor#1#{\@textcolor{#1}}
75 \def\@textcolor#1#2#3{\protect\leavemode{\color#1{#2}#3}}

Defining Colors
\definecolor \definecolor{name}{model}{color-spec} defines the color name, which may then be used in subsequent \color or \textcolor commands to refer to a color specified by color-spec in the color model model.
\definecolor associates the name to a color in model. So \color{name} would check name then issue a \special for the color model model.

\definecolor just calls an internal macro that defines the color for a particular model. This macro must have been defined by the driver file that supports the requested model.

81 \def\definecolor#1#2#3{%
82  \@ifundefined{color@#2}%
83   {\c@lor@error{model `#2'}}%
84   {\@ifundefined{\string\color @#1}{}%
85    {\PackageInfo{color}{Redefining color #1}}%
86   \csname color@#2\expandafter\endcsname
87     \csname\string\color @#1\endcsname{#3}}}

\DefineNamedColor Driver files may opt to define a `named' color model. Placing color names rather than numeric specifications into the dvi file has certain advantages, in that post processing software can tune the color specifications to the particular technology being used, and more easily make color separations for that color. The disadvantage is that the driver must `know' the color names.
The `color1' drivers (dvips) currently ignore the specification of the color, and once a name is defined, just put the color name in the dvi file. For dvips, the header file color.pro is used to give the cmyk equivalents of the names.
The `color2' drivers (textures) use a special postscript operator that takes both the name and the cmyk equivalent. So if the names are not being used, fall back definitions in the cmyk model are available. These drivers also allow a numeric value to affect the `density' of the color to use.
Drivers based on `color3' do not support named colors at the dvi level, but to ease document portability, the named model is still defined, but the \specials just put the color specifications, not the names, into the dvi file.
Normally after a color, say JungleGreen, has been de3clared with:
\DefineNamedColor{named}{JungleGreen}{cmyk}{1,2,3,4}
it is available in the `named' color model, for instance by
\color[named]{JungleGreen}
A user may give a more convenient name, using
\definecolor{mygreen}{named}{JungleGreen}
If however you are happy with the original names, and want to use them directly, as in \color{JungleGreen} without specifying [named] all the time, just give the package option usenames, which will redefine \DefineNamedColor, so that the color name is declared as a user-color as well as a name in the `named' model.

88 \def\DefineNamedColor#1#2#3#4{%
89  \@ifundefined{define@color@#1}%
90   {\c@lor@error{model `#1'}}%
91   {\@ifundefined{color@#3}%
92    {\c@lor@error{model `#3'}}%
93    {\@ifundefined{c@lor@#1@#2}{}%
94     {\PackageInfo{color}{Redefining color #2 in named color model}}%
95    \csname color@#3\endcsname\@tempa{#4}%
96    \csname define@color@#1\endcsname{#2}\@tempa
97    \c@lor@usename{#2}}}}
98 \@onlypreamble\DefineNamedColor



Get package{color}

click here to download LaTeX's color package.

top


Hyperlinks in TeX

Click here for "HyperTeX FAQ" by Los Alamos National Labs.

Click here for a more extensive Hyperref manual by TeX users group.

HyperTeX is a standard used in order to include hyperlinks in TeX documents. Hyperlinks include clickable links from one part of the document to another, from a part of the document to a www page, or from a part of the document to another file (be it a matlab file or a wave file or a graphics file or whatever; be creative).

The package hyperref is a LaTeX2e package that provides for constructing hyperlinks in LaTeX documents, and will automatically construct internal links for all the '\cite' and '\ref' commands that LaTeX users use to cite sources and refer to figures. It is avaiable at any CTAN mirror in the directory 'macros/latex2e/contrib/supported/hyperref/'. By including '\usepackage{hyperref}' at the beginning of your document you will be able to take advantage of all it has to offer.

Using hyperref To link to an email address:

\href{mailto:you@yourhost.blah}{linkingtext}

for example:

\href{mailto:sunbeam@rice.edu}{Email Laura}

To link to a file:
\href{file:///path/to/the.file}{linkingtext}

for example:

\href{file:///home/usr/sounds/mywav.wav}{my speech}

To link to a URL:
\href{http://www.the.url.blah}{linkingtext}

for example:

\href{http://www.rice.edu/}{Rice University}

As stated above, internal links are taken care of with the '\cite' and '\ref' commands.

In addition, HyperTeX adds new '\special' commands to deal with hyperlinks. They resemble html. Using these, you can put links directly into your document without using a package, but the package is recommended.

Note: My explanations are fairly conjectural. I haven't tried it; I have only seen hyperlinks work using hyperref. But I think I am basically correct because these commands are supposed to work much like html.

The first and third are used together around the linking text to link to the document located at "hrefstring." For example,
\special{html:<a href="http://www.rice.edu/">}{Rice University}\speical{html:</a>}
would link the text Rice University to its URL.
The second and third are used together to name the current anchor text, so that it can later be referred to (with href) as that name. For example, if I were to use it as follows:
\speical{html:<a name="OneTruth">}{Laura is a genius}\special{</a>}
Every time I later referred something to it:
\special{html:<a href = "OneTruth">}{2+2=4}\special{html:</a>}
it would send me to anchoring text "Laura is a genius."

Using the fourth command will insert the image stored at location "hrefstring."

Finally, using the fifth command allows you to link documents relative to each other. This way if you are linking to a document with the same base path, all you have to do is use this command and the "hrefstring" will simply be the different ending to the path.

Get package{hyperref}

click here to download LaTeX's hyperlinks package, hyperref.

top


Downloadable Signals and Software

To include downloadable signals and software in your articles, all you need to do is include in your paper a file link to the file you want to attach. See the parts of hypertex that deal with this for the LaTeX way to include these links.

Make sure that your files are platform independent, .wav files or .mat files for example. We have not been able to get a matlab file to load directly into matlab from the web.

When we download your article and files to our website, we will (at the very least) put them all in the same directory. We are also thinking of zipping them all into one file for easy download by the reader.

top


Hyperlinks in MS Word 97

MS Word provides an easy way for users to create hyperlinks.

For a www link: Click "insert/hyperlink" and Word will prompt you for the location. Type it in and click "OK." The linking text is by default the www address. Change this by highlighting the linking text and typing your preferred linking text.

For a link to another file on the computer: Click "insert/hyperlink" and type the path to where the file is located. If you are not sure of the path, click "Browse" to find your file. Click "OK." You can edit the linking text for these links in the same manner as for www links.

For a link inside the document: first you must 'bookmark' the object to which you want to link, for example the figure or equation. To do this, click at the beginning of the figure or equation to place the cursor there. Click "insert/bookmark." Word will prompt you for a name for your bookmark. Name it and click "OK." Then, go to the place in the document where you want to link to this bookmark. Click "insert/hyperlink." For the location, type the path to the document in which you are working. In the same window, there is an option for an internal link. Here, type the name of the bookmark, or use browse to choose from a list of bookmarks you have created in this document. Click "OK." Edit the linking text in the same manner as described above.

top

Adobe Acrobat Reader

Acrobat reader is an application which views .pdf files. You can get acrobat reader for free; Adobe has other acrobat software that is not free, like Acrobat Exchange. So be sure you are getting (as new kids on the block may have said,) the right stuff. (oh-oh-oh, the right stuff.)

To call acrobat reader from a UNIX prompt, use the command:

acroread file.blah
For help with acrobat reader, try thisAcrobat Reader Tutorial.

Get acrobat reader

Click here to go to the adobe site to download acrobat reader. Note there will be lots of advertisement for getting adobe acrobat 4.0, or whatever is the newest version. That is the entire package-- all you need is the free acrobat reader.

top


Blow By Blow


This page maintained by Laura and Doug
email us if there are any broken links.
Last updated on June 16, 1999 at 12:55 pm
Page accessed times.