diff options
author | Karl Berry <karl@freefriends.org> | 2024-06-10 20:40:06 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2024-06-10 20:40:06 +0000 |
commit | 941ed89e1bbffbc60c66a6b4da0315b112b867cf (patch) | |
tree | 2bde28ad6839a530109794fe2bd505152fac70a7 | |
parent | 51b68904e29a7bc0cd3712422c571cd27bf59b35 (diff) |
msu-thesis (9jun24)
git-svn-id: svn://tug.org/texlive/trunk@71472 c570f23f-e606-0410-a88d-b1316a301751
-rw-r--r-- | Master/texmf-dist/doc/latex/msu-thesis/README.md | 3 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/msu-thesis/docs/msu-thesis.tex | 18 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/msu-thesis/msu-thesis.pdf | bin | 117097 -> 117627 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-chapterbib-testfile.pdf | bin | 139419 -> 140074 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-chapterbib-testfile.tex | 2 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-template.tex | 23 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-testfile.pdf | bin | 214979 -> 210105 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-testfile.tex | 8 | ||||
-rw-r--r-- | Master/texmf-dist/tex/latex/msu-thesis/msu-thesis.cls | 22 |
9 files changed, 49 insertions, 27 deletions
diff --git a/Master/texmf-dist/doc/latex/msu-thesis/README.md b/Master/texmf-dist/doc/latex/msu-thesis/README.md index 8e706e6de94..e46f1c7d41f 100644 --- a/Master/texmf-dist/doc/latex/msu-thesis/README.md +++ b/Master/texmf-dist/doc/latex/msu-thesis/README.md @@ -1,4 +1,4 @@ -# MSU Thesis Class Version 4.2b 2024/05/16 +# MSU Thesis Class Version 4.3 2024/06/07 Copyright 2011-2024 by Alan Munn <amunn@msu.edu> @@ -58,6 +58,7 @@ a template. If you are using Overleaf, you should upload a copy of `msu-thesis.cls` to your project. It *must* have exactly this name to be found. Click on the Menu icon and make sure to choose the latest version of TeX Live for compilation. +## Licence 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 diff --git a/Master/texmf-dist/doc/latex/msu-thesis/docs/msu-thesis.tex b/Master/texmf-dist/doc/latex/msu-thesis/docs/msu-thesis.tex index 7ea3b12edf3..4a653326212 100644 --- a/Master/texmf-dist/doc/latex/msu-thesis/docs/msu-thesis.tex +++ b/Master/texmf-dist/doc/latex/msu-thesis/docs/msu-thesis.tex @@ -2,8 +2,8 @@ \documentclass[11pt]{article} -\def\msuversion{4.2b} -\def\msudate{2024/05/16} +\def\msuversion{4.3} +\def\msudate{2024/06/07} \title{\textbf{Using the MSU Thesis Class}} \author{\textbf{Alan Munn}\\Department of Linguistics, Languages, and Cultures\\Michigan State University\\\texttt{\href{mailto:amunn@msu.edu}{amunn@msu.edu}}} \date{Version \msuversion\\\msudate} @@ -137,6 +137,7 @@ In addition to all the user functionality defined by \pkg{memoir}, the \pkg{msu- \toprule {\bs msucaptiondelim} & Delimiter for floating elements (see section \ref{captiondelim}).\\ {\bs msutocdelim} & Delimiter for table of contents chapter/section titles.\\ +{\bs msuappendixdelim} & Delimiter for table of contents appendix titles.\\ %{\bs setabstractnamespace} & Changes spacing after the name in the abstract (see section \ref{abstractspacing}).\\ \bottomrule \end{tabularx} @@ -200,8 +201,8 @@ The thesis guide suggests that you use a simplified table of contents that lists \begin{quote} |\setcounter{msutocdepth}{0}| \end{quote} -\subsubsection{Ensuring the minimum number of leader dots} -If your chapter titles are very long, they sometimes fail to put any leader dots before the page number in the Table of Contents. The thesis office requires a minimum of three dots of leaders for any TOC line. You can solve this problem by putting a line break into the TOC entry title. To do this, use the optional argument of the corresponding |\chapter| or |\section| etc. command. Note that the line break needs to be preceded by |\protect|. +\subsubsection{Adding line breaks to TOC entries} +If your chapter titles are very long, they sometimes fail to put any leader dots before the page number in the Table of Contents or they hyphenate a word in the title. The thesis office requires a minimum of three dots of leaders for any TOC line, and they don't seem to like hyphenation inside TOC entries. You can solve both of these problems by putting a line break into the TOC entry title. To do this, use the optional argument of the corresponding |\chapter| or |\section| etc. command. Note that the line break needs to be preceded by |\protect|. %\begin{quote} \begin{lstlisting}[frame=none,xleftmargin=2.5em] @@ -211,7 +212,9 @@ If your chapter titles are very long, they sometimes fail to put any leader dots %\end{quote} \subsection{Captions} \subsubsection{Caption delimiter}\label{captiondelim} -Because the thesis office doesn't understand anything about punctuation, it requires the colon that would appear in a caption to also appear in the contents lists. Since they don't care about the colon itself, but just consistency I've removed colons from the captions entirely, since leaving it in makes the contents lists look really stupid. But in case you or your advisor want the colon in captions, you can add the colon back in by adding |\renewcommand{\msucaptiondelim}{:\space}| to your preamble, and the class will make sure the Lists of Tables and Figures match in formatting. If you have other floating objects with captions (e.g., algorithms, listings) you may need to change their delimiter too (see below). How you do this may depend on the particular packages you are using. +Because the thesis office doesn't understand anything about punctuation, it requires the colon that would appear in a caption to also appear in the contents lists. Since they don't care about the colon itself, but just consistency I've removed colons from the captions entirely, since leaving it in makes the contents lists look really stupid. But in case you or your advisor want the colon in captions, you can add the colon back in by adding |\renewcommand{\msucaptiondelim}{:}| to your preamble, and the class will make sure the Lists of Tables and Figures match in formatting. If you have other floating objects with captions (e.g., algorithms, listings) you may need to change their delimiter too (see below). How you do this may depend on the particular packages you are using. +\subsection{Colons after Appendix titles}\label{appendixdelim} +I have also received reports that sometimes the thesis office requires a colon after appendix titles in the table of contents. To add this colon you can add |\renewcommand{\msuappendixdelim}{:}| to your preamble. \subsubsection{New lists and floats} Note that the thesis office no longer seems to \emph{require} lists of anything other than the main table of contents. This is another odd decision on their part. If do include a List of Tables and List of Figures and need to add other lists, you can follow the directions here. Note that lists of algorithms require special treatment. See §\ref{algorithms}. @@ -452,7 +455,8 @@ Version 3.7 added improved support for \pkg{hyperref}. Version 4.0 implements the new requirements as of September 2022, including adding a |\dualmajor| command. Various spacing changes have been made which will make your document look like you used Word, but this is what the thesis office seems to care about. Version 4.1 added the |msutocdepth| counter to allow for the chapters-only format that the thesis office recommends. -Version 4.2 changed the spacing parameters for subsections to appease the thesis office yet again. +Version 4.2 changed the spacing parameters for subsections to appease the thesis office yet again and added an explicit check for an up-to-date kernel. +Version 4.3 added a |\msuappendixdelim| command to appease the thesis office's thirst for colons. \section{Acknowledgements} Thanks to Lars Madsen, Ulrike Fischer and Peter Wilson for help with setting up parts of @@ -464,7 +468,7 @@ current \pkg{hyperref} code. Thanks to David Carlisle for helping me understand Thanks also to the following people who have reported problems over the years: Irina Agafonova, Ali Al-jiboory, Abubakr Ayesh, Julian Blank, Nathan Brugnone, Dmitriy Bryndin, Greg Christian, Kyle Crayne, Ciaron Hamilton, Matt Husband, Changkuk -Jung, Claire Kopenhafer, Adam Liter, Vanessa Maldonado, Andriana Manousidaki, Ben Miller, William Muir, Eureka +Jung, Minkyu Kim, Claire Kopenhafer, Adam Liter, Vanessa Maldonado, Andriana Manousidaki, Ben Miller, William Muir, Eureka Pai, Alicia Parrish, Victoria Parrish, Neil ver Planck, Taha Posos, Nick Rekuski, Giacomo Romanini, William Sands, Adam Soliman, Mookyong Son, Erik Stitt, Fanurs C.E. Teh, Eremey Valetov, Matthew Vincent, Michael Wojcik, Stephen Yowono, Atacan Yücesoy, Ali Zare, and Yisu Zhou. A special thank you to Non Thongprong who graciously provided a copy diff --git a/Master/texmf-dist/doc/latex/msu-thesis/msu-thesis.pdf b/Master/texmf-dist/doc/latex/msu-thesis/msu-thesis.pdf Binary files differindex 89f49a4d547..89adadc3321 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/samples/MSU-thesis-chapterbib-testfile.pdf b/Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-chapterbib-testfile.pdf Binary files differindex 3fea93983a0..6e9c51144e1 100644 --- a/Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-chapterbib-testfile.pdf +++ b/Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-chapterbib-testfile.pdf diff --git a/Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-chapterbib-testfile.tex b/Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-chapterbib-testfile.tex index f4ee4c9157c..d0ce1cca0cf 100644 --- a/Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-chapterbib-testfile.tex +++ b/Master/texmf-dist/doc/latex/msu-thesis/samples/MSU-thesis-chapterbib-testfile.tex @@ -7,7 +7,7 @@ \usepackage[]{chapterbib} \usepackage[]{natbib} \usepackage{lipsum} - +\renewcommand{\msuappendixdelim}{:} \usepackage{hyperref} 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 eb0b2e2b838..6c02721c995 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,5 +1,5 @@ % This is a template for use with the MSU Thesis class -% Version 4.1b 2023/05/25 +% Version 4.3 2024/06/07 % % Class options: %[PhD] Doctor of Philosophy (default) @@ -61,10 +61,6 @@ % %\dedication{This thesis is dedicated to someone.} % -% The default TOC format for the class lists both chapters and sections -% The thesis office suggests only listing chapters. If you prefer that format -% uncomment the next line: -%\setcounter{msutocdepth}{0} % sets TOC to list chapters only % \begin{document} @@ -100,9 +96,21 @@ Your acknowledgements here. % \clearpage +% The default TOC format for the class lists both chapters and sections +% The thesis office suggests only listing chapters. If you prefer that format +% uncomment the next line: +% +%\setcounter{msutocdepth}{0} % sets TOC to list chapters only +% % 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 +% +% The thesis office now seems to discourage the use of lists of tables/figures etc. +% Again, this is a very dubious suggestion, since it makes it harder for the people who actually +% read your thesis, so I would recommend keeping these lists unless the thesis office forces you to +% remove them or finds other problems with them. %\clearpage %\listoftables % comment this out if you have no tables %\clearpage @@ -131,6 +139,11 @@ Your acknowledgements here. % If you are using it for an MA/MS thesis you still need to have chapters, even if they are very small. \chapter{Your first chapter} +% The \chapter command supports an optional argument for the entry in the Table of Contents. The thesis +% office sometimes complains about hyphenation in the TOC or entries with too few dots! If they do, you +% can use the optional argument of \chapter (or \section etc.) to add explicit linebreaks in the TOC entries: +%\chapter[Long title that will \protect\\ break before the word ‘break’]{Long title that will break before the word ‘break’} +% % % If you have pages that must appear in landscape mode, use the [lscape] documentclass option % and enclose the pages in a {landscape} environment. 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 Binary files differindex 1b819b0aa0b..8ac6fc3ef52 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 bd67ccb0914..a00f0b1070a 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 -% v4.1c Testfile +% v4.3 Testfile \listfiles \documentclass[lscape]{msu-thesis} @@ -26,6 +26,7 @@ \usepackage{lipsum} \usepackage{xcolor} \usepackage{enumitem} +\usepackage{calc} \usepackage[unit=in]{fgruler} \usepackage{gb4e} \counterwithin{exx}{chapter} @@ -41,6 +42,7 @@ \newlistentry{listing}{lol}{0} \renewcommand*{\cftlistingname}{Listing\space} \renewcommand*{\cftlistingaftersnum}{\msucaptiondelim} +\renewcommand*{\msuappendixdelim}{:} \usepackage[bookmarksopenlevel=2,bookmarks=true]{hyperref} % not needed but here for testing \setcounter{msutocdepth}{1} % default is 1; this puts only chapters in the TOC @@ -269,6 +271,7 @@ A & B & C & D & E & F & G \\ % use this if you have more than one appendix \clearpage %\backmatter + \bibliography{MSU-thesis-testfile} %\begin{appendix} ... \end{appendix} % use this if you have only one appendix %\begin{appendix} @@ -284,8 +287,7 @@ A & B & C & D & E & F & G \\ \section{An appendix section} \lipsum[16-17] \end{appendices} -% This command creates the cover page for the bibliography -%\makebibliographypage + \end{document} diff --git a/Master/texmf-dist/tex/latex/msu-thesis/msu-thesis.cls b/Master/texmf-dist/tex/latex/msu-thesis/msu-thesis.cls index f873f7a9647..7f5955ab4a1 100644 --- a/Master/texmf-dist/tex/latex/msu-thesis/msu-thesis.cls +++ b/Master/texmf-dist/tex/latex/msu-thesis/msu-thesis.cls @@ -192,11 +192,12 @@ % Version 4.1h 2023/10/07 Changed option processing code % Version 4.1i 2023/12/02 Fixed spurious blank page with biblatex bibliography % Version 4.2 2024/02/18 Changed spacing for sections to address complaints about adjacent sectioning commands -% Version 4.2b 2024/05/16 Added version check for l3kernel. +% Version 4.2b 2024/05/16 Added version check for l3kernel. +% Version 4.3 2024/06/07 Fixed bug with TOCs when calc package was loaded; added \msuappendixdelim % Report bugs/problems/questions to <amunn@msu.edu> % -\def\msu@version{4.2b} -\def\msu@date{2024/05/16} +\def\msu@version{4.3} +\def\msu@date{2024/06/07} \NeedsTeXFormat{LaTeX2e} \ProvidesClass{msu-thesis}[\msu@date\space Michigan State University Thesis Class version \msu@version] \@ifundefined{ExplLoaderFileDate} @@ -333,7 +334,6 @@ chapterapp.code = { % This may also be solved by using \hypersetup{hypertexnames=false} % hard to tell whether this is a better solution. - % make title 2in from top of page % This value is crazy because the grad school doesn’t know how to measure \setlength{\droptitle}{.25in} % changed again due to topskip removal 12/13/17 @@ -499,6 +499,7 @@ chapterapp.code = { \renewcommand\cftsectionfont{\msu@tocfont} % fixed 12/13/17 \renewcommand\cftchapterpagefont{\msu@tocfont} \renewcommand*{\cftappendixname}{APPENDIX\space} + \renewcommand*\cftchapteraftersnum{\msuappendixdelim} } \cftinsertcode{SINGAPP}{\renewcommand{\cftchapteraftersnum}{}} @@ -517,7 +518,7 @@ chapterapp.code = { % chapters in the source \newlength\apptoclen -\settowidth{\apptoclen}{APPENDIX M} +\settowidth{\apptoclen}{APPENDIX: M} \cftinsertcode{APPENDICES}{ \setlength\cftchapterindent{\cftsectionindent} \setlength\cftsectionnumwidth{\apptoclen} % add the extra space @@ -525,7 +526,7 @@ chapterapp.code = { \renewcommand\cftsectionfont{\msu@tocfont} % fixed 12/13/17 \renewcommand\cftchapterpagefont{\msu@tocfont} \renewcommand*{\cftappendixname}{APPENDIX\space} - \renewcommand\cftchapteraftersnum{\msutocdelim} + \renewcommand\cftchapteraftersnum{\msuappendixdelim} %\ifthenelse{\value{msutocdepth}=0}{\addtocounter{tocdepth}{-1}}{} % removed 8/12/2023 } @@ -538,7 +539,7 @@ chapterapp.code = { \setlength{\cftbeforechapterskip}{1.0em \@plus\p@} \renewcommand\cftchapterfont{\msu@chapfont\MakeUppercase} \renewcommand\cftchapterpagefont{\msu@chapfont} - \setcounter{tocdepth}{\value{msutocdepth}} + \protect\setcounter{tocdepth}{\value{msutocdepth}} } % This code resets the changes made in the APP code back to normal % so that the bibliography will appear correctly in the TOC @@ -547,7 +548,7 @@ chapterapp.code = { \setlength{\cftbeforechapterskip}{1.0em \@plus\p@} \renewcommand\cftchapterfont{\msu@chapfont\MakeUppercase} \renewcommand\cftchapterpagefont{\msu@chapfont} - \setcounter{tocdepth}{\value{msutocdepth}} + \protect\setcounter{tocdepth}{\value{msutocdepth}} } \cftinsertcode{CHAPBIB}{ @@ -679,6 +680,7 @@ chapterapp.code = { % contents lists don't look so stupid. Can be changed if necessary. \newcommand*\msucaptiondelim{\space} \newcommand*\msutocdelim{} % removed idiotic colon 5/25/23 +\newcommand*\msuappendixdelim{} % added 6/7/24 \captiondelim{\msucaptiondelim} \pagestyle{plain} @@ -773,11 +775,11 @@ chapterapp.code = { % \ifmsu@chapterapp\else \msu@singleappendixtrue % \fi% make sure single appendix doesn't have a number if global 3.1b (always 3.2) - \msu@apppage\cftinserthook{toc}{SINGAPP}\setcounter{tocdepth}{0}\@resets@pp\anappendixtrue}% + \msu@apppage\cftinserthook{toc}{SINGAPP}\protect\setcounter{tocdepth}{0}\@resets@pp\anappendixtrue}% {\@ppsaveapp\@pprestoresec\anappendixfalse\cftinserthook{toc}{CHAPAPPR}} % reset aded 2022/04/16 \renewenvironment{appendices}% - {\msu@singleappendixfalse\msu@apppage\ifmsu@chapterapp\cftinserthook{toc}{APPENDICES}\fi\addtocontents{toc}{\setcounter{tocdepth}{0}} + {\msu@singleappendixfalse\msu@apppage\ifmsu@chapterapp\cftinserthook{toc}{APPENDICES}\fi\addtocontents{toc}{\protect\setcounter{tocdepth}{0}} \@resets@pp\anappendixtrue}% {\@ppsaveapp\@pprestoresec\anappendixfalse\cftinserthook{toc}{CHAPAPPR}} % reset added 2022/04/16 |