- Project structure & configuration
- PDF/A configuration
- Workflow
- Updating the page template
- Overleaf
- Miscellaneous
- More?
Project structure & configuration
Please read the configuration page for setting up the LaTeX project structure. Highly recommended.
PDF/A configuration
Please read the PDF/A configuration page for setting up the PDF/A processing. Highly recommended.
Workflow
The documents are typically edited with
- TeX editors
- generic editors
- LyX
- UTU hosted Overleaf cloud service (tex.soft.utu.fi, overleaf.com)
- or even GitLab Web IDE)
The documents are compiled with
- TeX → directly with TeX utilities (pdflatex/xelatex/tectonic) → PDF
- TeX → LaTeX frontend (mklatex, arara etc.) → PDF
- LyX → TeX → one of the previous two → PDF
- LyX → PDF
- Integrated build system (Overleaf) → PDF
- CI/CD pipeline (GitLab) → PDF artifact / publish site
Note: when using TeX utilities directly, you need to make sure the
document has been fully processed. Usually this requires multiple
compilation passes, interleaved with invocations of the auxiliary tools
(glossary & bibliography generation etc.). Using the LaTeX frontend
tools (latexmk) instead are highly recommended.
Updating the page template
The page template is updated from time to time. Usually there are some minor bugs or updates needed to compile with later versions of LaTeX distributions. If you wish to apply those updates to your project, simply back up the previous utuftthesis.cls file and replace it with the new one. If you don't know how to use git, just copy the content listed here and replace the contents of the file in your workspace.
Overleaf
For more general instructions, this Youtube channel offers free videos on how to use Overleaf. Unfortunately, the techniques listed in the videos may slightly differ from our official recommendations.
Miscellaneous
- Report bugs via https://gitlab.utu.fi/ttweb/thesis/issues
- LaTeX tutorial: http://www.ctan.org/tex-archive/info/lshort/english/lshort.pdf
- Overleaf tutorials: https://www.overleaf.com/learn/latex/Tutorials
- https://intranet.utu.fi/fi/yksikot/sci/yksikot/mattil/opiskelu/latex/Sivut/default.aspx
More?
Few examples of more advanced functionality →