uiophd a LATEX document class for PhD theses

Transcription

1 uiophd a LATEX document class for PhD theses Program source code and documentation Dag Langmyhr dag@ifi.uio.no 26th January 2019

2

3 uiophd a L A T E X document class for PhD theses Dag Langmyhr dag@ifi.uio.no 26th January 2019 PHD THESES at the University of Oslo are printed centrally and must be typeset according to a set of specific requirements; see utdanning/mn/avvikling/skjemaer/nye_skjemaer/12_info_unipub.doc. The L A T E X document class uiophd defines a document style which implements these restrictions, the most important of which are typeface (URW Garamond and Vera Sans), page geometry (2.5 cm margins) and section header appearance. In addition, since most PhD theses contain a set of articles, a facility for including them is constructed. Program documentation system This program was documented using the eb 0 package which is based on Donald Knuth s ideas of literate programming. For more information on the eb 0 implementation, see 1 Standard L A T E X 2ϵ document class definitions All L A T E X 2ϵ class definitions consist of a standard part followed by code specific to that class. The class should also specify which version of L A T E X 2ϵ it needs. We do not need any recent one. #1 uiophd 1 \NeedsTeXFormat{LaTeX2e}[1995/06/01] 2 standard LaTeX specifications #2 (p.3) 3 uiophd definitions #8 (p.6) 4 final definitions #7 (p.6) (This code is not used.) Note that all internal names have the prefix uiophd@ to avoid confusion with names in other packages and any user-defined names. 1.1 Identification All L A T E X 2ϵ document classes should state their name and version number. #2 standard LaTeX specifications 5 \ProvidesClass{uiophd}[2016/09/26 v 1.04 UiO document class] (This code is extended in #2 a (p.3). It is used in #1 (p.3).) 1.2 Options This part of the code defines the document class options. #2 a standard LaTeX specifications #2 (p.3) + 6 option declarations #3 (p.4) 3

4 7 option inititialization #4 (p.4) (This code is extended in #2 b (p.5).) Type size options PhD theses should be set in 12 pt type. #3 option declarations 8 \DeclareOption{10pt}{\ClassWarningNoLine{uiophd}{Do not 9 use type size 10pt }} 10 \DeclareOption{11pt}{\ClassWarningNoLine{uiophd}{Do not 11 use type size 11pt }} 12 \DeclareOption{12pt}{} (This code is extended in #3 a (p.4). It is used in #2 a (p.3).) Language options This class presently handles the following two languages: American English (option american or USenglish) and British English (option english or UKenglish). #3 a option declarations #3 (p.4) + 13 \DeclareOption{american}{\renewcommand{\uiophd@lang}{USenglish}} 14 \DeclareOption{USenglish}{\renewcommand{\uiophd@lang}{USenglish}} 15 \DeclareOption{english}{\renewcommand{\uiophd@lang}{UKenglish}} 16 \DeclareOption{UKenglish}{\renewcommand{\uiophd@lang}{UKenglish}} (This code is extended in #3 b (p.4).) As is common in nearly all L A T E X document classes, American English is the default language. #3 b option declarations #3 (p.4) + 17 \newcommand{\uiophd@lang}{usenglish} (This code is extended in #3 c (p.4).) Adaption options Some users will use this document class at home, so not all fonts may not be available Alternative fonts Previously, this package used an option to select fonts which are not universially available; this is now done automatically (see Section 2.1 on page 6). The option is retained, however, for compatibility reasons. #3 c option declarations #3 (p.4) + 18 \DeclareOption{altfont}{} (This code is extended in #3 d (p.4).) Additional options Any other option is sent to the report class. #3 d option declarations #3 (p.4) + 19 \DeclareOption*{\PassOptionsToClass{\CurrentOption}{report}} Option initiation After all options have been defined, they may be processed. #4 option inititialization 20 \ProcessOptions \relax (This code is used in #2 a (p.3).) 4

5 1.3 Package and class loading The uiophd class is built on top of a base document class and various packages. #2 b standard LaTeX specifications #2 (p.3) + 21 load packages #6 (p.5) 22 load base class #5 (p.5) The base document class As mentioned, uiophd is an extension of the standard report document class. The options twoside and openright as well as the specified type size are standard. #5 load base class 23 \LoadClass[a4paper,twoside,openright,12pt]{report} (This code is used in #2 b (p.5).) The babel package This package handles everything concerning language and should always be present. #6 load packages 24 \RequirePackage[\uiophd@lang]{babel} (This code is extended in #6 a (p.5). It is used in #2 b (p.5).) The emptypage package We do not want page numbers on our blank pages. #6 a load packages #6 (p.5) + 25 \RequirePackage{emptypage} (This code is extended in #6 b (p.5).) The fontenc package This package, when specified with the T1 option, will utilize the more modern 8-bit fonts. #6 b load packages #6 (p.5) + 26 \RequirePackage[T1]{fontenc} (This code is extended in #6 c (p.5).) The geometry package This package will specify the page size 1 and the margins. #6 c load packages #6 (p.5) + 27 \RequirePackage[a4paper,twoside,margin=2.5cm]{geometry} (This code is extended in #6 d (p.5).) The keyval package This package is used to provide parameters to \includearticle defined in Section 2.3 on page 7. #6 d load packages #6 (p.5) + 28 \RequirePackage{keyval} (This code is extended in #6 e (p.6).) 1 For some reason yet unknown to me, the page size A4 should be declare both to the base document class (see Section 1.3.1) and to the geometry package to ensure that the PDF page size is correct. 5

