Dokumentationsvorlagen

Hier können die aktuell gültigen Vorlagen für die Protokolle und Diplomarbeiten der Abteilung HIT abgerufen werden.

Protokollvorlagen

Genauere Informationen zur Installation, Konfiguration und Kompilierung der Protokollvorlage finden sich im zugehörigen Repository unter https://github.com/TGM-HIT/latex-protocol (LaTeX-Version) bzw. https://github.com/TGM-HIT/typst-protocol (Typst-Version).

Installation (LaTeX)

Im Ordner, welcher das Protokoll beinhalten soll kann die Vorlage über Git heruntergeladen werden:

git clone https://github.com/tgm-hit/latex-protocol.git

Es ist auch möglich mit bekannten Editoren in den entsprechenden Betriebssystemen mit der Vorlage zu arbeiten.

Installation (Typst)

Die Vorlage der Diplomarbeit kann über typst init auf ein neues Projekt angewendet werden:

typst init @preview/tgm-hit-protocol

In der Webapp kann die Vorlage z.B. über den "Create new project in app" Button auf der Universe page der Vorlage verwendet werden.

Diplomarbeitsvorlage

Genauere Informationen zur Installation, Konfiguration und Kompilierung der Diplomarbeitsvorlage finden sich im zugehörigen Repository unter https://github.com/TGM-HIT/diploma-thesis (LaTeX-Version) bzw. https://github.com/TGM-HIT/typst-diploma-thesis (Typst-Version).

Installation (LaTeX)

Die Vorlage der Diplomarbeit kann über Git heruntergeladen werden:

git clone https://github.com/tgm-hit/diploma-thesis.git

Installation (Typst)

Die Vorlage der Diplomarbeit kann über typst init auf ein neues Projekt angewendet werden:

typst init @preview/tgm-hit-thesis

In der Webapp kann die Vorlage z.B. über den "Create new project in app" Button auf der Universe page der Vorlage verwendet werden.

LaTeX-Build

Am einfachsten kann das Dokument über den make Befehl erstellt werden, wenn dieses am System vorhanden ist.

make

Alternativ kann das Dokument auch folgende Latex Befehle zu diesem Ergebnis:

pdflatex -interaction=nonstopmode -shell-escape protocol	# Initial compilation
makeglossaries protocol 					# Compile glossaries
pdflatex -interaction=nonstopmode -shell-escape protocol	# Progressive compilation for glossaries
bibtex protocol 						# Compile bibliography
pdflatex -interaction=nonstopmode -shell-escape protocol	# Progressive compilation for bibtex
pdflatex -interaction=nonstopmode -shell-escape protocol	# Progressive compilation for bibtex

TexMaker / TexStudio

Bei der Verwendung der populären Entwicklungsprogramme TexMaker oder TexStudio, kann ein eigenes Kommando über Optionen → Konfiguriere TexStudio / TexMaker → Erzeugen → Benutzerkommando hinzugefügt werden:

pdflatex -shell-escape -interaction=nonstopmode % | txs:///makeglossaries | pdflatex -shell-escape -interaction=nonstopmode % | txs:///bibtex | pdflatex -shell-escape -interaction=nonstopmode % | pdflatex -shell-escape -interaction=nonstopmode % | txs:///view-pdf-internal --embedded

Natürlich kann auch der make Befehl mit der Umgebungsvariable LOG=true verwendet werden:

make LOG=true | txs:///view-pdf-internal --embedded

Typst-Build

Eine Typst-Installation vorausgesetzt kann ein Typst-Dokument über folgenden Befehl kompiliert werden (vorausgesetzt die Hauptdatei des Dokuments heißt main.typ):

typst compile main.typ
# für Live-Updates des zu erstellenden PDFs:
typst watch main.typ

Editor-Plugins

Für die Integration in verschiedene Editoren wird aktuell (September 2024) tinymist empfohlen. tinymist stellt Kompilierung, syntax highlighting, Autovervollständigung, live preview, etc. zur Verfügung. Es gibt Installationsanleitungen für einige gängige Editoren.