path: root/macros/latex/contrib/mitthesis/mitthesis-doc/mitthesis-doc.tex

% !TEX TS-program = lualatex
% !TEX encoding = UTF-8 Unicode

% Version date: 1 July 2024

\DocumentMetadata 
{
	pdfstandard = a-4,
	pdfversion  = 2.0,
%    testphase   = {phase-III, table, firstaid, math},
	lang		= en-US,
%	debug		= {xmp-export}, % note that subject entries are all fine in dc format of outputted xmpi file.
}

%%%%%%%%%%%%%%%

\documentclass[11pt]{article}

\usepackage[letterpaper,margin=1in,footskip=0.5in]{geometry} 
\usepackage{metalogo}
\usepackage{hologo}
\newcommand*\pdfTeX{\hologo{pdfTeX}}

\usepackage[x11names,svgnames,dvipsnames,table]{xcolor}
\usepackage{luacolor} % load AFTER xcolor

\usepackage[en-US]{datetime2} %% change default date format
\makeatletter
\newcommand{\daymonthyeardate}{%
  \DTMenglishordinal{\@dtm@day}\space\DTMenglishmonthname{\@dtm@month} \@dtm@year
}
\makeatother

\usepackage{booktabs}


%%%%%%%%%  Set up text and math fonts  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\usepackage[warnings-off={mathtools-colon,mathtools-overbracket}]{unicode-math}
% unicode math loads the fontspec package

\setmainfont{texgyreheros}[% Presumes these are system fonts! Available at: http://www.gust.org.pl/projects/e-foundry/tex-gyre
	WordSpace = {1,1.4,1},
	Extension = .otf,
	UprightFont = *-regular,
	ItalicFont = *-italic,
	BoldFont = *-bold,
	BoldItalicFont = *-bolditalic,
	Numbers = Lining,
	Scale=0.91,% same as for newtx
			]        
\setsansfont{texgyreheros}[% Presumes these are system fonts! Available at: http://www.gust.org.pl/projects/e-foundry/tex-gyre
	WordSpace = {1,1.4,1},
	Extension = .otf,
	UprightFont = *-regular,
	ItalicFont = *-italic,
	BoldFont = *-bold,
	BoldItalicFont = *-bolditalic,
	Numbers = Lining,
	Scale=0.91,% same as for newtx
			]        
