Commit c8d11c98 authored by Dennis Kähler's avatar Dennis Kähler

Update README.md

parent fde0e023
# iMEK Latex Vorlage
## Kompilieren des Projektes
Für die Kompilierung von LaTeX ist eine LaTeX Distribution erforderlich. Für Windows ist [MiKTeX](https://miktex.org/) und für Linux ist [TeX Live](https://www.tug.org/texlive/) zu empfehlen. Die Programme, welche mit der Distribution zur Verfügung gestellt werden, müssen in der **Path** Variable des Betriebssystems enthalten sein. Bei MiKTeX sind diese z.B. in dem Unterordner miktex/bin in dem Hauptinstallationsordner von MiKTeX zu finden.
Für die Kompilierung von LaTeX ist eine LaTeX Distribution erforderlich. Für Windows ist [MiKTeX](https://miktex.org/) und für Linux ist [TeX Live](https://www.tug.org/texlive/) zu empfehlen. Die Programme, welche mit der Distribution zur Verfügung gestellt werden, müssen in der *Path* Variable des Betriebssystems enthalten sein. Bei MiKTeX sind diese z.B. in dem Unterordner miktex/bin in dem Hauptinstallationsordner von MiKTeX zu finden.
Generell ist es zu empfehlen das Projekt mit **latexmk** zu kompilieren. Dieses Skript muss unter Umständen in der LaTeX Distribution hinzugeführt werden. Das Skript ist in Perl geschrieben, weshalb Perl installiert sein muss und vom System gefunden werden muss. Das heißt der Pfad der **Perl.exe** muss in der **Path** Variable des Betriebssystems enthalten sein. Für Windows kann man z.B. [Strawberry Perl](http://strawberryperl.com/) nutzen. **latexmk** kompiliert in der richtien Reihenfolge und mit der richtigen Anzahl an Durchläufen mit **pdflatex** und **bibtex**.
Generell ist es zu empfehlen das Projekt mit *latexmk* zu kompilieren. Dieses Skript muss unter Umständen in der LaTeX Distribution hinzugeführt werden. Das Skript ist in Perl geschrieben, weshalb Perl installiert sein muss und vom System gefunden werden muss. Das heißt der Pfad der *Perl.exe* muss in der *Path* Variable des Betriebssystems enthalten sein. Für Windows kann man z.B. [Strawberry Perl](http://strawberryperl.com/) nutzen. *latexmk* kompiliert in der richtien Reihenfolge und mit der richtigen Anzahl an Durchläufen mit *pdflatex* und *bibtex*.
Diese Vorlage nutzt unter anderem das Paket Glossaries für das Symbol- und Abkürzungsverzeichnis. Damit diese funktionieren, reicht es nicht **pdflatex** + **bibtex** oder **latexmk** ohne weitere Konfiguration auszuführen. Es muss für jedes Glossar der **makeindex** Befehl mit bestimmten Optionen ausgeführt werden. Dafür liegt die Konfigurationsdatei **latexmkrc** im Hauptordner bei. Diese konfiguriert **latexmk** entsprechend für die Nutzung der Glossare.
Diese Vorlage nutzt unter anderem das Paket Glossaries für das Symbol- und Abkürzungsverzeichnis. Damit diese funktionieren, reicht es nicht *pdflatex* + *bibtex* oder *latexmk* ohne weitere Konfiguration auszuführen. Es muss für jedes Glossar der *makeindex* Befehl mit bestimmten Optionen ausgeführt werden. Dafür liegt die Konfigurationsdatei *latexmkrc* im Hauptordner bei. Diese konfiguriert *latexmk* entsprechend für die Nutzung der Glossare.
In der **latexmkrc** wird außerdem konfiguriert, dass sämtliche Dateien, welche während dem Kompilierungsprozess entstehen in dem Unterordner **build** erstellt werden. Die Ausgabe der Kompilierung inkl. des PDF werden in dem Unterordner **PDF** erstellt. Zum Bereinigen der Komplilierungsdateien kann **latexmk -c** genutzt werden. Soll gleichzeitig auch die Ausgabe bereinigt werden wird **latexmk -C** (großes "C") genutzt.
In der *latexmkrc* wird außerdem konfiguriert, dass sämtliche Dateien, welche während dem Kompilierungsprozess entstehen in dem Unterordner *build* erstellt werden. Die Ausgabe der Kompilierung inkl. des PDF werden in dem Unterordner *PDF* erstellt. Zum Bereinigen der Komplilierungsdateien kann *latexmk -c* genutzt werden. Soll gleichzeitig auch die Ausgabe bereinigt werden wird *latexmk -C* (großes "C") genutzt.
Persönlich empfehle ich den Code Editor [Visual Studio Code](https://code.visualstudio.com/) (nicht zuverwechseln mit Visual Studio). Dieser ist Open Source und für alle gängigen Betriebssysteme zu erhalten. Zusammen mit der Erweiterung [LaTeX Workshop](https://marketplace.visualstudio.com/items?itemName=James-Yu.latex-workshop) erhält man eine sehr gute Umgebung zum Schreiben und Kompilieren von LaTeX Code. LaTeX Workshop nutzt ebenfalls das latexmk Skript. Allerdings wird dieses nicht mit der **latexmkrc* Datei konfiguriert, sondern in den Einstellungen von VS Code. Im Folgenden die benötigten Einstellungen für die **settings.json** von VS Code:
Persönlich empfehle ich den Code Editor [Visual Studio Code](https://code.visualstudio.com/) (nicht zuverwechseln mit Visual Studio). Dieser ist Open Source und für alle gängigen Betriebssysteme zu erhalten. Zusammen mit der Erweiterung [LaTeX Workshop](https://marketplace.visualstudio.com/items?itemName=James-Yu.latex-workshop) erhält man eine sehr gute Umgebung zum Schreiben und Kompilieren von LaTeX Code. LaTeX Workshop nutzt ebenfalls das latexmk Skript. Allerdings wird dieses nicht mit der *latexmkrc* Datei konfiguriert, sondern in den Einstellungen von VS Code. Im Folgenden die benötigten Einstellungen für die *settings.json* von VS Code:
```json
}
"latex-workshop.latex.recipes": [
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment