%% %% This is file `elsdoc.tex', %% generated with the docstrip utility. %% %% The original source files were: %% %% elsarticle.dtx (with options: `mydoc') %% %% Copyright 2007, 2008 Elsevier Ltd. %% %% This file is part of the 'Elsarticle Bundle'. %% ------------------------------------------- %% %% It may be distributed under the conditions of the LaTeX Project Public %% License, either version 1.2 of this license or (at your option) any %% later version. The latest version of this license is in %% http://www.latex-project.org/lppl.txt %% and version 1.2 or later is part of all distributions of LaTeX %% version 1999/12/01 or later. %% %% The list of all files belonging to the 'Elsarticle Bundle' is %% given in the file `manifest.txt'. %% \documentclass[a4paper,12pt]{article} \usepackage{amsfonts} \usepackage[pdftex,screen,vpanel]{docscreen} \panelwidth=5in \vpanelheight=1.25in \margins{1.5cm}{1cm}{1.25cm}{1.25cm} \screensize{210mm}{297mm} \vpaneloverlay{bg_body1.jpg} \usepackage{pxfonts} \usepackage{charter} \usepackage[scaled=.9]{lfr} \usepackage[scaled=.8]{prima} \usepackage{xspace} \usepackage{pdfwidgets} \makeatletter \def\bs{\expandafter\@gobble\string\\} \def\lb{\expandafter\@gobble\string\{} \def\rb{\expandafter\@gobble\string\}} \def\@pdfauthor{C.V.Radhakrishnan} \def\@pdftitle{elsarticle.cls -- A documentation} \def\@pdfsubject{Document formatting with elsarticle.cls} \def\@pdfkeywords{LaTeX, Elsevier Ltd., document class} \def\file#1{\textsf{#1}\xspace} \def\Hlink#1#2{\hyperlink{#1}{{\sffamily\color{brown}#2}}} \def\LastPage{19} \DeclareRobustCommand{\LaTeX}{L\kern-.26em% {\sbox\z@ T% \vbox to\ht\z@{\hbox{\check@mathfonts \fontsize\sf@size\z@ \math@fontsfalse\selectfont A\,}% \vss}% }% \kern-.15em% \TeX} \makeatother \usepackage{doc-tooltips} \begin{document} \newbox\contbox \global\setbox\contbox=\vbox{\hsize=108mm \color{orange} \begin{enumerate}[$\square$] \item \Hlink{introduction}{Introduction} \item \Hlink{majordifferences}{Major Differences} \item \Hlink{installation}{Installation} \item \Hlink{usage}{Usage} \item \Hlink{preamble}{Preamble} \item \Hlink{floats}{Floats} \item \Hlink{theorems}{Theorems} \item \Hlink{lists}{Lists} \item \Hlink{crossreferences}{Cross-references} \item \Hlink{math}{Mathematical Symbols and Formulae} \item \Hlink{bibliography}{Bibliography} \item \Hlink{final}{Final Print} \end{enumerate}\par\vspace{45mm} \footnotesize\parindent=0pt \color{Olive}% \copyright 2008, Elsevier Ltd. Bugs, feature requests, suggestions and comments shall be mailed to \href{mailto:elsarticle@river-valley.com} {\texttt{}}. \file{elsarticle.\allowbreak [dtx,ins]}, related documentation and supporting packages are released under \LaTeX{} Project Public Licence, either version 1.2 or any later version. This work has the LPPL maintenance status `author-maintained'.\par\vskip6pt \noindent } \def\testa{This is a specimen document. } \def\testc{\testa\testa\testa\testa} \def\testb{\testc\testc\testc\testc\testc} \long\def\test{\testb\par\testb\par\testb\par} \pinclude{\copy\contbox\printSq{\LastPage}} \normalcolor \section{Introduction} \hypertarget{introduction}{} \file{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 \file{hyperref.sty}, \file{preview-latex.sty}, etc., will be minimal. \file{elsarticle.cls} is primarily built upon the default \file{article.cls}. The class depends on the following packages for its proper functionality: \begin{enumerate}[1.] \item \file{pifont.sty} for openstar in the title footnotes. \item \file{natbib.sty} for citation processing. \item \file{geometry.sty} for margin settings. \item \file{fleqn.clo} for left aligned equations. \item \file{graphicx.sty} for graphics inclusion. \item \file{txfonts.sty} optional font package, if document is to be formatted with Times and compatible math fonts. \item \file{hyperref.sty} optional packages if hyper linking is required in the document. \end{enumerate} 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, \file{amsmath.sty}, \file{amsthm.sty}, \file{amssymb.sty}, \file{amsfonts.sty}, etc., if they want. All these packages work in tandem with \file{elsarticle.cls} without any problems. \section{Major Differences} \hypertarget{majordifferences}{} Following are the major differences between \file{elsarticle.cls} and its predecesor package, \file{elsart.cls}: \begin{enumerate}[\textbullet] \item \file{elsarticle.cls} is built upon \file{article.cls} while \file{elsart.cls} is not. \file{elsart.cls} redefines many of the commands in the \LaTeX{} classes/kernel, which can possibly cause surprising clashes with other contributed \LaTeX{} packages. \item Provides preprint document formatting by default, and optionally formats the document as per the final style of models $1+$, $3+$ and $5+$ of Elsevier journals. \item Some easier hooks for formatting \verb+list+ and \verb+theorem+ environments are provided while people can still use \file{amsthm.sty} package. \item \file{natbib.sty} is the main citation processing package which can comprehensively handle all kinds of citations and works perfectly with \file{hyperref.sty} in combination with \file{hypernat.sty}. \item Long title pages are processed correctly in preprint and final formats. \end{enumerate} \section{Installation} \hypertarget{installation}{} The package is available at \url{http://www.elsevier.com/locate/latex}. It can also be found in any of the nodes of the Comprehensive \TeX{} Archive Network (\textsc{ctan}), one of the primary nodes being \url{http://www.ctan.org/tex-archive/macros/latex/contrib/elsevier/}. Please grab the \file{elsarticle.dtx} which is the composite class with documentation and \file{elsarticle.ins} which is the \LaTeX{} installer file. When we compile the \file{elsarticle.ins} with \LaTeX{} it provides the class file, \file{elsarticle.cls} by stripping off all the documentation from the \verb+*.dtx+ file. The class may be moved or copied to a place, usually, \texttt{\$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 \verb+mktexlsr+ or \verb+texhash+ depending upon the distribution and operating system. \section{Usage}\label{sec:usage} \hypertarget{usage}{} The class should be loaded with the command: \begin{vquote} \documentclass[]{elsarticle} \end{vquote} where the \verb+options+ can be the following: \begin{enumerate}[(1)] \item \verb+preprint+ --- default options which formats the document for submission to Elsevier journals. \item \verb+review+ --- similar to \verb+preprint+ option, but increases the baselineskip to facilitate easier review process. \item \verb+1p+ --- formats to the look and feel of the final format of model 1+ journals. This is always single column style. \item \verb+3p+ --- formats to the look and feel of the final format of model 3+ journals. If the journal is a two column model use \verb+twocolumn+ option in combination. \item \verb+5p+ --- formats for model 5+ journals. This is always two column style. \item \verb+authoryear+ --- author-year citation style of \file{natbib.sty}. If you want to add extra options of \file{natbib.sty}, you may use the options as a comma delimited strings as argument to \verb+\biboptions+ command. An example would be: \end{enumerate} \begin{vquote} \biboptions{longnamesfirst,angle,semicolon} \end{vquote} \begin{enumerate}[(1)] \setcounter{enumi}{6} \item \verb+number+ --- numbered citation style. Extra options can be loaded with \verb+\biboptions+ command. \item \verb+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. \item \verb+times+ --- loads \file{txfonts.sty} if available in the system to use Times and compatible math fonts. \item All options of \file{article.cls} can be used with this document class. \item The default options loaded are \verb+a4paper+, \verb+10pt+, \verb+oneside+, \verb+onecolumn+ and \verb+preprint+. \end{enumerate} \section{Preamble} \hypertarget{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: \begin{vquote} \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.} \end{vquote} \begin{vquote} \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} \end{vquote} \begin{vquote} \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.} \end{vquote} \begin{vquote} \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} \end{vquote} You can see the output in the panel to the right. \mywidth=.7\panelwidth \Sep=8pt \def\rulewidth{.2pt} \def\rulecolor{orange} \npskip=8mm \pinclude{\def\rulecolor{blue!80}% \includeclip[width=3.25in]{1}{130 84 484 676}{els1.pdf}% \def\rulecolor{orange}} Most of the commands like \verb+\title+, \verb+\author+, \verb+\address+ are self explanatory. Various components are linked each other by a label--reference mechanism, for instance, title footnote is linked to the title with a footnote mark generated by referring to the \verb+\label+ string of the \verb=\tnotetext=. We have used similar commands like \verb=\tnoteref= (to link title note to title); \verb=\corref= (to link corresponding author text to corresponding author); \verb=\fnref= (to link footnote text to the relevant author names). \TeX{} needs two compilations to resolve the footnote marks in the preamble part. Given below are the syntax of various note marks and note texts. \begin{vquote} \tnoteref{} \corref{} \fnref{} \tnotetext[