summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/hep-bibliography/hep-bibliography-documentation.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/hep-bibliography/hep-bibliography-documentation.tex')
-rw-r--r--Master/texmf-dist/doc/latex/hep-bibliography/hep-bibliography-documentation.tex86
1 files changed, 86 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/hep-bibliography/hep-bibliography-documentation.tex b/Master/texmf-dist/doc/latex/hep-bibliography/hep-bibliography-documentation.tex
new file mode 100644
index 00000000000..9172ff1ad42
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/hep-bibliography/hep-bibliography-documentation.tex
@@ -0,0 +1,86 @@
+%%
+%% This is file `hep-bibliography-documentation.tex',
+%% generated with the docstrip utility.
+%%
+%% The original source files were:
+%%
+%% hep-bibliography-implementation.dtx (with options: `documentation')
+%% This is a generated file.
+%% Copyright (C) 2019-2020 by Jan Hajer
+%% This file may be distributed and/or modified under the
+%% conditions of the LaTeX Project Public License, either
+%% version 1.3c of this license or (at your option) any later
+%% version. The latest version of this license is in:
+%% http://www.latex-project.org/lppl.txt
+%% and version 1.3c or later is part of all distributions of
+%% LaTeX version 2005/12/01 or later.
+
+\ProvidesFile{hep-bibliography-documentation.tex}[2021/08/01 v1.8 HEP-Bibliography documentation]
+
+\RequirePackage[l2tabu, orthodox]{nag}
+\documentclass{ltxdoc}
+\AtBeginDocument{\DeleteShortVerb{\|}}
+\AtBeginDocument{\MakeShortVerb{\"}}
+
+\EnableCrossrefs
+\CodelineIndex
+\RecordChanges
+
+\usepackage[parskip]{hep-paper}
+
+\bibliography{bibliography}
+
+\acronym{URL}{uniform resource locator}
+
+\usepackage{hologo}
+
+\MacroIndent=1.5em
+\AtBeginEnvironment{macrocode}{\renewcommand{\ttdefault}{clmt}}
+
+\GetFileInfo{hep-bibliography.sty}
+
+\title{The \software{hep-bibliography} package\thanks{This document corresponds to \software{hep-bibliography}~\fileversion.}}
+\subtitle{Bibliographies for high energy physics}
+\author{Jan Hajer \email{jan.hajer@unibas.ch}}
+\date{\filedate}
+
+\begin{document}
+
+\newgeometry{vscale=.8, vmarginratio=3:4, includeheadfoot, left=11em, marginparwidth=4.6cm, marginparsep=3mm, right=7em}
+
+\maketitle
+
+\begin{abstract}
+The \software{hep-bibliography} package extends the \software{biblatex} package with some functionality mostly useful for high energy physics.
+In particular it makes full use of all "bibtex" fields provided by "inspirehep.net".
+\end{abstract}
+
+The package can be loaded via "\usepackage{hep-bibliography}".
+
+\DescribeMacro{\bibliography}
+\DescribeMacro{\printbibliography}
+The \software{biblatex} package \cite{biblatex} is loaded for bibliography management.
+The user has to add the line "\bibliography"\marg{my.bib} to the preamble of the document and "\printbibliography" at the end of the document.
+The bibliography is generated by \software{Biber} \cite{biber}.
+"biblatex" is extended to be able to cope with the "collaboration" and "reportNumber" fields provided by \online{https://inspirehep.net}{inspirehep.net} and a bug in the volume number is fixed.
+Additionally, the PubMed IDs are recognized and \online{https://ctan.org}{ctan.org}, \online{https://github.com}{github.com}, \online{https://gitlab.com}{gitlab.com}, \online{https://bitbucket.org}{bitbucket.org}, \online{https://www.launchpad.net}{launchpad.net}, \online{https://sourceforge.net}{sourceforge.net}, and \online{https://hepforge.org}{hepforge.org} are valid "eprinttype"s.
+\DescribeMacro{erratum}
+Errata can be included using the "related" feature.
+\begin{verbatim}
+\article{key1,
+ ...,
+ relatedtype="erratum",
+ related="key2",
+}
+\article{key2,
+ ...,
+}
+\end{verbatim}
+
+\printbibliography
+
+\end{document}
+
+\endinput
+%%
+%% End of file `hep-bibliography-documentation.tex'.