msu-thesis (5aug14)

git-svn-id: svn://tug.org/texlive/trunk@34858 c570f23f-e606-0410-a88d-b1316a301751

7 files changed, 26 insertions, 15 deletions

diff --git a/Master/texmf-dist/doc/latex/msu-thesis/README b/Master/texmf-dist/doc/latex/msu-thesis/README
index 7983d95ae3b..60f22a62b24 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.3 2012/12/01
+MSU Thesis Class Version 2.4 2013/05/02
 
-Copyright 2011,2012 by Alan Munn <amunn@msu.edu>
+Copyright 2011,2012,2013 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 (2012).
+Submission of Master's Theses and Dissertations (2013).
 
 The class is based on the memoir document class, and thefore inherits
 all of the functionality of that class.
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 fb3e40bcef0..d2db31546b9 100644
--- a/Master/texmf-dist/doc/latex/msu-thesis/msu-thesis.pdf
+++ b/Master/texmf-dist/doc/latex/msu-thesis/msu-thesis.pdf
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 45770f0b3f4..e285e46603a 100644
--- a/Master/texmf-dist/doc/latex/msu-thesis/msu-thesis.tex
+++ b/Master/texmf-dist/doc/latex/msu-thesis/msu-thesis.tex
@@ -1,9 +1,11 @@
+% !TEX TS-program = pdflatexmk
+
 \documentclass[11pt]{article}
 \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 2.3\\December 1, 2012}
+\date{Version 2.4\\Aug 4, 2014}
 \usepackage[T1]{fontenc}
-\usepackage[margin=1.25in]{geometry}
+\usepackage[lmargin=1.25in,rmargin=1.25in,tmargin=1in,bmargin=1in]{geometry}
 \usepackage{titling}
 \usepackage[utf8]{inputenc}
 \usepackage{array, booktabs, multicol, fancyhdr, xspace,tabularx}
@@ -64,13 +66,13 @@
 \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 \emph{Formatting Guide For Submission of Master’s Theses and Doctoral Dissertations} (2012) 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 \emph{Formatting Guide For Submission of Master’s Theses and Doctoral Dissertations} (2013) 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 documentclass 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}
 The MSU Thesis Class is based on the \pkg{memoir} document class.  The \pkg{memoir} class is an extensive class that incorporates the functionality of many other packages into it. The class is extensively documented, and the documentation (\pkg{memman.pdf}) should be available with any \TeX\ distribution.  I strongly recommend that you familiarize yourself with \pkg{memoir} as you use the present class.
 \section{Package Options}
-In addition to any options passed to the \pkg{memoir} class (e.g. |oldfontcommands|; see Section \ref{sec:fonts}), the \pkg{msu-thesis} takes two options: one to specify the type of degree, (see Table~\ref{degrees}), and one to enable landscape page numbering.  If no degree option is specified, a Ph.D. dissertation is assumed.
+In addition to any options passed to the \pkg{memoir} class (e.g. |oldfontcommands|; see Section \ref{sec:fonts}), the \pkg{msu-thesis} takes three options: one to specify the type of degree, (see Table~\ref{degrees}), one to enable landscape page numbering and one to make the Table of Contents prettier, but possibly non-compliant with the Formatting Guide.  If no degree option is specified, a Ph.D. dissertation is assumed.
 \begin{table}
 \centering
 \begin{tabularx}{.8\textwidth}{>{\ttfamily}lX}
