Eloi's Phd Manuscript Template

For any and all questions, feel free to reach out to me (Eloi): see my website for contacts.

Code structure

.vscode/ folder for VSCode settings.

.vscode/keybindings.json keybinding settings you can copy into your VSCode settings for compilation routines.

.vscode/settings.json additional settings automatically read by VSCode.

Chapters/ folder containing the Latex code for individual chapters.

Chapters/chapX/chapX.tex: main Latex file for chapter X.

Chapters/chapX/chapX_standalone.tex: Latex file allowing for compilation of chapter X independently.

Classe/colors.tex defines different template colours.

Classe/dummy_labels.tex defines \cref-compatible labels for the case where chapter X is referenced in chapter Y to allow for standalone compilation of chapter Y.

Classe/localTOC.tex: code for chapter table of contents.

Classe/packages.tex: all Latex packages used by the template (a few others are loaded in the class file).

Classe/rainbowtoc.tex: code for the colour-coded global table of contents.

Classe/shortcuts.tex: all math shortcuts.

Classe/standalone_addon.tex: code for compilation of independent chapters.

Classe/tags.tex defines the coloured sidebars on every page.

Classe/theorem.tex defines coloured theorem environments.

fonts/: font folder for the template (in particular for Roboto).

frontmatter/: folder for content before the introduction.

frontmatter/thanks/: folder for the thanks (a.k.a. Acknowledgements).

frontmatter/abstract_X.tex: file for abstract in language X.

frontmatter/dedication.tex: file for the dedication (on third page, e.g. "to my beloved pet")

frontmatter/lab.tex: your lab at the bottom of the second page.

Frontpage/: folder containing the latex code for Frontpage/frontpage.pdf which is imported by the main file.

PartAddons/partX_summary.tex: file defining the summary text on the page of part X.

.gitignore: Git file to ignore certain files from tracking.

all.bib: bibliography file.

Dissertate.cls: main Latex class file defining the template.

manuscript.tex: main Latex file for the manuscript.

README.md: you're reading it!

Latex questions

Compiling the main document

The main document manuscript.tex is meant to be compiled with LuaLaTeX and Biber. If you use VSCode, the settings included .vscode/settings.json define two compilation recipes automatically (this file is read by VSCode):

• LuaLaTeX ➞ Biber ➞ LuaLaTeX ×2 runs one pass of LuaLaTeX then Biber then two passes of LuaLaTeX. This is the full job that you should run for every compilation.

• LuaLaTeX Single Pass runs LuaLaTeX only once, which should be fine to check math and minor changes, but will likely not suffice for references and citations. In particular, this template's sidebars can break if this job is used after large changes.

In .vscode/keybindings, you can find VSCode key mappings which map the first job to F5 and the second to F4. For these to be applied to your editor, you need to copy them into your global VSCode keybindings JSON file.

Compiling the front page

The front page (located in Frontpage/frontpage.tex)is compiled separately from the main document. The compilation must be done with pdflatex, for example simply with the following command:

pdflatex frontpage.tex

Compiling chapters individually

To compile chapter X individually, simply run the compilation routine on the file Chapters/chapX/chapX_standalone.tex. If the chapter references equations, theorems, etc from another chapter, you need to use the package xr to load the hyperref data from the other chapter. This is done in chapter A.II which imports the data from chapter A.I using \externaldocument{../chapAI/chapAI_standalone}, which reads the data from the compilation of chapAI_standalone.tex to compile chapAII_standalone.tex.

Colours

The list of colours for the parts and chapters is defined (in HTML, i.e. hex format) in Classe/colors.tex. The macro BoxColor always stores the colour of the current chapter (it is updated in manuscript.tex using the macro \ChangeColor).

During each chapter, the template has a coloured sidebar defined by the macro Classe/tags.tex and using the colour code of the current chapter.

Tags (coloured sidebar)

To adjust the length of the sidebar, at line 62 in Classe/tags.tex, you can set the size (height) of the sidebar in each chapter. A possible formula for this is (29.7 - 2) / n_chapters where n_chapters is the number of chapters (including the intro but not the conclusion).