summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/nddiss/nddiss2e.dtx
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/nddiss/nddiss2e.dtx')
-rw-r--r--Master/texmf-dist/source/latex/nddiss/nddiss2e.dtx1820
1 files changed, 1064 insertions, 756 deletions
diff --git a/Master/texmf-dist/source/latex/nddiss/nddiss2e.dtx b/Master/texmf-dist/source/latex/nddiss/nddiss2e.dtx
index 0b6103b3afa..6d1ec98b056 100644
--- a/Master/texmf-dist/source/latex/nddiss/nddiss2e.dtx
+++ b/Master/texmf-dist/source/latex/nddiss/nddiss2e.dtx
@@ -13,7 +13,7 @@
% \fi
%
%
-% \CheckSum{1260}
+% \CheckSum{1478}
% \CharacterTable
% {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
% 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
@@ -42,7 +42,15 @@
% \texttt{numrefs} and \texttt{textrefs} to allow different kinds of citation
% styles, added some more macros and modified others,
% changed the titlepage a bit, completed source documentation}
-%
+% \changes{v3.2013$\beta$}{2013/1/14}{Initial release of updates in order to comply with
+% the Graduate School's current formatting regulations and to take advantage
+% of some LaTeX package updates. Should be functional, and has been approved
+% by the Dissertation/Thesis editors, but has not undergone wide-scale testing. - Megan Patnott}
+% \changes{v3.2013}{2013/4/20}{Some bug fixes, minor changes in documentation, and addition of support for parts. - MP}
+% \changes{v3.2016}{2016/10/16}{Fix natbib/showkeys ordering bug}
+% \changes{v3.2017.1}{2017/05/09}{Display (CONTINUED) on multipage long table captions}
+% \changes{v3.2017.2}{2017/08/23}{Add LuaLaTeX support. Allow non-capitalized titles.}
+% \renewcommand{\generalname}{Update}
%
% \iffalse (Don't show this in the doc).
% \begin{macrocode}
@@ -54,8 +62,8 @@
\DeclareRobustCommand{\nddiss}{%
\textsf{{\scshape nd}diss}\kern-0.03em%
2$_\mathsf{\textstyle\varepsilon}$}
-\providecommand{\dissfileversion}{3.0}
-\providecommand{\dissfiledate}{2005/07/27}
+\providecommand{\dissfileversion}{3.2017.2}
+\providecommand{\dissfiledate}{2017-05-09}
\DisableCrossrefs
\CodelineNumbered
\RecordChanges
@@ -69,485 +77,490 @@
% \title{The \nddiss\/ class\thanks{Version~\dissfileversion,%
% dated~\dissfiledate.}}
%
-% \author{Sameer Vijay\thanks{Inspiration from an
-% earlier {\sffamily NDThesis} class by D. A. Peterson}\\
-% }
% \date{\dissfiledate}
%
% \maketitle
%
% \begin{abstract}
-% This \nddiss\space class is based on the standard \LaTeXe\/ \textsf{book}
-% class and is an extensive rewrite of the earlier \textsf{NDthesis} class
-% file, incorporating changes for \LaTeXe\space and pdf\LaTeX\space as well
-% as many other improvements. This class conforms with the requirements of the
-% Graduate School guidelines published in Spring 2004 for the layout of the Ph.D.
-% dissertations and Master's theses. In reading this documentation you will
-% find that I assume that the
-% reader has working knowledge of \LaTeXe\/.
+% The \nddiss\space class can be used to typeset dissertations submitted
+% to the University of Notre Dame's Graduate School. This class conforms with
+% the Graduate School guidelines as of Spring 2013 for the layout of the Ph.D.
+% dissertations and Master's theses.
% \end{abstract}
%
% \tableofcontents
%
% \section{Introduction}
% \label{sec:intro}
-% This document describes the \LaTeXe\space document class \nddiss,
-% suitable\footnote{In my opinion, but with no guarantee that you or other users
-% will agree. I shall not be liable for any consequence, good or bad,
-% of anyone's use of this software.} for producing dissertations and
-% theses according to the Spring 2004 guidelines of the Graduate School at the
-% University of Notre Dame. The latest version of this class and
-% related documentation should be
-% available at \url{http://www.gsu.nd.edu} or at
-% \url{http://graduateschool.nd.edu}.
+% The \LaTeXe\space document class \nddiss\ is suitable for producing dissertations
+% and theses conforming to the Spring 2013
+% guidelines of the Graduate School at the University of Notre Dame.
+% The package is extends the standard \LaTeX\/ \textsf{book} class.
+%
+% The latest version of this class and related documentation can be found
+% in a few places:
+% \begin{itemize}
+% \item On CTAN: \url{https://ctan.org/pkg/nddiss}
+% \item On GitHub: \url{https://github.com/ndlib/nddiss}
+% \item On the University of Notre Dame's Graduate School website: \url{http://graduateschool.nd.edu/}
+% \end{itemize}
%
% \subsection{Disclaimer}
% \label{sec:disclaimer}
-% It could be thought of as suspicious if I begin with a disclaimer, but it is
-% important for you to keep in mind that only
-% {\em You} are responsible for the correct formatting of the document
-% even though use of this class simplifies this task considerably. There
-% are certain formatting things which need to be done manually and are
-% described later in section \ref{sec:author}.
-% As such, this class and its associated
-% documentation {\em must not} be assumed to be a replacement of the
-% formatting guide from the Graduate School and the official guide must be
-% consulted, in case of doubt.
-%
-% In short, no one but you (the user) accepts any responsibility for works
-% that do not get approved by the Graduate School. Use of the
-% \nddiss\space class file implicitly states acceptance of this policy. Having
-% said that, a document produced by using this class (as described in the
-% following sections) has a pretty good likelyhood
-% of being accepted as it is.
+% While this class does as much formatting as it can, there are a few formatting items that
+% you, the user, must do manually (see Section \ref{sec:author}).
+% Please keep in mind that only \emph{you} are responsible for the
+% correct formatting of your dissertation/thesis.
+% Should you have questions, please consult the official formatting guide or email \url{dteditor@nd.edu}.
%
% \subsection{Dependencies and Limitations}
% \label{sec:deps}
-% This classfile depends on many other packages to be present in either
-% the |TEXMF| tree (system or local) or the \LaTeX\space search path (defined by shell variable
-% \verb+$TEXINPUTS+). A list of the essential packages is mentioned in section \ref{sec:features}.
-%
-% Although I have tested it with \LaTeX\space
-% [2001/06/01], it should be backwards compatible with \LaTeX\space
-% [1995/12/01] and higher
-% as well. It is not possible for me to list the version of each
-% package used within the class file and you might get errors if the package in
-% your |TEXMF| tree is outdated.
-%
-% The classfile is limited in the sense that it will produce an acceptable
-% document with the packages that I have tried and included by default. There
-% are numerous packages you may want to use for your work, but they may have
-% to be modified accordingly. Things lacking include support
-% for {\sffamily subfigure} package and proper formatting of the captions in
-% such an environment. Formatting of the captions could be much easier with the
-% new {\sffamily caption}\footnote{\textsf{caption} package by Axel
-% Sommerfeldt v3.0b[2004/05/16] and higher}
-% in general, and is a thing-to-do for future versions.
+% This classfile depends on many other packages to be installed.
+% All of these required packages are available through MiKTeX and TeXLive, and
+% chances are good they are already installed by your TeX distribution.
+% Refer to section \ref{sec:features} for a list of the essential packages.
+%
+% The document class has only been tested with a small subset of available packages.
+% There are numerous packages you may want to use for your work, but they may have
+% to be modified accordingly.
+% Things lacking include support for the \textsf{subfigure}
+% and \textsf{subcaption} package and proper formatting of the captions in such an environment.
+% Formatting of the captions could be much easier with the
+% \textsf{caption}\footnote{\textsf{caption} package by Axel Sommerfeldt v3.0b[2004/05/16]
+% and higher} in general, and is a thing-to-do for future versions. Permitting use of the
+% \textsf{subfigure} and \textsf{subcaption} packages would also be a good thing to do
+% if an update is ever made for reaosns other than resolving conflicts caused by changing
+% Graduate School regulations. If you want to use a \textsf{subfigure} environment and don't
+% need the caption capabilities of the \textsf{subcaption} package, adding the following
+% code to your preamble may allow you to do this and still have your captions formatted
+% according to the Graduate School's rules.
+% \begin{verbatim}
+% \usepackage{subcaption}
+% \makeatletter
+% \renewcommand\LT@makecaption[3]{%
+% \LT@mcol\LT@cols c{\hbox to\z@{\hss\parbox[t]\LTcapwidth{%
+% \vskip\abovetableskip%
+% \centering\normalspacing
+% #1{#2 }\\[\single@skip]
+% {#3}\par
+% \endgraf\vskip\belowtableskip}%
+% \hss}}}
+% \makeatother
+% \end{verbatim}
+%
+% \subsection{History}
+%
+% The \nddiss\ package is an extensive rewrite by Sameer Vijay of an earlier \textsf{NDthesis} class
+% for formatting dissertations.
+% Megan Patnott updated \nddiss\ to the 2013 Graduate School Formatting guidelines.
+% The \textsf{NDThesis} class was by D. A. Peterson.
+%
+% \section{Quick Start}
+%
+% This section provides a template you can use to get started.
+% The distribution comes with a more detailed file, |template.tex|, that is similar, but more detailed.
+%
+% \begin{verbatim}
+% \documentclass[numrefs,final]{nddiss2e}
+%
+% \begin{document}
+%
+% \frontmatter
+%
+% \title{Title in Title Caps}
+% \author{Your Name}
+% \work{Dissertation}
+% \degaward{Doctor of Philosophy}
+% \advisor{}
+% \department{}
+% \maketitle
+% \makepublicdomain % There is also a copyright option
+%
+% \begin{abstract}
+% Abstract here
+% \end{abstract}
+%
+% % dedication is optional
+% \begin{dedication}
+% For Someone
+% \end{dedication}
+%
+% \tableofcontents
+% \listoffigures
+% \listoftables
+%
+% % list of symbols is optional
+% \begin{symbols}
+% \sym{a}{definition of a}
+% \end{symbol}
+%
+% % preface is optional
+% \begin{preface}
+% Preface here
+% \end{preface}
+%
+% \begin{acknowledge}
+% Thanks to everyone
+% \end{acknowledge}
+%
+% \mainmatter
+%
+% \chapter{A New Dawn} % Chapter 1
+% All the text ...
+%
+% \appendix
+% \chapter{Additional Data} % Appendix A
+%
+% \backmatter
+% \bibliographystyle{nddiss2e}
+% \bibliography{bibdatabase}
+%
+% \end{document}
+% \end{verbatim}
%
%
% \section{Usage}
%
-% The \nddiss\space document class can be used only with \LaTeXe\space native mode or
-% later, by typing |\documentclass|\oarg{options}|{nddiss2e}| at the
-% beginning of your \LaTeX\space source file. The available options for
-% the use of the class are discussed in section \ref{subsec:options} below.
-% These have been limited to a small number in order to obtain documents
-% with similar formatting under \LaTeXe\space using this class, although the
-% \nddiss\space class is based on the \textsf{book} class,
-% which has many other options.
+% Invoke the \nddiss\space document class by adding |\documentclass|\oarg{options}|{nddiss2e}|
+% at the beginning of your \LaTeX\space source file.
+% For most people the options |\documentclass[draft]{nddiss2e}| is good enough for the initial revisions.
+% If you want your figures to display, use |\documentclass[review]{nddiss2e}|.
%
-% \subsection{Options}
-% \label{subsec:options}
+% Use the option |\documentclass[final]{nddiss2e}| for your formatting check submission,
+% and |\documentclass[final,noinfo]{nddiss2e}| for the final submitted version.
+%
+% If you have two advisors, add the option |twoadvisors| here, and then use |\secondadvisor{}|
+% later on the title page to give the name of the second advisor.
%
% By default, all documents produced using this class
-% are formatted in |letterpaper| size and |onesided|,
-% |doublespaced| mode, as per
-% the requirements of the Graduate School. If you wish to override these
-% restrictions, appropriate changes to the class file
-% would be needed.
+% are formatted as one-sided, doublespaced, letter-sized pages, per the Graduate School requirements.
+% In theory, the class file's specifications should override your system's defaults.
+% If, however, you are getting A4 paper, try adding |\pdfpagewidth{8.5in}| and
+% |\pdfpageheight{11in}| immediately after the |\documentclass| in your file.
%
-% The most important of the options is |draft|, |review| or
-% |final|. Exactly one of
-% these {\em must} be used, otherwise you would surely get errors.
+% \subsection{Options}
+% \label{subsec:options}
%
% \DescribeMacro{draft}
-% Using |draft| option will enable the {\it draft} mode of the
-% |book| class, thus making the processing of the document
-% faster. As a result of this, the most visible change is that instead of the
-% included figure, only its placement box is displayed. An appropriate header
-% is included to indicate that the prepared document is a draft document. The
-% purpose of the |draft| option is to obtain a fast and preliminary
-% document showing the labels for citations, tables, figures etc. and a black
-% solid rule highlighting the horizontal overflows. Such a document would be
-% the one you would prepare for revising your text during writing stages.
-%
% \DescribeMacro{review}
+% \DescribeMacro{final}
+% Exactly \emph{one} of these options must be used.
+% The |draft| and |review| options enable faster processing of the document and
+% also include annotations to help write and edit it.
+%
+% The |draft| option enables a fast processing and preliminary document
+% showing the labels for citations, tables, figures etc. and a black solid rule
+% highlighting the horizontal overflows. Additionally, figures are replaced
+% with placement boxes showing where the included figure would be placed. Such
+% a document would be the one you would prepare for revising your text during
+% writing stages.
+%
% The |review| option makes it possible to prepare a document that is
-% one step closer to the final version. Almost all the formatting of final
-% version is present, along with the labels and keys as in the |draft|
-% option. A document prepared with |review| option would be the one to
-% check for proper formatting and giving to your advisor if (s)he wished to
-% suggest corrections.
+% one step closer to the final version.
+% Almost all the formatting of the final version is present,
+% but the labels and keys as in the |draft| option are also displayed.
+% A document prepared with the |review| option would be the one to
+% personally check for proper formatting and possibly giving to your advisor if
+% she wished to suggest corrections.
%
-% \DescribeMacro{final}
-% The |final| style option will produce the
-% document for the production of archival
-% copies of the dissertation for submission to the Graduate School.
+% The |final| option produces the document to be submitted to the Graduate School for
+% formatting checks and as the final version.
%
% \DescribeMacro{twoadvisors}
-% If you have more than one advisor for your project/research, selecting the
-% |twoadvisors| option
-% would produce an appropriately formatted titlepage. The |\secondadvisor|
-% macro command is used to specify the name of the second advisor.
+% The |twoadvisors| option will produce a title page with space for two advisors.
+% Use the |\secondadvisor| macro command
+% (discussed in Section \ref{subsec:titlepage}) on the title page to give the
+% name of the second advisor.
+%
+% \DescribeMacro{noinfo}
+% The |noinfo| option disables the information page produced
+% when the |review| or |final| style options are used. It is
+% recommended that you only use this option when making the final
+% submission to the Graduate School.
%
% \DescribeMacro{numrefs}
% \DescribeMacro{textrefs}
-% Exactly one of these options -- |numrefs| or |textrefs|,
-% needs to be specified. |numrefs| results in a
-% numbered citation sytle with {\sffamily natbib} and ``nddiss2e'' citation style
+% These options determine how citations are displayed in the text.
+% The default style is |numrefs|.
+% The |numrefs| option produces a numbered citation sytle by using \textsf{natbib}
+% and the ``nddiss2e'' or ``nddiss2enoarticletitles'' citation style
% file\footnote{|nddiss2e.bst| is a slight modificiation of |abbrvnat.bst|
-% in the {\sffamily natbib} package}.
-% Using |textrefs| changes the citation style to be similar to
-% ``author-date'' style with the same files. If none of these options is
-% specified, the default style of numbered citations (ie.\/ same as if
-% |numrefs| was used) is used.
-%
-% Since the same set of package and
-% style file results in differing citation format, it is {\em strongly}
-% suggested to
-% refer to the documentation |natnotes.dvi| in your |TEXMF| tree,
+% in the \textsf{natbib} package; |nddiss2enoarticletitles.bst| is
+% essentially the same as |nddiss2e|, but does not display the titles of
+% journal articles, as this is the standard in some fields}.
+% The |textrefs| option changes the citation style to be similar to
+% ``author-date'' style with the same files.
+%
+% \DescribeMacro{sort}
+% \DescribeMacro{compress}
+% \DescribeMacro{sort\&compress}
+% At most one of these options should be selected. The |sort| option will cause
+% both numerical and ``author-date'' style references to be sorted in the order
+% that they appear in the bibliography when multiple references are cited. The
+% |compress| option compresses numerical citations, e.g. it turns [1,2,3] into
+% [1-3], and does nothing to ``author-date'' style references. The
+% |sort&compress| option first sorts and then compresses numerical references, and
+% only sorts ``author-date'' style references.
+%
+% Since the same set of packages and
+% style files result in differing citation formats,
+% refer to the documentation for |natnotes.dvi| in your |TEXMF| tree,
% to be aware of the
% various ways in which you can make a citation in your text.
%
% \DescribeMacro{10pt}
% \DescribeMacro{11pt}
% \DescribeMacro{12pt}
-% The choice of the fontsize is only applicable with the |draft| option
-% used. By default, the document will be prepared in the 10pt size for the
-% |draft|
-% style option. For the |review| and the |final| style options,
-% the document is prepared in the 12pt fontsize and choosing any other fontsize
-% option will be ignored.
-%
-% \DescribeMacro{noinfo}
-% Using the |noinfo| option would disable the information page produced
-% when the |review| or |final| style options are used. It is
-% recommended that you do not disable the ``info'' page unless it is the final
-% most copy/copies for submission to the Graduate School.
-%
-% Thus, |\documentclass[draft,12pt]{nddiss2e}| would produce a document in
-% \textsf{draft} format in 12pt font size and \\
-% |\documentclass[final,twoadvisors]{nddiss2e}|
-% would produce a document (with modified title page) for final submission
-% to the Graduate School.
-%
-% \section{Features}
-% \label{sec:features}
-% A number of packages are required by default and must be present in your
-% \TeX\space search path. As far as possible, these have been tested for proper
-% formatting style with the \nddiss\/ class file. The list includes
-% \textsf{ifthen},
-% \textsf{exscale},
-% \textsf{xspace},
-% \textsf{longtable},
-% \textsf{indentfirst},
-% \textsf{tabularx},
-% \textsf{showkeys},
-% \textsf{enumerate},
-% \textsf{latexsym}.
-% \textsf{epsfig},
-% \textsf{color},
-% \textsf{graphicx},
-% \textsf{url},
-% \textsf{setspace}\footnote{v6.7[2000/12/01] or above},
-% \textsf{amsmath},
-% \textsf{amssymb},
-% \textsf{float},
-% \textsf{lscape},
-% \textsf{rotating},
-% \textsf{booktabs} and
-% \textsf{natbib}.
-% I urge you to read the documentation of these packages available in
-% the |TEXMF| tree, if you think you might use their features
-% or want to tweak some advanced options.
-%
-% Other packages may or may not be appropriate for use with the
-% \nddiss\space class when producing copies to be submitted to the
-% Graduate School. Please be careful when using packages that change the
-% default fonts, or the layout(s).
-%
-% In general, the official guidelines of the Graduate School are
-% followed to as much extent as possible. This includes proper
-% formatting of the title page and the abstract page (from the
-% \textsf{ndthesis} package), numbering of the pages in the {\it
-% frontmatter}, generation of properly formatted table of contents, list
-% of figures etc., as well as bibliography at the end. As per the guide,
-% number of different fonts and font sizes used in the thesis is kept to
-% a minimum. The contents, all lists and the bibliography are
-% single-spaced but the inter-line spacing for the rest of the document
-% is double.
-%
-% \subsection{Generating PDF document}
-% \label{subsec:pdfdoc}
-%
-% The \nddiss\space class also allows production of pdf documents with
-% pdf\LaTeX\space. In this case, the \textsf{hyperref} and
-% \textsf{hypernat} packages are also required. These packages ensure
-% that the generated pdf document contains internal as well as external
-% links for citations and bookmarks. A document produced by this method
-% also contains embedded fonts ({\it press quality} pdf) and is suitable
-% for electronic submission to the library and for microfilm archiving.
-% Although the most appropriate options for the \textsf{hyperref} are
-% passed on, for advanced features refer to its documentation.
-%
-% For creating documents with figures, it is imperative that these are
-% present in a pdf-like format (eg.\/ pdf or metapost) rather than
-% the usual encapsulated postscript (eps)
-% format. An easy way to convert your {\it eps} files to {\it pdf} files
-% is to use the utility |epstopdf| or |eps2pdf|, which should be
-% available on your unix-like distribution already.
+% These options adjust the font size of the body text.
+% The choice is only applicable when the |draft| option is used, and defaults
+% to |10pt|.
+% When |review| or |final| is used, this option is ignored and |12pt| is used.
+%
+% \DescribeMacro{twoside}
+% The |twoside| option causes the class file to prepare a document meant
+% to be printed double-sided.
+% This option is strictly for if you want to prepare a two-sided document for
+% your own use. The only difference from the one-sided document is in the page
+% layout.
+% Do NOT use this option when preparing to submit it to the Graduate School.
+%
+% \DescribeMacro{nocenter}
+% The |nocenter| option allows non-centered chapter titles.
+% Do NOT turn in your document this way to the Graduate School!
+%
+% \DescribeMacro{openbib}
+% The |openbib| option formats your bibliography in the following manner: \\
+% \qquad Author \\
+% \qquad \qquad Article/book title \\
+% \qquad \qquad Other information \\
+% \qquad \qquad Website, if applicable \\
+% Usually you would not need to use this option since the default layout of the
+% |bibliography| is acceptable.
%
-% \section{Arrangement of contents}
+% \section{Arrangement of Contents}
%
-% A dissertation or a thesis document must contain the following parts,
-% in the order listed. Only those explicitly marked as optional may be
-% omitted. Again, I must point out that the official guide must be
-% referred and its guidelines override the order listed here.
+% A dissertation or a thesis document contains the following parts,
+% in the order listed. Only those marked as optional may be omitted.
%
% \begin{enumerate}
% \item Title Page
% \item Copyright page
-% \item Abstract {\em (optional for Master's thesis)}
-% \item Dedication {\em(optional)}
+% \item Abstract \emph{(optional for Master's thesis)}
+% \item Dedication \emph{(optional)}
% \item Table of Contents
% \item List of Figures
% \item List of Tables
-% \item List Symbols {\em (optional)}
-% \item Preface {\em (optional)}
-% \item Acknowledgments {\em (optional)}
+% \item List of Symbols \emph{(optional)}
+% \item Preface \emph{(optional)}
+% \item Acknowledgments \emph{(optional)}
% \item Text
-% \item Appendix (or Appendices) {\em (optional)}
+% \item Appendix (or Appendices) \emph{(optional)}
% \item Bibliography (or References, or Works cited)
% \end{enumerate}
%
% The macros and environments described below ease the formatting of these
% parts.
%
-% \subsection{Title page}
+% \subsection{Title Page}
+% \label{subsec:titlepage}
%
-% The title page is generated by the standard
-% \LaTeX\space macro |\maketitle| with no arguments.
-% This macro has been modified for providing a title page format
-% required for dissertations/theses.
+% \DescribeMacro{\maketitle}
+% The title page is generated by |\maketitle| with no arguments.
+% This macro has been modified for providing a title page in the correct format.
%
-% Prior to invoking it in
-% your document, you should declare --
+% You can set information to display on the title page by using the following
+% commands before invoking |\maketitle|.
% \begin{itemize}
-% \item \DescribeMacro{\title\{\}} the title of the document using the
-% |\title| macro (note: title must be in ALL caps, eg.
-% |\title{THIS IS \||\ A TITLE IN TWO LINES}|, and you may use
-% linebreaks within the title),
-% \item \DescribeMacro{\author\{\}} your name (full and exactly as
-% registered with the Graduate School) with the
-% |\author| macro, (eg. |\author{Gary Graham Gordon-Graeme}|),
-% \item \DescribeMacro{\work\{\}} whether the document is a {\em Thesis} or a {\em
-% Dissertation} as
-% argument of |\work| macro, (eg. |\work{Dissertation}|),
-% \item \DescribeMacro{\degaward\{\}} the degree you're aiming for (in
-% full) with the |\degaward| macro, (eg. |\degaward{Doctor of Philosophy}| or
-% |\degaward{Master of Science\\in\\Engineering}|),
-% \item \DescribeMacro{\degprior\{\}} all your prior degrees to go with your name
-% with |\degprior| macro, (eg. |\degprior{B. S., M. S.}|),
-% \item \DescribeMacro{\advisor\{\}} the name of your advisor as argument to
-% |\advisor| macro,
-% \item \DescribeMacro{\secondadvisor\{\}} the name of second advisor, if any, with
-% |\secondadvisor| macro \footnote{this macro is necessary when,
-% \textsf{twoadvisors} option is used while invoking \nddiss\space class},
-% \item \DescribeMacro{\department\{\}} the name of the department in the
-% argument of the |\department| macro,
-% (eg. |\department{Gnulogical Engineering}|) and,
-% \item \DescribeMacro{\degdate\{\}} the month and year of the defense of the
-% thesis with the |\degdate| (eg. |\degdate{June 2004}|). If you forget to
-% declare this, the current month/year combination will be automatically used.
+% \item \DescribeMacro{\title\{\}} The title of the document, using the
+% |\title| macro. You may use linebreaks within the title,
+% protected via |\protect\\| and the title may be up to four
+% lines long.
+% \item \DescribeMacro{\author\{\}} Give your name in full and exactly as
+% registered with the Graduate School, using the
+% |\author| macro, e.g. |\author{Gary Graham Gordon-Graeme}|).
+% \item \DescribeMacro{\work\{\}} Whether the document is a
+% \emph{Thesis} or a \emph{Dissertation} as the argument of the
+% |\work| macro, e.g. |\work{Dissertation}|).
+% \item \DescribeMacro{\degaward\{\}} Specify the degree you're aiming for
+% with the |\degaward| macro. Should be one of
+% |\degaward{Doctor of Philosophy}| (without the ``in \emph{subject}'' or
+% |\degaward{Master of Science\\in\\Engineering}|.
+% \item \DescribeMacro{\advisor\{\}} Give the name of your advisor with
+% the |\advisor| macro.
+% \item \DescribeMacro{\secondadvisor\{\}} Give the name of your second advisor,
+% if any, with the |\secondadvisor| macro. You also need to pass in the
+% |twoadvisors| option in the |\documentclass| declaration.
+% \item \DescribeMacro{\department\{\}} Give the name of your department with the
+% |\department| macro, e.g. |\department{Gnulogical Engineering}|).
+% \item \DescribeMacro{\degdate\{\}} The month and year of the defense of the
+% thesis with the |\degdate| e.g. |\degdate{June 2004}|). If you forget to
+% declare this, the current month/year will be used.
% \end{itemize}
%
-% \DescribeMacro{\maketitle}
-% After defining the above macro arguments, use |\maketitle| to generate
-% a title page, which includes your entries. All the above macros are
-% required and if missing, they may result in errors in the generation
-% of the title page.
-%
-% \subsection{Copyright page}
+% \subsection{Copyright Page}
% \DescribeMacro{\makecopyright}
-% \DescribeMacro{\makepublicdomain}
-% The |\makecopyright| macro should be invoked after |\maketitle| to
-% produce a copyright page. Alternatively, you can use
-% |\makepublicdomain| to produce a page with the message ``This document
-% is in the public domain.'' Note that the absence of the copyright page
-% does {\em not} place your dissertaion in the public domain, you must
-% declare it as such explicitely.
-%
% \DescribeMacro{\copyrightholder\{\}}
% \DescribeMacro{\copyrightyear\{\}}
+% The |\makecopyright| macro should be invoked after |\maketitle| to
+% produce a copyright page.
% Prior to calling |\makecopyright|, you may specify a different name
% for the copyright holder (the default is the name given through the
% |\author| macro) and for the copyright year (the default being the
-% current year). You should do this with |\copyrightholder|\marg{name}
+% current year). Do this with the |\copyrightholder|\marg{name}
% and |\copyrightyear|\marg{year} macros.
%
-% \subsection{Abstract page(s)} \DescribeEnv{abstract}
-% The \textsf{abstract} environment has been modified from the default
-% in the \textsf{report} class to comply with the requirements
-% of the Graduate School. The abstract text should be placed between
+% \DescribeMacro{\makepublicdomain}
+% Alternatively, you can use
+% |\makepublicdomain| to produce a page with the message ``This document
+% is in the public domain.'' Note that the absence of the copyright page
+% does \emph{not} place your dissertaion in the public domain, you must
+% declare it as such explicitly.
+%
+% \subsection{Abstract Page(s)}
+% \DescribeEnv{abstract}
+% The abstract text should be placed between
% |\begin{abstract}| and |\end{abstract}|.
-% In this environment, the author's name is placed in
-% the top-right header, if it exceeds one page.
+% If the abstract is longer than one page, the environment will place
+% the author's name in the top-right header.
%
% \DescribeMacro{\abstractname\{\}}
% You may use |\abstractname|\marg{text} to change the abstract caption
% to |text|.
% Default name: |Abstract|.
+% You probably don't need to change it.
%
% \subsection{Dedication}
-%
% \DescribeEnv{dedication}
-% The format of dedication is essentially free, but you may want to use
-% the \textsf{dedication} environment for this purpose. This environment
-% will center the text of your dedication vertically on the page. The
-% dedication is optional.
+% The dedication is optional.
+% If you want one, use the \textsf{dedication} envrionment.
+% The format of dedication is essentially free.
+% This environment will center the text of your dedication vertically on the page.
+%
% \DescribeMacro{\dedicationame\{\}}
-% |\dedicationname|\marg{text} may be used to change the title for the
-% dedication page. Default name: |\mbox{}| ie.\/ an empty title.
+% You may use |\dedicationname|\marg{text} to change the title for the
+% dedication page. Default name: |\mbox{}| i.e.\/ an empty title.
+% You probably don't need to change it.
%
-% \subsection{Table of contents, figures and tables}
+% \subsection{Table of Contents; Lists of Figures and Tables}
% \DescribeMacro{\tableofcontents}
% \DescribeMacro{\listoffigures}
% \DescribeMacro{\listoftables}
-% Use the macros |\tableofcontents|,|\listoffigures| and |\listoftables|
-% in this order, to produce the required table of contents and list of
-% figures and tables. (Note: the ``list of figures'' should precede the
-% ``list of tables'' as per the Graduate School guide)
+% Use the macros |\tableofcontents|,|\listoffigures| and |\listoftables|,
+% \emph{in this order}, to produce the required table of contents and lists of
+% figures and tables.
%
% \DescribeMacro{\contentsname\{\}}
% \DescribeMacro{\listfigurename\{\}}
% \DescribeMacro{\listtablename\{\}}
-% The macros |\contentsname|, |\listfigurename| and |\listtablename| may
-% be used to change the caption for Table of Contents, List of Figures
-% and List of Tables, respectively. By default, they are named as |CONTENTS|,
-% |FIGURES| and |TABLES|.
-%
-% \subsection{List of symbols}
-% \DescribeEnv{symbols} The \textsf{symbols} environment is useful in
-% formatting the list of symbols/abbreviations used in your work. It
-% takes optional argument specifying the desired format, eg.
+% You may use |\contentsname|, |\listfigurename| and |\listtablename|
+% to change the titles for these sections.
+% By default they are |CONTENTS|, |FIGURES|, and |TABLES|.
+% You probably don't need to change them.
+%
+% \subsection{List of Symbols}
+% \DescribeEnv{symbols}
+% The list of symbols is optional.
+% Use the \textsf{symbols} envrionment to format a list of
+% symbols/abbreviations used in your work.
+% The envrionment takes an optional argument specifying the desired format, e.g.
% |\begin{symbols}[cl]| for first column centered and the next column
-% aligned left. \DescribeMacro{\symbolsname\{\}} As earlier, the
-% caption for the list of symbols can be changed by using the
-% |\symbolsname| macro. Default name: |SYMBOLS|
+% aligned left. By default, the first column will be right aligned and
+% the second column will be left aligned. You may use any of the standard
+% |tabular| column alignment options.
%
% \DescribeMacro{\sym\{\}\{\}}
-% Another macro |\sym|\marg{symbol}\marg{definition} makes the task of
+% The command |\sym|\marg{symbol}\marg{definition} may make the task of
% entering the symbols and their meanings in the \textsf{symbols}
-% environment easier. |\sym| takes two arguments - first, a math
-% ``object'' and second, assumed to be the plain text describing the
-% symbol. Any plain text in the first argument needs to be set with
-% |\mathrm{..}| and any math symbol in the second needs to placed in
+% environment easier. |\sym| takes two arguments: the first, a math
+% ``object'' and the second, the plain text describing the
+% symbol. Since the first argument is in math mode, any plain text
+% needs to be wrapped with |\mathrm{..}|
+% Likewise, any math symbol in the second argument needs to placed in
% |$..$|. Example: |\sym{\beta_\mathrm{norm}}{Definition for $\beta$}|
%
+% \DescribeMacro{\symbolsname\{\}}
+% You may use |\symbolsname{}| to change the title of the symbols section.
+% Default name: |SYMBOLS|.
+%
% \subsection{Preface}
% \DescribeEnv{preface}
+% The \textsf{preface} environment is provided for formatting the preface to your work.
+%
% \DescribeMacro{\prefacename\{\}}
-% An environment \textsf{preface} is provided for formatting the preface to the
-% document. The name of this {\em chapter} may be changed by |\prefacename|
-% macro. Default name: |PREFACE|
+% You may use |\prefacename| to change the name of this section.
+% Default name: |PREFACE|.
%
% \subsection{Acknowledgments}
% \DescribeEnv{acknowledgments}
-% \DescribeMacro{\acknowledgename\{\}}
% The environment \textsf{acknowledgments} is used to format the
-% acknowledgment {\em chapter}. As above |\acknowledgename| macro may be used
-% to change the title name. Default name: |ACKNOWLEDGMENTS|.
+% acknowledgment \emph{chapter}.
%
-% \subsection{Text} \DescribeMacro{\mainmatter}
-% Use the macro |\mainmatter| at the beginning of the text sections ie.
-% all text matter should follow this macro as in the {\sffamily book}
-% class. The text is formatted in |\normalspacing| ie. double-spacing.
+%
+% \DescribeMacro{\acknowledgename\{\}}
+% You may use |\acknowledgename| to change the name of this section.
+% Default name: |Acknowledgments|.
+%
+% \subsection{Text}
+% \DescribeMacro{\mainmatter}
+% Use the macro |\mainmatter| to mark the beginning of your text.
+% You can then use |\part|, |\chapter|, |\section|, |\subsection|, and |\subsubsection|
+% commands, as you would with the \textsf{book} class.
+% Text is formatted in |\normalspacing| i.e. double-spacing.
% The pages are numbered in |plain| pagestyle such that the page numbers
-% are centered in the bottom. The |chapter| titles can be multi-line or
-% long and would be formatted doubly spaced.
+% are centered in the bottom. The |chapter| titles can be multi-line,
+% and if so are formatted doubly spaced.
+%
+% \DescribeMacro{\unnumchapter\{\}}
+% Use the macro |\unnumchapter| to create to create unnumbered chapters that
+% appear in the Table of Contents.
%
% \subsection{Appendix}
% \DescribeMacro{\appendix}
-% As in the {\sffamily book} class, use the |\appendix| to mark the
-% end of the last chapter in the main section and the start of the
-% appendices. To begin an appendix, using a |\chapter|\marg{title}
-% macro. Appendices will be automatically ``numbered'' alphabetically.
+% Use the command |\appendix| after the last normal chapter to signal
+% that all following chapters are to be appendices.
+% This use is the same as in the \textsf{book} class.
+% To begin an appendix, use the |\chapter|\marg{title} macro.
%
% \subsection{Backmatter}
% \DescribeMacro{\backmatter}
-% This macro separates the bibliography, index
-% and glossary from the main matter and appendices, if any.
+% The |\backmatter| macro separates the bibliography, index
+% and glossary from the main matter and any appendices.
%
% \subsection{Bibliography} \DescribeMacro{\bibliography}
-% You may use the |\bibliography|\marg{bibfile} macro to generate the
-% bibliography with \BibTeX\/. In order to use the
-% \BibTeX\/ path for generating bibliography, one needs to have
-% all the bibliographic data in \BibTeX\/ files. You should
-% refer to \BibTeX\/ manual for details about making a |.bib| file
+% If you are using \BibTeX\/ (and why would you not want to use \BibTeX?),
+% use the |\bibliography|\marg{bibfile} macro to generate the
+% bibliography. You should refer to \BibTeX\/ manual for details about making a |.bib| file
% and format for the entries.
%
-% \DescribeMacro{\bibname\{\}} The default name for this {\em chapter} is
-% |BIBLIOGRAPHY|. You may change it by using the macro command
-% |\bibname|\marg{newbibname}.
-%
-% \DescribeEnv{thebibliography}
-% Alternatively, you can also make your own bibliography by using
-% {\sffamily thebibliography} environment. In this case, you would have
-% to write the reference entries in the right format in your |.tex| source
-% file itself.
-%
-% For citing references in the text, the package {\sffamily natbib} is
-% included with options: \texttt{numbers,sort\&compress} (|numrefs| option) or
+% For citing references in the text, the package \textsf{natbib} is
+% included with either the settings \texttt{numbers,sort\&compress} (|numrefs| option) or
% \texttt{authoryear,sort} (|textrefs| option). The package \textsf{natbib} is a
-% fantastic package that has numerous macros for {\em citing} in different ways.
-% It would make your life a lot easier if you read up its documentation. In
-% addition, for generation of pdf document, another package {\sffamily
-% hypernat} helps generates internal links for references.
+% fantastic package that has numerous macros for \emph{citing} in different ways.
%
-% {\bfseries Warning:} The packages {\sffamily cite} and \textsf{citation} are
+% \textbf{Warning:} The packages \textsf{cite} and \textsf{citation} are
% NOT compatible
-% with the {\sffamily natbib} package, and they must not be used.
+% with the \textsf{natbib} package, and will cause errors if used.
%
-% \section{Note for the authors}
-% \label{sec:author}
-% As noted earlier, the dissertation author must make sure that the
-% following conditions are met in order to generate a dissertation
-% acceptable by the Graduate School:
-%
-% \begin{itemize}
-% \item List of Figures should be {\em before} List of Tables, ie. the
-% macro command |\listoffigures| comes before |\listoftables| in the
-% frontmatter.
-% \item Chapter titles need to be written in ALL CAPS.
-% \item Table caption must be {\em above} the table, but the figure
-% caption should be {\em below} it.
-% In case of {\sffamily table} environment, this can be achieved by
-% putting |\caption| before you include the table (eg. in a {\sffamily
-% tabular} environment). In the {\sffamily figure} environment, |\caption|
-% goes after the |\includegraphics| macro command.
-% \item Table captions need to be in ALL CAPS as well.
-% \item Bibliography is the last section/chapter of the thesis.\footnote{Except
-% if you are using {\em chapter-wise} bibliography}
-% \end{itemize}
-%
-% \subsection{Chapter-wise bibliography}
-% It is now possible to obtain bibliography as a section in each chapter
-% (as is common
-% in some departments esp.\/ humanities) with some minor code
-% implementation in the |.tex| files. To do this you have to load the
-% package {\sffamily chapterbib} (without any options)
-% in the preamble of your main tex file and
-% redefine some commands as below -
+% \DescribeEnv{thebibliography}
+% If you are not using \BibTeX\/ make your own bibliography by using the
+% \textsf{thebibliography} environment. In this case, you would have
+% to write the reference entries in the right format in your |.tex| source
+% file itself. If you are using the |textrefs| option, you'll need to
+% consult the \textsf{natbib} manual to ensure that you enter your entries in
+% the format required by the package.
+%
+% \DescribeMacro{\bibname\{\}}
+% You may use |\bibname|\marg{newbibname} to change the name of this section.
+% Default name: |Bibliography|.
+%
+% \subsection{Chapter-wise Bibliography}
+% By default the bibliography appears at the end of your work and contains
+% all the references from the entire entity.
+% If you need to have a separate bibliography for each chapter,
+% you can do it in the following way.
+% First, load the package \textsf{chapterbib} without any options
+% in the preamble of your main source file and
+% redefine the commands |\bibname| and |\bibsection| as shown below.
% \begin{verbatim}
% %% Main source file %%
% \documentclass[...]{nddiss2e}
@@ -562,30 +575,55 @@
% \end{document}
% \end{verbatim}
%
-% In such a case, you must separate the chapters or sections in
-% which you want individual bibliographies in different files and {\em include}
-% them in the main file as above. Each such |\include|d file must contain
+% To process the bibliography for each chapter individually, the chapters or sections
+% must be separated into different files and \emph{include}
+% them in the main file, as shown above. Each such |\include|d file must contain
% its own |\bibliographystyle{nddiss2e}| and |\bibliography{...}| command at
% an appropriate position. There should not be any bibliographic commands in
% the main source file.
%
% After compiling the main tex file once (with |latex| or
-% |pdflatex|)\footnote{This creates |.aux| files which are needed by |bibtex|},
-% you
-% would have to run |bibtex| on each of the separate files to obtain a |.bbl|
+% |pdflatex|), the |.aux| files needed by |bibtex| will have been created
+% and you can then run |bibtex| on each of the separate source files to obtain a |.bbl|
% for each file. The remaining steps are the same as for a normal |.tex| file.
%
-% You can find more details of this in
-% the {\sffamily natbib} manual (|natbib.dvi|) in the |TEXMF| tree.
-% \subsection{Tips and suggestions}
+% You can find more details of this in the \textsf{natbib} manual.
+%
+% \section{Note For Authors}
+% \label{sec:author}
+% The dissertation author must make sure that the
+% following conditions are met in order to generate a dissertation
+% acceptable by the Graduate School:
+%
+% \begin{itemize}
+% \item The List of Figures must be \emph{before} the List of Tables, i.e. the
+% macro command |\listoffigures| comes before |\listoftables| in the
+% frontmatter.
+% \item Table captions must be \emph{above} the corresponding table,
+% In case of the \textsf{table} environment, this can be achieved by
+% putting |\caption| before you include the table (e.g. in a \textsf{
+% tabular} environment).
+% \item Figure captions should be \emph{below} the corresponding figure.
+% In the \textsf{figure} environment, the |\caption| goes after
+% the |\includegraphics| macro command.
+% \item The bibliography is the last section/chapter of the thesis---unless
+% you are using the \emph{chapter-wise} bibliography.
+% \end{itemize}
+%
+% \subsection{Tips and Suggestions}
% \label{subsec:tips}
% \begin{itemize}
-% \item Use |\toprule|, |\midrule| and |\bottomrule| macro commands (from the
-% {\sffamily booktabs} package) in the
-% tables for generating the appropriate horizontal rules. Use of vertical rules
-% to separate columns in tables, is in general, bad style and should be avoided as much as possible.
-% \item Use the {\sffamily longtable} environment for handling very long
-% tabular materials. Again, use the vertical rules only if very necessary.
+% \item It is \emph{strongly} recommended that you compile your document with
+% pdf\LaTeX. Compiling to dvi or postscript first may result in ``fuzzy'' fonts
+% when viewing the document on your screen. Additionally, the benefits
+% of |hyperref| and |pdflscape| are only available if you compile using
+% pdf\LaTeX.
+% \item Use the |\toprule|, |\midrule| and |\bottomrule| macro commands (from the
+% \textsf{booktabs} package) in tables for generating the appropriate
+% horizontal rules. Refrain from using vertical rules to separate columns in tables
+% as much as possible.
+% \item Use the \textsf{longtable} environment for handling very long
+% tabular materials. Example:
% \begin{verbatim}
% \begin{longtable}{lc}
% \caption[]{LONG TABLE CAPTION \label{tab:longtable} }
@@ -593,7 +631,7 @@
% Heading 1 & Heading 2 \\
% \midrule
% \endfirsthead
-% \caption[]{ {\em Continued} } \\
+% \caption[]{ } \\ % doesn't matter what text is in the continued caption.
% \midrule
% Heading 1 & Heading 2 \\
% \midrule
@@ -605,22 +643,25 @@
% Long & Table etc. \\
% \end{longtable}
% \end{verbatim}
-% \item If a figure/table is very wide and will not fit normally,
-% use the {\sffamily landscape} environment (from the included {\sffamily lscape}
-% package) to format them in {\em landscape}
-% mode. They will automatically appear on a separate page.
-% The {\sffamily sidewaystable} environment (from the included {\sffamily
-% rotating} package) is incompatible with the current
-% class and must be avoided.
-% \item Usually the width of the figure/table captions is 90\% of the textwidth
-% (ie. |0.9\textwidth|),
-% but if needed can be changed as per the following:
-% \begin{itemize}
-% \item Use a {\sffamily minipage} environment of appropriate width and enclose
-% your tabular or figure float inside it, or
-% \item set the |\capwidth| inside the {\sffamily table} or the
-% {\sffamily figure} environment, and |\LTcapwidth| {\em outside} the {\sffamily
-% longtable} environment, e.g.,\\[\baselineskip]
+% \item If a figure or table is very wide and will not fit on a page,
+% use the \textsf{landscape} environment (from the included
+% \textsf{lscape} package) to format them in \emph{landscape}
+% mode. They will automatically appear on a separate page. If you
+% use pdf\LaTeX\/ to compile your document, then the included
+% \textsf{pdflscape} package will flip this page on the screen
+% for easier reading.
+% \item The \textsf{sidewaystable} environment (from the included
+% \textsf{rotating} package) is incompatible with the current
+% class and should be avoided.
+% \item Usually the width of the figure and table captions is 90\% of the textwidth
+% (i.e. |0.9\textwidth|). If needed, the width can be changed on a case-by-case
+% basis by doing one of the following:
+% \begin{itemize}
+% \item Use a \textsf{minipage} environment of appropriate width and enclose
+% your tabular or figure float inside it, or
+% \item set the |\capwidth| inside the \textsf{table} or the \textsf{figure}
+% environment, and |\LTcapwidth| \emph{outside} the \textsf{
+% longtable} environment, e.g.,\\[\baselineskip]
% \begin{minipage}{0.5\textwidth}
% \begin{verbatim}
% \begin{table}[H]
@@ -641,22 +682,20 @@
% \end{\longtable}
% \end{verbatim}
% \end{minipage}
-% \end{itemize}
-% \item Use {\sffamily tabularx} environment for the actual
-% formatting of the tables (within the \textsf{table} environment). It differ
-% slightly from \textsf{tabular} environment and you should refer to their
-% documentation in the |TEXMF| tree for more information.
-% \item If you've used a {\sffamily longtable} environment in your document,
-% it might be
-% necessary to compile the document multiple times so as to get proper
-% alignment of columns. This is documented in the {\sffamily longtable} manual.
-% \item If you wish to use |\footnotes| in the \textsf{longtable} environment,
-% please read its documentation. There are some handicaps present.
-% \item A new macro command |\subsubsection| (self-explanatory) has been defined.
-% It is numbered as |3.2.1.4| in the TOC.
-% \item To cite a website in your bibliography\footnote{More info at
-% \url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=citeURL}}, use the
-% following format in your |.bib| file:
+% \end{itemize}
+% \item Use the \textsf{tabularx} environment for the actual formatting
+% of the tables (within the \textsf{table} environment). It differs
+% slightly from \textsf{tabular} environment and you should refer to
+% their documentation in the |TEXMF| tree for more information.
+% \item If you've used a \textsf{longtable} environment in your document,
+% it might be necessary to compile the document multiple times so as to
+% get proper alignment of columns. This is documented in the
+% \textsf{longtable} manual.
+% \item If you wish to use |\footnotes| in the \textsf{longtable} environment,
+% please read its documentation. There are some handicaps present.
+% \item To cite a website in your bibliography\footnote{More info at
+% \url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=citeURL}}, use the
+% following format in your |.bib| file:
% \begin{verbatim}
% @Misc{fairley2000,
% author = "N. Fairley",
@@ -664,100 +703,114 @@
% howpublished = "Website",
% note = "\url{http://www.casaxps.com}",
% }
-% \end{verbatim} This when processed with the |nddiss2e.bst| citation style file
-% gives:\newline
-% 111. N. Fairley. CasaXPS VAMAS processing software. Website.
-% \url{http://www.casaxps.com}.\newline
+% \end{verbatim} When processed with the |nddiss2e.bst| citation style file
+% this gives:\newline
+% 111. N. Fairley. CasaXPS VAMAS processing software. Website.
+% \url{http://www.casaxps.com}.\newline
% \end{itemize}
%
-% \subsection{You found errors?}
-% If you find some errors in formatting of your document, most likely these are
-% NOT due to the \nddiss\/ class, but due to either wrongly used
-% commands/macros or conflicting commands/macros in a package that you might
-% have used ie.\/ a mistake from your side. Please verify that before
-% contacting anyone regarding the class file.
-%
-% Read the manuals for the packages that you might have used and find out if
-% they have macro commands that modify the page-layout, spacing etc.\/ or if
-% they conflict with already defined commands (eg.\/ packages
-% \textsf{natbib} and
-% \textsf{cite} redefine the same command |\cite| in different ways). I would
-% suggest that you {\em read the manuals anyway}! It is a good practice.
-%
-% In the possible scenario that you
-% have found a significant error, please try to find out the source of the
-% error and, even better, a possible alternative, please
-% report it to the Graduate School's reviewer(s). It would also be great, if
-% you try to find a solution for the problem and inform that as well.
-% Please also inform if you find this documentation confusing or misleading or
-% if any mistakes are present.
-%
-% Your doing so will ensure that the reviwer(s) are aware of the problem and
-% its possible solutions and they can give better answers to the people who
-% might encounter similar problems. It will also help making the future
-% versions of the class file better.
-%
-% \section{Example}
-% Below is a basic |.tex| sample for your help.
-% A file called |template.tex|\footnote{Most likely present in the same
-% directory as |nddiss2e.cls| ie.\/ in |TEXMF/tex/latex/nddiss2e/|}
-% is generated from |nddiss2e.ins| which might serve as a guide for
-% your document. The |example| directory contains a mock thesis modified
-% from {\sffamily ndthesis} classfile and should also be helpful.
-%
-% \begin{verbatim}
-% \documentclass[numrefs,final]{nddiss2e}
-%
-% \begin{document}
-%
-% \frontmatter
-%
-% \title{}
-% \author{}
-% \work{Dissertation}
-% \degprior{B.S., M.S.}
-% \degaward{Doctor of Philosophy}
-% \advisor{}
-% \department{}
-% \maketitle
-% \makepublicdomain
-%
-% \begin{abstract}
-% Abstract here
-% \end{abstract}
-% \renewcommand{\dedicationname}{\mbox{}}% Empty dedication title
-% \begin{dedication}
-% For Someone
-% \end{dedication}
-%
-% \tableofcontents
-% \listoffigures
-% \listoftables
+% \subsection{You Found Errors?}
+% Errors in a \LaTeX\/ document are to be expected.
+% If you have a problem that is that seems to be more than a typo or
+% unbalanced brace, it is possible that there is a conflict between
+% the packages you have included and those that \nddiss\/ uses.
+% If you find yourself in that situtation, there is a mailing list
+% for handling support issues with \nddiss\/.
+% Look through the archive, and if there are no answers, please
+% send an email to \url{ND-LATEX-USERS@listserv.nd.edu} (registration required).
+% The more effort you spend in isolating the problem or in troubleshooting
+% will make it more likely that others can reproduce the problem and help
+% you solve it.
+% Also if you have a problem that you then solve, please also email the list.
+% Your doing so will help the next person to have that problem, and will
+% also make the maintainers aware of it, so future versions of the class file
+% can be better.
+%
+% \section{Other Packages Used}
+% \label{sec:features}
%
-% \begin{preface}
-% Preface here
-% \end{preface}
-% \begin{acknowledge}
-% Thanks to everyone
-% \end{acknowledge}
-% \begin{symbols}
-% \sym{a}{definition of a}
-% \end{symbol}
+% A number of packages are required by default and must be present in your
+% \TeX\space search path (if you use a package manager such as MiKTeX or
+% TeXLive, it will take care of this for you). As far as possible, these have
+% been tested for proper formatting style with the \nddiss\/ class file. The list
+% includes
+% \textsf{ifthen},
+% \textsf{exscale},
+% \textsf{ifpdf},
+% \textsf{ifluatex},
+% \textsf{ifxetex},
+% \textsf{xspace},
+% \textsf{longtable},
+% \textsf{indentfirst},
+% \textsf{tabularx},
+% \textsf{showkeys},
+% \textsf{enumerate},
+% \textsf{latexsym}.
+% \textsf{epsfig},
+% \textsf{color},
+% \textsf{graphicx},
+% \textsf{url},
+% \textsf{setspace}\footnote{v6.7[2000/12/01] or above},
+% \textsf{amsmath},
+% \textsf{float},
+% \textsf{lscape},
+% \textsf{rotating},
+% \textsf{booktabs}, and
+% \textsf{natbib}\footnote{v8.31[2009/07/16] or above}.
+% Sameer urges you to read the documentation of these packages available in
+% the |TEXMF| tree, if you think you might use their features
+% or want to tweak some advanced options. Of these packages,
+% \textsf{ifpdf},
+% \textsf{longtable},
+% \textsf{natbib},
+% \textsf{booktabs},
+% \textsf{rotating},
+% \textsf{url}, and
+% \textsf{setspace}
+% are not part of the \LaTeX\space required distribution, so you may need
+% to download them. They are all available through both MiKTeX and TeXLive;
+% note that \textsf{ifpdf} is part of the
+% \textsf{oberdiek} bundle, which is what you need to download to get
+% that package if it is not already installed on your system.
%
-% \mainmatter
+% Other packages may or may not be appropriate for use with the
+% \nddiss\space class when producing copies to be submitted to the
+% Graduate School. Please be careful when using packages that change the
+% default fonts, or the page layout.
%
-% \chapter{One} % Chapter 1
-% All the text ...
+% In general, the official guidelines of the Graduate School are
+% followed to the maximum extent possible. This includes proper
+% formatting of the title page and the abstract page (from the
+% \textsf{ndthesis} package), numbering of the pages in the \textit{frontmatter},
+% generation of properly formatted table of contents, list
+% of figures etc., as well as bibliography at the end.
+% Per the guide, the number of different fonts and font sizes used is kept to
+% a minimum. The contents, all lists and the bibliography are
+% single-spaced but the inter-line spacing for the rest of the document
+% is double.
%
-% \appendix
-% \chapter{Additional data} % Appendix A
+% \subsection{Generating PDF document}
+% \label{subsec:pdfdoc}
%
-% \backmatter
-% \bibliographystyle{nddiss2e}
-% \bibliography{bibdatabase}
+% The \nddiss\space class also allows production of pdf documents with
+% pdf\LaTeX\space. As of Spring 2013, this is the preferred method of
+% compilation. In this case, the \textsf{hyperref} and \textsf{pdflscape}
+% packages are also required. The \textsf{hyperref} package ensures
+% that the generated pdf document contains internal as well as external
+% links for citations and bookmarks. A document produced by this method
+% also contains embedded fonts (\textit{press quality} pdf) and is suitable
+% for electronic submission to the library and for microfilm archiving.
+% Although the most appropriate options for \textsf{hyperref} are
+% passed on, for advanced features refer to its documentation. The
+% \textsf{pdflscape} package flips pages with landscape orientation in the
+% pdf file for easier reading, but the location of the page numbers does not change.
%
-% \end{document}
-% \end{verbatim}
+% Figures must be in pdf, jpeg, png, or gif format, and not in encapsualted
+% postscript (eps). An easy way to convert \textit{eps} files to \textit{pdf}
+% files is to use the utility |epstopdf| or |eps2pdf|, which should be
+% available on your unix-like distribution already (should you have one). It is also
+% possible to convert your eps files to pdfs using an online conversion tool.
+% Searching for ``eps to pdf'' brought up several free options in Fall 2012.
%
%
%
@@ -768,15 +821,15 @@
%
% \clearpage
% \section{The Implementation}
-% Following is my attempt at documenting the source of the
+% Following is our attempt at documenting the source of the
% \nddiss\space class file for the \TeX\space hackers.
%
% \small\mbox{}\\
% \iffalse (Don't show this in the doc).
%<*class>
% \fi
-% At start, we define the base version of \LaTeXe\space needed and the label
-% information for the \nddiss\space class.
+% At the start, we define the base version of \LaTeXe\space needed and
+% the label information for the \nddiss\space class.
% \begin{macrocode}
\NeedsTeXFormat{LaTeX2e}[1999/12/01]
\ProvidesClass{nddiss2e}
@@ -790,13 +843,13 @@
% \end{macrocode}
% \fi
% \begin{macrocode}
- [2005/07/27 v3.0 ^^J%
+ [2016/10/16 v3.2016%
% \end{macrocode}
% \iffalse
%<*class>
% \fi
% \begin{macrocode}
- Notre Dame Dissertation document class by Sameer Vijay^^J]
+ Notre Dame Dissertation document class]
%
% \end{macrocode}
% \begin{macro}{\dissfileversion}
@@ -804,8 +857,8 @@
% The |\dissfileversion| and |\dissfiledate| macros contain the version and the date
% of the release.
% \begin{macrocode}
-\providecommand{\dissfileversion}{3.0}
-\providecommand{\dissfiledate}{2005/07/27}
+\providecommand{\dissfileversion}{3.2017.2}
+\providecommand{\dissfiledate}{2017/05/09}
%
% \end{macrocode}
% \end{macro}
@@ -815,7 +868,7 @@
% \fi
% \iffalse (Don't show this in the doc).
% \begin{macrocode}
-%<template> Template file for NDdiss2e class by Sameer Vijay^^J]
+%<template> Template file for NDdiss2e class]
% \end{macrocode}
% \fi
% \iffalse
@@ -832,6 +885,7 @@
\newif\ifdiss@dedication \diss@dedicationfalse
\newif\ifnum@refs \num@refstrue
\newif\ifcentered@chaptitle \centered@chaptitletrue
+\newif\if@ltfirstcaption
%
% \end{macrocode}
% \begin{macro}{draft}
@@ -864,7 +918,7 @@
% \end{macro}
% \begin{macro}{numrefs}
% \begin{macro}{textrefs}
-% The options |numrefs| or |textrefs| selects appropriate citation style ie.\/
+% The options |numrefs| or |textrefs| select the appropriate citation style i.e.\/
% ``numbered'' or ``textual'', respectively. By
% choosing |textrefs|, one can get ``author-date'' style of citation in the
% text. The default is |numrefs|.
@@ -876,12 +930,12 @@
% \end{macrocode}
% \end{macro}
% \end{macro}
-% The option |nocenter| (not documented) allows non-centered chapter titles.
+% The option |nocenter| allows non-centered chapter titles.
% \begin{macrocode}
\DeclareOption{nocenter}{\centered@chaptitlefalse}
%
% \end{macrocode}
-% The |openbib| option (not documented) is useful
+% The |openbib| option is useful
% in creating indented bibliography.
% Usually you would not need to use this option since the default layout of the
% |bibliography| is very much acceptable.
@@ -891,6 +945,29 @@
}
%
% \end{macrocode}
+% The |sort| option is passed to natbib, and causes multiple citations to be
+% listed in the sequence they appear in the bibliography.
+% \begin{macrocode}
+\DeclareOption{sort}{%
+ \PassOptionsToPackage{sort}{natbib}
+}
+%
+% \end{macrocode}
+% The |compress| option is passed to natbib, and causes numerical citations to
+% be compressed so that, e.g. 1,2,3 becomes 1-3. Does not also sort.
+% \begin{macrocode}
+\DeclareOption{compress}{%
+ \PassOptionsToPackage{compress}{natbib}
+}
+%
+% \end{macrocode}
+% The |sort&compress| option sorts numerical citations, and then compresses them.
+% \begin{macrocode}
+\DeclareOption{sort&compress}{%
+ \PassOptionsToPackage{sort&compress}{natbib}
+}
+%
+% \end{macrocode}
% The other options are declared in the following lines.
% \begin{macro}{twoadvisors}
% The |twoadvisors|
@@ -904,8 +981,8 @@
% \begin{macro}{10pt}
% \begin{macro}{11pt}
% \begin{macro}{12pt}
-% The options |10pt|, |11pt| or |12pt| are appropriately passed on to the
-% {\sffamily book} class depending on whether |\diss@draft| flag is set true.
+% The options |10pt|, |11pt| or |12pt| are passed on to the {\sffamily book}
+% class if appropriate, depending on whether the |\diss@draft| flag is set true.
% \begin{macrocode}
\DeclareOption{10pt}{%
\ifdiss@draft%
@@ -937,7 +1014,7 @@
\DeclareOption{noinfo}{\info@pagefalse}
%
% \end{macrocode}
-% The |twoside| option (not documented) is when you want to prepare a two-sided
+% The |twoside| option is for when you want to prepare a two-sided
% document for your own use. The only difference from the one-sided document
% is in the page layout. This option is passed on to the parent {\sffamily
% book} class.
@@ -949,7 +1026,7 @@
% All options other than those defined above are ignored and
% a warning is printed
% on the screen during compile-time. After processing all the options, the
-% {\sffamily book} class is loaded with the specified options.
+% \textsf{book} class is loaded with the specified options.
% \begin{macrocode}
\DeclareOption*{\ClassWarning{nddiss2e}%
{UnknownOption `\CurrentOption'} }%
@@ -957,99 +1034,119 @@
\LoadClass{book}
%
% \end{macrocode}
-% At this stage, the packages {\sffamily ifthen}, {\sffamily exscale},
-% {\sffamily ifpdf}, {\sffamily longtable}, {\sffamily xspace}, {\sffamily
-% indentfirst}, {\sffamily tabularx}, {\sffamily enumerate} and {\sffamily
-% latexsym} are loaded. It is important to load these in specific order so as
-% not to cause conflicts in definitions of certain macros.
+% At this stage, the packages \textsf{ifthen}, \textsf{exscale},
+% \textsf{etoolbox} \textsf{ifpdf}, \textsf{ifluatex},
+% \textsf{ifxetex}, \textsf{longtable}, \textsf{xspace}, \textsf{
+% indentfirst}, \textsf{tabularx}, \textsf{enumerate} and \textsf{
+% latexsym} are loaded. It is important to load these in a specific
+% order so as not to cause conflicts in definitions of certain macros.
% \begin{macrocode}
-\RequirePackage{ifthen,exscale}
-\RequirePackage{ifpdf}
+\RequirePackage{ifthen,exscale,etoolbox}
+\RequirePackage{ifpdf,ifluatex,ifxetex}
+\ifboolexpr{bool{pdf} or bool{xetex} or bool{luatex}}{}{%
+ \ClassError{nddiss2e}{%
+ PDF Output is required to support the PDF/A format.
+ }{DVI output is not supported. Use pdflatex to generate the dissertation.}
+}
+\RequirePackage[a-2b]{pdfx}
\RequirePackage{longtable}
+\RequirePackage{threeparttable}
+\RequirePackage[flushleft]{threeparttablex}
\RequirePackage{xspace}
\RequirePackage{indentfirst}
\RequirePackage{tabularx}
\RequirePackage{enumerate}
\RequirePackage{latexsym}
+\RequirePackage{textcase}
%
% \end{macrocode}
% If the |\diss@final| is set false (when using |draft| or |review| option) then
-% {\sffamily showkeys} package is also loaded.
+% the {\sffamily showkeys} package is also loaded.
% \begin{macrocode}
-\ifdiss@final\relax\else\RequirePackage{showkeys}\fi
+% \ifdiss@final\relax\else\RequirePackage{showkeys}\fi
%
% \end{macrocode}
% Depending in whether you are using pdf\LaTeX\space or plain \LaTeX\space,
-% {\sffamily epsfig}, {\sffamily color} and {\sffamily graphicx} are loaded
-% with respective options. Additionaly when using pdf\LaTeX\space, the package
-% {\sffamily hyperref} (for internal/external links in the document)
-% is also loaded. The options for this package have been tested to produce
-% a document which can be printed on laser printers without any problems
-% because of colored link boxes.
-% \begin{macrocode}
-\ifpdf
- \RequirePackage[pdftex]{epsfig}
- \RequirePackage[pdftex]{color}
- \RequirePackage[pdftex]{graphicx}
- \RequirePackage[pdftex,
- letterpaper=true,%
- bookmarks=true,%
- bookmarksnumbered=true,%
- linktocpage=true,%
- breaklinks=true,%
- bookmarkstype=toc,%
- colorlinks=false,%
- pdfpagemode=UseOutlines]{hyperref}
+% \textsf{epsfig}, \textsf{color} and \textsf{graphicx} are loaded
+% with respective options.
+% \begin{macrocode}
+\ifboolexpr{bool{pdf} or bool{xetex} or bool{luatex}}{%
+ \RequirePackage{epsfig}
+ \RequirePackage{color}
+ \RequirePackage{graphicx}
\AtBeginDocument{
\pdfadjustspacing=1
}
-\else
+}{%
\RequirePackage[dvips]{epsfig}
\RequirePackage[dvips]{color}
\RequirePackage[dvips]{graphicx}
-\fi
+}
%
% \end{macrocode}
-% Now the {\sffamily natbib} package is loaded
+% Now the \textsf{natbib} package is loaded
% with its options, appropriate to |numrefs| or |textrefs| class option. If |numrefs| is
-% specified, then {\sffamily natbib} is read-in with its options for
+% specified, then \textsf{natbib} is read-in with its options for
% ``numbered'' references and sorted \& compressed (eg. |[3-6,8-10]|).
% In this case, the default delimiter is square brackets and the
% default seperator is a comma. For the |textrefs| option, the
-% {\sffamily natbib} package is read-in so as to sort the references in an
+% \textsf{natbib} package is read-in so as to sort the references in an
% ``author-date'' style of citations.
-% The default delimitor and separator, in this case, are round brackets and
+% The default delimiter and seperator, in this case, are round brackets and
% colon, respectively.
%
-% For creating internal links in a pdf document with
-% pdf\LaTeX\space, the package {\sffamily hypernat} is also loaded.
% \begin{macrocode}
\ifnum@refs
- \RequirePackage[numbers,sort&compress]{natbib}
+ \RequirePackage[numbers]{natbib}
\else
- \RequirePackage[authoryear,sort]{natbib}
+ \RequirePackage[authoryear]{natbib}
\fi
-%
-\ifpdf
- \RequirePackage{hypernat}
-\fi
-%
% \end{macrocode}
-% Additionaly, the packages {\sffamily amsmath}, {\sffamily amssymb},
-% {\sffamily float}, {\sffamily lscape}, {\sffamily booktabs}, {\sffamily
-% rotating}, {\sffamily url} and {\sffamily setspace} are loaded when (pdf)\LaTeX\space
-% processes |\begin{document}|. Again, the order of these packages is
-% important.
+% Additionally, the packages \textsf{amsmath}, \textsf{float}, \textsf{booktabs},
+% \textsf{rotating}, \textsf{url} and \textsf{setspace} are loaded
+% when (pdf)\LaTeX\space processes |\begin{document}|. Again, the
+% order of these packages is important. Additionaly when using
+% pdf\LaTeX\space, the package \textsf{hyperref} (for
+% internal/external links in the document) is also loaded. The options
+% for this package have been tested to produce a document which can be
+% printed on laser printers without any problems because of colored
+% link boxes. Megan added required package pdflscape, which is part
+% of the oberdiek bundle in MiKTeX and TeXLive. Using this package
+% will flip landscape pages on the screen so that it's easier to read.
% \begin{macrocode}
\AtBeginDocument{
-\RequirePackage{amsmath,amssymb}
+\RequirePackage{amsmath}
\RequirePackage{float}
-\RequirePackage{lscape}
\RequirePackage{booktabs}
\RequirePackage{rotating}
\RequirePackage{url}
\RequirePackage[doublespacing]{setspace}[2000/12/01]
+\ifboolexpr{bool{pdf} or bool{xetex} or bool{luatex}}{%
+ \ifluatex
+ \RequirePackage[luatex]{pdflscape}
+ \else
+ \ifxetex
+ \RequirePackage[xetex]{pdflscape}
+ \else
+ \ifpdf
+ \RequirePackage{pdflscape}
+ \fi
+ \fi
+ \fi
+ % cannot use RequirePackage since pdfx also includes hyperref
+ \hypersetup{
+ plainpages=false,
+ pdfpagelabels,
+ bookmarks=true,%
+ bookmarksnumbered=true,%
+ linktocpage=true,%
+ breaklinks=true,%
+ bookmarkstype=toc,%
+ colorlinks=false,%
+ pdfpagemode=UseOutlines}
+}{}
}
+\RequirePackage{metalogo}
%
% \end{macrocode}
% Set the |\pagestyle| for the document to |plain| here
@@ -1065,28 +1162,38 @@
% Here, define some spacing macros for page layout and doublespacing.
% \begin{macrocode}
\newcommand{\normalspacing}{\doublespacing}
-\newcommand\single@baselinestretch{1.0}
-\newcommand\double@baselinestretch{1.66}
+\newcommand\single@baselinestretch{0.979}
+\newcommand\double@baselinestretch{1.625}
+\newlength{\usedtextsize}
+\setlength{\usedtextsize}{\f@size pt}
\newlength{\single@skip}
-\setlength{\single@skip}{\single@baselinestretch em}
+\setlength{\single@skip}{\single@baselinestretch \usedtextsize}
\newlength{\double@skip}
-\setlength{\double@skip}{\double@baselinestretch em}
+\setlength{\double@skip}{\double@baselinestretch \usedtextsize}
+\setlength{\footnotesep}{\double@skip}
%
% \end{macrocode}
% Define new lengths for some variables for a proper layout of normal pages,
-% pages with text and figures and pages with only floats.
+% pages with text and figures and pages with only floats. Note that although
+% the geometry package is usually easier, when Megan tried to switch to that
+% she discovered that something ends up overwriting it and, although the
+% the showframe option showed that the margins were setting correctly, the text
+% didn't look like they were. So these length values are set to what geometry
+% said they should be to get a 1.5 in left margin and 1 in margins on all other
+% sides (we'll use vspace commands later to get the 2 in top margin on pages
+% where that's needed).
% \begin{macrocode}
\setlength{\hoffset}{0pt}
\setlength{\voffset}{0pt}
-\addtolength{\topmargin}{-32pt}
-\setlength{\headsep}{12pt}
-\setlength{\marginparwidth}{54pt}
-\setlength{\marginparsep}{0pt}
-\addtolength{\textheight}{63pt}
-\addtolength{\textwidth}{26pt}
+\setlength{\topmargin}{-32pt}
+\setlength{\headsep}{20pt}
+\setlength{\marginparwidth}{47pt}
+\setlength{\marginparsep}{7pt}
+\setlength{\textheight}{648pt}
+\setlength{\textwidth}{432pt}
\setlength{\oddsidemargin}{36pt}
-\setlength{\evensidemargin}{18pt}
-\setlength{\footskip}{36pt}
+\setlength{\evensidemargin}{36pt}
+\setlength{\footskip}{30pt}
%
\setlength{\floatsep}{30pt}
\setlength{\intextsep}{50pt}
@@ -1107,16 +1214,22 @@
% \end{macrocode}
% \begin{macro}{\work}
% \begin{macro}{\degaward}
-% \begin{macro}{\degprior}
% \begin{macro}{\advisor}
% \begin{macro}{\secondadvisor}
% \begin{macro}{\department}
% \begin{macro}{\degdate}
+% \iffalse (does not appear in documentation)
+% In 2005 the Graduate School wanted us to list our degrees after our names.
+% In 2013 they no longer want this, so Megan removed the macro.
+% Here's the code for it, in case they change their minds again:
+% \begin{macro}{\degprior} (goes with the other \begin{macro}s above)
+% \newcommand{\degprior}[1]{\def\@degprior{#1}} (goes with other newcommands below)
+% \fi
% Here define new macros for use in the dissertation title page.
% \begin{macrocode}
+\renewcommand{\title}[1]{\def\@title{#1}}
\newcommand{\work}[1]{\def\@work{#1}}
\newcommand{\degaward}[1]{\def\@degaward{#1}}
-\newcommand{\degprior}[1]{\def\@degprior{#1}}
\newcommand{\advisor}[1]{\def\@advisor{#1}}
\ifadvisors@two
\newcommand{\secondadvisor}[1]{\def\@secondadvisor{#1}}
@@ -1136,16 +1249,15 @@
% \end{macro}
% \end{macro}
% \end{macro}
-% \end{macro}
% As a default, these macros have an empty arguement. Only the |\degdate| macro
% takes on the current month-year combination in the absence of any assignation.
+%^^A Removed 9-18-12: \degprior{}
% \begin{macrocode}
% Defaults are empty except the \degdate
\title{}
\author{}
\work{}
\degaward{}
- \degprior{}
\advisor{}
\ifadvisors@two \secondadvisor{} \fi
\department{}
@@ -1157,14 +1269,14 @@
% used etc.\ for the end-user and the proofreader along with a standard
% disclaimer and
% details of where to find documentation for the \nddiss\space class
-% file. This information can be suppressed by specifying ``|noinfo|'' option
-% while invoking the \nddiss\space class.
+% file. This information can be suppressed by specifying the ``|noinfo|''
+% option while invoking the \nddiss\space class.
% \begin{macrocode}
\DeclareRobustCommand{\@infopage}{
\thispagestyle{empty}
\null\vspace*{\single@skip}
\begin{center}
- \large This \@work\space \\ entitled \\ \@title \\
+ This \@work\space \\ entitled \\ \MakeTextUppercase{\@title} \\
typeset with \nddiss\ v%
\dissfileversion\ (\dissfiledate) %
on \today\space for\\
@@ -1174,8 +1286,8 @@
\normalfont\normalsize\singlespacing
\noindent This \LaTeXe\space classfile conforms to the
- University of Notre Dame style guidelines established in
- Spring 2004. However it is still possible to generate a
+ University of Notre Dame style guidelines as of Fall
+ 2012. However it is still possible to generate a
non-conformant document if the instructions in the class
file documentation are not followed!
@@ -1189,10 +1301,6 @@
\end{minipage}
\end{center}
- \noindent It is YOUR responsibility to ensure that the Chapter titles
- and Table caption titles are put in CAPS LETTERS. This classfile does
- {\em NOT\space} do that! \\
-
\noindent\itshape This page can be disabled by
specifying the ``{\upshape\ttfamily noinfo}'' option to the class invocation.
\upshape
@@ -1200,14 +1308,15 @@
)
\begin{center}
{\bfseries\large\singlespacing This page is \slshape NOT
- \upshape part of the dissertation/thesis, but MUST be turned in to the
- proofreader(s) or the reviwer(s)!}
+ \upshape part of the dissertation/thesis. It should be disabled before
+ making final, formal submission, but should be included in the version
+ submitted for format check.}
\end{center}
\normalsize\normalfont
\nddiss\ documentation can be found at these locations:
\begin{center}
- \url{http://www.gsu.nd.edu}\\
- \url{http://graduateschool.nd.edu}
+ \url{http://graduateschool.nd.edu} \\
+ \url{https://ctan.org/pkg/nddiss}
\end{center}
\vfill
@@ -1227,7 +1336,7 @@
% \end{macro}
% \begin{macro}{titlepage}
% The structuring begins with checking the proper macros for
-% obtaining a correct formatting for the title page. If any of those are
+% obtaining correct formatting for the title page. If any of those are
% not defined, an error is issued and processing stopped. Most of the code for
% this was taken from the earlier {\sffamily ndthesis} class and hence, the
% documentation is also picked from there.
@@ -1260,64 +1369,94 @@
% \end{macrocode}
% \end{macro}
% Now set up some skip registers to
-% hold the inter-data spacing. The initial values will vertically center
-% the title page provided the title is only one line long. We'll account for
-% the longer ones in a bit \ldots
-% \begin{macrocode}
-\skip1=1.2\double@skip
+% hold the inter-data spacing. The initial values will create a two-inch top margin
+% for the title page, provided the title is only one line long. |\skip1| is the primary
+% internal spacing command; |\skip2| is the spacing between the student's name and the
+% line for the first adviser to sign if there are two advisers and |\skip3| is the
+% spacing between the student's name and the line for the adviser to sign if there is
+% only one adviser; |\skip4| controls the top margin. We'll account for titles longer
+% than one line in a bit \ldots
+% \begin{macrocode}
+\skip1=2.1\double@skip
\skip2=1.7\double@skip
\skip3=2.7\double@skip
-\skip4=1em
+\skip4=36pt
%
% \end{macrocode}
-% If the author has two advisors, we need to do a little tweaking.
+% If the author has two advisors, we need to do a little tweaking to the
+% internal spacing.
% \begin{macrocode}
-\ifadvisors@two \skip1=1.0\double@skip \skip4=1.5em \else\relax\fi
-%
+ \ifadvisors@two
+ \skip1=1.6\double@skip
+ \else\relax
+ \fi
% \end{macrocode}
-% For positioning the title, we first stuff it in a box and find out how
-% many lines it will occupy. In order to maintain the $1''$ top margin
-% required by Notre Dame, we must not move our defaults up by more than
-% one-half of a |\doubleskip|. (Actually, there's a bit more room than
-% that, but we reserve that space in the case of multiple advisors.) As it
-% turns out, if the title is just two lines long, then just moving the top
-% of the text by |.5\doubleskip| will cause it to remain centered. For
-% longer titles, the extra lines have to be taken out of the inter-section
-% spacing (skip register 1).
-% \begin{macrocode}
-\setbox0=\hbox{\@title}
-\ifdim \wd0 > 3\hsize
- \advance\skip4 .5\double@skip
- \advance\skip1 -.33\double@skip
-\else
- \ifdim \wd0 > 2\hsize
- \advance\skip4 .5\double@skip
- \advance\skip1 -.167\double@skip
- \else
- \ifdim \wd0 > \hsize
- \advance\skip4 .5\double@skip
- \fi
- \fi
-\fi
-%
+% The 2012 formatting guidelines require the title to be 2'' from the top of page.
+% If it's more than one line long, we need to adjust the internal spacing:
+% \begin{macrocode}
+ \setbox0=\vbox{\MakeTextUppercase{\@title}}
+ \ifdim \ht0 > 3\double@skip
+ \advance \skip1 -.75\double@skip
+ \else
+ \ifdim \ht0 > 2\double@skip
+ \advance\skip1 -.5\double@skip
+ \else
+ \ifdim \ht0 > \double@skip
+ \advance\skip1 -.25\double@skip
+ \fi
+ \fi
+ \fi
% \end{macrocode}
-% Our default assumes a two-line \textsf{degree} field such as
+% Our default assumes a one-line \textsf{degree} field such as
% \begin{center}
-% Doctor of Philosophy \\ in Somekind of Science \\
+% Doctor of Philosophy
% \end{center}
-% but we check to see if it is simply one
-% line long. If so, we need to add-back that extra line to the spacing.
-% \begin{macrocode}
-\setbox1=\vbox{\@degaward}
-\ifdim \ht1 > \double@skip\relax
- \else \advance\skip1 .167\double@skip \fi
-%
+% but we check to see if it is two or three lines long.
+% If so, we need to remove those extra lines from the internal spacing.
+% \begin{macrocode}
+ \setbox1=\vbox{\@degaward}
+ \ifdim \ht1 > 2\double@skip
+ \advance\skip1 -.5\double@skip
+ \else
+ \ifdim \ht1 > \double@skip
+ \advance \skip1 -.25\double@skip
+ \else
+ \relax
+ \fi
+ \fi
+% \end{macrocode}
+% If we have two advisers, a three or four line title, and a
+% three line degree field or two advisers, a four line title, and
+% a two line degree field, then we need to remove some spacing between
+% the name and the first adviser and from the top margin,
+% and give that space to the internal spacing.
+% \begin{macrocode}
+ \ifadvisors@two
+ \ifdim \ht0 > 3\double@skip
+ \ifdim \ht1 > \double@skip
+ \advance \skip4 -.675\double@skip
+ \advance \skip2 -.4\double@skip
+ \advance \skip1 .25\double@skip
+ \else \relax
+ \fi
+ \else
+ \ifdim \ht0 > 2\double@skip
+ \ifdim \ht1 > 2\double@skip
+ \advance \skip2 -.4\double@skip
+ \advance \skip1 .1\double@skip
+ \else \relax
+ \fi
+ \else \relax
+ \fi
+ \fi
+ \else \relax
+ \fi
% \end{macrocode}
% Finally we start putting the text in place \ldots centered, of course.
% \begin{macrocode}
- \null\vspace*{-\skip4}
+ \null\vspace*{\skip4}
\begin{center}%
- \@title \par%
+ \MakeTextUppercase{\@title} \par%
\vskip\skip1%
%
% \end{macrocode}
@@ -1333,16 +1472,12 @@
\vskip\skip1%
\@degaward%
\vskip\skip1%
- by%
- \vskip\skip1%
+ by \\%
%
% \end{macrocode}
-% Now format the author's name and credentials.
+% Now format the author's name.
% \begin{macrocode}
- {\normalsize
- \begin{tabular}[t]{c@{}l}%
- \@author, &\ \@degprior
- \end{tabular}\par }%
+ \@author
%
% \end{macrocode}
% Now skip the proper space and place the signature line for the advisor
@@ -1351,10 +1486,14 @@
% signature line and placing the line in only the right-hand side.
% \begin{macrocode}
\ifadvisors@two
- \vskip\skip2\else
- \vskip\skip3\fi%
+ \vskip\skip2
+ \hspace*{2.75in}\underline{\hspace{2.75in}}\\%
+ \hspace*{2.75in}\@advisor, Co-Director\\
+ \else
+ \vskip\skip3
\hspace*{2.75in}\underline{\hspace{2.75in}}\\%
\hspace*{2.75in}\@advisor, Director\\
+ \fi%
%
% \end{macrocode}
% If there is a second advisor, place that line here now.
@@ -1362,12 +1501,12 @@
\ifadvisors@two %
\vskip\double@skip%
\hspace*{2.75in}\underline{\hspace{2.75in}}\\%
- \hspace*{2.75in}\@secondadvisor, Director\\
+ \hspace*{2.75in}\@secondadvisor, Co-Director\\
\fi
%
% \end{macrocode}
-% Finally, we do a vertical fill to get the department and date to the page
-% bottom.
+% We end with the department and date; the internal spacing is chosen so
+% that these are at the page bottom.
% \begin{macrocode}
\vskip\skip1%
Graduate Program in \@department \\%
@@ -1378,12 +1517,13 @@
}
%
% \end{macrocode}
-% \begin{environment}{copyrightpage} The environment |copyrightpage| defines
+% \begin{environment}{copyrightpage}
+% The environment |copyrightpage| defines
% the defaults for proper formatting the copyright page (if opted).
% \begin{macrocode}
\newenvironment{copyrightpage}{%
\clearemptydoublepage
- \typeout{Copyleft page}
+ \typeout{Copyright page}
\pagestyle{empty}
\null\vfil
\begin{center}\normalspacing}%
@@ -1397,15 +1537,18 @@
% desired. By default, they are taken as the current year and the |author|
% of the dissertation.
% \begin{macrocode}
-\newcommand{\@copyrightyear}{\year}
+\newcommand{\@copyrightyear}{\the\year}
\newcommand{\@copyrightholder}{\@author}
+\newcommand{\@copyrightlicense}{All Rights Reserved}
\newcommand{\copyrightyear}[1]{\renewcommand{\@copyrightyear}{#1}}
\newcommand{\copyrightholder}[1]{\renewcommand{\@copyrightholder}{#1}}
+\newcommand{\copyrightlicense}[1]{\renewcommand{\@copyrightlicense}{#1}}
%
% \end{macrocode}
% \end{macro}
% \end{macro}
-% \begin{macro}{\makecopyright} Finally, the |\makecopyright| macro creates the
+% \begin{macro}{\makecopyright}
+% Finally, the |\makecopyright| macro creates the
% copyright page as per defined in the |copyrightpage| environment.
% \begin{macrocode}
\newcommand{\makecopyright}{%
@@ -1415,14 +1558,15 @@
\copyright\space Copyright by \\
\@copyrightholder \\
\@copyrightyear\\
- All Rights Reserved \\[10mm]
+ \@copyrightlicense \\[10mm]
\end{copyrightpage}
\fi
}%
%
% \end{macrocode}
% \end{macro}
-% \begin{macro}{\makepublicdomain} Or, if chosen, |\makepublicdomain| macro
+% \begin{macro}{\makepublicdomain}
+% Or, if chosen, |\makepublicdomain| macro
% creates a copyright page (using earlier |copyrightpage| environment) that
% puts the document in public domain.
% \begin{macrocode}
@@ -1443,29 +1587,31 @@
% \begin{macrocode}
\providecommand{\abstractname}{Abstract}
\providecommand{\dedicationname}{\mbox{}}
-\providecommand{\prefacename}{PREFACE}
-\providecommand{\acknowledgename}{ACKNOWLEDGMENTS}
-\providecommand{\symbolsname}{SYMBOLS}
-\renewcommand{\tablename}{TABLE}
+\providecommand{\prefacename}{Preface}
+\providecommand{\acknowledgename}{Acknowledgments}
+\providecommand{\symbolsname}{Symbols}
+\renewcommand{\tablename}{Table}
\renewcommand{\figurename}{Figure}
-\renewcommand{\chaptername}{CHAPTER}
-\renewcommand{\appendixname}{APPENDIX}
-\renewcommand{\contentsname}{CONTENTS}
-\renewcommand{\listfigurename}{FIGURES}
-\renewcommand{\listtablename}{TABLES}
-\renewcommand{\bibname}{BIBLIOGRAPHY}
-\renewcommand{\indexname}{INDEX}
-%
-% \end{macrocode}
-% \begin{environment}{abstract} This environment is adapted
-% from the {\sffamily report}
-% class since the {\sffamily book} class does not have one. Additionaly, we add
+\renewcommand{\partname}{Part}
+\renewcommand{\chaptername}{Chapter}
+\renewcommand{\appendixname}{Appendix}
+\renewcommand{\contentsname}{Contents}
+\renewcommand{\listfigurename}{Figures}
+\renewcommand{\listtablename}{Tables}
+\renewcommand{\bibname}{Bibliography}
+\renewcommand{\indexname}{Index}
+%
+% \end{macrocode}
+% \begin{environment}{abstract}
+% This environment is adapted
+% from the \textsf{report} class since
+% the \textsf{book} class does not have one. Additionally, we add
% a |\pdfbookmark| for the abstract in the pdf document.
% \begin{macrocode}
\newenvironment{abstract}{%
- \ifpdf
+ \ifboolexpr{bool{pdf} or bool{xetex} or bool{luatex}}{%
\pdfbookmark[0]{\abstractname}{abstract}%abstract.0
- \fi
+ }{}
\typeout{Abstract page(s)}
\renewcommand{\@oddfoot}{\@empty}
\renewcommand{\@evenfoot}{\@empty}
@@ -1480,9 +1626,9 @@
\titlepage
\null
\begin{center}
- \vspace*{0.25in}
+ \vspace*{36pt}
{\normalsize\mdseries \normalspacing
- \@title \\[3.5ex]
+ \MakeTextUppercase{\@title} \\[3.5ex]
\normalsize\abstractname \\ by \\ \@author\space}%
\@endparpenalty \@M
\end{center}\par}%
@@ -1490,16 +1636,16 @@
%
% \end{macrocode}
% \end{environment}
-% \begin{environment}{dedication} The ``dedication'' environment is similar to
-% the ``abstract'' environment. This page is numbered 2 and the
-% subsequent pages are numbered accordingly.
+% \begin{environment}{dedication}
+% The \textsf{dedication} environment is similar to
+% the \textsf{abstract} environment. This page is numbered 2 and the
+% subsequent pages are numbered accordingly. A pdfbookmark is
+% not created because of a reported issue that Adobe products have with
+% pdfbookmarks containing an |\mbox|.
% \begin{macrocode}
\newenvironment{dedication}{%
\global\diss@dedicationtrue
\typeout{Dedication page}
- \ifpdf
- \pdfbookmark[0]{\dedicationname}{dedication}%dedication.0
- \fi
\chapter*{\dedicationname}%
\thispagestyle{plain}
\setcounter{page}{2}
@@ -1515,9 +1661,9 @@
\renewcommand\tableofcontents{%
\ifdiss@dedication\relax\else\setcounter{page}{2}\fi
\chapter*{\contentsname}%
- \ifpdf
+ \ifboolexpr{bool{pdf} or bool{xetex} or bool{luatex}}{%
\pdfbookmark[0]{\contentsname}{contents}%contents.0
- \fi
+ }{}
\singlespacing
\@starttoc{toc}%
\normalspacing
@@ -1556,7 +1702,7 @@
% \end{macro}
% \begin{environment}{preface}
% \begin{environment}{acknowledgement}
-% These environments are similar to the ``dedication'' environment. They are
+% These environments are similar to the \textsf{dedication} environment. They are
% defined as |\chapter*{}| so they are not numbered and not added to Table of
% Contents and so, add that manually by using |\addcontentsline|.
% \begin{macrocode}
@@ -1577,12 +1723,20 @@
% \end{macrocode}
% \end{environment}
% \end{environment}
+% \begin{macro}{\unnumchapter}
+% Allows the user to create unnumbered chapters that appear in the TOC.
+% \begin{macrocode}
+\newcommand\unnumchapter[1]{%
+ \chapter*{#1}%
+ \addcontentsline{toc}{chapter}{#1}}
+% \end{macrocode}
+% \end{macro}
% \begin{environment}{symbols}
% \begin{macro}{\sym}
% Define \textsf{symbols} environment which lays out it as a |\chapter*| and
% adds |\symbolsname| to the TOC. The environment is actually a horizontally
-% centered \textsf{longtable} environment. To aid entry of {\em symbol} and its
-% definition, |\sym| macro command is also defined.
+% centered \textsf{longtable} environment. To aid entry of a \emph{symbol} and
+% its definition, |\sym| macro command is also defined.
% \begin{macrocode}
\newcommand{\sym}[2]{\ensuremath{#1} & #2 \\}
\newenvironment{symbols}[1][rl]{%
@@ -1597,17 +1751,17 @@
% \end{environment}
% Modify chapter definition in |\@chapter| to put the word
% ``Chapter'' (|\@chapapp|) in the Table of Contents.
-% That is, now the TOC will contain \par·
-% ``\textbf{Chapter 1: First chapter}'' rather than
-% ``\textbf{1. First chapter}'' \newline·
-% The rest of the format code is essentially similar to
+% That is, now the TOC will contain
+% ``Chapter 1: First chapter'' rather than
+% ``1. First chapter.''
+% The rest of the format code is essentially the same as
% that in the \textsf{book} class.
% \begin{macrocode}
\def\@chapter[#1]#2{
\ifnum \c@secnumdepth >\m@ne
\if@mainmatter
\refstepcounter{chapter}%
- \typeout{\@chapapp\space\thechapter.}%
+ \typeout{\MakeTextUppercase{\@chapapp\space\thechapter.}}%
\addcontentsline{toc}{chapter}%
{{\@chapapp\ \thechapter: #1}}%
\else
@@ -1619,10 +1773,40 @@
\chaptermark{#1}%
\addtocontents{lof}{\protect\addvspace{10\p@}}%
\addtocontents{lot}{\protect\addvspace{10\p@}}%
- \@makechapterhead{#2}%
+ \@makechapterhead{\MakeTextUppercase{#2}}%
\@afterheading }%
%
% \end{macrocode}
+% Modify part definition in |\@part| and |\@spart| to keep the font
+% size for part headings |\normalsize| and |\mdseries|. It is otherwise
+% the same as in the \textsf{book} class.
+% \begin{macrocode}
+\def\@part[#1]#2{%
+ \ifnum \c@secnumdepth >-2\relax
+ \refstepcounter{part}%
+ \addcontentsline{toc}{part}{\thepart\hspace{1em}#1}%
+ \else
+ \addcontentsline{toc}{part}{#1}%
+ \fi
+ \markboth{}{}%
+ {\centering
+ \interlinepenalty \@M
+ \normalfont
+ \ifnum \c@secnumdepth >-2\relax
+ \normalsize\mdseries \partname\nobreakspace\thepart
+ \par
+ \vskip 20\p@
+ \fi
+ \normalsize\mdseries \MakeTextUppercase{#2}\par}%
+ \@endpart}
+\def\@spart#1{%
+ {\centering
+ \interlinepenalty \@M
+ \normalfont
+ \normalsize\mdseries #1\par}%
+ \@endpart}
+%
+% \end{macrocode}
% Now format section headings to conform to the official guidelines.
% \begin{macro}{\@makechapterhead}
% First, modify the chapter heading label to be normalsize'd
@@ -1634,13 +1818,13 @@
% double-spaced.
% \begin{macrocode}
\renewcommand{\@makechapterhead}[1]{%
- \vspace*{.625in}%
+ \vspace*{30pt}%
{\parindent \z@ \raggedright
\ifnum \c@secnumdepth >\m@ne
\normalfont\normalsize%
\if@mainmatter
\ifcentered@chaptitle\center\else\relax\fi%
- \@chapapp{} \thechapter\par\nobreak
+ \MakeTextUppercase{\@chapapp{} \thechapter}\par\nobreak
\fi
\fi
\interlinepenalty\@M
@@ -1654,17 +1838,17 @@
% \begin{macro}{\@makeschapterhead}
% Make the TOC, LOF, LOT and other |\chapter*| headings in normal size,
% and |\mdseries| by modifying the macro |\@makeschapterhead|. Although these
-% heading labels are usually fitting in single-line, we copy the formatting for
+% heading labels usually fit in a single-line, we copy the formatting for
% the chapter heading label (single-spacing) and make the spacing double again
% for the text.
% \begin{macrocode}
\renewcommand{\@makeschapterhead}[1]{%
- \vspace*{.625in}%
+ \vspace*{30pt}%
{\parindent \z@ \raggedright
\normalfont\normalsize%
\interlinepenalty\@M
\ifcentered@chaptitle\center\else\relax\fi
- \mdseries{#1}\par\nobreak
+ \mdseries{\MakeTextUppercase{#1}}\par\nobreak
\vskip 30\p@
}}
%
@@ -1703,11 +1887,34 @@
{\normalfont\normalsize\mdseries} }
%
% \end{macrocode}
+% \begin{macro}{\l@part}
+% Modify the macro |\l@part| that formats part titles in the
+% contents-like files (|.toc|, |.lof| and |.lot|) by adding a |\@dottedtocline|
+% macro. The indent width is set to 1.5em - to line up a continued line with
+% the section number below it. We also leave less space between each part
+% and the last section entry than the default and don't change the font.
+% \begin{macrocode}
+\renewcommand*\l@part[2]{%
+ \ifnum \c@tocdepth >-2\relax
+ \addpenalty{-\@highpenalty}%
+ \setlength\@tempdima{1.5em}%
+ \begingroup
+ {\leavevmode
+ \@dottedtocline{1}{0pt}{\@tempdima}{#1}{#2}
+ }\par
+ \nobreak
+ \global\@nobreaktrue
+ \everypar{\global\@nobreakfalse\everypar{}}%
+ \endgroup
+ \fi}
+%
+% \end{macrocode}
+% \end{macro}
% \begin{macro}{\l@chapter}
% Modify the macro |\l@chapter| that formats chapter titles in the
% contents-like files (|.toc|, |.lof| and |.lot|) by adding a |\@dottedtocline|
% macro. The indent width is set to 1.5em - to line up a continued line with
-% the section number below it. We also leave lesser space between each chapter
+% the section number below it. We also leave less space between each chapter
% and the last section entry than the default.
% \begin{macrocode}
\renewcommand*{\l@chapter}[2]{%
@@ -1722,16 +1929,12 @@
%
% \end{macrocode}
% \end{macro}
-% \begin{macro}{\l@subsubsection}
-% The macro |\l@subsubsection| is modified to indent the |\subsubsection| label
-% same as that for |\subsection| in the table of contents. We also increase the
-% number of section-depth by 1 and force subsubsection entry in the TOC
+% \begin{macro}{\thesubsubsection}
+% We increase the number of section-depth by 1 and force subsubsection entry in the TOC
% by increasing the |\tocdepth|. In addition, the label number of
% |\subsubsection| is defined to be similar to that for |\subsection| i.\/e.\/
% all arabic numerals.
% \begin{macrocode}
-\renewcommand{\l@subsubsection}{%
- \@dottedtocline{3}{3.8em}{4.1em}}
\addtocounter{secnumdepth}{1}
\addtocounter{tocdepth}{1}
\renewcommand{\thesubsubsection}{%
@@ -1751,6 +1954,47 @@
%
% \end{macrocode}
% \end{environment}
+% \begin{environment}{itemize}
+% Redefine the |itemize| environment so that each item is
+% single-spaced, but with a line of space between each item.
+% \begin{macrocode}
+\let\realitemize\itemize
+\let\endrealitemize\enditemize
+\renewenvironment{itemize}
+ {\realitemize
+ \singlespacing}
+ {\endrealitemize
+ \doublespacing}
+% \end{macrocode}
+% \end{environment}{itemize}
+% \begin{environment}{enumerate}
+% Redefine the |enumerate| environment so that each item is
+% single-spaced, but with a line of space between each item.
+% Note we need the optional argument in order to be compatible
+% with the |enumerate| package
+% \begin{macrocode}
+\let\realenumerate\enumerate
+\let\endrealenumerate\endenumerate
+\renewenvironment{enumerate}[1][1.]
+ {\realenumerate[#1]
+ \singlespacing}
+ {\endrealenumerate
+ \doublespacing}
+% \end{macrocode}
+% \end{environment}{enumerate}
+% \begin{environment}{description}
+% Redefine the |description| environment so that each item is
+% single-spaced, but with a line of space between each item.
+% \begin{macrocode}
+\let\realdescription\description
+\let\endrealdescription\enddescription
+\renewenvironment{description}
+ {\realdescription
+ \singlespacing}
+ {\endrealdescription
+ \doublespacing}
+% \end{macrocode}
+% \end{environment}{description}
% Set some lengths that are used in the |table| and the |figure|
% environments. Note that we set the caption width (|\capwidth|)
% to be 90\% of the |\textwidth|.
@@ -1769,7 +2013,7 @@
%
% \end{macrocode}
% \begin{environment}{figure}
-% For the |figure| environment, first some skip ``lengths'' are set, then
+% For the |figure| environment, first some skip lengths are set, then
% use |\@makefigurecaption| to
% format the captions instead of the default |\@makecaption|, since the
% layout is different for |figure| and the |table| environment. Further
@@ -1811,17 +2055,27 @@
% the |table| environment is set to be
% single spaced. However, to obtain double-spacing between the entries,
% redefine the |\arraystretch| to be equivalent to the
-% |\double@baselinestretch|. This way, while there is double-spaced entries,
+% |\double@baselinestretch|. This way, while there are double-spaced entries,
% the entry itself is single-spaced. Similar to that in
% |\@makefigurecaption|, a |\vskip| is added to each entry in the |.lot| file.
% \begin{macrocode}
-\renewenvironment{table}{%
+\renewenvironment{table}[1][tbp]{%
\setlength{\abovecaptionskip}{\abovetableskip}
\setlength{\belowcaptionskip}{\belowtableskip}
- \singlespacing
\renewcommand{\arraystretch}{\double@baselinestretch}
+ \let\scaption\caption%
+ \renewcommand*{\caption}[2][]{%
+ \ifthenelse{\equal{##1}{}}{%
+ \def\shortcaption{##2}%
+ }{%
+ \def\shortcaption{##1}%
+ }%
+ \scaption[\shortcaption]{\MakeTextUppercase{##2}}%
+ }%
\let\@makecaption\@maketablecaption
- \@float{table}}%
+ \@float{table}[#1]%
+ \singlespacing%
+ }%
{%
\addtocontents{lot}{ {\vskip 0.4em} }%
\end@float%
@@ -1830,18 +2084,20 @@
% \end{macrocode}
% \end{environment}
% \begin{macro}{\@maketablecaption}
-% The |\@maketablecaption| is defined similar to |\@makefigurecaption|
+% The |\@maketablecaption| is defined similarly to |\@makefigurecaption|
% to have the table label and caption in
% separate lines and with normal-spacing (double-spaced).
% \begin{macrocode}
\long\def\@maketablecaption#1#2{
\vskip\abovecaptionskip
\begin{center}
- \parbox{\capwidth}{
- \centering\normalspacing
- {#1}\\[\single@skip]
- {#2}%\par
- \vskip\belowcaptionskip }%
+ \makebox[\linewidth]{
+ \parbox{\capwidth}{
+ \centering\normalspacing
+ \MakeTextUppercase{#1}\\[\single@skip]
+ {#2}%\par
+ \vskip\belowcaptionskip }%
+ }%
\end{center}
}
%
@@ -1856,12 +2112,13 @@
\singlespacing
\renewcommand{\arraystretch}{\double@baselinestretch}
\begingroup
+ \@ltfirstcaptiontrue
\@ifnextchar[\LT@array{\LT@array[x]}}
%
% \end{macrocode}
% \end{macro}
% \begin{macro}{\endlongtable}
-% This bit is taken from the |longtable.sty|. In order to obtain double-spacing
+% This bit is taken from |longtable.sty|. In order to obtain double-spacing
% in the list of tables, a |\vskip| of 0.4em is added to |.lot| file.
% \begin{macrocode}
\renewcommand\endlongtable{%
@@ -1906,8 +2163,13 @@
\LT@mcol\LT@cols c{\hbox to\z@{\hss\parbox[t]\LTcapwidth{%
\vskip\abovetableskip%
\centering\normalspacing
- #1{#2 }\\[\single@skip]
- {#3}\par
+ \if@ltfirstcaption
+ #1{\MakeTextUppercase{#2} }\\[\single@skip]
+ \MakeTextUppercase{#3}\par
+ \else%
+ #1{\MakeTextUppercase{#2 (continued)} }\par
+ \fi
+ \global\@ltfirstcaptionfalse
\endgraf\vskip\belowtableskip}%
\hss}}}
%
@@ -1935,8 +2197,8 @@
%
% \end{macrocode}
% \end{macro}
-% The header prepared above is put in the document by modifiying the {\em
-% plain} and {\em empty} pagestyles except when the |final| option is chosen.
+% The header prepared above is put in the document by modifiying the \emph{plain}
+% and \emph{empty} pagestyles except when the |final| option is chosen.
% \begin{macrocode}
\ifdiss@final
\renewcommand{\ps@plain}{
@@ -1977,11 +2239,11 @@
% \begin{macro}{\bibfont}
% Changed the |\bibfont| macro to obtain single-spacing within each
% bibliographic entry. Between different entries, it is still |\normalspacing|.
-% In addition, when |numrefs| option is selected, the |\@biblabel| is redefined
+% In addition, when the |numrefs| option is selected, the |\@biblabel| is redefined
% to number the bibliographic entries as |1. xxxx| instead of the default
% |[1] xxxx|.
% \begin{macrocode}
-\newcommand{\bibfont}{\singlespacing}
+\renewcommand{\bibfont}{\singlespacing}
\ifnum@refs
\renewcommand{\@biblabel}[1]{\hfill#1.\hfill}
\fi
@@ -1989,7 +2251,7 @@
% \end{macrocode}
% \end{macro}
% Lastly, after the bibliography in the final document,
-% add a framed box which contains blurb about
+% add a framed box which contains a blurb about
% the typesetting program and \nddiss\space version used for preparing the
% dissertation document.
% \begin{macrocode}
@@ -2000,9 +2262,19 @@
\framebox[0.85\textwidth]{
\begin{minipage}{0.80\textwidth}\footnotesize%
\centering \itshape This document was prepared \& typeset with
- \upshape\ifpdf pdf\LaTeX\else\LaTeXe\fi\itshape , and
+ \upshape
+ \ifluatex
+ \LuaLaTeX
+ \else\ifxetex
+ \XeLaTeX
+ \else\ifpdf
+ pdf\LaTeX
+ \else
+ \LaTeXe
+ \fi\fi\fi
+ \itshape , and
formatted with \upshape\nddiss\xspace\itshape classfile
- (v\dissfileversion [\dissfiledate]) provided by Sameer Vijay.
+ (v\dissfileversion [\dissfiledate])
\end{minipage} }
\clearpage}
\else\relax\fi
@@ -2018,39 +2290,57 @@
% \iffalse
%<*template>
\documentclass[draft]{nddiss2e}
- % Available options are
- % (a) draft + 10pt/11pt/12pt + twoadvisors + textrefs
- % (b) review + noinfo + twoadvisors + textrefs
- % (c) final + noinfo + twoadvisors + textrefs
-
+ % One of the options draft, review, final must be chosen.
+ % One of the options textrefs or numrefs should be chosen
+ % to specify if you want numerical or ``author-date''
+ % style citations.
+ % Other available options are:
+ % 10pt/11pt/12pt (available with draft only)
+ % twoadvisors
+ % noinfo (should be used when you compile the final time
+ % for formal submission)
+ % sort (sorts multiple citations in the order that they're
+ % listed in the bibliography)
+ % compress (compresses numerical citations, e.g. [1,2,3]
+ % becomes [1-3]; has no effect when used with
+ % the textrefs option)
+ % sort&compress (sorts and compresses numerical citations;
+ % is identical to sort when used with textrefs)
\begin{document}
-\frontmatter % All the items before Chapter 1 go in ``frontmatter''
+\frontmatter % All the items before Chapter 1 go in ``frontmatter''
+
+\title{ Title of Work } % Title
-\title{ } % Title of Work
-\author{ } % Author's name
-\work{ } % ``Dissertation'' or ``Thesis''
-\degprior{ } % All prior degrees
-\degaward{ } % Degree you're aiming for
-\advisor{ } % Advisor's name
- % \secondadvisor{ } % Second advisor, if used option ``twoadvisors''
-\department{ } % Name of the department
+\author{ Jane Doe } % Author's name
+\work{ Dissertation } % ``Dissertation'' or ``Thesis''
+\degaward{ Doctor of Philosophy } % Degree you're aiming for.
+ % Should be one of the following options:
+ % ``Doctor of Philosophy'' (do NOT include ``in Subject'')
+ % ``Master of Science \\ in \\ Subject''
+\advisor{ John Public } % Advisor's name
+ % \secondadvisor{ } % Second advisor, if used option ``twoadvisors''
+\department{ } % Name of the department
-\maketitle % The title page is created now
+\maketitle % The title page is created now
- % \copyrightholder{ } % If you're not the copyright holder
- % \copyrightyear{ } % If the copyright is not for the current year
- % \makecopyright % If not making your work public domain
- % uncomment out \makecopyright
- % \makepublicdomain % Uncomment this to make your work public domain
+ % You must use either the \makecopyright option or the \makepublicdomain option.
+ % \copyrightholder{ } % If you're not the copyright holder
+ % \copyrightyear{ } % If the copyright is not for the current year
+ % \makecopyright % If not making your work public domain
+ % uncomment out \makecopyright
+ % \makepublicdomain % Uncomment this to make your work public domain
+ % Including an abstract is optional for a master's thesis, and required for a
+ % doctoral dissertation.
% \begin{abstract}
% \end{abstract}
- % % Either place the text between begin/end, or
- % \include{abstract} % put it in a file to be included
+ % % Either place the text between begin/end, or
+ % \include{abstract} % put it in a file to be included
+ % Including a dedication is optional.
% \renewcommand{\dedicationname}{\mbox{}} % Replace \mbox{} if you want
- % something else
+ % something else.
% \begin{dedication}
% \end{dedication}
% % Use one of the two choices to add dedication text
@@ -2060,20 +2350,24 @@
\listoffigures
\listoftables
+ % Including a list of symbols is optional.
%% \renewcommand{\symbolsname}{newsymname} % Replace ``newsymname'' with
- % the name you want, and uncomment
+ % the name you want, and uncomment
% \begin{symbols}
% \end{symbols}
% % Use one of the two choices to add symbols text
% \include{symbols}
+ % Including a preface is optional.
%% \renewcommand{\prefacename}{ } % If you want another Preface name, add
- % something else, and uncomment
+ % something else, and uncomment.
% \begin{preface}
% \end{preface}
% % Use one of the two choices to add preface text
% \include{preface}
+ % Including an acknowledgements section may or may not be optional. It's hard to
+ % tell from the information available in Spring 2013.
%% \renewcommand{\acknowledgename}{ } % If you want another Acknowledgement name
% add something else, and uncomment
% \begin{acknowledge}
@@ -2084,20 +2378,34 @@
\mainmatter
% Place the text body here.
% \include{chapter-one}
+ % Begin each chapter with \chapter{Title}.
+% Appendices are optional.
\appendix
% If you have appendices, add them here.
- % Begin each one with \chapter{title} as before- the \appendix command takes
+ % Begin each one with \chapter{TITLE} as before. The \appendix command takes
% care of renaming chapter headings and creates a new page in the Table of
% Contents for them.
% \include{appendix-one}
\backmatter % Place for bibliography and index
-\bibliographystyle{nddiss2e} % Use the ``nddiss2e'' biblio-style
+% If you are using BibTeX to manage your citations:
+% Use the ``nddiss2e'' bibliography style, unless your field does not
+% include the titles of journal articles in bibliography entires.
+% If you do not want the titles of journal articles to appear, use the
+% ``nddiss2enoarticletitles'' bibliography style.
+
+\bibliographystyle{nddiss2e}
\bibliography{ } % input the bib-database file name
+% If you are not using BibTeX to manage your citations, use
+% \begin{thebibliography}{number}
+% \end{thebilbiography}
+% as usual. Note that if you choose this route, formatting the bibliography
+% is your responsibility.
+
\end{document}
%</template>