01 Erste Schritte

Unterstützte Betriebssysteme:

• Windows
  • Automatische Einrichtung
  • Manuelle Einrichtung
• Linux
  • Manuelle Einrichtung

Windows

Automatische Einrichtung (Windows)

Dieses Projekt enthält ein Skript, das beim ersten Start die gesamte erforderliche Software installiert und konfiguriert sowie Ihr Dokument basierend auf dieser Vorlage erstellt. Es werden keine Administrationsrechte benötigt - somit funktioniert die automatische Einrichtung auch auf Schul-PCs.

Je nachdem, welche Programme Sie bereits installiert haben, können bis zu ~5 GB heruntergeladen und installiert werden.

Das Skript kann mehrere Male ausgeführt werden, um weitere Dokumente einzurichten.

1. Navigieren Sie zu dem Ordner, in dem Sie ein neues Dokument erstellen möchten (Hinweis: Das Skript wird dort einen neuen Unterordner für die Dokumentdateien erstellen)
2. Kopieren Sie den folgenden Befehl, fügen Sie ihn in die Adressleiste des Datei-Explorers oder in eine Eingabeaufforderung ein und drücken Sie die Enter Taste:

cmd /v /c "set "NAME=LaTeXDocument" && curl -s https://raw.githubusercontent.com/hampoelz/HTL_Thesis-Template/main/scripts/install.bat -o "!NAME!.bat" && ".\!NAME!.bat""

Um den Ordner der Dokument-Dateien direkt zu benennen, ersetzen Sie LaTeXDocument am Anfang des Befehls durch den gewünschten Namen.

Fehlerbehebung:

• Die Installation bleibt bei einem Texlive-Paket stecken: Versuchen Sie, die Enter Taste zu drücken.
• Das erstellen des Dokuments ist nach erfolgreicher Installation nicht möglich: Versuchen Sie, VS Code neu zu starten.

Im Abschnitt Benutzung erfahren Sie mehr über die Verwendung dieser Vorlage.

Manuelle Einrichtung (Windows)

Erforderliche Software:

• git ≥ v2.22
• vs-code
• eine TeX-Distribution (zum Beispiel texlive oder miktex)
• latexmk
• luatex
• lacheck

Es wird nicht empfohlen, MikTeX zu verwenden! Wenn Sie MikTeX trotzdem benutzen wollen, stellen Sie sicher, dass Sie eine Perl-Distribution (zum Beispiel strawberry-perl) auf Ihrem System installiert haben.

Nachdem alles installiert wurde, erstellen Sie Ihr Dokument mit dieser Vorlage:

1. Als erstes müssen Sie einen neuen Ordner erstellen, in dem das Dokument gespeichert wird
2. Initialisieren Sie ein neues Git-Repository in diesem Ordner mit dem Befehl git init
3. Führen Sie den folgenden Befehl aus:

curl -s https://raw.githubusercontent.com/hampoelz/HTL_Thesis-Template/main/scripts/update.bat -o ..\update.bat && ..\update.bat && del ..\update.bat

Öffnen Sie den Ordner mit VS Code und Sie können mit dem Schreiben loslegen.

Im Abschnitt Benutzung erfahren Sie mehr über die Verwendung dieser Vorlage.

Linux

Manuelle Einrichtung (Linux)

Erforderliche Software:

• git ≥ v2.22
• perl
• vs-code
• texlive-full
• jq (nur auf Geräten mit ARM-Architektur erforderlich)

Es wird empfohlen, eine ArchLinux-basierte Distribution zu verwenden, da dort die neuesten Pakete verfügbar sind:

# git, perl, jq und texlive installieren
sudo pacman -S git perl jq texlive-most texlive-latexextra texlive-bibtexextra biber

# vs-code installieren
sudo pacman -S --needed git base-devel
git clone https://aur.archlinux.org/visual-studio-code-bin.git
cd visual-studio-code-bin
makepkg -si

Wenn Sie eine Debian-basierte Distribution verwenden, können Sie mit den folgenden Befehlen alles installieren:

⚠️ Warnung

Das Paket texlive-full benötigt ca. 6GB an Speicherplatz. Sie können ca. 3GB einsparen, wenn Sie texlive ohne Dokumentationen, Sprachpakete und CJK-Pakete installieren. Nachfolgend finden Sie eine entsprechende Anleitung.

# git und jq installieren
sudo apt install git jq

# vs-code installieren
# Quelle: https://code.visualstudio.com/docs/setup/linux
sudo apt install wget gpg
wget -qO- https://packages.microsoft.com/keys/microsoft.asc | gpg --dearmor > packages.microsoft.gpg
sudo install -D -o root -g root -m 644 packages.microsoft.gpg /etc/apt/keyrings/packages.microsoft.gpg
sudo sh -c 'echo "deb [arch=amd64,arm64,armhf signed-by=/etc/apt/keyrings/packages.microsoft.gpg] https://packages.microsoft.com/repos/code stable main" > /etc/apt/sources.list.d/vscode.list'
rm -f packages.microsoft.gpg

sudo apt install apt-transport-https
sudo apt update
sudo apt install code

# texlive-full installieren ...
sudo apt install texlive-full

# ... oder texlive-full ohne Dokumentationen, Sprachpakete und CJK-Pakete installieren ...
# Quelle: https://gist.github.com/shivams/0e62b79aaef345560c11aa1862b7029c
sudo apt install `sudo apt --assume-no install texlive-full | awk '/The following additional packages will be installed/{f=1;next} /Suggested packages/{f=0} f' | tr ' ' '\n' | grep -vP 'doc$' | grep -vP 'texlive-lang' | grep -vP 'latex-cjk' | tr '\n' ' '`

# ... und installieren Sie die Sprachpakete einzeln. Zum Beispiel:
sudo apt install texlive-lang-english texlive-lang-european texlive-lang-german

Nachdem alles installiert wurde, können Sie nun Ihr Dokument mit dieser Vorlage einrichten:

1. Erstellen Sie einen Ordner
2. Initialisieren Sie ein neues Git-Repository in diesem Ordner
3. Führen Sie den folgenden Befehl aus:

curl -s https://raw.githubusercontent.com/hampoelz/HTL_Thesis-Template/main/scripts/update.sh -o ../update.sh && bash ../update.sh && rm ../update.sh

Öffnen Sie den Ordner mit VS Code und Sie können mit dem Schreiben loslegen.

Im Abschnitt Benutzung erfahren Sie mehr über die Verwendung dieser Vorlage.