Project structure & configuration
Please read the configuration page for setting up the LaTeX project structure. Highly recommended.
Workflow
The documents are typically edited with
- TeX editors
- generic editors
- LyX
- hosted cloud services (ShareLaTeX, Overleaf, 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
- Pandoc markdown → PDF
- Pandoc markdown → TeX → PDF
- Integrated build system (ShareLaTeX / 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
) is highly recommended.
ShareLaTeX
For more general instructions, this Youtube channel offers free videos on how to use ShareLaTeX. Unfortunately, the techniques listed in the videos may slightly differ from our official recommendations.
Miscellaneous
- Report bugs via https://gitlab.utu.fi/tech/education/misc/template-labreport/issues
- LaTeX tutorial: http://www.ctan.org/tex-archive/info/lshort/english/lshort.pdf
- Overleaf tutorials: https://www.overleaf.com/learn/latex/Tutorials
More?
Few examples of more advanced functionality →