Cuparticle.cls

From RVTsupport

Jump to: navigation, search

<Main Page

[LaTeX Tutorial]


Contents

cuparticle.cls - A new classfile for creating preprints for CUP journals

Introduction

cuparticle.cls is a thoroughly rewritten document class for formatting LaTeX submissions to Cambridge University Press (CUP) journals. This class uses the environments and commands defined in the LaTeX kernel without any change in the signature so that clashes with other contributed LaTeX packages such as hyperref.sty, preview-latex.sty, etc. will be minimal. cuparticle.cls is primarily built upon the default article.cls. This class depends on the following packages for its proper functioning:

  1. natbib.sty for citation processing;
  2. geometry.sty for margin settings;
  3. fleqn.clo for left aligned equations;
  4. graphicx.sty for graphics inclusion;
  5. txfonts.sty optional font package, if the document is to be formatted with Times and compatible math fonts;
  6. hyperref.sty optional packages if hyperlinking is required in the document;
  7. textcase.sty changing text (only) upper/lower case;
  8. xspace.sty put space after command;
  9. xcolor.sty for give textcolor.

All the above packages are part of any standard LaTeX installation. Therefore, the users need not be bothered about downloading any extra packages. Furthermore, users are free to make use of AMS math packages such as amsmath.sty, amsthm.sty, amssymb.sty, amsfonts.sty, etc., if they want to. All these packages work in tandem with cuparticle.cls without any problems.


Usage

The class should be loaded with the command:

 \documentclass[<options>]{cuparticle}

where the options can be the following:

preprint
default option which format the document for submission to CUP journals.
nopreprintline
Suppresses the preprint line in the title page.
review
similar to the preprint option, but increases the baselineskip to facilitate an easier review process.
fms
formats the article for the submission to `Forum Maths Sigma' journal.
fmpi
formats the article for the submission to `Forum Maths Pi' journal.
footmarks
print footnote marks for title and author footnotes. The default style is no footnote marks.
authoryear
author–year citation style of natbib.sty. If you want to add extra options of natbib.sty, you may use the options as comma delimited strings as arguments to the \biboptions command. An example would be:

 \biboptions{longnamesfirst,angle,semicolon}
number
numbered citation style which is the default. Extra options can be loaded with \biboptions command.
sort&compress
sorts and compresses the numbered citations. For example, citation [1,2,3] will become [1-3].
longtitle
if front matter is unusually long, use this option to split the title page across pages with the correct placement 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 a5paper, 10pt, oneside, onecolumn and preprint.

Front matter

\title{LaTeX TEMPLATE FOR AUTHORS}
\tnotemark[1]

\author{Kaveh~Bazargan}
\ead{kaveh@river-valley.com} 
 
\address{River Valley Technologies, 9, Browns Court,
    Kennford, Exeter, United Kingdom}

\author{C.V.~Radhakrishnan}
\fnmark[1]
\ead{cvr@river-valley.com}
 
\author{C.V.~Rajagopal}
\ead{cvr3@river-valley.com}
 
\address{River Valley Technologies, River Valley Campus, Malayinkil,
Trivandum 695571, India}

\author{Duncan~Yardy}
\ead{dyardy@cambridge.org}
 
\address{Cambridge University Press, Shaftesbury Road, Cambridge CB2 8RU, 
United Kingdom}

\cortext[1]{Corresponding author}
\tnotetext[1]{This is a tnote text}
\fntext[1]{Author footnote}

The output of the above TeX sources will look like the following:

Image:cuparticle-title-author.png

The authors and their affiliations including email ids are printed at the end of the document.

Image: cuparticle-author-affiliations.png

Following commands print short author list and title in running head of each pages.

 \authorheadline{...}
 \runningtitle{...}

Title footnotes are coded as:

 \tnotemark[1]
 \tnotetext[1]{....} 

Author footnotes are coded as:

 \fnmark[1]
 \fntext[1]

Corresponding author is indicated as:

 \cormark[1]
 \cortext[1]{...}


The front matter part has further environments such as \begin{abstract} . . . \end{abstract} and \begin{keyword} ... \end{keyword} which contain the abstract and keywords respectively. Keywords can be marked up in the following manner:

\MSC[2010]{\primary 000\sep 111\secondary 1111}
\begin{keyword}
  quadruple exiton \sep polariton \sep WGM
