elsarticle/doc/elsdoc.tex
author Alpar Juttner <alpar@cs.elte.hu>
Fri, 22 Sep 2017 12:52:55 +0200
changeset 29 0ff72a828b16
permissions -rw-r--r--
Spellchecking and some rewording
alpar@0
     1
%% 
alpar@0
     2
%% Copyright 2007, 2008, 2009 Elsevier Ltd
alpar@0
     3
%% 
alpar@0
     4
%% This file is part of the 'Elsarticle Bundle'.
alpar@0
     5
%% ---------------------------------------------
alpar@0
     6
%% 
alpar@0
     7
%% It may be distributed under the conditions of the LaTeX Project Public
alpar@0
     8
%% License, either version 1.2 of this license or (at your option) any
alpar@0
     9
%% later version.  The latest version of this license is in
alpar@0
    10
%%    http://www.latex-project.org/lppl.txt
alpar@0
    11
%% and version 1.2 or later is part of all distributions of LaTeX
alpar@0
    12
%% version 1999/12/01 or later.
alpar@0
    13
%% 
alpar@0
    14
%% The list of all files belonging to the 'Elsarticle Bundle' is
alpar@0
    15
%% given in the file `manifest.txt'.
alpar@0
    16
%% 
alpar@0
    17
\documentclass[a4paper,12pt]{article}
alpar@0
    18
alpar@0
    19
\usepackage[xcolor,qtwo]{rvdtx}
alpar@0
    20
\usepackage{multicol}
alpar@0
    21
\usepackage{color}
alpar@0
    22
\usepackage{xspace}
alpar@0
    23
\usepackage{pdfwidgets}
alpar@0
    24
\usepackage{enum}
alpar@0
    25
alpar@0
    26
\def\ttdefault{cmtt}
alpar@0
    27
alpar@0
    28
\headsep4pc
alpar@0
    29
alpar@0
    30
\makeatletter
alpar@0
    31
\def\bs{\expandafter\@gobble\string\\}
alpar@0
    32
\def\lb{\expandafter\@gobble\string\{}
alpar@0
    33
\def\rb{\expandafter\@gobble\string\}}
alpar@0
    34
\def\@pdfauthor{C.V.Radhakrishnan}
alpar@0
    35
\def\@pdftitle{elsarticle.cls -- A documentation}
alpar@0
    36
\def\@pdfsubject{Document formatting with elsarticle.cls}
alpar@0
    37
\def\@pdfkeywords{LaTeX, Elsevier Ltd, document class}
alpar@0
    38
\def\file#1{\textsf{#1}\xspace}
alpar@0
    39
alpar@0
    40
%\def\LastPage{19}
alpar@0
    41
alpar@0
    42
\DeclareRobustCommand{\LaTeX}{L\kern-.26em%
alpar@0
    43
        {\sbox\z@ T%
alpar@0
    44
         \vbox to\ht\z@{\hbox{\check@mathfonts
alpar@0
    45
           \fontsize\sf@size\z@
alpar@0
    46
           \math@fontsfalse\selectfont
alpar@0
    47
          A\,}%
alpar@0
    48
         \vss}%
alpar@0
    49
        }%
alpar@0
    50
     \kern-.15em%
alpar@0
    51
    \TeX}
alpar@0
    52
\makeatother
alpar@0
    53
alpar@0
    54
\def\figurename{Clip}
alpar@0
    55
alpar@0
    56
\begin{document}
alpar@0
    57
alpar@0
    58
\def\testa{This is a specimen document. }
alpar@0
    59
\def\testc{\testa\testa\testa\testa}
alpar@0
    60
\def\testb{\testc\testc\testc\testc\testc}
alpar@0
    61
\long\def\test{\testb\par\testb\par\testb\par}
alpar@0
    62
alpar@0
    63
\pinclude{\copy\contbox\printSq{\LastPage}}
alpar@0
    64
alpar@0
    65
\title{elsarticle.cls -- A better way to format your document}
alpar@0
    66
alpar@0
    67
\author{Elsevier Ltd}
alpar@0
    68
\contact{elsarticle@river-valley.com}
alpar@0
    69
alpar@0
    70
\version{1.20}
alpar@0
    71
\date{\today}
alpar@0
    72
\maketitle
alpar@0
    73
alpar@0
    74
\section{Introduction}
alpar@0
    75
%\hypertarget{introduction}{}
alpar@0
    76
alpar@0
    77
\file{elsarticle.cls} is a thoroughly re-written document class
alpar@0
    78
for formatting \LaTeX{} submissions to Elsevier journals.
alpar@0
    79
The class uses the environments and commands defined in \LaTeX{} kernel
alpar@0
    80
without any change in the signature so that clashes with other
alpar@0
    81
contributed \LaTeX{} packages such as \file{hyperref.sty},
alpar@0
    82
\file{preview-latex.sty}, etc., will be minimal.
alpar@0
    83
\file{elsarticle.cls} is primarily built upon the default
alpar@0
    84
\file{article.cls}.  This class depends on the following packages
alpar@0
    85
for its proper functioning:
alpar@0
    86
alpar@0
    87
\begin{enumerate}
alpar@0
    88
\item \file{pifont.sty} for openstar in the title footnotes;
alpar@0
    89
\item \file{natbib.sty} for citation processing;
alpar@0
    90
\item \file{geometry.sty} for margin settings;
alpar@0
    91
\item \file{fleqn.clo} for left aligned equations;
alpar@0
    92
\item \file{graphicx.sty} for graphics inclusion;
alpar@0
    93
\item \file{txfonts.sty} optional font package, if the document is to
alpar@0
    94
  be formatted with Times and compatible math fonts;
alpar@0
    95
\item \file{hyperref.sty} optional packages if hyperlinking is
alpar@0
    96
  required in the document.
alpar@0
    97
alpar@0
    98
\end{enumerate}
alpar@0
    99
alpar@0
   100
All the above packages are part of any standard \LaTeX{} installation.
alpar@0
   101
Therefore, the users need not be bothered about downloading any
alpar@0
   102
extra packages.  Furthermore, users are free to make use of \textsc{ams}
alpar@0
   103
math packages such as \file{amsmath.sty}, \file{amsthm.sty},
alpar@0
   104
\file{amssymb.sty}, \file{amsfonts.sty}, etc., if they want to.  All
alpar@0
   105
these packages work in tandem with \file{elsarticle.cls} without
alpar@0
   106
any problems.
alpar@0
   107
alpar@0
   108
\section{Major Differences}
alpar@0
   109
%\hypertarget{majordifferences}{}
alpar@0
   110
alpar@0
   111
Following are the major differences between \file{elsarticle.cls}
alpar@0
   112
and its predecessor package, \file{elsart.cls}:
alpar@0
   113
alpar@0
   114
\begin{enumerate}[\textbullet]
alpar@0
   115
\item \file{elsarticle.cls} is built upon \file{article.cls}
alpar@0
   116
while \file{elsart.cls} is not. \file{elsart.cls} redefines
alpar@0
   117
many of the commands in the \LaTeX{} classes/kernel, which can
alpar@0
   118
possibly cause surprising clashes with other contributed
alpar@0
   119
\LaTeX{} packages;
alpar@0
   120
alpar@0
   121
\item provides preprint document formatting by default, and
alpar@0
   122
optionally formats the document as per the final
alpar@0
   123
style of models $1+$, $3+$ and $5+$ of Elsevier journals;
alpar@0
   124
alpar@0
   125
\item some easier ways for formatting \verb+list+ and
alpar@0
   126
\verb+theorem+ environments are provided while people can still
alpar@0
   127
use \file{amsthm.sty} package;
alpar@0
   128
alpar@0
   129
\item \file{natbib.sty} is the main citation processing package
alpar@0
   130
  which can comprehensively handle all kinds of citations and
alpar@0
   131
works perfectly with \file{hyperref.sty} in combination with
alpar@0
   132
\file{hypernat.sty};
alpar@0
   133
alpar@0
   134
\item long title pages are processed correctly in preprint and
alpar@0
   135
  final formats.
alpar@0
   136
alpar@0
   137
\end{enumerate}
alpar@0
   138
alpar@0
   139
\section{Installation}
alpar@0
   140
%\hypertarget{installation}{}
alpar@0
   141
alpar@0
   142
The package is available at author resources page at Elsevier
alpar@0
   143
(\url{http://www.elsevier.com/locate/latex}).
alpar@0
   144
It can also be found in any of the nodes of the Comprehensive
alpar@0
   145
\TeX{} Archive Network (\textsc{ctan}), one of the primary nodes
alpar@0
   146
being
alpar@0
   147
\url{http://www.ctan.org/tex-archive/macros/latex/contrib/elsevier/}.
alpar@0
   148
Please download the \file{elsarticle.dtx} which is a composite
alpar@0
   149
class with documentation and \file{elsarticle.ins} which is the
alpar@0
   150
\LaTeX{} installer file. When we compile the
alpar@0
   151
\file{elsarticle.ins} with \LaTeX{} it provides the class file,
alpar@0
   152
\file{elsarticle.cls} by
alpar@0
   153
stripping off all the documentation from the \verb+*.dtx+ file.
alpar@0
   154
The class may be moved or copied to a place, usually,
alpar@0
   155
\verb+$TEXMF/tex/latex/elsevier/+, %$%%%%%%%%%%%%%%%%%%%%%%%%%%%%
alpar@0
   156
or a folder which will be read                   
alpar@0
   157
by \LaTeX{} during document compilation.  The \TeX{} file
alpar@0
   158
database needs updation after moving/copying class file.  Usually,
alpar@0
   159
we use commands like \verb+mktexlsr+ or \verb+texhash+ depending
alpar@0
   160
upon the distribution and operating system.
alpar@0
   161
alpar@0
   162
alpar@0
   163
\section{Usage}\label{sec:usage}
alpar@0
   164
%\hypertarget{usage}{}
alpar@0
   165
The class should be loaded with the command:
alpar@0
   166
alpar@0
   167
\begin{vquote}
alpar@0
   168
 \documentclass[<options>]{elsarticle}
alpar@0
   169
\end{vquote}
alpar@0
   170
alpar@0
   171
\noindent where the \verb+options+ can be the following:
alpar@0
   172
alpar@0
   173
\begin{description}
alpar@0
   174
alpar@0
   175
\item [{\tt\color{verbcolor} preprint}]  default option which format the
alpar@0
   176
  document for submission to Elsevier journals.
alpar@0
   177
alpar@0
   178
\item [{\tt\color{verbcolor} review}]  similar to the \verb+preprint+ option, but
alpar@0
   179
  increases the baselineskip to facilitate easier review process.
alpar@0
   180
alpar@0
   181
\item [{\tt\color{verbcolor} 1p}]  formats the article to the look and feel of the final
alpar@0
   182
  format of model 1+ journals. This is always single column style.
alpar@0
   183
alpar@0
   184
\item [{\tt\color{verbcolor} 3p}] formats the article to the look and feel of the final
alpar@0
   185
  format of model 3+ journals. If the journal is a two column
alpar@0
   186
model, use \verb+twocolumn+ option in combination.
alpar@0
   187
alpar@0
   188
\item [{\tt\color{verbcolor} 5p}] formats for model 5+ journals. This is always
alpar@0
   189
  of two column style.
alpar@0
   190
alpar@0
   191
\item [{\tt\color{verbcolor} authoryear}] author-year citation style of
alpar@0
   192
  \file{natbib.sty}. If you want to add extra options of
alpar@0
   193
\file{natbib.sty}, you may use the options as comma delimited
alpar@0
   194
strings as arguments to \verb+\biboptions+ command. An example
alpar@0
   195
would be:
alpar@0
   196
\end{description}
alpar@0
   197
\begin{vquote}
alpar@0
   198
 \biboptions{longnamesfirst,angle,semicolon}
alpar@0
   199
\end{vquote}
alpar@0
   200
alpar@0
   201
\begin{description}
alpar@0
   202
\item [{\tt\color{verbcolor} number}] numbered citation style. Extra options
alpar@0
   203
  can be loaded with\linebreak \verb+\biboptions+ command.
alpar@0
   204
alpar@0
   205
\item [{\tt\color{verbcolor} sort\&compress}] sorts and compresses the
alpar@0
   206
numbered citations. For example, citation [1,2,3] will become [1--3].
alpar@0
   207
alpar@0
   208
\item [{\tt\color{verbcolor} longtitle}] if front matter is unusually long, use
alpar@0
   209
  this option to split the title page across pages with the correct
alpar@0
   210
placement of title and author footnotes in the first page.
alpar@0
   211
alpar@0
   212
\item [{\tt\color{verbcolor} times}] loads \file{txfonts.sty}, if available in
alpar@0
   213
  the system to use Times and compatible math fonts.
alpar@0
   214
alpar@0
   215
\item[] All options of \file{article.cls} can be used with this
alpar@0
   216
  document class.
alpar@0
   217
alpar@0
   218
\item[] The default options loaded are \verb+a4paper+, \verb+10pt+,
alpar@0
   219
  \verb+oneside+, \verb+onecolumn+ and \verb+preprint+.
alpar@0
   220
alpar@0
   221
\end{description}
alpar@0
   222
alpar@0
   223
\section{Frontmatter}
alpar@0
   224
%\hypertarget{preamble}{}
alpar@0
   225
alpar@0
   226
There are two types of frontmatter coding:
alpar@0
   227
\begin{enumerate}[(1)]
alpar@0
   228
\item each author is
alpar@0
   229
connected to an affiliation with a footnote marker; hence all
alpar@0
   230
authors are grouped together and affiliations follow;
alpar@0
   231
\item authors of same affiliations are grouped together and the
alpar@0
   232
relevant affiliation follows this group. An example coding of the first
alpar@0
   233
type is provided below.
alpar@0
   234
\end{enumerate}
alpar@0
   235
alpar@0
   236
\begin{vquote}
alpar@0
   237
 \title{This is a specimen title\tnoteref{t1,t2}}
alpar@0
   238
 \tnotetext[t1]{This document is a collaborative effort.}
alpar@0
   239
 \tnotetext[t2]{The second title footnote which is a longer
alpar@0
   240
    longer than the first one and with an intention to fill
alpar@0
   241
    in up more than one line while formatting.}
alpar@0
   242
\end{vquote}
alpar@0
   243
alpar@0
   244
\begin{vquote}
alpar@0
   245
 \author[rvt]{C.V.~Radhakrishnan\corref{cor1}\fnref{fn1}}
alpar@0
   246
 \ead{cvr@river-valley.com}
alpar@0
   247
alpar@0
   248
 \author[rvt,focal]{K.~Bazargan\fnref{fn2}}
alpar@0
   249
 \ead{kaveh@river-valley.com}
alpar@0
   250
alpar@0
   251
 \author[els]{S.~Pepping\corref{cor2}\fnref{fn1,fn3}}
alpar@0
   252
 \ead[url]{http://www.elsevier.com}
alpar@0
   253
\end{vquote}
alpar@0
   254
alpar@0
   255
\begin{vquote}
alpar@0
   256
 \cortext[cor1]{Corresponding author}
alpar@0
   257
 \cortext[cor2]{Principal corresponding author}
alpar@0
   258
 \fntext[fn1]{This is the specimen author footnote.}
alpar@0
   259
 \fntext[fn2]{Another author footnote, but a little more 
alpar@0
   260
             longer.}
alpar@0
   261
 \fntext[fn3]{Yet another author footnote. Indeed, you can have
alpar@0
   262
    any number of author footnotes.}
alpar@0
   263
alpar@0
   264
 \address[rvt]{River Valley Technologies, SJP Building,
alpar@0
   265
    Cotton Hills, Trivandrum, Kerala, India 695014}
alpar@0
   266
 \address[focal]{River Valley Technologies, 9, Browns Court,
alpar@0
   267
    Kennford, Exeter, United Kingdom}
alpar@0
   268
 \address[els]{Central Application Management,
alpar@0
   269
    Elsevier, Radarweg 29, 1043 NX\\
alpar@0
   270
    Amsterdam, Netherlands}
alpar@0
   271
alpar@0
   272
\end{vquote}
alpar@0
   273
alpar@0
   274
The output of the above TeX source is given in Clips~\ref{clip1} and
alpar@0
   275
\ref{clip2}. The header portion or title area is given in Clip~\ref{clip1} and
alpar@0
   276
the footer area is given in Clip~\ref{clip2}.
alpar@0
   277
alpar@0
   278
\vspace*{6pt}
alpar@0
   279
\def\rulecolor{blue!70}
alpar@0
   280
\src{Header of the title page.}
alpar@0
   281
\includeclip{1}{132 571 481 690}{els1.pdf}
alpar@0
   282
\def\rulecolor{orange}
alpar@0
   283
alpar@0
   284
%\vspace*{6pt}
alpar@0
   285
\def\rulecolor{blue!70}
alpar@0
   286
\src{Footer of the title page.}
alpar@0
   287
\includeclip{1}{122 129 481 237}{els1.pdf}
alpar@0
   288
\def\rulecolor{orange}
alpar@0
   289
\pagebreak
alpar@0
   290
alpar@0
   291
Most of the commands such as \verb+\title+, \verb+\author+,
alpar@0
   292
\verb+\address+ are self explanatory.  Various components are
alpar@0
   293
linked to each other by a label--reference mechanism; for
alpar@0
   294
instance, title footnote is linked to the title with a footnote
alpar@0
   295
mark generated by referring to the \verb+\label+ string of
alpar@0
   296
the \verb=\tnotetext=.  We have used similar commands
alpar@0
   297
such as \verb=\tnoteref= (to link title note to title);
alpar@0
   298
\verb=\corref= (to link corresponding author text to
alpar@0
   299
corresponding author); \verb=\fnref= (to link footnote text to
alpar@0
   300
the relevant author names).  \TeX{} needs two compilations to
alpar@0
   301
resolve the footnote marks in the preamble part.  
alpar@0
   302
Given below are the syntax of various note marks and note texts.
alpar@0
   303
alpar@0
   304
\begin{vquote}
alpar@0
   305
  \tnoteref{<label(s)>}
alpar@0
   306
  \corref{<label(s)>}
alpar@0
   307
  \fnref{<label(s)>}
alpar@0
   308
  \tnotetext[<label>]{<title note text>}
alpar@0
   309
  \cortext[<label>]{<corresponding author note text>}
alpar@0
   310
  \fntext[<label>]{<author footnote text>}
alpar@0
   311
\end{vquote}
alpar@0
   312
alpar@0
   313
\noindent where \verb=<label(s)>= can be either one or more comma
alpar@0
   314
delimited label strings. The optional arguments to the
alpar@0
   315
\verb=\author= command holds the ref label(s) of the address(es)
alpar@0
   316
to which the author is affiliated while each \verb=\address=
alpar@0
   317
command can have an optional argument of a label. In the same
alpar@0
   318
manner, \verb=\tnotetext=, \verb=\fntext=, \verb=\cortext= will
alpar@0
   319
have optional arguments as their respective labels and note text
alpar@0
   320
as their mandatory argument.
alpar@0
   321
alpar@0
   322
The following example code provides the markup of the second type
alpar@0
   323
of author-affiliation.
alpar@0
   324
%as seen in the output given in the
alpar@0
   325
%box to the right.
alpar@0
   326
%\pinclude{\def\rulecolor{blue!80}
alpar@0
   327
%   \includeclip[width=3.25in]{1}{130 84 484 676}{els2.pdf}%
alpar@0
   328
% \def\rulecolor{orange}}
alpar@0
   329
alpar@0
   330
\begin{vquote}
alpar@0
   331
\author{C.V.~Radhakrishnan\corref{cor1}\fnref{fn1}}
alpar@0
   332
 \ead{cvr@river-valley.com}
alpar@0
   333
 \address{River Valley Technologies, SJP Building,
alpar@0
   334
   Cotton Hills, Trivandrum, Kerala, India 695014}
alpar@0
   335
\end{vquote}
alpar@0
   336
alpar@0
   337
\begin{vquote}
alpar@0
   338
\author{K.~Bazargan\fnref{fn2}}
alpar@0
   339
 \ead{kaveh@river-valley.com}
alpar@0
   340
 \address{River Valley Technologies, 9, Browns Court, Kennford,
alpar@0
   341
   Exeter, UK.}
alpar@0
   342
\end{vquote}
alpar@0
   343
alpar@0
   344
\begin{vquote}
alpar@0
   345
\author{S.~Pepping\fnref{fn1,fn3}}
alpar@0
   346
 \ead[url]{http://www.elsevier.com}
alpar@0
   347
 \address{Central Application Management,
alpar@0
   348
   Elsevier, Radarweg 43, 1043 NX Amsterdam, Netherlands}
alpar@0
   349
\end{vquote}
alpar@0
   350
alpar@0
   351
\begin{vquote}
alpar@0
   352
\cortext[cor1]{Corresponding author}
alpar@0
   353
\fntext[fn1]{This is the first author footnote.}
alpar@0
   354
\fntext[fn2]{Another author footnote, this is a very long 
alpar@0
   355
  footnote and it should be a really long footnote. But this 
alpar@0
   356
  footnote is not yet sufficiently long enough to make two lines 
alpar@0
   357
  of footnote text.}
alpar@0
   358
\fntext[fn3]{Yet another author footnote.}
alpar@0
   359
\end{vquote}
alpar@0
   360
alpar@0
   361
The output of the above TeX source is given in Clip~\ref{clip3}.
alpar@0
   362
alpar@0
   363
\vspace*{12pt}
alpar@0
   364
\def\rulecolor{blue!70}
alpar@0
   365
\src{Header of the title page..}
alpar@0
   366
\includeclip{1}{132 491 481 690}{els2.pdf}
alpar@0
   367
\def\rulecolor{orange}
alpar@0
   368
alpar@0
   369
alpar@0
   370
The frontmatter part has further environments such as abstracts and
alpar@0
   371
keywords.  These can be marked up in the following
alpar@0
   372
manner:
alpar@0
   373
alpar@0
   374
%\verb+\begin{abstract}+ \dots \verb+\end{abstract}+ and
alpar@0
   375
%\verb+\begin{keyword}+ \verb+...+ \verb+\end{keyword}+ which
alpar@0
   376
%contain the abstract and keywords respectively. 
alpar@0
   377
alpar@0
   378
\begin{vquote}
alpar@0
   379
 \begin{abstract}
alpar@0
   380
  In this work we demonstrate the formation of a new type of 
alpar@0
   381
  polariton on the interface between a ....
alpar@0
   382
 \end{abstract}
alpar@0
   383
\end{vquote} 
alpar@0
   384
alpar@0
   385
\begin{vquote}
alpar@0
   386
 \begin{keyword}
alpar@0
   387
  quadruple exiton \sep polariton \sep WGM
alpar@0
   388
alpar@0
   389
  \PACS 71.35.-y \sep 71.35.Lk \sep 71.36.+c
alpar@0
   390
 \end{keyword}
alpar@0
   391
\end{vquote}
alpar@0
   392
alpar@0
   393
\noindent Each keyword shall be separated by a \verb+\sep+ command.
alpar@0
   394
\textsc{pacs} and \textsc{msc} classifications shall be provided in 
alpar@0
   395
the keyword environment with the commands \verb+\PACS+ and
alpar@0
   396
\verb+\MSC+ respectively.  \verb+\MSC+ accepts an optional
alpar@0
   397
argument to accommodate future revisions.
alpar@0
   398
eg., \verb=\MSC[2008]=. The default is 2000.\looseness=-1
alpar@0
   399
alpar@0
   400
alpar@0
   401
\section{Floats}
alpar@0
   402
{Figures} may be included using the command, \verb+\includegraphics+ in
alpar@0
   403
combination with or without its several options to further control
alpar@0
   404
graphic. \verb+\includegraphics+ is provided by \file{graphic[s,x].sty}
alpar@0
   405
which is part of any standard \LaTeX{} distribution.
alpar@0
   406
\file{graphicx.sty} is loaded by default. \LaTeX{} accepts figures in
alpar@0
   407
the postscript format while pdf\LaTeX{} accepts \file{*.pdf},
alpar@0
   408
\file{*.mps} (metapost), \file{*.jpg} and \file{*.png} formats. 
alpar@0
   409
pdf\LaTeX{} does not accept graphic files in the postscript format. 
alpar@0
   410
alpar@0
   411
The \verb+table+ environment is handy for marking up tabular
alpar@0
   412
material. If users want to use \file{multirow.sty},
alpar@0
   413
\file{array.sty}, etc., to fine control/enhance the tables, they
alpar@0
   414
are welcome to load any package of their choice and
alpar@0
   415
\file{elsarticle.cls} will work in combination with all loaded
alpar@0
   416
packages.
alpar@0
   417
alpar@0
   418
\section[Theorem and ...]{Theorem and theorem like environments}
alpar@0
   419
alpar@0
   420
\file{elsarticle.cls} provides a few shortcuts to format theorems and
alpar@0
   421
theorem-like environments with ease. In all commands the options that
alpar@0
   422
are used with the \verb+\newtheorem+ command will work exactly in the same
alpar@0
   423
manner. \file{elsarticle.cls} provides three commands to format theorem or
alpar@0
   424
theorem-like environments: 
alpar@0
   425
alpar@0
   426
\begin{vquote}
alpar@0
   427
 \newtheorem{thm}{Theorem}
alpar@0
   428
 \newtheorem{lem}[thm]{Lemma}
alpar@0
   429
 \newdefinition{rmk}{Remark}
alpar@0
   430
 \newproof{pf}{Proof}
alpar@0
   431
 \newproof{pot}{Proof of Theorem \ref{thm2}}
alpar@0
   432
\end{vquote}
alpar@0
   433
alpar@0
   434
The \verb+\newtheorem+ command formats a
alpar@0
   435
theorem in \LaTeX's default style with italicized font, bold font
alpar@0
   436
for theorem heading and theorem number at the right hand side of the
alpar@0
   437
theorem heading.  It also optionally accepts an argument which
alpar@0
   438
will be printed as an extra heading in parentheses. 
alpar@0
   439
alpar@0
   440
\begin{vquote}
alpar@0
   441
  \begin{thm} 
alpar@0
   442
   For system (8), consensus can be achieved with $\|T_{\omega z}$
alpar@0
   443
   ...
alpar@0
   444
     \begin{eqnarray}\label{10}
alpar@0
   445
     ....
alpar@0
   446
     \end{eqnarray}
alpar@0
   447
  \end{thm}
alpar@0
   448
\end{vquote}  
alpar@0
   449
alpar@0
   450
Clip~\ref{clip4} will show you how some text enclosed between the
alpar@0
   451
above code looks like:
alpar@0
   452
alpar@0
   453
\vspace*{6pt}
alpar@0
   454
\def\rulecolor{blue!70}
alpar@0
   455
\src{{\ttfamily\color{verbcolor}\bs newtheorem}}
alpar@0
   456
\includeclip{2}{1 1 453 120}{jfigs.pdf}
alpar@0
   457
\def\rulecolor{orange}
alpar@0
   458
alpar@0
   459
The \verb+\newdefinition+ command is the same in
alpar@0
   460
all respects as its\linebreak \verb+\newtheorem+ counterpart except that
alpar@0
   461
the font shape is roman instead of italic.  Both
alpar@0
   462
\verb+\newdefinition+ and \verb+\newtheorem+ commands
alpar@0
   463
automatically define counters for the environments defined.
alpar@0
   464
alpar@0
   465
\vspace*{12pt}
alpar@0
   466
\def\rulecolor{blue!70}
alpar@0
   467
\src{{\ttfamily\color{verbcolor}\bs newdefinition}}
alpar@0
   468
\includeclip{1}{1 1 453 105}{jfigs.pdf}
alpar@0
   469
\def\rulecolor{orange}
alpar@0
   470
alpar@0
   471
The \verb+\newproof+ command defines proof environments with
alpar@0
   472
upright font shape.  No counters are defined. 
alpar@0
   473
alpar@0
   474
\vspace*{6pt}
alpar@0
   475
\def\rulecolor{blue!70}
alpar@0
   476
\src{{\ttfamily\color{verbcolor}\bs newproof}}
alpar@0
   477
\includeclip{3}{1 1 453 65}{jfigs.pdf}
alpar@0
   478
\def\rulecolor{orange}
alpar@0
   479
alpar@0
   480
Users can also make use of \verb+amsthm.sty+ which will override
alpar@0
   481
all the default definitions described above.
alpar@0
   482
alpar@0
   483
\section[Enumerated ...]{Enumerated and Itemized Lists}
alpar@0
   484
\file{elsarticle.cls} provides an extended list processing macros
alpar@0
   485
which makes the usage a bit more user friendly than the default
alpar@0
   486
\LaTeX{} list macros.   With an optional argument to the
alpar@0
   487
\verb+\begin{enumerate}+ command, you can change the list counter
alpar@0
   488
type and its attributes.
alpar@0
   489
alpar@0
   490
\begin{vquote}
alpar@0
   491
 \begin{enumerate}[1.]
alpar@0
   492
 \item The enumerate environment starts with an optional
alpar@0
   493
   argument `1.', so that the item counter will be suffixed
