summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/hepthesis/hepthesis.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2010-06-04 14:50:32 +0000
committerKarl Berry <karl@freefriends.org>2010-06-04 14:50:32 +0000
commit70c5604c155226ecad5f0c797cc59c9ce50e1e49 (patch)
treebfff574998380f5097007d19c6c64a3c7d20267f /Master/texmf-dist/doc/latex/hepthesis/hepthesis.tex
parent68ae4f7bfb0b890c21bd8c5d10752b008f641cd0 (diff)
hepthesis 1.4.3 (3jun10)
git-svn-id: svn://tug.org/texlive/trunk@18725 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/hepthesis/hepthesis.tex')
-rw-r--r--Master/texmf-dist/doc/latex/hepthesis/hepthesis.tex108
1 files changed, 54 insertions, 54 deletions
diff --git a/Master/texmf-dist/doc/latex/hepthesis/hepthesis.tex b/Master/texmf-dist/doc/latex/hepthesis/hepthesis.tex
index 7d18f68de14..fdca18876db 100644
--- a/Master/texmf-dist/doc/latex/hepthesis/hepthesis.tex
+++ b/Master/texmf-dist/doc/latex/hepthesis/hepthesis.tex
@@ -19,8 +19,8 @@
\newcommand{\Or}{\texorpdfstring{\ensuremath{\vert}\xspace}{or}}
\newcommand{\manifestsAs}{\texorpdfstring{\ensuremath{\Rightarrow\quad}\xspace}{->}}
-\newcommand{\texcmd}[1]{\texorpdfstring{\texttt{\char`\\#1}}{#1}}
-\newcommand{\texenv}[1]{\texorpdfstring{\texttt{#1}}{#1}}
+\newcommand{\texcmd}[1]{\texorpdfstring{\texttt{\char`\\#1}}{#1}}
+\newcommand{\texenv}[1]{\texorpdfstring{\texttt{#1}}{#1}}
\newcommand{\texopt}[1]{\texorpdfstring{\texttt{#1}}{#1}}
\newcommand{\texarg}[1]{\texorpdfstring{\texttt{\{#1\}}}{\textbraceleft#1\textbraceright}}
\newcommand{\texargoptgen}[1]{\texorpdfstring{\texttt{[}\gen{#1}\texttt{]}}{\textbraceleft<#1>\textbraceright}}
@@ -93,7 +93,7 @@ The basic usage mode for \hepthesis is to place
%
in the preamble of your document. This will then set up the document's appearance and
provide the \hepthesis macros as do the standard \LaTeX{} classes like |article|
-and |report|. A more sophisticated and flexible approach is described in
+and |report|. A more sophisticated and flexible approach is described in
Appendix~\ref{app:DerivedClass}.
Although strictly unrelated to \hepthesis, it is usual to write each thesis
@@ -121,25 +121,25 @@ be natively available in your \TeX{} distribution; the rest from CTAN.
Here's the mandatory packages:
\begin{itemize}
-\item \textbf{scrbook~\cite{scrbook}} (from KOMA-scripts)
-\item \textbf{setspace~\cite{setspace}}
-\item \textbf{fancyhdr~\cite{fancyhdr}}
-\item \textbf{rotating~\cite{rotating}}
-\item \textbf{tocbibind~\cite{tocbibind}}
-\item \textbf{caption~\cite{caption}}
-\item \textbf{chngpage~\cite{chngpage}}
-\item \textbf{varwidth~\cite{varwidth}}
+\item \textbf{scrbook\,\cite{scrbook}} (from KOMA-scripts)
+\item \textbf{setspace\,\cite{setspace}}
+\item \textbf{fancyhdr\,\cite{fancyhdr}}
+\item \textbf{rotating\,\cite{rotating}}
+\item \textbf{tocbibind\,\cite{tocbibind}}
+\item \textbf{caption\,\cite{caption}}
+\item \textbf{changepage\,\cite{changepage}}
+\item \textbf{varwidth\,\cite{varwidth}}
\end{itemize}
\vspace{0.4cm}
\noindent\fbox{\begin{minipage}{0.85\textwidth}\textsl{
%
-Note that the \texpkg{subfig}\cite{subfig} (previously \texpkg{subfigure})
-and \texpkg{ccaption}\cite{ccaption} package, which were required up to
-version 1.3, are no longer needed.
-If you need sub-figures then you should \texcmd{usepackage} the package as
-usual in your document preamble or custom class file, and make use of the
-\texcmd{ContinuedFloat} command for continuation captions, which is
+Note that the \texpkg{subfig}\,\cite{subfig} (previously \texpkg{subfigure})
+and \texpkg{ccaption}\,\cite{ccaption} packages, which were required up to
+version 1.3, are no longer needed.
+If you need sub-figures then you should \texcmd{usepackage} the package as
+usual in your document preamble or custom class file, and make use of the
+\texcmd{ContinuedFloat} command for continuation captions, which is
provided by the mandatory \texpkg{caption} package.
%
}\end{minipage}}
@@ -149,16 +149,16 @@ Additionally, there are several packages which are only required depending on
the class options:
\begin{itemize}
-%\item \textbf{cite~\cite{cite}}
-\item \textbf{csquotes~\cite{csquotes}:} very standard. Quotation commands will use this if loaded.
-\item \textbf{babel~\cite{babel}:} very standard. Quotation commands will use this if loaded.
-\item \textbf{a4wide~\cite{a4wide}:} very standard. Disabled with any paper size option other than |a4paper|
-\item \textbf{amsmath~\cite{amsmath}:} very, \emph{very} standard. Disabled with the |noams| option
-\item \textbf{hyperref~\cite{hyperref}:} very standard. Enabled with the |hyper| option
-\item \textbf{booktabs~\cite{booktabs}:} non-standard. Disable with the |nobooktabs| option
-\item \textbf{draftcopy~\cite{draftcopy}:} very standard. Enable with the |draft| option
-\item \textbf{lineno~\cite{lineno}:} non-standard (?). Enable with the |draft| option
-\item \textbf{titling~\cite{titling}:} non-standard (?). Enable with the |titling| option
+%\item \textbf{cite\,\cite{cite}}
+\item \textbf{csquotes\,\cite{csquotes}:} very standard. Quotation commands will use this if loaded.
+\item \textbf{babel\,\cite{babel}:} very standard. Quotation commands will use this if loaded.
+\item \textbf{a4wide\,\cite{a4wide}:} very standard. Disabled with any paper size option other than |a4paper|
+\item \textbf{amsmath\,\cite{amsmath}:} very, \emph{very} standard. Disabled with the |noams| option
+\item \textbf{hyperref\,\cite{hyperref}:} very standard. Enabled with the |hyper| option
+\item \textbf{booktabs\,\cite{booktabs}:} non-standard. Disable with the |nobooktabs| option
+\item \textbf{draftcopy\,\cite{draftcopy}:} very standard. Enable with the |draft| option
+\item \textbf{lineno\,\cite{lineno}:} non-standard (?). Enable with the |draft| option
+\item \textbf{titling\,\cite{titling}:} non-standard (?). Enable with the |titling| option
\end{itemize}
Some other handy packages (which aren't required at all for compatibility with
@@ -167,15 +167,15 @@ Section~\ref{sec:ExtraPackages}.
\subsection{Troublesome interactions}
Unfortunately not all \LaTeX{} packages get on well with each other --- if
-you are unlucky then you may get some of \TeX's wondertully cryptic error
+you are unlucky then you may get some of \TeX's wondertully cryptic error
messages on trying to use \texpkg{hepthesis}. Here are the problems that I'm
aware of\dots
\begin{itemize}
-\item
-If you have problems with \LaTeX{} complaining about bad definitions of
-\texcmd{pdfstringdefPreHook}, you may be using an old version of \texpkg{csquotes},
-which doesn't interface well to \texpkg{hyperref}. I think this is fixed in
+\item
+If you have problems with \LaTeX{} complaining about bad definitions of
+\texcmd{pdfstringdefPreHook}, you may be using an old version of \texpkg{csquotes},
+which doesn't interface well to \texpkg{hyperref}. I think this is fixed in
\texpkg{csquotes} version 3.2 and later --- it certainly works for version
3.7. Try including the \texpkg{csquotes} package with
%
@@ -376,7 +376,7 @@ Each command takes a single argument, which is just a \TeX{} length. Here's an e
%% TODO Change in v1.5
\subsection{\texcmd{title}\texarggen{title} and \texcmd{author}\texarggen{author}}
-The usual commands for setting the author and title. Don't use \texcmd{thanks} in
+The usual commands for setting the author and title. Don't use \texcmd{thanks} in
the \hepthesis author argument: the results are undefined!
%
\begin{fsnippet}
@@ -418,7 +418,7 @@ commands will probably be useful. Here's an example of usage:
%
\begin{fsnippet}
\titlepage[of \\ Churchill College]%
-{A dissertation submitted to the University of Cambridge\\
+{A dissertation submitted to the University of Cambridge\\
for the degree of Doctor of Philosophy}
\end{fsnippet}
%
@@ -463,7 +463,7 @@ obligatory thanks to a supervisor). Use it (in the front matter again) like:
%
\begin{fsnippet}
\begin{acknowledgements}
- Of the many people who deserve thanks, some are
+ Of the many people who deserve thanks, some are
particularly prominent, for example...
\end{acknowledgements}
\end{fsnippet}
@@ -503,13 +503,13 @@ your thesis in a few choice words, for example:
\end{fsnippet}
%
\texcmd{frontquote} also takes an optional argument indicating which language the
-quote is in. This will change the quotation mark and hyphenation styles, if the
+quote is in. This will change the quotation mark and hyphenation styles, if the
\texpkg{babel} and \texpkg{csquotes} packages are loaded:
%
\begin{fsnippet}
\frontquote[french]%
{Le savant n'\'etudie pas la nature parce que cela est utile; \\
- il l'\'etudie parce qu'il y prend plaisir et il y prend plaisir
+ il l'\'etudie parce qu'il y prend plaisir et il y prend plaisir
parce qu'elle est belle.}%
{Henri Poincar\'e, 1854--1912}
...
@@ -533,7 +533,7 @@ As for \texcmd{frontquote}, an optional language argument can be used.
A colophon is an inscription placed at the end of a book or other work that
talks about how the work was created and what things were used in its creation.
This should go in the back matter of your thesis and is completely optional.
-If you use this, please mention \hepthesis' r\^ole in making your thesis! Here's
+If you use this, please mention \hepthesis' r\^ole in making your thesis! Here's
an example:
%
\begin{fsnippet}
@@ -599,7 +599,7 @@ the text width and chosen to avoid overflows. Use them like this:
\label{fig:CKMFitter}
\end{figure}
\end{fsnippet}
-
+
Note also that this way of including images will automatically look for an
|.eps| file when building PostScript and a |.pdf| file when building PDF. You
may find the |eps2pdf| and |pdf2eps| utilities useful.
@@ -647,7 +647,7 @@ which is the version described above, prefixed with ``thesis''\footnote{This
is a hang-over from early versions of my thesis, when I didn't know how to
robustly extend and re-define environments and commands.}. These forms are
frankly a bit of a pain to use, so use the short versions, please. The
-``thesis---'' versions should be considered deprecated and \textbf{will be removed
+``thesis---'' versions should be considered deprecated and \textbf{will be removed
in the next release, version 1.5}.
@@ -655,19 +655,19 @@ in the next release, version 1.5}.
\label{sec:ExtraPackages}
Here are some other packages it might be good to know about:
\begin{itemize}
-\item \textbf{SIunits~\cite{SIunits}:} \emph{the} way to do units and get it right.
-\item \textbf{hepunits~\cite{hepunits}:} my extension of |SIunits| to include some common HEP units not used elsewhere.
-\item \textbf{hepnames~\cite{hepnames} and hepparticles~\cite{hepparticles}:} my packages for typesetting HEP particle names \emph{properly}, with |hepnames| defining macros for a lot of the standard ones. Requires |maybemath|~\cite{maybemath}
-\item \textbf{braket~\cite{braket}:} decent implementation of Dirac bra and ket notation
-\item \textbf{cancel~\cite{cancel}:} the best way to do Feynman slashes (in my opinion)
-\item \textbf{feynmf/feynmp~\cite{feynmf} and axodraw~\cite{axodraw}:} various approaches to doing Feynman diagrams, especially in equations, inline contexts and so-on.
+\item \textbf{SIunits\,\cite{SIunits}:} \emph{the} way to do units and get it right.
+\item \textbf{hepunits\,\cite{hepunits}:} my extension of |SIunits| to include some common HEP units not used elsewhere.
+\item \textbf{hepnames\,\cite{hepnames} and hepparticles\,\cite{hepparticles}:} my packages for typesetting HEP particle names \emph{properly}, with |hepnames| defining macros for a lot of the standard ones. Requires |maybemath|\,\cite{maybemath}
+\item \textbf{braket\,\cite{braket}:} decent implementation of Dirac bra and ket notation
+\item \textbf{cancel\,\cite{cancel}:} the best way to do Feynman slashes (in my opinion)
+\item \textbf{feynmf/feynmp\,\cite{feynmf} and axodraw\,\cite{axodraw}:} various approaches to doing Feynman diagrams, especially in equations, inline contexts and so-on.
\end{itemize}
%
and some related software:
%
\begin{itemize}
-\item \textbf{FeynDiagram~\cite{feyndiagram} and Jaxodraw~\cite{jaxodraw}}: for Feynman diagrams outside \TeX. You might also
- be interested in my |pyfeyn|~\cite{pyfeyn} program.
+\item \textbf{FeynDiagram\,\cite{feyndiagram} and Jaxodraw\,\cite{jaxodraw}}: for Feynman diagrams outside \TeX. You might also
+ be interested in my |pyfeyn|\,\cite{pyfeyn} program.
\item \textbf{SLAC SPIRES' biblio tools service:} see \url{www.slac.stanford.edu/spires/}
\end{itemize}
@@ -689,7 +689,7 @@ writing an HEP thesis then I'd encourage you to use the |hepnames| \LaTeX{}
package for typesetting particle names --- it depends on the extra
|hepparticles| and |maybemath| packages, which you'll also have to download. The
examples used here also rely on the |hepunits| package: you can all these extra
-packages from the CTAN~\cite{CTAN}. See Appendix~\ref{app:InstallingPackages} for
+packages from the CTAN\,\cite{CTAN}. See Appendix~\ref{app:InstallingPackages} for
a quick guide on how to install personal copies of \LaTeX{} packages.
@@ -718,7 +718,7 @@ a quick guide on how to install personal copies of \LaTeX{} packages.
\section{Wishlist / TODO}
I'm not planning on writing another thesis, but maybe I'll add features if
there's demand. If you add a nice feature, pass it on to me and I'll think about
-including it in the package (and will give you some credit, of course). But anyway,
+including it in the package (and will give you some credit, of course). But anyway,
here's the TODO:
%
\begin{itemize}
@@ -745,7 +745,7 @@ constructive criticism! Email your thoughts to
\section{Acknowledgements}
I'd like to thank all the people who have provided bug reports, patches, suggestions
-and who have otherwise helped me to get \hepthesis to the state it's in. See the
+and who have otherwise helped me to get \hepthesis to the state it's in. See the
|ChangeLog| file in the distribution for names!
@@ -753,7 +753,7 @@ and who have otherwise helped me to get \hepthesis to the state it's in. See the
\section{Using your own derived document class}
\label{app:DerivedClass}
-If you're feeling sophisticated, then you can make your own document class based on
+If you're feeling sophisticated, then you can make your own document class based on
\hepthesis by placing
%
\begin{snippet}
@@ -780,7 +780,7 @@ $ mkdir -p $HOME/local/texmf/tex/latex
$ mkdir -p $HOME/local/texmf/bibtex/bib
$ mkdir -p $HOME/local/texmf/bibtex/bst
\end{snippet}
-\item Download the packages from CTAN~\cite{CTAN} or wherever.
+\item Download the packages from CTAN\,\cite{CTAN} or wherever.
\item Follow the packages' installation instructions to install them into the \\
|$HOME/local/texmf/tex/latex| %$
directory you made above (or an appropriately-named sub-directory of it if you
@@ -860,7 +860,7 @@ Otherwise you can just delete the |.aux| file when you change between using
\bibitem{subfig}{subfig: \url{ctan:/obsolete/macros/latex/contrib/subfig/}}
\bibitem{caption}{caption: \url{ctan:/macros/latex/contrib/caption/}}
\bibitem{ccaption}{ccaption: \url{ctan:/macros/latex/contrib/ccaption/}}
-\bibitem{chngpage}{chngpage: \url{ctan:/macros/latex/contrib/chngpage/}}
+\bibitem{changepage}{changepage: \url{ctan:/macros/latex/contrib/changepage/}}
\bibitem{varwidth}{varwidth: \url{ctan:/macros/latex/contrib/varwidth/}}
\bibitem{csquotes}{csquotes: \url{ctan:/macros/latex/contrib/csquotes/}}
\bibitem{babel}{babel: \url{ctan:/macros/latex/contrib/babel/}}