Jinst Author Manual
User Manual:
Open the PDF directly: View PDF 
.
Page Count: 9
| Download | |
| Open PDF In Browser | View PDF |
Prepared for submission to JINST
JINST: LATEX author’s manual
JINST Editorial Office
SISSA Medialab s.r.l.,
via Bonomea 265, 34136 Trieste Italy
E-mail: jinst-eo@jinst.sissa.it
Abstract: This document provides instructions for using the jinstpub.sty LATEX package along
with some stylistic conventions. For a brief example that can be used as a template / boilerpate
please see the file example.tar.gz available in the documentation archive.
Contents
1
The JINST style package jinstpub.sty
1
2
Title page
2.1 Title
2.2 Authors and affiliations
2.3 E-mails
2.4 Abstract
2.5 Keywords
2.6 Additional information in the title page
1
2
2
3
3
3
4
3
Table of contents
5
4
Body of the paper
4.1 General conventions
4.2 Mathematics
4.3 Tables and figures
5
5
6
7
5
Bibliography
7
1
The JINST style package jinstpub.sty
jinstpub.sty is a LATEX package that is designed to help authors produce preprints in a form
suitable for submission to JINST.
This package should be used with the article documentclass and 11pt,a4paper options:
\documentclass[11pt,a4paper]{article}
\usepackage{jinstpub}
Some useful packages are already included in jinstpub.sty: hyperref, graphicx, amsmath,
amssymb, natbib (options: numbers, sort&compress).
NB:
2
please note that a recent LATEX distribution is required.
Title page
The title page is created by the command \maketitle and can accommodate many details that are
collected by specific macros (see figure 1).
The following sections explain the macros that may be used.
–1–
Prepared for submission to JINST
\title{An example title where \boldmath $x=1$}
An example title where x = 1
A. Author,a B. Authora, b,1 and C. Authora,c
a Institution,
Street number, City, Country
b Department, University,
Street number, City, Country
c Another University,
Street number, City, Country
\author[a]{A.~Author,}
\author[a,b,1]{B.~Author%
\note{Corresponding author.}}
\author[a,c]{and C.~Author}
\affiliation[a]{Institution,\\
Street number, City, Country}
\affiliation[b]{Department, University,\\
Street number, City, Country}
\affiliation[c]{Another University,\\
Street number, City, Country}
E-mail: buthor@univ.country
\emailAdd{buthor@univ.country}
Abstract: Text, text math, math text, text.
Text, text math, math text, text...
Keywords: keyword one, keyword two
\abstract{Text, text $math$, $math$ text, text.
Text, text $math$, $math$ text, text... }
\keywords{keyword one, keyword two}
\begin{document}
\maketitle
1Corresponding author.
Figure 1. An example of the JINST title page with the most common information (left), and the corresponding
source code (right).
2.1
Title
The title of your paper can be specified using the macro \title{...}.
If it contains any mathematics, then the command \boldmath should be placed inside the
argument of the title.
Only the first letter, acronyms and a persons’ name are capitalized. Also, the full stop is not
needed at the end of the title, unless it is followed by “Part 1” or “Part 2” (e.g. “An example title.
Part 1”).
2.2
Authors and affiliations
All authors should appear on the title page together with their affiliation(s). The firstname of each
author should be abbreviate to the initials only.
Authors and affiliations can be specified using the macros \author[]{...} and
\affiliation[]{...}, one for each author/affiliation (see the example of figure 1).
–2–
The author name is specified within the curly brackets, while the purpose of the optional
argument is to link authors and affiliations:
F. Author, a B. Author a,b and C. Authorb
a Institution,
Street number, City, Country
University,
Street number, City, Country
b Department,
\author[a]{A.~Author,}
\author[a,b]{B.~Author}
\author[b]{and C.~Author}
\affiliation[a]{Institution,\\
Street number, City, Country}
\affiliation[b]{Department, University,\\
Street number, City, Country}
When all the authors share the same affiliation(s), there is no need to identify them with letters:
A. Author, B. Author and C. Author
Institution,
Street number, City, Country
Department, University,
Street number, City, Country
\author{A.~Author,}
\author{B.~Author}
\author{and C.~Author}
\affiliation{Institution,\\
Street number, City, Country}
\affiliation{Department, University,\\
Street number, City, Country}
Footnote for the author. The macro \note{...} can be used inside \author to specify a
footnote for that author. Its numerical identification has to be manually specified inside the square
brackets of all the authors sharing that note.
A. Author, a,1 B. Author a,b,1 and C. Authorb
a Institution,
Street number, City, Country
University,
Street number, City, Country
b Department,
...
1 Note
2.3
shared by two authors.
\author[a,1]{A.~Author,%
\note{Note shared by two authors.}}
\author[a,b,1]{B.~Author}
\author[b]{and C.~Author}
\affiliation[a]{Institution,\\
Street number, City, Country}
\affiliation[b]{Department, University,\\
Street number, City, Country}
E-mails
Only the email address of the corresponing author appears on the first page. This email can be
specified using the macro \emailAdd{...}. If the email address contains an underscore, then it
needs to be escaped with a backslash (\emailAdd{name\_surname@domain.com}).
2.4
Abstract
The abstract of the paper can be specified inside the macro \abstract{...}.
We strongly discourage having citations in the abstract.
2.5
Keywords
The keywords of you paper can be specified inside the macro \keywords{...}.
Please note that the keywords that will appear on the published paper are those that you choose
during submission, not necessarily the one you provide in the tex source.
–3–
2.6
Additional information in the title page
The following additional information can be specified in the title page:
ArXiv number. You can provide the arXiv identification number of your paper by using the macro
\arxivnumber{...}.
Subheader. If your article is an invited review, you can specify the type of your manuscript as a
subtitle using the macro \subheader{...}.
Review
\subheader{Review}
An example title
\title{An example title}
Collaboration. If the authors are part of a collaboration, the name of the collaboration can be
specified in the macro \collaboration{...}.
\title{An example title}
An example title
\collaboration{XXX collaboration}
XXX collaboration
A. Author, B. Author and C. Author
\author{A.~Author,}
\author{B.~Author}
\author{and C.~Author}
If your collaboration has a logo, you can specify it as follows:
An example title
Image
\title...
\collaboration{%
\includegraphics[height=17mm]{logo.png}\\[6pt]
XXX collaboration}
XXX collaboration
A. Author, B. Author and C. Author
\author...
If you write on behalf of a collaboration, you can try as follows:
\title...
An example title
\collaboration[c]{on behalf of
XXX collaboration}
A. Author, B. Author and C. Author on
behalf of XXX collaboration
\author...
–4–
Dedication. If you want to dedicate your paper, the macro \dedicated{...} will place the
dedication in the bottom right part of the title page.
Keywords: keyword one, keyword two
ArXiv ePrint: 1234.56789
\dedicated{Dedicated to\ldots \\
\ldots if you want.}
Dedicated to. . .
. . . if you want.
3
Table of contents
The table of contents is generated by the command \maketitle and placed after the title page.
You can suppress the table of contents with the command \notoc in the document preamble
(i.e. before \begin{document}).
If you don’t want the table of contents to start on a new page, use the command
\toccontinuoustrue.1
4
4.1
Body of the paper
General conventions
The command \flushbottom is used immediately after \maketitle to make the text fill the
height of the page.
Sections and non-numbered sections. The text of a manuscript is usually divided into sections using the standard sectioning macros. Titled paragraphs (e.g. \paragraph{Title for the
paragraph.}) are preferred over non-numbered sections.
Usually only the first letter, acronyms and a persons’ name are capitalized in the section title.
Parenthesis and capitals. Parentheses in the text should always be round (like this), and should
not contain extra spaces: [ this is wrong ].
Capitals should be used only after full stops and not after colon, semicolon or parenthesis.
Dashes.
There are four types of dashes.
1. The minus sign (−2) (LATEX: $-$).
2. The hyphen connecting compounds (Kaluza-Klein, type-II) (LATEX: -).
3. The en-dash describes a range (september 1–10, 1999) (LATEX: --).
4. The em-dash — used for clauses — should be surrounded by spaces (LATEX: ---).
Emphasized text. Word or sentences within the text should preferably be emphasized using
\emph{}. The use of boldface is discouraged.
1If you need more space before the table of contents when using this command, you can use:
\renewcommand{\beforetookhook}{\bigskip\bigskip}.
–5–
Abbreviations. Figures, tables, appendices and sections are not abbreviated. Equations and
references may be abbreviated as: “eq. (eqs.)”, “ref. (refs.)”.
Latin abbreviations (“et al.”, “e.g.”, “i.e.”, ...) should be written without emphasis (i.e. in roman
characters).
The following should be avoided: fig.(2), sec(II), appendix (A), et.al., e.g., eqn. 1.2.
The following are correct: figure 2, section 2, appendix A, et al., e.g., eq. (1.2).
Footnotes. Footnotes should always be placed after the punctuation mark.2
They should begin with a capital letter and end with a full stop.
Acknowledgments. The command \acknowledgments starts a new non-numbered section
where the acknowledgments can be placed. It usually resides before the bibliography, or at the
end of the introduction.
Appendices. Appendices should have a proper title different from “Appendix A, B. . . ”.
To start the appendices’ section, the command \appendix will set the correct alphabetic
numbering for sections and equations.
other text.
other text.
A First appendix
\appendix
\section{First appendix}
A.1 Subsection
Text text text text text.
B Second appendix
Text text text text text.
\subsection{Subsection}
Text text text text text.
\section{Second appendix}
Text text text text text.
Cross referencing. To easily reference sections, figures, tables, etc. throughout your paper, please
use the commands \label{marker} and \ref{marker}. Labeled equations can also be cited
using the command \eqref{marker}.
4.2
Mathematics
Equations are numbered consecutively in the manuscript according to the section: (1.1), (1.2), . . . ,
(A.1), (A.2), . . .
Some conventions are adopted:
• Parenthesis surrounding fractions should be big enough for their contents
j
µB
1 j α
=
w η ,
Q α B
2Like this.
–6–
• Multiple equations should be aligned on the equal signs when possible (or on ≥, ∼, ↔, etc.)
1 j α
w η ,
Q α B
1
w̄ αj µ̄Bj = η̄αB .
Q
j
µB =
The same alignment rule holds for equations continued on multiple lines,
J =
1
Pγπ γ(γ 2 + 1) (α2 + β2 )2 − 2(α2 − β2 ) + 1 ×
2(
× (α + β) (α2 + β2 )2 + 2γ 2 (α2 − β2 ) + γ 4 +
+ d
(α2 + β2 )2 − 2(α2 − β2 ) + γ 4
γ2 + 1
+ 2
(3α2 − β2 − 1)
α + β2
)
≥ 0.
• Punctuation at the end of the equation should be consistent with the text following.
• If the equation lies on multiple lines, the equation number should appear on the last line or in
the middle of the block (if possible).
• If two or more equations are short, they can also be written on a single line, separated by
\quad or \qquad. For example:
j
µB =
4.3
1 j α
w η ,
Q α B
µ̄Bj =
1 B α
η̄ w̄ .
Q α j
Tables and figures
Tables and figures are numbered consecutively throughout the article. They always need a caption
describing their contents. A table’s caption should be placed above the table, while a figure’s
caption should be placed below the figure.
All figures and tables should be referenced in the text and should be placed on the page where
they are first cited or in subsequent pages. A collection of tables or figures at the end of the paper
should be avoided insofar as possible.
Resolution of raster images should be between 150 and 600 dpi. Vector images containing
fonts should have the fonts embedded in the files.
If you include pictures or other material that has already been published elsewhere, please
obtain permission from the copyright owner(s) before incorporating it in your article.
5
Bibliography
JINST uses the standard number-only system for references in the text with the enhancements given
by natbib’s sort&compress option. References in the bibliography should appear in the order that
they are cited in the text.
–7–
Some important rules:
• Every work should appear only once in the reference list.
• Self-citations are not permitted (a reference to the paper in its own bibliography).
• Each item of the bibliography should cite one work only. Phrases introducing cited work
(e.g. “See for example”) should not be included within the reference but may be used as part
of the text introducing the citation (“See for example [1,2,5,6]”).3
References.
The information provided for each reference should be as complete as possible.
articles: author(s), title, journal name, volume, year, page number, arXiv-number. Additional
information (erratum, addendum) can be specified too. For example:
M. Anselmino, A. Efremov and E. Leader, The theory and phenomenology of polarized
deep inelastic scattering, Phys. Rept. 261 (1995) 1 [Erratum ibid 281 (1997) 399]
[hep-ph/9501369].
books: author(s), title, publisher and year. For example:
R. Penrose and W. Rindler, Spinors and Space-time, Vol. 2: Spinor and twistor methods
in space-time geometry, Cambridge University Press, Cambridge U.K. (1986), pg. 501.
technical report/note: author(s), title, report number. For example:
CMS collaboration, Technical Design Report Vol. 1, CERN-LHCC-2006-001.
proceeding/talk: author(s), title, conference information, year. For example:
HERMES collaboration, F. Ellinghaus, DVCS at HERMES: Recent Results, in
Proceedings of the Workshop on Exclusive Reactions at High Momentum Transfer,
Jefferson Lab, Newport News, U.S.A., May 2007.
3Should your bibliography not meet this requirement upon acceptance of your paper, it will be corrected during the
typesetting stage, which might lead to a longer proofreading stage.
–8–
Source Exif Data:
File Type : PDF File Type Extension : pdf MIME Type : application/pdf PDF Version : 1.5 Linearized : No Page Count : 9 Page Mode : UseOutlines Author : Title : Subject : Creator : LaTeX with hyperref package Producer : pdfTeX-1.40.18 Create Date : 2018:03:19 12:24:12+01:00 Modify Date : 2018:03:19 12:24:12+01:00 Trapped : False PTEX Fullbanner : This is pdfTeX, Version 3.14159265-2.6-1.40.18 (TeX Live 2017) kpathsea version 6.2.3EXIF Metadata provided by EXIF.tools