alpar@0
   494
   by a period.
alpar@0
   495
 \item You can use `a)' for alphabetical counter and '(i)' for
alpar@0
   496
   roman counter.
alpar@0
   497
  \begin{enumerate}[a)]
alpar@0
   498
    \item Another level of list with alphabetical counter.
alpar@0
   499
    \item One more item before we start another.
alpar@0
   500
    \begin{enumerate}[(i)]
alpar@0
   501
     \item This item has roman numeral counter.
alpar@0
   502
     \item Another one before we close the third level.
alpar@0
   503
    \end{enumerate}
alpar@0
   504
    \item Third item in second level.
alpar@0
   505
  \end{enumerate}
alpar@0
   506
 \item All list items conclude with this step.
alpar@0
   507
 \end{enumerate}
alpar@0
   508
\end{vquote}
alpar@0
   509
alpar@0
   510
\vspace*{12pt}
alpar@0
   511
\def\rulecolor{blue!70}
alpar@0
   512
\src{List -- Enumerate}
alpar@0
   513
\includeclip{4}{1 1 453 185}{jfigs.pdf}
alpar@0
   514
\def\rulecolor{orange}
alpar@0
   515
alpar@0
   516
alpar@0
   517
Further, the enhanced list environment allows one to prefix a
alpar@0
   518
string like `step' to all the item numbers.  Take a look at the
alpar@0
   519
