summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/msu-thesis
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2017-12-20 23:16:34 +0000
committerKarl Berry <karl@freefriends.org>2017-12-20 23:16:34 +0000
commitae958dc3e079c58c21183c625f1da27d158c0207 (patch)
tree4eeb21c57d1227cdc1b5287ce0db0a1e395937a4 /Master/texmf-dist/doc/latex/msu-thesis
parent447dc264ab527086b26ff833b290df29969288de (diff)
msu-thesis (20dec17)
git-svn-id: svn://tug.org/texlive/trunk@46106 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/msu-thesis')
-rw-r--r--Master/texmf-dist/doc/latex/msu-thesis/README6
-rw-r--r--Master/texmf-dist/doc/latex/msu-thesis/msu-thesis.pdfbin224413 -> 226815 bytes
-rw-r--r--Master/texmf-dist/doc/latex/msu-thesis/msu-thesis.tex37
-rw-r--r--Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-template.pdfbin28559 -> 55385 bytes
-rw-r--r--Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-template.tex20
-rw-r--r--Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-testfile.lol2
-rw-r--r--Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-testfile.pdfbin134790 -> 135882 bytes
-rw-r--r--Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-testfile.tex5
8 files changed, 53 insertions, 17 deletions
diff --git a/Master/texmf-dist/doc/latex/msu-thesis/README b/Master/texmf-dist/doc/latex/msu-thesis/README
index fe7b267c065..33897dc31e6 100644
--- a/Master/texmf-dist/doc/latex/msu-thesis/README
+++ b/Master/texmf-dist/doc/latex/msu-thesis/README
@@ -1,10 +1,10 @@
-MSU Thesis Class Version 2.7 2017/06/22
+MSU Thesis Class Version 2.8 2017/12/13
Copyright 2011,2012,2013,2014,2015,2016, 2017 by Alan Munn <amunn@msu.edu>
This is a class file for producing dissertations and theses according to
the Michigan State University Graduate School Guidelines for Electronic
-Submission of Master's Theses and Dissertations (2016).
+Submission of Master's Theses and Dissertations (October 2017).
The class is based on the memoir document class, and thefore inherits
all of the functionality of that class.
@@ -15,7 +15,7 @@ The msu-thesis class is part of both TeXLive and MikTeX, so you should either al
If you wish to install it locally, follow the directions below:
-Put msu-thesis.cls and gb4e-compat.tex into
+Put msu-thesis.cls
<local texmf>/tex/latex/msu-thesis
Put msu-thesis.tex, msu-thesis.pdf and the samples folder into
diff --git a/Master/texmf-dist/doc/latex/msu-thesis/msu-thesis.pdf b/Master/texmf-dist/doc/latex/msu-thesis/msu-thesis.pdf
index 4559f2bd6ee..b3fc5781210 100644
--- a/Master/texmf-dist/doc/latex/msu-thesis/msu-thesis.pdf
+++ b/Master/texmf-dist/doc/latex/msu-thesis/msu-thesis.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/msu-thesis/msu-thesis.tex b/Master/texmf-dist/doc/latex/msu-thesis/msu-thesis.tex
index 008efa4ac0e..e995df49daf 100644
--- a/Master/texmf-dist/doc/latex/msu-thesis/msu-thesis.tex
+++ b/Master/texmf-dist/doc/latex/msu-thesis/msu-thesis.tex
@@ -2,8 +2,8 @@
\documentclass[11pt]{article}
-\def\msuversion{2.7}
-\def\msudate{2017/06/22}
+\def\msuversion{2.8}
+\def\msudate{2017/12/13}
\title{\textbf{Using the MSU Thesis Class}}
\author{\textbf{Alan Munn}\\Department of Linguistics and Languages\\\texttt{\href{mailto:amunn@msu.edu}{amunn@msu.edu}}}
\date{Version \msuversion\\\msudate}
@@ -69,7 +69,7 @@
\thispagestyle{empty}
\renewcommand{\abstractname}{\sffamily Abstract}
-\abstract{\noindent\begin{quote} This is a class file for MSU theses and dissertations. It is based on the \pkg{memoir} class, and therefore supports all of the functionality of that class. It should generate a document which meets all the basic formatting requirements laid out by the \href{https://grad.msu.edu/etd/formatting-guide}{Formatting Guide For Submission of Master’s Theses and Doctoral Dissertations} (February 2016) produced by the Graduate School, including requirements for margins, titlepage, page numbering, section titles, sub- and superscript sizes etc.\end{quote}}
+\abstract{\noindent\begin{quote} This is a class file for MSU theses and dissertations. It is based on the \pkg{memoir} class, and therefore supports all of the functionality of that class. It should generate a document which meets all the basic formatting requirements laid out by the \href{https://grad.msu.edu/etd/formatting-guide}{Formatting Guide For Submission of Master’s Theses and Doctoral Dissertations} (October 2017) produced by the Graduate School, including requirements for margins, titlepage, page numbering, section titles, sub- and superscript sizes etc.\end{quote}}
\section{Introduction}
Formatting a dissertation according to a University's thesis requirements is not always a simple task in \LaTeX, especially since the requirements are generally aimed at MSWord users. Furthermore, most of the work of formatting a document is supposed to be done by the document class itself, and not by the individual user. Fortunately, Michigan State University's thesis requirements are actually sane, and fairly straightforward. The present class file is designed to further make the process easier for \LaTeX\ users, by doing all the heavy lifting for you, so that you can focus on the content and not the formatting.
\section{Background}
@@ -113,6 +113,7 @@ In addition to all the user functionality defined by \pkg{memoir}, the \pkg{msu-
\begin{description}
\item[\texttt{\bs fieldofstudy\{\}}] Takes one argument corresponding to your field of study.
\item[\texttt{\bs dedication\{\}}] Takes one argument (should be short), your dedication.
+\item[\texttt{\{publicabstract\}}] Environment for the public abstract (unnumbered, uncounted).
\item[\texttt{\bs makecopyrightpage}] Creates the copyright page.
\item[\texttt{\bs makededicationpage}] Creates the dedication page.
\item[\texttt{\bs makebibliographypage}] Creates the bibliography cover page.
@@ -123,7 +124,7 @@ In addition to all the user functionality defined by \pkg{memoir}, the \pkg{msu-
Most book-length documents are divided into three main kinds of parts: the front matter, the main matter, and the back matter. In \pkg{memoir} (and therefore \pkg{msu-thesis}) these sections are preceded by the commands |\frontmatter|, |\mainmatter|, and |\backmatter|. These commands tell the class when to change the page numbering, for example, front matter pages use lower case roman numerals, but main matter pages use arabic numerals.
-The basic outline of a dissertation or thesis document is shown in Table~\ref{structure}: (your thesis may not have all of these parts, but if it does, they should be in this order.)
+The basic outline of a dissertation or thesis document is shown in Table~\ref{structure}: (your thesis may not have all of these parts, but if it does, they should be in this order.) You can find an annotated copy of the basic structure in the \href{https://ctan.org/tex-archive/macros/latex/contrib/msu-thesis/samples}{\pkg{samples}} folder of the \pkg{msu-thesis} documentation.
\begin{table}[ht]
\begin{itemize}
@@ -131,10 +132,12 @@ The basic outline of a dissertation or thesis document is shown in Table~\ref{st
\item |\frontmatter|
\begin{itemize}
\item Titlepage
+ \item Public Abstract
\item Abstract
\item Copyright Page
\item Dedication
- \item Acknowlegements
+ \item Acknowledgements
+ \item Preface
\item Table of Contents
\item List of Tables
\item List of Figures
@@ -203,7 +206,25 @@ Another common kind of list is a List of Abbreviations. The thesis office seems
Your list of abbreviations here.
\end{lstlisting}
\end{quote}
+\subsection{The \pkg{microtype} package and contents lists}
+If you use the \pkg{microtype} package with |protrusion| set, it’s best to turn it off before your contents lists. You can do this by using |\microtypesetup{protrusion=false}|
+before the contents lists and |\microtypesetup{protrusion=true}| afterwards. Schematically:
+\begin{quote}
+\begin{lstlisting}
+\microtypesetup{protrusion=false}
+\tableofcontents*
+\clearpage
+\listoftables
+\clearpage
+\listoffigures
+...
+\microtypesetup{protrusion=true}
+\end{lstlisting}
+\end{quote}
+
+\subsection{Public abstract}
+If your thesis requires a public abstract, it should go immediately before the regular abstract. Use the |{publicabstract}| environment for this.
\subsection{Landscape figures and tables}
If you have large figures and tables that must be rotated, you should use the |[lscape]| class option. This enables a pagestyle |lscape| and places the page numbers correctly on the long edge of the page. The option loads the \pkg{pdflscape} package which provides a |landscape| environment to place the landscape figure in. Before the landscape environment, you need to issue a |\clearpage| command and change the pagestyle to |lscape|, and afterwards, change it back to |plain|. Schematically, then, any landscape pages should be created in the following way.
@@ -284,13 +305,13 @@ Despite there being no explicit formatting requirements for Chapter headings (ot
\section{Bugs and redistribution}
\subsection{Current version}
-The latest copy of \pkg{msu-thesis} will always be available on \href{http://tug.ctan.org/cgi-bin/ctanPackageInformation.py?id=msu-thesis}{CTAN}. If you use MiKTeX, or a current year TeX Live then their respective package managers will update or install the latest version. If you are using a Linux-based distribution, or your TeXLive distribution is not the most recent year, you may need to install the latest copy in your local |texmf| directory. If you want others to use the class, \textsc{please} point them to CTAN, so that they can get an up-to-date version with all accompanying documentation and examples rather than passing along your copy. Please report \textsc{any} problems you have with the class to me \href{mailto:amunn@msu.edu}{amunn@msu.edu}, as this will aid in making things easier for those who follow you. The Graduate School rarely announces changes it makes to the formatting requirements, so your problem reports are extremely helpful for keeping the class in compliance with the latest standards.
+The latest copy of \pkg{msu-thesis} will always be available on \href{https://ctan.org/pkg/msu-thesis?lang=en}{CTAN}. If you use MiKTeX, or a current year TeX Live then their respective package managers will update or install the latest version. If you are using a Linux-based distribution, or your TeXLive distribution is not the most recent year, you may need to install the latest copy in your local |texmf| directory. If you want others to use the class, \textsc{please} point them to CTAN, so that they can get an up-to-date version with all accompanying documentation and examples rather than passing along your copy. Please report \textsc{any} problems you have with the class to me \href{mailto:amunn@msu.edu}{amunn@msu.edu}, as this will aid in making things easier for those who follow you. The Graduate School rarely announces changes it makes to the formatting requirements, so your problem reports are extremely helpful for keeping the class in compliance with the latest standards.
\subsection{Archiving your thesis for the future}
Since the current version of the \pkg{msu-thesis} class satisfies the Graduate School requirements at any one time, as these requirements change, you may find that if you need to recompile your thesis after you have graduated that the formatting changes. To avoid this, I would recommend saving an archived version of the \pkg{msu-thesis.cls} file in the same folder as your thesis file. You only need to do this once you have completely finished your thesis however; there's no need to do it during the writing process.
\subsection{Version history}
-Previous versions of \pkg{msu-thesis} (versions 1.0--1.4b) were created for non-electronic submission and should not be used. Versions 1.5--1.6 (the first electronic submission versions) contained a |\makeabstract| command and a separate |msuabstract| environment. These have been removed as of version 1.7. Users who are upgrading from earlier versions to version 1.7 do not need to change these commands however but their use will trigger a warning.) Version 2.0 implemented landscape pages; version 2.1 added support for \pkg{hyperref}. Versions 2.2--2.5 mainly accommodated to the ever changing whims of the MSU Graduate School. Version 2.6 fixed some appendix bugs introduced by the previous whim accommodation. Version 2.7 fixed various small spacing issues, fixed a bug which prevented a new chapter page to be a landscape page, added support for the \pkg{apacite} package, and updated degree options.
+Previous versions of \pkg{msu-thesis} (versions 1.0--1.4b) were created for non-electronic submission and should not be used. Versions 1.5--1.6 (the first electronic submission versions) contained a |\makeabstract| command and a separate |msuabstract| environment. These have been removed as of version 1.7. Users who are upgrading from earlier versions to version 1.7 do not need to change these commands however but their use will trigger a warning.) Version 2.0 implemented landscape pages; version 2.1 added support for \pkg{hyperref}. Versions 2.2--2.5 mainly accommodated to the ever changing whims of the MSU Graduate School. Version 2.6 fixed some appendix bugs introduced by the previous whim accommodation. Version 2.7 fixed various small spacing issues, fixed a bug which prevented a new chapter page to be a landscape page, added support for the \pkg{apacite} package, and updated degree options. Version 2.8 fixed some spacing and capitalization issues and added support for the the public abstract.
\section{Acknowledgements}
-Thanks to Lars Madsen, Ulrike Fischer and Peter Wilson for help with setting up parts of the memoir code for versions 1.0--1.4 (now eliminated due to changed requirements). Thanks to Wolfgang Sternefeld for supplying the \pkg{linguex} spacing fix code, Leo Liu for the landscape page numbering code, which greatly simplified my original version, and Florent Chervet for the hyperref code. Thanks also to the following students who have reported problems over the years: Irina Agafonova, Ali Al-jiboory, Dmitriy Bryndin, Greg Christian, Kyle Crayne, Matt Husband, Changkuk Jung, Adam Liter, William Muir, Adam Soliman, Alicia Parrish, Neil ver Planck, Michael Wojcik and Yisu Zhou. A special thank you to Non Thongprong who graciously provided a copy of his entire thesis which allowed me to debug some especially subtle spacing inconsistencies.
+Thanks to Lars Madsen, Ulrike Fischer and Peter Wilson for help with setting up parts of the memoir code for versions 1.0--1.4 (now eliminated due to changed requirements). Thanks to Wolfgang Sternefeld for supplying the \pkg{linguex} spacing fix code, Leo Liu for the landscape page numbering code, which greatly simplified my original version, and Florent Chervet for the hyperref code. Thanks also to the following students who have reported problems over the years: Irina Agafonova, Ali Al-jiboory, Dmitriy Bryndin, Greg Christian, Kyle Crayne, Matt Husband, Changkuk Jung, Adam Liter, William Muir, Adam Soliman, Alicia Parrish, Neil ver Planck, Michael Wojcik, Eremey Valetov, Matthew Vincent and Yisu Zhou. A special thank you to Non Thongprong who graciously provided a copy of his entire thesis which allowed me to debug some especially subtle spacing inconsistencies.
\appendix
\renewcommand{\thesection}{Appendix \Alph{section}}
diff --git a/Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-template.pdf b/Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-template.pdf
index c27e35d1224..93ded329af0 100644
--- a/Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-template.pdf
+++ b/Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-template.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-template.tex b/Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-template.tex
index 0af8986940c..c0ef1706b73 100644
--- a/Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-template.tex
+++ b/Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-template.tex
@@ -1,8 +1,22 @@
% This is a template for use with the MSU Thesis class
-% Vesion 2.7 2017/06/22
+% Vesion 2.8 2017/12/13
%
% Class options:
-%[PhD] Doctor of Philosophy (default) %[DEd] Doctor of Education%[DMA] Doctor of Musical Arts%[MA] Master of Arts%[MS] Master of Science%[MAT] Master of Arts for Teachers%[MBA] Master of Business Administration%[MFA] Master of Fine Arts%[MIPS] Master of International Planning Studies%[MHRL] Master of Human Resources and Labor Relations %[MMus] Master of Music%[MPH] Master of Public Health%[MPP] Master of Public Policy%[MSW] Master of Social Work%[MURP] Master in Urban and Regional Planning
+%[PhD] Doctor of Philosophy (default)
+%[DEd] Doctor of Education
+%[DMA] Doctor of Musical Arts
+%[MA] Master of Arts
+%[MS] Master of Science
+%[MAT] Master of Arts for Teachers
+%[MBA] Master of Business Administration
+%[MFA] Master of Fine Arts
+%[MIPS] Master of International Planning Studies
+%[MHRL] Master of Human Resources and Labor Relations
+%[MMus] Master of Music
+%[MPH] Master of Public Health
+%[MPP] Master of Public Policy
+%[MSW] Master of Social Work
+%[MURP] Master in Urban and Regional Planning
%%
% Default is PhD
%
@@ -34,7 +48,7 @@
\title{The syntax and semantics of phonology}
\author{Joe Linguist}
\fieldofstudy{Linguistics} % This should be in sentence case
-\date{2016}
+\date{2017}
% If you want a dedication page, specify the text of the dedication here and uncomment the next command.
%
diff --git a/Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-testfile.lol b/Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-testfile.lol
deleted file mode 100644
index b134d58cc52..00000000000
--- a/Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-testfile.lol
+++ /dev/null
@@ -1,2 +0,0 @@
-\contentsline {listing}{\numberline {2.1}{\ignorespaces A listing caption}}{11}{listing.2.1}
-\contentsline {listing}{\numberline {2.2}{\ignorespaces Another listing caption}}{11}{listing.2.2}
diff --git a/Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-testfile.pdf b/Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-testfile.pdf
index a7f1c32a384..994c15adc0e 100644
--- a/Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-testfile.pdf
+++ b/Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-testfile.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-testfile.tex b/Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-testfile.tex
index 50c2a29c274..fe74407b75d 100644
--- a/Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-testfile.tex
+++ b/Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-testfile.tex
@@ -1,5 +1,5 @@
% !TEX TS-program = pdflatexmk
-% v2.7 Testfile
+% v2.8 Testfile
\listfiles
\documentclass[lscape]{msu-thesis}
@@ -44,6 +44,9 @@
\begin{document}
\frontmatter
\maketitlepage
+\begin{publicabstract}
+\lipsum[1]
+\end{publicabstract}
\begin{abstract}
\lipsum[1-6]
\end{abstract}