Skip to content

Commit

Permalink
Reorganized documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Alan Munn committed May 2, 2024
1 parent e3c314c commit c196526
Show file tree
Hide file tree
Showing 33 changed files with 293 additions and 269 deletions.
2 changes: 1 addition & 1 deletion docs/Acknowledgements.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
</head><body>
<p><object class='toc' data='msu-thesis-toc.html'> <span class='ec-lmr-10'>[</span><a href='msu-thesis-toc.html'><span class='ec-lmr-10'>table of contents</span></a><span class='ec-lmr-10'>] </span></object>
</p><!-- l. 449 --><div class='crosslinks'><p class='noindent'><span class='ec-lmr-10'>[</span><a href='Sampletemplate.html'><span class='ec-lmr-10'>next</span></a><span class='ec-lmr-10'>] [</span><a href='Bugsandredistribution.html'><span class='ec-lmr-10'>prev</span></a><span class='ec-lmr-10'>] [</span><a href='Bugsandredistribution.html#tailBugsandredistribution.html'><span class='ec-lmr-10'>prev-tail</span></a><span class='ec-lmr-10'>] [</span><a href='#tailAcknowledgements.html'><span class='ec-lmr-10'>tail</span></a><span class='ec-lmr-10'>] [</span><a href='msu-thesis.html#Acknowledgements.html'><span class='ec-lmr-10'>up</span></a><span class='ec-lmr-10'>] </span></p></div>
<h3 class='sectionHead' id='acknowledgements'><span class='titlemark'><span class='ec-lmr-10'>7 </span></span> <a id='x34-440007'></a><span class='ec-lmr-10'>Acknowledgements</span></h3>
<h3 class='sectionHead' id='acknowledgements'><span class='titlemark'><span class='ec-lmr-10'>7 </span></span> <a id='x35-460007'></a><span class='ec-lmr-10'>Acknowledgements</span></h3>
<!-- l. 450 --><p class='noindent'><span class='ec-lmr-10'>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
</span><span class='ec-lmtt-10'>linguex</span><span class='ec-lmr-10'> spacing fix code, Leo Liu for the landscape page numbering code, which greatly simplified my original
Expand Down
45 changes: 24 additions & 21 deletions docs/Algorithmpackageslabelalgorithms.html
View file

Large diffs are not rendered by default.

33 changes: 17 additions & 16 deletions docs/Appendices.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,48 +10,49 @@
</head><body>
<p><object class='toc' data='msu-thesis-toc.html'> <span class='ec-lmr-10'>[</span><a href='msu-thesis-toc.html'><span class='ec-lmr-10'>table of contents</span></a><span class='ec-lmr-10'>] </span></object>
</p><!-- l. 347 --><div class='crosslinks'><p class='noindent'><span class='ec-lmr-10'>[</span><a href='Bibliographies.html'><span class='ec-lmr-10'>next</span></a><span class='ec-lmr-10'>] [</span><a href='Landscapefiguresandtables.html'><span class='ec-lmr-10'>prev</span></a><span class='ec-lmr-10'>] [</span><a href='Landscapefiguresandtables.html#tailLandscapefiguresandtables.html'><span class='ec-lmr-10'>prev-tail</span></a><span class='ec-lmr-10'>] [</span><a href='#tailAppendices.html'><span class='ec-lmr-10'>tail</span></a><span class='ec-lmr-10'>] [</span><a href='Usingtheclass.html#Appendices.html'><span class='ec-lmr-10'>up</span></a><span class='ec-lmr-10'>] </span></p></div>
<h4 class='subsectionHead' id='appendices'><span class='titlemark'><span class='ec-lmr-10'>5.11 </span></span> <a id='x23-290005.11'></a><span class='ec-lmr-10'>Appendices</span></h4>
<h4 class='subsectionHead' id='appendices'><span class='titlemark'><span class='ec-lmr-10'>5.12 </span></span> <a id='x24-310005.12'></a><span class='ec-lmr-10'>Appendices</span></h4>
<!-- l. 348 --><p class='noindent'><span class='ec-lmr-10'>Appendices in a thesis are usually at the end of the document, but before the bibliography. The class implements
this with two environments: </span><code class='verb'>{appendix}</code> <span class='ec-lmr-10'>for a single appendix and </span><code class='verb'>{appendices}</code> <span class='ec-lmr-10'>for multiple appendices. If
your thesis organization requires appendices per-chapter, you must use the </span><code class='verb'>[chapterapp]</code> <span class='ec-lmr-10'>class option. In either
case, the code for appendices is identical, i.e., each appendix is introduced with the </span><code class='verb'>\chapter</code>
<span class='ec-lmr-10'>command.</span>


