diff options
| -rw-r--r-- | Master/texmf-dist/doc/latex/hep-paper/README.md | 15 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/hep-paper/bibliography.bib | 520 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/hep-paper/hep-paper.pdf | bin | 425702 -> 535697 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/hep-paper/license.md | 416 | ||||
| -rw-r--r-- | Master/texmf-dist/source/latex/hep-paper/hep-paper.dtx | 1498 | ||||
| -rw-r--r-- | Master/texmf-dist/tex/latex/hep-paper/hep-paper.sty | 617 |
6 files changed, 2478 insertions, 588 deletions
diff --git a/Master/texmf-dist/doc/latex/hep-paper/README.md b/Master/texmf-dist/doc/latex/hep-paper/README.md index 9479966148e..e35410f36ec 100644 --- a/Master/texmf-dist/doc/latex/hep-paper/README.md +++ b/Master/texmf-dist/doc/latex/hep-paper/README.md @@ -1,12 +1,13 @@ -# README for the hep-paper package +# The `hep-paper` package -A LaTeX package for publications in High Energy Physics +A `LaTeX` package for publications in High Energy Physics. ## Introduction -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 light weight enough. -For usual publications it is enough to load additionally to the article class without optional arguments only the hep-paper package. +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. + +For usual publications it is enough to load additionally to the `article` class without optional arguments only the `hep-paper` package. \documentclass{article} \usepackage{hep-paper} @@ -17,5 +18,5 @@ Jan Hajer ## License -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. +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. diff --git a/Master/texmf-dist/doc/latex/hep-paper/bibliography.bib b/Master/texmf-dist/doc/latex/hep-paper/bibliography.bib index 2548f3b3677..5b295b1c37b 100644 --- a/Master/texmf-dist/doc/latex/hep-paper/bibliography.bib +++ b/Master/texmf-dist/doc/latex/hep-paper/bibliography.bib @@ -1,197 +1,272 @@ -@software{hep-paper, - author = "Jan Hajer", - title = "hep-paper, - year = 2020, - doi = "10.5281/zenodo.3606437", - eprinttype = "ctan", - eprint = "hep-paper", +@manual{hep-paper, +title = "The |hep-paper| package", +subtitle = "Publications in High Energy Physics", +author = "Jan Hajer", +year = "2019", +eprinttype = "ctan", +eprint = "hep-paper", +related = "hep-paper-1", +} + +@manual{hep-paper-1, +doi = "10.5281/zenodo.3606436", +eprinttype = "github", +eprintclass = "janhajer", +eprint = "hep-paper", } -@online{cleveref, -title = "cleveref", +@manual{cleveref, +title = "The |cleveref| package", +subtitle = "Intelligent cross-referencing", author = "Toby Cubitt", -url = "http://mirrors.ctan.org/macros/latex/contrib/cleveref/cleveref.pdf", +date = "2006", +url = "http://www.dr-qubit.org/cleveref.html", eprinttype = "ctan", eprint = "cleveref", } -@online{foreign, -title = "foreign", +@manual{foreign, +title = "The |foreign| package for \LaTeX2e", +subtitle = "Systematic treatment of \enquote{foreign} words in documents", author = "Philip G. Ratcliffe", -url = "http://mirrors.ctan.org/macros/latex/contrib/foreign/foreign.pdf", +date = "2012", eprinttype = "ctan", eprint = "foreign", } -@online{geometry, -title = "geometry", +@manual{geometry, +title = "The |geometry| package", +subtitle = "Flexible and complete interface to document dimensions", author = "David Carlisle and Hideo Umeki", -url = "http://mirrors.ctan.org/macros/latex/contrib/geometry/geometry.pdf", +date = "1996", eprinttype = "ctan", eprint = "geometry", +related = "geometry-1", +} + +@manual{geometry-1, +eprinttype = "github", +eprintclass = "davidcarlisle", +eprint = "geometry", } -@online{a4wide, -title = "a4wide", +@manual{a4wide, +title = "The |a4wide| package", +subtitle = "\enquote{Wide} a4 layout", author = "Alexander Holt and Jean-François Lamy", -url = "http://mirrors.ctan.org/macros/latex/contrib/a4wide/a4wide.pdf", +date = "1986", eprinttype = "ctan", eprint = "a4wide", +note = "depreciated and not used", } -@online{microtype, -title = "microtype", +@manual{microtype, +title = "The |microtype| package", +subtitle = "Subliminal refinements towards typographical perfection", author = "Robert Schlicht", -url = "http://mirrors.ctan.org/macros/latex/contrib/microtype/microtype.pdf", +date = "2004", eprinttype = "ctan", eprint = "microtype", } -@online{authblk, -title = "authblk", +@manual{authblk, +title = "A \LaTeX\ Package to Prepare Author and Affiliation Blocks", +subtitle = "Support for footnote style author/affiliation", author = "Patrick W. Daly", -url = "http://mirrors.ctan.org/macros/latex/contrib/authblk/authblk.pdf", +date = "2001", eprinttype = "ctan", eprint = "authblk", } -@online{bm, -title = "bm", +@manual{bm, +title = "The |bm| package", +subtitle = "Access bold symbols in maths mode", author = "David Carlisle and Frank Mittelbach", -url = "http://mirrors.ctan.org/macros/latex/required/tools/bm.pdf", +collaboration = "\LaTeX\ Team", +date = "1993", eprinttype = "ctan", eprint = "bm", } -@online{empheq, -title = "empheq", +@manual{empheq, +title = "The |empheq| package", author = "Lars Madsen and Morten Høgholm and Will Robertson and Joseph Wright", -url = "http://mirrors.ctan.org/macros/latex/contrib/mathtools/empheq.pdf", eprinttype = "ctan", eprint = "empheq", } -@online{mathtools, -title = "mathtools", +@manual{mathtools, +title = "The |mathtools| package", +subtitle = "Mathematical tools to use with |amsmath|", author = "Lars Madsen and Morten Høgholm and Will Robertson and Joseph Wright", -url = "http://mirrors.ctan.org/macros/latex/contrib/mathtools/mathtools.pdf", +date = "2004", eprinttype = "ctan", eprint = "mathtools", } -@online{amsmath, -title = "amsmath", -author = "LaTeX", -collaboration = "LaTeX", -url = "http://mirrors.ctan.org/macros/latex/required/amsmath/amsldoc.pdf", +@manual{amsmath, +title = "The |amsmath| package", +subtitle = "AMS mathematical facilities for \LaTeX", +author = "\LaTeX", +collaboration = "\LaTeX\ Team", +date = "1994", +url = "http://www.ams.org/tex/amslatex.html", eprinttype = "ctan", eprint = "amsmath", } -@online{amsfonts, -title = "amsfonts", +@manual{amsfonts, +title = "The |amsfonts| package", +subtitle = "\TeX\ fonts from the American Mathematical Society", author = "Michael Downes and David M. Jones and Frank Mittelbach and Rainer Schöpf", -url = "http://mirrors.ctan.org/fonts/amsfonts/doc/amsfndoc.pdf", +collaboration = "American Mathematical Society", +date = "1995", +url = "http://www.ams.org/tex/amsfonts.html", eprinttype = "ctan", eprint = "amsfonts", } -@online{amssymb, -title = "amssymb", +@manual{amssymb, +title = "The |amssymb| package", author = "Michael Downes and David M. Jones and Frank Mittelbach and Rainer Schöpf", -url = "http://mirrors.ctan.org/fonts/amsfonts/doc/amsfndoc.pdf", +collaboration = "American Mathematical Society", +date = "1995", eprinttype = "ctan", eprint = "amsfonts", } -@online{slashed, -title = "slashed", +@manual{slashed, +title = "The |slashed| package", +subtitle = "Put a slash through characters", author = "David Carlisle", +date = "1987", eprinttype = "ctan", eprint = "slashed", } -@online{physics, -title = "physics", +@manual{physics, +title = "The |physics| package", +subtitle = "Macros supporting the Mathematics of Physics", author = "Sergio C. de la Barrera", -url = "http://mirrors.ctan.org/macros/latex/contrib/physics/physics.pdf", +date = "2012", eprinttype = "ctan", eprint = "physics", } -@online{units, -title = "units", +@manual{units, +title = "The |units| and |nicefrac| packages", +subtitle = "Typeset units", author = "Axel Reichert", -url = "http://mirrors.ctan.org/macros/latex/contrib/units/units.pdf", +date = "1998", eprinttype = "ctan", eprint = "units", } -@online{subcaption, -title = "subcaption", +@manual{subcaption, +title = "The |subcaption| package", +subtitle = "Support for sub-captions", author = "Axel Sommerfeldt", -url = "http://mirrors.ctan.org/macros/latex/contrib/caption/subcaption.pdf", +date = "2007", eprinttype = "ctan", eprint = "subcaption", } -@online{biblatex, -title = "biblatex", +@manual{caption, +title = "The |caption| package", +subtitle = "Customising captions in floating environments", +author = "Axel Sommerfeldt", +date = "1994", +eprinttype = "ctan", +eprint = "caption", +related = "caption-1", +} + +@manual{caption-1, +eprinttype = "gitlab", +eprintclass = "axelsommerfeldt", +eprint = "caption", +} + + +@manual{biblatex, +title = "The |biblatex| Package", +subtitle = "Sophisticated Bibliographies in \LaTeX", author = "Philipp Lehman and Joseph Wright and Audrey Boruvka and Philip Kime", -url = "http://mirrors.ctan.org/macros/latex/contrib/biblatex/doc/biblatex.pdf", +date = "2006", eprinttype = "ctan", eprint = "biblatex", +related = "biblatex-1", +} + +@manual{biblatex-1, +eprinttype = "github", +eprintclass = "plk", +eprint = "biblatex", } -@online{hyperref, -title = "hyperref", +@manual{hyperref, +title = "Hypertext marks in \LaTeX: a manual for |hyperref|", +subtitle = "Extensive support for hypertext in \LaTeX", author = "Sebastian Rahtz and Heiko Oberdiek", -url = "http://mirrors.ctan.org/macros/latex/contrib/hyperref/doc/manual.pdf", +collaboration = "\LaTeX3 Project", +date = "1995", eprinttype = "ctan", eprint = "hyperref", +related = "hyperref-1", +} + +@manual{hyperref-1, +eprinttype = "github", +eprintclass = "latex3", +eprint = "hyperref", } -@online{graphicx, -title = "graphicx", +@manual{graphicx, +title = "Packages in the \enquote{graphics} bundle", +subtitle = "Enhanced support for graphics", author = "David Carlisle and Sebastian Rahtz", -url = "http://mirrors.ctan.org/macros/latex/required/graphics/grfguide.pdf", +date = "1994", eprinttype = "ctan", eprint = "graphicx", } -@online{booktabs, -title = "booktabs", +@manual{booktabs, +title = "The |booktabs| package", +subtitle = "Publication quality tables in \LaTeX", author = "Danie Els and Simon Fear", -url = "http://mirrors.ctan.org/macros/latex/contrib/booktabs/booktabs.pdf", +date = "1995", eprinttype = "ctan", eprint = "booktabs", } -@online{multirow, -title = "multirow", +@manual{multirow, +title = "The |multirow|, |bigstrut| and |bigdelim| packages", +subtitle = "Create tabular cells spanning multiple rows", author = "Piet van Oostrum and Jerry Leichter", -url = "http://mirrors.ctan.org/macros/latex/contrib/multirow/multirow.pdf", +date = "1994", eprinttype = "ctan", eprint = "multirow", } -@online{fixmath, -title = "fixmath", +@manual{fixmath, +title = "The |fixmath| package for \LaTeX2\epsilon", +subtitle = "Make maths comply with ISO 31-0:1992 to ISO 31-13:1992", author = "Walter Schmidt", -url = "http://mirrors.ctan.org/macros/latex/contrib/was/fixmath.pdf", +date = "2000", eprinttype = "ctan", eprint = "fixmath", } -@online{alphabeta, -title = "alphabeta", +@manual{alphabeta, +title = "The |alphabeta| package", +subtitle = "LICR macros and encoding definition files for Greek", author = "Günter Milde", -url = "http://mirrors.ctan.org/language/greek/greek-fontenc/alphabeta-doc.pdf", +date = "2013", eprinttype = "ctan", eprint = "greek-fontenc", } -@online{arxiv-collector, +@manual{arxiv-collector, title = "arxiv-collector", author = "Dougal Sutherland", eprinttype = "github", @@ -199,118 +274,315 @@ eprintclass = "dougalsutherland", eprint = "arxiv-collector", } -@online{biber, +@manual{biber, title = "biber", author = "François Charette and Philip Kime", eprinttype = "github", eprintclass = "plk", eprint = "biber", -url = "https://sourceforge.net/projects/biblatex-biber", +related = "biber-1", } -@online{lmodern, -title = "lmodern", +@manual{biber-1, +eprinttype = "sourceforge", +eprint = "biblatex-biber", +} + +@manual{lmodern, +title = "Latin Modern Family of Fonts", +subtitle = "Latin modern fonts in outline formats", +date = "2003", author = "B. Jackowski and J.M. Nowacki", -url = "https://www.ctan.org/tex-archive/fonts/lm", +url = "http://www.gust.org.pl/projects/e-foundry/latin-modern", eprinttype = "ctan", eprint = "lm", } -@online{ifluatex, -title = "ifluatex", -collaboration = "LaTeX", +@manual{ifluatex, +title = "The |ifluatex| package", +subtitle = "Provides the |\textbackslash ifluatex| switch", author = "Heiko Oberdiek", -url = "http://mirrors.ctan.org/macros/latex/contrib/iftex/README.md", +collaboration = "\LaTeX\ Team", +date = "2007", eprinttype = "ctan", eprint = "ifluatex", } -@online{fontspec, -title = "fontspec", +@manual{ifxetex, +title = "The |iftex| package", +subtitle = "Am I running under XeTeX?", +collaboration = "\LaTeX\ Team", +author = "Will Robertson", +date = "2006", +eprinttype = "ctan", +eprint = "ifxetex", +related = "ifxetex-1", +} + +@manual{ifxetex-1, +eprinttype = "github", +eprintclass = "latex3", +eprint = "iftex", +} + +@manual{fontspec, +title = "The |fontspec| package", author = "Will Robertson and Khaled Hosny", -url = "http://mirrors.ctan.org/macros/latex/contrib/fontspec/fontspec.pdf", eprinttype = "ctan", eprint = "fontspec", } -@online{fontenc, -title = "fontenc", -collaboration = "LaTeX", -author = "LaTeX", +@manual{fontenc, +title = "The |fontenc| package", +subtitle = "Standard package for selecting font encodings", +collaboration = "\LaTeX\ Team", +author = "\LaTeX\ Team", eprinttype = "ctan", eprint = "fontenc", } -@online{inputenc, -title = "inputenc", -collaboration = "LaTeX", +@manual{inputenc, +title = "The |inputenc| package", +subtitle = "Accept different input encodings", +collaboration = "\LaTeX\ Team", author = "Frank Mittelbach and Alan Jeffrey", -url = "http://mirrors.ctan.org/macros/latex/base/inputenc.pdf", eprinttype = "ctan", eprint = "inputenc", } -@online{textcomp, -title = "textcomp", -collaboration = "LaTeX", -author = "LaTeX", -url = "http://mirrors.ctan.org/obsolete/fonts/psfonts/ts1/README", +@manual{textcomp, +title = "The |textcomp| package", +subtitle = "\LaTeX\ support for the Text Companion fonts", +collaboration = "\LaTeX\ Team", +author = "Sebastian Rahtz", +date = "1995", eprinttype = "ctan", eprint = "textcomp", } -@online{enumitem, -title = "enumitem", +@manual{enumitem, +title = "Customizing lists with the |enumitem| package", +subtitle = "Control layout of itemize, enumerate, description", author = "Javier Bezos", -url = "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf", +date = "2003", +url = " http://www.texnia.com/enumitem.html", eprinttype = "ctan", eprint = "enumitem", +related = "enumitem-1", +} + +@manual{enumitem-1, +eprinttype = "github", +eprintclass = "jbezos", +eprint = "enumitem", } -@online{atbegshi, -title = "atbegshi", +@manual{atbegshi, +title = "The |atbegshi| package", +subtitle = "Execute stuff at |shipout| time", author = "Heiko Oberdiek", -url = "http://mirrors.ctan.org/macros/latex/contrib/atbegshi/atbegshi.pdf", +date = "2007", eprinttype = "ctan", eprint = "atbegshi", +related = "atbegshi-1", } -@online{picture, -title = "picture", +@manual{atbegshi-1, +eprinttype = "github", +eprintclass = "ho-tex", +eprint = "atbegshi", +} + +@manual{picture, +title = "The |picture| package", +subtitle = "Dimens for picture macros", author = "Heiko Oberdiek", -url = "http://mirrors.ctan.org/macros/latex/contrib/picture/picture.pdf", +date = "2006", eprinttype = "ctan", eprint = "picture", +related = "picture-1", +} + +@manual{picture-1, +eprinttype = "github", +eprintclass = "ho-tex", +eprint = "picture", } -@online{varwidth, -title = "varwidth", +@manual{varwidth, +title = "The |varwidth| package", +subtitle = "A variable-width minipage", author = "Donald Arseneau", -url = "http://mirrors.ctan.org/macros/latex/contrib/varwidth/varwidth-doc.pdf", +date = "2003", eprinttype = "ctan", eprint = "varwidth", } -@online{csquotes, -title = "csquotes", +@manual{csquotes, +title = "The |csquotes| Package", +subtitle = "Context sensitive quotation facilities", author = "Philipp Lehman and Joseph Wright", -url = "http://mirrors.ctan.org/macros/latex/contrib/csquotes/csquotes.pdf", +date = "2003", eprinttype = "ctan", eprint = "csquotes", } -@online{babel, -title = "babel", +@manual{babel, +title = "|Babel| Localization and internationalization", +subtitle = "Multilingual support for Plain \TeX\ or \LaTeX", author = "Johannes Braams and Javier Bezos and at al.", -url = "http://mirrors.ctan.org/macros/latex/required/babel/base/babel.pdf", +date = "1989", eprinttype = "ctan", eprint = "babel", +related = "babel-1", +} + +@manual{babel-1, +eprinttype = "github", +eprintclass = "latex3", +eprint = "babel", } -@online{polyglossia, -title = "polyglossia", +@manual{polyglossia, +title = "The |polyglossia| package", author = "Arthur Reutenauer and François Charette and Elie Roux and Bastien Roucariès and Jürgen Spitzmüller", -url = "http://mirrors.ctan.org/macros/latex/contrib/polyglossia/polyglossia.pdf", eprinttype = "ctan", eprint = "polyglossia", } + +@manual{parskip, +title = "The |parskip| package", +subtitle = "Layout with zero |\textbackslash parindent|, non-zero |\textbackslash parskip|", +author = "Robin Fairbairns and Frank Mittelbach and H. Partl", +date = "1989", +eprinttype = "ctan", +eprint = "parskip", +related = "parskip-1", +} + +@manual{parskip-1, +eprinttype = "github", +eprintclass = "FrankMittelbach", +eprint = "fmitex", +} + + +@manual{fntguide, +title = "\LaTeX2\epsilon\ font selection", +subtitle = "Docmentation of \LaTeX\ font commands", +collaboration = "\LaTeX\ Team", +author = "\LaTeX\ Team", +date = "1995", +eprinttype = "ctan", +eprint = "fntguide", +} + +@manual{euenc, +title = "The Experimental Unicode `EUx’ Encodings", +author = "Will Robertson and Elie Roux and Khaled Hosny", +eprinttype = "ctan", +eprint = "euenc", +} + +@manual{soul, +title = "The |soul| package", +subtitle = "Hyphenation for letterspacing, underlining, and more", +author = "Melchior Franz", +date = "1998", +eprinttype = "ctan", +eprint = "soul", +} + +@manual{glossaries, +title = "The |glossaries| package", +subtitle = "Create glossaries and lists of acronyms", +author = "Nicola Talbot", +date = "2007", +eprinttype = "ctan", +eprint = "glossaries", +} + +@manual{glossaries-extra, +title = "The |glossaries-extra| package", +subtitle = "An extension to the |glossaries| package", +author = "Dickimaw Books, Nicola Talbot", +date = "2015", +eprinttype = "ctan", +eprint = "glossaries-extra", +} + +@manual{xparse, +title = "The |xparse| package", +subtitle = "A generic document command parser", +author = "Frank Mittelbach and Chris Rowley and David Carlisle", +collaboration = "\LaTeX3 Project", +date = "1999", +eprinttype = "ctan", +eprint = "xparse", +} + +@manual{pdftexcmds, +title = "The |pdftexcmds| package", +subtitle = "LuaTeX support for pdfTeX utility functions", +author = "Heiko Oberdiek", +date = "2007", +eprinttype = "ctan", +eprint = "pdftexcmds", +} + +@manual{fix-cm, +title = "The |fix-cm| package", +author = "Frank Mittelbach and David Carlisle and Chris Rowley and Walter Schmidt", +eprinttype = "ctan", +eprint = "fix-cm", +} + +@manual{revtex, +title = "The |revtex| package", +subtitle = "Styles for various Physics Journals", +author = "Mark Doyle and Arthur Ogawa", +collaboration = "American Physical Society", +date = "1999", +url = "https://journals.aps.org/revtex", +eprinttype = "ctan", +eprint = "revtex", +} + +@manual{encguide, +title = "\LaTeX\ font encodings", +subtitle = "Documentation of \LaTeX\ font encodings", +author = "Frank Mittelbach and Robin Fairbairns and Werner Lemberg", +collaboration = "\LaTeX3 Project Team", +date = "1995", +eprinttype = "ctan", +eprint = "encguide", +} + +@manual{sfmath, +title = "The |sfmath| package", +subtitle = "Sans-serif mathematics", +author = "Olaf Dietrich", +date = "2005", +url = "http://dtrx.de/od/tex/sfmath.html", +eprinttype = "ctan", +eprint = "sfmath", +} + +@manual{relsize, +title = "The |relsize| package", +subtitle = "Set the font size relative to the current font size", +author = "Donald Arseneau and Matt Swift", +date = "2011", +eprinttype = "ctan", +eprint = "relsize", +} + +@manual{everyhook, +title = "The |everyhook| package", +subtitle = "Hooks for standard \TeX\ token lists", +author = "Stephen Checkoway", +date = "2010", +eprinttype = "ctan", +eprint = "everyhook", +} + diff --git a/Master/texmf-dist/doc/latex/hep-paper/hep-paper.pdf b/Master/texmf-dist/doc/latex/hep-paper/hep-paper.pdf Binary files differindex 3b22335ba63..29b7c506ae0 100644 --- a/Master/texmf-dist/doc/latex/hep-paper/hep-paper.pdf +++ b/Master/texmf-dist/doc/latex/hep-paper/hep-paper.pdf diff --git a/Master/texmf-dist/doc/latex/hep-paper/license.md b/Master/texmf-dist/doc/latex/hep-paper/license.md new file mode 100644 index 00000000000..494f58131f7 --- /dev/null +++ b/Master/texmf-dist/doc/latex/hep-paper/license.md @@ -0,0 +1,416 @@ +The LaTeX Project Public License +=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- + +LPPL Version 1.3c 2008-05-04 + +Copyright 1999 2002-2008 LaTeX3 Project + Everyone is allowed to distribute verbatim copies of this + license document, but modification of it is not allowed. + + +PREAMBLE +======== + +The LaTeX Project Public License (LPPL) is the primary license under +which the LaTeX kernel and the base LaTeX packages are distributed. + +You may use this license for any work of which you hold the copyright +and which you wish to distribute. This license may be particularly +suitable if your work is TeX-related (such as a LaTeX package), but +it is written in such a way that you can use it even if your work is +unrelated to TeX. + +The section `WHETHER AND HOW TO DISTRIBUTE WORKS UNDER THIS LICENSE', +below, gives instructions, examples, and recommendations for authors +who are considering distributing their works under this license. + +This license gives conditions under which a work may be distributed +and modified, as well as conditions under which modified versions of +that work may be distributed. + +We, the LaTeX3 Project, believe that the conditions below give you +the freedom to make and distribute modified versions of your work +that conform with whatever technical specifications you wish while +maintaining the availability, integrity, and reliability of +that work. If you do not see how to achieve your goal while +meeting these conditions, then read the document `cfgguide.tex' +and `modguide.tex' in the base LaTeX distribution for suggestions. + + +DEFINITIONS +=========== + +In this license document the following terms are used: + + `Work' + Any work being distributed under this License. + + `Derived Work' + Any work that under any applicable law is derived from the Work. + + `Modification' + Any procedure that produces a Derived Work under any applicable + law -- for example, the production of a file containing an + original file associated with the Work or a significant portion of + such a file, either verbatim or with modifications and/or + translated into another language. + + `Modify' + To apply any procedure that produces a Derived Work under any + applicable law. + + `Distribution' + Making copies of the Work available from one person to another, in + whole or in part. Distribution includes (but is not limited to) + making any electronic components of the Work accessible by + file transfer protocols such as FTP or HTTP or by shared file + systems such as Sun's Network File System (NFS). + + `Compiled Work' + A version of the Work that has been processed into a form where it + is directly usable on a computer system. This processing may + include using installation facilities provided by the Work, + transformations of the Work, copying of components of the Work, or + other activities. Note that modification of any installation + facilities provided by the Work constitutes modification of the Work. + + `Current Maintainer' + A person or persons nominated as such within the Work. If there is + no such explicit nomination then it is the `Copyright Holder' under + any applicable law. + + `Base Interpreter' + A program or process that is normally needed for running or + interpreting a part or the whole of the Work. + + A Base Interpreter may depend on external components but these + are not considered part of the Base Interpreter provided that each + external component clearly identifies itself whenever it is used + interactively. Unless explicitly specified when applying the + license to the Work, the only applicable Base Interpreter is a + `LaTeX-Format' or in the case of files belonging to the + `LaTeX-format' a program implementing the `TeX language'. + + + +CONDITIONS ON DISTRIBUTION AND MODIFICATION +=========================================== + +1. Activities other than distribution and/or modification of the Work +are not covered by this license; they are outside its scope. In +particular, the act of running the Work is not restricted and no +requirements are made concerning any offers of support for the Work. + +2. You may distribute a complete, unmodified copy of the Work as you +received it. Distribution of only part of the Work is considered +modification of the Work, and no right to distribute such a Derived +Work may be assumed under the terms of this clause. + +3. You may distribute a Compiled Work that has been generated from a +complete, unmodified copy of the Work as distributed under Clause 2 +above, as long as that Compiled Work is distributed in such a way that +the recipients may install the Compiled Work on their system exactly +as it would have been installed if they generated a Compiled Work +directly from the Work. + +4. If you are the Current Maintainer of the Work, you may, without +restriction, modify the Work, thus creating a Derived Work. You may +also distribute the Derived Work without restriction, including +Compiled Works generated from the Derived Work. Derived Works +distributed in this manner by the Current Maintainer are considered to +be updated versions of the Work. + +5. If you are not the Current Maintainer of the Work, you may modify +your copy of the Work, thus creating a Derived Work based on the Work, +and compile this Derived Work, thus creating a Compiled Work based on +the Derived Work. + +6. If you are not the Current Maintainer of the Work, you may +distribute a Derived Work provided the following conditions are met +for every component of the Work unless that component clearly states +in the copyright notice that it is exempt from that condition. Only +the Current Maintainer is allowed to add such statements of exemption +to a component of the Work. + + a. If a component of this Derived Work can be a direct replacement + for a component of the Work when that component is used with the + Base Interpreter, then, wherever this component of the Work + identifies itself to the user when used interactively with that + Base Interpreter, the replacement component of this Derived Work + clearly and unambiguously identifies itself as a modified version + of this component to the user when used interactively with that + Base Interpreter. + + b. Every component of the Derived Work contains prominent notices + detailing the nature of the changes to that component, or a + prominent reference to another file that is distributed as part + of the Derived Work and that contains a complete and accurate log + of the changes. + + c. No information in the Derived Work implies that any persons, + including (but not limited to) the authors of the original version + of the Work, provide any support, including (but not limited to) + the reporting and handling of errors, to recipients of the + Derived Work unless those persons have stated explicitly that + they do provide such support for the Derived Work. + + d. You distribute at least one of the following with the Derived Work: + + 1. A complete, unmodified copy of the Work; + if your distribution of a modified component is made by + offering access to copy the modified component from a + designated place, then offering equivalent access to copy + the Work from the same or some similar place meets this + condition, even though third parties are not compelled to + copy the Work along with the modified component; + + 2. Information that is sufficient to obtain a complete, + unmodified copy of the Work. + +7. If you are not the Current Maintainer of the Work, you may +distribute a Compiled Work generated from a Derived Work, as long as +the Derived Work is distributed to all recipients of the Compiled +Work, and as long as the conditions of Clause 6, above, are met with +regard to the Derived Work. + +8. The conditions above are not intended to prohibit, and hence do not +apply to, the modification, by any method, of any component so that it +becomes identical to an updated version of that component of the Work as +it is distributed by the Current Maintainer under Clause 4, above. + +9. Distribution of the Work or any Derived Work in an alternative +format, where the Work or that Derived Work (in whole or in part) is +then produced by applying some process to that format, does not relax or +nullify any sections of this license as they pertain to the results of +applying that process. + +10. a. A Derived Work may be distributed under a different license + provided that license itself honors the conditions listed in + Clause 6 above, in regard to the Work, though it does not have + to honor the rest of the conditions in this license. + + b. If a Derived Work is distributed under a different license, that + Derived Work must provide sufficient documentation as part of + itself to allow each recipient of that Derived Work to honor the + restrictions in Clause 6 above, concerning changes from the Work. + +11. This license places no restrictions on works that are unrelated to +the Work, nor does this license place any restrictions on aggregating +such works with the Work by any means. + +12. Nothing in this license is intended to, or may be used to, prevent +complete compliance by all parties with all applicable laws. + + +NO WARRANTY +=========== + +There is no warranty for the Work. Except when otherwise stated in +writing, the Copyright Holder provides the Work `as is', without +warranty of any kind, either expressed or implied, including, but not +limited to, the implied warranties of merchantability and fitness for a +particular purpose. The entire risk as to the quality and performance +of the Work is with you. Should the Work prove defective, you assume +the cost of all necessary servicing, repair, or correction. + +In no event unless required by applicable law or agreed to in writing +will The Copyright Holder, or any author named in the components of the +Work, or any other party who may distribute and/or modify the Work as +permitted above, be liable to you for damages, including any general, +special, incidental or consequential damages arising out of any use of +the Work or out of inability to use the Work (including, but not limited +to, loss of data, data being rendered inaccurate, or losses sustained by +anyone as a result of any failure of the Work to operate with any other +programs), even if the Copyright Holder or said author or said other +party has been advised of the possibility of such damages. + + +MAINTENANCE OF THE WORK +======================= + +The Work has the status `author-maintained' if the Copyright Holder +explicitly and prominently states near the primary copyright notice in +the Work that the Work can only be maintained by the Copyright Holder +or simply that it is `author-maintained'. + +The Work has the status `maintained' if there is a Current Maintainer +who has indicated in the Work that they are willing to receive error +reports for the Work (for example, by supplying a valid e-mail +address). It is not required for the Current Maintainer to acknowledge +or act upon these error reports. + +The Work changes from status `maintained' to `unmaintained' if there +is no Current Maintainer, or the person stated to be Current +Maintainer of the work cannot be reached through the indicated means +of communication for a period of six months, and there are no other +significant signs of active maintenance. + +You can become the Current Maintainer of the Work by agreement with +any existing Current Maintainer to take over this role. + +If the Work is unmaintained, you can become the Current Maintainer of +the Work through the following steps: + + 1. Make a reasonable attempt to trace the Current Maintainer (and + the Copyright Holder, if the two differ) through the means of + an Internet or similar search. + + 2. If this search is successful, then enquire whether the Work + is still maintained. + + a. If it is being maintained, then ask the Current Maintainer + to update their communication data within one month. + + b. If the search is unsuccessful or no action to resume active + maintenance is taken by the Current Maintainer, then announce + within the pertinent community your intention to take over + maintenance. (If the Work is a LaTeX work, this could be + done, for example, by posting to comp.text.tex.) + + 3a. If the Current Maintainer is reachable and agrees to pass + maintenance of the Work to you, then this takes effect + immediately upon announcement. + + b. If the Current Maintainer is not reachable and the Copyright + Holder agrees that maintenance of the Work be passed to you, + then this takes effect immediately upon announcement. + + 4. If you make an `intention announcement' as described in 2b. above + and after three months your intention is challenged neither by + the Current Maintainer nor by the Copyright Holder nor by other + people, then you may arrange for the Work to be changed so as + to name you as the (new) Current Maintainer. + + 5. If the previously unreachable Current Maintainer becomes + reachable once more within three months of a change completed + under the terms of 3b) or 4), then that Current Maintainer must + become or remain the Current Maintainer upon request provided + they then update their communication data within one month. + +A change in the Current Maintainer does not, of itself, alter the fact +that the Work is distributed under the LPPL license. + +If you become the Current Maintainer of the Work, you should +immediately provide, within the Work, a prominent and unambiguous +statement of your status as Current Maintainer. You should also +announce your new status to the same pertinent community as +in 2b) above. + + +WHETHER AND HOW TO DISTRIBUTE WORKS UNDER THIS LICENSE +====================================================== + +This section contains important instructions, examples, and +recommendations for authors who are considering distributing their +works under this license. These authors are addressed as `you' in +this section. + +Choosing This License or Another License +---------------------------------------- + +If for any part of your work you want or need to use *distribution* +conditions that differ significantly from those in this license, then +do not refer to this license anywhere in your work but, instead, +distribute your work under a different license. You may use the text +of this license as a model for your own license, but your license +should not refer to the LPPL or otherwise give the impression that +your work is distributed under the LPPL. + +The document `modguide.tex' in the base LaTeX distribution explains +the motivation behind the conditions of this license. It explains, +for example, why distributing LaTeX under the GNU General Public +License (GPL) was considered inappropriate. Even if your work is +unrelated to LaTeX, the discussion in `modguide.tex' may still be +relevant, and authors intending to distribute their works under any +license are encouraged to read it. + +A Recommendation on Modification Without Distribution +----------------------------------------------------- + +It is wise never to modify a component of the Work, even for your own +personal use, without also meeting the above conditions for +distributing the modified component. While you might intend that such +modifications will never be distributed, often this will happen by +accident -- you may forget that you have modified that component; or +it may not occur to you when allowing others to access the modified +version that you are thus distributing it and violating the conditions +of this license in ways that could have legal implications and, worse, +cause problems for the community. It is therefore usually in your +best interest to keep your copy of the Work identical with the public +one. Many works provide ways to control the behavior of that work +without altering any of its licensed components. + +How to Use This License +----------------------- + +To use this license, place in each of the components of your work both +an explicit copyright notice including your name and the year the work +was authored and/or last substantially modified. Include also a +statement that the distribution and/or modification of that +component is constrained by the conditions in this license. + +Here is an example of such a notice and statement: + + %% pig.dtx + %% Copyright 2005 M. Y. Name + % + % This work may be distributed and/or modified under the + % conditions of the LaTeX Project Public License, either version 1.3 + % 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.3 or later is part of all distributions of LaTeX + % version 2005/12/01 or later. + % + % This work has the LPPL maintenance status `maintained'. + % + % The Current Maintainer of this work is M. Y. Name. + % + % This work consists of the files pig.dtx and pig.ins + % and the derived file pig.sty. + +Given such a notice and statement in a file, the conditions +given in this license document would apply, with the `Work' referring +to the three files `pig.dtx', `pig.ins', and `pig.sty' (the last being +generated from `pig.dtx' using `pig.ins'), the `Base Interpreter' +referring to any `LaTeX-Format', and both `Copyright Holder' and +`Current Maintainer' referring to the person `M. Y. Name'. + +If you do not want the Maintenance section of LPPL to apply to your +Work, change `maintained' above into `author-maintained'. +However, we recommend that you use `maintained', as the Maintenance +section was added in order to ensure that your Work remains useful to +the community even when you can no longer maintain and support it +yourself. + +Derived Works That Are Not Replacements +--------------------------------------- + +Several clauses of the LPPL specify means to provide reliability and +stability for the user community. They therefore concern themselves +with the case that a Derived Work is intended to be used as a +(compatible or incompatible) replacement of the original Work. If +this is not the case (e.g., if a few lines of code are reused for a +completely different task), then clauses 6b and 6d shall not apply. + + +Important Recommendations +------------------------- + + Defining What Constitutes the Work + + The LPPL requires that distributions of the Work contain all the + files of the Work. It is therefore important that you provide a + way for the licensee to determine which files constitute the Work. + This could, for example, be achieved by explicitly listing all the + files of the Work near the copyright notice of each file or by + using a line such as: + + % This work consists of all files listed in manifest.txt. + + in that place. In the absence of an unequivocal list it might be + impossible for the licensee to determine what is considered by you + to comprise the Work and, in such a case, the licensee would be + entitled to make reasonable conjectures as to which files comprise + the Work. + diff --git a/Master/texmf-dist/source/latex/hep-paper/hep-paper.dtx b/Master/texmf-dist/source/latex/hep-paper/hep-paper.dtx index 880dbe4ea82..9ba0f10dcd7 100644 --- a/Master/texmf-dist/source/latex/hep-paper/hep-paper.dtx +++ b/Master/texmf-dist/source/latex/hep-paper/hep-paper.dtx @@ -17,40 +17,59 @@ % % \iffalse %<package>\NeedsTeXFormat{LaTeX2e}[2005/12/01] -%<package>\ProvidesPackage{hep-paper}[2020/01/01 v1.1 Publications in High Energy Physics] -% +%<package>\ProvidesPackage{hep-paper}[2020/03/01 v1.2 Publications in High Energy Physics] + %<*driver> \documentclass{ltxdoc} -\usepackage{hep-paper} -\usepackage{parskip} +\MacroIndent=1.5em + +% \makeatletter +% \newenvironment{decl}[1][]% +% {\par\small\addvspace{4.5ex plus 1ex}% +% \vskip -\parskip +% \ifx\relax#1\relax +% \def\@decl@date{}% +% \else +% \def\@decl@date{\NEWfeature{#1}}% +% \fi +% \noindent\hspace{-\leftmargini}% +% \begin{tabular}{|l|}\hline\ignorespaces}% +% {\\\hline\end{tabular}\nobreak\@decl@date\par\nobreak +% \vspace{2.3ex}\vskip -\parskip} +% \makeatother + +\newenvironment{example}[1][.5]{% + \begin{minipage}[t]{\linewidth}% + \begin{minipage}[t]{#1\linewidth} + \newcommand{\second}{% + \end{minipage}% + \begin{minipage}[t]{\linewidth-#1\linewidth}% + }% +}{\end{minipage}\end{minipage}} + +\usepackage[parskip]{hep-paper} \bibliography{bibliography} -\DeclareFieldFormat{eprint:ctan}{% - CTAN\addcolon\space - \ifhyperref{\href{https://ctan.org/pkg/#1}{\nolinkurl{#1}}}{\nolinkurl{#1}} -} -\DeclareFieldAlias{eprint:CTAN}{eprint:ctan} +\acronym{PDF}{portable document format} -\DeclareFieldFormat{eprint:github}{% - GitHub\addcolon\space - \ifhyperref{% - \href{https://github.com/\thefield{eprintclass}/#1}{\nolinkurl{\thefield{eprintclass}/#1}}}% - {\nolinkurl{\thefield{eprintclass}/#1}}% - } -\DeclareFieldAlias{eprint:GitHub}{eprint:github} +\listfiles + +\usepackage{titletoc} +\titlecontents{section}[0em]{\medskip\bfseries}{\thecontentslabel\hspace{.8em}}{}{\hfill\contentspage} \EnableCrossrefs \CodelineIndex \RecordChanges + \begin{document} \DocInput{hep-paper.dtx} \end{document} %</driver> % \fi % -% \CheckSum{442} +% \CheckSum{0} % % \CharacterTable % {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z @@ -68,19 +87,18 @@ % Grave accent \` Left brace \{ Vertical bar \| % Right brace \} Tilde \~} % -% \changes{v1.0}{2019/01/01}{Initial version} -% \changes{v1.1}{2020/01/01}{Minor tweaks} +% \changes{v1.0}{2019/01/01}{Initial version of the style file} +% \changes{v1.1}{2020/01/01}{Transition to documented \LaTeX\ source file} +% \changes{v1.2}{2020/03/01}{Inclusion of package options} % % \GetFileInfo{hep-paper.sty} % -% \DoNotIndex{\#,\$,\%,\&,\@,\\,\{,\},\^,\_,\~,\ } -% \DoNotIndex{\@ne} -% \DoNotIndex{\advance,\begingroup,\catcode,\closein} -% \DoNotIndex{\closeout,\day,\def,\edef,\else,\empty,\endgroup} +% \DoNotIndex{\,,\@} +% \DoNotIndex{\@affiliation,\@affil@opt,\@affil} % -% \title{The |hep-paper| package\thanks{This document corresponds to \protecting{|hep-paper|}~\fileversion, % dated \filedate.}} +% \title{The |hep-paper| package\thanks{This document corresponds to \protecting{|hep-paper|}~\fileversion.}} % \author{Jan Hajer \email{jan.hajer@uclouvain.be}} -% \affiliation{UCLouvain} +% \affiliation{Centre for Cosmology, Particle Physics and Phenomenology, Université catholique de Louvain, Louvain-la-Neuve B-1348, Belgium} % \preprint{Preprint-Number} % \date{\today} % \date{\normalsize\filedate} @@ -89,37 +107,81 @@ % % \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 light weight enough. +% 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} % % \clearpage\tableofcontents\clearpage % -% \newgeometry{scale=0.76,vmarginratio={3:4}, left=10em, marginparwidth=4.6cm, marginparsep=3mm} +% \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. +% 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 LaTeX defaults. +% 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 \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}. -% \footnote{Starting from this page the text of this document is additionally shifted to the right in order to facilitate a large left margin required by the |ltxdoc| package. -% This combination leads to a less than optimal page layout.} -% The font is changed to |lmodern| \cite{lmodern} with |microtype| \cite{microtype} optimizations. -% Hyperlinks of the |hyperref| package \cite{hyperref} are activated and hidden. -% Hyphenation is provided by the |babel| \cite{babel} and |polyglossia| \cite{polyglossia} packages in the case of normal TeX and LuaTeX repectively. -% Finally, quotation commands are provided by the recommended |csquotes| package \cite{csquotes}. -% \DescribeMacro{\MakeOuterQuote} -% The last package provides the convenient macro |\MakeOuterQuote{"}| allowing to simply use |"| instead of the pair |``| and |''|. +% Finally, the font is changed to |lmodern| \cite{lmodern} with |microtype| \cite{microtype} optimizations. +% \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|. +% +% \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|. +% +% \DescribeMacro{defaults} +% The |defaults| option prevents the adjustment of the page geometry and the font size set by the document class. +% +% \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{parskip} +% The |parskip| option makes use of the |parskip| package \cite{parskip} and changes how two paragraphs are separated from each other. +% The \LaTeX\ default is separation via indentation the |parskip| option switches to separation via vertical space. +% \footnote{The |parskip| option is used for this document.} +% +% \DescribeMacro{sansserif} +% The |sansserif| option switches the document including math to sans serif font shape. +% +% \DescribeMacro{title} +% The |title=false| option deactivates the titlepage adjustments. +% +% \DescribeMacro{manualplacement} +% The |manualplacement| option reactivates manual float placement. +% +% \DescribeMacro{bibliography} +% The |bibliography|=\meta{key} option prevents the automatic loading of the |biblatex| package \cite{biblatex} for \meta{key}=|false| or passes the \meta{key} as |style| string to the |biblatex| package. +% +% \DescribeMacro{glossaries} +% The |glossaries=false| option deactives the use of the |glossaries| package \cite{glossaries, glossaries-extra}. +% +% \DescribeMacro{revtex} +% The |revtex| option switches the |hep-paper| package into a |revtex| \cite{revtex} compatibility mode. +% +% \DescribeMacro{eqnarray} +% The |eqnarray| option reactivates the depreciated |eqnarray| environment. % % \section{Macros and environments} % % \subsection{Title page} % -% The macros of this section are supposed to be used within the preamble. +% The \PDF meta information is set according to the |\title|\marg{text} and |\author|\marg{text} information. % \DescribeMacro{\author} % \DescribeMacro{\affiliation} % \DescribeMacro{\email} @@ -127,76 +189,172 @@ % The following lines add \eg two authors with different affiliations % % | \author[1]{Author one \email{Email one}}|\\ -% | \affiliation{Affiliation one}|\\ +% | \affiliation[1]{Affiliation one}|\\ % | \author[2]{Author two \email{Email two}}|\\ % | \affiliation[1,2]{Affiliation two}| % % \DescribeMacro{\preprint} -% The |\preprint|\marg{text} macro places a preprint number in the upper right corner of the title page. -% The PDF meta information is set according to the |\title|\marg{text} and |\author|\marg{text} information. +% The |\preprint|\marg{numer} macro places a pre-print number in the upper right corner of the first page. +% % \DescribeEnv{abstract} -% The |abstract| environment has been adjusted to not start with identation. +% The |abstract| environment has been adjusted to not start with an indentation. % -% \subsection{References and footnotes} +% \subsection{Text} +% +% \DescribeMacro{\enquote} +% 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{\MakeOuterQuote} +% The latter package provides the convenient macro |\MakeOuterQuote{"}| allowing to simply use |"| instead of the pair |``| and |''|. % % \DescribeMacro{\eg} -% \DescribeMacro{\ie} -% The |foreign| package \cite{foreign} defines macros such as |\eg|, |\ie|, and |\cf| which are typeset as \eg, \ie, and \cf. - -% \DescribeMacro{\ref} -% \DescribeMacro{\cite} -% References and citations are adjusted to not start on a new line in order to avoid the repeated use of |~\ref|\marg{text} and |~\cite|\marg{text}. +% \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} and the |\url|\marg{text} macros, resulting in \eg \online{https://ctan.org/pkg/hep-paper}{ctan.org/pkg/hep-paper}. +% +% \DescribeMacro{inlinelist} +% Using the |enumitem| package \cite{enumitem} the |inlinelist| +% +% \begin{example} +% |The three main points are| +% +% |\begin{inlinelist}| +% +% | \item one| +% +% | \item two| +% +% | \item three| +% +% |\end{inlinelist}| +% \second +% The three main points are +% \begin{inlinelist} +% \item one +% \item two +% \item three +% \end{inlinelist} +% \end{example} +% +% \DescribeMacro{enumdescript} +% and the |enumdescript| environments are defined +% +% \begin{example}[.6] +% |\begin{enumdescript}[label=\Roman*)]| +% +% | \item{First} one| +% +% | \item{Second} two| +% +% | \item{Third} three| +% +% |\end{enumdescript}| +% \second +% \begin{enumdescript}[label=\Roman*)] +% \item{First} one +% \item{Second} two +% \item{Third} three +% \end{enumdescript} +% \end{example} +% +% \DescribeMacro{\textsc} +% A sans serif version of \textsf{\textsc{Small Caps}} is provided. +% +% \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 write just |\cref|\marg{figure} in order to get 'Figure 1'. -% The |cleveref| package furthermore allows to reference multiple objects within one |\cref|\marg{text} (similar to the |\cite|\marg{text} macro). +% References are extended with the |cleveref| package \cite{cleveref}, which allows to \eg just type |\cref|\marg{key} in order to write 'Figure 1'. +% Furthermore, the |cleveref| package allows to reference multiple objects within one |\cref|\marg{key} (similar to the |\cite|\marg{key} macro). +% +% \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} -% The |\eqref|\marg{text} macro is also adjusted to not start on a new line and be able to reference multiple equations at once. +% \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}\marg{definition}\oarg{plural\linebreak[4]definition} macro generates the singluar |\|\meta{abbreviation} and plural |\|\meta{abbreviation}|s| macros. +% The starred version does not add an \enquote{s} to the abbreviation plural. +% 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 only show 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. +% 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 |amsmath| \cite{amsmath} and |amsfonts| \cite{amsfonts} packages. % \DescribeMacro{\mathbf} -% Bold math, including |\mathbf| is provided by the |bm| package \cite{bm}. -% Macros switching to |bfseries| such as |\title|\marg{text} and |\section|\marg{text} are ensured to also typeset math in bold. +% Bold math, including |\mathbf| is provided 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{\mathsfit} -% Add an additional math italic sf font $\mathsfit A \mathsfit B \mathsfit C$ $\bm {\mathsfit A} \bm{\mathsfit B} \bm{\mathsfit C}$ -% % \DescribeMacro{\text} -% The |\text|\marg{text} macro makes it possible to write text within math mode. -% The often used |\mathrm|\marg{text} and |\rm|\marg{text} macros are \emph{not} the right tool for this purpose. +% 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|\marg{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}$). +% Details about the font handling in \TeX\ can be found in \cite{fntguide}. +% \DescribeMacro{\mathscr} +% The |\mathcal| font \ie ($\mathcal{ABCD}$) is accompanied by the |\mathscr| font \ie ($\mathscr{ABCD}$). % % \DescribeMacro{\nicefrac} % \DescribeMacro{\flatfrac} -% The |\frac|\marg{number}\marg{number} macro is accompanied by |\nicefrac|\marg{number}\marg{number} and |\flatfrac|\marg{number}\marg{number}. -% Providing the choices +% 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} % \begin{align} % \frac12 \ ,&& \nicefrac 12 \ ,&& \flatfrac 12\ . % \end{align} +% \DescribeMacro{\diag} +% A diagonal matrix operator is defined |\diag|. +% +% \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} +% The imaginary unit $\i$ is defined using this functionality. +% % \DescribeMacro{\numberwithin} -% For longer paper it can be useful to re-number the equation in accordance with the section |\numberwithin{equation}{section}|. +% 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. % +% \DescribeMacro{eqnarray} +% The depreciated |eqnarray| environment is undefined as long this behaviour is not prevented by the |eqnarray| package option. +% The |align| environment should be used instead. +% % \subsubsection{Physics} % -% Greek letters are adjusted to be italic and upright in math and text mode, respectively, using the |fixmath| \cite{fixmath} and |alphabeta| \cite{alphabeta} packages. +% 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 light neutrinos. -% Additionally, greek letters can now also typed directly using unicode. -% -% \DescribeMacro{\slashed} -% The |\slashed|\marg{symbol} macro from the |slashed| \cite{slashed} package allows to use the Dirac slash notation. +% Additionally, Greek letters can also be directly typed using Unicode. % % \DescribeMacro{\ev} % \DescribeMacro{\pdv} @@ -212,6 +370,9 @@ % &&\det(M)\ . % \end{align} % +% \DescribeMacro{\slashed} +% The |\slashed|\marg{character} macro from the |slashed| \cite{slashed} package allows to use the Dirac slash notation. +% % \DescribeMacro{\overleftright} % A better looking over left right arrow is defined $\overleftright{\partial}$. % \DescribeMacro{\unit} @@ -223,8 +384,12 @@ % % \DescribeEnv{figure} % \DescribeEnv{table} -% Manual float placement is deactivated and automatic float placement is adjusted to place one float at the top of pages and to reduce the number of float pages. -% The most useful float placement is usually archived by placing the float \emph{in front} of the paragraph it is referenced first. +% Automatic float placement is adjusted to place a single float at the top of pages and to reduce the number of float pages. +% The most useful float placement is usually archived by placing the float \emph{in front} of the paragraph it is referenced in first. +% Additionally, manual float placement is deactivated but can be reactivated using the |manualplacement| package option. +% \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} @@ -247,198 +412,313 @@ % % \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} +% \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 subfloats and takes as mandatory argument either the number of subfloats (default 2) or the width of the first subfloat as fraction of the |\linewidth|. -% Within the |\begin{panels}|\oarg{vert}\marg{width} environment the |\panel| macro initiates a new subfloat, in case that the width of the first subfloat has been given as an optional argument to the |panels| environment the |\panel|\marg{width} macro takes the width of the next subfloat as mandatory argument. +% 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{vert}\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{\graphicspath} -% 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 subfolder its path can be indicated by |\graphicspath{{./|$\langle path\rangle$|/}}|. -% \DescribeMacro{\raggedright} -% The float environments have been adjusted to center their content. -% The usual behaviour is reactived with |\raggedright|. +% \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} -% For bibliography management the |biblatex| package \cite{biblatex} is loaded and extended to be able to cope with the |collaboration| and |report| fields provided by |inspire|. -% The user has to add the line |\bibliography|\marg{mybib} to the preamble of the document and |\printbibliography| at the end of the document. +% 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 |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, \online{https://ctan.org}{ctan.org}, \online{https://github.com}{github.com}, \online{https://gitlab.com}{gitlab.com}, \online{https://sourceforge.net}{sourceforge.net}, and \online{https://hepforge.org}{hepforge.org} are recognized as |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 majority of macros defined and packages loaded by this package are fairly lightweight and provide the author with the necessary tools to focus on the content instead of the layout. +% 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} -% ArXiv requires the setup dependent |bbl| files instead of the original |bib| files, which causes trouble if the local LaTeX version differes 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) . +% ArXiv requires the setup dependent |bbl| files instead of the original |bib| files, which causes trouble if the local \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). % % \StopEventually{ % \printbibliography +% \PrintChanges % } % % \appendix % -% \section{Implementation} -% -% \subsection{Options} -% -% Redefine article options and choose sane values. -% -% \subsubsection{Paper size} +% \section{Options} % -% Redefine the article paper sizes options without any changes. -% \paragraph{A4 paper} +% Load the |kvoptions| package and define a |hep| namespace. +% \DoNotIndex{\RequirePackage,\SetupKeyvalOptions} % \begin{macrocode} -\DeclareOption{a4paper}{% - \setlength\paperheight{297mm}% - \setlength\paperwidth{210mm}% +\RequirePackage{kvoptions} +\SetupKeyvalOptions{ + family=hep, + prefix=hep@ } % \end{macrocode} % -% \paragraph{A5 paper} +% \begin{macro}{paper} +% Define a |paper=|\meta{size} option. +% Make A4 paper the default. +% \DoNotIndex{\DeclareStringOption} +% \begin{macrocode} +\DeclareStringOption[a4]{paper} +% \end{macrocode} +% \end{macro} % +% \begin{macro}{font} +% Define a |font=|\meta{size} option. +% Make \unit[11]{pt} the default font size. % \begin{macrocode} -\DeclareOption{a5paper}{% - \setlength\paperheight{210mm}% - \setlength\paperwidth{148mm}% -} +\DeclareStringOption[11pt]{font} % \end{macrocode} +% \end{macro} % -% \paragraph{B5 paper} +% \begin{macro}{defaults} +% Define the |defaults| option which deactivates the |paper| and |font| options and prevents the change of the class defaults by this package. +% \DoNotIndex{\DeclareBoolOption,\ifhep@defaults} % \begin{macrocode} -\DeclareOption{b5paper}{% - \setlength\paperheight{250mm}% - \setlength\paperwidth{176mm}% -} +\DeclareBoolOption[false]{defaults} % \end{macrocode} +% \end{macro} % -% \paragraph{Letter paper} +% \begin{macro}{lang} +% Define the |lang| option, which takes the values provided by the |babel| package \cite{babel}. +% Make |british| the default language. % \begin{macrocode} -\DeclareOption{letterpaper}{% - \setlength\paperheight{11in}% - \setlength\paperwidth{8.5in}% -} +\DeclareStringOption[british]{lang} % \end{macrocode} +% \end{macro} % -% \paragraph{Legal paper} +% \begin{macro}{parskip} +% Define the option pair |parindent| and |parskip| controlling the separation of paragraphs. +% \DoNotIndex{\DeclareComplementaryOption,\ifhep@parindent} % \begin{macrocode} -\DeclareOption{legalpaper}{% - \setlength\paperheight{14in}% - \setlength\paperwidth{8.5in}% -} +\DeclareBoolOption[true]{parindent} +\DeclareComplementaryOption{parskip}{parindent} % \end{macrocode} +% \end{macro} % -% \paragraph{Executive paper} +% \begin{macro}{sansserif} +% Define the option pair |serif| and |sansserif| controling the font shape of the whole document. +% \DoNotIndex{\ifhep@serif} % \begin{macrocode} -\DeclareOption{executivepaper}{% - \setlength\paperheight{10.5in}% - \setlength\paperwidth{7.25in}% -} +\DeclareBoolOption[true]{serif} +\DeclareComplementaryOption{sansserif}{serif} % \end{macrocode} -% Define the landscape option +% \end{macro} +% +% \begin{macro}{eqnarray} +% Provide the option |eqnarray| for reactivating the |eqnarray| environment. +% \DoNotIndex{\ifhep@eqnarray} % \begin{macrocode} -\DeclareOption{landscape}{% - \setlength\@tempdima{\paperheight}% - \setlength\paperheight{\paperwidth}% - \setlength\paperwidth{\@tempdima}% -} +\DeclareBoolOption[false]{eqnarray} % \end{macrocode} - -% \subsubsection{Font size} +% \end{macro} % -% Redefine the article font sizes options. +% \begin{macro}{bibliography} +% Provide the option |bibliography| for passing a |style| string to the |biblatex| package \cite{biblatex} or disabling the automatic loading of |biblatex|. % \begin{macrocode} -\DeclareOption{10pt}{\renewcommand\@ptsize{0}} -\DeclareOption{11pt}{\renewcommand\@ptsize{1}} -\DeclareOption{12pt}{\renewcommand\@ptsize{2}} +\DeclareStringOption[numeric-comp]{bibliography} % \end{macrocode} -% Define the package option |placement|. - -% \subsubsection{Placement} +% \end{macro} % +% \begin{macro}{glossaries} +% Provide the option |glossaries| able to turn of the use of the |glossaries-extra| package \cite{glossaries-extra}. +% \DoNotIndex{\ifhep@glossaries} % \begin{macrocode} -\DeclareOption{placement}{\def\@placement} +\DeclareBoolOption[true]{glossaries} % \end{macrocode} - -% \subsubsection{Execute options} +% \end{macro} % -% Change the paper size to a4 and the font size to \unit[11]{pt}. +% \begin{macro}{manualplacement} +% Provide the |manualplacement| option for reactivating the manual placement of floats. +% \DoNotIndex{\ifhep@manualplacement} % \begin{macrocode} -\ExecuteOptions{a4paper,11pt} -\ProcessOptions\relax +\DeclareBoolOption[false]{manualplacement} % \end{macrocode} +% \end{macro} % -% \subsection{Font size} +% \begin{macro}{title} +% Provide the option |title| for deactivating redefinition of title macros. +% \DoNotIndex{\ifhep@title} +% \begin{macrocode} +\DeclareBoolOption[true]{title} +% \end{macrocode} +% \end{macro} % -% Undefine previously defined font sizes and load the LaTeX font size file corresponding to the font size option loaded before. +% \begin{macro}{revtex} +% Provide the option |revtex| for |revtex| \cite{revtex} compatibility mode. % \begin{macrocode} -\let\small\relax -\let\footnotesize\relax -\let\scriptsize\relax -\let\tiny\relax -\let\large\relax -\let\Large\relax -\let\LARGE\relax -\let\huge\relax -\let\Huge\relax -\input{size1\@ptsize.clo} +\DeclareBoolOption[false]{revtex} % \end{macrocode} +% \end{macro} -% \subsection{Geometry} +% \subsection{Process options} % -% Load the |geometry| package \cite{geometry} and adjust the text width and height to the values of the |a4wide| package \cite{a4wide}. % \begin{macrocode} -\RequirePackage[hscale=.76, vscale=.8, vmarginratio=3:4, includeheadfoot]{geometry} +\ProcessKeyvalOptions* +% \end{macrocode} +% Set the |revtex| compatibility options. +% \DoNotIndex{\ifhep@revtex,\setkeys,\fi} +% \begin{macrocode} +\ifhep@revtex + \setkeys{hep}{defaults, title=false, lang=american, bibliography=false} +\fi % \end{macrocode} -% \subsection{Text} + +% \section{Engine} % -% Load the |ifluatex| package \cite{ifluatex} and check if |lualatex| is being used. -% In this case load the |fontspec| package \cite{fontspec} and the default font features together with the |polyglossia| package \cite{polyglossia}. -% In the case of traditional LaTeX load the |inputenc| \cite{inputenc}, |fontenc| \cite{fontenc}, and |textcomp| \cite{textcomp} packages, in order to set the input and output properties of the font encoding and extend the known characters. -% Additionally, load the the |babel| package \cite{babel} for hyphenation. -% In both cases load also the recommended |csquotes| package \cite{csquotes}. +% \begin{macro}{\ifxetexorluatex} +% Load the |ifluatex| \cite{ifluatex} and |ifxetex| \cite{ifxetex} packages. +% Define the |\ifxetexorluatex| conditional. +% \DoNotIndex{\newif,\ifxetex,\xetexorluatextrue,\else,\ifluatex,\xetexorluatexfalse,\fi} % \begin{macrocode} \RequirePackage{ifluatex} -\ifluatex - \RequirePackage{fontspec} - \defaultfontfeatures{Ligatures=TeX} - \RequirePackage{polyglossia} - \setmainlanguage{british} +\RequirePackage{ifxetex} +\newif\ifxetexorluatex +\ifxetex\xetexorluatextrue\else + \ifluatex\xetexorluatextrue + \else\xetexorluatexfalse + \fi +\fi +% \end{macrocode} +% \end{macro} + +% \section{Text} +% +% Load |alphabeta| package \cite{alphabeta} first in order to archive the correct behaviour. +% The |alphabeta| package provides upright Greek letters in text mode. +% \begin{macrocode} +\RequirePackage{alphabeta} +% \end{macrocode} +% +% Pick the correct font encoding depending on the engine used and load the |fontenc| package \cite{fontenc} with this encoding. +% For details of the font encoding see \cite{encguide}. +% \DoNotIndex{\def,\@encoding} +% \begin{macrocode} +\ifxetexorluatex + \def\@encoding{TU} \else - \RequirePackage[utf8]{inputenc} - \RequirePackage[T1]{fontenc} - \RequirePackage{textcomp} - \RequirePackage[british]{babel} + \def\@encoding{T1} \fi -\RequirePackage{csquotes} +\RequirePackage[\@encoding]{fontenc} % \end{macrocode} -% Load the |lmodern| font, and the |microtype| font optimization. +% Load the |lmodern| font \cite{lmodern}, the |textcomp| extension \cite{textcomp}, and the |microtype| font optimization \cite{microtype}. % \begin{macrocode} \RequirePackage{lmodern} +\RequirePackage{textcomp} \RequirePackage{microtype} % \end{macrocode} -% \subsubsection{Text macros} +% Define sans serif small caps font shapes. +% \DoNotIndex{\DeclareFontShape,\sffamily} +% \begin{macrocode} +\ifxetexorluatex + \DeclareFontShape{\@encoding}{lmss}{bx}{sc}{<->cmssbxcsc10}{} + \DeclareFontShape{\@encoding}{lmss}{m}{sc}{% + <-9>cmsscsc8<9-10>cmsscsc9<10->cmsscsc10% + }{} +\else + \sffamily + \DeclareFontShape{\@encoding}{lmss}{bx}{sc}{<->ssub*xcmss/bx/sc}{} + \DeclareFontShape{\@encoding}{lmss}{m}{sc}{<->ssub*xcmss/m/sc}{} +\fi +% \end{macrocode} + +% Load the |inputenc| \cite{inputenc} package. +% \begin{macrocode} +\ifxetexorluatex\else + \RequirePackage[utf8]{inputenc} +\fi +% \end{macrocode} + +% Load the |babel| \cite{babel} package for hyphenation and the recommended |csquotes| package \cite{csquotes}. +% \DoNotIndex{\hep@lang} +% \begin{macrocode} +\RequirePackage[\hep@lang]{babel} +\RequirePackage{csquotes} +% \end{macrocode} + +% Set the whole text to sans serif if requested. +% \DoNotIndex{\ifhep@serif,\renewcommand,\familydefault,\sfdefault} +% \begin{macrocode} +\ifhep@serif\else + \renewcommand\familydefault{\sfdefault} +\fi +% \end{macrocode} + +% \begin{macro}{\underline} +% Load the |soul| package \cite{soul} for hyphenable underlined text. +% \DoNotIndex{\let} +% \begin{macrocode} +\RequirePackage{soul} +\let\underline\ul +% \end{macrocode} +% \end{macro} + +% \subsection{Font size} +% +% Undefine previously defined font sizes and load the \LaTeX\ font size file corresponding to the font size option. +% \DoNotIndex{\remove@pt,\edef,\@ptsize,\expandafter,\small,\relax,\footnotesize,\scriptsize} +% \begin{macrocode} +\ifhep@defaults\else + \def\remove@pt#1pt{#1} + \edef\@ptsize{\expandafter\remove@pt\hep@font} + \let\small\relax + \let\footnotesize\relax + \let\scriptsize\relax + \let\tiny\relax + \let\large\relax + \let\Large\relax + \let\LARGE\relax + \let\huge\relax + \let\Huge\relax + \input{size\@ptsize.clo} +\fi +% \end{macrocode} + +% \subsection{Text macros} % %\begin{macro}{\vs} % Load the |foreign| package \cite{foreign} in order to highlight abbreviations and vocabularies from foreign languages. % Add the missing |\vs| command. +% \DoNotIndex{\DeclareRobustCommand,\xperiodafter,\foreignabbrfont,\pdf@strcmp,\hep@lang@foreign} % \begin{macrocode} -\RequirePackage[all,british]{foreign} +\RequirePackage{pdftexcmds} +\newcommand{\hep@lang@foreign}{british} +\ifnum\pdf@strcmp{\hep@lang}{american}=0% + \renewcommand{\hep@lang@foreign}{USenglish}% +\fi +\ifnum\pdf@strcmp{\hep@lang}{USenglish}=0% + \renewcommand{\hep@lang@foreign}{USenglish}% +\fi +\RequirePackage[all, \hep@lang@foreign]{foreign} \DeclareRobustCommand\vs{\xperiodafter{{\foreignabbrfont{vs}}}} % \end{macrocode} % \end{macro} @@ -450,63 +730,110 @@ % \end{macrocode} % \end{macro} -%\begin{macro}{\software}\label{test} -% Define a macro for software with optional version information |\software|\oarg{version}\marg{text}. +%\begin{macro}{\software} +% Define a macro for software with optional version information |\software|\linebreak[1]\oarg{version}\linebreak[1]\marg{name}, using the |relsize| package \cite{relsize}. +% \DoNotIndex{\hspace,\fontdimen,\font,\smaller,\textsc} % \begin{macrocode} -\newcommand{\software}[2][\hspace{-\fontdimen2\font}]{\texttt{#2}~#1} +\RequirePackage{relsize} +\newcommand{\software}[2][\hspace{-\fontdimen2\font}]{% + {\smaller\textsc{#2}~#1}% +} % \end{macrocode} % \end{macro} -% \begin{macro}{\sloppy} -% Redefine |sloppy| to be less invasive \cf |\printbibliography| +% \begin{macro}{\online} +% The |\online|\marg{text}\marg{url} macro combines the features of the |\href| and the |\url| macros. +% \DoNotIndex{\href,\url} % \begin{macrocode} -\def\sloppy{% - \emergencystretch 3em \hfuzz .5\p@ \vfuzz\hfuzz% -} +\newcommand{\online}[2]{\href{#1}{\url{#2}}} % \end{macrocode} % \end{macro} -%\begin{macro}{\no@break@before} -% Provide macro able to prevent line breaks. +% \subsection{Lists} + +% Load the |enumitem| package \cite{enumitem}. % \begin{macrocode} -\newcommand\no@break@before{% - \relax\ifvmode\else% - \ifhmode% - \ifdim\lastskip > 0pt% - \relax\unskip\nobreakspace% - \fi% - \fi% - \fi% -} +\RequirePackage[inline]{enumitem} % \end{macrocode} -% \end{macro} - -% \subsubsection{Lists} % % \begin{environment}{inlinelist} -% Load the |enumitem| package \cite{enumitem} and define an inline list. +% Define an inline list environment. +% \DoNotIndex{\newlist,\setlist*,\ } % \begin{macrocode} -\RequirePackage[inline]{enumitem} \newlist{inlinelist}{enumerate*}{1} -\setlist*[inlinelist,1]{itemjoin={,\ }, itemjoin*={, and\ }, after=.} +\setlist*[inlinelist,1]{% + label=\roman*), itemjoin={,\ }, itemjoin*={, and\ }, after=.% +} +% \end{macrocode} +% \end{environment} +% +% \begin{environment}{enumdescript} +% Define an enumdescript list environment. +% \DoNotIndex{\arabic*,\old@item,\item,ifx,\textbf,\empty,\@ifnextchar,\par,\@gobble} +% \begin{macrocode} +\newlist{enum@descript}{enumerate}{2} +\setlist[enum@descript]{label=\arabic*.} +\newenvironment{enumdescript}[1][]{ +\begin{enum@descript}[#1] + \let\old@item\item + \renewcommand{\item}[2][]{ + \ifx&##1&\old@item\else\old@item[##1]\fi + \textbf{##2}\ifx##2\empty\else~\fi\@ifnextchar\par\@gobble\relax + } +}{\end{enum@descript}} % \end{macrocode} % \end{environment} -% \subsubsection{Footnotes} +% \subsection{Footnotes} % % \begin{macro}{\footnote} % Ensure that no spaces appear before the footmark or at the beginning of the footnote. +% \DoNotIndex{\unskip,\@foot@note,\ignorespaces} % \begin{macrocode} \let\@foot@note\footnote \renewcommand{\footnote}[1]{\unskip\@foot@note{\ignorespaces#1}} % \end{macrocode} % \end{macro} -% \subsection{Math} +% \section{Geometry} +% +% Load the |geometry| package \cite{geometry} and adjust the text width and height to the values of the |a4wide| package \cite{a4wide}. +% \DoNotIndex{\ifhep@defaults,\hep@paper,\geometry} +% \begin{macrocode} +\ifhep@defaults\else + \RequirePackage[\hep@paper paper]{geometry} + \geometry{hscale=.75, vscale=.8, vmarginratio=3:4, includeheadfoot} +\fi +% \end{macrocode} + +%\begin{macro}{\useparskip} +%\begin{macro}{\useparindent} +% Load the |parskip| package \cite{parskip} and provide two commands switching between the two paragraph modes. +% \DoNotIndex{\ifhep@parindent,\setlength,\parskip,\baselineskip,\parindent} +% \begin{macrocode} +\ifhep@parindent\else +\RequirePackage{parskip} +\newcommand{\useparskip}{% + \setlength{\parskip}{.5\baselineskip plus 2pt}% + \setlength{\parindent}{0pt}% +} +\newcommand{\useparindent}{% + \setlength{\parskip}{0pt}% + \setlength{\parindent}{15pt}% + \if@twocolumn\setlength\parindent{1em} + \else\setlength\parindent{1.5em} + \fi +} +\fi +% \end{macrocode} +% \end{macro} +% \end{macro} + +% \section{Math} % % Load the |mathtools| package \cite{mathtools} which loads the |amsmath| package \cite{amsmath}. % Additionally, load the |amssymb| package \cite{amsfonts} which provides further math symbols and also loads the |amsfont| package \cite{amsfonts}. -% Allow pagebreaks within equations if necessary. +% Allow page breaks within equations if necessary. % \begin{macrocode} \RequirePackage{mathtools} \RequirePackage{amssymb} @@ -520,22 +847,79 @@ % \end{macrocode} % \end{macro} +% \begin{macro}{\mathdef} +% Define the |\mathdef|\marg{name}\oarg{arguments}\marg{macro} macro which (re-)defines macros in math mode only. +% This macro is implemented using the |xparse| package \cite{xparse}. +% \begin{macrocode} +\RequirePackage{xparse} +\DeclareDocumentCommand{\mathdef}{mO{0}m}{% + \expandafter\let\csname old\string#1\endcsname=#1 + \expandafter\newcommand\csname new\string#1\endcsname[#2]{#3} + \DeclareRobustCommand#1{% + \ifmmode + \expandafter\let\expandafter\next\csname new\string#1\endcsname + \else + \expandafter\let\expandafter\next\csname old\string#1\endcsname + \fi + \next + }% +} +% \end{macrocode} +% \end{macro} + % \begin{macro}{\i} -% Provide an upright imaginary unit. This will cause trouble in languages where the letter |\i| is used. +% Provide an upright imaginary unit in math mode. % \begin{macrocode} -\AtEndOfClass{\let\i\undefined\DeclareMathOperator{\i}{i}} +\AtBeginDocument{\mathdef{\i}{\operatorname{i}}} % \end{macrocode} % \end{macro} -% \subsubsection{Greek letters} +% \begin{macro}{eqnarray} +% Undefine the |eqnarray| environment. +% \begin{macrocode} +\ifhep@eqnarray\else% + \let\eqnarray\@undefined + \let\endeqnarray\@undefined +\fi +% \end{macrocode} +% \end{macro} + +% \subsection{Math fonts} % -% Load the |fixmath| package \cite{fixmath} which makes upper Greek letters in math mode italic and load the |alphabeta| package \cite{alphabeta} which allows upright italic letters in text mode. +% \begin{macro}{\mathbf} +% Load the |bm| package \cite{bm} for superior boldmath. +% Make math symbols bold whenever they appear in bold macros such as |\section|\marg{text}. % \begin{macrocode} -\RequirePackage{fixmath} -\RequirePackage{alphabeta} +\RequirePackage{bm} +\let\mathbf\bm +\g@addto@macro\bfseries{\boldmath} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\mathsf} +% Load the |fixmath| package \cite{fixmath} which ensures that upper Greek letters in math mode are italic. +% Ensure that also math mode is sans serif using the |sfmath| package \cite{sfmath} if the option sans serif is passed to the package. +% Ensure that |\mathsf| is italic as well as sans serif and sans for sans and sans serif documents, respectively. +% \begin{macrocode} +\ifhep@serif + \RequirePackage{fixmath} + \DeclareMathAlphabet{\mathsf}{OML}{cmbr}{m}{it} + \SetMathAlphabet{\mathsf}{bold}{OML}{cmbr}{bx}{it} +\else + \RequirePackage[slantedGreek]{sfmath} + \DeclareMathAlphabet{\mathsf}{OML}{cmm}{m}{it} + \SetMathAlphabet{\mathsf}{bold}{OML}{cmm}{bx}{it} +\fi +% \end{macrocode} +% \end{macro} +% \begin{macro}{\mathscr} +% Load the |mathrsfs| package for the |\mathscr| math script font. +% \begin{macrocode} +\RequirePackage{mathrsfs} % \end{macrocode} +% \end{macro} -% \subsubsection{Physics notation} +% \subsection{Physics notation} % % \begin{macro}{\slashed} % \begin{macro}{\units} @@ -558,43 +942,25 @@ % \end{macro} % \begin{macro}{\oset} -% \begin{macro}{\overleftright} -% Define a new overset macro |\oset|\oarg{offsest}\marg{over}\marg{base} and use it to define a over left right arrow |\overleftright|\marg{base}. +% Define a new overset macro |\oset|\oarg{offset}\marg{over}\marg{base} % \begin{macrocode} \newcommand{\oset}[3][-1pt]{% - \raisebox{1pt}{% - \ensuremath{ - \mathop{#3}\limits^{\vbox to#1{\kern-2\ex@\hbox{$\scriptscriptstyle#2$}\vss}}% - }% - }% + \raisebox{1pt}{\ensuremath{\mathop{#3}\limits^{% + \vbox to#1{\kern-2\ex@\hbox{$\scriptscriptstyle#2$}\vss}% + }}}% } -\newcommand{\overleftright}[1]{\oset{\leftrightarrow}{#1}} -% \end{macrocode} -% \end{macro} -% \end{macro} - -% \subsubsection{Math fonts} -% -% \begin{macro}{\mathsbf} -% Load the |bm| package \cite{bm} for superior boldmath. -% Make math symbols bold whenever they appear in bold macros such as title or subsection. -% \begin{macrocode} -\RequirePackage{bm} -\let\mathbf\bm -\g@addto@macro\bfseries{\boldmath} % \end{macrocode} % \end{macro} -% \begin{macro}{\mathsfit} -% Define a italc sf math font. +% \begin{macro}{\overleftright} +% Define a over left right arrow |\overleftright|\marg{base}. % \begin{macrocode} -\DeclareMathAlphabet{\mathsfit}{T1}{\sfdefault}{\mddefault}{\sldefault} -\SetMathAlphabet{\mathsfit}{bold}{T1}{\sfdefault}{\bfdefault}{\sldefault} +\newcommand{\overleftright}[1]{\oset{\leftrightarrow}{#1}} % \end{macrocode} % \end{macro} -% \subsection{Floats} +% \section{Floats} % -% Adjust the LaTeX float placement defaults +% Adjust the \LaTeX\ float placement defaults % \begin{macrocode} \renewcommand{\textfraction}{0.01} \setcounter{topnumber}{1} @@ -605,107 +971,146 @@ % \begin{environment}{figure} % \begin{environment}{table} -% Ignore the manual placement if the |placement| option is set. +% Center the content of |figure| and |table| environments. +% Ignore the manual placement if the |manualplacement| option is set to false. % \begin{macrocode} -\ifdefined\@placement% - \let\@figure@\figure% - \let\@end@figure@\endfigure% +\let\@figure@\figure% +\let\@end@figure@\endfigure% +\let\@table@\table% +\let\@end@table@\endtable% +\ifhep@manualplacement% \renewenvironment{figure}[1][tbp]{% \@figure@[#1]\centering% - }{% - \@end@figure@% - }% - \let\@table@\table% - \let\@end@table@\endtable% + }{\@end@figure@}% \renewenvironment{table}[1][tbp]{% \@table@[#1]\centering% - }{% - \@end@table@% - }% + }{\@end@table@}% \else% - \let\@figure@\figure% - \let\@end@figure@\endfigure% \renewenvironment{figure}[1][]{% \@figure@\centering% - }{% - \@end@figure@% - }% - \let\@table@\table% - \let\@end@table@\endtable% + }{\@end@figure@}% \renewenvironment{table}[1][]{% \@table@\centering% - }{% - \@end@table@% - } + }{\@end@table@} \fi% % \end{macrocode} % \end{environment} % \end{environment} -% \subsubsection{Subfloats} +% \subsection{Sub-floats} % -% \begin{environment}{panels} -% \begin{macro}{\panel} -% Load the |subcaption| package \cite{subcaption} and define the |panels| environment as well as the |\panel| macro. +% Prevent the |caption| package \cite{caption} from complaining about the |revtex| class. +% \begin{macrocode} +\ifhep@revtex + \setlength\abovecaptionskip{\f@size\p@} + \setlength\belowcaptionskip{0\p@} + \long\def\@makecaption#1#2{% + \vskip\abovecaptionskip + \sbox\@tempboxa{#1: #2}% + \ifdim \wd\@tempboxa >\hsize + #1: #2\par + \else + \global \@minipagefalse + \hb@xt@\hsize{\hfil\box\@tempboxa\hfil}% + \fi + \vskip\belowcaptionskip% + } +\fi +% \end{macrocode} +% +% Load the |subcaption| package \cite{subcaption}. % \begin{macrocode} \RequirePackage[subrefformat = parens]{subcaption} \captionsetup{font=small} \captionsetup[sub]{font=small} -\newcommand{\begin@subcaption@minipage}[2][b]{% - \caption@withoptargs\subcaption@minipage[#1]{#2}\centering\vskip 0pt% -} +% \end{macrocode} +% \begin{environment}{panels} +% \begin{macro}{\panel} +% Load the |subcaption| package \cite{subcaption} and define the |panels| environment as well as the |\panel| macro. +% \begin{macrocode} \newenvironment{panels}[2][b]{% +% \end{macrocode} +% Define an internal macro for global behaviour. +% \begin{macrocode} + \newcommand{\begin@subcaption@minipage}[2][b]{% + \caption@withoptargs\subcaption@minipage[##1]{##2}% + \centering\vskip 0pt% + } +% \end{macrocode} +% Define the |\panel| macro for the case that the number of panels is given. +% \begin{macrocode} \ifdim#2pt>1pt% \newcommand{\panel}[1][b]{% \endminipage\hfill\begin@subcaption@minipage[#1]{\linewidth/#2}% }% \begin@subcaption@minipage[#1]{\linewidth/#2}% +% \end{macrocode} +% Define the |\panel| macro for the case that the width of the panel is given. +% \begin{macrocode} \else% \newcommand{\panel}[2][b]{% \endminipage\hfill\begin@subcaption@minipage[#1]{##2\linewidth}% }% \begin@subcaption@minipage[#1]{#2\linewidth}% \fi% -}{% - \endminipage% -} +}{\endminipage} % \end{macrocode} % \end{macro} % \end{environment} -% \subsubsection{Tables} +% Reajust the captions to the revtex class. +% \begin{macrocode} +\ifhep@revtex + \renewcommand{\figurename}{Figure} + \renewcommand{\tablename}{Table} + \RequirePackage{ragged2e} + \DeclareCaptionFormat{revtex}{#1#2\justifying{#3}} + \captionsetup{font = small, format = revtex} + \captionsetup[sub]{font = footnotesize, format = plain} +\fi +% \end{macrocode} + +% \subsection{Tables} % % \begin{environment}{tabular} -% Enhance tables using the |booktabs| and |multirow| packages \cite{booktabs, multirow}. +% Enhance tabulars with the |booktabs| and |multirow| packages \cite{booktabs, multirow}. % \begin{macrocode} \RequirePackage{booktabs} \RequirePackage{multirow} % \end{macrocode} % \end{environment} -% \subsubsection{Figures} +% \subsection{Figures} % % \begin{macro}{\graphic} -% Provide the |graphic| macro for the inclusion of figures with the |graphicx| package \cite{graphicx}. +% Provide the |\graphic| macro for the inclusion of figures using the |graphicx| package \cite{graphicx}. % \begin{macrocode} \RequirePackage{graphicx} \providecommand{\tikzsetnextfilename}[1]{} -\newcommand{\graphic}[2][1]{% - \tikzsetnextfilename{#2}\centering\includegraphics[width=#1\linewidth]{#2}% -} +\newcommand{\graphic}[2][1]{\tikzsetnextfilename{#2}{% + \centering\includegraphics[width=#1\linewidth]{#2}% +}} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\graphics} +% Provide the |\graphics| macro for the inclusion of figures located in a subfolder. +% \begin{macrocode} +\newcommand{\graphics}[1]{\graphicspath{{./#1/}}} % \end{macrocode} % \end{macro} -% \subsection{Titlepage} +% \section{Title page} % % \begin{macro}{\date} % Allow empty date field. % \begin{macrocode} +\ifhep@title \date{} % \end{macrocode} % \end{macro} -% \subsubsection{Authors} +% \subsection{Authors} % % \begin{macro}{\author} % Allow empty author field. @@ -717,31 +1122,47 @@ % Provide macro for the email of authors used as |\author{|$\langle name\rangle$| \email{|$\langle email\rangle$|}}|. % \begin{macrocode} \AtEndOfClass{\newcommand{\email}[1]{% - \unskip\thanks{\href{mailto:#1}{\texttt{#1}}}% + \unskip\thanks{\online{mailto:#1}{#1}} }} % \end{macrocode} % \end{macro} % -% \begin{macro}{\affiliation} % Enable the handling of multiple authors with different affiliations using the |authblk| package \cite{authblk}. % \begin{macrocode} \RequirePackage{authblk} \renewcommand\Affilfont{\footnotesize} -\newcommand{\affiliation}[2][]{\affil[#1]{\protecting{#2}}} +% \end{macrocode} +% +% \begin{macro}{\affiliation} +% Define the |\affiliation| macro, ensure that linebreaks happen after a comma. +% \begin{macrocode} +\newcommand\active@comma{,\penalty-5\relax} +\newcommand\cat@comma@active{\catcode`\,\active} +{\cat@comma@active\gdef,{\active@comma}} +\newcommand\@affil[1]{% + \endgroup\@flushglue=0pt plus .5\linewidth\affil{#1}% +} +\def\@affil@opt[#1]#2{% + \endgroup\@flushglue=0pt plus .5\linewidth\affil[#1]{#2}% +} +\DeclareRobustCommand\@affiliation{\@ifnextchar[{\@affil@opt}{\@affil}} +\newcommand{\affiliation}{\begingroup\cat@comma@active\@affiliation} % \end{macrocode} % \end{macro} -% \subsubsection{Preprint} +% \subsection{Preprint} % % \begin{macro}{\preprint} -% Places a preprint number in the top right corner of the titel page. +% Places a preprint number in the top right corner of the first page. % This code uses the |varwidth| \cite{varwidth}, |atbegshi| \cite{atbegshi}, and |picture| \cite{picture} packages. % \begin{macrocode} \let\@preprint\relax \newcommand\preprint[1]{\long\gdef\@preprint{#1}} \RequirePackage{varwidth} \newcommand{\@preprint@box}{% - \begin{varwidth}{\textwidth}\textsc{\small\@preprint}\end{varwidth}% + \begin{varwidth}{\textwidth}% + \textsc{\small\@preprint}% + \end{varwidth}% } \RequirePackage{atbegshi} \RequirePackage{picture} @@ -754,75 +1175,181 @@ % \end{macrocode} % \end{macro} -% \subsubsection{Abstract} +% \subsection{Abstract} % % \begin{environment}{abstract} -% Adjust the |abstract| environment to not start with identation. +% Adjust the |abstract| environment to not start with indentation. % \begin{macrocode} \let\old@abstract\abstract \renewcommand\abstract{\old@abstract\noindent\ignorespaces} % \end{macrocode} % \end{environment} +% End of check for |title| option. +% \begin{macrocode} +\fi +% \end{macrocode} -% \subsection{Bibliography} +% \section{Bibliography} +% +% Check if bibliography management is requested using the |pdftexcmds| package \cite{pdftexcmds}. +% \begin{macrocode} +\ifnum\pdf@strcmp{\hep@bibliography}{false}=0\else +% \end{macrocode} % % \begin{macro}{\bibliography} % Load the |biblatex| package \cite{biblatex} with a JHEP like bibliography style. -% Add the collaboration and preprint information if present. % \begin{macrocode} -\RequirePackage[sorting=none,style=numeric-comp,giveninits=true]{biblatex} +\RequirePackage[style=\hep@bibliography]{biblatex} +\ExecuteBibliographyOptions{ + sorting=none, + giveninits=true +} +% \end{macrocode} +% \end{macro} +% Read the collaboration and pre-print information if present. +% Move letters from the volume field to the journal field. +% \begin{macrocode} +\newcommand{\@reg@exp}{\regexp{\A(\p{L}+)?\d+(\p{L}+)?\Z}} +\newcommand{\@reg@exp@}{\regexp{\A(\p{L}+)?(\d+)(\p{L}+)?\Z}} \DeclareSourcemap{% \maps[datatype=bibtex,overwrite=true]{% \map{% \step[fieldsource=Collaboration,final=true]% - \step[fieldset=usera,origfieldval,final=true] + \step[fieldset=usere,origfieldval,final=true] }% \map{% \step[fieldsource=reportNumber,final=true]% - \step[fieldset=userb,origfieldval,final=true] + \step[fieldset=userf,origfieldval,final=true] }% + \map[overwrite]{ + \step[fieldsource=volume, match=\@reg@exp, final] + \step[fieldsource=volume, match=\@reg@exp@, replace={$2}] + \step[fieldsource=journal, fieldtarget=journaltitle] + \step[fieldset=journaltitle, fieldvalue={\space$1$2}, append=true] + } }% } +% \end{macrocode} + +% Override the author information with collaboration information if present. +% \begin{macrocode} \renewbibmacro*{author}{% - \iffieldundef{usera}{\printnames{author}}{\textbf{\printfield{usera}}}% + \iffieldundef{usere}{\printnames{author}}{\textbf{\printfield{usere}}}% } +% \end{macrocode} + +% Remove spurious `In:' if no journal is present. +% \begin{macrocode} \renewbibmacro*{in:}{% \iffieldundef{journal}{}{\printtext{\bibstring{in}\intitlepunct}}% } -\renewbibmacro*{finentry}{% - \iffieldundef{userb}{}{% - \textls[0]{\small{\textsc{% - \newunitpunct\textnumero\intitlepunct\printfield{userb}% - }}}% - }\finentry% +% \end{macrocode} + +% Provide the |\letbibmacro| macro for old |biblatex| installations. +% \begin{macrocode} +\providecommand{\letbibmacro}[2]{\csletcs{abx@macro@#1}{abx@macro@#2}} +% \end{macrocode} + +% Add the pre-print information if present. +% \begin{macrocode} +\letbibmacro{doi+eprint+url-old}{doi+eprint+url} +\renewbibmacro*{doi+eprint+url}{% + \usebibmacro{doi+eprint+url-old} + \iffieldundef{userf}{}{\textls[0]{% + \newunitpunct\textnumero\intitlepunct% + \textsc{\small\printfield{userf}}% + }}% } % \end{macrocode} -% \end{macro} + +% Add CTAN as a pre-print option +% \begin{macrocode} +\DeclareFieldFormat{eprint:ctan}{% + CTAN\addcolon\space\ifhyperref{% + \href{https://ctan.org/pkg/#1}{\nolinkurl{#1}}% + }{\nolinkurl{#1}}% +} +\DeclareFieldAlias{eprint:CTAN}{eprint:ctan} +% \end{macrocode} + +% Add GitHub as a pre-print option +% \begin{macrocode} +\DeclareFieldFormat{eprint:github}{% + GitHub\addcolon\space\ifhyperref{\href{% + https://github.com/\thefield{eprintclass}/#1% + }{\nolinkurl{\thefield{eprintclass}/#1}}% + }{\nolinkurl{\thefield{eprintclass}/#1}}% +} +\DeclareFieldAlias{eprint:GitHub}{eprint:github} +% \end{macrocode} + +% Add GitLab as a pre-print option +% \begin{macrocode} +\DeclareFieldFormat{eprint:gitlab}{% + GitLab\addcolon\space\ifhyperref{\href{% + https://gitlab.com/\thefield{eprintclass}/#1% + }{\nolinkurl{\thefield{eprintclass}/#1}}% + }{\nolinkurl{\thefield{eprintclass}/#1}}% +} +\DeclareFieldAlias{eprint:GitLab}{eprint:gitlab} +% \end{macrocode} + +% Add SourceForge as a pre-print option +% \begin{macrocode} +\DeclareFieldFormat{eprint:sourceforge}{% + SourceForge\addcolon\space\ifhyperref{% + \href{https://sourceforge.net/projects/#1}{\nolinkurl{#1}}% + }{\nolinkurl{#1}}% +} +\DeclareFieldAlias{eprint:SourceForge}{eprint:sourceforge} +% \end{macrocode} + +% Add HEPForge as a pre-print option +% \begin{macrocode} +\DeclareFieldFormat{eprint:hepforge}{% + HEPForge\addcolon\space\ifhyperref{% + \href{https://#1/hepforge.org/}{\nolinkurl{#1}}% + }{\nolinkurl{#1}}% +} +\DeclareFieldAlias{eprint:HEPForge}{eprint:hepforge} +% \end{macrocode} + +% Add new bibliography string \enquote{Erratum} for the use in the |relatedtype| field. +% \begin{macrocode} +\NewBibliographyString{erratum} +\DefineBibliographyStrings{english}{erratum={Erratum:}} +% \end{macrocode} + % \begin{macro}{\printbibliography} -% Allow the bibliography to be printed sloppy \cf |\sloppy| +% Allow the bibliography to be printed sloppy % \begin{macrocode} \let\old@printbibliography\printbibliography \renewcommand{\printbibliography}{\sloppy\old@printbibliography} % \end{macrocode} % \end{macro} +% +% End check for bibliography option. +% \begin{macrocode} +\fi +% \end{macrocode} -% \subsection{Hyperlinks} +% \section{Hyperlinks and References} % -% Load the |hyperref| package \cite{hyperref} enable unicode encoding and hide links. +% Load the |hyperref| package \cite{hyperref} enable Unicode encoding and hide links. % % \begin{macrocode} \RequirePackage{hyperref} \hypersetup{ - hidelinks, - linktoc=all, pdfencoding=auto, psdextra, + hidelinks, + linktoc=all, breaklinks=true, pdfcreator={}, pdfproducer={} } % \end{macrocode} -% Set the PDF meta data according to the paper information and ensure that unnecessary information are suppressed. +% Set the \PDF meta data according to the paper information and ensure that unnecessary information is suppressed. % % \begin{macrocode} \pdfstringdefDisableCommands{\def\varepsilon{\textepsilon}} @@ -833,54 +1360,387 @@ \pdfstringdefDisableCommands{\let\thanks\@gobble} \pdfstringdefDisableCommands{\let\footnote\@gobble} \pdfstringdefDisableCommands{\let\\\@gobble} - \hypersetup{ - pdfauthor={\AB@authlist}, - pdftitle={\@title} - } } +\AtBeginShipout{\hypersetup{pdftitle={\@title}}} +\ifhep@title + \AtBeginDocument{\hypersetup{pdfauthor=\AB@authlist}} +\else + \AtBeginDocument{\hypersetup{pdfauthor={\@author}}} +\fi % \end{macrocode} -% \subsection{References} -% % \begin{macro}{\cref} -% Improve reference using the |cleveref| package \cite{cleveref} and prevent preceding line breaks various reference macros. +% Improve reference using the |cleveref| package \cite{cleveref}. % % \begin{macrocode} \RequirePackage[noabbrev, capitalize, nameinlink]{cleveref} \crefname{enumi}{point}{points} +\Crefname{enumi}{Point}{Points} +% \end{macrocode} +% \end{macro} + +% \begin{macro}{\refstepcounter@...} +% Adjust the |cleveref| |\refstepcounter@noarg| and |\refstepcounter@optarg| to use the |\@currentlabel| in order to fix problems with |\subref|. +% \begin{macrocode} +\def\refstepcounter@noarg#1{% + \cref@old@refstepcounter{#1}% + \cref@constructprefix{#1}{\cref@result}% + \@ifundefined{cref@#1@alias}% + {\def\@tempa{#1}}% + {\def\@tempa{\csname cref@#1@alias\endcsname}}% + \protected@edef\cref@currentlabel{% + [\@tempa][\arabic{#1}][\cref@result]% + \noexpand\@currentlabel% + }% changed +} + +\def\refstepcounter@optarg[#1]#2{% + \cref@old@refstepcounter{#2}% + \cref@constructprefix{#2}{\cref@result}% + \@ifundefined{cref@#1@alias}% + {\def\@tempa{#1}}% + {\def\@tempa{\csname cref@#1@alias\endcsname}}% + \protected@edef\cref@currentlabel{% + [\@tempa][\arabic{#2}][\cref@result]% + \noexpand\@currentlabel% changed + }% +} +% \end{macrocode} +% \end{macro} + +%\begin{macro}{\no@break@before} +% Provide macro able to prevent line breaks. +% \DoNotIndex{\no@break@before,\ifvmode,\ifhmode,\ifdim,\lastskip,\unskip,\nobreakspace} +% \begin{macrocode} +\newcommand\no@break@before{% + \relax\ifvmode\else% + \ifhmode% + \ifdim\lastskip > 0pt% + \relax\unskip\nobreakspace% + \fi% + \fi% + \fi% +} +% \end{macrocode} +% \end{macro} + +% \begin{macro}{\ref} +% Adjust |\ref|\marg{key} in order to prevent preceding line breaks and to enable the possibility to reference multiple references at once. +% \begin{macrocode} +\let\old@ref\ref +\AtBeginDocument{\renewcommand\ref{\no@break@before\labelcref}} % \end{macrocode} % \end{macro} % \begin{macro}{\eqref} -% Adjust |\eqref|\marg{ref} in order to prevent preceding line breaks and to enable the possibility to cite multiple equations at once. +% Adjust |\eqref|\marg{key} in order to prevent preceding line breaks and to enable the possibility to reference multiple equations at once. % \begin{macrocode} \renewcommand\eqref{\no@break@before\labelcref} % \end{macrocode} % \end{macro} % \begin{macro}{\subref} -% Adjust |\subref|\marg{ref} in order to prevent preceeding line breaks. +% Adjust |\subref|\marg{key} in order to prevent preceding line breaks. % \begin{macrocode} \let\old@subref\subref \renewcommand\subref{\no@break@before\old@subref} +\renewcommand*\subcaption@ref[2]{\begingroup% + \caption@setoptions{sub}% + \subcaption@reffmt\p@subref{\old@ref#1{sub@#2}}% +\endgroup} +% \end{macrocode} +% \end{macro} + +% \begin{macro}{\subcref} +% Provide the |\subcref| macro. +% \begin{macrocode} +\newcommand{\subcref}[1]{\cref{sub@#1}} +% \end{macrocode} +% \end{macro} + +% \begin{macro}{\eqcrefname} +% Define the |\eqcrefname| macro for named equation types. +% \begin{macrocode} +\DeclareDocumentCommand{\eqcrefname}{mmo}{ + \crefname{#1}{#2}{\IfValueTF{#3}{#3}{#2s}} + \creflabelformat{#1}{(##2##1##3)} +} +% \end{macrocode} +% \end{macro} + +% \begin{macro}{\labelcrefrange} +% Define the missing |\labelcrefrange|\marg{key1}\marg{key2} macro. +% \begin{macrocode} +\DeclareRobustCommand{\labelcrefrange}[2]{% + \@crefrangenostar{labelcref}{#1}{#2}% +} % \end{macrocode} % \end{macro} +% \subsection{Citation macros} +% % \begin{macro}{\cite} -% Adjust |\cite|\marg{ref} in order to prevent preceeding line breaks. +% Adjust |\cite|\marg{key} in order to prevent preceding line breaks. % \begin{macrocode} \let\old@cite\cite \renewcommand\cite{\no@break@before\old@cite} % \end{macrocode} % \end{macro} -% \begin{macro}{\labelcrefrange} -% Define the missing |\labelcrefrange|\marg{ref1}\marg{ref2} macro. +% Begin of bibliography if. +% \begin{macrocode} +\ifnum\pdf@strcmp{\hep@bibliography}{false}=0\else +% \end{macrocode} +% Define bibstrings for reference names. +% \begin{macrocode} +\NewBibliographyString{refname} +\NewBibliographyString{refsname} +\DefineBibliographyStrings{english}{% + refname = {Reference}, + refsname = {References} +} +% \end{macrocode} +% \begin{macro}{\ccite} +% \begin{macro}{\Ccite} +% Define \emph{clever} citation macros. +% \begin{macrocode} +\DeclareCiteCommand{\ccite}{% + \ifnum\thecitetotal=1% + \bibstring{refname}% + \else% + \bibstring{refsname}% + \fi% + \addnbspace\bibopenbracket% + \usebibmacro{cite:init}\usebibmacro{prenote}% +}{\usebibmacro{citeindex}\usebibmacro{cite:comp}}{}{% + \usebibmacro{cite:dump}\usebibmacro{postnote}% + \bibclosebracket% +} + +\newrobustcmd*{\Ccite}{\bibsentence\ccite} +% \end{macrocode} +% \end{macro} +% \end{macro} +% End of biblatex if. +% \begin{macrocode} +\fi +% \end{macrocode} + +% \section{Acronyms} +% +% Acronyms are implemented with the |glossaries-extra| package \cite{glossaries-extra} which is an extension of the |glossaries| package \cite{glossaries}. +% \begin{macrocode} +\ifhep@glossaries +\RequirePackage[nostyles]{glossaries-extra} +% \end{macrocode} +% The entry count feature is used. +% \begin{macrocode} +\glsenableentrycount +\glssetcategoryattribute{abbreviation}{entrycount}{1} +% \end{macrocode} +% Provide macros for older |glossaries-extra| installations. +% \begin{macrocode} +\providecommand{\glsxtrusefield}[2]{\@gls@entry@field{#1}{#2}} +\providecommand{\glsxtrsetfieldifexists}[3]{\glsdoifexists{#1}{#3}} +\providecommand{\gGlsXtrSetField}[3]{% + \glsxtrsetfieldifexists{#1}{#2}{% + \csgdef{glo@\glsdetoklabel{#1}@#2}{#3}% + }% +} +% \end{macrocode} +% Hyperlinks from the abbreviation to their definition in the text are set. +% \begin{macrocode} +\glssetcategoryattribute{abbreviation}{nohyperfirst}{true} +\renewcommand*{\glsdonohyperlink}[2]{{% + \glsxtrprotectlinks\edef\fieldvalue{% + \glsxtrusefield{\glslabel}{hastarget}% + }% + \ifdefstring\fieldvalue{true}{#2}{% + \gGlsXtrSetField{\glslabel}{hastarget}{true}% + \glsdohypertarget{#1}{#2}% + }% +}} +% \end{macrocode} + +% \begin{macro}{\if@begin@of@sentence} +% Mark the beginning of a paragraph as if it would follow a full stop using the |everyhook| package \cite{everyhook}. +% Provide a macro checking for the beginning of a sentence by examining the length of the preceeding space. (This breaks if |\frenchspacing| is activated) +% \begin{macrocode} +\usepackage[excludeor]{everyhook} +\PushPostHook{par}{{\spacefactor=3000}} +\newcommand{\if@begin@of@sentence}[2]{\leavevmode\protecting{% + \ifboolexpr{ test {\ifnumcomp{\spacefactor}{=}{3000}} or% + test {\ifnumcomp{\spacefactor}{=}{2000}}% + }{#1}{#2}% +}} +% \end{macrocode} +% \end{macro} + +% \begin{macro}{\acronym} +% The |\acronym|\meta{*}\oarg{typeset abbreviation}\marg{abbreviation}\marg{definition}\oarg{plural\linebreak[4] definition} macro is defined. +% \begin{enumerate}[nosep, label=\#\arabic*] +% \item star for omitting the \enquote{s} in the short plural +% \item optional typeset abbreviation +% \item mandatory abbreviation +% \item mandatory long form +% \item optional plural long form +% \end{enumerate} +% \begin{macrocode} +\DeclareDocumentCommand{\acronym}{sommo}{ + \newabbreviation[ + longplural=\IfNoValueTF{#5}{#4s}{#5}, + \glsshortpluralkey=\IfBooleanTF{#1}{#3}{\IfNoValueTF{#2}{#3s}{#2s}} + ]{#3}{\IfNoValueTF{#2}{#3}{#2}}{#4} +% \end{macrocode} +% Provide the singular acronym macro. +% \begin{macrocode} + \expandafter\newcommand\csname#3\endcsname{% + \if@begin@of@sentence{\cGls{#3}}{\cgls{#3}}\@\xspace% + } +% \end{macrocode} +% Expand the singular acronym macro in \PDF labels. +% \begin{macrocode} + \pdfstringdefDisableCommands{\expandafter\def\csname#3\endcsname{% + \IfNoValueTF{#2}{#3}{#2} }% + } +% \end{macrocode} +% Provide the singular acronym macro in math mode. +% \begin{macrocode} + \expandafter\mathdef\csname#3\endcsname{% + \text{\glsxtrshort{#3}}\glsunset{#3}% + } +% \end{macrocode} +% Provide the plural acronym macro. +% \begin{macrocode} + \expandafter\newcommand\csname#3s\endcsname{% + \if@begin@of@sentence{\cGlspl{#3}}{\cglspl{#3}}\@\xspace% + } +% \end{macrocode} +% Expand the plural acronym macro in \PDF labels. +% \begin{macrocode} + \pdfstringdefDisableCommands{\expandafter\def\csname#3s\endcsname{% + \IfBooleanTF{#1}{#3}{\IfNoValueTF{#2}{#3s}{#2s}} }% + } +% \end{macrocode} +% Provide the plural acronym macro in math mode. +% \begin{macrocode} + \expandafter\mathdef\csname#3s\endcsname{% + \text{\glsxtrshortpl{#3}}\glsunset{#3}% + } +} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\shortacronym} +% The |\shortacronym| never expands into the long form. % \begin{macrocode} -\DeclareRobustCommand{\labelcrefrange}[2]{\@crefrangenostar{labelcref}{#1}{#2}} +\DeclareDocumentCommand{\shortacronym}{somm}{ + \newabbreviation[ + \glsshortpluralkey=\IfBooleanTF{#1}{#3}{\IfNoValueTF{#2}{#3s}{#2s}} + ]{#3}{\IfNoValueTF{#2}{#3}{#2}}{#4} +% \end{macrocode} +% Provide the singular acronym macro. +% \begin{macrocode} + \expandafter\newcommand\csname#3\endcsname{\cgls*{#3}\@\xspace} +% \end{macrocode} +% Expand the singular acronym macro in \PDF labels. +% \begin{macrocode} + \pdfstringdefDisableCommands{\expandafter\def\csname#3\endcsname{% + \IfNoValueTF{#2}{#3}{#2} }% + } +% \end{macrocode} +% Provide the singular acronym macro in math mode. +% \begin{macrocode} + \expandafter\mathdef\csname#3\endcsname{\text{\glsxtrshort*{#3}}} +% \end{macrocode} +% Provide the plural acronym macro. +% \begin{macrocode} + \expandafter\newcommand\csname#3s\endcsname{\cglspl*{#3}\@\xspace} +% \end{macrocode} +% Expand the plural acronym macro in \PDF labels. +% \begin{macrocode} + \pdfstringdefDisableCommands{\expandafter\def\csname#3s\endcsname{% + \IfBooleanTF{#1}{#3}{\IfNoValueTF{#2}{#3s}{#2s}} }% + } +% \end{macrocode} +% Provide the plural acronym macro in math mode. +% \begin{macrocode} + \expandafter\mathdef\csname#3s\endcsname{\text{\glsxtrshortpl*{#3}}}% + \glsunset{#3} +} % \end{macrocode} % \end{macro} % +% \begin{macro}{\longacronym} +% The |\longacronym| never shows the abbreviated form. +% \begin{macrocode} +\DeclareDocumentCommand{\longacronym}{sommo}{ +% \end{macrocode} +% Provide the singular acronym macro. +% \begin{macrocode} + \expandafter\newcommand\csname#3\endcsname{% + \if@begin@of@sentence{\MakeUppercase#4}{#4}\@\xspace% + } +% \end{macrocode} +% Expand the singular acronym macro in \PDF labels. +% \begin{macrocode} + \pdfstringdefDisableCommands{\expandafter\def\csname#3\endcsname{#4 }} +% \end{macrocode} +% Provide the plural acronym macro. +% \begin{macrocode} + \expandafter\newcommand\csname#3s\endcsname{% + \if@begin@of@sentence{% + \IfNoValueTF{#5}{\MakeUppercase#4s}{\MakeUppercase#5}% + }{% + \IfNoValueTF{#5}{#4s}{#5}}\@\xspace% + } +% \end{macrocode} +% Expand the plural acronym macro in \PDF labels. +% \begin{macrocode} + \pdfstringdefDisableCommands{\expandafter\def\csname#3s\endcsname{% + \IfNoValueTF{#5}{#4s}{#5} }% + } +} +% \end{macrocode} +% \end{macro} +% Silence warning if no acronyms are defined. +% \begin{macrocode} +\renewcommand*{\@gls@write@entrycounts}{% + \immediate\write\@auxout{% + \string\providecommand*{\string\@gls@entry@count}[2]{} + }% + \count@=0\relax + \forallglsentries{\@glsentry}{% + \glshasattribute{\@glsentry}{entrycount}{% + \ifglsused{\@glsentry}{% + \immediate\write\@auxout{% + \string\@gls@entry@count{\@glsentry}{% + \glsentrycurrcount{\@glsentry}% + } + }% + }{}\advance\count@ by \@ne + }{}% + }% +} +% \end{macrocode} +% \begin{macro}{\resetacronym} +% \begin{macro}{\dummyacronym} +% Add two macros for acronym management. +% \begin{macrocode} +\newcommand{\resetacronym}[1]{\protect\glsreset{#1}} +\newcommand{\dummyacronym}[1]{\protect\glsunset{#1}} +% \end{macrocode} +% \end{macro} +% \end{macro} +% End of glossaries if. +% \begin{macrocode} +\fi +% \end{macrocode} +% % \Finale \endinput + +% \PrintIndex +% makeindex -s gglo.ist -o hep-paper.gls hep-paper.glo +% makeindex -s gglo.ist -o hep-paper.ind hep-paper.idx diff --git a/Master/texmf-dist/tex/latex/hep-paper/hep-paper.sty b/Master/texmf-dist/tex/latex/hep-paper/hep-paper.sty index 4ea1c73120b..e126a36b8a7 100644 --- a/Master/texmf-dist/tex/latex/hep-paper/hep-paper.sty +++ b/Master/texmf-dist/tex/latex/hep-paper/hep-paper.sty @@ -15,113 +15,193 @@ %% and version 1.3c or later is part of all distributions of %% LaTeX version 2005/12/01 or later. \NeedsTeXFormat{LaTeX2e}[2005/12/01] -\ProvidesPackage{hep-paper}[2020/01/01 v1.1 Publications in High Energy Physics] +\ProvidesPackage{hep-paper}[2020/03/01 v1.2 Publications in High Energy Physics] -\DeclareOption{a4paper}{% - \setlength\paperheight{297mm}% - \setlength\paperwidth{210mm}% +\RequirePackage{kvoptions} +\SetupKeyvalOptions{ + family=hep, + prefix=hep@ } -\DeclareOption{a5paper}{% - \setlength\paperheight{210mm}% - \setlength\paperwidth{148mm}% -} -\DeclareOption{b5paper}{% - \setlength\paperheight{250mm}% - \setlength\paperwidth{176mm}% -} -\DeclareOption{letterpaper}{% - \setlength\paperheight{11in}% - \setlength\paperwidth{8.5in}% -} -\DeclareOption{legalpaper}{% - \setlength\paperheight{14in}% - \setlength\paperwidth{8.5in}% -} -\DeclareOption{executivepaper}{% - \setlength\paperheight{10.5in}% - \setlength\paperwidth{7.25in}% -} -\DeclareOption{landscape}{% - \setlength\@tempdima{\paperheight}% - \setlength\paperheight{\paperwidth}% - \setlength\paperwidth{\@tempdima}% -} - -\DeclareOption{10pt}{\renewcommand\@ptsize{0}} -\DeclareOption{11pt}{\renewcommand\@ptsize{1}} -\DeclareOption{12pt}{\renewcommand\@ptsize{2}} - -\DeclareOption{placement}{\def\@placement} +\DeclareStringOption[a4]{paper} +\DeclareStringOption[11pt]{font} +\DeclareBoolOption[false]{defaults} +\DeclareStringOption[british]{lang} +\DeclareBoolOption[true]{parindent} +\DeclareComplementaryOption{parskip}{parindent} +\DeclareBoolOption[true]{serif} +\DeclareComplementaryOption{sansserif}{serif} +\DeclareBoolOption[false]{eqnarray} +\DeclareStringOption[numeric-comp]{bibliography} +\DeclareBoolOption[true]{glossaries} +\DeclareBoolOption[false]{manualplacement} +\DeclareBoolOption[true]{title} +\DeclareBoolOption[false]{revtex} + +\ProcessKeyvalOptions* +\ifhep@revtex + \setkeys{hep}{defaults, title=false, lang=american, bibliography=false} +\fi -\ExecuteOptions{a4paper,11pt} -\ProcessOptions\relax -\let\small\relax -\let\footnotesize\relax -\let\scriptsize\relax -\let\tiny\relax -\let\large\relax -\let\Large\relax -\let\LARGE\relax -\let\huge\relax -\let\Huge\relax -\input{size1\@ptsize.clo} +\RequirePackage{ifluatex} +\RequirePackage{ifxetex} +\newif\ifxetexorluatex +\ifxetex\xetexorluatextrue\else + \ifluatex\xetexorluatextrue + \else\xetexorluatexfalse + \fi +\fi -\RequirePackage[hscale=.76, vscale=.8, vmarginratio=3:4, includeheadfoot]{geometry} +\RequirePackage{alphabeta} +\ifxetexorluatex + \def\@encoding{TU} +\else + \def\@encoding{T1} +\fi +\RequirePackage[\@encoding]{fontenc} +\RequirePackage{lmodern} +\RequirePackage{textcomp} +\RequirePackage{microtype} -\RequirePackage{ifluatex} -\ifluatex - \RequirePackage{fontspec} - \defaultfontfeatures{Ligatures=TeX} - \RequirePackage{polyglossia} - \setmainlanguage{british} +\ifxetexorluatex + \DeclareFontShape{\@encoding}{lmss}{bx}{sc}{<->cmssbxcsc10}{} + \DeclareFontShape{\@encoding}{lmss}{m}{sc}{% + <-9>cmsscsc8<9-10>cmsscsc9<10->cmsscsc10% + }{} \else + \sffamily + \DeclareFontShape{\@encoding}{lmss}{bx}{sc}{<->ssub*xcmss/bx/sc}{} + \DeclareFontShape{\@encoding}{lmss}{m}{sc}{<->ssub*xcmss/m/sc}{} +\fi + +\ifxetexorluatex\else \RequirePackage[utf8]{inputenc} - \RequirePackage[T1]{fontenc} - \RequirePackage{textcomp} - \RequirePackage[british]{babel} \fi + +\RequirePackage[\hep@lang]{babel} \RequirePackage{csquotes} -\RequirePackage{lmodern} -\RequirePackage{microtype} -\RequirePackage[all,british]{foreign} +\ifhep@serif\else + \renewcommand\familydefault{\sfdefault} +\fi + +\RequirePackage{soul} +\let\underline\ul + +\ifhep@defaults\else + \def\remove@pt#1pt{#1} + \edef\@ptsize{\expandafter\remove@pt\hep@font} + \let\small\relax + \let\footnotesize\relax + \let\scriptsize\relax + \let\tiny\relax + \let\large\relax + \let\Large\relax + \let\LARGE\relax + \let\huge\relax + \let\Huge\relax + \input{size\@ptsize.clo} +\fi + +\RequirePackage{pdftexcmds} +\newcommand{\hep@lang@foreign}{british} +\ifnum\pdf@strcmp{\hep@lang}{american}=0% + \renewcommand{\hep@lang@foreign}{USenglish}% +\fi +\ifnum\pdf@strcmp{\hep@lang}{USenglish}=0% + \renewcommand{\hep@lang@foreign}{USenglish}% +\fi +\RequirePackage[all, \hep@lang@foreign]{foreign} \DeclareRobustCommand\vs{\xperiodafter{{\foreignabbrfont{vs}}}} \newcommand{\no}[1]{\textnumero~#1} -\newcommand{\software}[2][\hspace{-\fontdimen2\font}]{\texttt{#2}~#1} - -\def\sloppy{% - \emergencystretch 3em \hfuzz .5\p@ \vfuzz\hfuzz% +\RequirePackage{relsize} +\newcommand{\software}[2][\hspace{-\fontdimen2\font}]{% + {\smaller\textsc{#2}~#1}% } -\newcommand\no@break@before{% - \relax\ifvmode\else% - \ifhmode% - \ifdim\lastskip > 0pt% - \relax\unskip\nobreakspace% - \fi% - \fi% - \fi% -} +\newcommand{\online}[2]{\href{#1}{\url{#2}}} + \RequirePackage[inline]{enumitem} \newlist{inlinelist}{enumerate*}{1} -\setlist*[inlinelist,1]{itemjoin={,\ }, itemjoin*={, and\ }, after=.} +\setlist*[inlinelist,1]{% + label=\roman*), itemjoin={,\ }, itemjoin*={, and\ }, after=.% +} +\newlist{enum@descript}{enumerate}{2} +\setlist[enum@descript]{label=\arabic*.} +\newenvironment{enumdescript}[1][]{ +\begin{enum@descript}[#1] + \let\old@item\item + \renewcommand{\item}[2][]{ + \ifx&##1&\old@item\else\old@item[##1]\fi + \textbf{##2}\ifx##2\empty\else~\fi\@ifnextchar\par\@gobble\relax + } +}{\end{enum@descript}} \let\@foot@note\footnote \renewcommand{\footnote}[1]{\unskip\@foot@note{\ignorespaces#1}} +\ifhep@defaults\else + \RequirePackage[\hep@paper paper]{geometry} + \geometry{hscale=.75, vscale=.8, vmarginratio=3:4, includeheadfoot} +\fi + +\ifhep@parindent\else +\RequirePackage{parskip} +\newcommand{\useparskip}{% + \setlength{\parskip}{.5\baselineskip plus 2pt}% + \setlength{\parindent}{0pt}% +} +\newcommand{\useparindent}{% + \setlength{\parskip}{0pt}% + \setlength{\parindent}{15pt}% + \if@twocolumn\setlength\parindent{1em} + \else\setlength\parindent{1.5em} + \fi +} +\fi + \RequirePackage{mathtools} \RequirePackage{amssymb} \allowdisplaybreaks[1] \DeclareMathOperator{\diag}{diag} -\AtEndOfClass{\let\i\undefined\DeclareMathOperator{\i}{i}} +\RequirePackage{xparse} +\DeclareDocumentCommand{\mathdef}{mO{0}m}{% + \expandafter\let\csname old\string#1\endcsname=#1 + \expandafter\newcommand\csname new\string#1\endcsname[#2]{#3} + \DeclareRobustCommand#1{% + \ifmmode + \expandafter\let\expandafter\next\csname new\string#1\endcsname + \else + \expandafter\let\expandafter\next\csname old\string#1\endcsname + \fi + \next + }% +} -\RequirePackage{fixmath} -\RequirePackage{alphabeta} +\AtBeginDocument{\mathdef{\i}{\operatorname{i}}} + +\ifhep@eqnarray\else% + \let\eqnarray\@undefined + \let\endeqnarray\@undefined +\fi + +\RequirePackage{bm} +\let\mathbf\bm +\g@addto@macro\bfseries{\boldmath} +\ifhep@serif + \RequirePackage{fixmath} + \DeclareMathAlphabet{\mathsf}{OML}{cmbr}{m}{it} + \SetMathAlphabet{\mathsf}{bold}{OML}{cmbr}{bx}{it} +\else + \RequirePackage[slantedGreek]{sfmath} + \DeclareMathAlphabet{\mathsf}{OML}{cmm}{m}{it} + \SetMathAlphabet{\mathsf}{bold}{OML}{cmm}{bx}{it} +\fi +\RequirePackage{mathrsfs} \RequirePackage{physics} \RequirePackage{slashed} @@ -130,65 +210,61 @@ \newcommand{\inv}[2][1]{#2\ensuremath{^{-#1}}} \newcommand{\oset}[3][-1pt]{% - \raisebox{1pt}{% - \ensuremath{ - \mathop{#3}\limits^{\vbox to#1{\kern-2\ex@\hbox{$\scriptscriptstyle#2$}\vss}}% - }% - }% + \raisebox{1pt}{\ensuremath{\mathop{#3}\limits^{% + \vbox to#1{\kern-2\ex@\hbox{$\scriptscriptstyle#2$}\vss}% + }}}% } \newcommand{\overleftright}[1]{\oset{\leftrightarrow}{#1}} -\RequirePackage{bm} -\let\mathbf\bm -\g@addto@macro\bfseries{\boldmath} -\DeclareMathAlphabet{\mathsfit}{T1}{\sfdefault}{\mddefault}{\sldefault} -\SetMathAlphabet{\mathsfit}{bold}{T1}{\sfdefault}{\bfdefault}{\sldefault} - \renewcommand{\textfraction}{0.01} \setcounter{topnumber}{1} \renewcommand{\topfraction}{.9} \setcounter{bottomnumber}{0} \renewcommand{\floatpagefraction}{.8} -\ifdefined\@placement% - \let\@figure@\figure% - \let\@end@figure@\endfigure% +\let\@figure@\figure% +\let\@end@figure@\endfigure% +\let\@table@\table% +\let\@end@table@\endtable% +\ifhep@manualplacement% \renewenvironment{figure}[1][tbp]{% \@figure@[#1]\centering% - }{% - \@end@figure@% - }% - \let\@table@\table% - \let\@end@table@\endtable% + }{\@end@figure@}% \renewenvironment{table}[1][tbp]{% \@table@[#1]\centering% - }{% - \@end@table@% - }% + }{\@end@table@}% \else% - \let\@figure@\figure% - \let\@end@figure@\endfigure% \renewenvironment{figure}[1][]{% \@figure@\centering% - }{% - \@end@figure@% - }% - \let\@table@\table% - \let\@end@table@\endtable% + }{\@end@figure@}% \renewenvironment{table}[1][]{% \@table@\centering% - }{% - \@end@table@% - } + }{\@end@table@} \fi% +\ifhep@revtex + \setlength\abovecaptionskip{\f@size\p@} + \setlength\belowcaptionskip{0\p@} + \long\def\@makecaption#1#2{% + \vskip\abovecaptionskip + \sbox\@tempboxa{#1: #2}% + \ifdim \wd\@tempboxa >\hsize + #1: #2\par + \else + \global \@minipagefalse + \hb@xt@\hsize{\hfil\box\@tempboxa\hfil}% + \fi + \vskip\belowcaptionskip% + } +\fi \RequirePackage[subrefformat = parens]{subcaption} \captionsetup{font=small} \captionsetup[sub]{font=small} -\newcommand{\begin@subcaption@minipage}[2][b]{% - \caption@withoptargs\subcaption@minipage[#1]{#2}\centering\vskip 0pt% -} \newenvironment{panels}[2][b]{% + \newcommand{\begin@subcaption@minipage}[2][b]{% + \caption@withoptargs\subcaption@minipage[##1]{##2}% + \centering\vskip 0pt% + } \ifdim#2pt>1pt% \newcommand{\panel}[1][b]{% \endminipage\hfill\begin@subcaption@minipage[#1]{\linewidth/#2}% @@ -200,34 +276,55 @@ }% \begin@subcaption@minipage[#1]{#2\linewidth}% \fi% -}{% - \endminipage% -} +}{\endminipage} + +\ifhep@revtex + \renewcommand{\figurename}{Figure} + \renewcommand{\tablename}{Table} + \RequirePackage{ragged2e} + \DeclareCaptionFormat{revtex}{#1#2\justifying{#3}} + \captionsetup{font = small, format = revtex} + \captionsetup[sub]{font = footnotesize, format = plain} +\fi \RequirePackage{booktabs} \RequirePackage{multirow} \RequirePackage{graphicx} \providecommand{\tikzsetnextfilename}[1]{} -\newcommand{\graphic}[2][1]{% - \tikzsetnextfilename{#2}\centering\includegraphics[width=#1\linewidth]{#2}% -} +\newcommand{\graphic}[2][1]{\tikzsetnextfilename{#2}{% + \centering\includegraphics[width=#1\linewidth]{#2}% +}} +\newcommand{\graphics}[1]{\graphicspath{{./#1/}}} +\ifhep@title \date{} \author{} \AtEndOfClass{\newcommand{\email}[1]{% - \unskip\thanks{\href{mailto:#1}{\texttt{#1}}}% + \unskip\thanks{\online{mailto:#1}{#1}} }} \RequirePackage{authblk} \renewcommand\Affilfont{\footnotesize} -\newcommand{\affiliation}[2][]{\affil[#1]{\protecting{#2}}} +\newcommand\active@comma{,\penalty-5\relax} +\newcommand\cat@comma@active{\catcode`\,\active} +{\cat@comma@active\gdef,{\active@comma}} +\newcommand\@affil[1]{% + \endgroup\@flushglue=0pt plus .5\linewidth\affil{#1}% +} +\def\@affil@opt[#1]#2{% + \endgroup\@flushglue=0pt plus .5\linewidth\affil[#1]{#2}% +} +\DeclareRobustCommand\@affiliation{\@ifnextchar[{\@affil@opt}{\@affil}} +\newcommand{\affiliation}{\begingroup\cat@comma@active\@affiliation} \let\@preprint\relax \newcommand\preprint[1]{\long\gdef\@preprint{#1}} \RequirePackage{varwidth} \newcommand{\@preprint@box}{% - \begin{varwidth}{\textwidth}\textsc{\small\@preprint}\end{varwidth}% + \begin{varwidth}{\textwidth}% + \textsc{\small\@preprint}% + \end{varwidth}% } \RequirePackage{atbegshi} \RequirePackage{picture} @@ -240,42 +337,104 @@ \let\old@abstract\abstract \renewcommand\abstract{\old@abstract\noindent\ignorespaces} +\fi -\RequirePackage[sorting=none,style=numeric-comp,giveninits=true]{biblatex} +\ifnum\pdf@strcmp{\hep@bibliography}{false}=0\else +\RequirePackage[style=\hep@bibliography]{biblatex} +\ExecuteBibliographyOptions{ + sorting=none, + giveninits=true +} +\newcommand{\@reg@exp}{\regexp{\A(\p{L}+)?\d+(\p{L}+)?\Z}} +\newcommand{\@reg@exp@}{\regexp{\A(\p{L}+)?(\d+)(\p{L}+)?\Z}} \DeclareSourcemap{% \maps[datatype=bibtex,overwrite=true]{% \map{% \step[fieldsource=Collaboration,final=true]% - \step[fieldset=usera,origfieldval,final=true] + \step[fieldset=usere,origfieldval,final=true] }% \map{% \step[fieldsource=reportNumber,final=true]% - \step[fieldset=userb,origfieldval,final=true] + \step[fieldset=userf,origfieldval,final=true] }% + \map[overwrite]{ + \step[fieldsource=volume, match=\@reg@exp, final] + \step[fieldsource=volume, match=\@reg@exp@, replace={$2}] + \step[fieldsource=journal, fieldtarget=journaltitle] + \step[fieldset=journaltitle, fieldvalue={\space$1$2}, append=true] + } }% } + \renewbibmacro*{author}{% - \iffieldundef{usera}{\printnames{author}}{\textbf{\printfield{usera}}}% + \iffieldundef{usere}{\printnames{author}}{\textbf{\printfield{usere}}}% } + \renewbibmacro*{in:}{% \iffieldundef{journal}{}{\printtext{\bibstring{in}\intitlepunct}}% } -\renewbibmacro*{finentry}{% - \iffieldundef{userb}{}{% - \textls[0]{\small{\textsc{% - \newunitpunct\textnumero\intitlepunct\printfield{userb}% - }}}% - }\finentry% + +\providecommand{\letbibmacro}[2]{\csletcs{abx@macro@#1}{abx@macro@#2}} + +\letbibmacro{doi+eprint+url-old}{doi+eprint+url} +\renewbibmacro*{doi+eprint+url}{% + \usebibmacro{doi+eprint+url-old} + \iffieldundef{userf}{}{\textls[0]{% + \newunitpunct\textnumero\intitlepunct% + \textsc{\small\printfield{userf}}% + }}% +} + +\DeclareFieldFormat{eprint:ctan}{% + CTAN\addcolon\space\ifhyperref{% + \href{https://ctan.org/pkg/#1}{\nolinkurl{#1}}% + }{\nolinkurl{#1}}% +} +\DeclareFieldAlias{eprint:CTAN}{eprint:ctan} + +\DeclareFieldFormat{eprint:github}{% + GitHub\addcolon\space\ifhyperref{\href{% + https://github.com/\thefield{eprintclass}/#1% + }{\nolinkurl{\thefield{eprintclass}/#1}}% + }{\nolinkurl{\thefield{eprintclass}/#1}}% +} +\DeclareFieldAlias{eprint:GitHub}{eprint:github} + +\DeclareFieldFormat{eprint:gitlab}{% + GitLab\addcolon\space\ifhyperref{\href{% + https://gitlab.com/\thefield{eprintclass}/#1% + }{\nolinkurl{\thefield{eprintclass}/#1}}% + }{\nolinkurl{\thefield{eprintclass}/#1}}% +} +\DeclareFieldAlias{eprint:GitLab}{eprint:gitlab} + +\DeclareFieldFormat{eprint:sourceforge}{% + SourceForge\addcolon\space\ifhyperref{% + \href{https://sourceforge.net/projects/#1}{\nolinkurl{#1}}% + }{\nolinkurl{#1}}% +} +\DeclareFieldAlias{eprint:SourceForge}{eprint:sourceforge} + +\DeclareFieldFormat{eprint:hepforge}{% + HEPForge\addcolon\space\ifhyperref{% + \href{https://#1/hepforge.org/}{\nolinkurl{#1}}% + }{\nolinkurl{#1}}% } +\DeclareFieldAlias{eprint:HEPForge}{eprint:hepforge} + +\NewBibliographyString{erratum} +\DefineBibliographyStrings{english}{erratum={Erratum:}} + \let\old@printbibliography\printbibliography \renewcommand{\printbibliography}{\sloppy\old@printbibliography} +\fi \RequirePackage{hyperref} \hypersetup{ - hidelinks, - linktoc=all, pdfencoding=auto, psdextra, + hidelinks, + linktoc=all, breaklinks=true, pdfcreator={}, pdfproducer={} @@ -288,24 +447,206 @@ \pdfstringdefDisableCommands{\let\thanks\@gobble} \pdfstringdefDisableCommands{\let\footnote\@gobble} \pdfstringdefDisableCommands{\let\\\@gobble} - \hypersetup{ - pdfauthor={\AB@authlist}, - pdftitle={\@title} - } } +\AtBeginShipout{\hypersetup{pdftitle={\@title}}} +\ifhep@title + \AtBeginDocument{\hypersetup{pdfauthor=\AB@authlist}} +\else + \AtBeginDocument{\hypersetup{pdfauthor={\@author}}} +\fi \RequirePackage[noabbrev, capitalize, nameinlink]{cleveref} \crefname{enumi}{point}{points} +\Crefname{enumi}{Point}{Points} + +\def\refstepcounter@noarg#1{% + \cref@old@refstepcounter{#1}% + \cref@constructprefix{#1}{\cref@result}% + \@ifundefined{cref@#1@alias}% + {\def\@tempa{#1}}% + {\def\@tempa{\csname cref@#1@alias\endcsname}}% + \protected@edef\cref@currentlabel{% + [\@tempa][\arabic{#1}][\cref@result]% + \noexpand\@currentlabel% + }% changed +} + +\def\refstepcounter@optarg[#1]#2{% + \cref@old@refstepcounter{#2}% + \cref@constructprefix{#2}{\cref@result}% + \@ifundefined{cref@#1@alias}% + {\def\@tempa{#1}}% + {\def\@tempa{\csname cref@#1@alias\endcsname}}% + \protected@edef\cref@currentlabel{% + [\@tempa][\arabic{#2}][\cref@result]% + \noexpand\@currentlabel% changed + }% +} + +\newcommand\no@break@before{% + \relax\ifvmode\else% + \ifhmode% + \ifdim\lastskip > 0pt% + \relax\unskip\nobreakspace% + \fi% + \fi% + \fi% +} + +\let\old@ref\ref +\AtBeginDocument{\renewcommand\ref{\no@break@before\labelcref}} \renewcommand\eqref{\no@break@before\labelcref} \let\old@subref\subref \renewcommand\subref{\no@break@before\old@subref} +\renewcommand*\subcaption@ref[2]{\begingroup% + \caption@setoptions{sub}% + \subcaption@reffmt\p@subref{\old@ref#1{sub@#2}}% +\endgroup} + +\newcommand{\subcref}[1]{\cref{sub@#1}} + +\DeclareDocumentCommand{\eqcrefname}{mmo}{ + \crefname{#1}{#2}{\IfValueTF{#3}{#3}{#2s}} + \creflabelformat{#1}{(##2##1##3)} +} + +\DeclareRobustCommand{\labelcrefrange}[2]{% + \@crefrangenostar{labelcref}{#1}{#2}% +} \let\old@cite\cite \renewcommand\cite{\no@break@before\old@cite} -\DeclareRobustCommand{\labelcrefrange}[2]{\@crefrangenostar{labelcref}{#1}{#2}} +\ifnum\pdf@strcmp{\hep@bibliography}{false}=0\else +\NewBibliographyString{refname} +\NewBibliographyString{refsname} +\DefineBibliographyStrings{english}{% + refname = {Reference}, + refsname = {References} +} +\DeclareCiteCommand{\ccite}{% + \ifnum\thecitetotal=1% + \bibstring{refname}% + \else% + \bibstring{refsname}% + \fi% + \addnbspace\bibopenbracket% + \usebibmacro{cite:init}\usebibmacro{prenote}% +}{\usebibmacro{citeindex}\usebibmacro{cite:comp}}{}{% + \usebibmacro{cite:dump}\usebibmacro{postnote}% + \bibclosebracket% +} + +\newrobustcmd*{\Ccite}{\bibsentence\ccite} +\fi + +\ifhep@glossaries +\RequirePackage[nostyles]{glossaries-extra} +\glsenableentrycount +\glssetcategoryattribute{abbreviation}{entrycount}{1} +\providecommand{\glsxtrusefield}[2]{\@gls@entry@field{#1}{#2}} +\providecommand{\glsxtrsetfieldifexists}[3]{\glsdoifexists{#1}{#3}} +\providecommand{\gGlsXtrSetField}[3]{% + \glsxtrsetfieldifexists{#1}{#2}{% + \csgdef{glo@\glsdetoklabel{#1}@#2}{#3}% + }% +} +\glssetcategoryattribute{abbreviation}{nohyperfirst}{true} +\renewcommand*{\glsdonohyperlink}[2]{{% + \glsxtrprotectlinks\edef\fieldvalue{% + \glsxtrusefield{\glslabel}{hastarget}% + }% + \ifdefstring\fieldvalue{true}{#2}{% + \gGlsXtrSetField{\glslabel}{hastarget}{true}% + \glsdohypertarget{#1}{#2}% + }% +}} + +\usepackage[excludeor]{everyhook} +\PushPostHook{par}{{\spacefactor=3000}} +\newcommand{\if@begin@of@sentence}[2]{\leavevmode\protecting{% + \ifboolexpr{ test {\ifnumcomp{\spacefactor}{=}{3000}} or% + test {\ifnumcomp{\spacefactor}{=}{2000}}% + }{#1}{#2}% +}} + +\DeclareDocumentCommand{\acronym}{sommo}{ + \newabbreviation[ + longplural=\IfNoValueTF{#5}{#4s}{#5}, + \glsshortpluralkey=\IfBooleanTF{#1}{#3}{\IfNoValueTF{#2}{#3s}{#2s}} + ]{#3}{\IfNoValueTF{#2}{#3}{#2}}{#4} + \expandafter\newcommand\csname#3\endcsname{% + \if@begin@of@sentence{\cGls{#3}}{\cgls{#3}}\@\xspace% + } + \pdfstringdefDisableCommands{\expandafter\def\csname#3\endcsname{% + \IfNoValueTF{#2}{#3}{#2} }% + } + \expandafter\mathdef\csname#3\endcsname{% + \text{\glsxtrshort{#3}}\glsunset{#3}% + } + \expandafter\newcommand\csname#3s\endcsname{% + \if@begin@of@sentence{\cGlspl{#3}}{\cglspl{#3}}\@\xspace% + } + \pdfstringdefDisableCommands{\expandafter\def\csname#3s\endcsname{% + \IfBooleanTF{#1}{#3}{\IfNoValueTF{#2}{#3s}{#2s}} }% + } + \expandafter\mathdef\csname#3s\endcsname{% + \text{\glsxtrshortpl{#3}}\glsunset{#3}% + } +} +\DeclareDocumentCommand{\shortacronym}{somm}{ + \newabbreviation[ + \glsshortpluralkey=\IfBooleanTF{#1}{#3}{\IfNoValueTF{#2}{#3s}{#2s}} + ]{#3}{\IfNoValueTF{#2}{#3}{#2}}{#4} + \expandafter\newcommand\csname#3\endcsname{\cgls*{#3}\@\xspace} + \pdfstringdefDisableCommands{\expandafter\def\csname#3\endcsname{% + \IfNoValueTF{#2}{#3}{#2} }% + } + \expandafter\mathdef\csname#3\endcsname{\text{\glsxtrshort*{#3}}} + \expandafter\newcommand\csname#3s\endcsname{\cglspl*{#3}\@\xspace} + \pdfstringdefDisableCommands{\expandafter\def\csname#3s\endcsname{% + \IfBooleanTF{#1}{#3}{\IfNoValueTF{#2}{#3s}{#2s}} }% + } + \expandafter\mathdef\csname#3s\endcsname{\text{\glsxtrshortpl*{#3}}}% + \glsunset{#3} +} +\DeclareDocumentCommand{\longacronym}{sommo}{ + \expandafter\newcommand\csname#3\endcsname{% + \if@begin@of@sentence{\MakeUppercase#4}{#4}\@\xspace% + } + \pdfstringdefDisableCommands{\expandafter\def\csname#3\endcsname{#4 }} + \expandafter\newcommand\csname#3s\endcsname{% + \if@begin@of@sentence{% + \IfNoValueTF{#5}{\MakeUppercase#4s}{\MakeUppercase#5}% + }{% + \IfNoValueTF{#5}{#4s}{#5}}\@\xspace% + } + \pdfstringdefDisableCommands{\expandafter\def\csname#3s\endcsname{% + \IfNoValueTF{#5}{#4s}{#5} }% + } +} +\renewcommand*{\@gls@write@entrycounts}{% + \immediate\write\@auxout{% + \string\providecommand*{\string\@gls@entry@count}[2]{} + }% + \count@=0\relax + \forallglsentries{\@glsentry}{% + \glshasattribute{\@glsentry}{entrycount}{% + \ifglsused{\@glsentry}{% + \immediate\write\@auxout{% + \string\@gls@entry@count{\@glsentry}{% + \glsentrycurrcount{\@glsentry}% + } + }% + }{}\advance\count@ by \@ne + }{}% + }% +} +\newcommand{\resetacronym}[1]{\protect\glsreset{#1}} +\newcommand{\dummyacronym}[1]{\protect\glsunset{#1}} +\fi \endinput %% |