\end{keyword}

Each keyword shall be separated by a \sep command. MSC classifications shall be provided in the keyword environment with the commands \MSC. \MSC accepts an optional argument to accommodate future revisions. e.g. \MSC[2012]. The default is 2010.

Specimen of a title page coding

Following is the specimen of a title page coding.

\documentclass[fmpi,times]{cuparticle}
 
%\journal{Journal of Cambridge University Press}
 
\usepackage{amsmath}
 
\newtheorem{theorem}{Theorem}
\newdefinition{definition}{Definition}
\newproof{proof}{Proof}
 
\begin{document}
 
\authorheadline{K. Bazargan \etal}
\runningtitle{{LaTeX template for authors}
 
\begin{frontmatter}
 
\title{LATEX TEMPLATE FOR AUTHORS}
\tnotemark[1]
 
\author{Kaveh~Bazargan}
\ead{kaveh@river-valley.com} 
\address{River Valley Technologies, 9, Browns Court,
    Kennford, Exeter, United Kingdom}
 
\author{C.V.~Rajagopal}
\fnmark[1]
\ead{cvr3@river-valley.com}
 
\author{T. Rishi}
\ead{rishi@river-valley.com}
\address{River Valley Technologies, River Valley Campus, Malayinkil,
Trivandum 695571, India}
 
\author{Duncan~Yardy}
\ead{dyardy@cambridge.org}
\cormark[1]
 
\address{Cambridge University Press,
Shaftesbury Road, Cambridge CB2 8RU, United Kingdom}
 
\tnotetext[1]{This is a tnote text}
\fntext[1]{Author footnote}
\cortext[1]{Corresponding author.}
 
\received{15 October 2012}
 
\begin{abstract}
In this work we demonstrate the formation of a new type of polariton on
the interface between a cuprous oxide slab and a polystyrene
micro-sphere placed on the slab. .....
\end{abstract}
\MSC[2012]{\primary 16W10\sep 16W20; \secondary 16D50.}
\begin{keyword}
quadruple exciton \sep polariton \sep WGM
\end{keyword}
 
\end{frontmatter}
 
\section{Introduction}\label{sec1}
Although quadrupole excitons (QE) in cuprous oxide crystals are good
candidates for BEC... See section \ref{sec1}.

The output of the above coding is


Image: cuparticle-titlepage.png

Floats

Figures may be included using the command, \includegraphics in combination with or without its several options to further control graphics. \includegraphics is provided by graphic[s,x].sty which is part of any standard LaTeX distribution. graphicx.sty is loaded by default. LaTeX accepts figures in the postscript format while pdfLaTeX accepts *.pdf, *.mps (metapost), *.jpg and *.png formats. pdfLaTeX does not accept graphic files in the postscript (EPS) format.

The table environment is handy for marking up tabular material. If users want to use multirow.sty, array.sty, etc., to fine control/enhance the tables, they are welcome to load any package of their choice and cuparticle.cls will work in combination with all loaded packages.

Theorem and theorem-like environments

cuparticle.cls provides a few shortcuts to format theorems and theorem-like environments with ease. In all commands the options that are used with the \newtheorem command will work exactly in the same manner.

\newtheorem{theorem}{Theorem}
\newdefinition{definition}{Definition}
\newproof{proof}{Proof}

The \newtheorem command formats a theorem, lemma etc. in LaTeX's default style with italicized font, bold font for theorem heading and theorem number at the right hand side of the theorem heading. It also optionally accepts an argument which will be printed as an extra heading in parentheses. The following text will show you how some text enclosed in \begin{theorem} . . . \end{theorem} will look like.

The \newdefinition command is the same in all respects as its \newtheorem counterpart except that the font shape is roman instead of italic. Both \newdefinition and \newtheorem commands automatically define counters for the environments defined. See the output of \begin{definition} . . . \end{definition} which is given below.

The \newproof command defines proof environments with upright font shape. No counters are defined. See the output of \begin{proof} . . . \end{proof}.

Image:cuparticle-enun.png

Users can also make use of amsthm.sty which will override all the default definitions described above.

Enumerated and Itemized Lists

cuparticle.cls provides extended list processing macros which makes the usage a bit more user friendly than the default LaTeX list macros. With an optional argument to the \begin{enumerate} command, you can change the list counter type and its attributes.

\begin{enumerate}[1.]
\item The enumerate environment starts with an optional argument `1.', so that the item counter will be suffixed  by a period.
\item If you provide a closing parenthesis to the number in the  optional argument, the output will have closing parentheses for all the item counters.
\item You can use `(a)' for alphabetical counter and '(i)' for  roman counter.
 \begin{enumerate}[a)]
  \item Another level of list with alphabetical counter.
  \item One more item before we start another.
  \begin{enumerate}[(i)]
   \item This item has roman numeral counter.
   \item Another one before we close the third level.
  \end{enumerate}
  \item Third item in second level.
 \end{enumerate}
