LISTS

The traditional LATEX itemize, enumerate and description (IED) list environments are ill-suited for producing the style of lists used in IEEE publications. The main problem is that they do not provide the user a means for controlling the parameters of the resultant list. Furthermore, making global changes to the parameters of the underlying \list will result (often unexpectedly to a user) in the improper behavior of other commands that depend on it, such as \quote. Finally, LATEX’s \list considers the left margin of the list text to be the reference point that determines how the list is positioned relative to the left margin of the main text:

\labelwidth︷ ︸︸ ︷ Label

Don't use plagiarized sources. Get Your Custom Essay on
LISTS
Just from $13/Page
Order Essay

\labelsep︷ ︸︸ ︷ ︸ ︷︷ ︸

\leftmargin

List Text

This contrasts with IEEE lists which use the label box as the reference point for the list structure. i.e., for a given circumstance, the list labels will be indented by a certain amount, the list text block will be indented from the label boxes by a given amount and these spacings will determine the position of the list text.

For these reasons, IEEEtran provides enhanced IED list environments that make it much easier to produce IEEE style lists. The underlying \list remains the same as in traditional LATEX so as not to break code that depends upon it. IEEEtran uses a new length variable, \IEEElabelindent, so that users can specify IED list structures directly in IEEE fashion:

︸ ︷︷ ︸ \IEEElabelindent

\labelwidth︷ ︸︸ ︷ Label

\labelsep︷ ︸︸ ︷ List Text

The IEEEtran IED lists ignore all “external” changes to the list length parameters. Instead, IED lists are controlled exclusively via two interfaces:

1) “global” control via the \IEEEiedlistdecl command; and

2) “local” control via an optional argument that can be provided to \itemize, \enumerate, and \descrip tion.

For example, declaring

\renewcommand{\IEEEiedlistdecl}{\settowidth{\labelwi dth}{Hello}}

in an IEEEtran document will set the default width of the label boxes in all later IED lists to be equal to the width of “Hello”. Note: Because setting a \labelwidth is so commonly performed, IEEEtran provides a command: \IEEE setlabelwidth{X} which is a shorter form of: \settowid th{\labelwidth}{X}.

The local control is used if the parameters are to apply only to an individual IED list:

\begin{itemize}[\IEEEsetlabelwidth{$\gamma$}]

Within an IED list, the local control is executed just after the global control and therefore, the commands in the local control can both augment and countermand those in the global control. Please note that the code in the local and global controls are executed in the same manner as normal LATEX code. Therefore, the user should ensure that unwanted blank spaces do not appear in the controls. If a control definition is too long to fit on one line, shield the end of lines with “%” to prevent them from being interpreted as blanks (Section IV-B1 has some information on this topic). Also, note that the LATEX parser requires that braces be placed around commands with optional arguments that are placed directly within the optional arguments of other commands:

\begin{itemize}[{\mycmd[1]{example}}]

This IEEEtran IED implementation makes it easy to control IED lists, even when they are deeply nested.

The default spacings the IED lists use are stored in various length (not macro) commands. Changes to these “master” defaults are rarely needed and should be done only at the beginning of the document, not in the IED list controls. These constants will now be briefly explained. \IEEEilabelindent: This length is the default amount

the itemized list label boxes are indented from the left margin. IEEE seems to use at least two different values. For example, in the IEEE/OSA JOURNAL OF LIGHTWAVE TECHNOLOGY and the IEEE JOURNAL ON SELECTED AREAS IN COMMU- NICATIONS, they tend to use an indention equal to \parinde nt, while for IEEE TRANSACTIONS ON COMMUNICATIONS they tend to indent itemized lists a little more (1.3\parind

 

 

SHELL: HOW TO USE THE IEEETRAN LATEX CLASS 13

ent). The shorter length is stored as \IEEEilabelindentA and the longer as \IEEEilabelindentB. The default is to use the shorter version. To use the longer version do a \setlength{\IEEEilabelindent}{\IEEEilabelindentB}

at the beginning of the document. \IEEEelabelindent: This length is the default amount

the enumerated list label boxes are indented from the left margin. Normally, the same as \parindent. \IEEEdlabelindent: Ditto for description list labels. Nor-

mally, the same as \parindent. \IEEEiednormlabelsep: This length is the normal de-

fault spacing between the IED list label boxes and the list text. \IEEEiedmathlabelsep: For nomenclature description

lists (a list of math symbols and their explanations), IEEE usually increases the separation between the terms and the definitions. This length is set to the longer than normal length. To invoke its use, just issue the command \IEEEusemathla belsep in a list control. \IEEEiedtopsep: This length is the extra vertical separa-

tion put above and below each IED list. IEEE usually puts a little extra spacing around each list. However, this extra spacing is barely noticeable. \IEEElabelindentfactori through \IEEElabelinden

tfactorvi: These contain the factors by which the effective \IEEElabelindent is reduced as the list nesting depth increases. IEEE normally decreases the amount of indention as the list nesting level increases because there isn’t much room to indent with two column text. IEEEtran has an “automatic indention cut-back” feature that provides this behavior. The actual amount the label boxes will be indented is \IEEEla belindent multiplied by the \IEEElabelindentfactorX corresponding to the level of nesting depth (where “X” is the nesting depth in roman numerals). This provides a means by which the user can alter the effective \IEEElabelindent for deeper levels. There may not be such a thing as correct “standard IEEE” values. What IEEE actually does may depend on the specific circumstances. The first list level almost always has full indention. The second levels usually have only 75% of the normal indentation. Third level and greater nestings are very rare, and probably don’t use any indentation. These factors are not lengths, but rather constant macros like \bas elinestretch so \renewcommand should be used if they need to be changed. The default values are \IEEElabelindentfactori 1.0 \IEEElabelindentfactorii 0.75 \IEEElabelindentfactoriii 0.0 \IEEElabelindentfactoriv 0.0 \IEEElabelindentfactorv 0.0 \IEEElabelindentfactorvi 0.0

The use of these factors in IED lists may be suspended by issuing the command \IEEEnolabelindentfactortrue in a list control (which has the same effect as setting all the indent factors to 1.0).

Normally, IEEEtran automatically calculates \leftmargin based upon the current values of \IEEElabelindent, \labe lwidth and \labelsep. To stop this auto-calculation so that a manually specified value of \leftmargin is used instead,

just use \IEEEnocalcleftmargintrue in a list control. This feature should not be needed during the course of normal IEEE related work.

IEEEtran provides a means to manually specify the justifica- tion within the IED list label boxes. The commands \IEEEied labeljustifyl, \IEEEiedlabeljustifyc and \IEEEied labeljustifyr can be used in a list control to justify the list labels to the left, center, and right sides, respectively. Itemize and enumerate lists automatically default to right justification, while description defaults to left justification. The justification commands should not be needed during the course of normal IEEE related work.

In addition to modifying the behavior of itemize, enumer ate and description, IEEEtran also provides the respective aliases IEEEitemize, IEEEenumerate and IEEEdescript ion, which provides a way for the user to access the IEEE style list environments even in the event another package is loaded that overrides the IED list environments. For special- ized applications, the original LATEX IED list environments are retained as LaTeXitemize, LaTeXenumerate and LaTeXde scription.

ORDER NOW »»

and taste our undisputed quality.