FOP-2324-Projekt-Documentation-TeX

Die $\LaTeX$-Vorlage für die Dokumentation des FOP-Projekts im Wintersemester 2023/2024. Bitte wie bei anderen Abgaben auch den Quellcode der eigenen Abgabe nicht vor der Deadline veröffentlichen. (privates Repository)

Automatisches Setup (empfohlen)

Lokal (Devcontainer)

• Docker installieren
• VS-Code (oder die Open-Source Variante Code-OSS) und Remote-Containers-Extension installieren
• Dieses Repository klonen
• In VS-Code öffnen
• .vscode/settings.default.json in .vscode/settings.json kopieren
• Auf die Meldung "Reopen in Container" klicken
• Falls die Meldung nicht angezeigt werden sollte, kann der Container auch über die Command Palette (F1) geöffnet werden: Remote-Containers: Reopen in Container
• Für dark-mode kompillierung die Environment Variable DARK_MODE=1 unter der Einstellung "latex-workshop.latex.tools" hinzufügen

Lokal (Docker)

• Docker installieren
• Dieses Repository klonen
• kompilieren z.B. mit docker run --rm -v $(pwd):/workspace -w /workspace make -j $(nproc)

Online (Sharelatex der TU-Darmstadt)

Falls eine Latex-Installation nicht möglich ist, haben wir hier auch eine Sharelatex-Vorlage erstellt: Sharelatex

Um diese zu nutzen:

• Einloggen auf Sharelatex
• Den Link zum Template öffnen
• Menu -> Copy Project
• Projektname eingeben und auf "Create" klicken

Manuelle Installation (nicht empfohlen, aufwendig)

• Latex-Installation (z.B. MikTex oder TexLive)
• Installation der TU-Template und der verwendeten Plugins (inklusive Logo!)
• Installation der AlgoTeX-Vorlage

Konfiguration des Formatters

Um eine einheitliche Formatierung aller Übungsblätter zu gewährleisten, muss Latexindent installiert und entsprechend konfiguriert werden, um die mitgelieferte latexindent.yaml zu verwenden. Ein Aufruf von latexindent könnte z.B. so aussehen:

latexindent.pl -l -w myfile.tex

in VS-Code mit LaTeX-Workshop kann man die Folgende Konfiguration verwenden:

"latex-workshop.latexindent.args": [
    "-c",
    "%DIR%/",
    "%TMPFILE%",
    "-l",
    // "-m", // -m can have undesired sideeffects
    "-y=defaultIndent: '%INDENT%'"
],

Alternativ kann die Datei defaultSettings.yaml mit der mitgelieferten latexindent.yaml überschrieben werden. Den Speicherort der Default Settings findet man über:

latexindent -vv

Kompilieren

Automatisches Kompilieren mit Makefile

Unter Unix-basierten Systemen kann das Projekt mit dem Befehl

make -j

kompiliert werden Dabei werden automatisch sowohl die light als auch die dark Variante parallel kompiliert und sind im Ordner build zu finden.

Manuelles Kompilieren - Empfehlungen

• Empfohlener Compiler: latexmk mit LuaLaTeX
• Empfohlene LaTeX-Distribution: TeX-Live
• Auflistung der Empfohlenen LaTeX-Editoren:
  • VS-Code (oder die Open-Source Variante Code-OSS) mit LaTeX-Workshop-Extension
  • Neovim mit VimTeX-Plugin
  • IntelliJ Idea mit TeXiFy IDEA-Plugin
  • TeX-Studio
• Hinweise für das Auswählen von PDF-Viewern:
  • Ein guter PDF-Viewer sollte synctex unterstützen, sodass man zwischen Quellcode und PDF hin- und her springen kann