Fix bugs in template with numbering title and ToC colouring

ecsdocs.dtx

@@ -8,13 +8,14 @@
 % class files ecsthesis.cls, ecsminithesis.cls, ecsprogress.cls, ecsproject.cls, ecsreport.cls, ecsgdp.cls, ecsgdpsummary.cls and ecsarticle.cls.
 % \fi
 %
-% \CheckSum{1773}
+
+% \CheckSum{1871}
 %
 % \iffalse
 % Copyright (C) 2001 by Steve R. Gunn
 % Later Modifications 2018 by Edward Longman
 %    \begin{macrocode}
-%<thesis|minithesis|progress|project|article|report|gdp|gdpsummary>\NeedsTeXFormat{LaTeX2e}[1996/12/01]
+%<thesis|minithesis|progress|project|article|report|gdp|gdpsummary>\NeedsTeXFormat{LaTeX2e}[2007/02/26]
 %    \end{macrocode}
 %
 %    Announce the document class and its version.
@@ -79,7 +80,12 @@
 %   Of Southampton.
 %
 %   The basic settings for University, Faculty and School can be changed near
-%   line 550 of the generator .dtx file.
+%   line 600 of the generator .dtx file.
+%
+%   If a user only wishes to change the file for their thesis it is probably
+%   easier to navigate to the class file labeled ecsthesis and change the
+%   department and faculty naming there. This will be located in the
+%   subdirectory where you unzipped the files under tex/latex/ecsdocs/
 %
 % TODO: Check the line number.
 % \section{Description}
@@ -129,6 +135,8 @@
 %
 % \section{Implementation}
 %
+% The checksum is to determine if there has been a truncation in the file during transmission over a network
+%
 %    All options are passed on to the \texttt{book} or \texttt{article} class.
 %
 %    \begin{macrocode}
@@ -137,6 +145,10 @@
 %
 % \begin{macro}{\baseclass}
 %    \begin{macrocode}
+%% ------------ Class/Formating Adjustment ----------------------
+%% Adjust the book class to match the requirements
+%% Set spacing, line and paragraph options
+%% Set LaTeX builder options (work break penalties etc.)
 %<*thesis|minithesis|progress|project|report|gdp|gdpsummary>
 \def\baseclass{book}
 %</thesis|minithesis|progress|project|report|gdp|gdpsummary>
@@ -347,6 +359,8 @@
 %    setup the theorem environments.
 %
 %    \begin{macrocode}
+%% -------------------- Figure/Table/Eq/Listing Stying --------------------
+%% Set the styling for non text elements of the document
 \usepackage{amsmath,amsfonts,amssymb,amscd,amsthm,xspace}
 \theoremstyle{plain}
 %<*thesis|minithesis|progress|project|report|gdp>
@@ -521,6 +535,9 @@
 %    style for other parts of the University.
 %
 %    \begin{macrocode}