6 1.3.7 The pdfpages package To include articles (see Section 2.3 on the next page), this package 2 is needed. #6 e load packages #6 (p.5) + 29 \RequirePackage{pdfpages} (This code is extended in #6 f (p.6).) The setspace package Adding a bit of extra leading is recommended by the publisher. We also add some interparagraph stretch to avoid messages about underfull \vbox. #6 f load packages #6 (p.5) + 30 \RequirePackage{setspace} 31 \AtBeginDocument{\parskip=0pt plus 2.5pt\relax 32 \setstretch{1.1}} The textcomp package This packages provides many additional symbols. Because of the danger of option clash, it is only loaded if no font package (i.e., garamondx) has already loaded it. #7 final definitions 33 \@ifundefined{tc@check@symbol}{% 34 \RequirePackage{textcomp}}{} (This code is used in #1 (p.3).) 2 Code specific to uiophd Some L A T E X code must be adapted or modified. 2.1 Typeface The standard font is supposed to be URW Garamond which is freely available, but not included in the T E Xlive distrubution. So, if this font is not available, Times is the alternative. #8 uiophd definitions 35 \IfFileExists{t1zgmj.fd} 36 {\RequirePackage[full]{textcomp} 37 \RequirePackage[garamond,expert]{mathdesign} 38 \RequirePackage[swashQ]{garamondx}} 39 {\renewcommand{\rmdefault}{ptm}} (This code is extended in #8 a (p.6). It is used in #1 (p.3).) Sans serif text should be set in Vera Sans (or Helvetica if unavailable). #8 a uiophd definitions #8 (p.6) + 40 \IfFileExists{berasans.sty} 41 {\RequirePackage[scaled]{berasans}} 42 {\renewcommand{\sfdefault}{phv}} (This code is extended in #8 b (p.6).) I think that Vera Mono will suit well as the accompanying typewriter font. available, choose Courier. #8 b uiophd definitions #8 (p.6) + 43 \IfFileExists{beramono.sty} If that is not 2 As indicated by its name, the pdfpages package will only work for pdflat E X, but it has been designed not to fail when producing DVI code. 6

7 44 {\RequirePackage[scaled]{beramono}} 45 {\renewcommand{\ttdefault}{pcr}} (This code is extended in #8 c (p.7).) Mathematical formulæ Mathdesign math fonts have been designed to go with URW Garamond, so the proper package has been included (if available). 2.2 Document parts The uiophd document class is based on the report class which has no \frontmatter, \mainmatter and \backmatter commands. Some users want these, however. #8 c uiophd definitions #8 (p.6) + 46 \newcommand{\frontmatter}{\cleardoublepage 47 \pagenumbering{roman}} 48 \newcommand{\mainmatter}{\cleardoublepage 49 \pagenumbering{arabic}} 50 \newcommand{\backmatter}{\cleardoublepage} (This code is extended in #8 d (p.7).) Title page The title page (made by \maketitle) is modified to include information specific to PhD theses. This is achieved by hacking the \maketitle command which in its turn hacks the \@date command: 3 #8 d uiophd definitions #8 (p.6) + 51 \let \uiophd@maketitle = \maketitle 52 \renewcommand{\maketitle}{{% 53 \let \uiophd@date = \@date 54 \renewcommand{\@date}{% 55 \uiophd@date\par 56 \vspace{5em} 57 Thesis submitted for the degree of Philosophi\ae~Doctor} 58 \uiophd@maketitle 59 }} (This code is extended in #8 e (p.7).) 2.3 Including articles As mentioned, most PhD theses contain a set of articles. To make it easy to include these, the command \includearticle is given. #8 e uiophd definitions #8 (p.6) + 60 \newcommand{\includearticle}[2][]{{% 61 set default page number position #9 (p.8) 62 \setkeys{uiophd@keys}{#1} 63 \includepdf[pages={-},pagecommand={\thispagestyle{\uiophd@ps}}]{#2}}} (This code is extended in #8 f (p.8).) 3 I generally don t like hacking commands, but it seemed the best way in this case. This only other alternative would have been to completely redefine the \maketitle command, and I like that even less. 7

8 2.3.1 Adjusting the page number The user may have to adjust the page number position on the included pages. #8 f uiophd definitions #8 (p.6) + 64 \define@key{uiophd@keys}{numbers}{\def \uiophd@ps {#1}} The options are: numbers=default The page numbers are in the same position as on the ordinary pages This is page style plain. #9 set default page number position 65 \let \ps@default = \ps@plain (This code is extended in #9 a (p.8). It is used in #8 e (p.7).) This is of course the default. #9 a set default page number position #9 (p.8) + 66 \def \uiophd@ps {default} (This code is extended in #9 b (p.8).) numbers=low The page numbers are lowered to avoid colliding with the included pages This is implemented by creating a modification of page style plain. #9 b set default page number position #9 (p.8) + 67 \def \ps@low {\let\@mkboth\@gobbletwo 68 \let\@oddhead\@empty 69 \def\@oddfoot{\reset@font\hfil\raisebox{-1.25cm}{\thepage}\hfil}% 70 \let\@evenhead\@empty 71 \let\@evenfoot\@oddfoot} (This code is extended in #9 c (p.8).) numbers=none No page numbers on these pages This is page style empty. #9 c set default page number position #9 (p.8) + 72 \let \ps@none = \ps@empty 8

9 Meta symbols final definitions #7... page 6 load base class #5... page 5 load packages #6... page 5 option declarations #3... page 4 option inititialization #4... page 4 set default page number position #9... page 8 standard LaTeX specifications #2... page 3 uiophd #1... page 3 * uiophd definitions #8... page 6 (Symbols marked with * are not used.) 9