From 702ea1a475d8ae525aca8ca610b0497254ba513f Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Tue, 1 Sep 2020 21:34:50 +0000 Subject: hep-paper (1sep20) git-svn-id: svn://tug.org/texlive/trunk@56236 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/hep-paper/README.md | 8 + .../doc/latex/hep-paper/bibliography.bib | 84 ++- .../latex/hep-paper/hep-paper-documentation.pdf | Bin 0 -> 454890 bytes .../latex/hep-paper/hep-paper-documentation.tex | 609 +++++++++++++++++++++ .../latex/hep-paper/hep-paper-implementation.pdf | Bin 0 -> 535891 bytes .../texmf-dist/doc/latex/hep-paper/hep-paper.pdf | Bin 525662 -> 0 bytes 6 files changed, 694 insertions(+), 7 deletions(-) create mode 100644 Master/texmf-dist/doc/latex/hep-paper/hep-paper-documentation.pdf create mode 100644 Master/texmf-dist/doc/latex/hep-paper/hep-paper-documentation.tex create mode 100644 Master/texmf-dist/doc/latex/hep-paper/hep-paper-implementation.pdf delete mode 100644 Master/texmf-dist/doc/latex/hep-paper/hep-paper.pdf (limited to 'Master/texmf-dist/doc/latex/hep-paper') diff --git a/Master/texmf-dist/doc/latex/hep-paper/README.md b/Master/texmf-dist/doc/latex/hep-paper/README.md index e35410f36ec..fe6ce7a1058 100644 --- a/Master/texmf-dist/doc/latex/hep-paper/README.md +++ b/Master/texmf-dist/doc/latex/hep-paper/README.md @@ -12,6 +12,14 @@ For usual publications it is enough to load additionally to the `article` class \documentclass{article} \usepackage{hep-paper} +## Installation + +Running `pdflatex hep-paper.ins` will generate the main style file `hep-paper.sty` together with the necessary datamodel file `hep-paper.dbx`. +These two files must be moved into a folder the `tex` installation is aware of, e.g. the folder containing the document that should use the `hep-paper` package. +Additionally the documentation file `hep-paper-documentation.tex` will be generated. +Subsequently running `pdflatex hep-paper-documentation.tex` will generate the documentation `hep-paper-documentation.pdf`. +Finally running `pdflatex hep-paper-implementation.dtx` will generate the complete documentation of the implementation `hep-paper-implementation.pdf` + ## Author Jan Hajer diff --git a/Master/texmf-dist/doc/latex/hep-paper/bibliography.bib b/Master/texmf-dist/doc/latex/hep-paper/bibliography.bib index d63b7339470..63e5ad9916e 100644 --- a/Master/texmf-dist/doc/latex/hep-paper/bibliography.bib +++ b/Master/texmf-dist/doc/latex/hep-paper/bibliography.bib @@ -1,6 +1,6 @@ @article{hep-paper, title = "The |hep-paper| package", -subtitle = "Publications in High Energy Physics", +subtitle = "Publications in high energy physics", author = "Jan Hajer", year = "2019", eprinttype = "ctan", @@ -123,7 +123,6 @@ eprint = "mathtools", @article{amsmath, title = "The |amsmath| package", subtitle = "AMS mathematical facilities for \hologo{LaTeX}", -author = "\hologo{LaTeX}", collaboration = "\hologo{LaTeX} Team", date = "1994", url = "https://ams.org/tex/amslatex", @@ -348,7 +347,9 @@ eprint = "iftex", @article{fontspec, title = "The |fontspec| package", +subtitle = "Advanced font selection in \hologo{XeLaTeX} and \hologo{LuaLaTeX}", author = "Will Robertson and Khaled Hosny", +date = "2004", eprinttype = "ctan", eprint = "fontspec", } @@ -494,7 +495,6 @@ eprint = "fmitex", title = "\hologo{LaTeX2e}\ font selection", subtitle = "Docmentation of \hologo{LaTeX} font commands", collaboration = "\hologo{LaTeX} Team", -author = "\hologo{LaTeX} Team", date = "1995", eprinttype = "ctan", eprint = "fntguide", @@ -516,6 +516,15 @@ eprinttype = "ctan", eprint = "soul", } +@article{ulem, +title = "The |ulem| package", +subtitle = "Package for underlining", +author = "Donald Arseneau", +date = "1989", +eprinttype = "ctan", +eprint = "ulem", +} + @article{glossaries, title = "The |glossaries| package", subtitle = "Create glossaries and lists of acronyms", @@ -555,13 +564,15 @@ eprint = "pdftexcmds", @article{fix-cm, title = "The |fix-cm| package", +subtitle = "Permit Computer Modern fonts at arbitrary sizes", author = "Frank Mittelbach and David Carlisle and Chris Rowley and Walter Schmidt", +date = "1993", eprinttype = "ctan", eprint = "fix-cm", } @article{revtex, -title = "The REV\hologo{TeX} package", +title = "The REV\hologo{TeX} class", subtitle = "Styles for various Physics Journals", author = "Mark Doyle and Arthur Ogawa", collaboration = "American Physical Society", @@ -656,7 +667,6 @@ eprint = "url", @article{jhep, title = "The |JHEP| package", -author = "SISSA Medialab", collaboration = "SISSA Medialab", date = "1997", url = "https://jhep.sissa.it/jhep/help/JHEP_TeXclass.jsp", @@ -664,7 +674,6 @@ url = "https://jhep.sissa.it/jhep/help/JHEP_TeXclass.jsp", @article{jcap, title = "The |JCAP| package", -author = "SISSA Medialab", collaboration = "SISSA Medialab", date = "2002", url = "https://jcap.sissa.it/jcap/help/JCAP_TeXclass.jsp", @@ -682,7 +691,7 @@ related = "bbm" @article{bbm, title = "|bbm|", subtitle = "\enquote{Blackboard-style} cm fonts", -author = " Gilles Robert", +author = "Gilles Robert", date = "1993", eprinttype = "ctan", eprint = "bbm", @@ -698,3 +707,64 @@ year = "1991", organization = "Cornell University", ReportNumber = "test", } + +@article{dsfont, +title = "The |doublestroke| font", +subtitle = "Typeset mathematical double stroke symbols", +author = "Olaf Kummer", +date = "1995", +eprinttype = "ctan", +eprint = "doublestroke", +} + +@article{mleftright, +title = "The |mleftright| package", +subtitle = "Variants of delimiters that act as maths open/close", +author = "Heiko Oberdiek", +date = "2010", +eprinttype = "ctan", +eprint = "mleftright", +} + +@article{urwchancal, +title = "A virtual font for URW Chancery Math", +subtitle = "Use URW's clone of Zapf Chancery as a maths alphabet", +author = "Michael Sharpe", +date = "2011", +eprinttype = "ctan", +eprint = "urwchancal", +} + +@article{footnotebackref, +title = "The |footnotebackref| package", +subtitle = "Back-references from footnotes", +author = "Holger Lange", +date = "2012", +eprinttype = "ctan", +eprint = "footnotebackref", +} + +@article{cancel, +title = "The |cancel| package", +subtitle = "Place lines through maths formulae", +author = "Donald Arseneau", +date = "2013", +eprinttype = "ctan", +eprint = "cancel", +} + +@article{beamer, +title = "The |beamer| class", +subtitle = "A \hologo{LaTeX} class for producing presentations and slides", +author = "Till Tantau and Joseph Wright and Vedran Miletić", +date = "2003", +eprinttype = "ctan", +eprint = "beamer", +related = "beamer-1", +} + +@manual{beamer-1, +eprinttype = "github", +eprintclass = "josephwright", +eprint = "beamer", +} diff --git a/Master/texmf-dist/doc/latex/hep-paper/hep-paper-documentation.pdf b/Master/texmf-dist/doc/latex/hep-paper/hep-paper-documentation.pdf new file mode 100644 index 00000000000..7e8d9dbdb59 Binary files /dev/null and b/Master/texmf-dist/doc/latex/hep-paper/hep-paper-documentation.pdf differ diff --git a/Master/texmf-dist/doc/latex/hep-paper/hep-paper-documentation.tex b/Master/texmf-dist/doc/latex/hep-paper/hep-paper-documentation.tex new file mode 100644 index 00000000000..0f5e7957649 --- /dev/null +++ b/Master/texmf-dist/doc/latex/hep-paper/hep-paper-documentation.tex @@ -0,0 +1,609 @@ +%% +%% This is file `hep-paper-documentation.tex', +%% generated with the docstrip utility. +%% +%% The original source files were: +%% +%% hep-paper-implementation.dtx (with options: `documentation') +%% This is a generated file. +%% Copyright (C) 2019-2020 by Jan Hajer +%% This 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. The 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. +\RequirePackage[l2tabu, orthodox]{nag} +\documentclass{ltxdoc} + +\EnableCrossrefs +\CodelineIndex +\RecordChanges + +\MacroIndent=1.5em + +\usepackage[parskip]{hep-paper} + +\bibliography{bibliography} + +\acronym{PDF}{portable document format} +\acronym{URL}{uniform resource locator} + +\usepackage{hologo} + +\newenvironment{columns}[1][.5]{% + \begin{minipage}[t]{\linewidth}% + \begin{minipage}[t]{#1\linewidth}% + \newcommand{\column}{% + \end{minipage}% + \begin{minipage}[t]{\linewidth-#1\linewidth}% + }% +}{\end{minipage}\end{minipage}} + +\setlength{\fboxsep}{1pt} + +\begin{document} + +\GetFileInfo{hep-paper.sty} + +\title{The |hep-paper| package\thanks{This document corresponds to \protecting{|hep-paper|}~\fileversion.}} +\author{Jan Hajer \email{jan.hajer@uclouvain.be}} +\affiliation{Centre for Cosmology, Particle Physics and Phenomenology, Université catholique de Louvain, Louvain-la-Neuve B-1348, Belgium} +\preprint{Preprint-Number} +\date{\normalfont\filedate} + +\maketitle + +\begin{abstract} +The |hep-paper| package 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 macros |hep-paper| preferably loads third party packages as long as they are lightweight enough. +\end{abstract} + +\tableofcontents\clearpage + +\newgeometry{vscale=.8, vmarginratio=3:4, includeheadfoot, left=11em, marginparwidth=4.6cm, marginparsep=3mm, right=7em} + +\section{Introduction} + +For usual publications it is enough to load additionally to the |article| class without optional arguments only the |hep-paper| package \cite{hep-paper}. + +| \documentclass{article}|\\ +| \usepackage{hep-paper}| + +The most notable changes after loading the |hep-paper| package is the change of some \hologo{LaTeX} defaults. +The paper and font sizes are set to A4 and \unit[11]{pt}, respectively. +Additionally, the paper geometry is set to the values known from the (depreciated) |a4wide| package \cite{a4wide} using the |geometry| package \cite{geometry}. +Furthermore, the font is changed to |lmodern| \cite{lmodern} with |microtype| \cite{microtype} optimizations. +Finally, \PDF hyperlinks are implemented with the |hyperref| package \cite{hyperref}. + +\subsection{Options} + +\DescribeMacro{paper} +The |paper=|\meta{format} option loads the specified paper format. +The possible \meta{formats} 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|. + +\DescribeMacro{font} +The |font=|\meta{size} option loads the specified font size. +The possible \meta{sizes} are: +|8pt|, |9pt|, |10pt|, |11pt|, |12pt|, |14pt|, |17pt|, |20pt|. +The default is \unit[11]{pt}. + +\DescribeMacro{lang} +The |lang|=\meta{name} option switches the document language to the chosen value. +The possible values are given by the |babel| package \cite{babel}. +The default is |british|. + +\DescribeMacro{sansserif} +The |sansserif| option switches the document including math to the sans serif font shape. + +\DescribeMacro{parskip} +The |parskip| option makes use of the |parskip| package \cite{parskip} and changes how two paragraphs are separated from each other. +The \hologo{LaTeX} default is separation via indentation the |parskip| option switches to separation via vertical space. +\footnote{Although the |parskip| option is used for this document, it is recommended only for very few document types such as technical manuals or answers to referees.} + +\subsubsection{Deactivation} + +The \software{hep-paper} package loads few bigger packages which have a large impact on the document. +The deactivation options prevent such adjustments. + +\DescribeMacro{defaults} +The |defaults| option prevents the adjustment of the page geometry and the font size set by the document class. + +\DescribeMacro{title} +The |title=false| option deactivates the title page adjustments. + +\DescribeMacro{bibliography} +The |bibliography|=\meta{key} option prevents the automatic loading of the |biblatex| package \cite{biblatex} if \meta{key}=|false|. +Otherwise the \meta{key} is passed as |style| string to the |biblatex| package. + +\DescribeMacro{glossaries} +The |glossaries=false| option deactives acronyms and the use of the |glossaries| package \cite{glossaries}. + +\DescribeMacro{references} +The |references=false| option prevents the |cleveref| pacakge \cite{cleveref} from being loaded and deactivates further redefinitions of reference macros. + +\subsubsection{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 \software{hep-paper} is able to detect the presence of such a class or package, \ie if it is loaded before the \software{hep-paper} package, the compatibility mode is activated automatically. + +\DescribeMacro{beamer} +The |beamer| option activates the \software{beamer} \cite{beamer} compatibility mode. + +\DescribeMacro{jhep} +The |jhep| option activates the \software{JHEP} \cite{jhep} compatibility mode. + +\DescribeMacro{jcap} +The |jcap| option activates the \software{JCAP} \cite{jcap} compatibility mode. + +\DescribeMacro{revtex} +The |revtex| option activates the REV\hologo{TeX} \cite{revtex} compatibility mode. + +\DescribeMacro{pos} +The |pos| option activates the \software{PoS} compatibility mode. + +\subsubsection{Reactivation} + +The \software{hep-paper} package deactivates unrecommended macros, which can be reactivated manually. + +\DescribeMacro{manualplacement} +The |manualplacement| option reactivates manual float placement. + +\DescribeMacro{eqnarray} +The |eqnarray| option reactivates the depreciated |eqnarray| environment. + +\section{Macros and environments} + +\subsection{Title page} + +\DescribeMacro{\author} +\DescribeMacro{\affiliation} +\DescribeMacro{\email} +In order to facilitate multiple authors with different affiliations the |authblk| package \cite{authblk} is loaded. +The following lines add \eg two authors with different affiliations + +| \author[1]{Author one \email{Email one}}|\\ +| \affiliation[1]{Affiliation one}|\\ +| \author[2]{Author two \email{Email two}}|\\ +| \affiliation[1,2]{Affiliation two}| + +\DescribeMacro{\title} +The \PDF meta information is set according to the |\title|\marg{text} and |\author| \marg{text} information. + +\DescribeMacro{\preprint} +The |\preprint|\marg{numer} macro places a pre-print number in the upper right corner of the title page. + +\DescribeEnv{abstract} +The |abstract| environment is adjusted to not start with an indentation. + +\subsection{Text} + +Hyphenation is provided by the |babel| package \cite{babel} and quotation commands are provided by the |csquotes| package \cite{csquotes} recommended by the |babel| package. +\DescribeMacro{\enquote} +\DescribeMacro{\MakeOuterQuote} +The latter package provides the convenient macros |\enquote|\marg{text} and |\MakeOuterQuote{"}| allowing to leave the choice of quotation marks to \hologo{LaTeX} and use |"| instead of the pair |``| and |''|, respectively. + +\DescribeMacro{\eg} +\DescribeMacro{\vs} +The |foreign| package \cite{foreign} defines macros such as |\eg|, |\ie|, |\cf|, and |\vs| which are typeset as \eg, \ie, \cf, and \vs. + +\DescribeMacro{\no} +The |\no|\marg{number} macro is typeset as \no{123}. + +\DescribeMacro{\software} +The |\software|\oarg{version}\marg{name} macro is typeset as \software[\fileversion]{HEP-Paper}. + +\DescribeMacro{\online} +The |\online|\marg{url}\marg{text} macro combines the features of the |\href|\marg{url} \marg{text} \cite{hyperref} and the |\url|\marg{text} \cite{url} macros, resulting in \eg \online{https://ctan.org/pkg/hep-paper}{ctan.org/pkg/hep-paper}. + +The |inlinelist| and |enumdescript| environments are defined using the |enumitem| package \cite{enumitem}. + +\DescribeMacro{inlinelist} +\begin{columns} +|The three main points are| +|\begin{inlinelist}| + +| \item one| + +| \item two| + +| \item three| + +|\end{inlinelist}| +\column +The three main points are +\begin{inlinelist} + \item one + \item two + \item three +\end{inlinelist} +\end{columns} + +\DescribeMacro{enumdescript} +\begin{columns}[.6] +|\begin{enumdescript}[label=\Roman*)]| + +| \item{First} one| + +| \item{Second} two| + +| \item{Third} three| + +|\end{enumdescript}| +\column +\begin{enumdescript}[label=\Roman*)] + \item{First} one + \item{Second} two + \item{Third} three +\end{enumdescript} +\end{columns} + +\DescribeMacro{\textsc} +A bold versions \textbf{\textsc{Small Caps}} and a sans serif version of \textsf{\textsc{Small Caps}} is provided, using the |sansmathfonts| package \cite{sansmathfonts}. + +\DescribeMacro{\underline} +\DescribeMacro{\overline} +The |\underline| macro is redefined to allow line-breaks using the |ulem| package \cite{ulem}. +The |\overline| macro is extended to also \overline{overline} text outside of math environments. + +\DescribeMacro{\useparskip} +\DescribeMacro{\useparindent} +If the |parskip| option is activated the |\useparindent| macro switches back the usual parindent mode, while the |\useparskip| macro switches to the parskip mode. + +\subsubsection{References and footnotes} + +\DescribeMacro{\cref} +References are extended with the |cleveref| package \cite{cleveref}, which allows to \eg just type |\cref|\marg{key} in order to write \enquote{figure 1}. +Furthermore, the |cleveref| package allows to reference multiple objects within one |\cref|\marg{key1,key2}. + +\DescribeMacro{\cite} +Citations are adjusted to not start on a new line in order to avoid the repeated use of |~\cite|\marg{key}. + +\DescribeMacro{\ref} +\DescribeMacro{\eqref} +\DescribeMacro{\subref} +References are also adjusted to not start on a new line and are redefined in order to handle multiple references at once. + +\DescribeMacro{\footnote} +Footnotes are adjusted to swallow white space before the footnote mark and at the beginning of the footnote text. + +\subsubsection{Acronyms} + +\DescribeMacro{\acronym} +\DescribeMacro{\shortacronym} +\DescribeMacro{\longacronym} +The |\acronym|\meta{*}\oarg{typeset abbreviation}\marg{abbreviation}\meta{*}\marg{definition}\oarg{plural\linebreak[4]definition} macro generates the singular |\|\meta{abbreviation} and plural |\|\meta{abbreviation}|s| macros. +The first star prevents the addition of an \enquote{s} to the abbreviation plural. +The second star restores the \hologo{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. +Capitalization at the beginning of paragraphs and sentences is ensured. +The |\shortacronym| and |\longacronym| macros are drop-in replacements of the |\acronym| macro showing only the short or long form of their acronym. +\DescribeMacro{\resetacronym} +\DescribeMacro{\dummyacronym} +The first use form of the acronym can be enforced by resetting the acronym counter with |\resetacronym|\marg{key}. +If the acronym counter equals one at the end of the document the short form of the acronym is not introduced. +Placing a |\dummyacronym|\marg{key} at the end of the document ensures that the short form is introduced. + +\subsection{Math} + +The |mathtools| \cite{mathtools} and |amssymb| \cite{amsfonts} packages are loaded. +They in turn load the \hologo{AmSLaTeX} |amsmath| \cite{amsmath} and |amsfonts| \cite{amsfonts} packages. +\DescribeMacro{\mathbf} +Bold math, via |\mathbf| is improved by the |bm| package \cite{bm}, \ie ($ A b \Gamma \delta \mathbf A \mathbf b \mathbf \Gamma \mathbf \delta$). +Macros switching to |bfseries| such as |\section|\marg{text} are ensured to also typeset math in bold. +This may cause trouble if bold symbols carry an additional non-implicit meaning. +\DescribeMacro{\text} +The |\text|\marg{text} macro makes it possible to write text within math mode, \ie ($ \text A \text b \text \Gamma \text \delta \text{\textbf A} \text{\textbf b} \text{\textbf \Gamma} \text{\textbf \delta}$). +The often used |\mathrm|\marg{text} and |{\rm|\meta{text}|}| macros are \emph{not} the correct tool for this purpose, as they switch to roman font shape. +This behaviour conflicts \eg with the |sansserif| package option. +\DescribeMacro{\mathsf} +The math sans 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, \ie ($\mathsf A \mathsf b \mathsf \Gamma \mathsf \delta \mathbf{\mathsf A} \mathbf{\mathsf b} \mathbf{\mathsf \Gamma} \mathbf{\mathsf \delta}$). +\DescribeMacro{\mathscr} +The |\mathcal| font \ie ($\mathcal{ABCD}$) is accompanied by the |\mathscr| font \ie ($\mathscr{ABCD}$). +\DescribeMacro{\mathbb} +The |\mathbb| font is improved by the |doublestroke| package \cite{dsfont} and adjusted depending on the |sansserif| option \ie ($\mathbb{Ah1}$). +\DescribeMacro{\mathfrak} +Finally, the |\mathfrak| font is also available \ie ($\mathfrak{AaBb12}$). +Details about the font handling in \hologo{TeX} can be found in \ccite{fntguide}. + +\DescribeMacro{\nicefrac} +\DescribeMacro{\flatfrac} +The |\frac|\marg{number}\marg{number} macro is accompanied by |\nicefrac|\linebreak[1]\marg{number}\linebreak[1]\marg{number} and |\flatfrac|\marg{number}\marg{number} leading to $\frac12$, $\nicefrac 12$, and $\flatfrac 12$. +\DescribeMacro{\diag} +\DescribeMacro{\sgn} +Diagonal matrix |\diag| and signum |\sgn| operators are defined. + +\DescribeMacro{\mathdef} +The |\mathdef|\marg{name}\oarg{arguments}\marg{code} macro (re-)defines macros only within math mode without changing the text mode definition. + +\DescribeMacro{\i} +\DescribeMacro{\d} +The imaginary unit $\i$ and the differential $\d$ are defined using this functionality. + +\DescribeMacro{\numberwithin} +For longer paper it can be useful to re-number the equation in accordance with the section numbering |\numberwithin{equation}{section}|. +\DescribeMacro{subequations} +In order to further reduce the size the of equation counter it can be useful to wrap |align| environments with multiple rows in a |subequations| environment. +Both macros are provided by the |amsmath| package. + +\DescribeMacro{eqnarray} +The depreciated |eqnarray| environment is undefined as long this behaviour is not prevented by the |eqnarray| package option. +The |split|, |multline|, |align|, |multlined|, |aligned|, |alignedat|, and |cases| environments of the |amsmath| and |mathtools| packages should be used instead. + +\DescribeMacro{equation} +Use the |equation| environment for short equations. + +\begin{columns} +|\begin{equation}| + +| left = right \ .| + +|\end{equation}| +\column +\begin{equation} +\framebox[2em]{left\strut} = \framebox[7em]{right\strut} \ . +\end{equation} +\end{columns} + +\DescribeMacro{multline} +Use the |multline| environment for longer equations. + +\begin{columns} +|\begin{multline}| + +| left = right 1 \\| + +| + right 2 \ .| + +|\end{multline}| +\column +\begin{multline} +\framebox[2em]{left\strut} = \framebox[7em]{right 1\strut} \\ +\framebox[7em]{+ right 2\strut} \ . + \end{multline} +\end{columns} + +\DescribeMacro{split} +Use the |split| sub environment for equations in which multiple equal signs should be aligned. + +\begin{columns} +|\begin{equation} \begin{split}| + +| left &= right 1 \\| + +| &= right 2 \ .| + +|\end{split} \end{equation}| +\column +\begin{equation} +\begin{split} +\framebox[2em]{left\strut} &= \framebox[7em]{right 1\strut} \\ +&= \framebox[7em]{right 2\strut} \ . +\end{split} +\end{equation} +\end{columns} + +\DescribeMacro{align} +Use the |align| environment for the vertical alignment and horizontal distribution of multiple equations. + +\begin{columns} +|\begin{subequations}| +|\begin{align}| + +| left &= right \ , &| +| left &= right \ , \\| +| left &= right \ , &| +| left &= right \ .| + +|\end{align}| +|\end{subequations}| +\column +\begin{subequations} +\begin{align} +\framebox[2em]{left\strut} &= \framebox[3em]{right\strut} \ , & +\framebox[2em]{left\strut} &= \framebox[3em]{right\strut} \ , \\ +\framebox[2em]{left\strut} &= \framebox[3em]{right\strut} \ , & +\framebox[2em]{left\strut} &= \framebox[3em]{right\strut} \ . +\end{align} +\end{subequations} +\end{columns} + +\DescribeMacro{aligned} +Use the |aligned| environment within a |equation| environment if the aligned equations should be labeled with a single equation number. + +\DescribeMacro{multlined} +Use the |multlined| environment if either |split| or |align| contain very long lines. + +\begin{columns} +|\begin{equation} \begin{split}| + +| left &= right 1 \\ &=| +| \begin{multlined}[t]| +| right 2 \\ + right 3 \ .| +| \end{multlined}| +|\end{split} \end{equation}| +\column +\begin{equation} +\begin{split} +\framebox[2em]{left\strut} &= \framebox[7em]{right 1\strut} \\ &= + \begin{multlined}[t] + \framebox[7em]{right 2\strut} \\ + \framebox[7em]{+ right 3\strut} \ . +\end{multlined} +\end{split} +\end{equation} +\end{columns} + +\DescribeMacro{alignat} +Use the |alignat| environment together with the |\mathllap| macro for the alignment of multiple equations with vastly different lengths. + +\begin{columns} +|\begin{subequations}| +|\begin{alignat}{2}| + +| left &= long right && \ , \\| + +| le. 2 &= ri. 2 \ , &| + +| \mathllap{le. 3 = ri. 3} & \ .| +|\end{alignat}| +|\end{subequations}| +\column +\begin{subequations} +\begin{alignat}{2} +\framebox[2em]{left\strut} &= +\framebox[11em]{long right\strut} && \ , \\ +\framebox[2em]{le.\ 2\strut} +&= \framebox[2.5em]{ri.\ 2\strut} \ , & +\mathllap{\framebox[2em]{le.\ 3\strut} += \framebox[2.5em]{ri.\ 3\strut}} & \ . +\end{alignat} +\end{subequations} +\end{columns} + +As a rule of thumb if you have to use |\notag|, |\nonumber|, or perform manual spacing via |\quad| you are probably using the wrong environment. + +\subsubsection{Physics} + +Greek letters are adjusted to always be italic and upright in math and text mode, respectively, using the |fixmath| \cite{fixmath} and |alphabeta| \cite{alphabeta} packages. +This allows differentiations like +\begin{align} +\sigma &= \unit[5]{fb} \ , & &\text{at \unit[5]{\sigma} C.L.} \ , & \mu &= \unit[5]{cm} \ , & l &= \text{\unit[5]{\mu m}} \ , +\label{eq:greek} +\end{align} +and \eg to distinguish gauge $\nu$ and mass \nu\ eigenstates in models with massive neutrinos. +Additionally, Greek letters can also be directly typed using Unicode. + +\DescribeMacro{\ev} +\DescribeMacro{\pdv} +\DescribeMacro{\comm} +\DescribeMacro{\order} +The |physics| package \cite{physics} provides additional macros such as +\begin{align} +&\ev{\phi} \ , +&&\pdv[n]{f}{x} \ , +&&\comm{A}{B} \ , +&&\order{x^2} \ , +&&\eval{x}_0^\infty \ , +&&\det(M)\ . +\end{align} + +\DescribeMacro{\cancel} +\DescribeMacro{\slashed} +The |\cancel|\marg{characters} macro from the |cancel| \cite{cancel} package and the |\slashed| \marg{character} macro from the |slashed| \cite{slashed} package allow to $\cancel{\text{cancel}}$ math and use the Dirac slash notation \ie $\slashed \partial$, respectively. + +\DescribeMacro{\overleftright} +A better looking over left right arrow is defined \ie $\overleftright{\partial}$. + +\DescribeMacro{\unit} +\DescribeMacro{\inv} +The correct spacing for units, \cf \cref{eq:greek}, is provided by the macro |\unit|\oarg{value} \marg{unit} from the |units| package \cite{units} which can also be used in text mode. +The macro |\inv|\oarg{power}\marg{text} allows to avoid math mode also for inverse units such as \unit[5]{\inv{fb}} typeset via |\unit[5]{\inv{fb}}|. + +\subsection{Floats} + +\DescribeEnv{figure} +\DescribeEnv{table} +Automatic float placement is adjusted to place a single float at the top of pages and to reduce the number of float pages, using the \hologo{LaTeX} macros. + +|\setcounter{bottomnumber}{0}| \hfill no floats at the bottom of a page (default 1) \\ +|\setcounter{topnumber}{1}| \hfill a single float at the top of a page (default 2) \\ +|\setcounter{dbltopnumber}{1}| \hfill same for full widths floats in two-column mode \\ +|\renewcommand{\textfraction}{.1}| \hfill large floats are allowed (default 0.2)\\ +|\renewcommand{\topfraction}{.9}| \hfill (default 0.7) \\ +|\renewcommand{\dbltopfraction}{.9}| \hfill (default 0.7) \\ +|\renewcommand{\floatpagefraction}{.8}| \hfill float pages must be full (default 0.5) + +Additionally, manual float placement is deactivated but can be reactivated using the |manualplacement| package option. +It is however recommended to archive the desired design by adjusting above macros. +The most useful float placement is usually archived by placing the float \emph{in front} of the paragraph it is referenced in first. +\DescribeMacro{\raggedright} +The float environments have been adjusted to center their content. +The usual behaviour can be reactivated using |\raggedright|. + +\begin{table} +\begin{panels}{.6} +\raggedright +|\begin{panels}{.6}|\\ +|code|\\ +|\panel{.4}|\\ +|\begin{tabular}...\end{tabular}|\\ +|\end{panels}|\\ +\caption{Code for this panel environment.} +\label{tab:panels} +\panel{.4} +\begin{tabular}{cccc} +\toprule +\multicolumn{2}{c}{one}& \multicolumn{2}{c}{two} \\ \cmidrule(r){1-2} \cmidrule(l){3-4} +\multirow{2}{*}{a} & b & c & d \\ + & b & c & d \\ +\bottomrule +\end{tabular} +\caption{The \protecting{|booktabs|} and \protecting{|multirow|} features.} +\label{tab:booktabs} +\end{panels} +\caption{Example use of the \protecting{|panels|} environment in Panel \subref{tab:panels} and the features from the \protecting{|booktabs|} and \protecting{|multirow|} packages in Panel \subref{tab:booktabs}. +} \label{tab:table} +\end{table} + +\DescribeEnv{panels} +\DescribeMacro{\panel} +The |panels| environment makes use of the |subcaption| package \cite{subcaption}. +It provides sub-floats and takes as mandatory argument either the number of sub-floats (default~2) or the width of the first sub-float as fraction of the |\linewidth|. +Within the |\begin{panels}|\oarg{vertical alignment}\marg{width} 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|\marg{width} macro takes the width of the next sub-float as mandatory argument. +The example code is presented in \cref{tab:panels}. + +\DescribeEnv{tabular} +The |booktabs| \cite{booktabs} and |multirow| \cite{multirow} packages are loaded enabling publication quality tabulars such as in \cref{tab:booktabs}. + +\DescribeMacro{\graphic} +\DescribeMacro{\graphics} +The |graphicx| package \cite{graphicx} is loaded and the |\graphic|\oarg{width}\marg{figure} macro is defined, which is a wrapper for the |\includegraphics|\marg{figure} macro and takes the figure width as fraction of the |\linewidth| as optional argument (default~1). +If the graphics are located in a sub-folder its path can be indicated by |\graphics|\marg{subfolder}. + +\subsection{Bibliography} + +\DescribeMacro{\bibliography} +\DescribeMacro{\printbibliography} +The |biblatex| package \cite{biblatex} is loaded for bibliography management. +The user has to add the line |\bibliography|\marg{my.bib} to the preamble of the document and |\printbibliography| at the end of the document. +The bibliography is generated by \software{Biber} \cite{biber}. +|biblatex| is extended to be able to cope with the |collaboration| and |reportNumber| fields provided by \online{https://inspirehep.net}{inspirehep.net} and a bug in the volume number is fixed. +Additionally, the PubMed IDs are recognized and \online{https://ctan.org}{ctan.org}, \online{https://github.com}{github.com}, \online{https://gitlab.com}{gitlab.com}, \online{https://bitbucket.org}{bitbucket.org}, \online{https://www.launchpad.net}{launchpad.net}, \online{https://sourceforge.net}{sourceforge.net}, and \online{https://hepforge.org}{hepforge.org} are valid |eprinttype|s. +\DescribeMacro{erratum} +Errata can be included using the |related| feature. + +| \article{|\meta{key1}|,|\\ +| |\dots|,|\\ +| relatedtype="erratum",|\\ +| related="|\meta{key2}|",|\\ +| }|\\ +| \article{|\meta{key2}|,|\\ +| |\dots|,|\\ +| }| + +\section{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. + +\DescribeMacro{arxiv-collector} +\nolinkurl{arxiv.org} \cite{arxiv} requires the setup dependent |bbl| files instead of the original |bib| files, which causes trouble if the local \hologo{LaTeX} version differs from the one used by arXiv. +The |arxiv-collector| python script \cite{arxiv-collector} alleviates this problem by collecting all files necessary for publication on arXiv (including figures). + +\printbibliography + +\end{document} + +\endinput +%% +%% End of file `hep-paper-documentation.tex'. diff --git a/Master/texmf-dist/doc/latex/hep-paper/hep-paper-implementation.pdf b/Master/texmf-dist/doc/latex/hep-paper/hep-paper-implementation.pdf new file mode 100644 index 00000000000..b087bd542ea Binary files /dev/null and b/Master/texmf-dist/doc/latex/hep-paper/hep-paper-implementation.pdf differ diff --git a/Master/texmf-dist/doc/latex/hep-paper/hep-paper.pdf b/Master/texmf-dist/doc/latex/hep-paper/hep-paper.pdf deleted file mode 100644 index 4142b2afe7d..00000000000 Binary files a/Master/texmf-dist/doc/latex/hep-paper/hep-paper.pdf and /dev/null differ -- cgit v1.2.3