@@ -96,7 +98,8 @@ In addition to any options passed to the \pkg{memoir} class (e.g. |oldfontcomman
 \end{table}
 \subsection{The \pkg{[lscape]} option}
 The Formatting Guide requires that any lansdscape pages be numbered in landscape mode (i.e. along the long edge of the page) rather than in portrait mode, and rotated in the final PDF. The |[lscape]| option enables this. The option loads both the \pkg{pdflscape} package and \pkg{tikz}, and is implemented as a class option so that you are not required to load those packages if they are not needed.
-
+\subsection{The \pkg{[noboldtoc]} option}
+In 2013 I received reports that the thesis office now requires all elements in the Table of Contents to have the same formatting as they are in the main document, which means that all section, subsection, and subsubsection headings need to be bold.  Since this looks very ugly, I have created an option to turn it off, the |[noboldtoc]| option. I suspect that the thesis office checkers don't notice this all the time so if you want to have a prettier table of contents and are willing to have that format be corrected, you can use this option to turn off the MSWord inspired ugliness of an entirely bold Table of Contents. Unfortunately, to comply with the standards, I've left the Table of Contents bold by default.
 \section{User commands}
 In addition to all the user functionality defined by \pkg{memoir}, the \pkg{msu-thesis} class defines six new titling commands, and a command to signal that the document has multiple appendices. 
 \begin{quote}
@@ -157,7 +160,7 @@ The class itself sets up the margins, page numbering, and formatting of all of t
 \subsection{Line Spacing}
 The \pkg{memoir} class provides commands for single and double spacing (|\SingleSpacing| and |\DoubleSpacing|) most of your thesis will be double spaced, but certain parts (such as the table of contents, lists of figures/tales, bibliography) may be single spaced. This duplicates the functionality of the \pkg{setspace} package, which therefore should not be used.
 \subsection{Font changing commands}\label{sec:fonts}
-\sloppy The \pkg{memoir} class enforces the so-called ``new'' font changing commands (although they have now been in use for many years.) This means that it does not allow you to use the commands |\bf|, |\it|, |\rm|, etc.  Unfortunately there are some old packages that still use these commands, and there is also some outdated information on the web that might have examples using these commands. You should generally not use these commands (see \url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2letterfontcmd}); if you do encounter problems, you can pass the option |oldfontcommands| to the class.
+\sloppy The \pkg{memoir} class enforces the so-called ``new'' font changing commands (although they have now been in use for many years.) This means that it does not allow you to use the commands |\bf|, |\it|, |\rm|, etc.  Unfortunately there are some old packages that still use these commands, and there is also some outdated information on the web that might have examples using these commands. You should generally not use these commands (see \href{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2letterfontcmd}{Two Letter Font Commands}); if you do encounter problems, you can pass the option |oldfontcommands| to the class.
 \subsection{Extra Packages}
 The \pkg{memoir} class replicates the functionality of many independent packages, so if you are transferring \LaTeX\ source from other documents using the \pkg{article} class, you may encounter some warnings or errors.  The \pkg{memoir} documentation has substantial information about the packages it emulates, and the packages for which it provides equivalent functionality.  See Chap. 18 Sec. 24 of the \pkg{memoir} manual for details.  Quoting from the manual:
 \begin{quote} \pkg{memoir} emulates the following packages: {\sffamily abstract, appendix, array, booktabs, ccaption, chngcntr, crop, dcolumn, delarray, enumerate, epigraph, ifmtarg, ifpdf, index, makeidx, moreverb, needspace, newfile, nextpage, pagenote, patchcmd, parskip, setspace, shortvrb, showidx, tabularx, titleref, tocbibind, tocloft, verbatim}, and {\sffamily verse}. It also provides functions equivalent to those in the following packages, although the class does not prevent you from using them: {\sffamily fancyhdr, framed, geometry, sidecap, subfigure}, and \sffamily{titlesec}.\\\hfill{\normalfont\emph{The Memoir Class} 8th Ed. 2010, p.345}
@@ -200,11 +203,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 TeXLive or MiKTeX then their respective package managers will update or install the latest version. If you are using a Linux-based distribution, 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 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 TeX Live or MiKTeX then their respective package managers will update or install the latest version. If you are using a Linux-based distribution, 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{msuthesis} (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.)
+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 limited support for \pkg{hyperref} although this is for convenience only at the moment. It's not clear what the Grad School policy is on hyperlinks in submitted theses.
 \section{Acknowledgements}
-Thanks to Lars Masden, 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: Matt Husband, Irina Agafonova, Dmitriy Bryndin, Greg Christian, Changkuk Jung, and Yisu Zhou.
+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: Matt Husband, Irina Agafonova, Dmitriy Bryndin, Greg Christian, Changkuk Jung, Yisu Zhou, Neil ver Planck, Michael Wojcik and Kyle Crayne.
 
 \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 8f919a7e85f..d7f3e8638ce 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
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 15251406c3f..8eed362a718 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
@@ -22,12 +22,16 @@
 % Just add real content and you're done!
 %
 \documentclass[]{msu-thesis}
-\usepackage{lipsum}
+% for a prettier, but possibly non-compliant table of contents use the [noboldtoc] option
+
+% This is standard fontenc/inputenc for pdflatex
+% If you use LuaLaTeX or XeLaTeX you should replace this with the fontspec package
 \usepackage[utf8]{inputenc}
 \usepackage[T1]{fontenc}
 %
 % If the thesis office requires Times, we'll give them Times
 % You can experiment with other font packages here if you like.
+% If you are using XeLaTeX or LuaLaTeX load the Times or Times New Romaan font with \setmainfont
 \usepackage{mathptmx} 
 %
 % Load any extra packages here
@@ -36,7 +40,7 @@
 \title{The syntax and semantics of phonology}
 \author{Joe Linguist}
 \fieldofstudy{Linguistics} % This should be in sentence case
-\date{2010}
+\date{2013}
 
 % 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.pdf b/Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-testfile.pdf
index 75c5d96ef3c..3964ee1ab57 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
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 e9c08846c28..8e22deaa245 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,4 +1,4 @@
-%\listfiles
+\listfiles
 
 \documentclass[lscape]{msu-thesis}
 % lscape option is needed for this sample file to show correct placement
@@ -30,6 +30,8 @@
 %\let\oldexe\exe
 %\renewcommand{\exe}{\SingleSpacing\oldexe}
 
+
+
 \begin{document}
 \frontmatter
 \maketitlepage