/dhge-latex

Inoffizelles LaTeX-Template für Projektarbeiten an der Dualen Hochschule Gera Eisenach

Primary LanguageTeX

DHGE-LaTeX Build Status

Inoffizielles LaTeX-Template für Projektarbeiten für Technik-Studiengänge an der Dualen Hochschule Gera Eisenach

Inhaltsverzeichnis

Installation

LaTeX Installation

Eine Installation von MikTeX über proTeXt wird empfohlen. Als Editor bieten sich beispielsweise Visual Studio Code in Kombination mit der latex-workshop Extension und TeXstudio an.

Bei einer bereits bestehenden Installation sollten die installierten Packages auf Updates überprüft werden. Andererseits kann es zu Problemen beim Bauen kommen.

Setup

  1. Das Repository downloaden, clonen, oder die Template Funktion nutzen, um ein eigenes Repository zu erstellen.
  2. Mit der Update-Datei (OS abhängig .bat/.sh) kann das Template aktualisiert werden

  • ACHTUNG die Update-Datei (entsprechend OS)

    • überschreibt die Dateien im build Ordner
      • eigene Anpassungen sollten über die Dateien im Root-Ordner geschehen
    • löscht die mit git in Zusammenhang stehenden Ordner und Dateien (.git, .gitignore, .gitkeep)

Das Projekt sollte sich nun bauen lassen.

Wir empfehlen den latexmk Befehl zum kompilieren des Projekts (erfordert eine Perl Installation).

Latex Tipps

Ein relativ simples LaTeX-Tutorial zum einfachen Einstieg in die Welt von TeX.

ist allerdings durch das Template nicht nötig, nachfolgendes sollte ausreichen

"Variablen"

Variablen gibt es in TeX an sich nicht wie in anderen Sprachen.

\def\<variablenName>{<variablenWert>}

Der \def Befehl definiert ein Command der letztendlich dem folgendem entspricht

\newcommand{\<variablenName>}{<variablenWert>}

Richtig werden diese "Variablen" dann durch \<variablenName>{} aufgerufen.

Es ist aber auch möglich sie einfach nur durch \<variablenName> aufzurufen.\

Hier ist zu beachten ist das nach der Variable das Leerzeichen fehlt wird, da dieses als Argument aufgenommen wird

Environment (Umgebung)

Ein Codeblock welcher bestimmte Anläufe vor und nach dem eigenen Code laufen lässt.

\begin{<environment>}
  <codeAndText>
\end{<environment>}

Common Environments

Zitate und Literaturverzeichnis

Zitat als Fußnote einfügen

Dafür wird der footcite Befehl genutzt. Dieser bietet folgende Syntax:

\footcite[Postnote]{literatur_id}

Beispiel:

\footcite[S. 42]{mapi}

Hochgestelltes Zitat einfügen

Alternativ kann nun auch der supercite Befehl verwendet werden:

\supercite[Postnote]{literatur_id}

Beispiel:

\supercite[S. 42]{mapi}

Bei jeder Änderung in literatur.bib müssen folgende Schritte durchgeführt werden:

  1. Das Projekt kompilieren (pdflatex.exe -synctex=1 -interaction=nonstopmode "template".tex)
  2. Biber ausführen (biber.exe "template")
  3. Das Projekt 2x kompilieren

Werden die oben genannten Schritte nicht durchgeführt, kommt es zu Darstellungsfehlern bei Zitaten und dem Literaturverzeichnis.

Tipps

Firma als Autor

Wird als "Autor" eine Firma verwendet, sollten doppelte {} in der literatur.bib verwendet werden. Das bewirkt Wunder.

Mehrere Autoren

Mehrere Autoren können mit and verknüpft werden. Beispielsweise: author={Felix Prillwitz and Oliver Kogel and 谭九鼎}

Indirektes Zitat

Wird \footcite oder \supercite mit beiden optionalen Parametern aufgerufen, so ist die Syntax wie folgt:

\footcite[Prenote][Postnote]{id}

Beispiel:

\supercite[Vgl.][]{Computerphile.2020}

Abbildungen

  • Abbildungen werden durch das Template in assets/img gefunden.
    • \includegraphics{<imgName>} entspricht \includegraphics{assets/img/<imgName>}
    • anpassbar durch \graphicspath {{<newImagePath>}}
      • <newImagePath> ist aus der sicht von build/ zu sehen
      • \graphicspath {{../assets/img/}}}

LaTeX Abbildungen

\begin{figure}[<options>]
  \caption{<captionName>}
  \includegraphics[<imgOptions>]{<imgName>}
  \label{<labelName>}
\end{figure}

Beispiel:

\begin{figure}[H]
  \centering
  \caption{testImgName}
  \includegraphics[scale=0.75]{imgName}
  \label{fig:anlagentest}
\end{figure}
  • [H] - entspricht dem fixieren an der Stelle im Text
  • [scale=0.75] - skaliert das Bild auf 75% der Originalgröße
  • fig:anlagentest - fig: oder tab: ist ein typischer Anfang von Referenzen für entsprechend figure oder table Umgebung

dhge-latex Abbildungen

\dhgefigure[1]{2}{3}{4}{5}[6][7]

kann mit bis zu sechs Argumenten aufgerufen werden:

  1. Optional Float Position, standardmäßig h
  2. Relativer bild-path mit oder ohne Dateiendung (relativ zum ./assets/img Ordner, kann in template.tex angepasst werden)
  3. \includegraphics Optionen (leer lassen für Standard)
  4. Bildunterschrift
  5. Label für die Figure/Grafik
  6. Optional: ID
  7. Optional: "Postnote", beispielsweise um Seitenzahlen anzugeben

