-
Notifications
You must be signed in to change notification settings - Fork 0
/
lincolncsthesis.cls
589 lines (432 loc) Β· 13.8 KB
/
lincolncsthesis.cls
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
%%
%% lincolncsthesis.cls
%% Copyright 2019 Benjamin Williams <[email protected]>
%%
%% A LaTeX template for typesetting research degree theses
%% according to the University of Lincoln School of Computer Science
%% thesis guidelines.
%%
%% It is worth noting that the main inspiration (and small snippets of code)
%% for this template was Cameron Gray's bangorcsthesis template.
%%
%% -----------------------------------------
%%
%% This work may be distributed and/or modified under the
%% conditions of the LaTeX Project Public License, either version 1.3
%% of this license of (at your option) any later version.
%% The latest version of this license is in
%% http://www.latex-project.org/lppl.txt
%% and version 1.3 or later is part of all distributions of LaTeX
%% version 2005/12/01 or later.
%%
% We're gonna be defining variables as long globals
% (because they might wanna split these up with extra lines)
\def\lxdef{\long\xdef}
% This class name
\def\@classname {lincolncsthesis}
% METADATA AND OPTIONS
% --------------------
% Define thesis template version and other metadata
\gdef\@templateVersion{1.0.3}
\gdef\@templateDate{2019/10/03}
\gdef\@templateAuthor{Benjamin Williams}
% It provides this class
\ProvidesClass{\@classname}[\@templateDate \@templateVersion \@templateAuthor]
% We need LaTeX2e at least
\NeedsTeXFormat{LaTeX2e}
% Article class
\LoadClass[12pt]{report}
% PACKAGES
% --------
% Packages
\RequirePackage{amsmath}
% --
\RequirePackage{ifthen}
\RequirePackage{xkeyval}
\RequirePackage[dvipsnames]{xcolor}
\RequirePackage[T1]{fontenc} % font types and character verification
\RequirePackage[UKenglish]{babel}
\RequirePackage[UKenglish]{isodate}
\RequirePackage[utf8]{inputenc}
\RequirePackage{xparse}
\RequirePackage{graphicx}
\RequirePackage{longtable}
\RequirePackage{blindtext}
\RequirePackage{parskip}
\RequirePackage{setspace}
\RequirePackage{geometry}
\RequirePackage{layout}
\RequirePackage{courier}
\RequirePackage{subcaption}
\RequirePackage{url}
\RequirePackage{hyperref}
\RequirePackage[table,figure]{totalcount}
\RequirePackage{appendix}
% -----------------
\RequirePackage{csquotes}
\RequirePackage{titlesec}
\RequirePackage{datetime2}
\RequirePackage{fancyhdr}
\RequirePackage{lmodern}
% FANCY DATE STUFF
% -----------------
\newcommand{\monthyeardate}{%
\DTMenglishmonthname{\@dtm@month} \@dtm@year
}
\newcommand{\yeardate}{%
\@dtm@year
}
% Another handy macro to test if there's an option
\def\ifClassOption [#1]#2 {
\@ifclasswith{\@classname}{#1}{#2}{\empty}
}
% Another handy macro to test if there's an option + else
\def\ifClassOptionElse [#1]#2#3 {
\@ifclasswith{\@classname}{#1}{#2}{#3}
}
% THESIS TEMPLATE VARIABLES
% -------------------------
% Define variables relevant to this thesis
\lxdef \@logo {logo}
\newcommand{\thesisLogoPath}[1]{\xdef\@logo{#1}}
\lxdef \@date {\monthyeardate}
\newcommand{\thesisSubmissionDate}[1]{\xdef\@date{#1}}
\lxdef \@degree {Doctor of Philosophy}
\newcommand{\thesisDegree}[1]{\xdef\@degree{#1}}
\lxdef \@programme {Biochemistry}
\newcommand{\thesisProgramme}[1]{\xdef\@programme{#1}}
\lxdef \@schoolname {Department of Biochemistry}
\newcommand{\thesisSchool}[1]{\xdef\@schoolname{#1}}
\lxdef \@collegename {School of Biomedical Sciences}
\newcommand{\thesisCollege}[1]{\xdef\@collegename{#1}}
\lxdef \@universityname {University of Otago}
\newcommand{\thesisUniversity}[1]{\xdef\@universityname{#1}}
% -----
\newcommand{\thesisSupervisor}[1]{\xdef\@supervisor{#1}}
\newcommand{\thesisSecondSupervisor}[1]{\xdef\@secondsupervisor{#1}}
\newcommand{\thesisThirdSupervisor}[1]{\xdef\@thirdsupervisor{#1}}
% % -----
% \newcommand{\thesisStudentNumber}[1]{\xdef\@studentnumber{#1}}
% \newcommand{\thesisModuleCode}[1]{\xdef\@modulecode{#1}}
% \newcommand{\thesisAssessment}[1]{\xdef\@modulename{#1}}
% \newcommand{\thesisSubmissionText}[1]{\newcommand{\@submissiontext}{#1}}
%\newcommand{\includeUndergraduateHeaders}{}
%\newcommand{\includeUndergraduateHeaders}{\xdef\@includeheaders{
%\fancyhead[R]{\textit{\footnotesize \@modulecode~\@modulename}}
%\fancyfoot[L]{\footnotesize \@author \hspace{0.5cm} \@studentnumber}
%}}
% START OF THESIS
% --------------
\fancypagestyle{plain}{
\renewcommand{\headrulewidth}{0pt}%
\fancyhf{}%
\fancyfoot[R]{\footnotesize\textbf{\thepage}}%
}
\fancypagestyle{mainStyle}{
\renewcommand{\headrulewidth}{0pt}%
\fancyhf{}%
\fancyfoot[R]{\footnotesize\emph{\leftmark} \hspace{0.25cm} \footnotesize\textbf{\thepage}}%
%\fancyhead[L]{\@author \@ifundefined{}{\\ \@studentnumber}}
\@ifundefined{@includeheaders}{
}{
\fancyhead[R]{\textit{\footnotesize \@modulecode~\@modulename}}
\fancyfoot[L]{\footnotesize \@author \hspace{0.5cm} \@studentnumber}
}
%\fancyhead[R]{hello this is right}
}
\newcommand{\thesisBodyStart}{
% Clear the page so we don't number the last page
\cleardoublepage
% Set page numbering back to 1, 2, 3 ..
\pagenumbering{arabic}
}
% TABLE OF CONTENTS, FIGURES AND TABLES
% ---------------------------
\newcommand{\thesisTOF}{
\iftotalfigures
\cleardoublepage
\listoffigures
\fi
}
\newcommand{\thesisTOT}{
\iftotaltables
\cleardoublepage
\listoftables
\fi
}
\newcommand{\thesisTables}{
\cleardoublepage
\renewcommand{\contentsname}{Table of Contents}
\setcounter{tocdepth}{3}
{\setstretch{1.25}
\tableofcontents
\thesisTOF
\thesisTOT
}
\setlength{\abovedisplayskip}{1pt}
\setlength{\belowdisplayskip}{15pt}
}
% ABSTRACT
% -------------------------
\renewenvironment{abstract}
{\cleardoublepage
\chapter*{\abstractname}
}
{}
% ACKNOWLEDGEMENTS
% ----------------
\newenvironment{acknowledgements}
{\cleardoublepage
\chapter*{Acknowledgements}
}
{}
% AFTER TITLE PAGE BUT BEFORE THESIS CONTENT
% ------------------------------------------
\newcommand{\afterTitlePage}{
% Set margins for the rest of the thesis. UoL guidelines
% state that: [left >= 40mm], [others >= 15mm]
\newgeometry{
nohead,
top=15mm,
bottom=25mm,
right=25mm,
left=40mm,
marginparwidth=0cm,
marginparsep=0cm
}
% Set spacing and reset numbering
\pagenumbering{roman}
% Set double spacing (from cleanthesis.sty)
\setstretch{1.5}
\clubpenalty = 10000
\widowpenalty = 10000
\displaywidowpenalty = 10000
}
% TITLE PAGE
% -------------
% Print out submission text
\newcommand{\submissionStatement}{
\setstretch{1.25}
% \@ifundefined{@submissiontext}{Submitted for the degree of \@degree \\ in \@programme}{\@submissiontext}
\@ifundefined{@submissiontext}{a thesis submitted for the degree of \\ \textbf{Doctor of Philosophy} \\ at the University of Otago, Dunedin,\\New Zealand}
}
% Print out supervisors
\newcommand{\printSupervisor}{
%{\footnotesize \textit{Supervisor}~\@supervisor }
%\@ifundefined{@secondsupervisor}{}
%{\footnotesize \textit{Second Supervisor}~\@secondsupervisor }
\footnotesize\begin{tabular}{rl}
\@ifundefined{@supervisor}{}
{\textit{Supervisor} & \@supervisor \\}
\@ifundefined{@secondsupervisor}{}
{\textit{Second Supervisor} & \@secondsupervisor \\}
\@ifundefined{@thirdsupervisor}{}
{\textit{Third Supervisor} & \@thirdsupervisor }
\end{tabular}
}
% The default title page: title, then logo, then author
\newcommand{\@titlepage}{
\begin{titlepage}
% Make the title
\makeatletter
\centering{\LARGE \@title \par} \vspace{1.5cm}
% Make the logo
\includegraphics[height=1.5in]{\@logo}\par
% Some space, then the author, then the school and university
% name
\vspace{1.5cm}
{\large \@author \@ifundefined{@studentnumber}{}{\\ \@studentnumber} \par}\vspace{0.45cm}
% {\footnotesize \@schoolname \\ \vspace{0.25cm} \@collegename \\ \vspace{0.25cm} \@universityname \par}
% Some space and the submission statement
\vspace{3cm}
{\footnotesize \submissionStatement \par}
% Print out the supervisor
\vspace{1cm}
\printSupervisor
% Then the fancy date!
\vspace{1cm}
{\footnotesize \@ifundefined{@modulecode}{}{\@modulecode \\} \@date \par}
\end{titlepage}
}
% The alternate title page: logo, then title, then author
\def \@altTitlePage {
\begin{titlepage}
% Make the logo
\makeatletter
\centering\includegraphics[height=1.5in]{\@logo}\par
% Make the title
\vspace{2cm}
{\LARGE \@title\par}
% Some space, then the author, then the school and university
% name
\vspace{1.5cm}
{\large \@author \par}\vspace{0.45cm}
{\footnotesize \@schoolname \\ \vspace{0.25cm} \@collegename \\ \vspace{0.25cm} \@universityname \par}
% Some space and the submission statement
\vspace{2.5cm}
{\footnotesize \submissionStatement \par}
% Print out the supervisor
\vspace{1cm}
\printSupervisor
% Then the fancy date!
\vspace{1cm}
{\footnotesize \@date \par}
\end{titlepage}
}
\newcommand{\beforeTitlePage}{
% Set margins for the rest of the thesis. UoL guidelines
% state that: [left >= 40mm], [others > 15mm]
\newgeometry{
nohead,
top=40mm,
bottom=25mm,
right=30mm,
left=40mm,
marginparwidth=0cm,
marginparsep=0cm
}
}
% The default title page style is the title, logo, author style
\def \@defaultTitlePage {\@titlepage}
% Lets renew the make title command so we don't have to
% make a custom one
\RenewDocumentCommand{\maketitle}{o}{%
% Call function for before title page
\beforeTitlePage
% Then check which title page style to use
\IfNoValueTF{#1}
{\@defaultTitlePage}
{\ifthenelse{\equal{#1}{logo-first}}
{\@altTitlePage}
{\@defaultTitlePage}}
% Call function for after title page
\afterTitlePage
}
% TITLE / CHAPTERS / FIGURES / TITLESEC SPACING
% ---------------------------------------------
% Set the chapter title style
\titleformat{\chapter}[display]
{\normalfont\huge\bfseries}{\chaptertitlename\ \thechapter}{0pt}{\Huge}
% And space it out a bit
\titlespacing*{\chapter} {0pt}{0pt}{20mm}
% A fake chapter title command to emulate chapter titles
% without actually adding a chapter
\newcommand{\chapterTitle}[1]{
\vspace*{-20mm}
{\normalfont\huge\bfseries#1 \par}
\vspace*{20mm}
}
% Increase the depth of subsection
%\setcounter{secnumdepth}{4}
%\titleformat{\paragraph}
%{\normalfont\normalsize\bfseries}{\theparagraph}{1em}{}
%\titlespacing*{\paragraph}
%{0pt}{3.25ex plus 1ex minus .2ex}{1.5ex plus .2ex}
% REFERENCING
% -----------
% Fake harvard referencing, instead of using natbib -- because
% natbib makes biblatex blow up.
\def\@importHarvard {
\RequirePackage[
defernumbers=true,
backend=biber,
bibencoding=utf8,
natbib=true,
hyperref=true,
backref=true,
urldate=long,
style=authoryear,
citestyle=authoryear,
sorting=nyt
]{biblatex}
}
% Otherwise use ieee's style and numeric citation
\def\@importBibLaTeX {
\RequirePackage[
defernumbers=true,
backend=biber,
bibencoding=utf8,
natbib=true,
hyperref=true,
backref=true,
urldate=long,
style=ieee,
citestyle=numeric,
sorting=nyt
]{biblatex}
}
% Import harvard if [harvard] is specified, otherwise
% standard biblatex!
\ifClassOptionElse[harvard]{\@importHarvard}{\@importBibLaTeX}
% Command for printing out references list
\newcommand{\printReferences}[1][References]{
% Set some spacing up between the items
\setlength\bibitemsep{0.35cm}
% Set the line height (of actual items) to 1.0
\setstretch{1.0}
% Print out the bibliography with the given title
\printbibliography[notkeyword={game}, title=#1]
}
% LUDOGRAPHY
% ----------
% Citation environment for games
\defbibenvironment{games}
{\list
{}
{\setlength{\leftmargin}{\bibhang}%
\setlength{\itemindent}{-\leftmargin}%
\setlength{\itemsep}{\bibitemsep}%
\setlength{\parsep}{\bibparsep}}}
{\endlist}
{\item}
% Prints out the ludography (all citations with the
% key "game")
\newcommand{\printLudography}[1][Ludography]{
% Set some spacing up between the items
\setlength\bibitemsep{0.35cm}
% Set the line height (of actual items) to 1.0
\setstretch{1.0}
% Print out the bibliography with the given title
\printbibliography[env=games, keyword={game}, title=#1]
}
% Prints out the ludography without a heading
\newcommand{\printLudographyNoHead}{
% Set some spacing up between the items
\setlength\bibitemsep{0.35cm}
% Set the line height (of actual items) to 1.0
\setstretch{1.0}
% Print out the bibliography with the given title
\printbibliography[heading=none, env=games, keyword={game}]
}
% Ludography environment, if you wish to put some text before
% the list of games that are printed
%\newenvironment{ludography}[1][Ludography]{
% \chapter*{#1}
%}{\vspace*{1cm} \printLudographyNoHead}
% For citing games
%\newcommand{\citeGame}[1]{
% \emph{\citeauthor{#1}}
%}
% BLANK PAGE / QUOTE PAGE
% -----------------------
% For quote pages, copyright notices, or whatever else
\newenvironment{blankpage}[1][\unskip]{%
% Check if [c] is specified, if so, then
% make it vertically align.. if not, then
% just clear a double page and write some stuff
\ifthenelse{\equal{#1}{c}}{
\cleardoublepage
\topskip0pt
\vspace*{\fill}
}{
\cleardoublepage
\topskip0pt
\vspace*{1in}
}
}{
\vspace*{\fill}
}
% Set the page style to the main style. Set up the chapter
% mark style so that it shows the title of the chapter only.
\pagestyle{mainStyle}
\renewcommand{\chaptermark}[1]{\markboth{{#1}}{}}