TGM-HIT / latex-projects

LaTeX templates for project documentation and scrum artifacts.

LaTeX Projects

LaTeX templates for project documentation and scrum artifacts.

Anwendung

Zur Anwendung sind je nach Dokument bestimmte Dateien aus dem Vorlagenverzeichnis zu kopieren. Um die Dokumente zu kompilieren werden XeLaTex und Python 3.4 oder höher benötigt.

Dokument

mkdir -p docs/test                          # Verzeichnis des neuen Dokuments
cp templates/article/*article* docs/test/.  # Kopieren der Vorlagen

Zusätzlich können auch Bibliographie- und Glossareinträge früherer Dokumente hinzugefügt werden.

cp templates/article/bib.bib docs/test/. && cp templates/article/glo.tex docs/test/.

Kompiliert wird ein Dokument über die Anwendung maketex.

cd docs/test
../../maketex -xf article

Artefakt

mkdir -p alpha/test
cp -r templates/sprint/* alpha/test/.
cd alpha/test
../../maketex -xf abnahme dokumentation retro

Docker

Alternativ kann ein Docker Container mit allen Abhängigkeiten der Dockerfile Datei instanziert werden.

Um diesen Container zu erstellen, sollte folgendes Kommando ausgeführt werden:

docker build -t latex-tgm/projects:latest .

Das Erstellen von Dokumenten ist über Docker mit folgendem Befehl möglich: docker run --rm -it --user="$(id -u):$(id -g)" -v $PWD:/data latex-tgm/projects:latest bash -c "cd data && maketex -xf article" bzw. einfach mit dem bereitgestellten Shell-Script im jeweiligen Verzeichnis:

cd docs/test
../../rundocker.sh -xf article