example below:
alpar@0
   520
alpar@0
   521
\begin{vquote}
alpar@0
   522
 \begin{enumerate}[Step 1.]
alpar@0
   523
  \item This is the first step of the example list.
alpar@0
   524
  \item Obviously this is the second step.
alpar@0
   525
  \item The final step to wind up this example.
alpar@0
   526
 \end{enumerate}
alpar@0
   527
\end{vquote}
alpar@0
   528
alpar@0
   529
\def\rulecolor{blue!70}
alpar@0
   530
\src{List -- enhanced}
alpar@0
   531
\includeclip{5}{1 1 313 83}{jfigs.pdf}
alpar@0
   532
\def\rulecolor{orange}
alpar@0
   533
alpar@0
   534
\vspace*{-18pt}
alpar@0
   535
alpar@0
   536
\section{Cross-references}
alpar@0
   537
In electronic publications, articles may be internally
alpar@0
   538
hyperlinked. Hyperlinks are generated from proper
alpar@0
   539
cross-references in the article.  For example, the words
alpar@0
   540
\textcolor{black!80}{Fig.~1} will never be more than simple text,
alpar@0
   541
whereas the proper cross-reference \verb+\ref{tiger}+ may be
alpar@0
   542
turned into a hyperlink to the figure itself:
alpar@0
   543
