summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/IEEEtran/IEEEtrantools_doc.txt
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2015-08-27 22:01:39 +0000
committerKarl Berry <karl@freefriends.org>2015-08-27 22:01:39 +0000
commit7eb5047990feee3545abafcc60bae22fad6f1927 (patch)
treeef619a5e28e7215a5ab465a7647fa301245e2097 /Master/texmf-dist/doc/latex/IEEEtran/IEEEtrantools_doc.txt
parented0cc62be17e1bf2b0a072cf59cc8d49e9c02e4a (diff)
IEEEtran (27aug15)
git-svn-id: svn://tug.org/texlive/trunk@38220 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.txt60
1 files changed, 37 insertions, 23 deletions
diff --git a/Master/texmf-dist/doc/latex/IEEEtran/IEEEtrantools_doc.txt b/Master/texmf-dist/doc/latex/IEEEtran/IEEEtrantools_doc.txt
index 9dd642f8eae..73bef64ae08 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 2014/09/17 version 1.4
-(Version 1.4 is based on the commands of version 1.8a of IEEEtran.cls)
+IEEEtrantools_doc.txt 2015/08/26 version 1.5
+(Version 1.5 is based on the commands of version 1.8b 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.8a) file.
+commands from the IEEEtran.cls class file.
IEEEtrantools.sty should not be used with IEEEtran.cls.
@@ -14,9 +14,9 @@ visit the IEEEtrantools support page at my website:
http://www.michaelshell.org/tex/ieeetran/tools/
The latest version and documentation of IEEEtrantools can be obtained at:
-http://mirror.ctan.org/macros/latex/contrib/IEEEtran/
+http://www.ctan.org/pkg/ieeetran
-Copyright (c) 2002-2014 by Michael Shell
+Copyright (c) 2002-2015 by Michael Shell
See
http://www.michaelshell.org/
for current contact information.
@@ -27,7 +27,7 @@ This code is offered as-is without any warranty either expressed or
implied; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE!
User assumes all risk.
-In no event shall IEEE or any contributor to this code be liable for
+In no event shall the IEEE or any contributor to this code be liable for
any damages or losses, including, but not limited to, incidental,
consequential, or any other damages, resulting from the use or misuse
of any information contained here.
@@ -67,13 +67,13 @@ 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/
+http://www.ctan.org/pkg/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, the IEEEproof environment and
-\IEEEauthorrefmark.
+control entry types of IEEEtran.bst V1.00 and later; \IEEEnoauxwrite;
+the IEEE IED list environments; and the complete IEEEeqnarray family,
+including the 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 if the IDE lists are redefined
@@ -94,10 +94,8 @@ well as to capitialize the remaining letters of the first word of a chapter
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 (in IEEEtran.cls
-these parameters are prefixed with a \@, e.g., \@IEEEPARstartDROPLINES
-to discourage casual or accidental alteration).
+IEEEtrantools.sty provides the user with a way to control the various
+parameters of the \IEEEPARstart letters.
Below is how the user can alter them (after the IEEEtrantools.sty package
is loaded). Default values are shown. IEEEtrantools will not override
@@ -184,10 +182,6 @@ multiple bibliographies:
\bstctlcite[@auxoutsec]{IEEEexample:BSTcontrol}
-See the IEEEtran.bst documentation for details:
-http://www.ctan.org/tex-archive/macros/latex/contrib/IEEEtran/bibtex
-http://www.michaelshell.org/tex/ieeetran/bibtex/
-
\bstctlcite operates silently and will not alter the citation numbers or
place a citation entry into the main text or bibliography (when used with
IEEEtran.bst). It should not be used with .bst files that do not provide
@@ -195,8 +189,28 @@ support for these special BST control entries.
See the IEEEtran.bst BibTeX style documentation for details.
http://www.michaelshell.org/tex/ieeetran/bibtex/
-http://www.ctan.org/tex-archive/macros/latex/contrib/IEEEtran/bibtex
+http://www.ctan.org/pkg/ieeetran
+
+
+
+
+*** \IEEEnoauxwrite ***
+
+Sometimes an author wants to cite something within \thanks or other section
+that comes early in the document, but does not want that to take the place
+of the first reference in the main text (e.g., alter the citation counter).
+Assuming the publisher's rules allow citations in footnote and/or abstract
+sections of the document, the command \IEEEnoauxwrite{} can be used:
+
+\author{... \thanks{... \IEEEnoauxwrite{\cite{myreference}}.}}
+
+to accomplish this.
+If the reference is not also cited elsewhere in the document, it will have
+to be manually inserted into the reference list of the bibliography via a
+\nocite. If the \nocite is done at the end of document, the citation will
+be last in the reference list rather than first as would normally happen
+with citations within \thanks.
@@ -229,7 +243,7 @@ The support commands for the IEEE IED list environments (\IEEEsetlabelwidth,
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/
+http://www.ctan.org/pkg/ieeetrantools
@@ -247,13 +261,13 @@ 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://mirror.ctan.org/macros/latex/contrib/IEEEtran/
+ http://www.ctan.org/pkg/ieeetrantools
2. Stefan 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/
+ http://www.ctan.org/pkg/lshort