\item All list items conclude with this step.
\end{enumerate}

The typeset copy of the above source code is given below:

Image:cuparticle-list.png

Furthermore, the enhanced list environment allows one to prefix a string-like `step' to all the item numbers. Take a look at the example below:

\begin{enumerate}[Step 1.]
 \item This is the first step of the example list.
 \item Obviously this is the second step.
 \item The final step to wind up this example.
\end{enumerate}

The typeset copy of the above source code is given below:

Image:cuparticlelist-enh.png

Cross-references

In electronic publications, articles may be internally hyperlinked. Hyperlinks are generated from proper cross-references in the article. For example, the words Fig. 1 will never be more than a simple text, whereas the proper cross-reference \ref{tiger} may be turned into a hyperlink to the figure itself: Fig. 1. In the same way, the words Ref. [1] will fail to turn into a hyperlink; the proper cross-reference is \cite{Knuth96}. Cross-referencing is possible in LaTeX for sections, subsections, formulae, figures, tables, and literature references.

Mathematical symbols and formulae

Many physical/mathematical science authors require more mathematical symbols than the few that are provided in standard LaTeX. A useful package for additional symbols is the amssymb package, developed by the American Mathematical Society. This package includes such oft-used symbols as \lesssim, \gtrsim or \hbar. Note that your TeX system should have the msam and msbm fonts installed. If you need only a few symbols, such as \Box, you might try the package latexsym.

Image:symbol.png

Another point which would require the authors' attention is the breaking up of long equations. When you use elsarticle.cls for formatting your submissions in the preprint mode, the document is formatted in single column style with a text width of 384pt or 5.3in. When this document is formatted for final print and if the journal happens to be a double column journal, the text width will be reduced to 224pt for 3+ double column and 5+ journals respectively. All the nifty fine-tuning in equation breaking done by the author goes to waste in such cases. Therefore, authors are requested to check this problem by typesetting their submissions in the final format as well just to see if their equations are broken at the appropriate places, by changing appropriate options in the document class loading command, which is explained in the section Usage. This allows authors to fix any equation breaking problem before submission for publication. cuparticle.cls supports formatting the author submission in different types of final format. This is further discussed in the section Final print.

Bibliography

In the LaTeX literature, references are listed in the thebibliography environment. Each reference is a \bibitem and each \bibitem is identified by a label, by which it can be cited in the text: \bibitem[Elson et al.(1996)]{ESG96} is cited as \citet{ESG96}. In connection with cross-referencing and possible future hyperlinking it is not a good idea to collect more than one literature item in one \bibitem. The so-called Harvard or author–year style of referencing is enabled by the LaTeX package natbib. With this package the literature can be cited as follows:

  • Parenthetical: \citep{WB96} produces (Wettig & Brown, 1996).
  • Textual: \citet{ESG96} produces Elson et al. (1996).
  • An affix and part of a reference: \citep[e.g.][Ch. 2]{Gea97} produces (e.g. Governato et al., 1997, Ch. 2).

In the numbered scheme of citation, \cite{<label>} is used, since \citep or \citet has no relevance in the numbered scheme. natbib package is loaded by cuparticle.cls with numbers as default options. You can change this to the author–year or harvard scheme by adding option authoryear in the class loading command. If you want to use more options of the natbib package, you can do so with the \biboptions command, which is described in the section Usage. For details of various options of the natbib package, please take a look at the natbib documentation, which is part of any standard LaTeX installation.

Download the cuparticle packages

The following files are available for download:

  1. cuparticle.cls, the class file

Contact

Please write to latex.support@river-valley.com for any help, feedbacks or suggestions.

Personal tools