</p>
<h5 class='subsubsectionHead' id='single-appendix'><span class='titlemark'><span class='ec-lmr-10'>5.11.1 </span></span> <a id='x23-300005.11.1'></a><span class='ec-lmr-10'>Single appendix</span></h5>
<h5 class='subsubsectionHead' id='single-appendix'><span class='titlemark'><span class='ec-lmr-10'>5.12.1 </span></span> <a id='x24-320005.12.1'></a><span class='ec-lmr-10'>Single appendix</span></h5>
<!-- l. 350 --><p class='noindent'><span class='ec-lmr-10'>If you have a single appendix, your code should look like this:</span>
</p>
<!-- l. 352 --><p class='indent'>
</p>
<blockquote class='quote'>
<!-- l. 353 -->
<pre class='lstlisting' id='listing-10'><span class='label'><a id='x23-30001r1'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>\</span></span><span style='color:#000000'><span class='ec-lmtt-10'>begin</span></span><span style='color:#000000'><span class='ec-lmtt-10'>{</span></span><span style='color:#000000'><span class='ec-lmtt-10'>appendix</span></span><span style='color:#000000'><span class='ec-lmtt-10'>}</span></span>
<span class='label'><a id='x23-30002r2'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>\</span></span><span style='color:#000000'><span class='ec-lmtt-10'>chapter</span></span><span style='color:#000000'><span class='ec-lmtt-10'>{</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Your</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>appendix title}</span>
</span><span class='label'><a id='x23-30003r3'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>Appendix</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>text goes here</span>
</span><span class='label'><a id='x23-30004r4'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>\</span></span><span style='color:#000000'><span class='ec-lmtk-10'>end</span></span><span style='color:#000000'><span class='ec-lmtt-10'>{</span></span><span style='color:#000000'><span class='ec-lmtt-10'>appendix</span></span><span style='color:#000000'><span class='ec-lmtt-10'>}</span></span></pre>
<pre class='lstlisting' id='listing-10'><span class='label'><a id='x24-32001r1'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>\</span></span><span style='color:#000000'><span class='ec-lmtt-10'>begin</span></span><span style='color:#000000'><span class='ec-lmtt-10'>{</span></span><span style='color:#000000'><span class='ec-lmtt-10'>appendix</span></span><span style='color:#000000'><span class='ec-lmtt-10'>}</span></span>
<span class='label'><a id='x24-32002r2'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>\</span></span><span style='color:#000000'><span class='ec-lmtt-10'>chapter</span></span><span style='color:#000000'><span class='ec-lmtt-10'>{</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Your</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>appendix title}</span>
</span><span class='label'><a id='x24-32003r3'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>Appendix</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>text goes here</span>
</span><span class='label'><a id='x24-32004r4'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>\</span></span><span style='color:#000000'><span class='ec-lmtk-10'>end</span></span><span style='color:#000000'><span class='ec-lmtt-10'>{</span></span><span style='color:#000000'><span class='ec-lmtt-10'>appendix</span></span><span style='color:#000000'><span class='ec-lmtt-10'>}</span></span></pre>

