Skip to content

Writing a paper in LaTeX: resources

jacow.cls

Most important thing of all: use the latest jacow.cls file.

It may be that your LaTeX distribution includes it already but in an older version. If in doubt, download it from the JACoW github repository and install it in your distribution's TEXMFHOME directory.

How to use lowercase letters in title and section headings

The jacow.cls class file defines commands like \title and \section which go into structuring your document. These commands force their text to be UPPERCASE. If you need include lowercase letters (e.g. for special acronyms or units) please use the \NoCaseChange command.

Examples

\title{The 3 \NoCaseChange{GeV} Taiwan Light Source}

renders: THE 3 GeV TAIWAN LIGHT SOURCE

\section{RF Shielding at \NoCaseChange{SPring-8}}

renders: RF SHIELDING AT SPring-8

Typesetting units

Numbers and units are typeset with the thin space between them, this should preferably an non-breaking space to insure that number and unit are not split over line breaks or column/page breaks. A thin space is entered in LATEX using \,. The alternative is to use the siunitx package (preloaded in jacow.cls) with \SI{<number>}{<unit>}.

The numerical value always precedes the unit, and a space is always used to separate the unit from the number, e. g. 10.2 m (not 10.2m).

The same should be done with temperature degrees: 30.2 °C (not 30.2°C or 30.2° C).

The only exceptions to this rule are for the unit symbols for degree, minute, and second for plane angle (°, ', and ", respectively), for which no space is left between the numerical value and the unit symbol.

Examples

  • \qty[]{10}{\um} or \qty[]{10}{\micro\meter} - required way to get an upright unit

  • \qty[]{10}{m} will give optimised spacing (thin space) between digit and unit

  • 10\,m (rather than 10 m) alternative way to siunitx

  • Exceptions: 10\,$^{\circ}$C renders 10 °C

    • \usepackage{gensymb} → \degree

    • \usepackage{textcomp} → \textdegree

References

Example of correct use of references in LaTeX:

\begin{thebibliography}{9}     %% use {99} for 10+ references!

  \bibitem{Author:IJC99-MONA2}
    A.N. Author \emph{et al.},
    ``Title of the paper’’,
    in \emph{Proc. IJC’99}, Nowhere, XY, May 2099, pp. 199--201.\\
    \url{doi:10.18429/JACoW-IJC2099-MONA2}

\end{thebibliography}

Renders:

[1] A.N. Author et al., ``Title of the paper’’, in Proc. IJC’99, Nowhere, XY, May 2099, pp. 199--201. doi:10.18429/JACoW-IJC2099-MONA2

Note: referenced titles should be in Sentence case, not Title Case.

BibLaTeX

BibLaTeX can be use with BibTeX or Biber. As the automatically formatted output of BibLaTeX + Biber is superior to all other ways of generating a bibliography, this is recommended. If the requested formatting cannot be achieved, using BibTeX and pasting the final outcome into the source is a possibility.

The following magic comments are understood by most TeX-editors (e.g. TeXStudio, TeXnicCenter, TeXWorks). They are placed before the opening \documentclass[]{} command and overwrite settings in the TeX-editor:

% !BIB TS-program = biber/bibtex
% !BIB program = biber/bibtex
% !TeX spellcheck = en_GB/en_US
% !TeX program = pdflatex/lualatex/xetex
% !TEX TS-program = pdflatex/lualatex/xetex
% !TeX encoding = utf8/IsoLatin/IsoLatin
% !TEX root = <main file name>

TextMate, SublimeText, Atom, vimtex, and Overleaf understand some of the magic comments.

References to a published JACoW paper

Please note the peculiar use of venue and year for a correct rendering:

@inproceedings{xiang:ipac2022-thpopt022,
  author = {R. Xiang and A. Arnold and S. Ma and P. Michel and P. Murcek and A.A. Ryzhov and J. Schaber and J. Teichert and P.Z. Zwartek},
  title = {{Study on QE evolution of Cs₂Te photocathodes in ELBE SRF Gun-II}},
  booktitle = {Proc. IPAC'22},
  %booktitle = {Proc. 13th International Particle Accelerator Conference (IPAC'22)},
  pages = {2617--2619},
  %eid = {THPOPT022},
  language = {english},
  keywords = {cathode, gun, SRF, operation, vacuum},
  venue = {Bangkok, Thailand, May 2022},
  series = {International Particle Accelerator Conference},
  number = {13},
  publisher = {JACoW Publishing, Geneva, Switzerland},
  month = {05},
  %year = {2022},
  issn = {2673-5490},
  isbn = {978-3-95450-227-1},
  doi = {10.18429/JACoW-IPAC2022-THPOPT022},
  url = {https://jacow.org/ipac2022/papers/thpopt022.pdf},
  abstract = {{...}},
}

In fact, the "standard way" with:

venue = {Bangkok, Thailand},
year = {2022}
month={05}
eid ={THPOPT022}

would render:

[14] R. Xiang et al., “Study on QE evolution of Cs2Te photocathodes in ELBE SRF Gun-II,” in Proc. IPAC’22, Bangkok, Thailand, 2022, paper THPOPT022, pp. 2617–2619. doi:10.18429/JACoW-IPAC2022-THPOPT022

By fine-tuning our .bib file:

venue = {Bangkok, Thailand, May 2022},
%year = {2022}
%eid ={THPOPT022}

we get the correct format:

[14] R. Xiang et al., “Study on QE evolution of Cs2Te photocathodes in ELBE SRF Gun-II,” in Proc. IPAC’22, Bangkok, Thailand, May 2022, pp. 2617–2619. doi:10.18429/JACoW-IPAC2022-THPOPT022

References to papers presented at the current conference in BibLaTeX

The following Bib-entries should be used for BibLaTeX to correctly reference papers presented at the current conference:

@article{bib-key,
  title = "{Title of the paper presented at...}",
  author = {Author, A. N. and Somebody, E.L.S.E.},
  journal = {\normalfont{presented at the 99th International JACoW
Conference (IJC'99), Nowhere, XY}},
  year = {May 2099, paper MONA2, this conference},
}

In abbreviated form:

@article{bib-key,
  title = "{Title of the paper presented at...}",
  author = {Author, A. N. and Somebody, E.L.S.E.},
  journal = {\normalfont{presented at IJC'99, Nowhere, XY}},
  year = {May 2099, paper MONA2, this conference},

Other tricks

  • When using \usepackage{authblk} you probably see a spacing between author and affiliation block. This can be suppressed using \setlength{\affilsep}{0pt} If there is a , and before the last author’s name, this can be suppressed using \renewcommand\Authsep{, }

  • Equation formatting: the JACoW template requires the equation numbers to be put inside parenthesis. This can easily achieved using \eqref{label} instead of (\ref{label})

Resources