Fix many small mistakes in the documentation

source/latex/uosdocs/uosdocs.dtx

@@ -63,14 +63,14 @@
 % \maketitle
 % \section{Quickstart}
 %   This guide assumes you have installed MiKTeX or TeX live distributions.
-%   It also requires having the program "make" for producing the templates again.
+%   It also requires having the program ``make'' for producing the templates again.
 %
 %   The folder labelled tex-mf should be installed in your local tex files
 %   source or whatever your tex distro uses.
 %
 %   The Templates have been built for the Deparment of Electronics and Computer
 %   Science in the Faculty of Engineering and Physical Science at the University
-%   Of Southampton.
+%   of Southampton.
 %
 %   The basic settings for University, Faculty and School are explained in Section~\ref{IntNames}
 %
@@ -432,7 +432,7 @@
 % \begin{macro}{\sref}
 % \begin{macro}{\aref}
 %
-%   Load the \texttt{caption2} package to improve formatting of captions,
+%   Load the \texttt{caption} package to improve formatting of captions,
 %   and provide short referencing commands.
 %
 %    \begin{macrocode}
@@ -684,12 +684,13 @@
 %    Setup an appropriate title page and pdf strings if we are using
 %    pdf\LaTeX.
 %
-%    The %\global\let\@title\@empty has been removed
+%    The %\\global\\let\\@title\\@empty has been removed
 %
 %    Possibly the relax statement also needs to be removed
 %
 %   \begin{macrocode}
 %<*thesis|minithesis|progress|project|report|gdp|gdpsummary>}
+%    Start by Adding meta data to the produced document
 \usepackage{titling}
 \AtBeginDocument{
   \hypersetup{pdftitle={\thetitle}}
@@ -697,6 +698,7 @@
   \hypersetup{pdfauthor={\authornames}}
   \hypersetup{pdfkeywords={\keywordnames}}
 }
+%    Define the title page layout
 \renewcommand\maketitle{
   \btypeout{Title Page}
   \thispagestyle{empty}
@@ -1047,10 +1049,11 @@
 %
 % \subsubsection{Add to Table of Contents}
 %
+% \begin{macro}{\addtotoc}
 %    Ensures numbering for sub-subsections in the table of contents, and provide
 %    for 6 levels to appear in toc. Define \texttt{addtotoc} to enable adding
 %    elements to the toc at chapter level, using a dummy counter to fix bookmarks
-%    in pdf\LaTeX.
+%    in pdf\LaTeX{}.
 %
 %    \begin{macrocode}
 %<*thesis|minithesis|progress|project|report|gdp|article>
@@ -1066,7 +1069,7 @@
 \addcontentsline{toc}{section}{#1}}
 %</article>
 %    \end{macrocode}
-%
+% \end{\macro}
 % \subsubsection{Table of Contents}
 %
 % \begin{macro}{\tableofcontents}
@@ -1170,6 +1173,7 @@
 %
 % \subsection{List of Symbols}
 %
+% \begin{macro}{\listsymbolname}
 % \begin{macro}{\listofsymbols}
 %
 %    Provide a \texttt{listofsymbols} command to produce a list of symbols,
@@ -1202,12 +1206,16 @@
 %    \end{macrocode}
 %
 % \end{macro}
+% \end{macro}
 %
 % \subsection{Declaration of Authorship}
 % \begin{macro}{\authorshipdeclaration}
-% Taken from Modified Template by Lovell TODO: Complete reference
+% Taken from Modified Template by Lovell \ref{references}
+%
 % TODO: Consider a separate dissertation class for non techinical?
+%
 % TODO: Provide extra argument for putting the date into the Declaration
+%
 % TODO: make slightly different declarations for theses and projects
 %
 % This Authorship macro takes one argument for the case of People
@@ -1261,7 +1269,7 @@ I confirm that:
 % \subsection{Copyright Statement}
 % \begin{macro}{\copyrightDeclaration}
 %
-%    This standard Copyright statement is to be included for a theis submission
+%    This standard Copyright statement is to be included for a thesis submission
 %    to University of Southampton Digital Repository
 %
 %    \begin{macrocode}
@@ -1853,7 +1861,7 @@ showpage
 %</definitions>
 %    \end{macrocode}
 %
-% \subsection{References File}
+% \subsection{References File}\label{references}
 %
 %    \begin{macrocode}
 %<*references>