alpar@0: %% alpar@0: %% Copyright 2007, 2008, 2009 Elsevier Ltd alpar@0: %% alpar@0: %% This file is part of the 'Elsarticle Bundle'. alpar@0: %% --------------------------------------------- alpar@0: %% alpar@0: %% It may be distributed under the conditions of the LaTeX Project Public alpar@0: %% License, either version 1.2 of this license or (at your option) any alpar@0: %% later version. The latest version of this license is in alpar@0: %% http://www.latex-project.org/lppl.txt alpar@0: %% and version 1.2 or later is part of all distributions of LaTeX alpar@0: %% version 1999/12/01 or later. alpar@0: %% alpar@0: %% The list of all files belonging to the 'Elsarticle Bundle' is alpar@0: %% given in the file `manifest.txt'. alpar@0: %% alpar@0: \documentclass[a4paper,12pt]{article} alpar@0: alpar@0: \usepackage[xcolor,qtwo]{rvdtx} alpar@0: \usepackage{multicol} alpar@0: \usepackage{color} alpar@0: \usepackage{xspace} alpar@0: \usepackage{pdfwidgets} alpar@0: \usepackage{enum} alpar@0: alpar@0: \def\ttdefault{cmtt} alpar@0: alpar@0: \headsep4pc alpar@0: alpar@0: \makeatletter alpar@0: \def\bs{\expandafter\@gobble\string\\} alpar@0: \def\lb{\expandafter\@gobble\string\{} alpar@0: \def\rb{\expandafter\@gobble\string\}} alpar@0: \def\@pdfauthor{C.V.Radhakrishnan} alpar@0: \def\@pdftitle{elsarticle.cls -- A documentation} alpar@0: \def\@pdfsubject{Document formatting with elsarticle.cls} alpar@0: \def\@pdfkeywords{LaTeX, Elsevier Ltd, document class} alpar@0: \def\file#1{\textsf{#1}\xspace} alpar@0: alpar@0: %\def\LastPage{19} alpar@0: alpar@0: \DeclareRobustCommand{\LaTeX}{L\kern-.26em% alpar@0: {\sbox\z@ T% alpar@0: \vbox to\ht\z@{\hbox{\check@mathfonts alpar@0: \fontsize\sf@size\z@ alpar@0: \math@fontsfalse\selectfont alpar@0: A\,}% alpar@0: \vss}% alpar@0: }% alpar@0: \kern-.15em% alpar@0: \TeX} alpar@0: \makeatother alpar@0: alpar@0: \def\figurename{Clip} alpar@0: alpar@0: \begin{document} alpar@0: alpar@0: \def\testa{This is a specimen document. } alpar@0: \def\testc{\testa\testa\testa\testa} alpar@0: \def\testb{\testc\testc\testc\testc\testc} alpar@0: \long\def\test{\testb\par\testb\par\testb\par} alpar@0: alpar@0: \pinclude{\copy\contbox\printSq{\LastPage}} alpar@0: alpar@0: \title{elsarticle.cls -- A better way to format your document} alpar@0: alpar@0: \author{Elsevier Ltd} alpar@0: \contact{elsarticle@river-valley.com} alpar@0: alpar@0: \version{1.20} alpar@0: \date{\today} alpar@0: \maketitle alpar@0: alpar@0: \section{Introduction} alpar@0: %\hypertarget{introduction}{} alpar@0: alpar@0: \file{elsarticle.cls} is a thoroughly re-written document class alpar@0: for formatting \LaTeX{} submissions to Elsevier journals. alpar@0: The class uses the environments and commands defined in \LaTeX{} kernel alpar@0: without any change in the signature so that clashes with other alpar@0: contributed \LaTeX{} packages such as \file{hyperref.sty}, alpar@0: \file{preview-latex.sty}, etc., will be minimal. alpar@0: \file{elsarticle.cls} is primarily built upon the default alpar@0: \file{article.cls}. This class depends on the following packages alpar@0: for its proper functioning: alpar@0: alpar@0: \begin{enumerate} alpar@0: \item \file{pifont.sty} for openstar in the title footnotes; alpar@0: \item \file{natbib.sty} for citation processing; alpar@0: \item \file{geometry.sty} for margin settings; alpar@0: \item \file{fleqn.clo} for left aligned equations; alpar@0: \item \file{graphicx.sty} for graphics inclusion; alpar@0: \item \file{txfonts.sty} optional font package, if the document is to alpar@0: be formatted with Times and compatible math fonts; alpar@0: \item \file{hyperref.sty} optional packages if hyperlinking is alpar@0: required in the document. alpar@0: alpar@0: \end{enumerate} alpar@0: alpar@0: All the above packages are part of any standard \LaTeX{} installation. alpar@0: Therefore, the users need not be bothered about downloading any alpar@0: extra packages. Furthermore, users are free to make use of \textsc{ams} alpar@0: math packages such as \file{amsmath.sty}, \file{amsthm.sty}, alpar@0: \file{amssymb.sty}, \file{amsfonts.sty}, etc., if they want to. All alpar@0: these packages work in tandem with \file{elsarticle.cls} without alpar@0: any problems. alpar@0: alpar@0: \section{Major Differences} alpar@0: %\hypertarget{majordifferences}{} alpar@0: alpar@0: Following are the major differences between \file{elsarticle.cls} alpar@0: and its predecessor package, \file{elsart.cls}: alpar@0: alpar@0: \begin{enumerate}[\textbullet] alpar@0: \item \file{elsarticle.cls} is built upon \file{article.cls} alpar@0: while \file{elsart.cls} is not. \file{elsart.cls} redefines alpar@0: many of the commands in the \LaTeX{} classes/kernel, which can alpar@0: possibly cause surprising clashes with other contributed alpar@0: \LaTeX{} packages; alpar@0: alpar@0: \item provides preprint document formatting by default, and alpar@0: optionally formats the document as per the final alpar@0: style of models $1+$, $3+$ and $5+$ of Elsevier journals; alpar@0: alpar@0: \item some easier ways for formatting \verb+list+ and alpar@0: \verb+theorem+ environments are provided while people can still alpar@0: use \file{amsthm.sty} package; alpar@0: alpar@0: \item \file{natbib.sty} is the main citation processing package alpar@0: which can comprehensively handle all kinds of citations and alpar@0: works perfectly with \file{hyperref.sty} in combination with alpar@0: \file{hypernat.sty}; alpar@0: alpar@0: \item long title pages are processed correctly in preprint and alpar@0: final formats. alpar@0: alpar@0: \end{enumerate} alpar@0: alpar@0: \section{Installation} alpar@0: %\hypertarget{installation}{} alpar@0: alpar@0: The package is available at author resources page at Elsevier alpar@0: (\url{http://www.elsevier.com/locate/latex}). alpar@0: It can also be found in any of the nodes of the Comprehensive alpar@0: \TeX{} Archive Network (\textsc{ctan}), one of the primary nodes alpar@0: being alpar@0: \url{http://www.ctan.org/tex-archive/macros/latex/contrib/elsevier/}. alpar@0: Please download the \file{elsarticle.dtx} which is a composite alpar@0: class with documentation and \file{elsarticle.ins} which is the alpar@0: \LaTeX{} installer file. When we compile the alpar@0: \file{elsarticle.ins} with \LaTeX{} it provides the class file, alpar@0: \file{elsarticle.cls} by alpar@0: stripping off all the documentation from the \verb+*.dtx+ file. alpar@0: The class may be moved or copied to a place, usually, alpar@0: \verb+$TEXMF/tex/latex/elsevier/+, %$%%%%%%%%%%%%%%%%%%%%%%%%%%%% alpar@0: or a folder which will be read alpar@0: by \LaTeX{} during document compilation. The \TeX{} file alpar@0: database needs updation after moving/copying class file. Usually, alpar@0: we use commands like \verb+mktexlsr+ or \verb+texhash+ depending alpar@0: upon the distribution and operating system. alpar@0: alpar@0: alpar@0: \section{Usage}\label{sec:usage} alpar@0: %\hypertarget{usage}{} alpar@0: The class should be loaded with the command: alpar@0: alpar@0: \begin{vquote} alpar@0: \documentclass[]{elsarticle} alpar@0: \end{vquote} alpar@0: alpar@0: \noindent where the \verb+options+ can be the following: alpar@0: alpar@0: \begin{description} alpar@0: alpar@0: \item [{\tt\color{verbcolor} preprint}] default option which format the alpar@0: document for submission to Elsevier journals. alpar@0: alpar@0: \item [{\tt\color{verbcolor} review}] similar to the \verb+preprint+ option, but alpar@0: increases the baselineskip to facilitate easier review process. alpar@0: alpar@0: \item [{\tt\color{verbcolor} 1p}] formats the article to the look and feel of the final alpar@0: format of model 1+ journals. This is always single column style. alpar@0: alpar@0: \item [{\tt\color{verbcolor} 3p}] formats the article to the look and feel of the final alpar@0: format of model 3+ journals. If the journal is a two column alpar@0: model, use \verb+twocolumn+ option in combination. alpar@0: alpar@0: \item [{\tt\color{verbcolor} 5p}] formats for model 5+ journals. This is always alpar@0: of two column style. alpar@0: alpar@0: \item [{\tt\color{verbcolor} authoryear}] author-year citation style of alpar@0: \file{natbib.sty}. If you want to add extra options of alpar@0: \file{natbib.sty}, you may use the options as comma delimited alpar@0: strings as arguments to \verb+\biboptions+ command. An example alpar@0: would be: alpar@0: \end{description} alpar@0: \begin{vquote} alpar@0: \biboptions{longnamesfirst,angle,semicolon} alpar@0: \end{vquote} alpar@0: alpar@0: \begin{description} alpar@0: \item [{\tt\color{verbcolor} number}] numbered citation style. Extra options alpar@0: can be loaded with\linebreak \verb+\biboptions+ command. alpar@0: alpar@0: \item [{\tt\color{verbcolor} sort\&compress}] sorts and compresses the alpar@0: numbered citations. For example, citation [1,2,3] will become [1--3]. alpar@0: alpar@0: \item [{\tt\color{verbcolor} longtitle}] if front matter is unusually long, use alpar@0: this option to split the title page across pages with the correct alpar@0: placement of title and author footnotes in the first page. alpar@0: alpar@0: \item [{\tt\color{verbcolor} times}] loads \file{txfonts.sty}, if available in alpar@0: the system to use Times and compatible math fonts. alpar@0: alpar@0: \item[] All options of \file{article.cls} can be used with this alpar@0: document class. alpar@0: alpar@0: \item[] The default options loaded are \verb+a4paper+, \verb+10pt+, alpar@0: \verb+oneside+, \verb+onecolumn+ and \verb+preprint+. alpar@0: alpar@0: \end{description} alpar@0: alpar@0: \section{Frontmatter} alpar@0: %\hypertarget{preamble}{} alpar@0: alpar@0: There are two types of frontmatter coding: alpar@0: \begin{enumerate}[(1)] alpar@0: \item each author is alpar@0: connected to an affiliation with a footnote marker; hence all alpar@0: authors are grouped together and affiliations follow; alpar@0: \item authors of same affiliations are grouped together and the alpar@0: relevant affiliation follows this group. An example coding of the first alpar@0: type is provided below. alpar@0: \end{enumerate} alpar@0: alpar@0: \begin{vquote} alpar@0: \title{This is a specimen title\tnoteref{t1,t2}} alpar@0: \tnotetext[t1]{This document is a collaborative effort.} alpar@0: \tnotetext[t2]{The second title footnote which is a longer alpar@0: longer than the first one and with an intention to fill alpar@0: in up more than one line while formatting.} alpar@0: \end{vquote} alpar@0: alpar@0: \begin{vquote} alpar@0: \author[rvt]{C.V.~Radhakrishnan\corref{cor1}\fnref{fn1}} alpar@0: \ead{cvr@river-valley.com} alpar@0: alpar@0: \author[rvt,focal]{K.~Bazargan\fnref{fn2}} alpar@0: \ead{kaveh@river-valley.com} alpar@0: alpar@0: \author[els]{S.~Pepping\corref{cor2}\fnref{fn1,fn3}} alpar@0: \ead[url]{http://www.elsevier.com} alpar@0: \end{vquote} alpar@0: alpar@0: \begin{vquote} alpar@0: \cortext[cor1]{Corresponding author} alpar@0: \cortext[cor2]{Principal corresponding author} alpar@0: \fntext[fn1]{This is the specimen author footnote.} alpar@0: \fntext[fn2]{Another author footnote, but a little more alpar@0: longer.} alpar@0: \fntext[fn3]{Yet another author footnote. Indeed, you can have alpar@0: any number of author footnotes.} alpar@0: alpar@0: \address[rvt]{River Valley Technologies, SJP Building, alpar@0: Cotton Hills, Trivandrum, Kerala, India 695014} alpar@0: \address[focal]{River Valley Technologies, 9, Browns Court, alpar@0: Kennford, Exeter, United Kingdom} alpar@0: \address[els]{Central Application Management, alpar@0: Elsevier, Radarweg 29, 1043 NX\\ alpar@0: Amsterdam, Netherlands} alpar@0: alpar@0: \end{vquote} alpar@0: alpar@0: The output of the above TeX source is given in Clips~\ref{clip1} and alpar@0: \ref{clip2}. The header portion or title area is given in Clip~\ref{clip1} and alpar@0: the footer area is given in Clip~\ref{clip2}. alpar@0: alpar@0: \vspace*{6pt} alpar@0: \def\rulecolor{blue!70} alpar@0: \src{Header of the title page.} alpar@0: \includeclip{1}{132 571 481 690}{els1.pdf} alpar@0: \def\rulecolor{orange} alpar@0: alpar@0: %\vspace*{6pt} alpar@0: \def\rulecolor{blue!70} alpar@0: \src{Footer of the title page.} alpar@0: \includeclip{1}{122 129 481 237}{els1.pdf} alpar@0: \def\rulecolor{orange} alpar@0: \pagebreak alpar@0: alpar@0: Most of the commands such as \verb+\title+, \verb+\author+, alpar@0: \verb+\address+ are self explanatory. Various components are alpar@0: linked to each other by a label--reference mechanism; for alpar@0: instance, title footnote is linked to the title with a footnote alpar@0: mark generated by referring to the \verb+\label+ string of alpar@0: the \verb=\tnotetext=. We have used similar commands alpar@0: such as \verb=\tnoteref= (to link title note to title); alpar@0: \verb=\corref= (to link corresponding author text to alpar@0: corresponding author); \verb=\fnref= (to link footnote text to alpar@0: the relevant author names). \TeX{} needs two compilations to alpar@0: resolve the footnote marks in the preamble part. alpar@0: Given below are the syntax of various note marks and note texts. alpar@0: alpar@0: \begin{vquote} alpar@0: \tnoteref{} alpar@0: \corref{} alpar@0: \fnref{} alpar@0: \tnotetext[