\textcolor{blue}{Fig.~1}.  In the same way,
alpar@0
   544
the words \textcolor{blue}{Ref.~[1]} will fail to turn into a
alpar@0
   545
hyperlink; the proper cross-reference is \verb+\cite{Knuth96}+.
alpar@0
   546
Cross-referencing is possible in \LaTeX{} for sections,
alpar@0
   547
subsections, formulae, figures, tables, and literature
alpar@0
   548
references.
alpar@0
   549
alpar@0
   550
\section[Mathematical ...]{Mathematical symbols and formulae}
alpar@0
   551
alpar@0
   552
Many physical/mathematical sciences authors require more
alpar@0
   553
mathematical symbols than the few that are provided in standard
alpar@0
   554
\LaTeX. A useful package for additional symbols is the
alpar@0
   555
\file{amssymb} package, developed by the American Mathematical
alpar@0
   556
Society. This package includes such oft-used symbols as
alpar@0
   557
$\lesssim$ (\verb+\lesssim+), $\gtrsim$ (\verb+\gtrsim+)  or 
alpar@0
   558
$\hbar$ (\verb+\hbar+). Note that your \TeX{}
alpar@0
   559
system should have the \file{msam} and \file{msbm} fonts installed. If
alpar@0
   560
you need only a few symbols, such as $\Box$ (\verb+\Box+), you might try the
alpar@0
   561
