ucalgmthesis (24oct19)

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

5 files changed, 61 insertions, 35 deletions

diff --git a/Master/texmf-dist/doc/latex/ucalgmthesis/README.md b/Master/texmf-dist/doc/latex/ucalgmthesis/README.md
index 918cd6e6ba9..2b3c1b74d43 100644
--- a/Master/texmf-dist/doc/latex/ucalgmthesis/README.md
+++ b/Master/texmf-dist/doc/latex/ucalgmthesis/README.md
@@ -59,6 +59,11 @@ with parts `\include`'d from separate files. Here's a minimal file:
 \end{document}
 ```
 
+The easiest way to get started is perhaps to rename
+`sample-thesis.tex`, change the metadata and layout options to your
+liking, and put the content of your thesis into the files it includes
+(`frontmatter.tex`, `chapter1.tex`, etc.)
+
 Commands
 --------
 
@@ -98,13 +103,17 @@ The class takes a number of options:
 - `singlespaced`, `onehalfspaced`, `doublespaced` sets up the line
   spacing (`onehalfspaced` is the default).
 
-- `palatino`, `times`, `garamond`, `utopia`, `libertine` offer some nice
-  alternative typefaces (i.e., fonts) to the default Computer Modern.
+- `palatino`, `times`, `garamond`, `utopia`, `libertine` offer some
+  nice alternative typefaces (i.e., fonts) to the default Computer
+  Modern. Note that `garamond` uses the
+  [`garamondx`](https://ctan.org/tex-archive/fonts/garamondx?lang=en)
+  package, which is not included in the TeXLive distibution (and is
+  not available on Overleaf).
 
-- `headers` produces running heads. Per the guidelines, must not be
-  the thesis title or author's name, and must be separated from the
-  main text by a line. The class uses the chapter number and title and
-  places it flush right in the header.
+- `headers` produces running heads. Per the guidelines, the running
+  heads must not be the thesis title or author's name, and must be
+  separated from the main text by a line. The class uses the chapter
+  number and title and places it flush right in the header.
 
 - `fullpage` calls `\fullpagethesis`, so produces a thesis with 1"
   margins all around. This produces very long lines and is not
@@ -186,6 +195,12 @@ Troubleshooting and Known Issues
 - `garamond` and `utopia` use the `mathdesign` package, which has a buggy
   `\hrulefill` command. The package tries to correct this.
 
+- `garamond` uses the `garamondx` package. This package has a
+  restrictive license and is thus not included in the TeXLive
+  distribution. Use the
+  [`getnonfreefonts`](https://www.tug.org/fonts/getnonfreefonts/)
+  installer to download it.
+
 - The guidelines require that the official filed thesis is laid out
   for one-sided printing (equal left and right margins). You may want
   to print the thesis two-sided, however, e.g., to give a nice bound
diff --git a/Master/texmf-dist/doc/latex/ucalgmthesis/appendix.tex b/Master/texmf-dist/doc/latex/ucalgmthesis/appendix.tex
index f5700956dbe..4ef131f6113 100644
--- a/Master/texmf-dist/doc/latex/ucalgmthesis/appendix.tex
+++ b/Master/texmf-dist/doc/latex/ucalgmthesis/appendix.tex
@@ -8,7 +8,7 @@
 \chapter*{Appendix}\label{appendix}
 
 % \chapter* doesn't include it in the TOC, so we have to do that by
-% hand.  If you have multiple chapters, use \chapter instead and
+% hand.  If you have multiple appendices, use \chapter instead and
 % remove the following line. 
 
 \addcontentsline{toc}{chapter}{Appendix}
diff --git a/Master/texmf-dist/doc/latex/ucalgmthesis/sample-thesis.pdf b/Master/texmf-dist/doc/latex/ucalgmthesis/sample-thesis.pdf
index 79e876a302e..8cc7d5a167b 100644
--- a/Master/texmf-dist/doc/latex/ucalgmthesis/sample-thesis.pdf
+++ b/Master/texmf-dist/doc/latex/ucalgmthesis/sample-thesis.pdf
diff --git a/Master/texmf-dist/doc/latex/ucalgmthesis/sample-thesis.tex b/Master/texmf-dist/doc/latex/ucalgmthesis/sample-thesis.tex
index 610fe039870..96fc6b4ace8 100644
--- a/Master/texmf-dist/doc/latex/ucalgmthesis/sample-thesis.tex
+++ b/Master/texmf-dist/doc/latex/ucalgmthesis/sample-thesis.tex
@@ -1,24 +1,28 @@
 % A Sample Thesis for the University of Calgary
 % =============================================
 
-% Load the UCalgary Memoir Thesis class. By default (without options),
-% this produces a 1-1/2 spaced thesis in 11 point font without running
-% heads. Use package options singlespaced or doublespaced for single
-% or double line spacing. The default font is LaTeX's Computer
-% Modern. Use package options times, palatino, libertine, garamond, or
-% utopia for other nice typefaces. (You may need to install the
-% relevant packages to get these to work.) Use package option headers
-% if you want running heads. Use option fullpage if you want the text
-% to occupy all allowable space (1 inch margins all around), or option
-% manuscript if you want a page layout suitable for reviewing and
-% proof reading. Option manuscript selects 12 pt type, doublespaced,
-% approx. 25 lines per page, with approx. 72 characters per line. You
-% may want to remove the option for the version you file in the Vault;
-% it looks nicer and is a bit more compact. You can also use any
-% options that the memoir class recognizes, such as 10pt for 10 point
-% font, 11pt for 11 point font, 12pt for 12 point type,
-% etc. Documentation of the memoir package can be found at
-% https://ctan.org/pkg/memoir?lang=en
+% This is a sample LaTeX document to build a University of Calgary
+% graduate thesis according to the guidelines of the Faculty of
+% Graduate Studies, available here:
+% https://grad.ucalgary.ca/current-students/thesis-based-students/thesis/building-thesis
+
+% To use this sample for your own thesis, rename this file, make any changes
+% necessary, then add the content of your thesis t othe included files
+% frontmatter.tex, chapter1.tex, etc.
+
+% First, we load the UCalgary Memoir Thesis class ucalgmthesis,
+% available at https://github.com/rzach/ucalgmthesis
+
+% By default (without options), this produces a 1-1/2 spaced thesis in
+% 11 point font without running heads. See the README file for a
+% description of all package options.
+
+% In our sample we give three options: Option utopia sets the thesis in a
+% nice font. Option headers produces running heads. Option manuscript
+% formats the page in a way suitable for reading and commenting: 12 pt type,
+% double spaced, approx. 25 lines per page, with approx. 72 characters
+% per line. For filing in the Vault, remove that option to produce a
+% more compact thesis with a slightly better layout.
 
 \documentclass[utopia,headers,manuscript]{ucalgmthesis}
 
@@ -37,8 +41,7 @@
 \usepackage{microtype}
 
 % We'll need some colored links, so we load xcolor and hyperref. But
-% you can take that out if you don't want links at all or are happy
-% with the standard garish colored boxes.
+% you can take that out if you don't want links at all.
 
 \usepackage[dvipsnames]{xcolor}
 
@@ -100,7 +103,7 @@
 
 % The year
 
-\thesisyear{2018}
+\thesisyear{2019}
 
 % Tell hyperref to put author and title into the PDF metadata
 
@@ -123,6 +126,8 @@
 
 % \includeonly{titlepage}
 
+% and then copy the resulting PDF to a separate file.
+
 \begin{document}
 
 \frontmatter
@@ -153,8 +158,9 @@
 
 \include{backmatter}
 
-% The appendix contains material that would clutter up the main
-% text. Remove it if you don't have an appendix.
+% The appendix contains material that would clutter up the main text,
+% such as program code, survey instruments, or interview transcripts.
+% Remove it if you don't have an appendix.
 
 \appendix
 
diff --git a/Master/texmf-dist/tex/latex/ucalgmthesis/ucalgmthesis.cls b/Master/texmf-dist/tex/latex/ucalgmthesis/ucalgmthesis.cls
index 23cd021b0de..3e2c691def2 100644
--- a/Master/texmf-dist/tex/latex/ucalgmthesis/ucalgmthesis.cls
+++ b/Master/texmf-dist/tex/latex/ucalgmthesis/ucalgmthesis.cls
@@ -11,7 +11,7 @@
 % Distributed under the terms of the MIT License
 % https://opensource.org/licenses/MIT
 
-\ProvidesClass{ucalgmthesis}[2019/04/02
+\ProvidesClass{ucalgmthesis}[2019/10/24
   University of Calgary Memoir Thesis Class]
 
 \NeedsTeXFormat{LaTeX2e}[1994/06/01]
@@ -85,12 +85,12 @@
 
 \DeclareOption*{\PassOptionsToClass{\CurrentOption}{memoir}}
 
-% By default, typeset with one half spacing, no running heads, 11 pt
+% By default, typeset with one half spacing, no running heads
 
 \ExecuteOptions{onehalfspaced,plain}
 
 % Tell memoir the document has to be one-sided (i.e., don't switch
-% margins, etc.) and don't add empty pages before new chapters
+% margins, etc.), 11 pt, and don't add empty pages before new chapters
 
 \PassOptionsToClass{openany,oneside,11pt}{memoir}
 \ProcessOptions
@@ -119,8 +119,13 @@
 
 \newcommand{\manuscriptthesis}{%
   \setlxvchars
-  \settypeblocksize{25\baselineskip}{1.1\lxvchars}{*}%
-  \setulmargins{*}{*}{*}%
+  \settypeblocksize{25\baselineskip}{1.1\lxvchars}{*}
+  \if@twoside
+    \setlrmargins{*}{*}{1.618}
+  \else
+    \setlrmargins{*}{*}{1}
+  \fi
+  \setulmargins{*}{*}{*}
   \checkandfixthelayout}
 
 % fix a bug in mathdesign