README

   1
   2 November 21, 2012
   3
   4 IEEEtran.cls version 1.8 revises format specifications so that the final
   5 layout more closely matches the layout of the Microsoft Word templates.
   6
   7 Additionally, the IEEEtran_HOWTO.pdf now includes the notice to not use
   8 symbols, special characters, or math in the paper title and abstract.
   9
  10
  11 *******
  12
  13
  14 March 5, 2007
  15
  16
  17 IEEEtran is the official LaTeX class for authors of the Institute of
  18 Electrical and Electronics Engineers (IEEE) transactions journals and
  19 conferences. The latest version of the IEEEtran package can be found
  20 at CTAN:
  21
  22 http://www.ctan.org/tex-archive/macros/latex/contrib/IEEEtran/
  23
  24 as well as within IEEE's site:
  25
  26 http://www.ieee.org/
  27
  28 For latest news, helpful tips, answers to frequently asked questions,
  29 beta releases and other support, visit the IEEEtran home page at my
  30 website:  http://www.michaelshell.org/tex/ieeetran/
  31
  32
  33 Version 1.7a is a bug fix release that corrects the two column peer
  34 review title page problem. This problem was not present in the 1.6 series.
  35
  36
  37 V1.7 is a significant update over the 1.6 series with many important
  38 changes. For a full list, please read the file changelog.txt. The most
  39 notable changes include:
  40
  41  1. New class option compsoc to support the IEEE Computer Society format.
  42
  43  2. Several commands and environments have been deprecated in favor of
  44     replacements with IEEE prefixes to better avoid potential future name
  45     clashes with other packages. Legacy code retained to allow the use of
  46     the obsolete forms (for now), but with a warning message to the console
  47     during compilation:
  48     \IEEEauthorblockA, \IEEEauthorblockN, \IEEEauthorrefmark,
  49     \IEEEbiography, \IEEEbiographynophoto, \IEEEkeywords, \IEEEPARstart,
  50     \IEEEproof, \IEEEpubid, \IEEEpubidadjcol, \IEEEQED, \IEEEQEDclosed,
  51     \IEEEQEDopen, \IEEEspecialpapernotice. IEEEtran.cls now redefines
  52     \proof in way to avoid problems with the amsthm.sty package.
  53     For IED lists:
  54     \IEEEiedlabeljustifyc, \IEEEiedlabeljustifyl, \IEEEiedlabeljustifyr,
  55     \IEEEnocalcleftmargin, \IEEElabelindent, \IEEEsetlabelwidth,
  56     \IEEEusemathlabelsep
  57     These commands/lengths now require the IEEE prefix and do not have
  58     legacy support: \IEEEnormaljot.
  59     For IED lists: \ifIEEEnocalcleftmargin, \ifIEEEnolabelindentfactor,
  60     \IEEEiedlistdecl, \IEEElabelindentfactor
  61
  62  3. New \CLASSINPUT, \CLASSOPTION and \CLASSINFO interface allows for more
  63     user control and conditional compilation.
  64
  65  4. Several bug fixes and improved compatibility with other packages.
  66
  67
  68 A note to those who create classes derived from IEEEtran.cls: Consider the
  69 use of patch code, either in an example .tex file or as a .sty file,
  70 rather than creating a new class. The IEEEtran.cls CLASSINPUT interface
  71 allows IEEEtran.cls to be fully programmable with respect to document
  72 margins, so there is no need for new class files just for altered margins.
  73 In this way, authors can benefit from updates to IEEEtran.cls and the need
  74 to maintain derivative classes and backport later IEEEtran.cls revisions
  75 thereto is avoided. As always, developers who create classes derived from
  76 IEEEtran.cls should use a different name for the derived class, so that it
  77 cannot be confused with the official/base version here, as well as provide
  78 authors with technical support for the derived class. It is generally a bad
  79 idea to produce a new class that is not going to be maintained.
  80
  81
  82 Best wishes for all your publication endeavors,
  83
  84 Michael Shell
  85 http://www.michaelshell.org/
  86
  87
  88 ********************************** Files **********************************
  89
  90 README                 - This file.
  91
  92 IEEEtran.cls           - The IEEEtran LaTeX class file.
  93
  94 changelog.txt          - The revision history.
  95
  96 IEEEtran_HOWTO.pdf     - The IEEEtran LaTeX class user manual.
  97
  98 bare_conf.tex          - A bare bones starter file for conference papers.
  99
 100 bare_jrnl.tex          - A bare bones starter file for journal papers.
 101
 102 bare_jrnl_compsoc.tex  - A bare bones starter file for Computer Society
 103                          journal papers.
 104
 105 bare_adv.tex           - A bare bones starter file showing advanced
 106                          techniques such as conditional compilation,
 107                          hyperlinks, PDF thumbnails, etc. The illustrated
 108                          format is for a Computer Society journal paper.
 109
 110 ***************************************************************************
 111 Legal Notice:
 112 This code is offered as-is without any warranty either expressed or
 113 implied; without even the implied warranty of MERCHANTABILITY or
 114 FITNESS FOR A PARTICULAR PURPOSE!
 115 User assumes all risk.
 116 In no event shall IEEE or any contributor to this code be liable for
 117 any damages or losses, including, but not limited to, incidental,
 118 consequential, or any other damages, resulting from the use or misuse
 119 of any information contained here.
 120
 121 All comments are the opinions of their respective authors and are not
 122 necessarily endorsed by the IEEE.
 123
 124 This work is distributed under the LaTeX Project Public License (LPPL)
 125 ( http://www.latex-project.org/ ) version 1.3, and may be freely used,
 126 distributed and modified. A copy of the LPPL, version 1.3, is included
 127 in the base LaTeX documentation of all distributions of LaTeX released
 128 2003/12/01 or later.
 129 Retain all contribution notices and credits.
 130 ** Modified files should be clearly indicated as such, including  **
 131 ** renaming them and changing author support contact information. **
 132
 133 File list of work: IEEEtran.cls, IEEEtran_HOWTO.pdf, bare_adv.tex,
 134                    bare_conf.tex, bare_jrnl.tex, bare_jrnl_compsoc.tex
 135 ***************************************************************************