package \file{latexsym}.
alpar@0
   562
alpar@0
   563
Another point which would require authors' attention is the
alpar@0
   564
breaking up of long equations.  When you use
alpar@0
   565
\file{elsarticle.cls} for formatting your submissions in the 
alpar@0
   566
\verb+preprint+ mode, the document is formatted in single column
alpar@0
   567
style with a text width of 384pt or 5.3in.  When this document is
alpar@0
   568
formatted for final print and if the journal happens to be a double column
alpar@0
   569
journal, the text width will be reduced to 224pt at for 3+
alpar@0
   570
double column and 5+ journals respectively. All the nifty 
alpar@0
   571
fine-tuning in equation breaking done by the author goes to waste in
alpar@0
   572
such cases.  Therefore, authors are requested to check this
alpar@0
   573
problem by typesetting their submissions in final format as well
alpar@0
   574
just to see if their equations are broken at appropriate places,
alpar@0
   575
by changing appropriate options in the document class loading
alpar@0
   576
command, which is explained in section~\ref{sec:usage},
alpar@0
   577
\nameref{sec:usage}. This allows authors to fix any equation breaking
alpar@0
   578
problem before submission for publication.
alpar@0
   579
\file{elsarticle.cls} supports formatting the author submission
alpar@0
   580
in different types of final format.  This is further discussed in
alpar@0
   581
