Mercurial > hg > Papers > 2015 > kaito-lola

comparison tools/IEEEtrantools_doc.txt @ 0:c0d36568602d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
1st commit
author Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
date Sun, 10 May 2015 22:54:12 +0900
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:c0d36568602d
1
2 IEEEtrantools_doc.txt 2014/09/17 version 1.4
3 (Version 1.4 is based on the commands of version 1.8a of IEEEtran.cls)
4 This document is the user guide for the IEEEtrantools.sty package.
5
6 The IEEEtrantools.sty package provides several popular and unique
7 commands from the IEEEtran.cls class (version 1.8a) file.
8
9 IEEEtrantools.sty should not be used with IEEEtran.cls.
10
11 For helpful tips, answers to frequently asked questions and other support,
12 visit the IEEEtrantools support page at my website:
13
14 http://www.michaelshell.org/tex/ieeetran/tools/
15
16 The latest version and documentation of IEEEtrantools can be obtained at:
17 http://mirror.ctan.org/macros/latex/contrib/IEEEtran/
18
19 Copyright (c) 2002-2014 by Michael Shell
20 See
21 http://www.michaelshell.org/
22 for current contact information.
23
24 *************************************************************************
25 Legal Notice:
26 This code is offered as-is without any warranty either expressed or
27 implied; without even the implied warranty of MERCHANTABILITY or
28 FITNESS FOR A PARTICULAR PURPOSE!
29 User assumes all risk.
30 In no event shall IEEE or any contributor to this code be liable for
31 any damages or losses, including, but not limited to, incidental,
32 consequential, or any other damages, resulting from the use or misuse
33 of any information contained here.
34
35 All comments are the opinions of their respective authors and are not
36 necessarily endorsed by the IEEE.
37
38 This work is distributed under the LaTeX Project Public License (LPPL)
39 ( http://www.latex-project.org/ ) version 1.3, and may be freely used,
40 distributed and modified. A copy of the LPPL, version 1.3, is included
41 in the base LaTeX documentation of all distributions of LaTeX released
42 2003/12/01 or later.
43 Retain all contribution notices and credits.
44 ** Modified files should be clearly indicated as such, including **
45 ** renaming them and changing author support contact information. **
46
47 File list of work: IEEEtrantools.sty, IEEEtrantools_doc.txt, changelog.txt
48 *************************************************************************
49
50
51 Available package options e.g., \usepackage[redeflists]{IEEEtrantools}
52
53 redeflists
54 Causes IEEEtrantools to redefine the standard LaTeX itemize,
55 enumerate and description (IED) lists to their IEEE versions.
56 The default behavior is to retain the standard definitions
57 of itemize, enumerate and description. The IEEEtran versions are
58 always available as IEEEitemize, IEEEenumerate and IEEEdescription
59 and the original LaTeX versions are always available as LaTeXitemize,
60 LaTeXenumerate and LaTeXdescription.
61
62 **********************************************************************
63
64 The IEEEtrantools.sty package provides several commands from IEEEtran.cls
65 so that they can be used under other LaTeX classes. This guide covers only
66 the differences in the use (or undocumented uses) of the commands from
67 those provided by IEEEtran.cls. For complete documentation on these
68 commands, see the relevant sections in the IEEEtran_HOWTO manual which
69 is available at
70 http://www.ctan.org/tex-archive/macros/latex/contrib/IEEEtran/
71
72 IEEEtrantools.sty provides \IEEEPARstart; the \bstctlcite command for the
73 control entry types of IEEEtran.bst V1.00 and later; the IEEE IED list
74 environments; and the complete IEEEeqnarray family, including the
75 IEEEeqnarray support commands, the IEEEproof environment and
76 \IEEEauthorrefmark.
77
78 Please note that, as a package file, IEEEtrantools.sty will not attempt
79 to alter document formatting (other than if the IDE lists are redefined
80 if the redeflists option is invoked) as controlled by the class file.
81 Therefore, there may be spacing/layout differences between the results
82 of the same IEEEtran commands under IEEEtran.cls and the user's class
83 file as different fonts, default values for the various length commands,
84 etc., are used than under IEEEtran.cls.
85
86
87
88
89
90 *** \IEEEPARstart ***
91
92 \IEEEPARstart{}{} is used to provide a large initial "drop cap" letter(s) as
93 well as to capitialize the remaining letters of the first word of a chapter
94 or section (if placed within the second argument). e.g.,
95 \IEEEPARstart{O}{nce}
96
97 Unlike IEEEtran.cls, IEEEtrantools.sty provides the user with a way to
98 control the various parameters of the \IEEEPARstart letters (in IEEEtran.cls
99 these parameters are prefixed with a \@, e.g., \@IEEEPARstartDROPLINES
100 to discourage casual or accidental alteration).
101
102 Below is how the user can alter them (after the IEEEtrantools.sty package
103 is loaded). Default values are shown. IEEEtrantools will not override
104 any previous definitions of these parameters if they already exist when
105 the package is loaded.
106
107
108 % The number of lines that are indented to clear the drop cap letter.
109 % You may need to increase this beyond 1 + \IEEEPARstartDROPDEPTH if
110 % you are using lowercase letters with descenders.
111 \renewcommand{\IEEEPARstartDROPLINES}{2}
112
113 % The minimum number of lines left on a page to allow an \IEEEPARstart.
114 % Does not take into consideration glue shrink, so it tends to be overly
115 % cautious.
116 \renewcommand{\IEEEPARstartMINPAGELINES}{2}
117
118 % The height of the drop cap (*above* the baseline), is adjusted to match
119 % the height of this text in the current font (when \IEEEPARstart is called).
120 % Use a strut if you want a height not based on that of the main text font.
121 \renewcommand{\IEEEPARstartHEIGHTTEXT}{T}
122
123 % The depth the letter is lowered below the baseline. The height (and size)
124 % of the letter is determined by the sum of this value and the height of
125 % \IEEEPARstartHEIGHTTEXT in the current font. It is a good idea to set this
126 % value in terms of the baselineskip so that it can respond to changes
127 % therein.
128 \renewcommand{\IEEEPARstartDROPDEPTH}{1.1\baselineskip}
129
130 % The font the drop cap will be rendered in. The argument is a command that
131 % can take zero or one argument.
132 \renewcommand{\IEEEPARstartFONTSTYLE}{\bfseries}
133
134 % Any additional, non-font related commands needed to modify the drop cap
135 % letter, can take zero or one argument.
136 \renewcommand{\IEEEPARstartCAPSTYLE}{\MakeUppercase}
137
138 % The font that will be used to render the rest of the word (second argument
139 % to \IEEEPARstart), can take zero or one argument.
140 \renewcommand{\IEEEPARstartWORDFONTSTYLE}{\relax}
141
142 % Any additional, non-font related commands needed to modify the rest of the
143 % word (second argument to \IEEEPARstart), can take zero or one argument.
144 \renewcommand{\IEEEPARstartWORDCAPSTYLE}{\MakeUppercase}
145
146 % The horizontal separation distance from the drop letter to the main text.
147 % Lengths that depend on the font (i.e., ex, em, etc.) will be referenced to
148 % the font that is active when \IEEEPARstart is called.
149 \renewcommand{\IEEEPARstartSEP}{0.15em}
150
151 % The Horizontal offset applied to the left of the drop cap. The drop cap
152 % can be shifted left (negative) or right (positive) using this parameter.
153 % Lengths that depend on the font (e.g., ex, em, etc.) will be referenced
154 % to the font that is active when \IEEEPARstart is called.
155 \renewcommand{\IEEEPARstartHOFFSET}{0em}
156
157 For \IEEEPARstartSEP and \IEEEPARstartHOFFSET, you can also reference the
158 length variable, \IEEEPARstartletwidth, which will be set to the width of
159 the drop drop before it is rendered. e.g.,
160 \renewcommand{\IEEEPARstartHOFFSET}{-0.5\IEEEPARstartletwidth}
161 will cause the drop cap to be shifted leftward by half its width.
162
163 % Italic correction command applied at the end of the drop cap when
164 % evaluating its width. Without this, italic or slanted drop cap letters will
165 % "crash into" the main text because their full true width is not taken into
166 % consideration.
167 \renewcommand{\IEEEPARstartITLCORRECT}{\/}
168
169
170
171
172
173 *** \bstctlcite ***
174
175 \bstctlcite{} is used to issue a citation for a special IEEEtran.bst BibTeX
176 style control entry which can control various operating parameters of the
177 IEEEtran.bst file (V1.00 and later):
178
179 \bstctlcite{IEEEexample:BSTcontrol}
180
181 V1.2 and later of IEEEtrantools.sty provides for an optional argument so
182 that different auxiliary file specifiers may be used in documents with
183 multiple bibliographies:
184
185 \bstctlcite[@auxoutsec]{IEEEexample:BSTcontrol}
186
187 See the IEEEtran.bst documentation for details:
188 http://www.ctan.org/tex-archive/macros/latex/contrib/IEEEtran/bibtex
189 http://www.michaelshell.org/tex/ieeetran/bibtex/
190
191 \bstctlcite operates silently and will not alter the citation numbers or
192 place a citation entry into the main text or bibliography (when used with
193 IEEEtran.bst). It should not be used with .bst files that do not provide
194 support for these special BST control entries.
195
196 See the IEEEtran.bst BibTeX style documentation for details.
197 http://www.michaelshell.org/tex/ieeetran/bibtex/
198 http://www.ctan.org/tex-archive/macros/latex/contrib/IEEEtran/bibtex
199
200
201
202
203
204 *** itemize, enumerate and description (IED) lists ***
205
206 IEEEtrantools provides the IEEEitemize, IEEEenumerate and IEEEdescription
207 list environments that offer enhanced controls and make it much easier to
208 create such lists when the main text is "block indented" from the
209 labels (IEEE style).
210
211 By default, the LaTeX IED list environments are not overridden with the
212 IEEE IED versions. To force this, load IEEEtrantools.sty with the
213 "redeflists" option:
214
215 \usepackage[redeflists]{IEEEtrantools}
216
217 In any event, the IEEE IED list environments are available as IEEEitemize,
218 IEEEenumerate, and IEEEdescription. The IEEE IED lists depend on the LaTeX
219 low-level list environment, so class files that redefine it may also alter
220 the IEEE IED list formatting. The original LaTeX IED environments (as
221 provided by the LaTeX kernel and class file) are always retained as
222 LaTeXitemize, LaTeXenumerate and LaTeXdescription.
223
224 Beware that the default enumerate label width will not be correct if
225 the class file is not using normalfont "9)" style labeled enumerated lists.
226
227 The support commands for the IEEE IED list environments (\IEEEsetlabelwidth,
228 \IEEEusemathlabelsep, \IEEEiedlabeljustifyl, etc.) are also provided.
229
230 See the section on lists in the IEEEtran_HOWTO manual for full details
231 on the IEEE style lists.
232 http://www.ctan.org/tex-archive/macros/latex/contrib/IEEEtran/
233
234
235
236 *** The IEEEeqnarray family ***
237
238 Please note that IEEEtrantools provides and sets the length variable
239 \IEEEnormaljot. At the \begin{document}, \IEEEnormaljot will be set to
240 the current value of \jot. If the user later alters the document's
241 nominal \jot, the value of \IEEEnormaljot should be revised as well.
242
243 The support commands for the IEEEeqnarray commands (\IEEEstrut,
244 \IEEEeqnarrayvrule, \IEEEvisiblestrutstrue, etc.) are also provided.
245
246 For more information on the use of the IEEEeqnarray family of commands,
247 the following sources of information are recommended:
248
249 1. The IEEEtran HOWTO manual (IEEEeqnarray is covered in the Appendices):
250 http://mirror.ctan.org/macros/latex/contrib/IEEEtran/
251
252 2. Stefan M. Moser's "How to Typeset Equations in LaTeX"
253 http://moser.cm.nctu.edu.tw/manuals.html#eqlatex
254
255 3. Tobias Oetiker's "The Not So Short Introduction to LaTeX2e"
256 http://www.ctan.org/tex-archive/info/lshort/
257
258
259
260
261 *** The IEEEproof environment ***
262
263 IEEEtrantools provides the IEEEtran IEEEproof environment as well as
264 several undocumented IEEEtran IEEEproof commands that are useful for
265 non-IEEE related work:
266
267 1. \IEEEQEDoff, when issued within an IEEEproof, turns off the
268 automatic generation of the \IEEEQED symbol at the end of
269 the proof.
270
271 2. \IEEEQEDhere emits an \IEEEQED symbol at the place it is executed
272 and turns off the \IEEEQED symbol at the end of the proof. This
273 can be useful when using IEEEeqnarray within IEEEproof
274 \begin{IEEEproof}
275 \begin{IEEEeqnarray*}{c+x*}
276 x=1. & \IEEEQEDhere
277 \end{IEEEeqnarray*}
278 \end{IEEEproof}
279 % Thanks to Stefan M. Moser for this example.
280
281 3. \IEEEQEDhereeqn is somewhat similar to the AMS \qedhere and
282 is for use with the standard equation environment within
283 IEEEproof:
284 \begin{IEEEproof}
285 \begin{equation*}
286 x=1. \IEEEQEDhereeqn
287 \end{equation*}
288 \end{IEEEproof}
289 Note that \IEEEQEDhereeqn will put the QED symbol in front
290 of an equation number if it exists.
291
292 4. \IEEEproofindentspace allows users to change the indention
293 of the proof environment from its IEEEtran default of 2\parindent:
294
295 \renewcommand{\IEEEproofindentspace}{1\parindent}
296
297 Place the above redefinition before any IEEEproof environments it is
298 to affect.
299
300
301
302
303 *** \IEEEauthorrefmark{} ***
304
305 The \IEEEauthorrefmark{} simply takes a number as an argument and generates
306 a corresponding superscript symbol. Used in IEEEtran.cls to link author
307 names to their affiliations:
308
309 Michael Shell\IEEEauthorrefmark{2}
310
311
312
313 %%%%%%%%%%%%%%%%%%%%%%%%%% End of IEEEtrantools_doc.txt %%%%%%%%%%%%%%%%%%
314 % That's all folks!
315