summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/hep/README
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/hep/README
Initial commit
Diffstat (limited to 'macros/latex/contrib/hep/README')
-rw-r--r--macros/latex/contrib/hep/README53
1 files changed, 53 insertions, 0 deletions
diff --git a/macros/latex/contrib/hep/README b/macros/latex/contrib/hep/README
new file mode 100644
index 0000000000..d6583452a5
--- /dev/null
+++ b/macros/latex/contrib/hep/README
@@ -0,0 +1,53 @@
+hep --- convenience wrapper for high-energy physics packages
+by Andy Buckley <andy@insectnation.org>
+-----------------------------------------------------------
+
+The hep package is a relatively thin wrapper package on a variety of packages
+useful for typesetting high-energy physics documents. It is aimed at HEP users
+who just want to write papers without having to worry about which packages are
+useful. hep includes a useful minimal set of packages by default, with more
+specialist ones being available via package options.
+
+The default packages (activated just by placing \usepackage{hep} in the document
+preamble) are:
+ * url: provides \url{} macro for typestting (you guessed it) URLs. For example,
+ \url{http://www.mysite.org}.
+ * cite: gathers consecutive citations to show e.g. [21-23] rather than [21,22,23]
+ * amsmath: extended maths stymbols etc.
+ * braket: provides \bra{}, \ket{} and \braket{} macros for Dirac notation
+ * cancel/slashed: two different ways to do Feynman slash notation
+ * hepnicenames: collection of macros for typesetting particle names. Also includes
+ heppennames and hepparticles. See
+ http://www.tex.ac.uk/tex-archive/help/Catalogue/entries/hepnames.html and
+ http://www.tex.ac.uk/tex-archive/help/Catalogue/entries/hepparticles.html
+ for details.
+ * hepunits: extends the SIunits package to provide HEP specific units, accessed
+ via e.g. \unit{114.5}{\GeVovercsq} (the LEP2 lower bound on the Higgs mass).
+ See http://www.tex.ac.uk/tex-archive/help/Catalogue/entries/hepunits.html
+ for details.
+
+Options for these default packages can be passed using \usepackage[option1,option2,...]{hep}
+The available options are:
+ * HNitalic, HNitforce, HNmaybess, HNnoss,
+ corresponding to the hepnames/hepparticles options (without the "HN" prefix)
+
+ * HUnoprefixcmds, HUcdot, HUthickspace, HUmediumspace, HUthinspace,
+ HUthickqspace, HUmediumqspace, HUthinqspace, HUnoamssquareissue,
+ HUamssymb, HUsquaren, HUpstricks, HUGray, HUitalian, HUtextstyle
+ HUnotextstyle, HUbinary, HUnoams, HUderivedinbase, HUderived
+ corresponding to the hepunits options (without the "HU" prefix)
+
+Additionally, the "fd", "hyper", "layout" and "float" options add useful
+packages for Feynman diagrams, hyperlinking (with sensible default options),
+layout additions (the booktabs, setspace, fancyhdr and tocbibind packages) and
+additional float handling (via the morefloats, afterpage, ccaption, subfigure
+and caption packages). The convenience option "all" includes all of the optional
+packages. While the hyper, layout and float options are not HEP-specific, they
+reflect the package author's prejudice that not enough authors know about these
+packages and that they should be encouraged to use them :-)
+
+Comments, criticism etc. should be directed at andy-texpkg@insectnation.org.
+
+This material is subject to the LaTeX Project Public License.
+See http://www.ctan.org/tex-archive/help/Catalogue/licenses.lppl.html
+for the details of that license.