Commit e9e32a0d authored by Edward Longman's avatar Edward Longman
Browse files

Correct typos, improve build description, improve spacing and layout and remove redundant files

parent d852561a
...@@ -44,10 +44,10 @@ If you are writing a technical or mathematical thesis, then you may want to read ...@@ -44,10 +44,10 @@ If you are writing a technical or mathematical thesis, then you may want to read
under the ``Additional Documentation'' section towards the bottom of the page. under the ``Additional Documentation'' section towards the bottom of the page.
\subsection{Common \LaTeX{} Math Symbols} \subsection{Common \LaTeX{} Math Symbols}
There are a multitude of mathematical symbols available for \LaTeX{} and it would take a great effort to learn the commands for them all. The most common ones you are likely to use are shown on this page: There are a multitude of mathematical symbols available for \LaTeX{} and it would take a great effort to learn the commands for them all. The most common ones you are likely to use are shown on this quick reference sheet:
\url{http://www.sunilpatel.co.uk/latex-type/latex-math-symbols/} \url{http://www.sunilpatel.co.uk/latex-type/latex-math-symbols/}.
Also, \url{https://detexify.kirelabs.org/} is very useful, detecting what you draw and suggesting appropriate symbols.
You can use this page as a reference or crib sheet, the symbols are rendered as large, high quality images so you can quickly find the \LaTeX{} command for the symbol you need.
\section{Prerequisistes}\label{prereq} \section{Prerequisistes}\label{prereq}
You should have installed a TeX distribution (MiKTeX or TexLive). How to do so can be found by searching the internet. You should have installed a TeX distribution (MiKTeX or TexLive). How to do so can be found by searching the internet.
...@@ -61,9 +61,9 @@ MacTeX includes a custom dedicated \LaTeX{} editor called TeXShop for writing yo ...@@ -61,9 +61,9 @@ MacTeX includes a custom dedicated \LaTeX{} editor called TeXShop for writing yo
\subsection{TeXlive GUI Installer (Windows and Unix)}\label{texlive} \subsection{TeXlive GUI Installer (Windows and Unix)}\label{texlive}
TeXLive has a friendly GUI installer, it helps to only install the collections (``Advanced'' install) required to reduce the size though (this will speed your install up). TeXLive has a friendly GUI installer, it helps to only install the collections (``Advanced'' install) required to reduce the size though (this will speed your install up).
The following process can be followed to select the collections required the result of which is shown in Figure~\ref{Figure:CustomCollections}. The following process (correct in 2019) can be followed to select the collections required, the result of which is shown in Figure~\ref{Figure:CustomCollections}.
\begin{itemize} \begin{itemize}
\item You may need to run the installer as an Administrator (right click\textgreater Run as Administrator). \item You may need to run the installer as an Administrator (right click \textgreater{} Run as Administrator).
\item To start the installer select ``Install'', Click ``Next'' and then ``Install'' \item To start the installer select ``Install'', Click ``Next'' and then ``Install''
\item Now the installer is running select ``Advanced'', as in \fref{Figure:SelectAdvanced} \item Now the installer is running select ``Advanced'', as in \fref{Figure:SelectAdvanced}
\begin{figure} \begin{figure}
...@@ -72,6 +72,7 @@ The following process can be followed to select the collections required the res ...@@ -72,6 +72,7 @@ The following process can be followed to select the collections required the res
\label{Figure:RunInstaller}}{ \label{Figure:RunInstaller}}{
\includegraphics[scale=0.6]{Install2019/RunInstaller} \includegraphics[scale=0.6]{Install2019/RunInstaller}
} }
\hspace{3em}%
\subcaptionbox{Select advanced installation to select the right collections for reduced size. \subcaptionbox{Select advanced installation to select the right collections for reduced size.
\label{Figure:SelectAdvanced}}{ \label{Figure:SelectAdvanced}}{
\includegraphics[scale=0.6]{Install2019/SelectAdvanced} \includegraphics[scale=0.6]{Install2019/SelectAdvanced}
...@@ -81,10 +82,10 @@ The following process can be followed to select the collections required the res ...@@ -81,10 +82,10 @@ The following process can be followed to select the collections required the res
\item Then choose Scheme, medium is a good setup.% \item Then choose Scheme, medium is a good setup.%
\item Then choose specific collections for this thesis template, the install size should now be around 2GB. As shown in \fref{Figure:CustomCollections}% \item Then choose specific collections for this thesis template, the install size should now be around 2GB. As shown in \fref{Figure:CustomCollections}%
\begin{itemize} \begin{itemize}
\item[-] Remove any languages you do not need. \item[$-$] Remove any languages you do not need.
\item[-] Remove ``ConTeXt'', ``MetaPost'', ``XeTeX'' \item[$-$] Remove ``ConTeXt'', ``MetaPost'', ``XeTeX''
\item[+] Add ``LaTex Additional Packages'', ``Graphics, Pictures, Diagrams'' \item[$+$] Add ``LaTeX Additional Packages'', ``Graphics, Pictures, Diagrams''
\item[*] The installation of ``TeXworks editor'' is optional \item[$\sim$] The installation of ``TeXworks editor'' is optional
\end{itemize} \end{itemize}
\begin{figure} \begin{figure}
\centering \centering
...@@ -92,14 +93,15 @@ The following process can be followed to select the collections required the res ...@@ -92,14 +93,15 @@ The following process can be followed to select the collections required the res
\label{Figure:CustomScheme}}{ \label{Figure:CustomScheme}}{
\includegraphics[scale=0.6]{Install2019/CustomScheme} \includegraphics[scale=0.6]{Install2019/CustomScheme}
} }
\vspace{1em}%
\subcaptionbox{Required installation collections in Tex Live Windows/Unix Installer \subcaptionbox{Required installation collections in Tex Live Windows/Unix Installer
\label{Figure:CustomCollections}}{ \label{Figure:CustomCollections}}{
\includegraphics[scale=0.6]{Install2019/CollectionsCustom} \includegraphics[scale=0.6]{Install2019/CollectionsCustom}
} }
\caption{Reducing the install size by reducing to required packages only}\label{Figure:SchemeAndCollections} \caption{Reducing the install size by only selecting required packages}\label{Figure:SchemeAndCollections}
\end{figure} \end{figure}
\item Click ``Install'' to begin the install (around half an hour). \item Click ``Install'' to begin the install (around half an hour).
\item The ``Droid'' package is required for the copyright statement. Install this using the ``Tex Live Manager'' after the main install, as shown in \fref{Figure:TeXLiveManagerDroid}. \item The ``Droid'' package is required for the thesis copyright statement. Install this using the ``Tex Live Manager'' after the main install, as shown in \fref{Figure:TeXLiveManagerDroid}.
\begin{figure} \begin{figure}
\centering \centering
\includegraphics[scale=0.6]{Install2019/InstallDroid} \includegraphics[scale=0.6]{Install2019/InstallDroid}
......
No preview for this file type
%% ---------------------------------------------------------------- %% ----------------------------------------------------------------
%% README.tex %% README.tex
%% ---------------------------------------------------------------- %% ----------------------------------------------------------------
\documentclass[sotoncolour]{uosthesis} % Use the Thesis Style \documentclass[sotoncolour,oneside]{uosthesis} % Use the Thesis Style
\graphicspath{{../Figures/}} % Location of your graphics files \graphicspath{{../Figures/}} % Location of your graphics files
\usepackage{natbib} % Use Natbib style for the refs. \usepackage{natbib} % Use Natbib style for the refs.
\hypersetup{colorlinks=true} % Set to false for black/white printing \hypersetup{colorlinks=true} % Set to false for black/white printing
...@@ -32,10 +32,10 @@ ...@@ -32,10 +32,10 @@
\frontmatter \frontmatter
\maketitle \maketitle
\begin{abstract} \begin{abstract}
This introduction the University of Southampton Thesis template should get you started with this template as quick as possible. This introduction to the University of Southampton Thesis template should get you started with this template as quickly as possible.
Whilst knowledge of \LaTeX{} in advance is helpful this guide should be friendly Whilst knowledge of \LaTeX{} in advance is helpful, this guide should be friendly
enough to get started without it. enough to get started without it.
This guide has been produced in the style of a thesis, with some front sections omitted. This guide has been produced in the style of a thesis, with some front sections and blank pages omitted.
\end{abstract} \end{abstract}
\tableofcontents \tableofcontents
%% ----------------------- %% -----------------------
...@@ -50,7 +50,7 @@ This guide has been produced in the style of a thesis, with some front sections ...@@ -50,7 +50,7 @@ This guide has been produced in the style of a thesis, with some front sections
This template is the cumulative effort of a number of people, of whom I am just the most recent. This template is the cumulative effort of a number of people, of whom I am just the most recent.
The template relies on the work of \cite{Gunn:2001:pdflatex} who started this work and \cite{Lovell:2011:updated} who textually updated some parts. The template relies on the work of \cite{Gunn:2001:pdflatex} who started this work and \cite{Lovell:2011:updated} who textually updated some parts.
This guide is an extension of the work of \href{http://latextemplates.com}{Vel (at latextemplates.com)}, and \href{https://www.sunilpatel.co.uk/thesis-template/}{Sunil Patel} who kindly gave permission for me to use their instructions \citep{latex_patels} as a base.} This guide is an extension of the work of \href{http://latextemplates.com}{Vel (at latextemplates.com)}, and \href{https://www.sunilpatel.co.uk/thesis-template/}{Sunil Patel} who kindly gave permission for me to use their instructions \citep{latex_patels} as a base.}
\dedicatory{To \dots} % \dedicatory{To \dots}
\mainmatter \mainmatter
%% ---------------------------------------------------------------- %% ----------------------------------------------------------------
\include{Introduction} \include{Introduction}
......
\chapter{Rebuilding the Templates}\label{rebuilding} \chapter{Rebuilding the Templates}\label{rebuilding}
In most cases this template style and layout will be suitable. If it is not, it may only require a small change to bring the template in line with your institution's recommendations. In most cases this template style and layout will be suitable. If it is not, it may only require a small change to bring the template in line with your institution's recommendations.
Quick modifications will need to be done on the \verb|uosdocs.cls| file in the \verb|tex/latex/uosdocs| folder. Modification of all the templates or major modifications should be made to the original \verb|source/docstrip/uosdocs/uosdocs.dtx| Quick modifications will need to be done on the \verb|uosthesis.cls|, \verb|uosprogress.cls| etc. file in the \verb|tex/latex/uosdocs| folder. Modification of all the templates or major modifications should be made to the original \verb|source/latex/uosdocs/uosdocs.dtx|
\section{The Build Process} \section{The Build Process}
To change the templates you should understand how the templates are made. To change the templates you should understand how the templates are made.
...@@ -13,6 +13,7 @@ When this tool is run it creates lots of auxiliary files. ...@@ -13,6 +13,7 @@ When this tool is run it creates lots of auxiliary files.
To help with managing these auxiliary files GNU Make is used. ``GNU Make is a tool which controls the generation of executables and other non-source files of a program from the program's source files.''\citep{GNUdesc}. To help with managing these auxiliary files GNU Make is used. ``GNU Make is a tool which controls the generation of executables and other non-source files of a program from the program's source files.''\citep{GNUdesc}.
The make command can be run in several different configurations. \verb|make all| creates all of the class, template, bibliography and figure files from the source files. \verb|make install| moves all of the created files into the users texmf directory ready for use. The make command can be run in several different configurations. \verb|make all| creates all of the class, template, bibliography and figure files from the source files. \verb|make install| moves all of the created files into the users texmf directory ready for use.
Also, the \verb|make Thesis.zip| etc. will package the minimum necessary files for each type of template.
\section{The Source File} \section{The Source File}
The source file \verb|uosdocs.dtx| results in the several different class (\verb|.cls|) files as well as the template (\verb|.tex|) files. The source file \verb|uosdocs.dtx| results in the several different class (\verb|.cls|) files as well as the template (\verb|.tex|) files.
...@@ -20,7 +21,7 @@ The source file \verb|uosdocs.dtx| results in the several different class (\verb ...@@ -20,7 +21,7 @@ The source file \verb|uosdocs.dtx| results in the several different class (\verb
extracts the code from a \verb|.dtx| file, uses \verb|DocStrip| to extracts the code from a \verb|.dtx| file, uses \verb|DocStrip| to
strip off the comments and documentation, and outputs the \verb|.cls| files.''\citep{pack_write} strip off the comments and documentation, and outputs the \verb|.cls| files.''\citep{pack_write}
It also creates the figure files and the chapter files. It also creates the figure files and the chapter files.
Whilst this creates a mess of files all in one folder the \verb|make install| command is designed to clean them up into a folder structure described in Listing~\ref{folder_struct}. Whilst this creates a mess of files all in one folder, the \verb|make install| command is designed to clean them up into a folder structure described in Listing~\ref{folder_struct}.
The dtx file is designed to ensure continuity across different classes: names, font, department page styling and other formats. The dtx file is designed to ensure continuity across different classes: names, font, department page styling and other formats.
It largely self documents into the folder labelled \verb|doc|. It largely self documents into the folder labelled \verb|doc|.
......
...@@ -9,8 +9,6 @@ The structure of this folder should look like this. ...@@ -9,8 +9,6 @@ The structure of this folder should look like this.
+-texmf +-texmf
+-bibtex +-bibtex
| +-bib | +-bib
| | +-uosdocs
| +-bst
| +-uosdocs | +-uosdocs
+-doc +-doc
| +-latex | +-latex
...@@ -27,22 +25,24 @@ The structure of this folder should look like this. ...@@ -27,22 +25,24 @@ The structure of this folder should look like this.
\end{lstlisting} \end{lstlisting}
On some \LaTeX{} systems, the directory look-up tables will need to be refreshed after making additions or deletions to the system files. On some \LaTeX{} systems, the directory look-up tables will need to be refreshed after making additions or deletions to the system files.
For TeXlive systems this is accomplished via executing \verb|texhash| as root. For TeXlive systems this is accomplished via executing \verb|texhash| as root.
MikTeX users can update it with \texttt{MiKTeX Console -> Tasks ->Refresh file name database} or in the console by running \verb|initexmf -u| to accomplish the same thing. MikTeX users can update it with \texttt{MiKTeX Console -> Tasks -> Refresh file name database} or in the console by running \verb|initexmf -u| to accomplish the same thing.
The \verb|templates/latex/uosdocs| folder contains the files to get you started. The \verb|templates/latex/uosdocs| folder contains the files to get you started.
The base file is \verb|Thesis.tex| for a thesis and \verb|Progress.tex| for a progress report. The base file is \verb|Thesis.tex| for a thesis and \verb|Progress.tex| for a progress report.
The base files have dependancies for the sections and the figures. The base files have dependencies for the sections and the figures.
These files are: \verb|Definitions.tex|, \verb|Introduction.tex|, \verb|Conclusion.tex|, \verb|AppendixA.tex|, \verb|figure.eps|, \verb|UOS.bib|(in the bibtex base folder). To start using the templates, copy the base file and the dependancies into your working directory. These files are: \verb|Definitions.tex|, \verb|Introduction.tex|, \verb|Conclusion.tex|, \verb|AppendixA.tex|, \verb|figure.eps|, \verb|UOS.bib| (in the bibtex base folder). To start using the templates, copy the base file and the dependencies into your working directory.
These files are designed as a starting point for the structure of your thesis. These files are designed as a starting point for the structure of your thesis.
If you are familiar with \LaTeX{}, go and explore the template and use it. Maybe start with putting your info in the section \emph{THESIS/DOC INFORMATION} block of the \verb|Thesis.tex| or \verb|Progress.tex| file. You can then modify the rest of this file to your unique specifications based on your degree/university. If you are new to \LaTeX{} then read about the file structure below. If you are familiar with \LaTeX{}, go and explore the template and use it. Maybe start by filling your info in the \emph{THESIS/DOC INFORMATION} block of the \verb|Thesis.tex| or \verb|Progress.tex| file. You can modify this file to meet your unique specifications based on your degree/university. If you are new to \LaTeX{} then read about the file structure below.
\section{File Structure} \section{File Structure}
The \verb|Thesis.tex| file is composed of three main parts: \verb|frontmatter|, \verb|mainmatter| and \verb|backmatter| as in Figure~\ref{matter_arrangement} The \verb|Thesis.tex| file is composed of three main parts: \verb|frontmatter|, \verb|mainmatter| and \verb|backmatter| as in Figure~\ref{matter_arrangement}.
\begin{figure}[b]\caption{Separation of document content within thesis. Modified from \citet[p.~5]{latex_moril}. The symbol *
\begin{figure}[b]\caption{Document structure separating thesis content across sections and files. Modified from \citet[p.~5]{latex_moril}. The symbol *
indicates optional sections and $^\circ$ indicates sections that should indicates optional sections and $^\circ$ indicates sections that should
not be in the table of contents.}\label{matter_arrangement} not be in the table of contents.}\label{matter_arrangement}
\begin{elencopar}{frontmatter} \begin{elencopar}{frontmatter}
\item Title page$^\circ$% \item Title page$^\circ$%
\item Abstract*$^\circ$% \item Abstract*$^\circ$%
...@@ -66,12 +66,14 @@ not be in the table of contents.}\label{matter_arrangement} ...@@ -66,12 +66,14 @@ not be in the table of contents.}\label{matter_arrangement}
\item Index*% \item Index*%
\end{elencopar} \end{elencopar}
\end{figure} \end{figure}
It is advisable to write each chapter (and possibly section) in a separate file to It is advisable to write each chapter (and possibly section) in a separate file to
keep each file of a manageable size. keep each file of a manageable size.
They are included with an \verb|\include{Filename}| statement in the main file. They are included with an \verb|\include{Filename}| statement in the main file.
Also keep the Appendix and Listings files separate if possible. Also keep the Appendix and Listings files separate if possible.
The initial template contains a \verb|Defniitions.tex| file for abbreviations, custom symbols, shorthand symbols etc. and is included in the document preamble.
The main matter files are provided as a boilerplate in \verb|Introduction.tex|, \verb|Conclusion.tex| and \verb|AppendixA.tex|.
\section{Changes and additions} \section{Changes and additions}
\subsection{University Organizational information} \subsection{University Organizational information}
The template assumes that you are in the \groupname, \deptname, \facname{} at the The template assumes that you are in the \groupname, \deptname, \facname{} at the
...@@ -102,9 +104,10 @@ It is very easy to change the default font of the document. Fonts in \LaTeX{} co ...@@ -102,9 +104,10 @@ It is very easy to change the default font of the document. Fonts in \LaTeX{} co
\verb|\usepackage{fontname}| before your \verb|\begin{document}| directive. \verb|\usepackage{fontname}| before your \verb|\begin{document}| directive.
\subsection{Add a Glossary or Index} \subsection{Add a Glossary or Index}
\emph{Both Indexes and Glossaries involve an extra build step so you will need to read the manual before inserting these.} They should be put after a \verb|\cleartoeven| as is convention for indexes to start on the left. \emph{Both Indexes and Glossaries involve an extra build step so you will need to read the manual before inserting these.}
Some people may want to have an index or prefer Glossary instead of a list of symbols. Some people may want to have an index or prefer Glossary instead of a list of symbols.
The \href{http://anorien.csc.warwick.ac.uk/mirrors/CTAN/macros/latex/contrib/glossaries}{\texttt{glossaries}} package can be used. They should be put after a \verb|\cleartoeven|, as conventionally indexes start on the left.
The \href{https://ctan.org/pkg/glossaries}{\texttt{glossaries}} package can be used.
Inserting the \verb|\printglossaries| command will put the glossary where you want it. Inserting the \verb|\printglossaries| command will put the glossary where you want it.
The list of symbols command can be removed in this case. The list of symbols command can be removed in this case.
Inserting the \verb|\printindex| command will put the glossary where you want it. Inserting the \verb|\printindex| command will put the glossary where you want it.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment