Debian Codegraph @

texmf-dist/source/latex/york-thesis/york-thesis.dtx

raw
1 % \iffalse meta-comment
2 %
3 % Copyright (C) 2002-11 by Diane Gall <[email protected]>
4 % -------------------------------------------------------
5 %
6 % This file may be distributed and/or modified under the
7 % conditions of the LaTeX Project Public License, either version 1.3
8 % of this license or (at your option) any later version.
9 % The latest version of this license is in:
10 %
11 % http://www.latex-project.org/lppl.txt
12 %
13 % and version 1.3 or later is part of all distributions of LaTeX
14 % version 2003/06/01 or later.
15 %
16 % This work has the LPPL maintenance status "author-maintained".
17 %
18 % \fi
19 %
20 % \iffalse
21 %<*driver>
22 \ProvidesFile{york-thesis.dtx}
23 %</driver>
24 %<class>\NeedsTeXFormat{LaTeX2e}[1999/12/01]
25 %<class>\ProvidesClass{york-thesis}
26 %<*class>
27 [2011/06/13 v3.6 York University (Toronto, Canada) thesis class]
28 %</class>
29 %
30 %<*driver>
31 \documentclass{ltxdoc}
32 \usepackage{listings}
33 \EnableCrossrefs
34 \RecordChanges
35 \widowpenalty=50000 \clubpenalty=50000
36 \begin{document}
37 \DocInput{york-thesis.dtx}
38 \end{document}
39 %</driver>
40 % \fi
41 %
42 % \CheckSum{0}
43 %
44 % \CharacterTable
45 % {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
46 % Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
47 % Digits \0\1\2\3\4\5\6\7\8\9
48 % Exclamation \! Double quote \" Hash (number) \#
49 % Dollar \$ Percent \% Ampersand \&
50 % Acute accent \' Left paren \( Right paren \)
51 % Asterisk \* Plus \+ Comma \,
52 % Minus \- Point \. Solidus \/
53 % Colon \: Semicolon \; Less than \<
54 % Equals \= Greater than \> Question mark \?
55 % Commercial at \@ Left bracket \[ Backslash \\
56 % Right bracket \] Circumflex \^ Underscore \_
57 % Grave accent \` Left brace \{ Vertical bar \|
58 % Right brace \} Tilde \~}
59 %
60 % \changes{v1.0}{1995/04/25}{Set up for distribution to others}
61 % \changes{v1.1}{2002/02/13}{Various housekeeping functions}
62 % \changes{v2.5}{2005/04/20}{Extensive changes to comply with the new
63 % Spring 2005 FGS Thesis and Dissertation Guidelines}
64 % \changes{v3.0}{2005/05/21}{Converted all code to literate
65 % programming; corrected innumerable minor errors}
66 % \changes{v3.5}{2010/05/06}{Updated author name}
67 %
68 % \GetFileInfo{york-thesis.dtx}
69 %
70 % \DoNotIndex{\newcommand,\newenvironment}
71 %
72 % \title{The \textsf{york-thesis} class\thanks{This document
73 % corresponds to \textsf{york-thesis}~\fileversion, dated
74 % \filedate.}} \author{Diane Gall \\
75 % \texttt{[email protected]}\thanks{For the love of all that is
76 % holy, if you find errors your output, get hold of me pronto at
77 % \texttt{[email protected]}---I will make every effort to make
78 % the corrections quickly and get back to you. However, you need
79 % to describe the problem clearly and include the source and
80 % output that offends.}}
81 %
82 % \maketitle
83 % \parindent = 0pt
84 % \parskip = 1em
85 % \begin{abstract}
86 % \noindent The \textsf{york-thesis} class implements the York
87 % University (Toronto, Canada) Faculty of Graduate Studies guidelines
88 % for Theses and Dissertations (Spring 2005). This class file is based
89 % on the \textsf{report} class included in every \LaTeX\
90 % distribution. All requirements are pre-programmed and various
91 % additional bits that I found useful when writing my dissertation are
92 % included.
93 % \end{abstract}
94 %
95 % \section{Introduction}
96 %
97 % This document specifies completely the changes the class file makes
98 % to the \textsf{report} class in order for the output to meet the
99 % York FGS specifications for Theses and Dissertations. These
100 % guidelines are available from your graduate programme office and
101 % from FGS.\footnote{They are also available at
102 % \texttt{http://www.yorku.ca/grads/pub/td.htm}} It is your
103 % responsibility to ensure that your output meets these requirements.
104 %
105 % \section{Usage}
106 %
107 % \subsection{Installation}
108 %
109 % Now that you have run both \texttt{york-thesis.ins} and
110 % \texttt{york-thesis.dtx} through \LaTeX, the only file you
111 % \textit{need} to install is the \texttt{york-thesis.cls} file. It
112 % goes in your personal \texttt{texmf} tree, wherever that is. For
113 % MacOS X users, this location is in \texttt{Library/texmf/tex/latex/}
114 % in your home folder.
115 %
116 % If you are using emacs and AUCTeX, the file \texttt{york-thesis.el}
117 % should be installed in a folder called \texttt{style} in your
118 % personal \texttt{emacs-lisp} folder in your home directory. This
119 % file contains some definitions for AUCTeX.
120 %
121 % The york-thesis-Template.tex file contains a sample master document
122 % that uses all of the features provided by the class file over
123 % \textsf{report.cls}. If you forget to set anything, the defaults
124 % from the class file will be used, so review your output carefully.
125 %
126 % \subsection{Deployment}
127 %
128 % \DescribeMacro{\documentclass} Use: |\documentclass| \oarg{options}
129 % \{\textsf{york-thesis}\}
130 %
131 % The \textsf{york-thesis} class is invoked in the standard
132 % fashion. The defaults are
133 % \textsf{letterpaper,10pt,oneside,onecolumn,draft,openany}. The
134 % |\documentclass| command has extra functionality built into two
135 % options: \textsf{draft} and \textsf{final}. The \textsf{draft}
136 % option sets the margins to 1 inch all around and single-spaces
137 % everything. All other \textsf{draft} features of the \textsf{report}
138 % class (such as marking overfull boxes and providing empty boxes for
139 % graphics) are left intact, if you explicitly declare \textsf{draft};
140 % otherwise, you get the graphics drawn and bad boxes are not marked.
141 % The \textsf{final} option, by itself in the options list, sets all
142 % parameters for producing output suitable for examination and
143 % deposit. All other options are available, though some (like
144 % \textsf{titlepage}) do nothing.\footnote{If you declare
145 % \textsf{twocolumn}, the output may be goofy. I intend to make this
146 % a real option in future. See \S\ref{future}.}
147 %
148 % \subsection{Preprogrammed Formats}
149 % \label{preprog}
150 %
151 % The York FGS guidelines are both specific and vague. Where the
152 % guidelines \textit{require} some feature, it is implemented as the
153 % default. If you change the behaviour of anything, you should confirm
154 % that this liberty is permitted by the guidelines. I have taken some
155 % liberties that are permitted---these are detailed below.
156 %
157 % \DescribeMacro{\chapter} \DescribeMacro{\section}
158 % \DescribeMacro{\subsection} \DescribeMacro{\subsubsection}
159 % \DescribeMacro{\paragraph} I have made the size and spacing of the
160 % output these commands less idiotic---that is, smaller. The chapter
161 % type size is slightly larger than that for the others (|\Large|
162 % rather than |\Huge|), but the others are now simply |\large|, save
163 % |\paragraph|, which is |\normalsize|. Additionally, the chapter
164 % command gives you a chapter number with the title on a single line
165 % without the word `Chapter' to remind you that this is where a
166 % chapter begins. I think we can all tell from the context.
167 %
168 % \DescribeMacro{\appendix} Appendices are marked with
169 % capital Roman letters (i.e., A, B, C, et cetera), and treated
170 % exactly the same as a normal chapter.
171 %
172 % \DescribeEnv{quote} \DescribeEnv{quotation} \DescribeEnv{verse} I
173 % have made a command decision regarding these environments. The
174 % guidelines allow for single spacing these in the submission copy and
175 % I think it just looks better to do so. So, these three environments
176 % are single-spaced in both \textsf{draft} and \textsf{final}. I am
177 % planning to implement a switch for this in the future. If this is an
178 % important feature for anyone, please give me a shout.
179 %
180 % \DescribeMacro{\footnote} The guidelines allow footnotes to be
181 % single-spaced, so they are. Also, I have set the footnote
182 % continuation bar (the one that gets drawn when footnotes continue on
183 % the next page) to be drawn across the width of the text. Again, if
184 % anyone needs a switch to double space their footnotes soon, give me
185 % a shout.
186 %
187 % \subsection{Booleans and Macros}
188 %
189 % \subsubsection{Preamble Material}
190 %
191 % These booleans and macros must be set before the |document|
192 % environment begins.
193 %
194 % \DescribeMacro{masters} This \textsf{boolean} sets whether the
195 % document should be typeset as a PhD dissertation or a Masters
196 % thesis.
197 %
198 % \DescribeMacro{hasfigures} This \textsf{boolean} sets whether there
199 % are any figures in the text. All this switch does is tell \LaTeX\ to
200 % construct a list of figures and insert an entry for the list of
201 % figures in the table of contents.
202 %
203 % \DescribeMacro{hastables} This \textsf{boolean} sets whether there
204 % are any tables in the text. All this switch does is tell \LaTeX\ to
205 % construct a list of tables and insert an entry for the list of
206 % tables in the table of contents.
207 %
208 % \DescribeMacro{\title} This macro specifies the title of the work
209 % for the title page.
210 %
211 % \DescribeMacro{\author} This macro specifies your name for the title
212 % page.
213 %
214 % \DescribeMacro{\department} This macro specifies the department or
215 % graduate programme within which you are pursuing the degree.
216 %
217 % \DescribeMacro{\date} This macro specifies the full month and year
218 % of the defense date.
219 %
220 % \DescribeMacro{\committeememberslist} Use: |\committeememberslist|
221 % \marg{enumerated list}
222 %
223 % This macro specifies the list of your
224 % examination committee members for the authenticity page, if you are
225 % printing one. What goes into the macro must be an enumerated list.
226 %
227 % \DescribeMacro{\mastersof} This macro specifies which Masters degree
228 % you are attempting (i.e., Master of Science, Master of Arts). This
229 % macro has no effect if |\boolean{masters}| is false, i.e., if this
230 % is a PhD dissertation.
231 %
232 % \DescribeMacro{\degreename} This macro specifies the name of the
233 % degree you are attempting: Master or Magisteriate, Doctor or
234 % Doctorate.
235 %
236 % \DescribeMacro{\abstractfile} This macro specifies the filename of
237 % the .tex file that contains your abstract. If you do not specify a
238 % file, nothing is typeset. The macro constructs the title and table
239 % of contents entry for the page. All you need to do in the file is
240 % enter the text. The first line of the abstract should not be
241 % indented, so this is forced by the class file.
242 %
243 % \DescribeMacro{\dedicationfile} This macro specifies the filename of
244 % the .tex file that contains your dedication text. All you need to do
245 % here is specify the text of your dedication.
246 %
247 % \changes{v3.2}{2006/01/31}{Added the \textsf{dedicationfile} macro.}
248 %
249 % \DescribeMacro{\acknowledgementsfile} This macro specifies the
250 % filename of the .tex file that contains your acknowledgements. If
251 % you do not specify a file, nothing is typeset. The macro constructs
252 % the title and table of contents entry for the page. All you need to
253 % do in the file is enter the text. The first line of the
254 % acknowledgements should not be indented, so this is forced by the
255 % class file.
256 %
257 % \DescribeMacro{\prefacefile} This macro specifies the filename of
258 % the .tex file that contains your preface. If you do not specify a
259 % file, nothing is typeset. The macro constructs the title and table
260 % of contents entry for the page. All you need to do in the file is
261 % enter the text. The first line of the preface should not be
262 % indented, so this is forced by the class file.
263 %
264 % \DescribeMacro{\abbreviationsfile} This macro specifies the filename
265 % of the .tex file that contains any abbreviations for citations, et
266 % cetera, that you are going to use in the text. If you do not specify
267 % a file, nothing is typeset. The macro constructs the title and
268 % table of contents entry for the page. All you need to do in the file
269 % is enter the text. The first line of the abbreviations page should
270 % not be indented, so this is forced by the class file.
271 %
272 % \subsubsection{Source Material}
273 % \label{sourcemat}
274 %
275 % These macros are used inside the |document| environment.
276 %
277 % \DescribeMacro{\makefrontmatter} This macro generates the title
278 % page, abstract, acknowledgements, preface, abbreviations page, table
279 % of contents, and lists of tables and figures. It can be commented
280 % out until you need the front matter generated.
281 %
282 % \DescribeMacro{\epigraph} Use: |\epigraph| \marg{pithy quote}
283 % \marg{source}
284 %
285 % I have added a command to insert an epigraph to be used inside an
286 % |epigraphs| environment immediately after the |\chapter| command (or
287 % wherever it strikes your fancy). It takes two arguments: a pithy
288 % quote and the source. The text is inserted right-justified with a
289 % rule underneath just after the chapter title (when invoked right
290 % after the |\chapter| command). The output is single-spaced in
291 % \texttt{draft} mode and double-spaced in \texttt{final} mode. As you
292 % can see, the possibilities are endless.
293 %
294 % \subsection{Environments}
295 %
296 % The |quote|, |quotation|, and |verse| environments have been
297 % modified as specified in \S\ref{preprog}.
298 %
299 % \DescribeEnv{epigraphs} This environment allows for the setting of
300 % epigraphs---if you are so inclined. It is a list environment and
301 % uses the |\epigraph| macro as the list item as specified in
302 % \S\ref{sourcemat}.
303 %
304 % \DescribeEnv{fquote} \DescribeEnv{fquotation} \DescribeEnv{fverse}
305 % These environments are redefinitions of the corresponding
306 % environments for use inside footnotes. They properly set the text
307 % size to |\footnotesize| and control the spacing appropriately.
308 %
309 % \section{Miscellaneous Goodies}
310 %
311 % \subsection{Bugs}
312 %
313 % There are, of course, no bugs in this class file. In the incredibly
314 % unlikely event that it does not perform correctly, it is obvious that
315 % it is the operator's fault. Please send a detailed description of your
316 % error to me at \texttt{[email protected]} and I will instruct you in
317 % the proper use of the class file. If, on the other hand, you have the
318 % temerity to think that there could be \textit{improvements} to this
319 % most perfect code, please send those along as well for I do enjoy
320 % condescending to those who dare second-guess genius.\footnote{For the
321 % humour-impaired, if this thing is messed up, send me a detailed
322 % description of the error or improvement desired and I'll make
323 % something useful happen.}
324 %
325 % \subsection{Future Features}
326 % \label{future}
327 %
328 % \begin{itemize}
329 %
330 % \item Implement a switch for the |quote|, |quotation|, |verse|
331 % environments so that they can be set to double-space in
332 % \textsf{final} mode.
333 %
334 % \item Implement a switch for the |\footnote| command so that they
335 % can be double-spaced in \textsf{final} mode.
336 %
337 % \item Some people might want to have the option of setting their
338 % \textsf{draft} documents two sided and/or two columned (i.e., any
339 % damned way they want). If you do so right now, things may look
340 % goofy (most of the frontmatter, for instance). I want to make it
341 % such that a decent looking \textsf{draft} document can be
342 % generated. My idea here is that users might want to make their
343 % thesis/dissertation look like a book at the end of the day, since
344 % the \textsf{final} document is not set like a book. This is not a
345 % high priority.
346 %
347 % \item Generation of subject matter appropriate text. I forsee a
348 % |generate| option for the |\documentclass| command. This option
349 % will, if the computer is attached to the Internet, search all
350 % available sources, generate a thesis statement (based upon the
351 % value of the |\title| macro), and the supporting arguments for
352 % that thesis. I anticipate a great deal of extra code will be
353 % necessary, so this feature will be an ongoing project.
354 %
355 % \end{itemize}
356 %
357 % \StopEventually{\PrintChanges}
358 %
359 % \section{Implementation}
360 %
361 % \subsection{Initial Code}
362 %
363 % All of these packages are in the standard distribution of
364 % \LaTeX. I've included the \textsf{makeidx} so I can re-define
365 % |\printindex|. The |saving| boolean is defined here for use with the
366 % class options.
367 %
368 % \begin{macrocode}
369 \RequirePackage{ifthen}
370 \RequirePackage{calc}
371 \RequirePackage{makeidx}
372 \newboolean{saving}
373 % \end{macrocode}
374 %
375 % \subsection{Declaration of Options}
376 %
377 % \changes{v1.1}{2002/02/13}{added \textsf{final} and \textsf{draft}
378 % options in \textsf{documentclass} macro.}
379 % \changes{v3.0}{2005/05/21}{changed the fashion in which options are
380 % processed so that \textsf{report.cls} correctly gets the draft and
381 % final options.} \changes{v3.0}{2005/05/21}{FGS guidelines allow
382 % for 10pt, 11pt, and 12pt type now. I no longer enforce 12pt;
383 % however, it is set as the default. Other type sizes must be
384 % explicitly declared.}
385 %
386 % All of the options available to the |report| class are available in
387 % \textsf{york-thesis}.\footnote{Do not use the |titlepage| and
388 % |abstract| environments from \textsf{report.cls}. The title page
389 % and the abstract are taken care of by the |makefronmatter|
390 % macro.} I have changed the default options (i.e., the option set
391 % executed where there are no explicitly declared options in the
392 % |\documentclass| macro. There are also two changes to the standard
393 % behaviour of two options: \textsf{draft} and \textsf{final}.
394 %
395 % The default option list is:
396 % \textsf{letterpaper,10pt,oneside,onecolumn,draft,openany}
397 %
398 % I have set the options up in a way that increases the number of
399 % options for typesetting the document.
400 %
401 % If \textsf{draft} is declared \textit{implicitly} (that is, neither
402 % \textsf{draft} or \textsf{final} is declared in the options list),
403 % then all text is set to single-spacing, graphics are drawn, and bad
404 % boxes are not marked.
405 %
406 % If draft is declared \textit{explicitly} (that is, \textsf{draft} is
407 % declared in the options list), then all text is set to
408 % single-spaced, graphics are not drawn (bounding boxes are drawn),
409 % and bad boxes are marked.
410 %
411 % If \textsf{final} is declared, the text is set to double-space (as
412 % described in \S\ref{preprog}), one sided printing, and one
413 % column. If \textsf{final} is declared alone, what you get is
414 % acceptable by FGS for deposit.
415 %
416 % \begin{macrocode}
417 \DeclareOption{draft}{\setboolean{saving}{true}}
418 \DeclareOption{final}{\setboolean{saving}{false}
419 \PassOptionsToClass{letterpaper,12pt,oneside,%
420 onecolumn,final,openany}{report}}
421 \DeclareOption*{\PassOptionsToClass{\CurrentOption}{report}}
422 \ExecuteOptions{draft}
423 % \end{macrocode}
424 %
425 % \subsection{Execution of Options}
426 %
427 % \begin{macrocode}
428 \ProcessOptions
429 % \end{macrocode}
430 %
431 % \subsection{Package Loading}
432 %
433 % \begin{macrocode}
434 \LoadClass{report}
435 % \end{macrocode}
436 %
437 % \subsection{Main Code}
438 %
439 % \subsubsection{Preliminary Matter}
440 %
441 % I need to re-define a number of standard macros and settings to get
442 % everything to come out exactly right. This is where that magic
443 % happens.
444 %
445 % \begin{macrocode}
446 \let\oldquote\quote \let\oldendquote\endquote
447 \let\oldquotation\quotation \let\oldendquotation\endquotation
448 \let\oldverse\verse \let\oldendverse\endverse
449 \let\oldbibliography\bibliography
450 \let\oldendbibliography\endbibliography
451 \let\oldprintindex\printindex
452 % \end{macrocode}
453 %
454 %
455 % The following are booleans along with their initial values
456 %
457 % \changes{v2.5}{2005/04/20}{added the boolean
458 % \textsf{authenticitypage}} \changes{v3.0}{2005-05-21}{removed the
459 % boolean \textsf{authenticitypage}; the authenticity page is now
460 % always generated}
461 %
462 % \begin{macro}{hasfigures}
463 %
464 % This \textsf{boolean} sets whether a list of figures should be
465 % generated
466 %
467 % \begin{macrocode}
468 \newboolean{hasfigures}\setboolean{hasfigures}{false}
469 % \end{macrocode}
470 % \end{macro}
471 %
472 % \begin{macro}{hastables}
473 %
474 % This \textsf{boolean} sets whether a list of tables should be
475 % generated
476 %
477 % \begin{macrocode}
478 \newboolean{hastables}\setboolean{hastables}{false}
479 % \end{macrocode}
480 % \end{macro}
481 %
482 % \begin{macro}{masters}
483 %
484 % The |masters| boolean was taken from dissertation.sty with
485 % modification. If set \textsf{true}, you will need to specify which
486 % master's degree you are pursuing with the |\masterof| macro.
487 %
488 % \begin{macrocode}
489 \newboolean{masters}\setboolean{masters}{false}
490 % \end{macrocode}
491 % \end{macro}
492 %
493 % \begin{macro}{\spacing}
494 %
495 % I redefine |\baselinestretch| and recompute |\baselineskip|
496 % lateral effect: set typeface to normal size roman
497 %
498 % \begin{macrocode}
499 \newcommand{\spacing}[1]{\renewcommand{\baselinestretch}{#1}%
500 \large\normalsize}
501 % \end{macrocode}
502 % \end{macro}
503 %
504 % \begin{macro}{\@removefromreset}
505 %
506 % I define a command that can undo footnote reset between chapters
507 % (shamelessly lifted from removefr.sty by Donald Arseneau) and then
508 % do it.
509 %
510 % \begin{macrocode}
511 \def\@removefromreset#1#2{\let\@tempb\@elt
512 \expandafter\let\expandafter\@tempa\csname c@#1\endcsname
513 \def\@elt##1{\expandafter\ifx\csname c@##1\endcsname\@tempa\else
514 \noexpand\@elt{##1}\fi}%
515 \expandafter\edef\csname cl@#2\endcsname{\csname cl@#2\endcsname}%
516 \let\@elt\@tempb}
517 \@removefromreset{footnote}{chapter}
518 % \end{macrocode}
519 % \end{macro}
520 %
521 % \begin{macro}{\resetfootnote}
522 %
523 % Here I undo the hideous |\@addtoreset| in \textsf{report.cls}
524 %
525 % \begin{macrocode}
526 \def\resetfootnote{\setcounter{footnote}{0}}
527 % \end{macrocode}
528 % \end{macro}
529 %
530 % \begin{macro}{\footnotetext}
531 %
532 % Make footnotes single spaced, footnote continuation lines
533 % longer
534 %
535 % \changes{v1.1}{2002/02/13}{made footnote spacing single
536 % spaced in final}
537 %
538 % \changes{v3.4}{2006/05/16}{stole code from |footmisc| to
539 % lengthen footnote continuation lines}
540 %
541 %
542 % \begin{macrocode}
543 \long\def\@footnotetext#1{%
544 \insert\footins{%
545 \def\baselinestretch {1}%
546 \reset@font\footnotesize
547 \interlinepenalty\interfootnotelinepenalty
548 \splittopskip\footnotesep
549 \splitmaxdepth \dp\strutbox \floatingpenalty \@MM
550 \hsize\columnwidth
551 \@parboxrestore
552 \protected@edef\@currentlabel{%
553 \csname p@footnote\endcsname\@thefnmark}%
554 \color@begingroup
555 \@makefntext{%
556 \rule\z@\footnotesep\ignorespaces#1\@finalstrut\strutbox}%
557 \color@endgroup}}
558 \gdef\split@prev{0}
559 \let\pagefootnoterule\footnoterule
560 \let\mpfootnoterule\footnoterule
561 \def\splitfootnoterule{\kern-3\p@ \hrule \kern2.6\p@}
562 \def\footnoterule{\relax
563 \ifx \@listdepth\@mplistdepth
564 \mpfootnoterule
565 \else
566 \ifnum\split@prev=\z@
567 \pagefootnoterule
568 \else
569 \splitfootnoterule
570 \fi
571 \xdef\split@prev{\the\insertpenalties}%
572 \fi
573 }
574 % \end{macrocode}
575 % \end{macro}
576 %
577 % \begin{macro}{\appendix}
578 %
579 % Renew the |\appendix| command to deal with spacing in appendices
580 % correctly
581 %
582 % \begin{macrocode}
583 \renewcommand\appendix{\par
584 \setcounter{chapter}{0}%
585 \setcounter{section}{0}%
586 \gdef\@chapapp{\appendixname}%
587 \gdef\thechapter{\@Alph\c@chapter}
588 \ifthenelse{\boolean{saving}}{\spacing{1}}{\spacing{2}}}
589 % \end{macrocode}
590 % \end{macro}
591 %
592 % \begin{macro}{\bibliography}
593 %
594 % Renew the |\bibliography| macro so that it puts in its own toc entry
595 %
596 % \begin{macrocode}
597 \renewenvironment{bibliography}[1]%
598 {\addcontentsline{toc}{chapter}{Bibliography}\oldbibliography {#1}}%
599 {\oldendbibliography}
600 % \end{macrocode}
601 % \end{macro}
602 %
603 % \begin{macro}{\printindex}
604 %
605 % Renew the |\printindex| macro so that it puts in its own toc entry
606 %
607 % \begin{macrocode}
608 \renewcommand{\printindex}{\newpage%
609 \addcontentsline{toc}{chapter}{Index}\oldprintindex}
610 % \end{macrocode}
611 % \end{macro}
612 %
613 % \begin{macro}{\hugeskip}
614 %
615 % Skip twice as much as the TeX command |\bigskip|
616 %
617 % \begin{macrocode}
618 \def\hugeskip{\vskip 24pt plus 8pt minus 8pt}
619 % \end{macrocode}
620 %
621 % \end{macro}
622 %
623 % \begin{macro}{\@ifdefined}
624 %
625 % Expand second argument if the command in the first argument is not
626 % defined
627 %
628 % \begin{macrocode}
629 \def\@ifdefined#1#2{\@ifundefined{#1}{}{#2}}
630 % \end{macrocode}
631 %
632 % \end{macro}
633 %
634 % \begin{macro}{\@makechapterhead}
635 %
636 % These macros are redefined here to use not-so-huge type and to
637 % provide chapters of form: N chaptername
638 %
639 % \changes{v1.5}{2003/09/20}{Changed appearance of chapter titles:
640 % removed \textsf{chaptername} and placed the section number on
641 % the same line as the label (suggested by Dave Makalsky)}
642 %
643 % \begin{macrocode}
644 \def\@makechapterhead#1{ \vspace*{50pt} { \parindent 0pt
645 \raggedright%
646 \ifnum \c@secnumdepth > \m@ne \Large\bf
647 \thechapter \hskip 1em \fi \Large \bf #1\par
648 \nobreak \vskip 40pt } }
649 \def\@makeschapterhead#1{ \vspace*{50pt} { \parindent 0pt \raggedright
650 \Large \bf #1\par
651 \nobreak \vskip 40pt }}
652 % \end{macrocode}
653 % \end{macro}
654 %
655 % \begin{macro}{\section}
656 %
657 % This section of code re-defines some standard stuff for sanity.
658 %
659 % \begin{macrocode}
660 \renewcommand\section{\@startsection {section}{1}{\z@}%
661 {-3.5ex \@plus -1ex \@minus -.2ex}%
662 {2.3ex \@plus.2ex}%
663 {\normalfont\large\bfseries}}
664 \renewcommand\subsection{\@startsection {subsection}{1}{\z@}%
665 {-3.5ex \@plus -1ex \@minus -.2ex}%
666 {2.3ex \@plus.2ex}%
667 {\normalfont\normalsize\bfseries}}
668 \renewcommand\subsubsection{\@startsection {subsubsection}{1}{\z@}%
669 {-3.5ex \@plus -1ex \@minus -.2ex}%
670 {2.3ex \@plus.2ex}%
671 {\normalfont\normalsize\bfseries}}
672 % \end{macrocode}
673 % \end{macro}
674 %
675 % We rename the headings for the toc, lof, and the references.
676 %
677 % \begin{macrocode}
678 \renewcommand\contentsname{Table of Contents}
679 \renewcommand\listfigurename{List of Figures}
680 \renewcommand\listtablename{List of Tables}
681 \renewcommand\bibname{Bibliography}
682 % \end{macrocode}
683 %
684 % We modify the definitions for the various contents headers
685 %
686 % \begin{macrocode}
687 \newcommand{\contentsheader}[2] { \addtocontents{#1} {
688 \centerline{\underline{#2}\protect\hfill%
689 \underline{Page}}}}
690 \renewcommand\tableofcontents { \chapter*{\contentsname}
691 \addcontentsline{toc}{chapter}{Table of Contents}
692 \@starttoc{toc}}
693 \renewcommand\listoffigures { \chapter*{\listfigurename}
694 \addcontentsline{toc}{chapter}{List of Figures}
695 \@starttoc{lof}}
696 \renewcommand\listoftables { \chapter*{\listtablename}
697 \addcontentsline{toc}{chapter}{List of Tables}
698 \@starttoc{lot}}
699 % \end{macrocode}
700 %
701 % \subsubsection{Margins and spacing}
702 %
703 % Rules taken from York FGS Guidelines for Theses and Dissertations
704 %
705 % The style guide, for the final deposited verrsion, requires 1.5in
706 % left and top margin and 1.0in right and bottom margins.
707 %
708 % If |\boolean{saving}| is true, set for draft; otherwise, set for
709 % final
710 %
711 % \begin{macrocode}
712 \ifthenelse{\boolean{saving}} {%
713 \setlength {\topmargin}{0.0in}
714 \setlength {\textheight}{\paperheight-2.5in}
715 \setlength {\oddsidemargin}{0.0in}
716 \setlength {\evensidemargin}{0.0in}
717 \setlength {\textwidth}{\paperwidth-2in}
718 \spacing{1}
719 } {%
720 \setlength {\topmargin}{0.65in}
721 \setlength {\textheight}{\paperheight-3.05in}
722 \setlength {\oddsidemargin}{0.6in}
723 \setlength {\evensidemargin}{0.1in}
724 \setlength {\textwidth}{\paperwidth-2.65in}
725 \setlength {\footskip}{0.3in}
726 \spacing{2}
727 % \end{macrocode}
728 %
729 % \begin{environment}{quote}
730 %
731 % \changes{v1.1}{2002/02/13}{changed \textsf{quote} environment for
732 % single spacing in \textsf{final}}
733 %
734 % \begin{macrocode}
735 \renewenvironment{quote}{\oldquote\spacing{1}}%
736 {\oldendquote\spacing{2}}
737 % \end{macrocode}
738 % \end{environment}
739 %
740 % \begin{environment}{quotation}
741 %
742 % \changes{v1.1}{2002/02/13}{changed \textsf{quotation} environment
743 % for single spacing in \textsf{final}}
744 %
745 % \begin{macrocode}
746 \renewenvironment{quotation}{\oldquotation\spacing{1}}%
747 {\oldendquotation\spacing{2}}
748 % \end{macrocode}
749 % \end{environment}
750 %
751 % \begin{environment}{verse}
752 %
753 % \changes{v1.1}{2002/02/13}{changed \textsf{verse} environment for
754 % single spacing in \textsf{final}}
755 %
756 % \begin{macrocode}
757 \renewenvironment{verse}{\oldverse\spacing{1}}%
758 {\oldendverse\spacing{2}}}
759 % \end{macrocode}
760 % \end{environment}
761 %
762 % Let's space the footnotes nicely and, since we have no headers,
763 % remove them from the page layout.
764 %
765 % \begin{macrocode}
766 \setlength {\footnotesep}{14pt}
767 \setlength {\headheight}{0in}
768 \setlength {\headsep}{0in}
769 % \end{macrocode}
770 %
771 % \subsubsection{Commands to define parameters for the front matter}
772 %
773 % There are two kinds of commands that define parameters for the front
774 % matter: macros that provide info (like |\author| or |\abstractfile|)
775 % and booleans that set flags.
776 %
777 % The following are the definitions of the macros that provide info
778 % (standard LaTeX commands like |\author| are omitted because they are
779 % already defined).
780 %
781 % \changes{v2.5}{2005/04/20}{added \textsf{degreename},
782 % \textsf{committeememberslist}}
783 %
784 % \begin{macrocode}
785 \def\department#1{\gdef\@department{#1}}
786 \def\masterof#1{\gdef\@masterof{#1}}
787 \def\abstractfile#1{\gdef\@abstractfile{#1}}
788 \def\dedicationfile#1{\gdef\@dedicationfile{#1}}
789 \def\acknowledgementsfile#1{\gdef\@acknowledgementsfile{#1}}
790 \def\prefacefile#1{\gdef\@prefacefile{#1}}
791 \def\abbreviationsfile#1{\gdef\@abbreviationsfile{#1}}
792 \def\committeememberslist#1{\gdef\@committeememberslist{#1}}
793 \def\degreename#1{\gdef\@degreename{#1}}
794 % \end{macrocode}
795 %
796 % The following are the initial values for some macros that provide
797 % info.
798 %
799 % \begin{macrocode}
800 \gdef\@author{YOUR FULL NAME} \gdef\@title{{\bf THE TITLE OF YOUR
801 WORK}} \gdef\@date{\number\year} \gdef\@department{PHILOSOPHY}
802 \gdef\@masterof{Arts} \gdef\@committeememberslist{%
803 \begin{enumerate}%
804 \item Joanne Examiner%
805 \item Fred P. Questioner%
806 \end{enumerate}}
807 \ifthenelse{\boolean{masters}}{\gdef\@degreename{MASTER}}%
808 {\gdef\@degreename{DOCTOR}}
809 % \end{macrocode}
810 %
811 % \subsubsection{Generate frontmatter}
812 %
813 % \begin{macro}{\makefrontmatter}
814 %
815 % What we want is a single macro that will generate all of the
816 % frontmatter of the document, such as, the title page, abstract,
817 % authenticity page, table of contents, etc.\@ Each page of the
818 % frontmatter is created by individual macros. This keeps things
819 % modular and tidy. Any sections of the frontmatter that are not
820 % declared are ignored.
821 %
822 % \changes{v1.1}{2002/02/13}{added a TOC entry for the Table of
823 % Contents}
824 % \changes{v3.6}{2011/06/13}{added code so that fancyhdr package could
825 % be used}
826 %
827 % \begin{macrocode}
828 \def\makefrontmatter{%
829 \pagestyle {empty}
830 \pagenumbering {roman}
831 \maketitlepage
832 \pagestyle {empty} \makecopyrightpage
833 \pagestyle {empty} \makeauthenticitypage
834 \setcounter {page} {3}
835 \@ifdefined {@abstractfile}{\makeabstract}
836 \pagestyle {fancy}
837 \@ifdefined {@dedicationfile}{\makededication}
838 \@ifdefined {@acknowledgementsfile}{\makeacknowledgements}
839 \tableofcontents
840 \ifthenelse{\boolean{hastables}}{\listoftables}{}
841 \ifthenelse{\boolean{hasfigures}}{\listoffigures}{}
842 \@ifdefined{@prefacefile}{\makepreface}
843 \@ifdefined{@abbreviationsfile}{\makeabbreviations}
844 \newpage
845 \pagenumbering {arabic}
846 \setcounter {page}{1}}
847 % \end{macrocode}
848 %
849 % \end{macro}
850 %
851 % \begin{macro}{\maketitlepage}
852 %
853 % The title page is standard. The guidelines require uppercase
854 % throughout, so I have forced this wherever necessary.
855 %
856 % \changes{v3.3}{2002/03/07}{removed the tabular environment from
857 % around the title macro. I still have the problem of not being able
858 % to force a line break inside the title macro.}
859 %
860 % \begin{macrocode}
861 \def\maketitlepage{
862 \vspace*{.85in}
863 \begin{center}
864 \spacing{1}
865 \textbf{\MakeUppercase{\@title}}
866 \hugeskip
867 \hugeskip
868 \hugeskip
869 {\bigskip \MakeUppercase{\@author}}
870 \end{center}
871 \hugeskip \hugeskip \hugeskip \hugeskip \hugeskip \hugeskip
872 {\spacing{1}
873 \begin{center}
874 \ifmasters A THESIS \else A DISSERTATION \fi
875 SUBMITTED TO THE FACULTY OF GRADUATE STUDIES \\
876 IN PARTIAL FULFILMENT OF THE REQUIREMENTS \\
877 FOR THE DEGREE OF \\
878 \hugeskip \hugeskip \hugeskip
879 \ifmasters \MakeUppercase{\@degreename} OF
880 \MakeUppercase{\@masterof}
881 \else
882 \MakeUppercase{\@degreename} OF PHILOSOPHY \fi \\
883 \hugeskip \hugeskip
884 GRADUATE PROGRAM IN \MakeUppercase{\@department} \\
885 YORK UNIVERSITY \\
886 TORONTO, ONTARIO \\
887 \MakeUppercase{\@date}
888 \end{center}}
889 \newpage }
890 % \end{macrocode}
891 % \end{macro}
892 %
893 % \begin{macro}{\copyrightpage}
894 %
895 % The copyright page has to be centred both left and right and up and
896 % down \textit{between the margins}. Not hard to do but a little bit
897 % of a pain to make come out just right.
898 %
899 % The author might be using the department generated copyright pages,
900 % but I have no idea if this is still a common practice. So, the
901 % copyright page is always generated.
902 %
903 % \begin{macrocode}
904 \def\makecopyrightpage{%
905 \begin{center}
906 \setlength{\fboxrule}{.004in} \setlength{\fboxsep}{2cm}
907 \mbox{}
908 \par\vspace*{\stretch{1}}
909 \fbox{\parbox{4in}{%
910 \spacing{1}
911 \begin{center}
912 \textbf{\MakeUppercase{\@title}}
913 \end{center} by
914 \textbf{\@author}
915
916 \bigskip
917 a \ifmasters thesis \else dissertation \fi submitted to the
918 Faculty of Graduate Studies of York University in partial
919 fulfilment of the requirements for the degree of
920 \begin{center}
921 \ifmasters \textbf{\MakeUppercase{\@degreename} OF
922 \MakeUppercase{\@masterof}}
923 \else
924 \textbf{\MakeUppercase{\@degreename} OF PHILOSOPHY} \fi \\
925 $\copyright$\ \number\year \\
926 \end{center}
927
928 Permission has been granted to: a) YORK UNIVERSITY LIBRARIES
929 to lend or sell copies of this dissertation in paper,
930 microform or electronic formats, and b) LIBRARY AND ARCHIVES
931 CANADA to reproduce, lend, distribute, or sell copies of this
932 \ifmasters thesis \else dissertation \fi anywhere in the world
933 in microform, paper or electronic formats \textit{and} to
934 authorise or procure the reproduction, loan, distribution or
935 sale of copies of this \ifmasters thesis \else dissertation
936 \fi anywhere in the world in microform, paper or electronic
937 formats.
938
939 \bigskip The author reserves other publication rights, and
940 neither the \ifmasters thesis \else dissertation \fi nor
941 extensive extracts for it may be printed or otherwise
942 reproduced without the author's written permission.}}
943 \vspace*{\stretch{1}}
944 \end{center}
945 \newpage}
946 % \end{macrocode}
947 % \end{macro}
948 %
949 % \begin{macro}{\makeauthenticitypage}
950 %
951 % This page is used in lieu of a Certificate page when the thesis or
952 % dissertation is being deposited electronically. Now that we can do
953 % this, I have no idea why anyone \textit{wouldn't} submit
954 % electronically. As such, we will always have an authenticity
955 % page. If you don't like it, throw it away and stick a certificate
956 % page in.
957 %
958 % \begin{macrocode}
959 \def\makeauthenticitypage{%
960 \par\vfill
961 {\spacing{1}
962 \begin{center}
963 \textbf{\MakeUppercase{\@title}} \hugeskip\hugeskip by
964 \textbf{\@author}
965 \end{center}
966 \hugeskip\noindent By virtue of submitting this document
967 electronically, the author certifies that this is a true
968 electronic equivalent of the copy of the \ifmasters thesis \else
969 dissertation \fi approved by York University for the award of
970 the degree. No alteration of the content has occurred and if
971 there are any minor variations in formatting, they are as a
972 result of the coversion to Adobe Acrobat format (or similar
973 software application). \hugeskip
974 \begin{flushright}
975 \begin{minipage}[t]{4in}
976 Examination Committee Members: \@committeememberslist
977 \end{minipage}
978 \end{flushright}}}
979 % \end{macrocode}
980 % \end{macro}
981 %
982 % \begin{macro}{\makeabstract}
983 %
984 % The abstract page is pretty standard. It sets up a toc entry, starts
985 % a new chapter, and forces a non-indented first paragraph.
986 %
987 % \begin{macrocode}
988 \def\makeabstract{%
989 \chapter*{Abstract}
990 \addcontentsline {toc}{chapter}{Abstract}
991 \noindent
992 \@input{\@abstractfile}}
993 % \end{macrocode}
994 % \end{macro}
995 %
996 % \begin{macro}{\makededication}
997 %
998 % \changes{v3.2}{2006/01/31}{Added the \textsf{makededication} and
999 % \textsf{dedicationfile} macro.}
1000 %
1001 % The dedication page is pretty simple. It just sets whatever is in
1002 % your dedication.tex file.
1003 %
1004 % \begin{macrocode}
1005 \def\makededication{%
1006 \newpage
1007 \@input{\@dedicationfile}}
1008 % \end{macrocode}
1009 % \end{macro}
1010 %
1011 % \begin{macro}{\makepreface}
1012 %
1013 % We need to include the preface file, if specified
1014 %
1015 % \changes{v2.0}{2004/05/13}{Added prefacefile support}
1016 %
1017 % \begin{macrocode}
1018 \def\makepreface{%
1019 \chapter*{Preface}
1020 \addcontentsline {toc}{chapter}{Preface}
1021 \noindent
1022 \@input{\@prefacefile}}
1023 % \end{macrocode}
1024 % \end{macro}
1025 %
1026 % \begin{macro}{\makeabbreviations}
1027 %
1028 % This page will probably be rarely used. If you have a lot of
1029 % references from one or two authors, sometimes it is clearer to use
1030 % an abbreviation rather than the sometimes cryptic in-line
1031 % citation. This is the page where you provide the legend.
1032 %
1033 % I have found this particularly useful in conjunction with
1034 % \texttt{natbib}'s |\citepalias| and |\citetalias| macros.
1035 %
1036 % \begin{macrocode}
1037 \def\makeabbreviations{%
1038 \chapter*{Abbreviations}
1039 \addcontentsline{toc}{chapter}{Abbreviations}
1040 \noindent
1041 \@input{\@abbreviationsfile}}
1042 % \end{macrocode}
1043 % \end{macro}
1044 %
1045 % \begin{macro}{\makeacknowledgements}
1046 %
1047 % \begin{macrocode}
1048 \def\makeacknowledgements{%
1049 \chapter*{Acknowledgements}
1050 \addcontentsline{toc}{chapter}{Acknowledgements}
1051 \noindent
1052 \@input{\@acknowledgementsfile}}
1053 % \end{macrocode}
1054 % \end{macro}
1055 %
1056 % \subsubsection{Other new commands and environments}
1057 %
1058 % \begin{environment}{epigraphs}
1059 % \begin{macro}{\epigraph}
1060 %
1061 % Constructed with stolen code from epigraph.sty by Peter Wilson
1062 % (pandgwilson at earthlink dot net)
1063 %
1064 % This is simple: |\epigraph| macros go in an |epigraphs| environment
1065 %
1066 % \changes{v3.0}{2005/05/21}{Set \textsf{epigraphwidth} to .8 of the
1067 % \textsf{columnwidth} rather than the \textsf{textwidth}}
1068 %
1069 % \changes{v3.1}{2005/07/27}{Make \textsf{epigraphs} environment
1070 % single-spaced in all output modes.}
1071 %
1072 % \begin{macrocode}
1073 \newlength{\epigraphwidth}\setlength{\epigraphwidth}{.8\columnwidth}
1074 \newlength{\epigraphrule}\setlength{\epigraphrule}{.4\p@}
1075 \newcommand{\@epirule}{\rule[.5ex]{\epigraphwidth}{\epigraphrule}}
1076 \newcommand{\epigraph}[2]%
1077 {\item #1\vspace{-12pt}\begin{flushright}#2\end{flushright}}
1078 \newcommand{\epigraphlabel}[1]{\hfill}
1079 \newenvironment{epigraphs}{%
1080 \begin{flushright}
1081 \begin{minipage}{\epigraphwidth}
1082 \list{}%
1083 {\itemindent\z@ \labelwidth\z@ \labelsep\z@
1084 \leftmargin\z@ \rightmargin\z@
1085 \let\makelabel\epigraphlabel}}%
1086 {\endlist\vspace{-18pt}\@epirule\vspace{24pt}\end{minipage}\end{flushright}}
1087 \let\oldepigraphs\epigraphs \let\oldendepigraphs\endepigraphs
1088 \ifthenelse{\boolean{saving}}{}{%
1089 \renewenvironment{epigraphs}{\oldepigraphs\spacing{1}}%
1090 {\oldendepigraphs\spacing{2}}
1091 }
1092 % \end{macrocode}
1093 % \end{macro}
1094 % \end{environment}
1095 %
1096 % \begin{environment}{fquote}
1097 %
1098 % The |fquote| environment corrects for line spacing and indentation
1099 % when used inside a |\footnote|.
1100 %
1101 % \changes{v2.0}{2004/05/13}{Added \textsf{fquote} environment for
1102 % footnotes}
1103 %
1104 % \begin{macrocode}
1105 \newenvironment{fquote}%
1106 {\oldquote\footnotesize}%
1107 {\oldendquote\normalsize}
1108 % \end{macrocode}
1109 % \end{environment}
1110 % \begin{environment}{fquotation}
1111 %
1112 % The |fquotation| environment corrects for line spacing and indentation
1113 % when used inside a |\footnote|.
1114 %
1115 % \changes{v2.0}{2004/05/13}{Added \textsf{fverse} environment for
1116 % footnotes}
1117 %
1118 % \begin{macrocode}
1119 \newenvironment{fquotation}{\oldquotation\footnotesize}%
1120 {\oldendquotation\normalsize}
1121 % \end{macrocode}
1122 % \end{environment}
1123 % \begin{environment}{fverse}
1124 % The |fverse| environment corrects for line spacing and indentation
1125 % when used inside a |\footnote|.
1126 %
1127 % \changes{v2.0}{2004/05/13}{Added \textsf{fverse} environment for
1128 % footnotes}
1129 %
1130 % \begin{macrocode}
1131 \newenvironment{fverse}{\oldverse\footnotesize}%
1132 {\oldendverse\normalsize}
1133 % \end{macrocode}
1134 % \end{environment}
1135 %
1136 % \begin{macro}{\threestars}
1137 % The |threestars| macro gives a centred set of three asterisks for
1138 % use at the end of a section near the end of a chapter so that a
1139 % new `concluding' section need not be used.
1140 %
1141 % \changes{v3.1}{2005/07/27}{Added \textsl{threestars} macro}
1142 %
1143 % \begin{macrocode}
1144 \newcommand{\threestars}{\begin{center}%
1145 *\hspace{.5in}*\hspace{.5in}*\hspace{.5in}\end{center}}
1146 % \end{macrocode}
1147 % \end{macro}
1148 %
1149 % \Finale
1150 % \newpage
1151 % \appendix
1152 %
1153 % \section{The york-thesis-Template.tex File}
1154 %
1155 % This is a listing of a sample master document for your thesis or
1156 % dissertation. I recommend placing chapters and appendices in
1157 % separate files (like I force you to do for your abstract, preface,
1158 % acknowledgements, and abbreviations). This makes everything more
1159 % manageable from an editor point of view (you are scrolling through
1160 % thousands of lines) and makes typesetting parts of the document much
1161 % easier.
1162 %
1163 % \lstinputlisting[language=TeX,basicstyle={\footnotesize}]{york-thesis-Template.tex}
1164 \endinput