Ignore:
File:
1 edited

Legend:

Unmodified
Added
Removed

  • doc/theses/andrew_beach_MMath/uw-ethesis.tex

    r7eb6eb5 r1c1c180  
    11%======================================================================
    2 % University of Waterloo Thesis Template for LaTeX 
    3 % Last Updated November, 2020 
    4 % by Stephen Carr, IST Client Services, 
     2% University of Waterloo Thesis Template for LaTeX
     3% Last Updated November, 2020
     4% by Stephen Carr, IST Client Services,
    55% University of Waterloo, 200 University Ave. W., Waterloo, Ontario, Canada
    66% FOR ASSISTANCE, please send mail to request@uwaterloo.ca
    77
    88% DISCLAIMER
    9 % To the best of our knowledge, this template satisfies the current uWaterloo thesis requirements.
    10 % However, it is your responsibility to assure that you have met all requirements of the University and your particular department.
    11 
    12 % Many thanks for the feedback from many graduates who assisted the development of this template.
    13 % Also note that there are explanatory comments and tips throughout this template.
     9% To the best of our knowledge, this template satisfies the current uWaterloo
     10% thesis requirements. However, it is your responsibility to assure that you
     11% have met all requirements of the University and your particular department.
     12
     13% Many thanks for the feedback from many graduates who assisted the
     14% development of this template. Also note that there are explanatory comments
     15% and tips throughout this template.
    1416%======================================================================
    1517% Some important notes on using this template and making it your own...
    1618
    17 % The University of Waterloo has required electronic thesis submission since October 2006.
    18 % See the uWaterloo thesis regulations at
    19 % https://uwaterloo.ca/graduate-studies/thesis.
    20 % This thesis template is geared towards generating a PDF version optimized for viewing on an electronic display, including hyperlinks within the PDF.
    21 
    22 % DON'T FORGET TO ADD YOUR OWN NAME AND TITLE in the "hyperref" package configuration below.
    23 % THIS INFORMATION GETS EMBEDDED IN THE PDF FINAL PDF DOCUMENT.
    24 % You can view the information if you view properties of the PDF document.
    25 
    26 % Many faculties/departments also require one or more printed copies.
    27 % This template attempts to satisfy both types of output.
     19% The University of Waterloo has required electronic thesis submission since
     20% October 2006. See the uWaterloo thesis regulations at:
     21%   https://uwaterloo.ca/graduate-studies/thesis.
     22% This thesis template is geared towards generating a PDF version optimized
     23% for viewing on an electronic display, including hyperlinks within the PDF.
     24
     25% DON'T FORGET TO ADD YOUR OWN NAME AND TITLE in the "hyperref" package
     26% configuration below. THIS INFORMATION GETS EMBEDDED IN THE FINAL PDF
     27% DOCUMENT. You can view the information if you view properties of the PDF.
     28
     29% Many faculties/departments also require one or more printed copies.
     30% This template attempts to satisfy both types of output.
    2831% See additional notes below.
    29 % It is based on the standard "book" document class which provides all necessary sectioning structures and allows multi-part theses.
    30 
    31 % If you are using this template in Overleaf (cloud-based collaboration service), then it is automatically processed and previewed for you as you edit.
    32 
    33 % For people who prefer to install their own LaTeX distributions on their own computers, and process the source files manually, the following notes provide the sequence of tasks:
    34  
     32% It is based on the standard "book" document class which provides all
     33% necessary sectioning structures and allows multi-part theses.
     34
     35% If you are using this template in Overleaf (cloud-based collaboration
     36% service), then it is automatically processed and previewed for you as you
     37% edit.
     38
     39% For people who prefer to install their own LaTeX distributions on their own
     40% computers, and process the source files manually, the following notes
     41% provide the sequence of tasks:
     42
    3543% E.g. to process a thesis called "mythesis.tex" based on this template, run:
    3644
    3745% pdflatex mythesis     -- first pass of the pdflatex processor
    3846% bibtex mythesis       -- generates bibliography from .bib data file(s)
    39 % makeindex         -- should be run only if an index is used
    40 % pdflatex mythesis     -- fixes numbering in cross-references, bibliographic references, glossaries, index, etc.
    41 % pdflatex mythesis     -- it takes a couple of passes to completely process all cross-references
    42 
    43 % If you use the recommended LaTeX editor, Texmaker, you would open the mythesis.tex file, then click the PDFLaTeX button. Then run BibTeX (under the Tools menu).
    44 % Then click the PDFLaTeX button two more times.
    45 % If you have an index as well,you'll need to run MakeIndex from the Tools menu as well, before running pdflatex
    46 % the last two times.
    47 
    48 % N.B. The "pdftex" program allows graphics in the following formats to be included with the "\includegraphics" command: PNG, PDF, JPEG, TIFF
    49 % Tip: Generate your figures and photos in the size you want them to appear in your thesis, rather than scaling them with \includegraphics options.
    50 % Tip: Any drawings you do should be in scalable vector graphic formats: SVG, PNG, WMF, EPS and then converted to PNG or PDF, so they are scalable in the final PDF as well.
     47% makeindex         -- should be run only if an index is used
     48% pdflatex mythesis     -- fixes numbering in cross-references, bibliographic
     49%                      references, glossaries, index, etc.
     50% pdflatex mythesis     -- it takes a couple of passes to completely process all
     51%                      cross-references
     52
     53% If you use the recommended LaTeX editor, Texmaker, you would open the
     54% mythesis.tex file, then click the PDFLaTeX button. Then run BibTeX (under
     55% the Tools menu). Then click the PDFLaTeX button two more times.
     56% If you have an index as well, you'll need to run MakeIndex from the Tools
     57% menu as well, before running pdflatex the last two times.
     58
     59% N.B. The "pdftex" program allows graphics in the following formats to be
     60% included with the "\includegraphics" command: PNG, PDF, JPEG, TIFF
     61% Tip: Generate your figures and photos in the size you want them to appear
     62% in your thesis, rather than scaling them with \includegraphics options.
     63% Tip: Any drawings you do should be in scalable vector graphic formats: SVG,
     64% PNG, WMF, EPS and then converted to PNG or PDF, so they are scalable in the
     65% final PDF as well.
    5166% Tip: Photographs should be cropped and compressed so as not to be too large.
    5267
    53 % To create a PDF output that is optimized for double-sided printing:
    54 % 1) comment-out the \documentclass statement in the preamble below, and un-comment the second \documentclass line.
    55 % 2) change the value assigned below to the boolean variable "PrintVersion" from " false" to "true".
    56 
    57 %======================================================================
     68% To create a PDF output that is optimized for double-sided printing:
     69% 1) comment-out the \documentclass statement in the preamble below, and
     70%    un-comment the second \documentclass line.
     71% 2) change the value assigned below to the boolean variable "PrintVersion"
     72%    from " false" to "true".
     73
     74% ======================================================================
    5875%   D O C U M E N T   P R E A M B L E
    59 % Specify the document class, default style attributes, and page dimensions, etc.
     76% Specify the document class, default style attributes, page dimensions, etc.
    6077% For hyperlinked PDF, suitable for viewing on a computer, use this:
    6178\documentclass[letterpaper,12pt,titlepage,oneside,final]{book}
    6279
    63 % For PDF, suitable for double-sided printing, change the PrintVersion variable below to "true" and use this \documentclass line instead of the one above:
     80% For PDF, suitable for double-sided printing, change the PrintVersion
     81% variable below to "true" and use this \documentclass line instead of the
     82% one above:
    6483%\documentclass[letterpaper,12pt,titlepage,openright,twoside,final]{book}
    6584
    6685% Some LaTeX commands I define for my own nomenclature.
    67 % If you have to, it's easier to make changes to nomenclature once here than in a million places throughout your thesis!
     86% If you have to, it's easier to make changes to nomenclature once here than
     87% in a million places throughout your thesis!
    6888\newcommand{\package}[1]{\textbf{#1}} % package names in bold text
    69 \newcommand{\cmmd}[1]{\textbackslash\texttt{#1}} % command name in tt font
    70 \newcommand{\href}[1]{#1} % does nothing, but defines the command so the print-optimized version will ignore \href tags (redefined by hyperref pkg).
     89\newcommand{\cmmd}[1]{\textbackslash\texttt{#1}} % command name in tt font
     90\newcommand{\href}[1]{#1} % does nothing, but defines the command so the
     91% print-optimized version will ignore \href tags (redefined by hyperref pkg).
    7192%\newcommand{\texorpdfstring}[2]{#1} % does nothing, but defines the command
    7293% Anything defined here may be redefined by packages added below...
    … …  
    7697\newboolean{PrintVersion}
    7798\setboolean{PrintVersion}{false}
    78 % CHANGE THIS VALUE TO "true" as necessary, to improve printed results for hard copies by overriding some options of the hyperref package, called below.
     99% CHANGE THIS VALUE TO "true" as necessary, to improve printed results for
     100% hard copies by overriding some options of the hyperref package, called below.
    79101
    80102%\usepackage{nomencl} % For a nomenclature (optional; available from ctan.org)
    81 \usepackage{amsmath,amssymb,amstext} % Lots of math symbols and environments
    82 \usepackage[pdftex]{graphicx} % For including graphics N.B. pdftex graphics driver
     103% Lots of math symbols and environments
     104\usepackage{amsmath,amssymb,amstext}
     105% For including graphics N.B. pdftex graphics driver
     106\usepackage[pdftex]{graphicx}
    83107
    84108% Hyperlinks make it very easy to navigate an electronic document.
    85 % In addition, this is where you should specify the thesis title and author as they appear in the properties of the PDF document.
     109% In addition, this is where you should specify the thesis title and author as
     110% they appear in the properties of the PDF document.
    86111% Use the "hyperref" package
    87112% N.B. HYPERREF MUST BE THE LAST PACKAGE LOADED; ADD ADDITIONAL PKGS ABOVE
    88113\usepackage[pdftex,pagebackref=true]{hyperref} % with basic options
    89114%\usepackage[pdftex,pagebackref=true]{hyperref}
    90                 % N.B. pagebackref=true provides links back from the References to the body text. This can cause trouble for printing.
     115% N.B. pagebackref=true provides links back from the References to the body
     116% text. This can cause trouble for printing.
    91117\hypersetup{
    92118    plainpages=false,       % needed if Roman numbers in frontpages
    … …  
    96122    pdffitwindow=false,     % window fit to page when opened
    97123    pdfstartview={FitH},    % fits the width of the page to the window
    98 %    pdftitle={uWaterloo\ LaTeX\ Thesis\ Template},    % title: CHANGE THIS TEXT!
     124%    pdftitle={uWaterloo\ LaTeX\ Thesis\ Template}, % title: CHANGE THIS TEXT!
    99125%    pdfauthor={Author},    % author: CHANGE THIS TEXT! and uncomment this line
    100126%    pdfsubject={Subject},  % subject: CHANGE THIS TEXT! and uncomment this line
    101 %    pdfkeywords={keyword1} {key2} {key3}, % list of keywords, and uncomment this line if desired
     127%    pdfkeywords={keyword1} {key2} {key3}, % optional list of keywords
    102128    pdfnewwindow=true,      % links in new window
    103129    colorlinks=true,        % false: boxed links; true: colored links
    … …  
    107133    urlcolor=cyan           % color of external links
    108134}
    109 \ifthenelse{\boolean{PrintVersion}}{   % for improved print quality, change some hyperref options
     135% for improved print quality, change some hyperref options
     136\ifthenelse{\boolean{PrintVersion}}{
    110137\hypersetup{    % override some previously defined hyperref options
    111138%    colorlinks,%
    … …  
    116143}{} % end of ifthenelse (no else)
    117144
    118 \usepackage[automake,toc,abbreviations]{glossaries-extra} % Exception to the rule of hyperref being the last add-on package
    119 % If glossaries-extra is not in your LaTeX distribution, get it from CTAN (http://ctan.org/pkg/glossaries-extra),
    120 % although it's supposed to be in both the TeX Live and MikTeX distributions. There are also documentation and
    121 % installation instructions there.
     145% Exception to the rule of hyperref being the last add-on package
     146\usepackage[automake,toc,abbreviations]{glossaries-extra}
     147% If glossaries-extra is not in your LaTeX distribution, get it from CTAN
     148% (http://ctan.org/pkg/glossaries-extra), although it's supposed to be in
     149% both the TeX Live and MikTeX distributions. There are also documentation
     150% and installation instructions there.
    122151
    123152% Setting up the page margins...
    124 \setlength{\textheight}{9in}\setlength{\topmargin}{-0.45in}\setlength{\headsep}{0.25in}
    125 % uWaterloo thesis requirements specify a minimum of 1 inch (72pt) margin at the
    126 % top, bottom, and outside page edges and a 1.125 in. (81pt) gutter margin (on binding side).
    127 % While this is not an issue for electronic viewing, a PDF may be printed, and so we have the same page layout for both printed and electronic versions, we leave the gutter margin in.
    128 % Set margins to minimum permitted by uWaterloo thesis regulations:
     153\setlength{\textheight}{9in}
     154\setlength{\topmargin}{-0.45in}
     155\setlength{\headsep}{0.25in}
     156% uWaterloo thesis requirements specify a minimum of 1 inch (72pt) margin at
     157% the top, bottom, and outside page edges and a 1.125 in. (81pt) gutter margin
     158% (on binding side). While this is not an issue for electronic viewing, a PDF
     159% may be printed, and so we have the same page layout for both printed and
     160% electronic versions, we leave the gutter margin in. Set margins to minimum
     161% permitted by uWaterloo thesis regulations:
    129162\setlength{\marginparwidth}{0pt} % width of margin notes
    130163% N.B. If margin notes are used, you must adjust \textwidth, \marginparwidth
    131164% and \marginparsep so that the space left between the margin notes and page
    132165% edge is less than 15 mm (0.6 in.)
    133 \setlength{\marginparsep}{0pt} % width of space between body text and margin notes
    134 \setlength{\evensidemargin}{0.125in} % Adds 1/8 in. to binding side of all
     166% width of space between body text and margin notes
     167\setlength{\marginparsep}{0pt}
     168% Adds 1/8 in. to binding side of all
    135169% even-numbered pages when the "twoside" printing option is selected
    136 \setlength{\oddsidemargin}{0.125in} % Adds 1/8 in. to the left of all pages when "oneside" printing is selected, and to the left of all odd-numbered pages when "twoside" printing is selected
    137 \setlength{\textwidth}{6.375in} % assuming US letter paper (8.5 in. x 11 in.) and side margins as above
     170\setlength{\evensidemargin}{0.125in}
     171% Adds 1/8 in. to the left of all pages when "oneside" printing is selected,
     172% and to the left of all odd-numbered pages when "twoside" printing is selected
     173\setlength{\oddsidemargin}{0.125in}
     174% assuming US letter paper (8.5 in. x 11 in.) and side margins as above
     175\setlength{\textwidth}{6.375in}
    138176\raggedbottom
    139177
    140 % The following statement specifies the amount of space between paragraphs. Other reasonable specifications are \bigskipamount and \smallskipamount.
     178% The following statement specifies the amount of space between paragraphs.
     179% Other reasonable specifications are \bigskipamount and \smallskipamount.
    141180\setlength{\parskip}{\medskipamount}
    142181
    143 % The following statement controls the line spacing. 
    144 % The default spacing corresponds to good typographic conventions and only slight changes (e.g., perhaps "1.2"), if any, should be made.
     182% The following statement controls the line spacing.
     183% The default spacing corresponds to good typographic conventions and only
     184% slight changes (e.g., perhaps "1.2"), if any, should be made.
    145185\renewcommand{\baselinestretch}{1} % this is the default line space setting
    146186
    147187% By default, each chapter will start on a recto (right-hand side) page.
    148 % We also force each section of the front pages to start on a recto page by inserting \cleardoublepage commands.
    149 % In many cases, this will require that the verso (left-hand) page be blank, and while it should be counted, a page number should not be printed.
    150 % The following statements ensure a page number is not printed on an otherwise blank verso page.
     188% We also force each section of the front pages to start on a recto page by
     189% inserting \cleardoublepage commands. In many cases, this will require that
     190% the verso (left-hand) page be blank, and while it should be counted, a page
     191% number should not be printed. The following statements ensure a page number
     192% is not printed on an otherwise blank verso page.
    151193\let\origdoublepage\cleardoublepage
    152194\newcommand{\clearemptydoublepage}{%
    … …  
    154196\let\cleardoublepage\clearemptydoublepage
    155197
    156 % Define Glossary terms (This is properly done here, in the preamble and could also be \input{} from a separate file...)
     198% Define Glossary terms (This is properly done here, in the preamble and
     199% could also be \input{} from a separate file...)
    157200\input{glossaries}
    158201\makeglossaries
    … …  
    169212%   L O G I C A L    D O C U M E N T
    170213% The logical document contains the main content of your thesis.
    171 % Being a large document, it is a good idea to divide your thesis into several files, each one containing one chapter or other significant chunk of content, so you can easily shuffle things around later if desired.
     214% Being a large document, it is a good idea to divide your thesis into several
     215% files, each one containing one chapter or other significant chunk of content,
     216% so you can easily shuffle things around later if desired.
    172217%======================================================================
    173218\begin{document}
    … …  
    176221% FRONT MATERIAL
    177222% title page,declaration, borrowers' page, abstract, acknowledgements,
    178 % dedication, table of contents, list of tables, list of figures, nomenclature, etc.
    179 %----------------------------------------------------------------------
    180 \input{uw-ethesis-frontpgs}
     223% dedication, table of contents, list of tables, list of figures,
     224% nomenclature, etc.
     225%----------------------------------------------------------------------
     226\input{uw-ethesis-frontpgs}
    181227
    182228%----------------------------------------------------------------------
    183229% MAIN BODY
    184230% We suggest using a separate file for each chapter of your thesis.
    185 % Start each chapter file with the \chapter command.
    186 % Only use \documentclass or \begin{document} and \end{document} commands in this master document.
     231% Start each chapter file with the \chapter command. Only use \documentclass,
     232% \begin{document} and \end{document} commands in this master document.
    187233% Tip: Putting each sentence on a new line is a way to simplify later editing.
    188234%----------------------------------------------------------------------
    … …  
    200246% Bibliography
    201247
    202 % The following statement selects the style to use for references. 
    203 % It controls the sort order of the entries in the bibliography and also the formatting for the in-text labels.
     248% The following statement selects the style to use for references.
     249% It controls the sort order of the entries in the bibliography and also the
     250% formatting for the in-text labels.
    204251\bibliographystyle{plain}
    205 % This specifies the location of the file containing the bibliographic information. 
    206 % It assumes you're using BibTeX to manage your references (if not, why not?).
    207 \cleardoublepage % This is needed if the "book" document class is used, to place the anchor in the correct page, because the bibliography will start on its own page.
    208 % Use \clearpage instead if the document class uses the "oneside" argument
    209 \phantomsection  % With hyperref package, enables hyperlinking from the table of contents to bibliography             
    210 % The following statement causes the title "References" to be used for the bibliography section:
     252% This specifies the location of the file containing the bibliographic
     253% information. It assumes you're using BibTeX to manage your references (if
     254% not, why not?).
     255\cleardoublepage % This is needed if the "book" document class is used, to
     256% place the anchor in the correct page, because the bibliography will start
     257% on its own page.
     258% Use \clearpage instead if the document class uses the "oneside" argument.
     259\phantomsection  % With hyperref package, enables hyperlinking from the table
     260% of contents to bibliography.
     261% The following statement causes the title "References" to be used for the
     262% bibliography section:
    211263\renewcommand*{\bibname}{References}
    212264
    … …  
    215267
    216268\bibliography{uw-ethesis,pl}
    217 % Tip: You can create multiple .bib files to organize your references.
    218 % Just list them all in the \bibliogaphy command, separated by commas (no spaces).
    219 
    220 % The following statement causes the specified references to be added to the bibliography even if they were not cited in the text.
    221 % The asterisk is a wildcard that causes all entries in the bibliographic database to be included (optional).
     269% Tip: You can create multiple .bib files to organize your references. Just
     270% list them all in the \bibliogaphy command, separated by commas (no spaces).
     271
     272% The following statement causes the specified references to be added to the
     273% bibliography even if they were not cited in the text. The asterisk is a
     274% wildcard that causes all entries in the bibliographic database to be
     275% included (optional).
    222276% \nocite{*}
    223277%----------------------------------------------------------------------
    … …  
    227281% The \appendix statement indicates the beginning of the appendices.
    228282\appendix
    229 % Add an un-numbered title page before the appendices and a line in the Table of Contents
     283% Add an un-numbered title page before the appendices and a line in the Table
     284% of Contents
    230285% \chapter*{APPENDICES}
    231286% \addcontentsline{toc}{chapter}{APPENDICES}
    232 % Appendices are just more chapters, with different labeling (letters instead of numbers).
     287% Appendices are just more chapters, with different labeling (letters instead
     288% of numbers).
    233289% \input{appendix-matlab_plots.tex}
    234290
    235 % GLOSSARIES (Lists of definitions, abbreviations, symbols, etc. provided by the glossaries-extra package)
     291% GLOSSARIES (Lists of definitions, abbreviations, symbols, etc.
     292% provided by the glossaries-extra package)
    236293% -----------------------------
    237294\printglossaries
Note: See TracChangeset for help on using the changeset viewer.