summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/hepthesis/hepthesis.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/hepthesis/hepthesis.tex')
-rw-r--r--Master/texmf-dist/doc/latex/hepthesis/hepthesis.tex103
1 files changed, 69 insertions, 34 deletions
diff --git a/Master/texmf-dist/doc/latex/hepthesis/hepthesis.tex b/Master/texmf-dist/doc/latex/hepthesis/hepthesis.tex
index 7209893924b..6f709b49053 100644
--- a/Master/texmf-dist/doc/latex/hepthesis/hepthesis.tex
+++ b/Master/texmf-dist/doc/latex/hepthesis/hepthesis.tex
@@ -1,7 +1,7 @@
\documentclass[12pt]{article}
%\usepackage{booktabs}
\usepackage{maybemath, xspace, setspace, fancyvrb, a4wide, url, relsize}
-\usepackage[colorlinks=true,pdfpagemode=FullScreen,bookmarks=true]{hyperref}
+\usepackage[colorlinks=true,bookmarks=true]{hyperref}
\newcommand{\maybemath}{\texttt{maybemath}\xspace}
\newcommand{\hepthesis}{\texttt{hepthesis}\xspace}
@@ -41,16 +41,16 @@
\section{Introduction}
When I began my PhD, I was surprised to find that there was no standard \LaTeX
thesis class used by students in my field (high-energy particle physics, hence
-the ``hep''). In retrospect, this is not so surprising --- groups tend to have
-an informal system of handing down slightly tailored thesis templates (complete
-with in line \texcommand{vspace}s, \texcommand{Huge}s and all the rest) through
-generations of students without ever formalising the style and attempting to do
-it ``properly''. By the time it came to write my own thesis it was obvious that
-I would only retain my sanity through measures of extreme procrastination and so
-this package came to be. It has now been edited and hacked for about 2 years,
-taking stylistic features from other theses that I've thought attractive. As my
-own thesis has been recently submitted, this seems an apt time to release the
-first official version of \hepthesis upon the world.
+the ``hep''). In retrospect, this is not so surprising --- research groups tend
+to have an informal system of handing down slightly tailored thesis templates
+(complete with in line \texcmd{vspace}s, \texcmd{Huge}s and all the
+rest) through generations of students without ever formalising the style and
+attempting to do it ``properly''. By the time it came to write my own thesis it
+was obvious that I would only retain my sanity through measures of extreme
+procrastination and so this package came to be. It has now been edited and
+hacked for about 2 years, taking stylistic features from other theses that I've
+thought attractive. As my own thesis has been recently submitted, this seems an
+apt time to release the first official version of \hepthesis upon the world.
This document will document the structure of \hepthesis and how to make it work
with you rather than against you. I may be unable to resist including other
@@ -70,6 +70,7 @@ decide for yourself:
\item Nicely (re-)defined figure, table and equation environments
\item Optional mode for generating hyper-links when building PDF files
\item Built-in draft copy mode with line numbering
+\item Maths in section titles etc. will automatically be boldened if appropriate
\end{itemize}
@@ -130,6 +131,8 @@ the class options:
\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{sfheaders~\cite{sfheaders}:} non-standard (?). Enable with the |sftitles| option
\end{itemize}
Some other handy packages (which aren't required at all for compatibility with
@@ -179,6 +182,10 @@ Prints ``DRAFT'' diagonally across the pages and numbers the lines, suitable for
proof-reading. This makes use of the standard |draftcopy| and the less-standard
|lineno| packages.
+\subsection{\texoption{sftitles}}
+Uses a sans-serif font for the title page and all chapter, section and
+subsection headings. Requires the |sfheaders| package.
+
\subsection{\texoption{booktabs} \Or \texoption{nobooktabs}}
Use the |booktabs| package to define the \hepthesis tabular environment.
|booktabs| produces publication quality tables, as opposed to \TeX's rather
@@ -207,13 +214,24 @@ that this option requires some carefulness with the |.aux| file, since
alternating between PS and PDF builds involves repeatedly writing and removing
hyperref tokens. A solution to this is described in Appendix \ref{app:AuxFileProblem}.
-\subsection{\texoption{index}}
+\subsection{\texopt{index}}
Include the |makeidx| package, to allow an index to be built. Note that you have
to do this by hand and that it's probably best done as a retrospective feature
after you've written the thesis. Not many people want to spend \emph{more} time
with their thesis when they've done enough to pass!
-\subsection{\texoption{a4paper} \Or \texoption{a4narrow} \Or \texoption{letterpaper} \Or \dots}
+\subsection{\texopt{titling}}
+Use the |titling| package to redefine the \texcmd{title} and \texcmd{author}
+commands so that their arguments are available through the document as
+\texcmd{thetitle} and \texcmd{theauthor}. This is used, for example, by the
+\texcmd{titlepage} command. If this option isn't passed, a more basic attempt is
+made to do this definition without needing an external package. It's unclear
+whether titling really helps but there may be complicated cases (such as those
+where the author includes a \texcmd{thanks}) where |titling| may do a better
+job. This is untested, though, and the result of using \texcmd{thanks} in a
+|hepthesis| document is to be considered undefined.
+
+\subsection{\texopt{a4paper} \Or \texoption{a4narrow} \Or \texoption{letterpaper} \Or \dots}
Choose the paper size. Duh.
%\subsection{\texoption{hep} \Or \texoption{hep\{fd,layout,hyper,float,all\}}}
@@ -228,22 +246,24 @@ choice is yours!
Here are the environments and commands, roughly in the order that you'd use them:
-\subsection{\texcmd{definethesis}}
-This command should be placed in the preamble, and is used to define
-the thesis title and the author (you!). In future, maybe I'll find a nice way to
-use the built-in \texcmd{author} and \texcmd{title} commands for this. Use it like:
+\subsection{\texcmd{title} and \texcmd{author}}
+Up to version 1.3, a special \texcmd{definethesis} command was used to specify
+the thesis author and title. While this is still retained for backwards compatibility,
+it is deprecated and you should use the standard \texcmd{title} and \texcmd{author}
+macros instead. Don't use \texcmd{thanks} in the author argument: the results are
+undefined!
%
\begin{snippet}
-\definethesis%
- {A study of \BToKPi decays with the \LHCb experiment}%
- {Andrew Gordon Buckley}
+\title{A study of \BToKPi decays with the \LHCb experiment}
+\author{Andrew Gordon Buckley}
...
\begin{document}
-...
+ ...
\end{snippet}
-Once this command has been executed, the title and author strings are available
-via the \texcommand{thetitle} and \texcommand{theauthor} commands.
+Once these commands have been executed, the title and author strings are available
+via the \texcommand{thetitle} and \texcommand{theauthor} commands. These are used by
+\texcmd{titlepage}.
\subsection{\texenv{frontmatter} \Or \texenv{mainmatter} \Or \texenv{appendices} \Or \texenv{backmatter}}
Use these to delimit the auxiliary parts of your thesis from the main feature
@@ -258,17 +278,23 @@ itself, which is intended for such things as the bibliography, colophon etc.
\subsection{\texcmd{titlepage}}
The \texcmd{titlepage} macro generates a title page for the thesis and as such
should probably be the first item in the front matter. It takes two arguments:
-the institution and the description of the award for which the thesis is being
-submitted. You may need to hack this or use a different macro if your
-institution has a very different prescribed format for the layout of thesis
-title pages. Here's an example:
+an optional elaboration of the author name and the description of the award for
+which the thesis is being submitted. You may need to use a different macro if
+your institution has a very different prescribed format for the layout of thesis
+title pages: in such a case, the \texcmd{theauthor} and \texcmd{thetitle}
+commands will probably be useful. Here's an example of usage:
%
\begin{snippet}
-\thesistitlepage
-{Churchill College}
-{A dissertation submitted to the University
- of Cambridge\\ for the degree of Doctor of Philosophy}
+\thesistitlepage[of \\ Churchill College]%
+{A dissertation submitted to the University of Cambridge\\
+for the degree of Doctor of Philosophy}
\end{snippet}
+%
+Additionally, the \texcmd{maketitle} command has been redefined to behave as
+\texcmd{titlepage} with two empty arguments. This is only provided to not
+confuse users who convert to |hepthesis| from a standard \LaTeX{} class and
+expect \texcmd{maketitle} to work: \texcmd{titlepage} is a more powerful
+command and should be used by those who are aware of it. That includes you!
\subsection{\texenv{abstract}}
Where you present the summary of your thesis: this should be within the
@@ -374,7 +400,8 @@ an example:
\subsection{\texenv{table}}
Tables --- use like any other table (probably combined with the tabular
environment). It has been slightly modified to be horizontally centered and have
-an slightly increased vertical spacing at the top.
+an slightly increased vertical spacing at the top. It supports the standard
+\LaTeX{} ``[!htbp]'' float placement specifiers.
\subsection{\texenv{tabular}}
If the |booktabs| package is used (enabled by default), then the tabular
@@ -383,7 +410,8 @@ looks much nicer than \TeX's default tables.
\subsection{\texenv{figure} and \texenv{sidewaysfigure}}
The \texenv{figure}, \texenv{figure*} and \texenv{sidewaysfigure} environments
-are re-defined to be automatically centered.
+are re-defined to be automatically centered. They support the standard \LaTeX{}
+``[!htbp]'' float placement specifiers.
\subsection{\texenv{equation \Or displaymath}}
These environments and their starred versions are re-defined so that
@@ -548,7 +576,12 @@ here's the TODO:
\begin{itemize}
\item Make |hepthesis| use |subfig| in place of |subfigure| and check out compatibility between |caption| and |caption2|.
\item Make the spacing in the \texcmd{SectionRef} etc. commands customisable.
-\item Make the vertical spacings on the quote, dedication and title pages appropriate for the paper size
+\item Allow the PDF page style to be specified as a class argument
+\item Allow section titles to be centre / right justified?
+\item User control of frontmatter title sizes and alignments? (Probably not\dots)
+\item Provide different styles for the titlepage etc.
+\item Themes, like for Beamer?
+\item Make the vertical spacings on the quote, dedication and title pages change by paper size
\end{itemize}
@@ -679,6 +712,8 @@ Otherwise you can just delete the |.aux| file when you change between using
\bibitem{booktabs}{booktabs: \url{ctan:/macros/latex/contrib/booktabs/}}
\bibitem{draftcopy}{draftcopy: \url{ctan:/macros/latex/contrib/draftcopy/}}
\bibitem{lineno}{lineno: \url{ctan:/macros/latex/contrib/lineno/}}
+\bibitem{titling}{titling: \url{ctan:/macros/latex/contrib/titling/}}
+\bibitem{sfheaders}{sfheaders: \url{ctan:/macros/latex/contrib/sfheaders/}}
\bibitem{SIunits}{SIunits: \url{ctan:/macros/latex/contrib/SIunits/}}
\bibitem{hepunits}{hepunits: \url{ctan:/macros/latex/contrib/hepunits/}}
\bibitem{hepnames}{hepnames: \url{ctan:/macros/latex/contrib/hepnames/}}