section \ref{sec:final}, \nameref{sec:final}.
alpar@0
   582
alpar@0
   583
\section{Bibliography}
alpar@0
   584
alpar@0
   585
Three bibliographic style files (\verb+*.bst+) are provided ---
alpar@0
   586
\file{elsarticle-num.bst}, \file{elsarticle-num-names.bst} and
alpar@0
   587
\file{elsarticle-harv.bst} --- the first one for the numbered scheme, the
alpar@0
   588
second for the numbered with new options of \file{natbib.sty} and the
alpar@0
   589
last one for the author year scheme.
alpar@0
   590
alpar@0
   591
In \LaTeX{} literature, references are listed in the
alpar@0
   592
\verb+thebibliography+ environment.  Each reference is a
alpar@0
   593
\verb+\bibitem+ and each \verb+\bibitem+ is identified by a label,
alpar@0
   594
by which it can be cited in the text:
alpar@0
   595
alpar@0
   596
\verb+\bibitem[Elson et al.(1996)]{ESG96}+ is cited as
alpar@0
   597
\verb+\citet{ESG96}+. 
alpar@0
   598
alpar@0
   599
\noindent In connection with cross-referencing and
alpar@0
   600
possible future hyperlinking it is not a good idea to collect
alpar@0
   601
more that one literature item in one \verb+\bibitem+.  The
alpar@0
   602
