summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2010-12-17 23:02:10 +0000
committerKarl Berry <karl@freefriends.org>2010-12-17 23:02:10 +0000
commitdbf35b048ee6685fbdf772fa0186fef710cbc068 (patch)
tree880b98e682d021e8edc20934a850c82d5bfc5fe7 /Master/texmf-dist/doc
parent834448bb75bb0ec4788336fb9895a9a1fcc34607 (diff)
msuthesis 1.7 (18dec10)
git-svn-id: svn://tug.org/texlive/trunk@20779 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r--Master/texmf-dist/doc/latex/msuthesis/MSU-thesis-template.pdfbin30953 -> 31294 bytes
-rw-r--r--Master/texmf-dist/doc/latex/msuthesis/MSU-thesis-template.tex18
-rw-r--r--Master/texmf-dist/doc/latex/msuthesis/MSU-thesis-testfile.pdfbin68969 -> 68915 bytes
-rw-r--r--Master/texmf-dist/doc/latex/msuthesis/MSU-thesis-testfile.tex35
-rw-r--r--Master/texmf-dist/doc/latex/msuthesis/README46
-rw-r--r--Master/texmf-dist/doc/latex/msuthesis/msu-thesis.pdfbin236258 -> 238708 bytes
-rw-r--r--Master/texmf-dist/doc/latex/msuthesis/msu-thesis.tex72
7 files changed, 96 insertions, 75 deletions
diff --git a/Master/texmf-dist/doc/latex/msuthesis/MSU-thesis-template.pdf b/Master/texmf-dist/doc/latex/msuthesis/MSU-thesis-template.pdf
index 7d086fd44a3..ee8e5287968 100644
--- a/Master/texmf-dist/doc/latex/msuthesis/MSU-thesis-template.pdf
+++ b/Master/texmf-dist/doc/latex/msuthesis/MSU-thesis-template.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/msuthesis/MSU-thesis-template.tex b/Master/texmf-dist/doc/latex/msuthesis/MSU-thesis-template.tex
index 730538ac92a..797faa7cc52 100644
--- a/Master/texmf-dist/doc/latex/msuthesis/MSU-thesis-template.tex
+++ b/Master/texmf-dist/doc/latex/msuthesis/MSU-thesis-template.tex
@@ -22,6 +22,7 @@
% Just add real content and you're done!
%
\documentclass[]{msu-thesis}
+\usepackage{lipsum}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
%
@@ -48,10 +49,9 @@
% First make the title page
\maketitlepage
% Next make the abstract
-\begin{msuabstract}
-Your abstract here
-\end{msuabstract}
-\makeabstract
+\begin{abstract}
+% Your abstract goes here. Master's 1 page max. PhD 2 page max.
+\end{abstract}
% Force a newpage
\clearpage
@@ -70,7 +70,7 @@ Your acknowledgements here.
\clearpage
% We need to turn single spacing back on for the contents/figures/tables lists
\SingleSpacing
-\tableofcontents* % table of contents will not be listed in the TOC
+\maketableofcontents % table of contents will not be listed in the TOC
\clearpage
\listoftables % comment this out if you have no tables
\clearpage
@@ -81,11 +81,9 @@ Your acknowledgements here.
\mainmatter
%
% The next line removes the dots in chapter headings in the TOC
-% Uncomment this if you want leader dots everywhere
+% May violate thesis office rules
%\addtocontents{toc}{\protect\renewcommand{\protect\cftchapterdotsep} {\cftnodots}}
-% Everything now needs to be double spaced
-\DoubleSpacing
\chapter{Your first chapter}
%
% If you have appendices, they would go here. Comment these lines out if you don't
@@ -97,15 +95,15 @@ Your acknowledgements here.
%
\backmatter
% The next lines add the dots back into the References/Bibliography heading
-% of the TOC. Uncomment this if you need to put the dots back in having
+% of the TOC. Only uncomment this if you need to put the dots back in having
% removed them for Chapter headings.
%
%\addtocontents{toc}{%
% \protect\renewcommand{\protect\cftchapterdotsep} {\cftdotsep}}
%
+\makebibliographycover % make the bibliography cover page
% Bibliography can be single spaced
%
-\makebibliographycover % make the bibliography cover page
\SingleSpacing
% Your bibliography command here (e.g. \bibliography{your-bib-file}) if using natbib
\end{document}
diff --git a/Master/texmf-dist/doc/latex/msuthesis/MSU-thesis-testfile.pdf b/Master/texmf-dist/doc/latex/msuthesis/MSU-thesis-testfile.pdf
index b9500a163e6..2b193b5f053 100644
--- a/Master/texmf-dist/doc/latex/msuthesis/MSU-thesis-testfile.pdf
+++ b/Master/texmf-dist/doc/latex/msuthesis/MSU-thesis-testfile.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/msuthesis/MSU-thesis-testfile.tex b/Master/texmf-dist/doc/latex/msuthesis/MSU-thesis-testfile.tex
index a01445a2473..155df34d77e 100644
--- a/Master/texmf-dist/doc/latex/msuthesis/MSU-thesis-testfile.tex
+++ b/Master/texmf-dist/doc/latex/msuthesis/MSU-thesis-testfile.tex
@@ -1,4 +1,5 @@
\listfiles
+
\documentclass[]{msu-thesis}
\usepackage[T1]{fontenc}
\usepackage{mathptmx}
@@ -21,27 +22,23 @@
% Uncomment the next two lines for single spaced examples with gb4e
%\let\oldexe\exe
%\renewcommand{\exe}{\SingleSpacing\oldexe}
+\tracingpatches
\begin{document}
\frontmatter
\maketitlepage
-\begin{msuabstract}
-\lipsum[1]
-\lipsum[2]
-\lipsum[3]
-\lipsum[4]
-\end{msuabstract}
-\makeabstract
-
+\begin{abstract}
+\lipsum
+\end{abstract}
\clearpage
\makecopyrightpage
\makededicationpage
\clearpage
\chapter*{Acknowledgements}
\DoubleSpacing
-\lipsum[4]
+\lipsum[1]
\clearpage
\SingleSpacing
-\tableofcontents*
+\maketableofcontents
\clearpage
\listoftables
\clearpage
@@ -49,7 +46,6 @@
\mainmatter
% The next command changes chapters in the TOC to have no dotted leader
%\addtocontents{toc}{\protect\renewcommand{\protect\cftchapterdotsep}{\cftnodots}}
-\DoubleSpacing
\chapter{Introduction}
\section{Some section}
\lipsum[2]
@@ -124,6 +120,11 @@ Men & Women & Monsters\\
\ex[]{This_{i_{j_{k}}} contains three subscripts of the right size.}
\end{xlist}
\end{exe}
+\begin{figure}
+\centering
+{\color{gray!40}\rule{4in}{2in}}
+\caption{Another sample figure}
+\end{figure}
\lipsum[2]
\begin{quote}
\SingleSpacing
@@ -131,7 +132,19 @@ This is a sample long quotation. \lipsum[2]
\hfill{\citep{munn1999}}
\end{quote}
+\begin{table}
+\centering
+\begin{tabular}{ccc}
+\toprule
+Men & Women & Monsters\\
+\midrule
+29 & 33 & 51\\
+\bottomrule
+\end{tabular}
+\caption{Another sample table.}
+\end{table}
\lipsum[8]
+
% Uncomment this next command if you have more than one appendix
%\appendicestrue
diff --git a/Master/texmf-dist/doc/latex/msuthesis/README b/Master/texmf-dist/doc/latex/msuthesis/README
index b5ff2341dec..201eac60691 100644
--- a/Master/texmf-dist/doc/latex/msuthesis/README
+++ b/Master/texmf-dist/doc/latex/msuthesis/README
@@ -1,39 +1,43 @@
-MSU Thesis Class
-Version 1.5b 2010/12/13
+MSU Thesis Class Version 1.7 2010/12/16
Copyright 2010 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 (2010).
+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 (2010).
-The class is based on the memoir document class, and thefore inherits all of the functionality of that class.
+The class is based on the memoir document class, and thefore inherits
+all of the functionality of that class.
Installation:
-Put the msu-thesis folder from the latex folder into the latex folder of your local texmf tree.
+Put the msu-thesis folder from the latex folder into the latex folder of
+your local texmf tree.
-Put the msu-thesis folder from the doc folder into the doc folder of your local texmf tree.
+Put the msu-thesis folder from the doc folder into the doc folder of
+your local texmf tree.
-Put the samples folder somewhere where you can find it; it contains the sample template.
+The samples folder inside the doc folder contains a thesis test-file and
+a template.
-This package may be distributed and/or modified under the
-conditions of the LaTeX Project Public License, either version 1.3
-of this license or any later version.
-The latest version of this license is in
- http://www.latex-project.org/lppl.txt
-and version 1.3 or later is part of all distributions of LaTeX
-version 2005/12/01 or later.
+This package may be distributed and/or modified under the conditions of
+the LaTeX Project Public License, either version 1.3 of this license or
+any later version. The latest version of this license is in
+http://www.latex-project.org/lppl.txt and version 1.3 or later is part
+of all distributions of LaTeX version 2005/12/01 or later.
This package has the LPPL maintenance status `maintained'.
The Current Maintainer of this package is Alan Munn.
-This package consists of the following source files: msu-thesis.cls, gb4e-compat.tex;
-Documentation files msu-thesis-doc.tex and msu-thesis-doc.pdf;
-A template file MSU-thesis-sample-document.tex
-And a test file, test bibliography, and the Unified Linguistics Stylesheet bst file
-testfile.tex, testfile.bib, unified.bst
+This package consists of the following source files:
+msu-thesis.cls,
+gb4e-compat.tex;
+Documentation files:
+msu-thesis.tex and msu-thesis.pdf;
+A template file: MSU-thesis-template.tex;
+A test file, test bibliography, and the Unified Linguistics Stylesheet bst file: MSU-thesis-testfile.tex, testfile.bib, unified.bst
-Use at your own risk!
-Report bugs/problems/questions to <amunn@msu.edu>
+Use at your own risk! Report bugs/problems/questions to <amunn@msu.edu>
diff --git a/Master/texmf-dist/doc/latex/msuthesis/msu-thesis.pdf b/Master/texmf-dist/doc/latex/msuthesis/msu-thesis.pdf
index 26a75cc6bfb..afd7b0ef169 100644
--- a/Master/texmf-dist/doc/latex/msuthesis/msu-thesis.pdf
+++ b/Master/texmf-dist/doc/latex/msuthesis/msu-thesis.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/msuthesis/msu-thesis.tex b/Master/texmf-dist/doc/latex/msuthesis/msu-thesis.tex
index 9b680e8b039..0d97cbfd0f6 100644
--- a/Master/texmf-dist/doc/latex/msuthesis/msu-thesis.tex
+++ b/Master/texmf-dist/doc/latex/msuthesis/msu-thesis.tex
@@ -1,7 +1,7 @@
\documentclass[11pt]{article}
\title{\textbf{Using the MSU Thesis Class}}
-\author{\textbf{Alan Munn}\\Department of Linguistics and Languages\\\texttt{amunn@msu.edu}}
-\date{Version 1.5b\\December 13, 2010}
+\author{\textbf{Alan Munn}\\Department of Linguistics and Languages\\\texttt{\href{mailto:amunn@msu.edu}{amunn@msu.edu}}}
+\date{Version 1.7\\December 16, 2010}
\usepackage[T1]{fontenc}
\usepackage[margin=1in]{geometry}
\usepackage{titling}
@@ -10,7 +10,7 @@
\usepackage{enumitem}
\usepackage{fancyvrb,listings,url}
\usepackage[sf]{titlesec}
-\usepackage{hyperref}
+\usepackage[colorlinks=true]{hyperref}
@@ -96,15 +96,17 @@ In addition to any options passed to the \pkg{memoir} class (e.g. |oldfontcomman
\section{User commands}
-In addition to all the user functionality defined by \pkg{memoir}, the \pkg{msu-thesis} class defines seven new titling commands, an environment for the abstract, and a command to signal that the document has multiple appendices.
+In addition to all the user functionality defined by \pkg{memoir}, the \pkg{msu-thesis} class defines seven new titling commands, and a command to signal that the document has multiple appendices.
\begin{quote}
\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{\bs makecopyrightpage}] Creates the copyright page.
\item[\texttt{\bs makededicationpage}] Creates the dedication page.
-\item[\texttt{\bs begin\{msuabstract\}\ldots \bs end\{msuabstract\}}] Environment containing the text of the thesis abstract.
-\item[\texttt{\bs makeabstract}] Generates the abstract.
+\item[\texttt{\bs maketableofcontents}] Creates the table of contents
+% deprecated commands from < v1.7
+%\item[\texttt{\bs begin\{msuabstract\}\ldots \bs end\{msuabstract\}}] Environment containing the text of the thesis abstract.
+%\item[\texttt{\bs makeabstract}] Generates the abstract.
\item[\texttt{\bs appendicestrue}] Tells the class that you have more than one appendix.
\item[\texttt{\bs makeappendixcover}] Creates the appendix/ces cover page.
\item[\texttt{\bs makebibliographycover}] Creates the bibliography cover page.
@@ -159,27 +161,10 @@ The \pkg{memoir} class replicates the functionality of many independent packages
\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}
\end{quote}
-\subsection{Linguistic Examples with \pkg{gb4e} and \pkg{linguex}}
-The \pkg{msu-thesis} class has been tested with both the \pkg{gb4e} package, and the \pkg{linguex} package. Unfortunately some versions of \pkg{gb4e} use old font commands, and so does \pkg{linguex}, so if you encounter problems with either package, load the class with the |oldfontcommands| option. Since linguistic examples are usually single spaced, even in theses, you should use the |\singlegloss| command (from the \pkg{cgloss4e} package loaded by both \pkg{gb4e} and \pkg{linguex}) to make your glosses examples singlespaced. The default mode for examples themselves is to make them doublespaced. If you want all examples to be single spaced (which looks better if the examples take up more than one line) you need to put the following code in your preamble, which redefines the |exe| environment to be single spaced.
-\begin{quote}
-\begin{lstlisting}
-\let\oldexe\exe
-\renewcommand{\exe}{\SingleSpacing\oldexe}
-\end{lstlisting}
-\end{quote}
-For the \pkg{linguex} package, you can use the following code:
-\begin{quote}
-\begin{lstlisting}
-\let\oldex\ex
-\renewcommand{\ex}{\SingleSpacing\oldex}
-\renewcommand{\ExEnd}{%
- \ifnum\theExDepth=0\global\unembeddedfalse\DoubleSpacing\else%
- \end{list}\addtocounter{ExDepth}{-1}\ExEnd\fi}
-\end{lstlisting}
-\end{quote}
+
\subsection{Customizing the look of things}
-I have created a basic looking style for Chapter headings based on the |thatcher| style in |memoir|. If you want to change these things, you may, using the appropriate |\renewcommand| commands. More information can be found in the |memoir| documentation. The Thesis Office seems to require dotted leaders for the List of Figures/Tables in the Table of Contents, even though they get typeset as Chapters. If you wish your Chapter headings to have no leaders, add the following command just after the |\mainmatter| command. To put the dots back for the Bibliography, repeat the same command right after the |\backmatter| command, but replace |\cftnodots| with |\cftdotsep|.
+I have created a basic looking style for Chapter headings based on the |thatcher| style in |memoir|. If you want to change these things, you may, using the appropriate |\renewcommand| commands. More information can be found in the |memoir| documentation. The Thesis Office seems to require dotted leaders for the List of Figures/Tables in the Table of Contents, even though they get typeset as Chapters. If you wish your Chapter headings to have no leaders, add the following command just after the |\mainmatter| command. To put the dots back for the Bibliography, repeat the same command right after the |\backmatter| command, but replace |\cftnodots| with |\cftdotsep|. The default template leaves dots everywhere, which should appease the thesis office.
\begin{quote}
\begin{lstlisting}
\addtocontents{toc}{%
@@ -190,24 +175,47 @@ I have created a basic looking style for Chapter headings based on the |thatcher
\subsection{Things to watch out for}
\begin{itemize}[label={\textbullet}]
\item Make sure you pay attention to any ``Overfull hbox'' warnings when you are producing your final copy. You should make sure you eliminate all of them or else the thesis office is likely to reject your thesis. One common way to eliminate such warnings is to place the command |\sloppy| at the beginning of the paragraph that triggers the warning. You should only use this technique at the very end when you are completely done with everything. Alternatively, rewording the text may also fix things.
+\item Remember to use the |\maketableofcontents| command instead of the regular |\tableofcontents*| command.
\item Remember to use the command |\appendicestrue| if you have more than one appendix.
\item Remember to add the |\makeappedixcover| and |\makebibliographycover| commands before your appendices and your bibliography.
\end{itemize}
\section{Bugs and redistribution}
-The latest copy of \pkg{msu-thesis} will always be available here \url{http://www.msu.edu/~amunn/latex/msuthesis.zip} and probably on CTAN when the version is finalized. If you want others to use the class, \textsc{please} point them to that link, 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 \url{mailto:amunn@msu.edu}, as this will aid in making things easier for those who follow you.
+\subsection{Current version}
+The latest copy of \pkg{msu-thesis} will always be available here \url{http://www.msu.edu/~amunn/latex/msuthesis.zip} and on \href{http://tug.ctan.org/cgi-bin/ctanPackageInformation.py?id=msu-thesis}{CTAN}. If you use TeXLive, then \pkg{tlmgr} will update or install the latest version. If you want others to use the class, \textsc{please} point them to those links, 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.
+\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.)
\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 also to Wolfgang Sternefeld for supplying the \pkg{linguex} spacing fix code, and Matt Husband, Irina Agafonova and Dmitriy Bryndin for reporting problems during initial testing.
-\clearpage
+
\appendix
\renewcommand{\thesection}{Appendix \Alph{section}}
+\section{Linguistic Examples with \pkg{gb4e} and \pkg{linguex}}
+The \pkg{msu-thesis} class has been tested with both the \pkg{gb4e} package, and the \pkg{linguex} package. Unfortunately some versions of \pkg{gb4e} use old font commands, and so does \pkg{linguex}, so if you encounter problems with either package, load the class with the |oldfontcommands| option. Since linguistic examples are usually single spaced, even in theses, you should use the |\singlegloss| command (from the \pkg{cgloss4e} package loaded by both \pkg{gb4e} and \pkg{linguex}) to make your glosses examples singlespaced. The default mode for examples themselves is to make them doublespaced. If you want all examples to be single spaced (which looks better if the examples take up more than one line) you need to put the following code in your preamble, which redefines the |exe| environment to be single spaced.
+\begin{quote}
+\begin{lstlisting}
+\let\oldexe\exe
+\renewcommand{\exe}{\SingleSpacing\oldexe}
+\end{lstlisting}
+\end{quote}
+For the \pkg{linguex} package, you can use the following code:
+\begin{quote}
+\begin{lstlisting}
+\let\oldex\ex
+\renewcommand{\ex}{\SingleSpacing\oldex}
+\renewcommand{\ExEnd}{%
+ \ifnum\theExDepth=0\global\unembeddedfalse\DoubleSpacing\else%
+ \end{list}\addtocounter{ExDepth}{-1}\ExEnd\fi}
+\end{lstlisting}
+\end{quote}
+\clearpage
\section{Sample template}
\enlargethispage{2\baselineskip}
\begin{lstlisting}
\documentclass[PhD]{msu-thesis}
% Your extra packages here
%
-% Define the title, author, advisor, field of study, date, and dedication
+% Define the title, author, field of study, date, and dedication (optional)
%
\title{The syntax and semantics of phonology}
\author{Joe Linguist}
@@ -220,10 +228,9 @@ Thanks to Lars Masden, Ulrike Fischer and Peter Wilson for help with setting up
%
\maketitlepage
%
-\begin{msuabstract}
+\begin{abstract}
Your abstract text here
-\end{msuabstract}
-\makeabstract
+\end{abstract}
%
\clearpage
\makecopyrightpage
@@ -236,14 +243,13 @@ Your acknowledgements here
%
\clearpage
\SingleSpacing
-\tableofcontents*
+\maketableofcontents
\clearpage
\listoftables
\clearpage
\listoffigures
%
\mainmatter
-\DoubleSpacing
\chapter{Your first chapter}
%
\appendix