Beispiel:

\dhgefigure[h]{mapi_outgoing_illustration}{scale=0.75}{Absenden einer MAPI Nachricht}{fig:mapi}[mapi][S. 17ff]

Wir empfehlen den Befehl als Snippet im Text-Editor zu hinterlegen. In Visual Studio Code kann ein Snippet folgendermaßen konfiguriert werden:

  1. CTRL+Shift+P
  2. Preferences: Configure User Snippets
  3. bereits existierenden latex Snippet File auswählen oder New Global Snippets File...
  4. Snippet einfügen:
"DHGE Figure": {
  "prefix": "dhgefigure",
  "body": "\\dhgefigure[H]{${1:filename}}{scale=${6:1.0}}{${2:Caption}}{fig:${3:label}}[${4:biblatex_id}][${5:Postnote}]",
  "description": "Insert \\dhgefigure"
}

Abkürzungen

\DeclareAcronym{1}{
  short = {2},
  long = {3}
  }
  1. ID der Abkürzung, damit wird im Fließtext später referenziert.
  2. Die Abkürzung selbst
  3. Der ausgeschriebene Begriff

Beispielweise:

\DeclareAcronym{dhge}{
	short = {DHGE},
	long = {Duale Hochschule Gera-Eisenach}
}

Im Fließtext wird dann mit

\ac{dhge}

die Abkürzung aufgerufen. Dies sind die Angaben, die mindestens benötigt werden. Es gibt weitere Einstellungsmöglichkeiten bei dem Deklarieren von Abkürzungen, die in der unten stehenden Dokumentation nachgelesen werden können. Eine sinnvolle Auswahl davon:

\DeclareAcronym{1}{
  short = {2},
  long = {3},
  short-plural = {4},
  long-plural = {5},
  alt = {8}
  }

ODER

\DeclareAcronym{1}{
  short = {2},
  long = {3},
  short-plural-form = {6},
  long-plural-form = {7},
  alt = {8}
  }
  1. ID der Abkürzung, damit wird im Fließtext später referenziert.
  2. Die Abkürzung selbst
  3. Der ausgeschriebene Begriff
  4. Buchstabe oder Silbe, die der Abkürzung im Plural angehangen wird
  5. Buchstabe oder Silbe, die dem ausgeschriebenen Wort im Plural angehangen wird
  6. Plural-Form der Abkürzung, ersetzt die Abkürzung komplett
  7. Plural-Form des Wortes, ersetzt das Wort komplett
  8. Alternative zum ausgeschriebenen Wort

Die Angaben 4 bis 8 sind optional.

Die Pluralform lässt sich mit

\acp{1}

aufrufen, die Alternativform mit

\aca{1}

Beispiel:

\DeclareAcronym{jpg}{
  short = {JPEG},
  long = {Joint Photographic Experts Group},
  short-plural-form = {JPEGs},
  long-plural-form = {Joint Photographic Experts Groups},
  alt = {JPG}
  }

ODER

\DeclareAcronym{jpg}{
  short = {JPEG},
  long = {Joint Photographic Experts Group},
  short-plural = {s},
  long-plural = {s},
  alt = {JPG}
  }

Aufruf:

\ac{jpg} % Normale Form
\acp{jpg} % Plural-Form
\aca{jpg} % Alternativ-Form

Das Abkürzungsverzeichnis wird dann automatisch erstellt. Dabei ist zu beachten, dass unter Umständen bis zu vier Kompilierungen notwendig sind, wenn eine Abkürzung hinzugefügt oder entfernt wurde, damit das Verzeichnis korrekt erstellt wird.

Für mehr Informationen kann die Acro Package Documentation gelesen werden

Anlagenverzeichnis

wird automatisch generiert

Verwendung

  • Anlagen werden in der anlagen.tex hinterlegt.
    • hierbei ist zu beachten:
      • die Anlage muss sich in einer Umgebung vom Typ figure oder table befinden
      • die Anlage benötigt eine Beschriftung \caption{}
    • ein Label ist nicht nötig für eine automatische Verknüpfung im Anlagenverzeichnis
    • der vorgefertigte Befehl \dhgefigure, kann verwendet werden, da dieser beide Anforderungen erfüllt
    • siehe Beispiel build/tests/anlagen.tex

Beispiel:

\begin{table}
    \caption{TestBeschriftung}
    \begin{tabular}{c | c}
        1 & 1 \\
    \end{tabular}
\end{table}

Code einfügen mit Minted

Hier eine kurze Anleitung für das Minted Package. Damit lässt sich Code mit Syntaxhervorhebung direkt in LaTeX einfügen.

  1. Python installieren
  2. Sicherstellen, dass die Python Umbebungsvariable gesetzt ist
  3. Pygments installieren (pip install Pygments)
  4. \usepackage {minted} in build/package.config.tex hinzufügen
  5. --shell-escape flag im Compiler-Aufruf setzen
  6. Minted Kurz-Anleitung oder Minted Documentation lesen

Bei Proxy-Problemen mit pip, kann auch das Pygments.whl file runtergeladen und dann mit pip installiert werden. Pygments Download

Spezielle Abschnitte

SubSubSubSection

Falls man einen Abschnitt 4. Stufe schreiben möchte, kann das mit

\dhgeparagraph{}

umgesetzt werden.

Beispiel:

\dhgeparagraph{This is a SubSubSubSection}

Unicode Alphabete

Falls chinesische, japanische o.ä. Alphabete verwendet werden müssen (bsp. bedingt durch Autoren), ist die einfachste Methode das CJKutf8 Package zu laden.

Eine Anleitung finden Sie in diesem Artikel.