so-called Harvard or author-year style of referencing is enabled
alpar@0
   603
by the \LaTeX{} package \file{natbib}. With this package the
alpar@0
   604
literature can be cited as follows:
alpar@0
   605
alpar@0
   606
\begin{enumerate}[\textbullet]
alpar@0
   607
\item Parenthetical: \verb+\citep{WB96}+ produces (Wettig \& Brown, 1996).
alpar@0
   608
\item Textual: \verb+\citet{ESG96}+ produces Elson et al. (1996).
alpar@0
   609
\item An affix and part of a reference:
alpar@0
   610
\verb+\citep[e.g.][Ch. 2]{Gea97}+ produces (e.g. Governato et
alpar@0
   611
al., 1997, Ch. 2).
alpar@0
   612
\end{enumerate}
alpar@0
   613
alpar@0
   614
In the numbered scheme of citation, \verb+\cite{<label>}+ is used,
alpar@0
   615
since \verb+\citep+ or \verb+\citet+ has no relevance in the numbered
alpar@0
   616
scheme.  \file{natbib} package is loaded by \file{elsarticle} with
alpar@0
   617
\verb+numbers+ as default option.  You can change this to author-year
alpar@0
   618
or harvard scheme by adding option \verb+authoryear+ in the class
alpar@0
   619
loading command.  If you want to use more options of the \file{natbib}
alpar@0
   620
package, you can do so with the \verb+\biboptions+ command, which is
alpar@0
   621
described in the section \ref{sec:usage}, \nameref{sec:usage}.  For
alpar@0
   622
details of various options of the \file{natbib} package, please take a
alpar@0
   623
look at the \file{natbib} documentation, which is part of any standard
alpar@0
   624
\LaTeX{} installation.
alpar@0
   625
alpar@0
   626
\subsection*{Displayed equations and double column journals}
alpar@0
   627
alpar@0
   628
Many Elsevier journals print their text in two columns. Since
alpar@0
   629
