Elsarticle.cls: Difference between revisions
No edit summary |
No edit summary |
||
Line 63: | Line 63: | ||
* All options of <code>article.cls</code> can be used with this document class. | * All options of <code>article.cls</code> can be used with this document class. | ||
* The default options loaded are <code>a4paper</code>, <code>10pt</code>, <code>oneside</code>, <code>onecolumn</code> and <code>preprint</code>. | * The default options loaded are <code>a4paper</code>, <code>10pt</code>, <code>oneside</code>, <code>onecolumn</code> and <code>preprint</code>. | ||
==Preamble== | |||
There are two types of preamble coding — (1) each author is | |||
connected to an affiliation with a footnote marker; hence all | |||
authors are grouped together and affiliations follow; (2) authors | |||
of same affiliations are grouped together and the relevant | |||
affiliation follows this group. An example coding of the first | |||
type is provided below: | |||
<geshi lang="latex"> | |||
\title{This is a specimen title\tnoteref{t1,t2}} | |||
\tnotetext[t1]{This document is a collaborative effort.} | |||
\tnotetext[t2]{The second title footnote which is a longer | |||
longer than the first one and with an intention to fill | |||
in up more than one line while formatting.} | |||
\author[rvt]{C.V.~Radhakrishnan\corref{cor1}\fnref{fn1}} | |||
\ead{cvr@river-valley.com} | |||
\author[rvt,focal]{K.~Bazargan\fnref{fn2}} | |||
\ead{kaveh@river-valley.com} | |||
\author[els]{S.~Pepping\corref{cor2}\fnref{fn1,fn3}} | |||
\ead[url]{http://www.elsevier.com} | |||
\cortext[cor1]{Corresponding author} | |||
\cortext[cor2]{Principal corresponding author} | |||
\fntext[fn1]{This is the specimen author footnote.} | |||
\fntext[fn2]{Another author footnote, but a little more longer.} | |||
\fntext[fn3]{Yet another author footnote. Indeed, you can have | |||
any number of author footnotes.} | |||
\address[rvt]{River Valley Technologies, SJP Building, | |||
Cotton Hills, Trivandrum, Kerala, India 695014} | |||
\address[focal]{River Valley Technologies, 9, Browns Court, | |||
Kennford, Exeter, United Kingdom} | |||
\address[els]{Central Application Management, | |||
Elsevier, Radarweg 29, 1043 NX\\ | |||
Amsterdam, Netherlands} | |||
</geshi> |
Revision as of 10:49, 31 July 2008
Introduction
elsarticle.cls
is a thoroughly re-written document class
for formatting LaTeX submissions to Elsevier journals.
The class uses the environments and commands defined in LaTeX kernel
without change to the signature so that clashes with other
contributed LaTeX packages like hyperref.sty
,
preview-latex.sty
, etc., will be minimal.
elsarticle.cls
is primarily built upon the default
article.cls
. The class depends on the following packages
for its proper functionality:
pifont.sty
for openstar in the title footnotes.natbib.sty
for citation processing.geometry.sty
for margin settings.fleqn.clo
for left aligned equations.graphicx.sty
for graphics inclusion.txfonts.sty
optional font package, if document is to be formatted with Times and compatible math fonts.hyperref.sty
optional packages if hyper linking is required in the document.
All the above packages are part of any standard LaTeX installation.
Therefore, the users need not be bothered about downloading any
extra packages. Further, users are free to make use of \textsc{ams}
math packages like, amsmath.sty
, amsthm.sty
,
amssymb.sty
, amsfonts.sty
, etc., if they want. All
these packages work in tandem with elsarticle.cls
without
any problems.
Major Differences
Following are the major differences between elsarticle.cls
and its predecesor package, elsart.cls
:
elsarticle.cls
is built uponarticle.cls
whileelsart.cls
is not.elsart.cls
redefines many of the commands in the LaTeX classes/kernel, which can possibly cause surprising clashes with other contributed LaTeX packages.- Provides preprint document formatting by default, and optionally formats the document as per the final style of models
1+
,3+
and5+
of Elsevier journals. - Some easier hooks for formatting
list
andtheorem
environments are provided while people can still useamsthm.sty
package. natbib.sty
is the main citation processing package which can comprehensively handle all kinds of citations and works perfectly withhyperref.sty
in combination withhypernat.sty
.- Long title pages are processed correctly in preprint and final formats.
Installation
The package is available at author resources page at Elsevier Science.
It can also be found in any of the nodes of the Comprehensive TeX Archive Network (CTAN), one of the primary nodes being http://www.ctan.org. Please grab the elsarticle.dtx
which is the composite class with documentation and elsarticle.ins
which is the LaTeX installer file. When we compile the elsarticle.ins
with LaTeX it provides the class file, elsarticle.cls
by stripping off all the documentation from the *.dtx
file. The class may be moved or copied to a place, usually, $TEXMF/tex/latex/elsevier/
, or a folder which will be read by LaTeX during document compilation. The TeX file database needs updation after moving/copying class file. Usually, we use commands like mktexlsr
or texhash
depending upon the distribution and operating system.
Usage
The class should be loaded with the command: <geshi lang="latex">
\documentclass[<options>]{elsarticle}
</geshi>
where the options
can be the following:
preprint
- default options which formats the document for submission to Elsevier journals.
review
- similar to preprint option, but increases the baselineskip to facilitate easier review process.
1p
- formats to the look and feel of the final format of model 1+ journals. This is always single column style.
3p
- formats to the look and feel of the final format of model 3+ journals. If the journal is a two column model use
twocolumn
option in combination. 5p
- formats for model 5+ journals. This is always two column style.
authoryear
- author-year citation style of
natbib.sty
. If you want to add extra options ofnatbib.sty
, you may use the options as a comma delimited strings as argument to\biboptions
command. An example would be:
<geshi lang="latex">
\biboptions{longnamesfirst,angle,semicolon}
</geshi>
number
- numbered citation style. Extra options can be loaded with
\biboptions
command. longtitle
- if front matter is unusually long, use this option to split the title page across pages with correct placing of title and author footnotes in the first page.
times
- loads
txfonts.sty
if available in the system to use Times and compatible math fonts.
- All options of
article.cls
can be used with this document class. - The default options loaded are
a4paper
,10pt
,oneside
,onecolumn
andpreprint
.
Preamble
There are two types of preamble coding — (1) each author is connected to an affiliation with a footnote marker; hence all authors are grouped together and affiliations follow; (2) authors of same affiliations are grouped together and the relevant affiliation follows this group. An example coding of the first type is provided below:
<geshi lang="latex">
\title{This is a specimen title\tnoteref{t1,t2}} \tnotetext[t1]{This document is a collaborative effort.} \tnotetext[t2]{The second title footnote which is a longer longer than the first one and with an intention to fill in up more than one line while formatting.}
\author[rvt]{C.V.~Radhakrishnan\corref{cor1}\fnref{fn1}} \ead{cvr@river-valley.com}
\author[rvt,focal]{K.~Bazargan\fnref{fn2}} \ead{kaveh@river-valley.com}
\author[els]{S.~Pepping\corref{cor2}\fnref{fn1,fn3}} \ead[url]{http://www.elsevier.com}
\cortext[cor1]{Corresponding author} \cortext[cor2]{Principal corresponding author} \fntext[fn1]{This is the specimen author footnote.} \fntext[fn2]{Another author footnote, but a little more longer.} \fntext[fn3]{Yet another author footnote. Indeed, you can have any number of author footnotes.}
\address[rvt]{River Valley Technologies, SJP Building, Cotton Hills, Trivandrum, Kerala, India 695014} \address[focal]{River Valley Technologies, 9, Browns Court, Kennford, Exeter, United Kingdom} \address[els]{Central Application Management, Elsevier, Radarweg 29, 1043 NX\\ Amsterdam, Netherlands}
</geshi>