source: doc/theses/mike_brooks_MMath/uw-ethesis.tex

Last change on this file was cad8c88, checked in by Peter A. Buhr <pabuhr@…>, 3 weeks ago

change xleftmargin spacing for lstinput, add code formatting macro for C++

  • Property mode set to 100644
File size: 14.9 KB
Line 
1%======================================================================
2% University of Waterloo Thesis Template for LaTeX
3% Last Updated August 2022
4% by IST Client Services,
5% University of Waterloo, 200 University Ave. W., Waterloo, Ontario, Canada
6% FOR ASSISTANCE, please send mail to helpdesk@uwaterloo.ca
7
8% 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.
14%======================================================================
15% Some important notes on using this template and making it your own...
16
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% Search for: PDFTITLE, PDFAUTHOR, PDFSUBJECT, and PDFKEYWORDS.
24% THIS INFORMATION GETS EMBEDDED IN THE FINAL PDF DOCUMENT.
25% You can view the information if you view properties of the PDF document.
26
27% Many faculties/departments also require one or more printed copies.
28% This template attempts to satisfy both types of output.
29% See additional notes below.
30% It is based on the standard "book" document class which provides all necessary sectioning structures and allows multi-part theses.
31
32% If you are using this template in Overleaf (cloud-based collaboration service), then it is automatically processed and previewed for you as you edit.
33
34% 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:
35 
36% E.g. to process a thesis called "mythesis.tex" based on this template, run:
37
38% pdflatex mythesis     -- first pass of the pdflatex processor
39% bibtex mythesis       -- generates bibliography from .bib data file(s)
40% makeindex         -- should be run only if an index is used
41% pdflatex mythesis     -- fixes numbering in cross-references, bibliographic references, glossaries, index, etc.
42% pdflatex mythesis     -- it takes a couple of passes to completely process all cross-references
43
44% 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).
45% Then click the PDFLaTeX button two more times.
46% If you have an index as well,you'll need to run MakeIndex from the Tools menu as well, before running pdflatex
47% the last two times.
48
49% N.B. The "pdftex" program allows graphics in the following formats to be included with the "\includegraphics" command: PNG, PDF, JPEG, TIFF
50% Tip: Generate your figures and photos in the size you want them to appear in your thesis, rather than scaling them with \includegraphics options.
51% 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.
52% Tip: Photographs should be cropped and compressed so as not to be too large.
53
54% To create a PDF output that is optimized for double-sided printing:
55% 1) comment-out the \documentclass statement in the preamble below, and un-comment the second \documentclass line.
56% 2) change the value assigned below to the boolean variable "PrintVersion" from " false" to "true".
57
58%======================================================================
59%   D O C U M E N T   P R E A M B L E
60% Specify the document class, default style attributes, and page dimensions, etc.
61% For hyperlinked PDF, suitable for viewing on a computer, use this:
62\documentclass[letterpaper,12pt,titlepage,oneside,final]{book}
63\usepackage[T1]{fontenc}        % Latin-1 => 256-bit characters, => | not dash, <> not Spanish question marks
64 
65% For PDF, suitable for double-sided printing, change the PrintVersion variable below to "true" and use this \documentclass line instead of the one above:
66%\documentclass[letterpaper,12pt,titlepage,openright,twoside,final]{book}
67
68% Some LaTeX commands I define for my own nomenclature.
69% If you have to, it's easier to make changes to nomenclature once here than in a million places throughout your thesis!
70\newcommand{\package}[1]{\textbf{#1}} % package names in bold text
71\newcommand{\cmmd}[1]{\textbackslash\texttt{#1}} % command name in tt font
72\newcommand{\href}[1]{#1} % does nothing, but defines the command so the print-optimized version will ignore \href tags (redefined by hyperref pkg).
73%\newcommand{\texorpdfstring}[2]{#1} % does nothing, but defines the command
74% Anything defined here may be redefined by packages added below...
75
76% This package allows if-then-else control structures.
77\usepackage{ifthen}
78\newboolean{PrintVersion}
79\setboolean{PrintVersion}{false}
80% CHANGE THIS VALUE TO "true" as necessary, to improve printed results for hard copies by overriding some options of the hyperref package, called below.
81
82%\usepackage{nomencl} % For a nomenclature (optional; available from ctan.org)
83\usepackage{amsmath,amssymb,amstext} % Lots of math symbols and environments
84\usepackage{fullpage,times,comment}
85\usepackage{xcolor}
86\usepackage{epic,eepic}
87\usepackage{graphicx}
88\usepackage{tabularx}
89\usepackage[labelformat=simple,aboveskip=0pt,farskip=0pt,font=normalsize]{subfig}
90\renewcommand\thesubfigure{(\alph{subfigure})}
91
92\graphicspath{{pictures/}} % picture directory
93%\usepackage{algorithm}
94%\usepackage{algpseudocode}
95\usepackage{pbox}
96
97\makeatletter
98\newcommand{\lstinput}[3][]{\lstinputlisting[#1,linerange={#2},xleftmargin=\parindentlnth,escapechar={\$},moredelim={**[is][\color{red}]{@}{@}}]{#3}}
99\makeatother
100% cfa macros used in the document
101\input{common}
102%\usepackage{common}
103\CFAStyle                                               % CFA code-style
104\lstset{language=cfa,belowskip=-1pt} % set default language to CFA
105\lstnewenvironment{c++}[1][]{\lstset{language=[GNU]C++,escapechar=\$,moredelim=**[is][\color{red}]{@}{@},}\lstset{#1}}{}
106\lstset{inputpath={programs}}
107
108\newcommand{\uCpp}{$\mu$\CC}
109\newcommand{\PAB}[1]{{\color{red}PAB: #1}}
110
111% Hyperlinks make it very easy to navigate an electronic document.
112% In addition, this is where you should specify the thesis title and author as they appear in the properties of the PDF document.
113% Use the "hyperref" package
114% N.B. HYPERREF MUST BE THE LAST PACKAGE LOADED; ADD ADDITIONAL PKGS ABOVE
115\usepackage{url}
116\usepackage[pagebackref=true]{hyperref} % with basic options
117%\usepackage[pdftex,pagebackref=true]{hyperref}
118% N.B. pagebackref=true provides links back from the References to the body text. This can cause trouble for printing.
119\hypersetup{
120    plainpages=false,       % needed if Roman numbers in frontpages
121    unicode=false,          % non-Latin characters in Acrobat's bookmarks
122    pdftoolbar=true,        % show Acrobat's toolbar?
123    pdfmenubar=true,        % show Acrobat's menu?
124    pdffitwindow=false,     % window fit to page when opened
125    pdfstartview={FitH},    % fits the width of the page to the window
126    pdftitle={\CFA Container Library}, % title: CHANGE THIS TEXT!
127    pdfauthor={Mike Brooks},    % author: CHANGE THIS TEXT! and uncomment this line
128    pdfsubject={Cforall}% subject: CHANGE THIS TEXT! and uncomment this line
129    pdfkeywords={Cforall} {container library} {C language}, % optional list of keywords
130    pdfnewwindow=true,      % links in new window
131    colorlinks=true,        % false: boxed links; true: colored links
132    linkcolor=blue,         % color of internal links
133    citecolor=blue,         % color of links to bibliography
134    filecolor=magenta,      % color of file links
135    urlcolor=blue,          % color of external links
136    breaklinks=true
137}
138\ifthenelse{\boolean{PrintVersion}}{   % for improved print quality, change some hyperref options
139\hypersetup{    % override some previously defined hyperref options
140%    colorlinks,%
141    citecolor=black,%
142    filecolor=black,%
143    linkcolor=black,%
144    urlcolor=black}
145}{} % end of ifthenelse (no else)
146
147\usepackage{breakurl}
148\urlstyle{sf}
149
150%\usepackage[automake,toc,abbreviations]{glossaries-extra} % Exception to the rule of hyperref being the last add-on package
151% If glossaries-extra is not in your LaTeX distribution, get it from CTAN (http://ctan.org/pkg/glossaries-extra),
152% although it's supposed to be in both the TeX Live and MikTeX distributions. There are also documentation and
153% installation instructions there.
154
155% Customizing tabularx
156\newcolumntype{Y}{>{\centering\arraybackslash}X}
157
158% Setting up the page margins...
159%\setlength{\textheight}{9in}
160%\setlength{\topmargin}{-0.45in}
161%\setlength{\headsep}{0.25in}
162% uWaterloo thesis requirements specify a minimum of 1 inch (72pt) margin at the
163% top, bottom, and outside page edges and a 1.125 in. (81pt) gutter margin (on binding side).
164% 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.
165% Set margins to minimum permitted by uWaterloo thesis regulations:
166\setlength{\marginparwidth}{0pt} % width of margin notes
167% N.B. If margin notes are used, you must adjust \textwidth, \marginparwidth
168% and \marginparsep so that the space left between the margin notes and page
169% edge is less than 15 mm (0.6 in.)
170\setlength{\marginparsep}{0pt} % width of space between body text and margin notes
171\setlength{\evensidemargin}{0.125in} % Adds 1/8 in. to binding side of all
172% even-numbered pages when the "twoside" printing option is selected
173\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
174\setlength{\textwidth}{6.375in} % assuming US letter paper (8.5 in. x 11 in.) and side margins as above
175\raggedbottom
176
177% The following statement specifies the amount of space between paragraphs. Other reasonable specifications are \bigskipamount and \smallskipamount.
178\setlength{\parskip}{\medskipamount}
179
180% The following statement controls the line spacing. 
181% The default spacing corresponds to good typographic conventions and only slight changes (e.g., perhaps "1.2"), if any, should be made.
182\renewcommand{\baselinestretch}{1} % this is the default line space setting
183
184% By default, each chapter will start on a recto (right-hand side) page.
185% We also force each section of the front pages to start on a recto page by inserting \cleardoublepage commands.
186% 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.
187% The following statements ensure a page number is not printed on an otherwise blank verso page.
188\let\origdoublepage\cleardoublepage
189\newcommand{\clearemptydoublepage}{%
190  \clearpage{\pagestyle{empty}\origdoublepage}}
191\let\cleardoublepage\clearemptydoublepage
192
193% Define Glossary terms (This is properly done here, in the preamble and could also be \input{} from a separate file...)
194%\input{glossaries}
195%\makeglossaries
196
197%======================================================================
198%   L O G I C A L    D O C U M E N T
199% The logical document contains the main content of your thesis.
200% 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.
201%======================================================================
202\begin{document}
203
204%----------------------------------------------------------------------
205% FRONT MATERIAL
206% title page,declaration, borrowers' page, abstract, acknowledgements,
207% dedication, table of contents, list of tables, list of figures, nomenclature, etc.
208%----------------------------------------------------------------------
209\input{uw-ethesis-frontpgs} 
210
211%----------------------------------------------------------------------
212% MAIN BODY
213% We suggest using a separate file for each chapter of your thesis.
214% Start each chapter file with the \chapter command.
215% Only use \documentclass or \begin{document} and \end{document} commands in this master document.
216% Tip: Putting each sentence on a new line is a way to simplify later editing.
217%----------------------------------------------------------------------
218
219\input{intro}
220\input{background}
221\input{array}
222\input{list}
223\input{string}
224\input{conclusion}
225
226%----------------------------------------------------------------------
227% END MATERIAL
228% Bibliography, Appendices, Index, etc.
229%----------------------------------------------------------------------
230
231% Bibliography
232
233% The following statement selects the style to use for references. 
234% It controls the sort order of the entries in the bibliography and also the formatting for the in-text labels.
235\bibliographystyle{plain}
236% This specifies the location of the file containing the bibliographic information. 
237% It assumes you're using BibTeX to manage your references (if not, why not?).
238\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.
239% Use \clearpage instead if the document class uses the "oneside" argument
240\phantomsection  % With hyperref package, enables hyperlinking from the table of contents to bibliography             
241% The following statement causes the title "References" to be used for the bibliography section:
242\renewcommand*{\bibname}{References}
243
244% Add the References to the Table of Contents
245\addcontentsline{toc}{chapter}{\textbf{References}}
246
247\bibliography{pl,uw-ethesis}
248% Tip: You can create multiple .bib files to organize your references.
249% Just list them all in the \bibliogaphy command, separated by commas (no spaces).
250
251% The following statement causes the specified references to be added to the bibliography even if they were not cited in the text.
252% The asterisk is a wildcard that causes all entries in the bibliographic database to be included (optional).
253% \nocite{*}
254%----------------------------------------------------------------------
255
256% Appendices
257
258% The \appendix statement indicates the beginning of the appendices.
259\appendix
260% Add an un-numbered title page before the appendices and a line in the Table of Contents
261% \chapter*{APPENDICES}
262% \addcontentsline{toc}{chapter}{APPENDICES}
263% Appendices are just more chapters, with different labeling (letters instead of numbers).
264% \input{appendix-matlab_plots.tex}
265
266% GLOSSARIES (Lists of definitions, abbreviations, symbols, etc. provided by the glossaries-extra package)
267% -----------------------------
268%\printglossaries
269%\cleardoublepage
270%\phantomsection                % allows hyperref to link to the correct page
271
272%----------------------------------------------------------------------
273\end{document} % end of logical document
Note: See TracBrowser for help on using the repository browser.