the preprint layout uses a larger line width than such columns,
alpar@0
   630
the formulae are too wide for the line width in print. Here is an
alpar@0
   631
example of an equation  (see equation 6) which is perfect in a
alpar@0
   632
single column preprint format:
alpar@0
   633
alpar@0
   634
\bigskip
alpar@0
   635
\setlength\Sep{6pt}
alpar@0
   636
\src{See equation (6)}
alpar@0
   637
\def\rulecolor{blue!70}
alpar@0
   638
\includeclip{4}{134 391 483 584}{els1.pdf}
alpar@0
   639
\def\rulecolor{orange}
alpar@0
   640
                 	
alpar@0
   641
\noindent When this document is typeset for publication in a
alpar@0
   642
model 3+ journal with double columns, the equation will overlap
alpar@0
   643
the second column text matter if the equation is not broken at
alpar@0
   644
the appropriate location.
alpar@0
   645
alpar@0
   646
\vspace*{6pt}
alpar@0
   647
\def\rulecolor{blue!70}
alpar@0
   648
\src{See equation (6) overprints into second column}
alpar@0
   649
\includeclip{3}{61 531 532 734}{els-3pd.pdf}
alpar@0
   650
\def\rulecolor{orange}
alpar@0
   651
alpar@0
   652
\pagebreak
alpar@0
   653
alpar@0
   654
\noindent The typesetter will try to break the equation which
alpar@0
   655
need not necessarily be to the liking of the author or as it
alpar@0
   656
happens, typesetter's break point may be semantically incorrect.
alpar@0
   657
Therefore, authors may check their submissions for the incidence
alpar@0
   658
of such long equations and break the equations at the correct
alpar@0
   659
places so that the final typeset copy will be as they wish.
alpar@0
   660
alpar@0
   661
\section{Final print}\label{sec:final}
alpar@0
   662
alpar@0
   663
The authors can format their submission to the page size and margins
alpar@0
   664
of their preferred journal.  \file{elsarticle} provides four
alpar@0
   665
class options for the same. But it does not mean that using these
alpar@0
   666
options you can emulate the exact page layout of the final print copy. 
alpar@0
   667
\lmrgn=3em
alpar@0
   668
\begin{description}
alpar@0
   669
\item [\texttt{1p}:] $1+$ journals with a text area of
alpar@0
   670
384pt $\times$ 562pt or 13.5cm $\times$ 19.75cm or 5.3in $\times$
alpar@0
   671
7.78in, single column style only.
alpar@0
   672
alpar@0
   673
\item [\texttt{3p}:] $3+$ journals with a text area of 468pt
alpar@0
   674
$\times$ 622pt or 16.45cm $\times$ 21.9cm or 6.5in $\times$
alpar@0
   675
8.6in, single column style.
alpar@0
   676
alpar@0
   677
\item [\texttt{twocolumn}:] should be used along with 3p option if the
alpar@0
   678
journal is $3+$ with the same text area as above, but double column
alpar@0
   679
style. 
alpar@0
   680
alpar@0
   681
\item [\texttt{5p}:] $5+$ with text area of 522pt $\times$
alpar@0
   682
682pt or 18.35cm $\times$ 24cm or 7.22in $\times$ 9.45in,
alpar@0
   683
double column style only.
alpar@0
   684
\end{description}
alpar@0
   685
alpar@0
   686
Following pages have the clippings of different parts of
alpar@0
   687
the title page of different journal models typeset in final
alpar@0
   688
format.
alpar@0
   689
alpar@0
   690
Model $1+$ and $3+$  will have the same look and
alpar@0
   691
feel in the typeset copy when presented in this document. That is
alpar@0
   692
also the case with the double column $3+$ and $5+$ journal article
alpar@0
   693
pages. The only difference will be wider text width of
alpar@0
   694
higher models.  Therefore we will look at the
alpar@0
   695
different portions of a typical single column journal page and
alpar@0
   696
that of a double column article in the final format.
alpar@0
   697
alpar@0
   698
\vspace*{2pc}
alpar@0
   699
alpar@0
   700
\begin{center}
alpar@0
   701
\hypertarget{bsc}{}
alpar@0
   702
\hyperlink{sc}{
alpar@0
   703
{\bf [Specimen single column article -- Click here]}
alpar@0
   704
}
alpar@0
   705
alpar@0
   706
\vspace*{2pc}
alpar@0
   707
alpar@0
   708
\hypertarget{bsc}{}
alpar@0
   709
\hyperlink{dc}{
alpar@0
   710
{\bf [Specimen double column article -- Click here]}
alpar@0
   711
}
alpar@0
   712
\end{center}
alpar@0
   713
alpar@0
   714
\newpage
alpar@0
   715
\vspace*{-2pc}
alpar@0
   716
\src{}\hypertarget{sc}{}
alpar@0
   717
\def\rulecolor{blue!70}
alpar@0
   718
\hyperlink{bsc}{\includeclip{1}{121 81 497 670}{els1.pdf}}
alpar@0
   719
\def\rulecolor{orange}
alpar@0
   720
alpar@0
   721
alpar@0
   722
\newpage
alpar@0
   723
alpar@0
   724
\src{}\hypertarget{dc}{}
alpar@0
   725
\def\rulecolor{blue!70}
alpar@0
   726
\hyperlink{bsc}{\includeclip{1}{55 93 535 738}{els-3pd.pdf}}
alpar@0
   727
\def\rulecolor{orange}
alpar@0
   728
alpar@0
   729
\end{document}