Index: doc/theses/thierry_delisle_PhD/thesis/thesis.tex =================================================================== --- doc/theses/thierry_delisle_PhD/thesis/thesis.tex (revision 52f625091e823b7d3d68b3a2e756ab86b1eec67d) +++ doc/theses/thierry_delisle_PhD/thesis/thesis.tex (revision 79debb025dcb88ef24b56dff5e83776fe5f5e95c) @@ -1,74 +1,74 @@ -% uWaterloo Thesis Template for LaTeX -% Last Updated June 14, 2017 by Stephen Carr, IST Client Services -% FOR ASSISTANCE, please send mail to rt-IST-CSmathsci@ist.uwaterloo.ca - -% Effective October 2006, the University of Waterloo -% requires electronic thesis submission. See the uWaterloo thesis regulations at +%====================================================================== +% University of Waterloo Thesis Template for LaTeX +% Last Updated November, 2020 +% by Stephen Carr, IST Client Services, +% University of Waterloo, 200 University Ave. W., Waterloo, Ontario, Canada +% FOR ASSISTANCE, please send mail to request@uwaterloo.ca + +% DISCLAIMER +% To the best of our knowledge, this template satisfies the current uWaterloo thesis requirements. +% However, it is your responsibility to assure that you have met all requirements of the University and your particular department. + +% Many thanks for the feedback from many graduates who assisted the development of this template. +% Also note that there are explanatory comments and tips throughout this template. +%====================================================================== +% Some important notes on using this template and making it your own... + +% The University of Waterloo has required electronic thesis submission since October 2006. +% See the uWaterloo thesis regulations at % https://uwaterloo.ca/graduate-studies/thesis. - -% DON'T FORGET TO ADD YOUR OWN NAME AND TITLE in the "hyperref" package -% configuration below. THIS INFORMATION GETS EMBEDDED IN THE PDF FINAL PDF DOCUMENT. -% You can view the information if you view Properties of the PDF document. - -% Many faculties/departments also require one or more printed -% copies. This template attempts to satisfy both types of output. -% It is based on the standard "book" document class which provides all necessary -% sectioning structures and allows multi-part theses. - -% DISCLAIMER -% To the best of our knowledge, this template satisfies the current uWaterloo requirements. -% However, it is your responsibility to assure that you have met all -% requirements of the University and your particular department. -% Many thanks for the feedback from many graduates that assisted the development of this template. - -% ----------------------------------------------------------------------- - -% By default, output is produced that is geared toward generating a PDF -% version optimized for viewing on an electronic display, including -% hyperlinks within the PDF. - +% This thesis template is geared towards generating a PDF version optimized for viewing on an electronic display, including hyperlinks within the PDF. + +% DON'T FORGET TO ADD YOUR OWN NAME AND TITLE in the "hyperref" package configuration below. +% THIS INFORMATION GETS EMBEDDED IN THE PDF FINAL PDF DOCUMENT. +% You can view the information if you view properties of the PDF document. + +% Many faculties/departments also require one or more printed copies. +% This template attempts to satisfy both types of output. +% See additional notes below. +% It is based on the standard "book" document class which provides all necessary sectioning structures and allows multi-part theses. + +% If you are using this template in Overleaf (cloud-based collaboration service), then it is automatically processed and previewed for you as you edit. + +% 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: + % E.g. to process a thesis called "mythesis.tex" based on this template, run: % pdflatex mythesis -- first pass of the pdflatex processor % bibtex mythesis -- generates bibliography from .bib data file(s) -% makeindex -- should be run only if an index is used +% makeindex -- should be run only if an index is used % pdflatex mythesis -- fixes numbering in cross-references, bibliographic references, glossaries, index, etc. -% pdflatex mythesis -- fixes numbering in cross-references, bibliographic references, glossaries, index, etc. - -% 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). -% Then click the PDFLaTeX button two more times. If you have an index as well, -% you'll need to run MakeIndex from the Tools menu as well, before running pdflatex +% pdflatex mythesis -- it takes a couple of passes to completely process all cross-references + +% 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). +% Then click the PDFLaTeX button two more times. +% If you have an index as well,you'll need to run MakeIndex from the Tools menu as well, before running pdflatex % the last two times. -% N.B. The "pdftex" program allows graphics in the following formats to be -% included with the "\includegraphics" command: PNG, PDF, JPEG, TIFF -% Tip 1: Generate your figures and photos in the size you want them to appear -% in your thesis, rather than scaling them with \includegraphics options. -% Tip 2: 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. -% Tip 3: Photographs should be cropped and compressed so as not to be too large. - -% To create a PDF output that is optimized for double-sided printing: -% -% 1) comment-out the \documentclass statement in the preamble below, and -% un-comment the second \documentclass line. -% -% 2) change the value assigned below to the boolean variable -% "PrintVersion" from "false" to "true". - -% --------------------- Start of Document Preamble ----------------------- - -% Specify the document class, default style attributes, and page dimensions +% N.B. The "pdftex" program allows graphics in the following formats to be included with the "\includegraphics" command: PNG, PDF, JPEG, TIFF +% Tip: Generate your figures and photos in the size you want them to appear in your thesis, rather than scaling them with \includegraphics options. +% 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. +% Tip: Photographs should be cropped and compressed so as not to be too large. + +% To create a PDF output that is optimized for double-sided printing: +% 1) comment-out the \documentclass statement in the preamble below, and un-comment the second \documentclass line. +% 2) change the value assigned below to the boolean variable "PrintVersion" from " false" to "true". + +%====================================================================== +% D O C U M E N T P R E A M B L E +% Specify the document class, default style attributes, and page dimensions, etc. % For hyperlinked PDF, suitable for viewing on a computer, use this: \documentclass[letterpaper,12pt,titlepage,oneside,final]{book} -% For PDF, suitable for double-sided printing, change the PrintVersion variable below -% to "true" and use this \documentclass line instead of the one above: +% For PDF, suitable for double-sided printing, change the PrintVersion variable below to "true" and use this \documentclass line instead of the one above: %\documentclass[letterpaper,12pt,titlepage,openright,twoside,final]{book} -\newcommand{\href}[1]{#1} % does nothing, but defines the command so the - % print-optimized version will ignore \href tags (redefined by hyperref pkg). +% Some LaTeX commands I define for my own nomenclature. +% If you have to, it's easier to make changes to nomenclature once here than in a million places throughout your thesis! +\newcommand{\package}[1]{\textbf{#1}} % package names in bold text +\newcommand{\cmmd}[1]{\textbackslash\texttt{#1}} % command name in tt font +\newcommand{\href}[1]{#1} % does nothing, but defines the command so the print-optimized version will ignore \href tags (redefined by hyperref pkg). +%\newcommand{\texorpdfstring}[2]{#1} % does nothing, but defines the command +% Anything defined here may be redefined by packages added below... % This package allows if-then-else control structures. @@ -76,6 +76,5 @@ \newboolean{PrintVersion} \setboolean{PrintVersion}{false} -% CHANGE THIS VALUE TO "true" as necessary, to improve printed results for hard copies -% by overriding some options of the hyperref package below. +% CHANGE THIS VALUE TO "true" as necessary, to improve printed results for hard copies by overriding some options of the hyperref package, called below. %\usepackage{nomencl} % For a nomenclature (optional; available from ctan.org) @@ -85,15 +84,15 @@ % Hyperlinks make it very easy to navigate an electronic document. -% In addition, this is where you should specify the thesis title -% and author as they appear in the properties of the PDF document. +% In addition, this is where you should specify the thesis title and author as they appear in the properties of the PDF document. % Use the "hyperref" package % N.B. HYPERREF MUST BE THE LAST PACKAGE LOADED; ADD ADDITIONAL PKGS ABOVE \usepackage[pagebackref=false]{hyperref} % with basic options - % N.B. pagebackref=true provides links back from the References to the body text. This can cause trouble for printing. +%\usepackage[pdftex,pagebackref=true]{hyperref} +% N.B. pagebackref=true provides links back from the References to the body text. This can cause trouble for printing. \hypersetup{ plainpages=false, % needed if Roman numbers in frontpages - unicode=false, % non-Latin characters in Acrobat’s bookmarks - pdftoolbar=true, % show Acrobat’s toolbar? - pdfmenubar=true, % show Acrobat’s menu? + unicode=false, % non-Latin characters in Acrobat's bookmarks + pdftoolbar=true, % show Acrobat's toolbar? + pdfmenubar=true, % show Acrobat's menu? pdffitwindow=false, % window fit to page when opened pdfstartview={FitH}, % fits the width of the page to the window @@ -111,7 +110,7 @@ \ifthenelse{\boolean{PrintVersion}}{ % for improved print quality, change some hyperref options \hypersetup{ % override some previously defined hyperref options - citecolor=black, - filecolor=black, - linkcolor=black, + citecolor=black,% + filecolor=black,% + linkcolor=black,% urlcolor=black }}{} % end of ifthenelse (no else) @@ -136,10 +135,10 @@ % Setting up the page margins... -\setlength{\textheight}{9in}\setlength{\topmargin}{-0.45in}\setlength{\headsep}{0.25in} +\setlength{\textheight}{9in} +\setlength{\topmargin}{-0.45in} +\setlength{\headsep}{0.25in} % uWaterloo thesis requirements specify a minimum of 1 inch (72pt) margin at the -% top, bottom, and outside page edges and a 1.125 in. (81pt) gutter -% margin (on binding side). 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. +% top, bottom, and outside page edges and a 1.125 in. (81pt) gutter margin (on binding side). +% 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. % Set margins to minimum permitted by uWaterloo thesis regulations: \setlength{\marginparwidth}{0pt} % width of margin notes @@ -150,27 +149,19 @@ \setlength{\evensidemargin}{0.125in} % Adds 1/8 in. to binding side of all % even-numbered pages when the "twoside" printing option is selected -\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 -\setlength{\textwidth}{6.375in} % assuming US letter paper (8.5 in. x 11 in.) and -% side margins as above +\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 +\setlength{\textwidth}{6.375in} % assuming US letter paper (8.5 in. x 11 in.) and side margins as above \raggedbottom -% The following statement specifies the amount of space between -% paragraphs. Other reasonable specifications are \bigskipamount and \smallskipamount. +% The following statement specifies the amount of space between paragraphs. Other reasonable specifications are \bigskipamount and \smallskipamount. \setlength{\parskip}{\medskipamount} -% The following statement controls the line spacing. The default -% spacing corresponds to good typographic conventions and only slight -% changes (e.g., perhaps "1.2"), if any, should be made. +% The following statement controls the line spacing. +% The default spacing corresponds to good typographic conventions and only slight changes (e.g., perhaps "1.2"), if any, should be made. \renewcommand{\baselinestretch}{1} % this is the default line space setting -% By default, each chapter will start on a recto (right-hand side) -% page. We also force each section of the front pages to start on -% a recto page by inserting \cleardoublepage commands. -% In many cases, this will require that the verso page be -% blank and, while it should be counted, a page number should not be -% printed. The following statements ensure a page number is not -% printed on an otherwise blank verso page. +% By default, each chapter will start on a recto (right-hand side) page. +% We also force each section of the front pages to start on a recto page by inserting \cleardoublepage commands. +% 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. +% The following statements ensure a page number is not printed on an otherwise blank verso page. \let\origdoublepage\cleardoublepage \newcommand{\clearemptydoublepage}{% @@ -204,5 +195,5 @@ \input{common} \CFAStyle % CFA code-style for all languages -\lstset{basicstyle=\linespread{0.9}\tt} +\lstset{language=CFA,basicstyle=\linespread{0.9}\tt} % CFA default language % glossary of terms to use @@ -210,32 +201,28 @@ \makeindex -\newcommand\io{\glsxtrshort{io}}% - -%====================================================================== -% L O G I C A L D O C U M E N T -- the content of your thesis +\newcommand\io{\glsxtrshort{io}\xspace}% + +%====================================================================== +% L O G I C A L D O C U M E N T +% The logical document contains the main content of your thesis. +% 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. %====================================================================== \begin{document} -% For a large document, it is a good idea to divide your thesis -% into several files, each one containing one chapter. -% To illustrate this idea, the "front pages" (i.e., title page, -% declaration, borrowers' page, abstract, acknowledgements, -% dedication, table of contents, list of tables, list of figures, -% nomenclature) are contained within the file "uw-ethesis-frontpgs.tex" which is -% included into the document by the following statement. %---------------------------------------------------------------------- % FRONT MATERIAL +% title page,declaration, borrowers' page, abstract, acknowledgements, +% dedication, table of contents, list of tables, list of figures, nomenclature, etc. %---------------------------------------------------------------------- \input{text/front.tex} - %---------------------------------------------------------------------- % MAIN BODY -%---------------------------------------------------------------------- -% Because this is a short document, and to reduce the number of files -% needed for this template, the chapters are not separate -% documents as suggested above, but you get the idea. If they were -% separate documents, they would each start with the \chapter command, i.e, -% do not contain \documentclass or \begin{document} and \end{document} commands. +% We suggest using a separate file for each chapter of your thesis. +% Start each chapter file with the \chapter command. +% Only use \documentclass or \begin{document} and \end{document} commands in this master document. +% Tip: Putting each sentence on a new line is a way to simplify later editing. +%---------------------------------------------------------------------- + \part{Introduction} \input{text/intro.tex} @@ -255,16 +242,16 @@ %---------------------------------------------------------------------- % END MATERIAL -%---------------------------------------------------------------------- - -% B I B L I O G R A P H Y -% ----------------------- - -% The following statement selects the style to use for references. It controls the sort order of the entries in the bibliography and also the formatting for the in-text labels. +% Bibliography, Appendices, Index, etc. +%---------------------------------------------------------------------- + +% Bibliography + +% The following statement selects the style to use for references. +% It controls the sort order of the entries in the bibliography and also the formatting for the in-text labels. \bibliographystyle{plain} % This specifies the location of the file containing the bibliographic information. -% It assumes you're using BibTeX (if not, why not?). -\cleardoublepage % This is needed if the book class is used, to place the anchor in the correct page, - % because the bibliography will start on its own page. - % Use \clearpage instead if the document class uses the "oneside" argument +% It assumes you're using BibTeX to manage your references (if not, why not?). +\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. +% Use \clearpage instead if the document class uses the "oneside" argument \phantomsection % With hyperref package, enables hyperlinking from the table of contents to bibliography % The following statement causes the title "References" to be used for the bibliography section: @@ -275,16 +262,20 @@ \bibliography{local,pl} -% Tip 5: You can create multiple .bib files to organize your references. +% Tip: You can create multiple .bib files to organize your references. % Just list them all in the \bibliogaphy command, separated by commas (no spaces). -% % The following statement causes the specified references to be added to the bibliography% even if they were not -% % cited in the text. The asterisk is a wildcard that causes all entries in the bibliographic database to be included (optional). +% The following statement causes the specified references to be added to the bibliography even if they were not cited in the text. +% The asterisk is a wildcard that causes all entries in the bibliographic database to be included (optional). % \nocite{*} +%---------------------------------------------------------------------- + +% Appendices % The \appendix statement indicates the beginning of the appendices. \appendix -% Add a title page before the appendices and a line in the Table of Contents +% Add an un-numbered title page before the appendices and a line in the Table of Contents \chapter*{APPENDICES} \addcontentsline{toc}{chapter}{APPENDICES} +% Appendices are just more chapters, with different labeling (letters instead of numbers). %====================================================================== \chapter[PDF Plots From Matlab]{Matlab Code for Making a PDF Plot} @@ -324,5 +315,6 @@ %\input{thesis.ind} % index -\phantomsection - -\end{document} +\phantomsection % allows hyperref to link to the correct page + +%---------------------------------------------------------------------- +\end{document} % end of logical document