</blockquote>
<!-- l. 361 --><p class='noindent'>
</p>
<h5 class='subsubsectionHead' id='multiple-appendices'><span class='titlemark'><span class='ec-lmr-10'>5.11.2 </span></span> <a id='x23-310005.11.2'></a><span class='ec-lmr-10'>Multiple appendices</span></h5>
<h5 class='subsubsectionHead' id='multiple-appendices'><span class='titlemark'><span class='ec-lmr-10'>5.12.2 </span></span> <a id='x24-330005.12.2'></a><span class='ec-lmr-10'>Multiple appendices</span></h5>
<!-- l. 362 --><p class='noindent'><span class='ec-lmr-10'>If you have more than one appendix, your code should look like this:</span>
</p>
<!-- l. 364 --><p class='indent'>
</p>
<blockquote class='quote'>
<!-- l. 365 -->
<pre class='lstlisting' id='listing-11'><span class='label'><a id='x23-31001r1'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>\</span></span><span style='color:#000000'><span class='ec-lmtt-10'>begin</span></span><span style='color:#000000'><span class='ec-lmtt-10'>{</span></span><span style='color:#000000'><span class='ec-lmtt-10'>appendices</span></span><span style='color:#000000'><span class='ec-lmtt-10'>}</span></span>
<span class='label'><a id='x23-31002r2'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>\</span></span><span style='color:#000000'><span class='ec-lmtt-10'>chapter</span></span><span style='color:#000000'><span class='ec-lmtt-10'>{</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Your</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>first appendix title}</span>
</span><span class='label'><a id='x23-31003r3'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>Appendix</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>text goes here</span>
</span><span class='label'><a id='x23-31004r4'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>\</span></span><span style='color:#000000'><span class='ec-lmtt-10'>chapter</span></span><span style='color:#000000'><span class='ec-lmtt-10'>{</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Your</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>second appendix title}</span>
</span><span class='label'><a id='x23-31005r5'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>Appendix</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>text goes here</span>
</span><span class='label'><a id='x23-31006r6'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>\</span></span><span style='color:#000000'><span class='ec-lmtk-10'>end</span></span><span style='color:#000000'><span class='ec-lmtt-10'>{</span></span><span style='color:#000000'><span class='ec-lmtt-10'>appendices</span></span><span style='color:#000000'><span class='ec-lmtt-10'>}</span></span></pre>
<pre class='lstlisting' id='listing-11'><span class='label'><a id='x24-33001r1'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>\</span></span><span style='color:#000000'><span class='ec-lmtt-10'>begin</span></span><span style='color:#000000'><span class='ec-lmtt-10'>{</span></span><span style='color:#000000'><span class='ec-lmtt-10'>appendices</span></span><span style='color:#000000'><span class='ec-lmtt-10'>}</span></span>
<span class='label'><a id='x24-33002r2'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>\</span></span><span style='color:#000000'><span class='ec-lmtt-10'>chapter</span></span><span style='color:#000000'><span class='ec-lmtt-10'>{</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Your</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>first appendix title}</span>
</span><span class='label'><a id='x24-33003r3'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>Appendix</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>text goes here</span>
</span><span class='label'><a id='x24-33004r4'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>\</span></span><span style='color:#000000'><span class='ec-lmtt-10'>chapter</span></span><span style='color:#000000'><span class='ec-lmtt-10'>{</span></span><span style='color:#000000'><span class='ec-lmtt-10'>Your</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>second appendix title}</span>
</span><span class='label'><a id='x24-33005r5'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>Appendix</span></span><span style='color:#000000'> <span class='ec-lmtt-10'>text goes here</span>
</span><span class='label'><a id='x24-33006r6'></a></span><span style='color:#000000'><span class='ec-lmtt-10'>\</span></span><span style='color:#000000'><span class='ec-lmtk-10'>end</span></span><span style='color:#000000'><span class='ec-lmtt-10'>{</span></span><span style='color:#000000'><span class='ec-lmtt-10'>appendices</span></span><span style='color:#000000'><span class='ec-lmtt-10'>}</span></span></pre>

</blockquote>
<!-- l. 375 --><p class='noindent'>
</p>
<h5 class='subsubsectionHead' id='appendices-per-chapter'><span class='titlemark'><span class='ec-lmr-10'>5.11.3 </span></span> <a id='x23-320005.11.3'></a><span class='ec-lmr-10'>Appendices per chapter</span></h5>
<h5 class='subsubsectionHead' id='appendices-per-chapter'><span class='titlemark'><span class='ec-lmr-10'>5.12.3 </span></span> <a id='x24-340005.12.3'></a><span class='ec-lmr-10'>Appendices per chapter</span></h5>