\setmonofont{Inconsolatazi4}[% This otf font ships with the LaTeX Inconsolata package (it's in TeX Live)
    Scale=1.05,%
    Extension = .otf,
    UprightFont = *-Regular,
    ItalicFont = *-Regular,% has no italic face
    BoldFont = *-Bold, 
	BoldItalicFont = *-Bold,% has no bold italic face
    RawFeature = {+ss01,+ss02,+ss03},
    ]             
\setmathfont{STIXTwoMath-Regular}[% nice glyphs, but kerning requires fixes %% https://github.com/stipub/stixfonts.
	Scale=MatchUppercase,
	Extension = .otf,
%    Color=NavyBlue, 
	RawFeature = {+ss01, -ss02, -ss08},
]% ss01 -- switch calligraphic to script; +ss02 -- variants of g, u, v, w, z; +ss08 -- upright integrals

\setmathfontface\mathbf{STIXTwoText-Bold.otf}% to not get text font's sans bold ... could change other text-math faces, if desired


%%%%%%%%%%%   Hyperref related   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\usepackage[psdextra]{hyperref}

\hypersetup{%
    unicode,%
%	pdftex,%
	pdfborder={0 0 0},%
	bookmarksnumbered=true,%
	bookmarksopen=true,%
	bookmarksopenlevel=2,%
	colorlinks=true,
	linkcolor=blue,
	citecolor=blue,
	urlcolor=violet,
	filecolor=red, 
	anchorcolor=yellow,% not all pdf viewers recognize this field (Firefox does)
%	colorscheme=phelype,% overrides link, cite, url, file colors with a preset scheme, through \DocumentMetadata
	pdfpagelayout=SinglePage,
	pdfdisplaydoctitle=true,%
	pdfstartview=Fit,
	pdfmetalang={en},
	pdftitle={Documentation for the MIT thesis template},%
	pdfkeywords={John Lienhard, Massachusetts Institute of Technology, MIT, thesis, dissertation, template, latex},%
	pdfnewwindow=true,%
	pdfauthor={John H. Lienhard},
	pdfauthortitle={Professor of Mechanical Engineering},
	pdfcaptionwriter={{John H. Lienhard,  V}}, %{\xmpquote{John H. Lienhard\xmpcomma\  V}},
	pdfurl={https://lienhard.mit.edu},
	pdfcontactemail={lienhard@mit.edu},
	pdfcontactaddress={77 Massachusetts Avenue, Room 3-166},
    pdfcontactcity={Cambridge, MA},
    pdfcontactpostcode={02139},
    pdfcontactcountry={USA},
    pdfcontacturl={https://lienhard.mit.edu},
    pdfcopyright={Copyright © \the\year\ by John H. Lienhard. Reuse under the MIT license},
	pdfsubject={Documentation for the MIT thesis class and template},
	pdflicenseurl={https://ctan.org/license/mit},
	}

% Directly add the xmp property that shows work is copyrighted. See l3pdfmeta.pdf. 
% This is not automatic with \DocumentMetadata. "True" must be capitalized. 
\ExplSyntaxOn
	  \cs_if_exist:NTF \pdfmeta_xmp_add:n {\pdfmeta_xmp_add:n{<xmpRights:Marked>True</xmpRights:Marked>}}{}
\ExplSyntaxOff
	
\urlstyle{same}   % this changes font for \url to the current text font, but it is not recognized by \href.  

%\RequirePackage{bookmark}% improves handling of pdf bookmarks
%\providecommand\hrefurl[2]{\href{#1}{#2}}% to address certain issues around URL recognition with new pdf management code


%%%%%%%%  A nomenclature environment, if needed  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\providecommand{\nomname}{Nomenclature}  
\newlength\nomenwidth
\newlength\savitemsep

\makeatletter
% nomenclature entries
\NewDocumentCommand\entry{m m}{%
    \item[#1\hfill]#2%
    \@itempenalty=-\@lowpenalty
}
% nomenclature subheadings 
\NewDocumentCommand\EntryHeading{m}{%
	\itemsep3\p@ plus 1\p@ minus 1\p@
    \goodbreak\item[\itshape#1\hfill]\mbox{}% mbox added for tagged pdf 2023/10/11
    \setlength{\itemsep}{\savitemsep}\@itempenalty=1000
}
\makeatother
%
%   Increase first optional argument to a dimension > 2em if wide entries cause undesired misalignment of columns. 
%   Second optional argument can be used to rename the environment, e.g., to List of Symbols.
%   Third optional argument selects section-level or chapter-level style for the nomenclature list.
\newcounter{dummy}% for tagging code
\NewDocumentEnvironment{nomenclature}{O{2em} O{\nomname} O{section}}{%
    \setlength\columnsep{2em} 
    \setlength{\nomenwidth}{#1}
    \csname #3\endcsname *{#2}% this level will vary amongst users!
%	\refstepcounter{dummy}\addcontentsline{toc}{#3}{#2}% omit contentsline for this document!
    \raggedright
    \begin{list}{}{%
         \setlength{\itemsep}{0pt}%
         \setlength{\parsep}{\itemsep}%
         \setlength{\labelsep}{1em}%
         \setlength{\labelwidth}{\nomenwidth}%
         \setlength{\leftmargin}{\labelwidth}%
         \addtolength{\leftmargin}{\labelsep}%
		 \setlength{\savitemsep}{\itemsep}%
    }%
}{\end{list}\ignorespacesafterend}


%%%%%%%%%%%%%   End preamble   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\renewcommand\abstractname{SUMMARY}

\begin{document}

\begingroup  
  \centering
  \LARGE The MIT thesis template\\[1em]
  \large 
  John H. Lienhard \\ Department of Mechanical Engineering \\ Massachusetts Institute of Technology
  \\[1em]
  \daymonthyeardate\\[1em]
\endgroup


\phantomsection\pdfbookmark[1]{\abstractname}{summary}
\begin{abstract}
This \LaTeX\ class formats theses according to the requirements of the MIT Libraries. The template is suitable for MIT theses of all types and at all levels. The title and abstract pages are automatically laid out from information provided by the user. The template includes options to use a variety of typefaces, and it is compatible with either pdfTeX or unicode engines such as luaLaTeX. When using LaTeX formats dated November 2022 or later, the resulting pdf file meets the PDF/A-2b archivability standard. A standard \href{https://www.tug.org/texlive/}{\TeX\ Live} installation includes all other packages required by the template.  This document provides instructions for installation and use of the template.
\end{abstract}

\tableofcontents

\section{BACKGROUND}

The original MIT Thesis template was written \LaTeX\ 2.09 by Stephen Gildea in the late 1980s (in CTAN, \href{https://mirrors.ctan.org/obsolete/macros/latex209/contrib/mitthesis/mitthesis.sty}{here}). That template was edited by many later students.

LaTeX has changed greatly since the original MIT thesis template was written. \LaTeX\ 2.09 was replaced by \LaTeXe\ in 1994. New engines were developed, particularly pdfTeX during the 1990s and Unicode-aware engines in the decades that followed. Many packages and fonts were developed to accompany the original platform, particularly after 2000; and major updates to the LaTeX kernel began in 2018. Over the years, the MIT Libraries changed the required format several times, especially as electronic thesis submission became the norm. The original template served MIT well; but by the early 2020s, it was substantially out of date. That situation motivated the creation of a new template. 

This new MIT thesis template was developed in 2023 at the request of the MIT Libraries.  The title and abstract pages strictly follow the current \href{https://libraries.mit.edu/distinctive-collections/thesis-specs/}{requirements of the Libraries}. The underlying code is entirely new, with extensive use of  \texttt{expl3} syntax.

\section{SYSTEM REQUIREMENTS AND INSTALLATION}
The new \texttt{mitthesis} class uses the features of \LaTeX\ as of 2022, with limited backward compatibility. An up-to-date \LaTeX\ system is therefore necessary when using this template.  

\LaTeX\ is a free, open source system. The entire system is distributed through the \TeX\ Live platform (\url{https://www.tug.org/texlive/}), including the basic format, packages, and user interfaces.  The system operates on Windows, MacOS, and Unix/Linux. \TeX\ Live is formally updated each year in the spring, and the associated utility package allows users to download the most current codes more frequently if they desire. (At the time of this writing, the commercial platform Overleaf.com provides a similar functionality.)

If you are missing a package or documentation, you may obtain it at no cost from CTAN (\href{http://ctan.org}{ctan.org}). 

\subsection{Downloading the template}
The files needed for preparing your thesis are in the CTAN repository: \url{https://ctan.org/pkg/mitthesis}. Copy the subdirectory \texttt{MIT-thesis-template} onto your system. That directory contains files you can modify into your own thesis. 

If the most current version of \texttt{mitthesis.cls} is installed in your system (e.g., if you use an up-to-date version of \TeX\ Live), you are all set.  If not, copy the file \texttt{mitthesis.cls} into your working directory. If you plan to use fonts other than the default fonts, ensure that the subdirectory \texttt{fontsets} is present in your working directory.

\subsection{File structure}
The new MIT thesis template consists of: \texttt{mitthesis.cls}; a root file \texttt{MIT-Thesis.tex}; a file to load the abstract, \texttt{abstract.tex}; a file for design options, \texttt{mydesign.tex}; and an optional file to change the fonts (see the subdirectory, \texttt{fontset}). You should change the name of the root file to something more descriptive of your own work (e.g., \texttt{JohnsThesis.tex}, \texttt{MagnumOpusScientiae.tex},\ldots). In addition, files must be loaded for acknowledgments, an optional biosketch, chapters, optional appendices, and bibliography.

\subsection{\LaTeX\ engine}
The template works with either \pdfTeX\ or unicode engines such as \LuaLaTeX.  With the latter, fonts that you install in your operating system can be configured for use in your thesis. \LuaLaTeX\ also enables the direct use of lua code in your \texttt{.tex} file. With lua code, you can automate plotting, table generation, and other numerical computations.

\subsection{PDF/A compliance}
PDF/A-2b compliance will be automatic if the \verb|\DocumentMetadata{pdfstandard = a-2b}| command is issued before the \verb|\documentclass{..}| command and \textit{provided that your graphics are also compliant}. This command was added to \LaTeX\ in June 2022. For older versions of \LaTeX,
PDF/A compliance will require post-processing (for example, by using the PreFlight function of Adobe Acrobat).  Current \LaTeX\ development (ca.~2024) is working toward fully \textit{accessible} PDF/A out of the box (e.g., PDF/A-2a). Unicode compliance (e.g., PDF/A-2u) depends greatly on your fonts and figures.



\section{SETTING UP TITLE PAGE, ABSTRACT, AND BIBLIOGRAPHY}
Various fields and commands must be changed to your own information in the preamble of \texttt{MIT-Thesis.tex} and immediately after the \verb|\begin{document}| command. This information includes the title, author, degree and other essential information.  With the comments in \texttt{MIT-Thesis.tex}, this step should be self-explanatory. Nevertheless, some explanation follows.


\begin{enumerate}
\item In the \verb|\hypersetup{..}| command, change the sample file to match your own information (e.g., keywords, subject, etc.). These commands generate metadata that are incorporated into the pdf file.  

\item \verb|\title{the title of your thesis}|

\item \verb|\Author{author full name}{author department}[1st PREVIOUS degree][2nd...| \linebreak
Note that third, fourth, fifth, and sixth arguments are optional [..] and may be omitted.  Use once for each author.

\item \verb|\Degree{name of degree}{department giving degree}|. Use once for each degree fulfilled by the thesis. 

If two departments jointly issue a single degree, leave the degree argument blank for the \textit{second} degree: 
\verb|\Degree{}{2nd department name}|.  
If the thesis satisfies two degrees from one department, leave the department argument blank for 
the \textit{second} degree: \verb|\Degree{2nd degree name}{}|. 

If you wish to cause a line break in a very long degree name, you can insert \verb|\\| at an appropriate point.
Department names should not break across lines.  For example:
\begin{quote}
\verb|\Degree{Doctor of Philosophy \\ in \\ Electrical Engineering and Computer|\linebreak
\hbox{}\qquad\verb|Science}{Department of Electrical Engineering and Computer Science}|
\end{quote}

\item \verb|\Supervisor{supervisor name}{supervisor title}|. Use once for each supervisor. See \S\ref{sec:6.3} if your supervisor has more than one title.

\item \verb|\Acceptor{acceptor name}{acceptor title}{thesis related position}|. Professor who accepts theses for your department (e.g., the Graduate Officer). Use once for each department. 

\item \verb|\DegreeDate{Month}{year}|. Date degree is awarded (February, May, June, or September).  

\item \verb|\ThesisDate{date}|. Date that your final thesis is submitted to the department.
\end{enumerate}

\subsection{Copyright license}
If you wish to make your thesis available under a Creative Commons License, issue the following command between
\verb|\begin{document}| and \verb|\maketitle|: \verb|\CClicense{license type}{license url}|.  For example,
 
\vskip 5pt
\noindent\quad\verb|\CClicense{CC BY-NC-ND 4.0}{https://creativecommons.org/licenses/by-nc-nd/4.0/}|.

\subsection{Bibliography}
You may generate your bibliography using either \texttt{biblatex/biber} or \texttt{natbib/bibtex}.  The template is set up for \texttt{biblatex} by default, rather than the older, less flexible \texttt{natbib}.  The \texttt{biblatex} package is very powerful, and you can customize most aspects the reference list and citations to suit your needs. See the documentation for details: \hrefurl{https://ctan.org/pkg/biblatex}{ctan.org/pkg/biblatex}.

The style of citations and references can be set in your \texttt{.tex} file. For numerical citations of references (e.g., [1]), you can do
\vskip 5pt
\verb|\usepackage[style=ext-numeric-comp,giveninits=true,sorting=none]{biblatex}|
\vskip 5pt
\noindent For IEEE style citations and references, you might do
\vskip 5pt
\verb| \usepackage[style=ieee,maxbibnames=10,sorting=none]{biblatex}|
\vskip 5pt
\noindent For author/year style (Smith, 2024), you might do
\vskip 5pt
\verb| \usepackage[style=authoryear, maxbibnames=10]{biblatex} |
\vskip 5pt
\noindent In the author/year style, \verb|\cite{..}| commands do not automatically produce parentheses. Instead, you can do
\verb|\parencite{..}| to get ``(Author, year).''

\section{CLASS OPTIONS}
Class options may be specified for \verb|\documentclass[..]{mitthesis}|. These options are described in Table~\ref{tab:1} and the subsections that follow.

\begin{table}[b]
\caption{Options to the document class\label{tab:1}}
\smallskip\setlength\extrarowheight{3pt}%
\centering{%
\small
\begin{tabular}{>{\ttfamily}l<{} >{\raggedright\arraybackslash}p{42em} }
\toprule
\textrm{Class option} & Effect \\
\midrule
fontset 	& is a keyvalue, \texttt{fontset = <\textit{name}>}, which selects the set of fonts used for the thesis. See description below. \\
lineno 		& this option loads  the \texttt{\hrefurl{https://ctan.org/pkg/lineno}{lineno}} package, which provides line numbers, as for editing. The \texttt{\hrefurl{https://ctan.org/pkg/lineno}{lineno}} package  provides additional commands to control line numbering. \\
mydesign 	& this option loads the file \texttt{mydesign.tex}, which in turn loads the packages \texttt{\hrefurl{https://ctan.org/pkg/xcolor}{xcolor}}, \texttt{\hrefurl{https://ctan.org/pkg/titlesec}{titlesec}}, \texttt{\hrefurl{https://ctan.org/pkg/enumitem}{enumitem}}, \texttt{\hrefurl{https://ctan.org/pkg/caption}{caption}}, \texttt{\hrefurl{https://ctan.org/pkg/subcaption}{subcaption}}, and anything else that affects document design. You may edit \texttt{mydesign.tex} 
as you prefer.\\
twoside 	& gives facing-page behavior for two-sided printing; omitting it will eliminate the even-numbered blank pages.\\[\jot]
\bottomrule
\end{tabular}}%
\end{table}

\subsection{Font loading}
By default, \texttt{mitthesis.cls} will load the traditional \LaTeX\ typeface, Computer Modern (for \pdfTeX) or Latin Modern (for unicode engines).  By using the key value \texttt{fontset=$\cdots$} in the \verb|\documentclass| command, you can select a different set of fonts.  

Ten font sets are predefined, including the default set (see Table~\ref{tab:2}).  Three work only with \pdfTeX, four work only with unicode engines, and three work with either.  These options include a mixture of serif or sans serif text and math fonts, as shown in the table. To access the predefined font sets, you \textit{must} have the directory \texttt{fontsets} as a subdirectory of your working directory, including its files as named.

Among the predefined font sets, Termes and NewTX are serifed typefaces similar to the digital typeface Times New Roman.  STIX Two is more similar to the original metal-type Times typeface. Linux Libertine is a serif typeface inspired by 19\textsuperscript{th} century book type. Lucida is a serifed typeface designed for high legibility at small size or on low resolution devices. Lucida is excellent for mathematics and includes a complete bold-face math font, but it is not free. Heros and NewTX-sans are sans-serif text typefaces similar to Helvetica. NewTXsf is a sans-serif math font which draws upon glyphs from the STIX fonts. Fira is a humanist sans-serif text typeface designed in association with the Firefox browser. Finally, Computer Modern (and its extension Latin Modern)---the traditional \LaTeX\ typeface---is a Didone typeface, with high contrast between thick and thin elements.   
% STIX Two, Termes, and LMR do not include a separate bold math font.

You may also place your own font-set file, say \texttt{Myfontset.tex}, in your working directory, and load it with:
\verb|\documentclass[fontset=Myfontset]{mitthesis}|.

\begin{table}[t]
\caption{Predefined font sets\label{tab:2}}
\smallskip
\centering{%
\small
\begin{tabular}{>{\ttfamily}l<{}l l p{3em} p{3em} >{\raggedright\arraybackslash}p{22em} }
\toprule
fontset & \pdfTeX & unicode & text font & math font & details \\
\midrule
fira-newtxsf 	& yes 	& no 	& sans 	& sans 	& included in \TeX\ Live \\
newtx		 	& yes 	& no 	& serif & serif & included in \TeX\ Live \\
newtx-sans-text & yes 	& no 	& sans 	& serif & included in \TeX\ Live \\[1em]
default		 	& yes 	& yes 	& serif & serif & CM \& LM fonts are included in \TeX\ Live \\
libertine 		& yes 	& yes 	& serif & serif & in \TeX\ Live for \pdfTeX. For unicode, OpenType text fonts freely available here 
\linebreak \url{https://sourceforge.net/projects/linuxlibertine/}\linebreak and the math font here
\linebreak \url{https://github.com/alerque/libertinus} \\
lucida 			& yes	& yes 	& serif	& serif & the Lucida fonts are available from the \TeX\ User's Group, 
\url{https://tug.org/store/lucida} \\[2em]
heros-stix2  	& no 	& yes 	& sans 	& serif & \url{http://www.gust.org.pl/projects/e-foundry/tex-gyre} \linebreak\url{https://github.com/stipub/stixfonts} \linebreak  fonts are free \\
stix2			& no	& yes	& serif	& serif	& \url{https://github.com/stipub/stixfonts}, fonts are free\\
termes			& no	& yes	& serif	& serif	& \url{http://www.gust.org.pl/projects/e-foundry/tex-gyre} fonts are free\\
termes-stix2	& no 	& yes	& serif & serif & \url{http://www.gust.org.pl/projects/e-foundry/tex-gyre} \linebreak\url{https://github.com/stipub/stixfonts}\linebreak fonts are free\\
\midrule
\multicolumn{5}{l}{Typewriter (monospaced) fonts are also loaded for unicode} & Inconsolata (sans serif): \url{https://ctan.org/tex-archive/fonts/inconsolata} Cursor (serif): \url{http://www.gust.org.pl/projects/e-foundry/tex-gyre} \\
\bottomrule
\end{tabular}}%
\end{table}

\subsection{Design options}
The thesis will follow the default styles of the \LaTeX\ report class for sections headings, captions, and lists.  If you prefer different styles you can use the class option [mydesign] which loads the file \texttt{mydesign.tex}.  

With \texttt{mydesign.tex}, you can set options for packages that manage color, e.g.\ \texttt{\hrefurl{https://ctan.org/pkg/xcolor}{xcolor}}, that change the margins, or that change the design of titles, captions, and lists: \texttt{\hrefurl{https://ctan.org/pkg/titlesec}{titlesec}}, \texttt{\hrefurl{https://ctan.org/pkg/caption}{caption}}, or \texttt{\hrefurl{https://ctan.org/pkg/enumitem}{enumitem}}. You can also load other packages.  The \texttt{mitthesis} class will insert these commands at the appropriate point (prior to loading  \texttt{\hrefurl{https://ctan.org/pkg/babel}{babel}}, fonts, or  \texttt{\hrefurl{https://ctan.org/pkg/hyperref}{hyperref}}).  You should not need to edit the class file.

Hyperlink colors and pdf bookmark or viewing options from the \texttt{hyperref} package can be changed by using \verb|\hypersetup{ .. }| in the preamble or using \verb|\AtBeginDocument{ \hypersetup{ .. } }| in the \texttt{mydesign.tex} file.

\subsection{Single-sided vs.\ double-sided layout}
The sample template uses the option \texttt{[twosided]}, which starts major sections (abstract, table of contents, chapters, etc.) on odd-numbered pages.  This arrangement is suitable for two-sided printing, but can lead to empty even-numbered pages. If you do not wish to have this behavior, omit that option.  By default, even and odd page margins are the same; this can be changed in \texttt{mydesign.tex} if necessary.

\subsection{Additional commands}
The class also provides \verb|\DegreeYear|, \verb|\DegreeMonth|, and \verb|\CopyrightAuthor|. The latter combines all author names into a single token list, e.g., ``Joseph O. Hirschfelder, Charles F. Curtiss and R. Byron Bird''; a period at the end of the final name (e.g., as in ``John F. Nash Jr.'') is removed.

\subsection{Nomenclature}
An optional nomenclature environment is provided by the class.  This environment can support either chapter-by-chapter nomenclature (at the section level) or a single nomenclature for the entire thesis (at the chapter level). The environment has three optional arguments: [1] adjust space between symbol and definition; [2] name (heading) of the nomenclature list; and [3] level, which can be ``chapter'' or ``section'' depending on whether you
have one nomenclature list for whole thesis or one for each chapter (the default is section). 

For example, the following code 
\begin{center}
\begin{minipage}{0.8\textwidth}
\begin{verbatim}
\begin{nomenclature}[2em][Nomenclature for Chapter 1][section]
\EntryHeading{Roman letters}
\entry{$\mathcal{C}$}{material curve}
\entry{$\mathbf{u}$}{velocity [m s$^{-1}$]}
\EntryHeading{Greek letters}
\entry{$\Gamma$}{circulation [m$^2$ s$^{-1}$]}
\entry{$\rho$}{mass density [kg m$^{-3}$]}
\end{nomenclature}
\end{verbatim}
\end{minipage}
\end{center}
produces the nomenclature list below
\begin{center}
\begin{minipage}{0.8\textwidth}
\begin{nomenclature}[2em][Nomenclature for Chapter 1][section]
\EntryHeading{Roman letters}
\entry{$\mathcal{C}$}{material curve}
\entry{$\mathbf{u}$}{velocity [m s$^{-1}$]}
\EntryHeading{Greek letters}
\entry{$\Gamma$}{circulation [m$^2$ s$^{-1}$]}
\entry{$\rho$}{mass density [kg m$^{-3}$]}
\end{nomenclature}
\end{minipage}
\end{center}

\section{PACKAGES FOR MATH, CHEMISTRY, CODE, TABLES, AND MORE}
The \texttt{mitthesis} class loads the \texttt{amsmath} package and its extension \texttt{mathttools}. These packages provide many useful macros for typesetting equations and symbols, such as: environments for aligning and splitting equations or groups of equations; tools for matrices; a wide variety of operators and symbols; tools to define new math operators and paired delimiters; and much, much more. If you are including equations, look at the documentation for these packages: \url{https://ctan.org/pkg/amsmath} and \url{https://ctan.org/pkg/mathtools}.\looseness=1

Specialized packages for many disciplines can be found in \hrefurl{https://ctan.org}{CTAN}.  These include subjects like \hrefurl{https://ctan.org/topic/chemistry}{chemistry}, \hrefurl{https://ctan.org/topic/linguistic}{linguistics}, and \hrefurl{https://ctan.org/topic/physics}{physics}.  As examples of such packages, the sample thesis template uses the package \texttt{\hrefurl{https://ctan.org/pkg/mhchem}{mhchem}} to set chemical equations and the package \texttt{\hrefurl{https://ctan.org/pkg/listings}{listings}} to list computer code.

Several packages focus on table and tabular environments.  The \texttt{\hrefurl{https://ctan.org/pkg/booktabs}{booktabs}} package, use in the sample thesis template, produces better quality horizontal lines (called \textit{rules}) for separating material in tables.  The \texttt{\hrefurl{https://ctan.org/pkg/array}{array}} package (also used) provides additional options for column formats in tabular environments, and the \texttt{\hrefurl{https://ctan.org/pkg/dcolumn}{dcolumn}} package aligns columns of numbers on the decimal separator. 

When selecting a package to use, check that it is currently maintained (with relatively recent updates), and compare it to other packages that perform similar functions.  Some packages are better than others, and some obsolete packages remain online.

The packages called by \texttt{mitthesis} are listed in Table~\ref{tab:3} on page~\pageref{tab:3}.

\begin{table}
\caption{External packages used. For documentation, visit CTAN, \url{https://ctan.org}.  Alternatively, if you have \hrefurl{https://www.tug.org/texlive/}{\TeX\ Live} installed, you can open a terminal window and type \texttt{\%\  texdoc package-name}.\label{tab:3}}
\vskip5pt
\centering{\small%
\setlength\extrarowheight{3pt}
\begin{tabular*}{\textwidth}{>{\ttfamily}l<{}@{\extracolsep{\fill}}p{18em} p{22em} }
\\[-5pt]
\toprule
Package & Class & User \\
\midrule
bm		 & defines commands to access bold math symbols (loaded for default fonts) & with \pdfTeX, the command \verb|\bm{..}| produces a bold math symbol \\
bookmarks& is loaded automatically under the new pdf-management system & customize pdf bookmarks \\
doi		 & support for hyperlinking DOIs		&  hyperlink a doi number: \verb|\doi{..}| \\
etoolbox & extend or modify other macros  		&  can use in preamble if needed \\
geometry & set page size and margins			&  can use \verb|\newgeometry| in \texttt{mydesign.tex}\\
graphicsx& support for inserting images			&  use to include graphics\\
hyperref & support for hyperlinks and metadata  &  must complete setup in preamble\\
iftex	 & check which \LaTeX\ engine is running&  macros to check which engine, e.g., \verb|\ifpdftex| \\
mathtools& loads and extends \texttt{amsmath} 	&  \textbf{many useful math macros available}.  See documentation for \texttt{amsmath} and \texttt{mathtools} \\[0.7em]
\midrule
hyperxmp & fallback if no \verb|\DocumentMetadata{..}|&  ---\\
kvoptions& key values for systems pre 2022/11/01 & ---\\
xparse	 & for systems older than 2020/10/01 & macros to define new commands\\
\midrule
lineno	 & loaded if class option is given		& keyvalue \texttt{lineno} will give line numbers; \texttt{lineno} package adds commands to control numbering\\[0.7em]
\midrule
caption    & also loaded by \texttt{mydesign.tex} 		& support for caption styling \\
subcaption & also loaded by \texttt{mydesign.tex}		& support for subfigures within figures \\
titlesec   & also loaded by \texttt{mydesign.tex} 		& support for styling section headings \\
xcolor	   & also loaded by \texttt{mydesign.tex} 		& support for colors, including colored fonts \\[0.7em]
array	   & --- & additional options for formatting table columns \\
booktabs   & --- & better quality tables, with additional commands \\
dcolumn    & --- & align number columns on selectable separators \\
\midrule
babel	 & --- & if you use multiple languages, load \texttt{babel} in a fontset file before loading fonts \\
biblatex & --- & sample template uses this bibliography tool. Change to \texttt{natbib} if you prefer\\
fontenc	 & --- & load this in a fontset file if using \pdfTeX\\
fontspec & --- & load this in a fontset file if using a unicode engine (\texttt{unicode-math} loads \texttt{fontspec} by default)\\
lipsum   & --- & create filler text (see sample template, Chapter~1) \\
listings & --- & for listing computer code (see sample template, Appendix~A) \\
mhchem   & --- & to format chemical formul\ae\ (see sample template, Chapter~1) \\
setspace & --- & can be loaded to change the default line spacing, if desired (e.g., for ``double-spacing'')\\
unicode-math & --- & load in a fontset file if using a unicode engine\\
\bottomrule
\end{tabular*}}%
\end{table}

\section{TROUBLESHOOTING AND MODIFICATIONS}

\subsection{Listing thesis committee members or using a signature page}
Listing committee members (with or without signatures) is not required under MIT's thesis specifications. Only the thesis supervisor should appear on the title page, not a list of committee members.  However, some departments may require a separate committee or signature page.  That page can be inserted by the author between the title and abstract pages.  Check with your department about this page and any associated formatting requirements. 

\subsection{Dealing with multiple titles in the signature block}\label{sec:6.3}
When a thesis supervisor has multiple titles (and both will not fit on one line), you can obtain a line break with proper horizontal spacing by doing
	\vskip 5pt
	\quad\verb|\Supervisor{name}{first title and \\ \> second title}|
	\vskip 5pt
\noindent\textbf{\TeX hackers note:} The signature block is typeset as a \LaTeX\ \texttt{tabbing} environment.

\subsection{Overflowing title page: managing space} If your title page overflows the vertical space (from too many authors, degrees, previous degrees, etc.), you can using some or all of the following techniques. The commands must be given before \verb|\maketitle|.
\begin{enumerate}
 \item Reduce the 12 pt and 18 pt skips between the various blocks of text to 6 pt with this command:
	\vskip 5pt
	\noindent\verb|\Tighten|
 \item Reduce the font size in the signature block with this command:
	\vskip 5pt
	\noindent\verb|\SignatureBlockSize{\small}| 
 \item Put the acceptor name and title onto two lines, rather than three, by putting the acceptor's position into the 2\textsuperscript{nd} argument and leaving the 3\textsuperscript{rd} argument blank:
	\vskip 5pt
	{\small\noindent\verb|\Acceptor{Tertius Castor}{Professor and Graduate Officer, Department of Research}{}|}
 \item Reduce the font size of the the author name[s] from \verb|\large| to \verb|\normalsize| with this command:
	\vskip 5pt
	\noindent\verb|\AuthorNameSize{\normalsize}|
 \item Omit previous degrees from the title page, instead mentioning them in the biographical sketch.
\end{enumerate}


\subsection{Push title page text toward top} If you prefer to keep the text toward the top of the page with most white space at the bottom, you
can use this command to squash the vertical glue (\TeX's stretchy space):
	\vskip 5pt
	\quad\verb|\Squash| 
	\vskip 5pt
\noindent This command is useful when the text has not already reach the bottom of the page, since the glue gets squashed automatically when the page is too full.

\subsection{Changing paragraph separation}
If you prefer to denote paragraph breaks by vertical space rather than indentation, you can try the \texttt{parskip} package: \hrefurl{https://ctan.org/pkg/parskip}{ctan.org/pkg/parskip}. See that package's documentation for details.

\subsection{Use outside MIT}
To adapt this template for use at a different institution, you can put the following commands in your preamble.  
\begin{itemize}
\item Use \verb|\Institution{Your Institution}| to change MIT to your own institution on the title page.

\item Use \verb|\maketitle*| (in place of \verb|\maketitle|) to drop the MIT copyright permission statement

\item If your institution issues degrees in months other than February, May, June, or September, you can still put those months into the 
\verb|\DegreeDate| command. To suppress the resulting error message, put \verb|\SuppressMonthError| before \verb|\maketitle*|. 

\item Omitting \verb|\Acceptor| commands will drop the ``Accepted by:'' field. To suppress the resultant error message, put \verb|\SuppressAcceptorError| before \verb|\maketitle*|.

\item To change ``Thesis Supervisor'' to something else use \verb|\SupervisorDesignation{..}|.
\end{itemize}
Please do not remove the license/copyright text from the sources files --- this code took me some time write!

\section[RESOURCES FOR LATEX]{RESOURCES FOR \LaTeX}
\LaTeX\ documentation is easy to find online. A few useful resources, among many, are these:
\begin{description}
\item[\LaTeX\ Wikibook.] \url{https://en.wikibooks.org/wiki/LaTeX}. An online tutorial book.
\item[\LaTeX 2e: An unofficial reference manual.] \url{https://latexref.xyz/dev/latex2e.html}. A comprehensive explanation of each \LaTeX\ command, from the \TeX\ User's Group. 
\item[\TeX\ Stack-Exchange.]\ \url{https://tex.stackexchange.com/}. More than 250,000 answered questions, and you can ask your own!
\item[ChatGPT.] At the time of this writing, ChatGPT, a chatbot based on a large language model, could sometimes accurately answer \LaTeX-related questions or write acceptable \LaTeX\ and expl3 code.
\end{description}

\vskip 30pt

\centering{\color{Red3}\Large\textbf{\textit{Good luck with your thesis and your thesis defense!}}


\end{document}