+%% --------------------- Organisational Structure ----------------------
+%% This should be changed in the ecsdocs.dtx file and then all the files
+%% should be recompilled with the new details.
 \newcommand*{\supervisor}[1]{\def\supname{#1}}
 \newcommand*{\examiner}[1]{\def\examname{#1}}
 \newcommand*{\degree}[1]{\def\degreename{#1}}
@@ -574,6 +591,9 @@
 %    to defaults appropriate to the Department of Electronics and Computer Science.
 %
 %    \begin{macrocode}
+%% --------------------- Organisational Structure ----------------------
+%% This should be changed in the ecsdocs.dtx file and then all the files
+%% should be recompilled with the new details. TODO: Fix capitalisation of URL
 \supervisor  {}
 \examiner    {}
 \degree      {}
@@ -581,27 +601,19 @@
 \university  {\texorpdfstring{\href{http://www.soton.ac.uk}
                 {University of Southampton}}
                 {University of Southampton}}
-\UNIVERSITY  {\texorpdfstring{\href{http://www.soton.ac.uk}
-                {UNIVERSITY OF SOUTHAMPTON}}
-                {UNIVERSITY OF SOUTHAMPTON}}
+\UNIVERSITY  {\MakeUppercase{\univname}}
 \department  {\texorpdfstring{\href{http://www.ecs.soton.ac.uk}
                 {School of Electronics and Computer Science}}
                 {School of Electronics and Computer Science}}
-\DEPARTMENT  {\texorpdfstring{\href{http://www.ecs.soton.ac.uk}
-                {SCHOOL OF ELECTRONICS AND COMPUTER SCIENCE}}
-                {SCHOOL OF ELECTRONICS AND COMPUTER SCIENCE}}
-\group       {\texorpdfstring{\href{http://www.isis.ecs.soton.ac.uk}
-                {Image, Speech and Intelligent Systems Group}}
-                {Image, Speech and Intelligent Systems Group}}
-\GROUP       {\texorpdfstring{\href{http://www.isis.ecs.soton.ac.uk}
-                {IMAGE, SPEECH AND INTELLIGENT SYSTEMS GROUP}}
-                {IMAGE, SPEECH AND INTELLIGENT SYSTEMS GROUP}}
-\faculty     {\texorpdfstring{\href{http://www.engineering.soton.ac.uk}
-                {Faculty of Engineering, Science and Mathematics}}
-                {Faculty of Engineering, Science and Mathematics}}
-\FACULTY     {\texorpdfstring{\href{http://www.engineering.soton.ac.uk}
-                {FACULTY OF ENGINEERING, SCIENCE AND MATHEMATICS}}
-                {FACULTY OF ENGINEERING, SCIENCE AND MATHEMATICS}}
+\DEPARTMENT  {\MakeUppercase{\deptname}}
+\group       {\texorpdfstring{\href{http://cps.ecs.soton.ac.uk}
+                {Cyber Physical Systems Group}}
+                {Cyber Physical Systems Group}}
+\GROUP       {\MakeUppercase{\groupname}}
+\faculty     {\texorpdfstring{\href{http://www.feps.soton.ac.uk}
+                {Faculty of Engineering and Physical Science}}
+                {Faculty of Engineering and Physical Science}}
+\FACULTY     {\MakeUppercase{\facname}}
 \addresses   {}
 \subject     {}
 \keywords    {}
@@ -631,6 +643,10 @@
 %    Setup an appropriate title page and pdf strings if we are using
 %    pdf\LaTeX.
 %
+%    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>}
 \renewcommand\maketitle{
@@ -728,7 +744,6 @@
   \global\let\@thanks\@empty
   \global\let\@author\@empty
   \global\let\@date\@empty
-  \global\let\@title\@empty
   \global\let\title\relax
   \global\let\author\relax
   \global\let\date\relax
@@ -786,7 +801,6 @@
     \global\let\@thanks\@empty
     \global\let\@author\@empty
     \global\let\@date\@empty
-    \global\let\@title\@empty
     \global\let\title\relax
     \global\let\author\relax
     \global\let\date\relax
@@ -832,7 +846,6 @@
     \global\let\@thanks\@empty
     \global\let\@author\@empty
     \global\let\@date\@empty
-    \global\let\@title\@empty
     \global\let\title\relax
     \global\let\author\relax
     \global\let\date\relax
@@ -1007,6 +1020,7 @@
 %
 %    \begin{macrocode}
 \renewcommand\tableofcontents{
+\hypersetup{linkcolor={black}}
 \btypeout{Table of Contents}
 \begin{spacing}{1}{
     \setlength{\parskip}{1pt}
@@ -1144,8 +1158,12 @@
 %
 % This Authorship macro takes one argument for the case of People
 % who have published part of their thesis already (perhaps in a paper).
+%
+% xifthen else package used for the ifempty command
+%
 %    \begin{macrocode}
 %<*thesis|minithesis|progress|report|article>
+\usepackage{xifthen}
 \newcommand\authorshipdeclaration[1]{
 \btypeout{Declaration of Authorship}
 \addtotoc{Declaration of Authorship}
@@ -1380,13 +1398,12 @@ Author (Year of Submission) "Full thesis title", University of Southampton, name
 \input{Definitions}            % Include your abbreviations
 %% ----------------------------------------------------------------
 \begin{document}
-\frontmatter
 %<*testthesis>
 %% TODO: Check that the page numbering isn't destroyed
 \pagenumbering{gobble} % removes page number
 \copyrightDeclaration{} % !!! Comment this line when printing the hardcopy !!!
-\pagenumbering{arabic} % restores page number
 %</testthesis>
+\frontmatter
 \title      {An Investigation into \dots}
 \authors    {\texorpdfstring
              {\href{mailto:S.R.Gunn@ecs.soton.ac.uk}{Steve R. Gunn}}