summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/IEEEtran/IEEEtrantools_doc.txt
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2013-01-02 22:56:16 +0000
committerKarl Berry <karl@freefriends.org>2013-01-02 22:56:16 +0000
commitf0cc716316bc05b757f8c652feab6205ac11e3f0 (patch)
tree6df995375b60faef22956479244f2932ebf53b08 /Master/texmf-dist/doc/latex/IEEEtran/IEEEtrantools_doc.txt
parent77180107ed1f272af1f1e2f03469f7dbd996b602 (diff)
IEEEtran (2jan13)
git-svn-id: svn://tug.org/texlive/trunk@28697 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/IEEEtran/IEEEtrantools_doc.txt')
-rw-r--r--Master/texmf-dist/doc/latex/IEEEtran/IEEEtrantools_doc.txt169
1 files changed, 100 insertions, 69 deletions
diff --git a/Master/texmf-dist/doc/latex/IEEEtran/IEEEtrantools_doc.txt b/Master/texmf-dist/doc/latex/IEEEtran/IEEEtrantools_doc.txt
index 5152ac7a14a..f38ec4f31e8 100644
--- a/Master/texmf-dist/doc/latex/IEEEtran/IEEEtrantools_doc.txt
+++ b/Master/texmf-dist/doc/latex/IEEEtran/IEEEtrantools_doc.txt
@@ -1,10 +1,10 @@
-IEEEtrantools_doc.txt 2007/01/11 version 1.2
-(Version 1.2 is based on the commands of version 1.7 of IEEEtran.cls)
+IEEEtrantools_doc.txt 2012/12/27 version 1.3
+(Version 1.3 is based on the commands of version 1.8 of IEEEtran.cls)
This document is the user guide for the IEEEtrantools.sty package.
The IEEEtrantools.sty package provides several popular and unique
-commands from the IEEEtran.cls class (version 1.7) file.
+commands from the IEEEtran.cls class (version 1.8) file.
IEEEtrantools.sty should not be used with IEEEtran.cls.
@@ -16,7 +16,7 @@ http://www.michaelshell.org/tex/ieeetran/tools/
The latest version and documentation of IEEEtrantools can be obtained at:
http://www.ctan.org/tex-archive/macros/latex/contrib/IEEEtran/
-Copyright (c) 2002-2007 by Michael Shell
+Copyright (c) 2002-2012 by Michael Shell
See
http://www.michaelshell.org/
for current contact information.
@@ -44,82 +44,44 @@ Retain all contribution notices and credits.
** Modified files should be clearly indicated as such, including **
** renaming them and changing author support contact information. **
-File list of work: IEEEtrantools.sty, IEEEtrantools_doc.txt
+File list of work: IEEEtrantools.sty, IEEEtrantools_doc.txt, changelog.txt
*************************************************************************
-Available package options e.g., \usepackage[retainorgcmds]{IEEEtrantools}
- retainorgcmds
- Prevents IEEEtrantools from overriding existing LaTeX commands.
- Currently, the only effect is to preserve the original definitions
+Available package options e.g., \usepackage[redeflists]{IEEEtrantools}
+
+ redeflists
+ Causes IEEEtrantools to redefine the standard LaTeX itemize,
+ enumerate and description (IED) lists to their IEEE versions.
+ The default behavior is to retain the standard definitions
of itemize, enumerate and description. The IEEEtran versions are
always available as IEEEitemize, IEEEenumerate and IEEEdescription
and the original LaTeX versions are always available as LaTeXitemize,
LaTeXenumerate and LaTeXdescription.
**********************************************************************
-1/2007 V1.2 (V1.7 of IEEEtran.cls) changes:
-
- 1. Several commands and enviroments have depreciated in favor of
- replacements with IEEE prefixes to better avoid potential future name
- clashes with other packages. Legacy code retained to allow use of the
- obsolete forms, but with an warning message to the console during
- compilation:
- \IEEEPARstart
- For IED lists:
- \IEEEiedlabeljustifyc, \IEEEiedlabeljustifyl, \IEEEiedlabeljustifyr,
- \IEEEnocalcleftmargin, \IEEElabelindent, \IEEEsetlabelwidth,
- \IEEEusemathlabelsep
-
- 2. These commands/lengths now require the IEEE prefix and do not have
- legacy support: \IEEEnormaljot.
- For IED lists: \ifIEEEnocalcleftmargin, \ifIEEEnolabelindentfactor,
- \IEEEiedlistdecl, \IEEElabelindentfactor
-
- 3. \normalsizebaselineskip no longer provided.
-
- 4. New \IEEEPARstart controls:
- \IEEEPARstartHEIGHTTEXT, \IEEEPARstartFONTSTYLE, \IEEEPARstartCAPSTYLE,
- \IEEEPARstartWORDFONTSTYLE, \IEEEPARstartWORDCAPSTYLE,
- \IEEEPARstartHOFFSET, \IEEEPARstartITLCORRECT
- and the (output) length \IEEEPARstartletwidth.
-
- 5. Provide for an optional argument to \bstctlcite to provide a way to
- specify a different aux file. Define \bstctlcite even if it has already
- been defined.
-
-
-*******
-11/2002 V1.1 (v1.6b of IEEEtran.cls) changes:
-
- 1. In addition to the IEEE IED lists, the original LaTeX IED style list
- environments are now preserved as LaTeXitemize, LaTeXenumerate, and
- LaTeXdescription. Also, users can now redefine \makelabel within
- IEEE IED list controls. There may be some use for these in specialized
- applications. Thanks to Eli Barzilay for suggesting this feature.
-
-**********************************************************************
-
-
The IEEEtrantools.sty package provides several commands from IEEEtran.cls
so that they can be used under other LaTeX classes. This guide covers only
-the differences in the use of the commands from those provided by
-IEEEtran.cls. For complete documentation on these commands, see the relevant
-sections in the IEEEtran_HOWTO manual which is available at the CTAN site.
+the differences in the use (or undocumented uses) of the commands from
+those provided by IEEEtran.cls. For complete documentation on these
+commands, see the relevant sections in the IEEEtran_HOWTO manual which
+is available at
+http://www.ctan.org/tex-archive/macros/latex/contrib/IEEEtran/
IEEEtrantools.sty provides \IEEEPARstart; the \bstctlcite command for the
control entry types of IEEEtran.bst V1.00 and later; the IEEE IED list
environments; and the complete IEEEeqnarray family, including the
-IEEEeqnarray support commands.
+IEEEeqnarray support commands, the IEEEproof environment and
+\IEEEauthorrefmark.
Please note that, as a package file, IEEEtrantools.sty will not attempt
-to alter document formatting (other than the override of the IDE lists,
-if the retainorgcmds option is not invoked) as controlled by the class
-file. Therefore, there may be spacing/layout differences between the
-results of the same IEEEtran commands under IEEEtran.cls and the user's
-class file as different fonts, default values for the various length
-commands, etc., are used than under IEEEtran.cls.
+to alter document formatting (other than if the IDE lists are redefined
+if the redeflists option is invoked) as controlled by the class file.
+Therefore, there may be spacing/layout differences between the results
+of the same IEEEtran commands under IEEEtran.cls and the user's class
+file as different fonts, default values for the various length commands,
+etc., are used than under IEEEtran.cls.
@@ -133,7 +95,9 @@ or section (if placed within the second argument). e.g.,
\IEEEPARstart{O}{nce}
Unlike IEEEtran.cls, IEEEtrantools.sty provides the user with a way to
-control the various parameters of the \IEEEPARstart letters.
+control the various parameters of the \IEEEPARstart letters (in IEEEtran.cls
+these parameters are prefixed with a \@, e.g., \@IEEEPARstartDROPLINES
+to discourage casual or accidental alteration).
Below is how the user can alter them (after the IEEEtrantools.sty package
is loaded). Default values are shown. IEEEtrantools will not override
@@ -239,16 +203,16 @@ http://www.ctan.org/tex-archive/macros/latex/contrib/IEEEtran/bibtex
*** itemize, enumerate and description (IED) lists ***
-IEEEtrantools provides revised itemize, enumerate and description list
-environments that offer enhanced controls and make it much easier to
+IEEEtrantools provides the IEEEitemize, IEEEenumerate and IEEEdescription
+list environments that offer enhanced controls and make it much easier to
create such lists when the main text is "block indented" from the
labels (IEEE style).
-By default, the LaTeX IED list environments are overridden with the IEEE
-IED versions. To prevent this, load IEEEtrantools.sty with the
-"retainorgcmds" option:
+By default, the LaTeX IED list environments are not overridden with the
+IEEE IED versions. To force this, load IEEEtrantools.sty with the
+"redeflists" option:
-\usepackage[retainorgcmds]{IEEEtrantools}
+\usepackage[redeflists]{IEEEtrantools}
In any event, the IEEE IED list environments are available as IEEEitemize,
IEEEenumerate, and IEEEdescription. The IEEE IED lists depend on the LaTeX
@@ -263,6 +227,9 @@ the class file is not using normalfont "9)" style labeled enumerated lists.
The support commands for the IEEE IED list environments (\IEEEsetlabelwidth,
\IEEEusemathlabelsep, \IEEEiedlabeljustifyl, etc.) are also provided.
+See the section on lists in the IEEEtran_HOWTO manual for full details
+on the IEEE style lists.
+http://www.ctan.org/tex-archive/macros/latex/contrib/IEEEtran/
@@ -276,6 +243,70 @@ the current value of \jot. If the user later alters the document's nominal
The support commands for the IEEEeqnarray commands (\IEEEstrut,
\IEEEeqnarrayvrule, \IEEEvisiblestrutstrue, etc.) are also provided.
+For more information on the use of the IEEEeqnarray family of commands,
+the following sources of information are recommended:
+
+ 1. The IEEEtran HOWTO manual (IEEEeqnarray is covered in the Appendices):
+ http://www.ctan.org/tex-archive/macros/latex/contrib/IEEEtran/
+
+ 2. Stephan M. Moser's "How to Typeset Equations in LaTeX"
+ http://moser.cm.nctu.edu.tw/manuals.html#eqlatex
+
+ 3. Tobias Oetiker's "The Not So Short Introduction to LaTeX2e"
+ http://www.ctan.org/tex-archive/info/lshort/
+
+
+
+
+*** The IEEEproof environment ***
+
+IEEEtrantools provides the IEEEtran IEEEproof environment as well as
+several undocumented IEEEtran IEEEproof commands that are useful for
+non-IEEE related work:
+
+ 1. \IEEEQEDoff, when issued within an IEEEproof, turns off the
+ automatic generation of the \IEEEQED symbol at the end of
+ the proof.
+
+ 2. \IEEEQEDhere emits an \IEEEQED symbol at the place it is executed
+ and turns off the \IEEEQED symbol at the end of the proof. This
+ can be useful when using IEEEeqnarray within IEEEproof
+ \begin{IEEEproof}
+ \begin{IEEEeqnarray*}{c+x*}
+ x=1. & \IEEEQEDhere
+ \end{IEEEeqnarray*}
+ \end{IEEEproof}
+ % Thanks to Stefan M. Moser for this example.
+
+ 3. \IEEEQEDhereeqn is somewhat similar to the AMS \qedhere and
+ is for use with the standard equation environment within
+ IEEEproof:
+ \begin{IEEEproof}
+ \begin{equation*}
+ x=1. \IEEEQEDhereeqn
+ \end{equation*}
+ \end{IEEEproof}
+ Note that \IEEEQEDhereeqn will put the QED symbol in front
+ of an equation number if it exists.
+
+ 4. \IEEEproofindentspace allows users to change the indention
+ of the proof environment from its IEEEtran default of 2\parindent:
+
+ \renewcommand{\IEEEproofindentspace}{1\parindent}
+
+ Place the above redefinition before any IEEEproof environments it is
+ to affect.
+
+
+
+
+*** \IEEEauthorrefmark{} ***
+
+The \IEEEauthorrefmark{} simply takes a number as an argument and generates
+a corresponding superscript symbol. Used in IEEEtran.cls to link author
+names to their affiliations:
+
+ Michael Shell\IEEEauthorrefmark{2}