The hep-paper package
∗Publications in high energy physics
Jan Hajer† 2021/09/01 Abstract
The hep-paperpackage aims to provide a single style file containing most configurations and macros necessary to write appealing publications in High Energy Physics. Instead of reinventing the wheel by introducing newly created macroshep-paper preferably loads third party packages.
Contents
1 Introduction 3
1.1 Options . . . 3
1.1.1 Deactivation . . . 3
1.1.2 Compatibility . . . 4
1.1.3 Reactivation . . . 4
2 Macros and environments 4 2.1 Title page . . . 4
2.2 Text . . . 5
2.2.1 References and footnotes . . . 5
2.2.2 Acronyms . . . 5
2.3 Math . . . 6
2.4 Floats . . . 7
2.5 Bibliography . . . 7
3 Conclusion 7
∗This document corresponds tohep-paperv2.0.
A Options 9
A.1 Deactivation . . . 10
A.2 Compatibility . . . 10
A.3 Reactivation . . . 11
A.4 Process options . . . 11
A.5 Set compatibility . . . 11
A.6 Math fonts . . . 13
A.7 Font size . . . 13
B Geometry 13 C Text 14 D Math 14 E Floats 14 F Title page 15 G Bibliography 16 H Hyperlinks, Footnotes and References 16 H.1 Footnotes . . . 17
H.2 References . . . 17
H.3 Citations . . . 18
I Acronyms 18 J Tests 19 J.1 JHEP . . . 19
J.2 JCAP . . . 19
J.3 AMSArt . . . 20
J.4 Beamer . . . 21
J.5 PoS . . . 21
J.6 RevTeX . . . 22
J.7 Springer . . . 23
K Readme 24
1 Introduction
For usual publications it is enough to load additionally to thearticleclass without optional arguments only thehep-paper package [1].
\documentclass{article}
\usepackage{hep-paper}
The most notable changes after loading the hep-paper package is the change of some LATEX defaults. The paper and font sizes are set to A4 and 11 pt, respectively. Addi- tionally, the paper geometry is adjusted using thegeometrypackage [2]. Furthermore, the font is changed to latin modern using thehep-fontpackage [3]. Finally, portable document format (PDF) hyperlinks are implemented with the hyperref package [4].
1.1 Options
Thepaper=hformati option loads the specified paper format. The possiblehformatsi paper
are: a0, a1, a2, a3, a4, a5,a6, b0, b1, b2,b3,b4, b5,b6, c0, c1, c2, c3, c4,c5, c6, ansia,ansib,ansic,ansid,ansie,letter,executive,legal. The default is a4.
The font=hsizei option loads the specified font size. The possible hsizesi are: 8pt, font
9pt,10pt,11pt,12pt,14pt,17pt,20pt. The default is 11 pt.
The lang=hnamei option switches the document language. The default isbritish. lang
The sansserifoption switches the document including math to sans serif font shape.
sansserif
The oldstyleoption activates the use of oldstyle text- (123) in favour of lining- (123) oldstyle
figures in text mode.
Theparskip option changes how paragraphs are separated from each other using the parskip
parskip package [5]. The LATEX default is separation via indentation the parskip option switches to separation via vertical space.1
Thesymbols=hfamilyiis passed to thehep-math-fontpackage [6] and sets the family symbols
of the symbol fonts. symbols=false deactivates loading any additional symbol fonts.
1.1.1 Deactivation
The hep-paper package loads few bigger packages which have a large impact on the document. The deactivation options can prevent such and other adjustments.
The defaultsoption prevents the adjustment of the page geometry and the font size defaults
set by the document class.
The title=falseoption deactivates the title page adjustments.
title
Thebibliography=hkeyioption prevents the automatic loading of thehep-bibliographypack- bibliography
age [7] if hkeyi=false.
1Although theparskip option is used for this document, it is recommended only for very few document types such as technical manuals or answers to referees.
Theglossaries=falseoption deactivates acronyms and the use of thehep-acronympack- glossaries
age [8].
The references=falseoption prevents the cleveref package [9] from being loaded references
and deactivates further redefinitions of reference macros.
1.1.2 Compatibility
The compatibility options activate the compatibility mode for certain classes and packages used for publications in high energy physics. They are mostly suitable combinations of options described in the previous section. If hep-paper is able to detect the presence of such a class or package, i.e. if it is loaded before the hep-paperpackage, the compatibility mode is activated automatically.
The beameroption activates the beamer[10] compatibility mode.
beamer
The jhepoption activates the JHEP [11] compatibility mode.
jhep
The jcapoption activates the JCAP [12] compatibility mode.
jcap
The revtexoption activates the REVTEX [13] compatibility mode.
revtex
The pos option activates the PoScompatibility mode.
pos
The springer option activates the compatibility mode thesvjourclass [14].
springer
1.1.3 Reactivation
Thehep-paperpackage deactivates unrecommended macros, which can be reactivated manually.
The manualplacement option reactivates manual float placement.
manualplacement
The eqnarrayoption reactivates the depreciated eqnarray environment.
eqnarray
2 Macros and environments
If the global twocolumn option is present the page geometry is changed to cover twocolumn
abstract* almost the entire page. Additionally the abstract* environment is defined that generates a one column abstract and takes care of placing the title information.
2.1 Title page
The \series{hseriesi}macro is defined using the hep-titlepackage [15].
\series
The PDF meta information is set according to the \title{htexti}and\author{htexti}
\title
information.
The \subtitle{hsubtitlei}macro is defined.
\subtitle
The following lines add e.g. two authors with different affiliations
\editor
\author
\author[1]{Author one \email{email one}}
\affiliation[1]{Affiliation one}
\author[2]{Author two \email{email two}}
\affiliation[1,2]{Affiliation two}
The \preprint{hnumeri}macro places a pre-print number in the upper right corner
\preprint
of the title page.
The abstractenvironment is adjusted to not start with an indentation.
abstract
Various title font macros are defined, allowing to change the appearance of the
\titlefont
\subtitlefont
\authorfont
\affiliationfont
\preprintfont
\maketitle output.
2.2 Text
The inlinelist andenumdescript environments are defined.
inlinelist enumdescript
A bold versions Small Caps and a sans serif version ofSmall Caps is provided.
\textsc
The \underline macro is redefined to allow line-breaks. The \overline macro is
\underline
\overline
extended to also overline text outside of math environments.
If the parskip option is activated the \useparindent macro switches to the usual
\useparskip
\useparindent
parindent mode, while the \useparskipmacro switches to the parskip mode.
2.2.1 References and footnotes
References are extended with thecleverefpackage [9], which allows toe.g. just type
\cref \cref{hkeyi}in order to write ‘figure 1’. Furthermore, the cleverefpackage allows to reference multiple objects within one\cref{hkey1,key2i}.
Citations are adjusted to not start on a new line in order to avoid the repeated use
\cite
of ~\cite{hkeyi}.
References are also adjusted to not start on a new line.
\ref
\eqref
\subref
Footnotes are adjusted to swallow white space before the footnote mark and at the
\footnote
beginning of the footnote text.
2.2.2 Acronyms
The hep-acronym package [8] is loaded. The \acronymh*i[htypeset abbreviationi]
\acronym
\shortacronym
\longacronym
{habbreviationi}h*i{hdefinitioni}[hplural definitioni] macro generates the singular
\habbreviationi and plural \habbreviationis macros. The first star prevents the addition of an ‘s’ to the abbreviation plural. The second star restores the TEX default of swallowing subsequent white space. The long form is only shown at the first appearance of these macros, later appearances generate the abbreviation with a hyperlink to the long form. The long form is never used in math mode. Capitalization at the beginning of paragraphs and sentences is (mostly) ensured. The\shortacronym and\longacronymmacros are drop-in replacements of the\acronym macro showing only the short or long form of their acronym.
2.3 Math
The hep-math [16] and hep-math-font [6] packages are loaded. Bold math, via
\mathbf
\mathbf is improved, i.e. (AbΓ δAbΓ δ). Macros switching to bfseries such as
\section{htexti}are ensured to also typeset math in bold. The \text{htexti}macro
\text
makes it possible to write text within math mode,i.e. (AbΓδAbΓδ). The math sans
\mathsf
serif alphabet is redefined to be italic sans serif if the main text is serif and italic serif if the main text is sans serif,i.e. (Ab` ‹Ab` ‹). The\mathcal fonti.e. (ABCD)
\mathscr
is accompanied by the \mathscrfonti.e. (A BC D). The \mathbbfont is adjusted
\mathbb
depending on the sansserif option i.e. (Ah1). Finally, the \mathfrak font is also
\mathfrak availablei.e. (AaBb12).
The \frac{hnumberi}{hnumberi} macro is accompanied by \nicefrac{hnumberi}
\nicefrac
\flatfrac
\textfrac
{hnumberi}, \textfrac{hnumberi}{hnumberi}, and \flatfrac{hnumberi}{hnumberi} leading to 12, 1/2,1/2, and 1/2 . Diagonal matrix\diag and signum \sgn operators
\diag
\sgn
are defined.
The \mathdef{hnamei}[hargumentsi]{hcodei}macro (re-)defines macros only within
\mathdef
math mode without changing the text mode definition.
The imaginary unit i and the differential dare defined using this functionality.
\i
\d
For longer paper it can be useful to re-number the equation in accordance with the
\numberwithin
section numbering\numberwithin{equation}{section}. In order to further reduce subequations
the size the of equation counter it can be useful to wrap align environments with multiple rows in a subequationsenvironment.
The correct spacing for units,cf. equation (1), is provided by the macro\unit[hvaluei]
\unit
\inv
{huniti} which can also be used in text mode. The macro \inv[hpoweri]{htexti} allows to avoid math mode also for inverse units such as 5 fb−1 typeset via
\unit[5]{\inv{fb}}.
Greek letters are adjusted to always be italic and upright in math and text mode, respectively, using thehep-math-font[6] package. This allows differentiations like
σ = 5 fb, at 5σC.L. , µ= 5 cm , l= 5μm. (1) Additionally, Greek letters can also be directly typed using Unicode.
The hep-mathpackage [16] provides additional macros such as
\ev
\pdv
\comm
\order
hφi , ∂3f
∂x∂y2 , [A, B], O(x2), x|∞0 , det(M) . (2) The \cancel{hcharactersi} macro and the \slashed {hcharacteri} macro allow to
\cancel
\slashed cancel math and use the Dirac slash notation i.e.∂, respectively./ A better looking over left right arrow is defined i.e. ↔∂.
\overleftright
2.4 Floats
Automatic float placement is adjusted to place a single float at the top of pages and to figure
table reduce the number of float pages, using thehep-float package [17]. The most useful float placement is usually archived by placing the float in front of the paragraph it is referenced in first.
Thepanels environment provides sub-floats and takes as mandatory argument either panels
\panel the number of sub-floats (default 2) or the width of the first sub-float as fraction of the
\linewidth. Within the \begin{panels}[hvertical alignmenti]{hwidthi}environment the \panel macro initiates a new sub-float. In the case that the width of the first sub-float has been given as an optional argument to the panels environment the
\panel{hwidthi}macro takes the width of the next sub-float as mandatory argument.
The \graphic[hwidthi]{hfigurei} macro is defined, which is a wrapper for the
\graphic
\graphics \includegraphics{hfigurei} macro and takes the figure width as fraction of the
\linewidthas optional argument (default 1). If the graphics are located in a sub-folder its path can be indicated by \graphics{hsubfolderi}.
2.5 Bibliography
The biblatex package [18] is loaded for bibliography management. The user has
\bibliography
\printbibliography to add the line \bibliography{hmy.bibi} to the preamble of the document and
\printbibliographyat the end of the document. The bibliography is generated by Biber[19]. biblatexis extended by thehep-bibliographypackage [7] to be able to cope with thecollaborationandreportNumberfields provided byinspirehep.netand a bug in the volume number is fixed. Additionally, the PubMed IDs are recognized and ctan.org, github.com, gitlab.com, bitbucket.org, launchpad.net, sourceforge.net, and hepforge.org are valid eprinttypes. Errata can be included using the related erratum
feature.
\article{key1,
...,relatedtype="erratum", related="key2",
}\article{key2, }...,
3 Conclusion
The hep-paper package provides a matching selection of preloaded packages and additional macros enabling the user to focus on the content instead of the layout by reducing the amount of manual tasks. The majority of the loaded packages are fairly lightweight, the others can be deactivated with package options.
arxiv.org[20] requires the setup dependentbblfiles instead of the original bibfiles, arxiv-collector
which causes trouble if the local LATEX version differs from the one used by arXiv.
The arxiv-collectorpython script [21] alleviates this problem by collecting all files necessary for publication on arXiv (including figures).
A Options
<*package>
Load thekvoptions package [22] and define ahepnamespace.
1\RequirePackage{kvoptions}
2\SetupKeyvalOptions{
3 family=hep,
4 prefix=hep@
5}
paper Define apaper=hsizei option. Make A4 paper the default.
6\DeclareStringOption[a4]{paper}
font Define afigures=hsizei option. Make 11 pt the default font size.
7\DeclareStringOption[11pt]{font}
lang Define the langoption, which takes the values provided by the babelpackage [23].
Makebritishthe default language.
8\DeclareStringOption[british]{lang}
sansserif Define the option pair serif and sansserif controling the font shape of the whole document.
9\DeclareBoolOption[true]{serif}
10\DeclareComplementaryOption{sansserif}{serif}
lining Define the liningoption deactivating the use of text figures in text mode.
11\DeclareBoolOption[true]{lining}
12\DeclareComplementaryOption{oldstyle}{lining}
parskip Define the option pairparindentandparskipcontrolling the separation of paragraphs.
13\DeclareBoolOption[true]{parindent}
14\DeclareComplementaryOption{parskip}{parindent}
symbols Provide thesymbols option allowing to switch the symbol font.
15\DeclareStringOption[true]{symbols}
A.1 Deactivation
defaults Define thedefaultsoption which deactivates thepaperandfontoptions and prevents the change of the class defaults by this package.
16\DeclareBoolOption[false]{defaults}
title Provide thetitleoption deactivating redefinitions of title macros.
17\DeclareBoolOption[true]{title}
physics Provide thephysics option for deactivating redefinition of physics macros.
18\DeclareBoolOption[true]{physics}
bibliography Provide thebibliographyoption for passing astylestring to thebiblatexpackage [18]
or disabling the automatic loading of biblatex.
19\DeclareStringOption[numeric-comp]{bibliography}
glossaries Provide theglossariesoption able to turn of the use of the hep-acronympackage [8].
20\DeclareBoolOption[true]{glossaries}
references Provide thereferencesoption for preventing thecleverefpackage from being loaded redefinitions of reference macros.
21\DeclareBoolOption[true]{references}
A.2 Compatibility
beamer Provide thebeamer option forbeamer[10] compatibility mode.
22\DeclareBoolOption[false]{beamer}
revtex Provide therevtex option for REVTEX [13] compatibility mode.
23\DeclareBoolOption[false]{revtex}
jhep Provide thejhep option for JHEP [11] compatibility mode.
24\DeclareBoolOption[false]{jhep}
jcap Provide thejcap option for JCAP [12] compatibility mode.
25\DeclareBoolOption[false]{jcap}
pos Provide thepos option for PoS compatibility mode.
\DeclareBoolOption[false]{pos}
springer Provide thespringer option for Springer compatibility mode.
27\DeclareBoolOption[false]{springer}
amsart Provide theamsart option for AMS article compatibility mode.
28\DeclareBoolOption[false]{amsart}
A.3 Reactivation
eqnarray Provide theeqnarray option for reactivating the eqnarrayenvironment.
29\DeclareBoolOption[true]{eqnarray}
manualplacement Provide themanualplacementoption for reactivating the manual placement of floats.
30\DeclareBoolOption[false]{manualplacement}
A.4 Process options
31\ProcessKeyvalOptions*
Read the class options regarding font and paper size.
32\def\hep@get@class#1.cls#2\relax{\def\hep@class{#1}}
33\def\hep@getclass{\expandafter\hep@get@class\@filelist\relax}
34\hep@getclass
35\@ifclasswith{\hep@class}{10pt}{\setkeys{hep}{font=10pt}}{}
36\@ifclasswith{\hep@class}{12pt}{\setkeys{hep}{font=12pt}}{}
37\@ifclasswith{\hep@class}{a5paper}{\setkeys{hep}{paper=a5}}{}
38\@ifclasswith{\hep@class}{b5paper}{\setkeys{hep}{paper=b5}}{}
39\@ifclasswith{\hep@class}{letterpaper}{\setkeys{hep}{paper=letter}}{}
40\@ifclasswith{\hep@class}{legalpaper}{\setkeys{hep}{paper=legal}}{}
41\@ifclasswith{\hep@class}{executivepaper}{%
42 \setkeys{hep}{paper=executive}%
43}{}
A.5 Set compatibility
Set theamsart compatibility options.
44\@ifclassloaded{amsart}{\setkeys{hep}{amsart}}{}
45\ifhep@amsart
46 \setkeys{hep}{defaults, title=false}
47 \RequirePackage{xpatch}
48 \xpretocmd{\@adminfootnotes}{\let\@makefntext\BHFN@OldMakefntext}{}{}
49\fi
Set thespringer compatibility options.
50\@ifclassloaded{svjour}{\setkeys{hep}{springer}}{}
51\@ifclassloaded{svjour2}{\setkeys{hep}{springer}}{}
52\@ifclassloaded{svjour3}{\setkeys{hep}{springer}}{}
53\ifhep@springer
54 \setkeys{hep}{defaults, title=false}
55 \let\cl@chapter\undefined
56\fi
Set thepos compatibility options.
57\@ifclassloaded{PoS}{\setkeys{hep}{pos}}{}
58\ifhep@pos
59 \setkeys{hep}{defaults, title=false}
60 \DeclareRobustCommand\boldmath{\@nomath\boldmath\mathversion{bold}}
61\fi
Set thebeamercompatibility options.
62\@ifclassloaded{beamer}{\setkeys{hep}{beamer}}{}
63\ifhep@beamer
64 \setkeys{hep}{defaults, title=false, references=false, sansserif}
65 \@ifpackageloaded{beamerbasefont}{\usefonttheme{professionalfonts}}{}
66 \setbeamertemplate{navigation symbols}{}
67\fi
Set therevtex compatibility options.
68\@ifclassloaded{revtex4}{\setkeys{hep}{revtex}}{}
69\@ifclassloaded{revtex4-1}{\setkeys{hep}{revtex}}{}
70\@ifclassloaded{revtex4-2}{\setkeys{hep}{revtex}}{}
71\ifhep@revtex
72 \setkeys{hep}{defaults, title=false, bibliography=false, lang=american}
73\fi
Define the SISSA conditional.
74\@ifpackageloaded{jheppub}{\setkeys{hep}{jhep}}{}
75\@ifpackageloaded{jcappub}{\setkeys{hep}{jcap}}{}
76\newif\ifhep@sissa
77\ifhep@jhep\hep@sissatrue
78\else
79 \ifhep@jcap\hep@sissatrue
80 \else\hep@sissafalse
81 \fi
82\fi
Set the SISSA compatibility options.
83\ifhep@sissa
84 \setkeys{hep}{defaults, title=false, bibliography=false}
85 \PassOptionsToPackage{
86 colorlinks=true, linktocpage=true, pdfproducer=medialab, pdfa=true,
87 urlcolor=blue, anchorcolor=blue, citecolor=blue, filecolor=blue, linkcolor=blue, menucolor=blue, pagecolor=blue
89 }{hyperref}
90 \AtBeginDocument{\renewcommand{\foreignabbrfont}{}}
91\fi
92%
93% \section{Font}
94%
95% Set the whole text to sans serif if requested.
96% \begin{macrocode}
97\ifhep@serif\else
98 \renewcommand{\familydefault}{\sfdefault}
99\fi
Load the hep-font package.
100\RequirePackage[lining=\ifhep@lining true\else false \fi]{hep-font}
A.6 Math fonts
Load the hep-math-font package.
101\RequirePackage[symbols=\hep@symbols]{hep-math-font}
A.7 Font size
Undefine previously defined font sizes and load the LATEX font size file corresponding to the font size option.
102\ifhep@defaults\else
103 \def\hep@remove@pt#1pt{#1}
104 \edef\hep@pt@size{\expandafter\hep@remove@pt\hep@font}
105 \let\small\relax
106 \let\footnotesize\relax
107 \let\scriptsize\relax
108 \let\tiny\relax
109 \let\large\relax
110 \let\Large\relax
111 \let\LARGE\relax
112 \let\huge\relax
113 \let\Huge\relax
114 \input{size\hep@[email protected]}
115\fi
B Geometry
Load the geometry package [2] and adjust the text width and height. This step must happen after readjusting the font size in appendix A.7.
116\ifhep@defaults\else
117 \RequirePackage{geometry}
118 \geometry{\hep@paper paper, includeheadfoot}
119 \if@twocolumn
120 \geometry{hscale=.85, vscale=.925, vmarginratio=1:1}
121 \geometry{headsep=2ex, footskip=6ex}
122 \setlength{\columnsep}{1.1em}
123 \else
124 \geometry{hscale=.75, vscale=.8, vmarginratio=3:4}
125 \fi
126\fi
\useparskip
\useparindent
Load the parskip package [5] if requested and provide two commands switching between the two paragraph modes.
127\ifhep@parindent\else
128\RequirePackage{parskip}
129\newcommand{\useparskip}{%
130 \setlength{\parskip}{.5\baselineskip plus 2pt}%
131 \setlength{\parindent}{0pt}%
132}
133\newcommand{\useparindent}{%
134 \setlength{\parskip}{0pt}%
135 \setlength{\parindent}{15pt}%
136 \if@twocolumn\setlength\parindent{1em}
137 \else\setlength\parindent{1.5em}
138 \fi
139}
140\fi
C Text
Load thehep-textpackage [24].
141\RequirePackage[lang=\hep@lang]{hep-text}
D Math
142\ifhep@physics\RequirePackage{hep-math}\fi
E Floats
Adjust the LATEX float placement defaults
143\RequirePackage[
144 manualplacement=\ifhep@manualplacement true\else false \fi
145]{hep-float}
\ifhep@journal Define a new journal conditional.
146\newif\ifhep@journal
147\ifhep@sissa\hep@journaltrue
148\else\ifhep@revtex\hep@journaltrue
149 \else\ifhep@pos\hep@journaltrue
150 \else\ifhep@springer\hep@journaltrue
151 \else\hep@journalfalse
152 \fi
153 \fi
154 \fi
155\fi
Prevent the captionpackage [25] from complaining about the journal classes and packages.
156\ifhep@journal
157 \setlength\abovecaptionskip{\f@size\p@}
158 \setlength\belowcaptionskip{0\p@}
159 \long\def\@makecaption#1#2{%
160 \vskip\abovecaptionskip
161 \sbox\@tempboxa{#1: #2}%
162 \ifdim \wd\@tempboxa >\hsize
163 #1: #2\par
164 \else
165 \global \@minipagefalse
166 \hb@xt@\hsize{\hfil\box\@tempboxa\hfil}%
167 \fi
168 \vskip\belowcaptionskip%
169 }
170\fi
Readjust the document captions to look like the original revtex captions using the ragged2epackage [26].
171\ifhep@revtex
172 \RequirePackage{ragged2e}
173 \DeclareCaptionFormat{revtex}{#1#2\justifying{#3}}
174 \captionsetup{font=small, format=revtex}
175 \captionsetup[sub]{font=footnotesize, format=plain}
176 \renewcommand{\figurename}{Figure}
177 \renewcommand{\tablename}{Table}
178\fi
F Title page
Begin of titleconditional.
179\ifhep@title\RequirePackage{hep-title}\fi
G Bibliography
Check if bibliography management is requested using thepdftexcmds package [27].
180\RequirePackage{pdftexcmds}
181\ifnum\pdf@strcmp{\hep@bibliography}{false}=0\else
182 \RequirePackage[style=\hep@bibliography]{hep-bibliography}
183\fi
H Hyperlinks, Footnotes and References
Load thehyperref package [4] enable Unicode encoding and hide links.
184\RequirePackage{hyperref}
185\hypersetup{
186 pdfencoding=auto, psdextra,
187 hidelinks, linktoc=all, breaklinks=true,
188 pdfcreator={}, pdfproducer={}
189}
Set the PDF meta data according to the paper information and ensure that unneces- sary information is suppressed.
190\pdfstringdefDisableCommands{\def\varepsilon{\textepsilon}}
191\pdfstringdefDisableCommands{\def\to{\textrightarrow}}
192\AtBeginDocument{
193 \pdfstringdefDisableCommands{\let\ensuremath\@gobble}
194 \pdfstringdefDisableCommands{\let\mathsurround\@gobble}
195 \pdfstringdefDisableCommands{\let\unskip\@gobble}
196 \pdfstringdefDisableCommands{\let\thanks\@gobble}
197 \pdfstringdefDisableCommands{\let\footnote\@gobble}
198 \pdfstringdefDisableCommands{\let\\\@gobble}
199}
200\ifhep@revtex
201 \AtBeginShipout{\hypersetup{pdftitle={\@title}}}
202\else
203 \ifhep@beamer\else
204 \AtBeginDocument{\hypersetup{pdftitle={\@title}}}
205 \fi
206\fi
207\ifhep@title
208 \AtBeginDocument{\hypersetup{pdfauthor=\AB@authlist}}
209\else
210 \ifhep@beamer\else
211 \ifhep@pos\else\AtBeginDocument{\hypersetup{pdfauthor={\@author}}}\fi
212 \fi
213\fi
H.1 Footnotes
Place a hyperlink from the footnote back to its referencing label using the footnote- backref package [28].
214\def\BackrefFootnoteTag{}
215\RequirePackage{footnotebackref}
\footnote Ensure that no spaces appear before the footmark or at the beginning of the footnote.
216\let\@foot@note\footnote
217\renewcommand{\footnote}[1]{\unskip\@foot@note{\ignorespaces#1}}
H.2 References
Begin of referencesconditional
218\ifhep@references
\cref Improve reference using thecleveref package [9].
219\RequirePackage[noabbrev, nameinlink]{cleveref}
220\newcommand{\creflastconjunction}{, and\nobreakspace}
221\crefname{enumi}{point}{points}
222\crefname{inlinelisti}{point}{points}
\no@break@before Define a macro able to prevent line breaks.
223\newcommand\no@break@before{%
224 \relax\ifvmode\else%
225 \ifhmode%
226 \ifdim\lastskip > 0pt%
227 \relax\unskip\nobreakspace%
228 \fi%
229 \fi%
230 \fi%
231}
\ref Adjust\ref{hkeyi}in order to prevent preceding line breaks.
232\let\hep@ref\ref
233\AtBeginDocument{\renewcommand\ref{\no@break@before\hep@ref}}
\eqref Adjust\eqref{hkeyi}in order to prevent preceding line breaks.
234\renewcommand\eqref{\no@break@before\labelcref}
\subref Adjust\subref{hkeyi}in order to prevent preceding line breaks.
235\let\hep@subref\subref
236\renewcommand\subref{\no@break@before\hep@subref}
237\renewcommand*\subcaption@ref[2]{\begingroup%
238 \caption@setoptions{sub}%
239 \subcaption@reffmt\p@subref{\hep@ref#1{sub@#2}}%
240\endgroup}
\subcref Provide the\subcref macro.
241\newcommand{\subcref}[1]{\cref{sub@#1}}
\eqcrefname Define the \eqcrefname macro for named equation types.
242\NewDocumentCommand{\eqcrefname}{mmo}{
243 \crefname{#1}{#2}{\IfValueTF{#3}{#3}{#2s}}
244 \creflabelformat{#1}{(##2##1##3)}
245}
\labelcrefrange Define the missing\labelcrefrange{hkey1i}{hkey2i}macro.
246\DeclareRobustCommand{\labelcrefrange}[2]{%
247 \@crefrangenostar{labelcref}{#1}{#2}%
248}
Adjust the title page
249\ifhep@title
250 \labelcrefmultiformat{affiliation}{#2#1#3}{%
251 \textsuperscript,#2#1#3}{\textsuperscript,#2#1#3%
252 }{%
253 \textsuperscript,#2#1#3%
254 }
255 \labelcrefrangeformat{affiliation}{#3#1#4\textsuperscript{--}#5#2#6}
256% \thanksmarkseries{alph}
257\fi
End ofreferences conditional
258\fi
H.3 Citations
\cite Adjust\cite{hkeyi}in order to prevent preceding line breaks.
259\let\hep@cite\cite
260\renewcommand\cite{\no@break@before\hep@cite}
I Acronyms
Define acronyms if not deactivated.
Acronyms are implemented in the hep-acronympackage [8] and must be loaded after thehyperref package in appendix H. Set the abbreviation style.
261\ifhep@glossaries\RequirePackage{hep-acronym}\fi
</package>
J Tests
J.1 JHEP
<*testJHEP>
262\documentclass[a4paper, 11pt]{article}
263
264\usepackage{jheppub}
265\usepackage[lang=english]{hep-paper}
266\usepackage[math]{blindtext}
267
268\begin{document}
269
270\title{Title}
271
272\emailAdd{[email protected]}
273\author[a]{First author}
274\emailAdd{[email protected]}
275\author[b]{Second author}
276\affiliation[a]{First affiliation}
277\affiliation[b]{Second affiliation}
278
279\abstract{\blindtext}
280
281\maketitle
282
283\Blinddocument
284
285\end{document}
</testJHEP>
J.2 JCAP
<*testJCAP>
286\documentclass[a4paper, 11pt]{article}
287
288\usepackage{jcappub}
289\usepackage[lang=english]{hep-paper}
290\usepackage[math]{blindtext}
291
292\begin{document}
293
294\title{Title}
295
296\emailAdd{[email protected]}
297\author[a]{First author}
298\emailAdd{[email protected]}
299\author[b]{Second author}
300\affiliation[a]{First affiliation}
301\affiliation[b]{Second affiliation}
302
303\abstract{\blindtext}
304
305\maketitle
306
307\Blinddocument
308
309\end{document}
</testJCAP>
J.3 AMSArt
<*testAMSArt>
310\documentclass{amsart}
311
312\usepackage[lang=english]{hep-paper}
313\usepackage[math]{blindtext}
314
315\title{title}
316
317\author{Author}
318\address{Address 1}
319\email{[email protected]}
320\author{Author 2}
321\email{[email protected]}
322\address{Address 2}
323
324\date{date}
325
326\begin{document}
327
328\begin{abstract}
329\blindtext
330\end{abstract}
331
332\maketitle
333
334\Blinddocument
336\end{document}
</testAMSArt>
J.4 Beamer
<*testBeamer>
337\documentclass{beamer}
338
339\usepackage[lang=english]{hep-paper}
340\usepackage[math]{blindtext}
341
342\title{Title}
343\subtitle{Subtitle}
344\author{Author}
345\institute{Institute}
346\date{Event}
347
348\begin{document}
349
350\frame{\titlepage}
351
352\begin{frame}{Frame title}
353\blindtext
354\end{frame}
355
356\end{document}
</testBeamer>
J.5 PoS
<*testPoS>
357\documentclass{PoS}
358
359\usepackage[lang=english,title=false]{hep-paper}
360\usepackage[math]{blindtext}
361
362\title{Title}
363
364\author{First author \thanks{[email protected]}}
365\author{
366\speaker{Second author is speaker}\\
367First affiliation\\
368E-mail: \email{[email protected]}
369}
370\author{Third author \thanks{\email{[email protected]}}\\Second affiliation}
371\author{Fourth author\\Third affiliation}
372\FullConference{Full conference}
373\ShortTitle{Short title}
374
375\begin{abstract}
376\blindtext
377\end{abstract}
378
379\begin{document}
380
381\Blinddocument
382
383\end{document}
</testPoS>
J.6 RevTeX
<*testRevTeX>
384\documentclass[
385 aps,
386 prl,
387 reprint,
388 nofootinbib,
389 nobibnotes,
390 superscriptaddress,
391 preprintnumbers,
392]{revtex4-2}
393
394\usepackage{hep-paper}
395\usepackage[math]{blindtext}
396
397\begin{document}
398
399\title{Title}
400
401\author{First author}
402\email[E-mail me at: ]{[email protected]}
403\affiliation{First affiliation}
404\author{Second author}
405\email{[email protected]}
406\affiliation{Second affiliation}
407\affiliation{Third affiliation}
408\author{Third author}
409\affiliation{Fourth affiliation}
410
411\begin{abstract}
412\blindtext
413\end{abstract}
414
415\maketitle
417\Blinddocument
418
419\end{document}
</testRevTeX>
J.7 Springer
<*testSpringer>
420\documentclass[twocolumn,epjc3]{svjour3}
421
422\usepackage[lang=english]{hep-paper}
423\usepackage[math]{blindtext}
424
425\journalname{Journal name}
426
427\title{Title\thanksref{title}}
428
429\titlerunning{Short title}
430
431\subtitle{Subtitle}
432
433\thankstext{title}{Title thanks}
434
435\authorrunning{Short form of author list}
436
437\thankstext{email1}{e-mail: [email protected]}
438\thankstext{email2}{e-mail: [email protected]}
439
440\institute{
441 First address \label{address1} \and
442 Second address \label{address2} \and
443 \emph{Present Address:} if needed\label{address3}
444}
445
446\date{Received: date / Accepted: date}
447
448\begin{document}
449
450\author{
451 First Author\thanksref{email1,address1} \and
452 Second Author\thanksref{email2,address2,address3}
453}
454
455\maketitle
456
457\begin{abstract}
458\blindtext
459\end{abstract}
460
461\Blinddocument
462
463\end{document}
</testSpringer>
K Readme
<*readme>
464# The ‘hep-paper‘ package
465
466A ‘LaTeX‘ package for publications in High Energy Physics.
467
468## Introduction
469
470The ‘hep-paper‘ package aims to provide a single style file containing most configurations and macros necessary to write appealing publications in High Energy Physics.
471Instead of reinventing the wheel by introducing newly created macros ‘hep-paper‘ preferably loads third party packages as long as they are lightweight enough.
472
473For usual publications it is enough to load additionally to the ‘article‘ class without optional arguments only the ‘hep-paper‘ package.
474
475 \documentclass{article}
476 \usepackage{hep-paper}
477
478## Author
479
480Jan Hajer
481
482## License
483
484This file may be distributed and/or modified under the conditions of the ‘LaTeX‘ Project Public License, either version 1.3c of this license or (at your option) any later version.
485The latest version of this license is in ‘http://www.latex-project.org/lppl.txt‘ and version 1.3c or later is part of all distributions of LaTeX version 2005/12/01 or later.
</readme>
References
[1] J. Hajer. ‘The hep-paperpackage: Publications in high energy physics’ (2019).
CTAN: hep-paper. doi: 10.5281/zenodo.3606436. GitHub: janhajer/hep- paper.
[2] D. Carlisle and H. Umeki. ‘Thegeometrypackage: Flexible and complete inter- face to document dimensions’ (1996). CTAN:geometry. GitHub:davidcarlisle/
geometry.
[3] J. Hajer. ‘The hep-fontpackage: Latin modern extended by computer modern’
(2021). CTAN: hep-font.doi:10.5281/zenodo.3606436. GitHub: janhajer/
hep-paper.
[4] LATEX3 Project. ‘Hypertext marks in LATEX: a manual forhyperref: Extensive support for hypertext in LATEX’ (1995). CTAN: hyperref. GitHub: latex3/
hyperref.
[5] R. Fairbairns, F. Mittelbach, and H. Partl. ‘The parskip package: Layout with zero \parindent, non-zero \parskip’ (1989). CTAN: parskip. GitHub:
FrankMittelbach/fmitex.
[6] J. Hajer. ‘Thehep-math-font package: Extended Greek and sans serif math’
(2021). CTAN: hep - math - font. doi: 10 . 5281 / zenodo . 3606436. GitHub:
janhajer/hep-paper.
[7] J. Hajer. ‘Thehep-bibliographypackage: Bibliographies for high energy physics’
(2021). CTAN: hep-bibliography. doi: 10.5281/zenodo.3606436. GitHub:
janhajer/hep-paper.
[8] J. Hajer. ‘The hep-acronym package: An acronym extension for glossaries’
(2021). CTAN: hep - acronyms. doi: 10 . 5281 / zenodo . 3606436. GitHub:
janhajer/hep-paper.
[9] T. Cubitt. ‘The cleverefpackage: Intelligent cross-referencing’ (2006). CTAN:
cleveref.url:dr-qubit.org/cleveref.
[10] T. Tantau, J. Wright, and V. Miletić. ‘The beamer class: A LATEX class for producing presentations and slides’ (2003). CTAN: beamer. GitHub:
josephwright/beamer.
[11] SISSA Medialab. ‘TheJHEP package’ (1997). url: jhep.sissa.it/jhep/help/
JHEP_TeXclass.jsp.
[12] SISSA Medialab. ‘TheJCAPpackage’ (2002).url:jcap.sissa.it/jcap/help/
JCAP_TeXclass.jsp.
[13] American Physical Society. ‘The REVTEX class: Styles for various Physics Journals’ (1999). CTAN:revtex.url:journals.aps.org/revtex.
[14] Springer Verlag. ‘The svjour package: Macros for Springer journals’ (1997).
CTAN: springer.
[15] J. Hajer. ‘The hep-titlepackage: Extensions for the title page’ (2021). CTAN:
hep-title.doi:10.5281/zenodo.3606436. GitHub: janhajer/hep-paper. [16] J. Hajer. ‘The hep-math package: Extended math macros’ (2021). CTAN:
hep-math.doi:10.5281/zenodo.3606436. GitHub:janhajer/hep-paper. [17] J. Hajer. ‘The hep-float package: Convenience package for float placement’
(2021). CTAN: hep-float.doi:10.5281/zenodo.3606436. GitHub:janhajer/
hep-paper.
[18] P. Lehman, J. Wright, A. Boruvka, and P. Kime. ‘The biblatex Package:
Sophisticated Bibliographies in LATEX’ (2006). CTAN:biblatex. GitHub:plk/
biblatex.
[19] F. Charette and P. Kime. ‘biber: Backend processor for BibLATEX’ (2009).
GitHub: plk/biber. sourceforge: biblatex-biber.
[20] arXiv Team. ‘arXiv: free distribution service and an open archive for scholarly articles’ (1991). url:arxiv.org.
[21] D. Sutherland. ‘arxiv-collector: A little Python script to collect LATEX sources for upload to the arXiv’ (2018). GitHub:dougalsutherland/arxiv-collector.
[22] H. Oberdiek. ‘The kvoptions package: Key value format for package options’
(2004). CTAN: kvoptions. GitHub:ho-tex/kvoptions.
[23] J. Braams, J. Bezos, and at al. ‘Babel Localization and internationalization:
Multilingual support for Plain TEX or LATEX’ (1989). CTAN:babel. GitHub:
latex3/babel.
[24] J. Hajer. ‘The hep-text package: List and text extensions’ (2021). CTAN:
hep-text.doi:10.5281/zenodo.3606436. GitHub:janhajer/hep-paper. [25] A. Sommerfeldt. ‘The caption package: Customising captions in floating envi-
ronments’ (1994). CTAN:caption. GitLab: axelsommerfeldt/caption. [26] M. Schröder. ‘The ragged2e-package: Alternative versions of “ragged”-type
commands’ (1996). CTAN: ragged2e. GitLab:hagenbuch/ragged2e.
[27] H. Oberdiek. ‘The pdftexcmds package: LuaTEX support for pdfTEX utility functions’ (2007). CTAN: pdftexcmds.
[28] H. Lange. ‘Thefootnotebackrefpackage: Back-references from footnotes’ (2012).
CTAN: footnotebackref.