utrechtuniversity/uu-dissertation-template

This is a Utrecht University dissertation template for LaTeX

Utrecht University dissertation template

Version 1.0

This is a Utrecht University dissertation template for LaTeX. While it is loosely based on the TU Delft template, it should follow the required content and textual obligations as provided in the doctoral degree regulations and the 'aanwijzingen voor promovendi'.

It is designed to work with all versions of LaTeX, but if you want to adhere to the UU housestyle (some legacy there), you need add the UU fonts and use XeLaTeX, as it supports TrueType and OpenType fonts.

We welcome all input and any suggestions or examples of using this template, for those a showcase will be made here.

Using the template

The document can be compiled with latexmk, alternatively by running:

pdflatex main
biber references
pdflatex main
pdflatex main

Or by selecting the 'pdfLaTeX' and 'Biber' options in your favourite TeX editing program, respectively.

A sample document, as well as documentation for template options, can be found in main.pdf.

Known issues

When you use the template for the first time, you might encounter some of the issues below.

1. Please note: When running the following warning is due to the fancy colouring of the headers. Not sure how to fix this.

   Token not allowed in a PDF string (Unicode): (hyperref) removing `\@ifnextchar'.

2. pdfLaTeX may not initially succeed, referring to a log file for troubleshooting. This log file may contain a line such as:

   The futri8r source file could not be found.

   This means that the font map file was not created or linked, which is needed for the Type1 version of the font. Usually you can resolve this by installing the fonts (if you have not already done so) for your specific distribution (check the installed packages) and then refresh the font map files. This last step may depend on the TeX distribution you are using. For example, in the MiKTeX console, you can do this by clicking "Refresh font map files" in the "Tasks" drop down menu.

If this doesn't work on Windows you can try the following solution with updmap.exe: https://tex.stackexchange.com/questions/247492/problem-with-fourier-package-the-text-disappears.

Project organisation

A description of the project organisation is provided below. The required, often included and optional sections are also labeled here (as well as within main.tex).

As this is an ongoing project, the works in progress (WIP) are explicitly listed.

.
├── .gitignore
├── CITATION.md
├── LICENSE.md
├── README.md
├── dissertation.cls 			<- Class description and general style definition (WIP)
├── stylesheet.tex 			<- Packages and some style definitions (WIP)
├── main.tex 				<- Main .tex document, use this to (de-)activate chapters and parts
├── main.pdf 				<- Compiled disseration
├── fonts                		<- Set of fonts to use within the dissertation
├── FrontMatter         		<- Contains all .tex files for content before the introduction
│   	├── cover.tex   	 		<- Styling of the cover content
│   	├── Cover	  	 		<- Contains cover images
│   	├── title.tex          	 		<- Title page content and styling (required)
│   	├── Logos		 		<- Contains all logos used
│   	├── acronyms.tex 		        <- Definition of acronyms used (often included)
│   	├── hyphenations.tex 		        <- Explicit hyphenation commands for terminology
│   	├── shorthand.tex 		        <- Way to define shorthands for common terms or phrases
│   	└── preface.tex     		        <- Optional opening word (optional)
├── MainMatter             		<- Contains all .tex files for the content from introduction to conclusion
│   	├── introduction.tex     		<- Introduction .tex file (required)
│   	├── contributions.tex     	        <- Overview of contributions .tex file (required, can be part of appendix, see publications.tex)
│   	├── conclusions.tex     		<- Conclusion .tex file (required)
│   	└── paper1				<- Contains the .tex file (paper1-main) and Figures folder (in this case the explanation of the class)
└── BackMatter           		<- Contains all .tex files for content after the conclusion
        ├── epilogue.tex                        <- Epilogue (optional)
        ├── appendix-example.tex   	        <- Example of appendix of a MainMatter paper/chapter
        ├── sikx.tex        		        <- SIKS research school list (required for SIKS members)
        ├── samenvatting.tex        	        <- Dutch samenvatting (required if dissertation in English)
        ├── publications.tex        	        <- Listing method for published works (required)
        ├── acknowledgements.tex	        <- Ackns. or Dankwoord (often included)
        ├── cv.tex        			<- CV or about the author (required)
        └── backcover.tex         	        <- Styling of the back cover content

License

This project is licensed under the terms of the MIT License

Citation

Please cite this project as described here.

uu-dissertation-template's Issues

Fix comments in Stylesheet

This is still the original slightly shit version of the combination of all information into a stylesheet.

Reason to use packages should be explained, possibly add examples for later

Fix comments in the LaTeX class descriptor

Current version needs some work and misses a large set of comments to explain choices and what a part does.

Born outside of NL

Input from Bureau Pedel;
Is een kandidaat geboren in het buitenland dan moet ook in het Nederlands het geboorteland vermeld worden achter de plaats.

i.e. add optional country after location + comments

Change TUD colours to UU colours

Needs to be changed in name and explicit colour variables (CMYK/RGB)

• define colours in documentclass
• change name use in stylesheet
• change in example chapter

Building with latexmk

I tried following the instructions, and after cloning run latexmk, but I get the following output

...
(/usr/share/texlive/texmf-dist/tex/latex/acro/acro.definitions.tex))

! LaTeX3 Error: The key 'acro/make-links' is unknown and is being ignored.

For immediate help type H <return>.
 ...                                              
                                                  
l.28 \acsetup{make-links=true}
                              
? 

Versions:

jacco@betal082367:~$ lsb_release -a
No LSB modules are available.
Distributor ID:	Ubuntu
Description:	Ubuntu 20.04.6 LTS
Release:	20.04
Codename:	focal

jacco@betal082367:~$ latexmk --version

Latexmk, John Collins, 26 Dec. 2019. Version 4.67

Update Citation

Should probably use a CITATION.cff file instead of the current Markdown citation. That way, GitHub can provide the citation in both APA and BibTex formats, as is also explained in their docs.

Fix the ToC colouring

Something goes a bit iffy with the current ToC colouring... Need to look into this as the chapters/parts should be given their own colour....

Integrate a showcase

I think the addition of a showcase for folk who've used the template and wanted to share their final manuscript could be cool.
This can also be used to show what can be done/adjusted & provide others with ideas for their manuscript.

Given my limited knowledge on how to run a github repo, input on the best/neatest way to do this would be appreciated!