diff options
Diffstat (limited to 'macros/latex/contrib/mitthesis/mitthesis-doc/mitthesis-doc.tex')
| -rw-r--r-- | macros/latex/contrib/mitthesis/mitthesis-doc/mitthesis-doc.tex | 26 |
1 files changed, 15 insertions, 11 deletions
diff --git a/macros/latex/contrib/mitthesis/mitthesis-doc/mitthesis-doc.tex b/macros/latex/contrib/mitthesis/mitthesis-doc/mitthesis-doc.tex index a896751c37..c9431036ea 100644 --- a/macros/latex/contrib/mitthesis/mitthesis-doc/mitthesis-doc.tex +++ b/macros/latex/contrib/mitthesis/mitthesis-doc/mitthesis-doc.tex @@ -251,7 +251,7 @@ The new MIT thesis template consists of: \texttt{mitthesis.cls}; a root file \te \section*{Information you need to complete} 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 comments follow. -In the \verb|\hypersetup{..}| command, change the sample file to match your own information (name, title, keywords, etc.). These commands generate metadata that are incorporated into the pdf file. +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. The commands that define the title page are as follow. \begin{itemize} @@ -262,7 +262,7 @@ Note that third, fourth, fifth, and sixth arguments are optional [..] and may be \item \verb|\Degree{name of degree}{department giving degree}|. Use once for each degree fulfilled by thesis. If the thesis satisfies two degrees from one department, leave the department argument blank for the \textit{second} degree: \verb|\Degree{2nd degree name}{}| -\item \verb|\Supervisor{supervisor name}{supervisor department}|. Use once for each supervisor. +\item \verb|\Supervisor{supervisor name}{supervisor title}|. Use once for each supervisor. \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. @@ -280,11 +280,9 @@ If you wish to make your thesis available under a Creative Commons License, issu \vskip 5pt \noindent\quad\verb|\CClicense{CC BY-NC-ND 4.0}{https://creativecommons.org/licenses/by-nc-nd/4.0/}|. - \section*{Package options} Package options may be specified for \verb|\documentclass[..]{mitthesis}|. These options are described in Table~\ref{tab:1} and the subsections that follow. - \begin{table}[ht] \caption{Options to the document class\label{tab:1}} \smallskip\setlength\extrarowheight{3pt}% @@ -303,7 +301,7 @@ twoside & gives facing-page behavior for two-sided printing; omitting it will e \end{tabular}}% \end{table} -\subsection*{Font loading} +\subsection*{Font loading}\enlargethispage{\baselineskip}% By default, \texttt{mitthesis.cls} will load the traditional \LaTeX\ fonts, computer modern (\pdfTeX) or latin modern (unicode engines). By using the key value \texttt{fontset=$\cdots$} in the \verb|\documentclass| command, you can select a different set of fonts. Ten fontsets 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. @@ -346,7 +344,11 @@ termes-stix2 & no & yes & serif & serif & \url{http://www.gust.org.pl/projects/ \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.\footnote{If you are using different style files, say \texttt{styleA.tex} and \texttt{styleB.tex}, you can switch between them with the options [mydesign=styleA] and [mydesign=styleB].} +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. + +If you have two different style files, say \texttt{styleA.tex} and \texttt{styleB.tex}, you can switch between them with the options [mydesign=styleA] and [mydesign=styleB]. \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 the \texttt{mydesign.tex} file if necessary. @@ -366,7 +368,6 @@ bookmarks& is loaded automatically under the new pdf-management system & --- \\ doi & support for hyperlinking DOIs & hyperlink a doi number: \verb|\doi{..}| \\ etoolbox & extend or modify other macros & can use in preamble if needed \\ iftex & check which \LaTeX\ engine is running& macros to check engine \\ -ifthen & streamlined conditionals & 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\\ @@ -395,7 +396,7 @@ unicode-math & --- & load in a fontset file if using a unicode engine\\ \end{tabular*}}% \end{table} -\section*{PDF/A compatibility} +\section*{PDF/A compatibility}\enlargethispage{\baselineskip}% PDF/A-2b compliance will be automatic if the \verb|\DocumentMetadata{..}| 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, the \texttt{mitthesis} class will fall back to loading \texttt{hyperxmp} to support pdf metadata, but PDF/A compliance will require post-processing (for example, by using the PreFlight function of Adobe Acrobat). An up-to-date \LaTeX\ installation is preferred. Current \LaTeX\ development (ca.~2023) is working toward fully 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. @@ -407,7 +408,7 @@ Specialized packages for many disciplines can be found in \hrefurl{https://ctan. 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. -\section*{Nomenclature} +\section*{Nomenclature}\enlargethispage{\baselineskip}% 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 (default = section). @@ -446,14 +447,17 @@ produces the nomenclature list below \clearpage +\section*{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. + \section*{Use outside MIT} If your want to adapt this template for use at a different institution, you can put the following commands in your preamble. \begin{itemize} -\item Use \verb|\def\MIT{YOUR INSTITUTION}| to change MIT to your own institution (use all capital letters). +\item Use \verb|\Institution{Your Institution}| to change MIT to your own institution on the title page. {\small\textit{New with v1.06.}} \item Use \verb|\maketitle*| (in place of \verb|\maketitle|) to drop the MIT copyright permission statement -\item Use \verb|\setcounter{acccnt}{-2}| to remove the ``Accepted by:'' field. +\item Omitting \verb|\Acceptor| commands will drop the ``Accepted by:'' field. To suppress the resultant error message, put \verb|\SuppressAcceptorError| before \verb|\maketitle*|. \newline{\small\textit{New with v1.06.}} \end{itemize} Please do not remove the license/copyright text from the sources files. |