<!-- l. 376 --><p class='noindent'><span class='ec-lmr-10'>If you need to add an appendix or appendices to a chapter, you must use the </span><span class='ec-lmtt-10'>[chapterapp]</span><span class='ec-lmr-10'> class option. The
code for the appendices themselves is exactly as described above. This means that the appendix itself is
introduced by the </span><code class='verb'>\chapter</code> <span class='ec-lmr-10'>command, </span><span class='ec-lmri-10'>not </span><span class='ec-lmr-10'>a </span><code class='verb'>\section</code> <span class='ec-lmr-10'>command (because this seems to be how the thesis office
Expand Down
2 changes: 1 addition & 1 deletion docs/Archivingyourthesisforthefuture.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
</head><body>
<p><object class='toc' data='msu-thesis-toc.html'> <span class='ec-lmr-10'>[</span><a href='msu-thesis-toc.html'><span class='ec-lmr-10'>table of contents</span></a><span class='ec-lmr-10'>] </span></object>
</p><!-- l. 423 --><div class='crosslinks'><p class='noindent'><span class='ec-lmr-10'>[</span><a href='MajorVersionhistory.html'><span class='ec-lmr-10'>next</span></a><span class='ec-lmr-10'>] [</span><a href='Askingmeforhelp.html'><span class='ec-lmr-10'>prev</span></a><span class='ec-lmr-10'>] [</span><a href='Askingmeforhelp.html#tailAskingmeforhelp.html'><span class='ec-lmr-10'>prev-tail</span></a><span class='ec-lmr-10'>] [</span><a href='#tailArchivingyourthesisforthefuture.html'><span class='ec-lmr-10'>tail</span></a><span class='ec-lmr-10'>] [</span><a href='Bugsandredistribution.html#Archivingyourthesisforthefuture.html'><span class='ec-lmr-10'>up</span></a><span class='ec-lmr-10'>] </span></p></div>
<h4 class='subsectionHead' id='archiving-your-thesis-for-the-future'><span class='titlemark'><span class='ec-lmr-10'>6.4 </span></span> <a id='x32-420006.4'></a><span class='ec-lmr-10'>Archiving your thesis for the future</span></h4>
<h4 class='subsectionHead' id='archiving-your-thesis-for-the-future'><span class='titlemark'><span class='ec-lmr-10'>6.4 </span></span> <a id='x33-440006.4'></a><span class='ec-lmr-10'>Archiving your thesis for the future</span></h4>
<!-- l. 424 --><p class='noindent'><span class='ec-lmr-10'>Since the current version of the </span><span class='ec-lmtt-10'>msu-thesis</span><span class='ec-lmr-10'> 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
Expand Down
9 changes: 3 additions & 6 deletions docs/Askingmeforhelp.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,18 @@
</head><body>
<p><object class='toc' data='msu-thesis-toc.html'> <span class='ec-lmr-10'>[</span><a href='msu-thesis-toc.html'><span class='ec-lmr-10'>table of contents</span></a><span class='ec-lmr-10'>] </span></object>
</p><!-- l. 413 --><div class='crosslinks'><p class='noindent'><span class='ec-lmr-10'>[</span><a href='Archivingyourthesisforthefuture.html'><span class='ec-lmr-10'>next</span></a><span class='ec-lmr-10'>] [</span><a href='Usagesurvey.html'><span class='ec-lmr-10'>prev</span></a><span class='ec-lmr-10'>] [</span><a href='Usagesurvey.html#tailUsagesurvey.html'><span class='ec-lmr-10'>prev-tail</span></a><span class='ec-lmr-10'>] [</span><a href='#tailAskingmeforhelp.html'><span class='ec-lmr-10'>tail</span></a><span class='ec-lmr-10'>] [</span><a href='Bugsandredistribution.html#Askingmeforhelp.html'><span class='ec-lmr-10'>up</span></a><span class='ec-lmr-10'>] </span></p></div>
<h4 class='subsectionHead' id='asking-me-for-help'><span class='titlemark'><span class='ec-lmr-10'>6.3 </span></span> <a id='x31-410006.3'></a><span class='ec-lmr-10'>Asking me for help</span></h4>
<h4 class='subsectionHead' id='asking-me-for-help'><span class='titlemark'><span class='ec-lmr-10'>6.3 </span></span> <a id='x32-430006.3'></a><span class='ec-lmr-10'>Asking me for help</span></h4>
<!-- l. 414 --><p class='noindent'><span class='ec-lmr-10'>I’m happy to answer emails about formatting issues with the class, especially when you are in
the final stages of formatting your dissertation or thesis, but please keep in mind the following:</span>
</p>



</p>
<ul class='itemize1'>
<li class='itemize'><span class='ec-lmr-10'>If you have general LaTeX questions that are not specifically related to the class, please try to find
answers elsewhere. </span><a href='https://tex.stackexchange.com/'><span class='ec-lmr-10'>tex.stackexchange.com</span></a> <span class='ec-lmr-10'>is an excellent resource for LaTeX help.</span>
</li>
<li class='itemize'><span class='ec-lmr-10'>Please make sure you have the latest version of the class (check the log file and compare it with</span>
<a href='https://ctan.org/pkg/msu-thesis?lang=en'><span class='ec-lmr-10'>CTAN</span></a> <span class='ec-lmr-10'>or </span><a href='https://github.com/amunn/msu-thesis'><span class='ec-lmr-10'>GitHub</span></a><span class='ec-lmr-10'>).</span>
</li>
<li class='itemize'><span class='ec-lmr-10'>Please make sure you’ve checked all the issues listed in section </span><a href='Thingstowatchoutforlabelwatchout.html#things-to-watch-out-for'><span class='ec-lmr-10'>5.14</span><!-- tex4ht:ref: watchout --></a><span class='ec-lmr-10'>.</span>
<li class='itemize'><span class='ec-lmr-10'>Please make sure you’ve checked all the issues listed in section </span><a href='Thingstowatchoutforlabelwatchout.html#things-to-watch-out-for'><span class='ec-lmr-10'>5.15</span><!-- tex4ht:ref: watchout --></a><span class='ec-lmr-10'>.</span>
</li>
<li class='itemize'><span class='ec-lmr-10'>Please send me an error-free, compilable sample document for me to test. The best option is for
this to be a small sample document using the class that you create that recreates the problem
Expand Down
Loading

0 comments on commit c196526

Please sign in to comment.