diff --git a/York-Thesis/C-Begin/beg.tex b/York-Thesis/C-Begin/beg.tex index 6f9cd4c..f803e58 100644 --- a/York-Thesis/C-Begin/beg.tex +++ b/York-Thesis/C-Begin/beg.tex @@ -22,7 +22,7 @@ % % This work consists of all the files listed in the README.md, % and provides a copy of the original hosted on -% https://git.tigrau.ovh/Ambroise/LaTeX-Templates/York-Thesis. +% https://git.tigrau.ovh/Ambroise/LaTeX-Templates/. \documentclass[../main]{subfiles} %\myexternaldocument{main} % for overleaf to get the cross references @@ -33,4 +33,4 @@ This is the beginning of your work where you will refer to equation \eqref{eq:th \blindmathpaper -\end{document} \ No newline at end of file +\end{document} diff --git a/York-Thesis/C-End/end.tex b/York-Thesis/C-End/end.tex index ffdc990..5b32feb 100644 --- a/York-Thesis/C-End/end.tex +++ b/York-Thesis/C-End/end.tex @@ -22,7 +22,7 @@ % % This work consists of all the files listed in the README.md, % and provides a copy of the original hosted on -% https://git.tigrau.ovh/Ambroise/LaTeX-Templates/York-Thesis. +% https://git.tigrau.ovh/Ambroise/LaTeX-Templates/. \documentclass[../main]{subfiles} \begin{document} diff --git a/York-Thesis/main.pdf b/York-Thesis/main.pdf index 072d08f..127ac6a 100644 Binary files a/York-Thesis/main.pdf and b/York-Thesis/main.pdf differ diff --git a/York-Thesis/main.tex b/York-Thesis/main.tex index b9f0e94..00d5a7c 100644 --- a/York-Thesis/main.tex +++ b/York-Thesis/main.tex @@ -22,7 +22,7 @@ % % This work consists of all the files listed in the README.md, % and provides a copy of the original hosted on -% https://git.tigrau.ovh/Ambroise/LaTeX-Templates/York-Thesis. +% https://git.tigrau.ovh/Ambroise/LaTeX-Templates/. %%% ==== Begin file % FORMAT: Font size must be at least 11pt, 12pt is set as default @@ -49,29 +49,29 @@ % FORMAT: All pages should be numbered continuously. % Suppressing the numbering style and headers for the opening pages -\frontmatter* +\frontmatter* -%% Call the title page to be made. Use this instead of \titlepage to get the yorkthesis class format +%% Call the title page to be made. Use this instead of \titlepage to get the yorkthesis class format \makethesistitle %% Abstract of the thesis [required] \chapter{Abstract} -% TODO: +% TODO: \todo[noline]{Write the abstract.} % FORMAT: At most 300 words. \vspace*{-2em}\begin{quote} \centering \scshape \itshape The \texttt{Abstract} section is a requirement and should not be longer than 300 words. \end{quote}\todo[caption={Shorten the abstract}, size=footnotesize]{Keep it under the limit to prevent doing the same thing I'm doing reducing fonts} {\small -This document serves as an example of the look the \texttt{yorkthesis} class can provide while being at the same time a documentation for the code this document is built upon. -This whole project was prompted from the fact that the template provided by the department was very old and outdated, and didn't provide a ``good enough`` look. +This document serves as an example of the look the \texttt{yorkthesis} class can provide while being at the same time a documentation for the code this document is built upon. +This whole project was prompted from the fact that the template provided by the department was very old and outdated, and didn't provide a ``good enough`` look. For a thesis document, the usual \texttt{article} environment does not provide the chapter layout one would expect to structure such an important piece of work. -The class that is recommended is the \href{https://ctan.org/pkg/memoir}{\texttt{memoir}} class, but its documentation and setting can be a bit daunting at first glance due to its sheer volume (at the time of writing the documentation is $615$ pages long, and its implementation in \TeX consists of more than $37000$ lines of code). +The class that is recommended is the \href{https://ctan.org/pkg/memoir}{\texttt{memoir}} class, but its documentation and setting can be a bit daunting at first glance due to its sheer volume (at the time of writing the documentation is $615$ pages long, and its implementation in \TeX consists of more than $37000$ lines of code). For his thesis in 2020, Alessandro Pezzoni decided to write a class on top of the \texttt{memoir} one that would contain the structure required by the university while being also easier to use (you can find his initial implementation in his github project at \url{https://github.com/donbex/yorkthesis}). -He accepted to share this for others to use it, and I am really grateful for that. +He accepted to share this for others to use it, and I am really grateful for that. I decided to add two elements to his class implementation (the possibility of a subtitle and an easier handling of margins), but thought that a thorough example of a good folder structure for writing a thesis would benefit people. -On top of being hosted on the maths departmental moodle page, the up to date code can be downloaded on my personal Gitea repository (at \url{https://git.tigrau.ovh/Ambroise/LaTeX-Templates/York-Thesis}), where suggestions and requests can be made, and a copy of it can also be found as an Overleaf project (at \url{https://www.overleaf.com/read/mmprbwrdbgbx}). +On top of being hosted on the maths departmental moodle page, the up to date code can be downloaded on my personal Gitea repository (at \url{https://git.tigrau.ovh/Ambroise/LaTeX-Templates/src/branch/master/York-Thesis}), where suggestions and requests can be made, and a copy of it can also be found as an Overleaf project (at \url{https://www.overleaf.com/read/mmprbwrdbgbx}). I hope this will be useful to many others.}\todo[color=red!60, inline, size=footnotesize,caption={Warning for old \LaTeX\ versions}]{Warning: Some features might not work as intended if the installed \LaTeX\ version and its packages are not up to date} @@ -121,10 +121,10 @@ As for myself, I want to thank Alessandro for his template which makes the perfe \bigskip This section should include a text similar to: \begin{verbatim} - I declare that the work presented in this thesis, except where - otherwise stated, is based on my own research carried out at - the University of York and has not been submitted previously - for any degree at this or any other university. Sources are + I declare that the work presented in this thesis, except where + otherwise stated, is based on my own research carried out at + the University of York and has not been submitted previously + for any degree at this or any other university. Sources are acknowledged by explicit references. \end{verbatim} If you have submitted a paper (either already published or currently under review), this should be explicitly mentioned in this section with a reference to its bibliography entry. @@ -163,4 +163,4 @@ If you have submitted a paper (either already published or currently under revie % FORMAT: The index, if there is one, goes here. -\end{document} \ No newline at end of file +\end{document} diff --git a/York-Thesis/mypreamble.tex b/York-Thesis/mypreamble.tex index 94d1698..d5cb95a 100644 --- a/York-Thesis/mypreamble.tex +++ b/York-Thesis/mypreamble.tex @@ -20,7 +20,7 @@ % % This work consists of all the files listed in the README.md, % and provides a copy of the original hosted on -% https://git.tigrau.ovh/Ambroise/LaTeX-Templates/York-Thesis. +% https://git.tigrau.ovh/Ambroise/LaTeX-Templates/. %%% ===== Folder structure @@ -30,15 +30,15 @@ \externaldocument{\subfix{main}} % all refs available in subfiles by \ref{labelname} as usual %% NOTE: The following code make an additional paths search -%% search to simplify the calls to \subfile if you don't want -%% to bother with relative paths. If you uncomment it, add -%% the folders' name appropriately to the list with the {dir/} +%% search to simplify the calls to \subfile if you don't want +%% to bother with relative paths. If you uncomment it, add +%% the folders' name appropriately to the list with the {dir/} %% syntax (brackets and trailing slash). %% WARNING: This slows down compilation time A LOT!!! \makeatletter \def\input@path{ % - {../Bibfiles/}{C-Begin/}{C-Middle/}{C-End/} % list of folders - } + {../Bibfiles/}{C-Begin/}{C-Middle/}{C-End/} % list of folders + } \makeatother @@ -68,11 +68,11 @@ %%% ===== List of recommended packages you need to include \usepackage{amsmath, amsthm} \usepackage{amssymb, amsfonts} -\usepackage[final]{hyperref} % links with final option to force them to appear even in draft mode +\usepackage[final]{hyperref} % links with final option to force them to appear even in draft mode \usepackage{xspace} % for automatic spaces after text commands \usepackage{xcolor} % to use colours in different parts -% NOTE: Package for the todo notes. Notice that it uses multiple packages such as -% ifthen, xkeyval, xcolor, tikz (w/ graphicx) and calc, and thus they need +% NOTE: Package for the todo notes. Notice that it uses multiple packages such as +% ifthen, xkeyval, xcolor, tikz (w/ graphicx) and calc, and thus they need % to be called before todonotes if specific options are wanted \usepackage[obeyDraft, textsize=small, colorinlistoftodos]{todonotes} @@ -105,7 +105,7 @@ \theoremstyle{plain} % the style for theorem, propositions and lemmas % Counter used to make it continuous numbering with subsubsection value appended \newtheorem{thm}[subsubsection]{Theorem} % name shortcut for Theorem & counter check -\newtheorem{prop}[subsubsection]{Proposition} % idem for rest... +\newtheorem{prop}[subsubsection]{Proposition} % idem for rest... \newtheorem{lem}[subsubsection]{Lemma} \newtheorem{cor}[subsubsection]{Corollary} \newtheorem{conj}[subsubsection]{Conjecture} @@ -126,4 +126,4 @@ %%% ===== List of your own macros here -\newcommand{\AG}{\ensuremath{\mathscr{A\hspace*{-3pt}{G}}}\xspace} \ No newline at end of file +\newcommand{\AG}{\ensuremath{\mathscr{A\hspace*{-3pt}{G}}}\xspace} diff --git a/York-Thesis/thesisoptions.sty b/York-Thesis/thesisoptions.sty index 8cb6ead..74908e9 100644 --- a/York-Thesis/thesisoptions.sty +++ b/York-Thesis/thesisoptions.sty @@ -20,7 +20,7 @@ % % This work consists of all the files listed in the README.md, % and provides a copy of the original hosted on -% https://git.tigrau.ovh/Ambroise/LaTeX-Templates/York-Thesis. +% https://git.tigrau.ovh/Ambroise/LaTeX-Templates/. \ProvidesPackage{thesisoptions}[2022/07/08 v1.0 Options for the York Thesis class] @@ -35,22 +35,22 @@ %%% ==== Margins % Margins of the document can be set using some helper macros defined in the class file. % The block size of the document will adjust relatively to the values of the margin defined. -% Horizontal margins are set relatively to the spine edge of the page, while vertical ones -% are relatively to the upper edge. +% Horizontal margins are set relatively to the spine edge of the page, while vertical ones +% are relatively to the upper edge. % Defaults: The defaults margins are 3cm on spine and foredge and 4cm on upper and lower edges. -% Commands: The available commands are the following: -% \horizontalmarginsvalue, \horizontalmarginsratio, \verticalmarginsvalue and -% \verticalmarginsratio which all takes one required parameter and one optional. It -% is expected that at most one of the horizontal commands and at most one of the -% vertical commands is called (see limitations below). +% Commands: The available commands are the following: +% \horizontalmarginsvalue, \horizontalmarginsratio, \verticalmarginsvalue and +% \verticalmarginsratio which all takes one required parameter and one optional. It +% is expected that at most one of the horizontal commands and at most one of the +% vertical commands is called (see limitations below). % Arguments: For the \horizontal* commands the required one is the spine margin with its unit, -% and the upper edge margin with its unit for the \vertical* commands. +% and the upper edge margin with its unit for the \vertical* commands. % For the \*marginsvalue commands the optional argument is the opposite edge margin -% value with its unit (with default the same value as the required argument), and for -% the \*marginsratio it corresponds to a ratio between the margin set for the reference -% and the margin obtained for the opposite side (with default value 1, meaning that +% value with its unit (with default the same value as the required argument), and for +% the \*marginsratio it corresponds to a ratio between the margin set for the reference +% and the margin obtained for the opposite side (with default value 1, meaning that % margin values will be the same), under the rule: oppside = ratio * refside. -% Limitations: Since the horizontal ratio cannot be set if the margins on both the spine and the +% Limitations: Since the horizontal ratio cannot be set if the margins on both the spine and the % foredge sides are set, this ratio is discarded. This means that calling both the % \horizontalmarginsvalue and \horizontalmarginsratio commands will set the spine margin % to the value set by the last of the two commands called, and the foredge margin will @@ -66,25 +66,25 @@ %%% ==== Styling chapters/sections % See the manual of the `memoir` class for more predefined styles: -% - Appendix B for chapter styles (or for more examples consult +% - Appendix B for chapter styles (or for more examples consult % https://ctan.uib.no/info/latex-samples/MemoirChapStyles/MemoirChapStyles.pdf); % - Section 6.9 for lower level heading styles. % To learn how to define your own, see Chapter 6. -% The order of call between \headstyles and \chapterstyle is important since -% the chapter header is defined in both of these, but the former defines +% The order of call between \headstyles and \chapterstyle is important since +% the chapter header is defined in both of these, but the former defines % the other sections style headers, so calling \headstyle second would % override the parameters of \chapterstyle. -% As a baseline choice, I use dowding for the [sub]sections headers (defined +% As a baseline choice, I use dowding for the [sub]sections headers (defined % in memoir.dtx in `\makeheadstyles{dowding}`) and then I set the chapter style to % dash (defined in `\makechapterstyle{dash}`) \headstyles{dowding} -\chapterstyle{dash} +\chapterstyle{dash} % Personal styling choice, modifying the look and placement of section headers % (using the definitions in file for the base code but suppressing \centering % to manually set the indentation) -\setsecheadstyle{\normalfont\large\MakeTextUppercase} % large CAPS +\setsecheadstyle{\normalfont\large\MakeTextUppercase} % large CAPS \setsubsecheadstyle{\normalfont\scshape} % small caps \setsubsecindent{1em} \setsubsubsecheadstyle{\normalfont\normalsize\itshape} % italicised for subsubsection @@ -117,4 +117,4 @@ %%%% ==== DEBUG % If you want the version of the packages you use appear when they load in the log file, uncomment the following line: -\listfiles \ No newline at end of file +\listfiles diff --git a/York-Thesis/yorkthesis.cls b/York-Thesis/yorkthesis.cls index 2d263b8..1efa54b 100644 --- a/York-Thesis/yorkthesis.cls +++ b/York-Thesis/yorkthesis.cls @@ -24,7 +24,7 @@ % % This work consists of all the files listed in the README.md, % and provides a copy of the original hosted on -% https://git.tigrau.ovh/Ambroise/LaTeX-Templates/York-Thesis. +% https://git.tigrau.ovh/Ambroise/LaTeX-Templates/. % Comments starting with FORMAT highlight requirements from the UoY thesis @@ -59,14 +59,14 @@ % FORMAT: Use 1.5 line spacing. \OnehalfSpacing -% FORMAT: GRS states as a recommendation that: +% FORMAT: GRS states as a recommendation that: % spine margin should be at least 40mm, % other margins should be at least 15mm. % In effect, their view is the following: % "We would recommend that they stick with the guidance re. margin on binding edge merely because we still get examiners who prefer to make themselves a physical copy to mark up, rather than using the digital annotation." -% I have taken the stand to set the default value to 3cm on both sizes horizontally, +% I have taken the stand to set the default value to 3cm on both sizes horizontally, % while putting 4cm vertically. The implementation below prevents the use of setting -% the blocksize and then letting the margins be defined by a value relatively to that +% the blocksize and then letting the margins be defined by a value relatively to that % blocksize. If you want to use these instead, you need to delete the macros below. % DOC: Check memoir package sec2.4.2 p.17-21 \newcommand{\horizontalmarginsvalue}[2][*]{\def\margin@spine{#2} \def\margin@foredge{#1}}