63 lines
2.1 KiB
Markdown
63 lines
2.1 KiB
Markdown
# PidI Thesis LaTeX Template
|
|
|
|
This template follows the specs:
|
|
- A4, margins: left/top **3 cm**, right/bottom **2.5 cm**.
|
|
- Page numbers bottom-center.
|
|
- Font: **Times Newer Roman 12 pt** (`times` class option, default).
|
|
- Line spacing **1.3**, justified text, paragraph spacing **6 pt**, emphasis **bold**.
|
|
- `\emph{}` is mapped to bold.
|
|
|
|
## File name for submission
|
|
|
|
`<Nachname> PidI 3 <Kurzform des Titels>.pdf`
|
|
|
|
## Build
|
|
|
|
```sh
|
|
direnv allow # einmalig — setzt Nix-Umgebung auf
|
|
latexmk # baut das PDF (LuaLaTeX + Biber, Ausgabe nach out/)
|
|
latexmk -c # aufräumen
|
|
```
|
|
|
|
Requires the Nix shell (`shell.nix`) — provides TeX Live, `latexmk`, `mermaid-cli`,
|
|
and Times Newer Roman (fonts are installed into `~/.local/share/fonts/` by the shell hook).
|
|
|
|
`minted` code listings require shell escape; `latexmk` handles this automatically via
|
|
`$pdf_mode = 4`.
|
|
|
|
## Rendering Mermaid diagrams
|
|
|
|
```sh
|
|
# render a single diagram
|
|
mmdc -f -i figures/diagrams/system-context.mmd -o figures/diagrams/system-context.pdf
|
|
|
|
# render all diagrams at once
|
|
for f in figures/diagrams/*.mmd; do
|
|
mmdc -f -i "$f" -o "${f%.mmd}.pdf"
|
|
done
|
|
```
|
|
|
|
`-f` (`--pdfFit`) is mandatory: without it `mmdc` writes the chart onto a full US-Letter
|
|
page, so `\includegraphics[width=\textwidth]` scales all that surrounding whitespace up
|
|
and a small diagram eats a whole A4 page.
|
|
|
|
Render before calling `latexmk` whenever a `.mmd` file changes. The generated `.pdf`
|
|
files are gitignored via `out` (only `out/` is ignored, so diagrams in `figures/` are
|
|
**not** ignored — commit them).
|
|
|
|
## Structure
|
|
|
|
```
|
|
main.tex entry point: metadata + \input all chapters
|
|
pidi-thesis.cls enforces the complete layout
|
|
frontmatter/ usage-of-ai, abstract, acknowledgments
|
|
chapters/<part>/*.tex one file per \section
|
|
appendix/ appendix.tex bundles tables/diagrams/screenshots/code
|
|
figures/code/ code excerpts as real files (no inline code in appendix)
|
|
figures/diagrams/ *.mmd source + rendered *.pdf
|
|
figures/screenshots/ screenshots
|
|
figures/worksimple/ company logos
|
|
figures/itc/ ITC logo
|
|
references.bib biblatex/biber sources
|
|
```
|