Skip to content

02 Benutzung

Jump to bottom
Rene Hampölz edited this page Sep 19, 2023 · 64 revisions

Eine ausführliche Dokumentation finden Sie im originalen hampoelz/LaTeX-Template Repository.

Inhaltsverzeichnis

Grundlagen

Um die Dokumentation dieser Vorlage zu verstehen und die bereitgestellten Funktionen nutzen zu können, sind keine Grundkenntnisse erforderlich. Allerdings ist die Vorlage im Grunde nur eine Sammlung von Werkzeugen und Konfigurationen. Daher sind Grundkenntnisse in LaTeX immer noch notwendig, um das gewünschte Ergebnis zu erzielen. Kenntnisse über VS Code und die Versionskontrolle Git sind für die fortgeschrittene Nutzung der Vorlage ebenfalls empfehlenswert.

Um Ihnen den Einstieg in LaTeX zu erleichtern, finden Sie hier eine Sammlung von nützlichen Links:

Erweitern, um die Sammlung zu sehen

Projektordnerstruktur

Die Vorlage verwendet eine gängige Ordnerstruktur, um auch größere Dokumente übersichtlich zu halten. Es wird daher empfohlen, sich an diese Ordnerstruktur zu halten. Dies ist jedoch nicht unbedingt erforderlich.

LaTeX-Document/         
 +-- images/            # Ordner für Ihre Bilder, Grafiken, ...
 +-- out/               # Ordner für Temporär- und Protokolldateien
 |   +-- main.pdf       # Fertige PDF-Datei (wird auch im out Ordner gespeichert)
 +-- scripts/           
 +-- src/               # Ordner für zusätzliche tex-Dateien für modulare Dokumente
 +-- styles/            # Ordner für Stil- und Konfigurationsdateien
 |   +-- commands.sty   # Datei, in der vordefinierte Befehle und Umgebungen aktivieren/deaktivieren werden
 |   +-- custom.sty     # Stildatei für Ihre eigenen Stile, Befehle und Umgebungen
 |   +-- history.sty    # Stildatei für den Git-Verlauf
 |   +-- htbla.sty      # Datei für Vorkonfigurierte Befehle für die HTL-Weiz
 |   +-- main.sty       # Datei für Konfigurationen, Aktivierung/Deaktivierung vordefinierter Pakete
 +-- main.tex           # Hauptdatei zum Schreiben des Dokuments
 +-- references.bib     # Datei für Bibtex-Referenzen, wenn aktiviert

Öffnen des Dokuments

Um das Dokument zur Bearbeitung zu öffnen, müssen Sie den Ordner, der die Dokumentdateien enthält, über VS Code öffnen. Eine Möglichkeit wäre, VS Code zu starten und unter dem Menüpunkt Datei den Eintrag Ordner Öffnen auszuwählen.

Erstellen des Dokuments

Das LaTeX-Dokument wird normalerweise durch Aufrufen des Befehls Build LaTeX project aus der Befehlspalette (strg+shift+P) oder aus dem TeX Badge (strg+alt+X) erstellt. Um das Dokument direkt zu kompilieren, können Sie auch den Ausführen-Button in VS Code oder die Tastenkombination strg+alt+B verwenden.

Der Status des aktuellen Builds wird durch eines der folgenden Abzeichen in der VS Code Statusleiste angezeigt:

  • ✓: Das Dokument wurde erfolgreich erstellt
  • ↻ Build: Der Build wird ausgeführt
  • ✗: Der Build wurde mit einem Fehler beendet

Das aktuelle Build-Protokoll kann im Ausgabe-Tab (strg+shift+U) angezeigt werden, indem Sie Latex Compiler in der Dropdown-Liste auswählen. Alternativ wird das Protokoll auch in die Datei out/main.log geschrieben.

Wenn die erstellte PDF nicht aktualisiert wird, obwohl bei der Erstellung des Dokuments kein Fehler aufgetreten ist, überprüfen Sie, dass Ihre Dateinamen keine Umlaute enthalten, und führen Sie den Task clean aus (siehe Abschnitt Vorkonfigurierte Skripte/Tasks), um temporäre Dateien zu bereinigen.

Dokumentvorschau

Sie können die Vorschau Ihres Dokuments neben der Datei anzeigen, die Sie gerade bearbeiten. Sie können die Vorschau öffnen oder zwischen Ansichten wechseln, indem Sie den Befehl View LaTeX PDF aus der Befehlspalette (strg+shift+P) oder aus dem TeX Badge (strg+alt+X) aufrufen. Um direkt zu wechseln, können Sie auch den Vorschau-Button in VS Code oder das Tastenkürzel strg+alt+V im Editor verwenden.

Wenn Sie Ihr Dokument in einem separaten Fenster in der Vorschau anzeigen möchten, können Sie dies mit dem Browser tun, indem Sie den Befehl View LaTeX PDF file in web browser aufrufen.

Die Vorschau wird automatisch aktualisiert, sobald Sie Ihre .tex Datei speichern. (z.B. mit der Tastenkombination strg+S) Je nach Größe des Dokuments kann es einige Zeit dauern, bis Ihre Änderungen sichtbar werden, da das Dokument zunächst im Hintergrund kompiliert wird.

Im Vorschau-Viewer unterstützte Tastenkombinationen sind auf der folgenden Seite dokumentiert: https://github.com/mozilla/pdf.js/wiki/Frequently-Asked-Questions#faq-shortcuts

Wenn die Dokumentvorschau nicht aktualisiert wird, obwohl bei der Erstellung des Dokuments kein Fehler aufgetreten ist, überprüfen Sie, dass Ihre Dateinamen keine Umlaute enthalten, und führen Sie den Task clean aus (siehe Abschnitt Vorkonfigurierte Skripte/Tasks), um temporäre Dateien zu bereinigen.

Hovering- und Vorschaufunktionen

Sie können den Mauszeiger über einige LaTeX-Ausdrücke bewegen, um zusätzliche Informationen wie Paketdokumentation oder Zitatdetails anzuzeigen. Gleichungen und Referenzen können ebenfalls direkt in der Vorschau angezeigt werden.

Weitere Informationen zu Hover- und Vorschaufunktionen finden Sie unter: https://github.com/James-Yu/LaTeX-Workshop/wiki/Hover

Archivieren (zip) / Weitergeben des Dokument-Quellcodes

Für eine effektive Zusammenarbeit an einem Dokument wird empfohlen, das Versionskontrollsystem Git zusammen mit Plattformen wie GitHub zu verwenden. Wenn Git/GitHub jedoch keine Option ist, können Sie das Dokument als Archiv/Zip weitergeben.

Führen Sie dazu den Task archive aus (siehe Abschnitt Vorkonfigurierte Skripte/Tasks), um alle erforderlichen Dokumentdateien zu packen. Sie erhalten eine Zip-Archivdatei in Ihrem Hauptverzeichnis mit dem Namen LaTeXDocument.zip, welche Sie mit Ihren Mitarbeitern teilen können.

ℹ️ Information

Beachten Sie, dass die in Windows integrierte Zip-Funktion nicht alle erforderlichen Dateien packt, was zu beschädigten Dokumenten führen kann. Daher ist es ratsam, den in dieser Vorlage enthaltenen Archivierungs-Task zu verwenden.

Dokumentensprache ändern

Sie können die Sprache des Dokuments sowie die Sprache der Rechtschreibprüfung ändern:

Rechtschreibprüfungssprache: Ändern Sie in der Datei .vscode/settings.json die Eigenschaft cSpell.language in Ihren ISO 639-1-Sprachcode:

diff -u .vscode/settings.json
@@ -3,4 +3,4 @@
  3     "git.pullTags": false,
  4     "git.mergeEditor": true,
- 5     "cSpell.language": "en",
+ 5     "cSpell.language": "de",
  6     "latex-workshop.latex.outDir": "%DIR%/out",

Möglicherweise müssen Sie auch die zugehörige Spracherweiterung installieren. Führen Sie dazu Quick Open (strg+P) in VS Code aus, geben Sie den folgenden Befehl ein und ändern Sie ihn auf Ihre gewünscht Sprache ab: ext install streetsidesoftware.code-spell-checker-german


Dokumentsprache: Ändern Sie in der Datei styles/main.sty die Konfiguration \usepackage[english]{babel} auf Ihre Sprache:

diff -u styles/main.sty
@@ -26,7 +26,7 @@
  26 % ========================================
  27 %              Configurations             
  28 % ========================================
  29 
  30 % --------------- language ---------------
- 31 \usepackage[english]{babel}
+ 31 \usepackage[german]{babel}
  32

Verwenden Sie in mehrsprachigen Dokumenten einfach eine Liste der erforderlichen Sprachen. Zum Beispiel "cSpell.language": "en,de" und \usepackage[english,german]{babel}

Vorkonfigurierte Befehle und Umgebungen

Die Vorlage enthält einige vorkonfigurierte LaTeX-Befehle und -Umgebungen, um gängige Szenarien zu vereinfachen. Einige weniger häufige sind standardmäßig nicht aktiviert. Um diese zu aktivieren, müssen Sie diese in der Datei styles/commands.sty auskommentieren. Möglicherweise müssen Sie auch erforderliche Pakete auskommentieren, optional können Sie diese auch selbst hinzufügen. Verfügbare Befehle und Umgebungen sind zusammen mit der dazugehörigen Dokumentation unten aufgeführt:

Titel mit HTL-Weiz Logo

Fügen Sie den Titel mit dem HTL-Weiz Logo ein.

  • Standardmäßig aktiviert: Ja
  • Verwendete Pakete: keine
  • Verwendung: \htltitle{<Titel>}

HTL-Weiz Kopfzeile

Verwenden Sie eine Kopfzeile mit dem Logo der HTL Weiz, einem Titel und etwas Inhalt (z.B. einer Beschreibung).

  • Standardmäßig aktiviert: Ja
  • Verwendete Pakete: fancyhdr, calc
  • Verwendung: \usehtlheader{<Titel>}{<Inhalt>}

Benutzerdefinierte Textgröße

Ändern Sie die Textgröße.

  • Standardmäßig aktiviert: Ja
  • Verwendete Pakete: keine
  • Verwendung: \tsize<Größe>{<Text>}

Verfügbare Textgrößen: tiny, script, footnote, small, normal, large, Large, LARGE, huge, Huge

Daraus ergeben sich folgende Befehlskombinationen:

  • \tsizetiny{<Text>}
  • \tsizescript{<Text>}
  • \tsizefootnote{<Text>}
  • \tsizesmall{<Text>}
  • \tsizenormal{<Text>}
  • \tsizelarge{<Text>}
  • \tsizeLarge{<Text>}
  • \tsizeLARGE{<Text>}
  • \tsizehuge{<Text>}
  • \tsizeHuge{<Text>}

Unnumerierte Abschnitte

Erstellen Sie einen Abschnitt, der keine Nummerierung aufweist.

  • Standardmäßig aktiviert: Ja
  • Verwendete Pakete: keine
  • Verwendung: \unnumbered<section>{<Titel>}

Verfügbare Abschnitte: Part, Section, Subsection, Subsubsection, Paragraph, Subparagraph

Daraus ergeben sich folgende Befehlskombinationen:

  • \unnumberedPart{<Titel>}
  • \unnumberedSection{<Titel>}
  • \unnumberedSubsection{<Titel>}
  • \unnumberedSubsubsection{<Titel>}
  • \unnumberedParagraph{<Titel>}
  • \unnumberedSubparagraph{<Titel>}

Abschnitts Titelseite / Großer Abschnitt

Erstellen Sie einen neuen "großen" Abschnitt, in dem der Titel und die Kapitelnummer eine ganze Seite einnehmen. Optional können Sie den Abschnitt auch direkt beschriften, um später auf ihn zu verweisen.

  • Standardmäßig aktiviert: Ja
  • Verwendete Pakete: keine
  • Verwendung: \bigsection[<Abschnitts Label>]{<Abschnitts Titel>}

Zentrierter Titel mit Inhaltsverzeichnis

Fügen Sie einen Titel, sowie ein Inhaltsverzeichnis ein und zentrieren Sie beides vertikal auf der Seite mit einem leichten Versatz.

  • Standardmäßig aktiviert: Nein
  • Verwendete Pakete: keine
  • Verwendung: \maketitletoc

Dies ist für kleine Inhaltsverzeichnisse praktisch, da es das Aussehen verbessert. Bei Inhaltsverzeichnissen, die größer als eine Seite sind, kann dieser Befehl zu einem unerwünschten Aussehen führen.

Seitenumbruch im Inhaltsverzeichnis

Fügen Sie dem Inhaltsverzeichnis einen Seitenumbruch hinzu.

  • Standardmäßig aktiviert: Ja
  • Verwendete Pakete: keine
  • Verwendung: \tocbreak

Dieser Befehl wird wie ein section oder unnumberedSection-Befehl verwendet, jedoch wird dem Inhaltsverzeichnis anstatt eines neuen Abschnitts ein Seitenumbruch hinzugefügt.

Unterstreichen, Durchstreichen und Hervorheben von Text

Unterstreichen Sie Text, Durchstreichen Sie Text oder Hinterlegen Sie Text mit einer gelben Farbe.

  • Standardmäßig aktiviert: Ja
  • Verwendete Pakete: luacolor, lua-ul
  • Verwendung:
    • Unterstreichen: \ul{<Text>}
    • Durchstreichen: \st{<Text>}
    • Hervorheben: \hl{<Text>}

Spalten mit benutzerdefinierter Breite ausrichten

Fügen Sie rechtsbündige, zentrierte und linksbündige Tabellenspalten mit benutzerdefinierten Breiten hinzu.

  • Standardmäßig aktiviert: Ja
  • Verwendete Pakete: array
  • Verwendung: 
    \begin{tabular}{ L{<Breite>} C{<Breite>} R{<Breite>} }
  ...
\end{tabular}

Verfügbare Spaltentypen:

  • L{<Breite>} (linksbündige Spalte mit benutzerdefinierter Breite)
  • C{<Breite>} (mittig ausgerichtete Spalte mit benutzerdefinierter Breite)
  • R{<Breite>} (rechtsbündige Spalte mit benutzerdefinierter Breite)

Betitelte Umgebung

Rücken Sie den Inhalt der Umgebung um die Länge eines bestimmten Titels ein.

  • Standardmäßig aktiviert: Nein
  • Verwendete Pakete: enumitem
  • Verwendung: 
    \begin{titled}{<Titel>}
  ...
\end{titled}
  • Beispiel: 
    \begin{titled}{lorem ipsum: }
  Lorem ipsum\\
  Lorem ipsum\\
  ...
\end{titled}

Ausgabe des Beispiels:

lorem ipsum: Lorem ipsum  
             Lorem ipsum  
             ...

Box mit verbleibender Seitengröße

Erstellen Sie eine neue Box-Umgebung, in der Sie den Befehl \restspace verwenden können. Wobei \restspace durch den verbleibenden vertikalen Platz ersetzt wird, der auf der aktuellen Seite verfügbar ist.

  • Standardmäßig aktiviert: Nein
  • Verwendete Pakete: tcolorbox
  • Verwendung: 
    \begin{restofpage}[<Optionen>]
  ...
\end{restofpage}
  • Beispiel: 
    \begin{restofpage}[frame style, boxrule=0.5pt]
  \includegraphics[height=\restspace]{images/lorem_picsum.jpg}
\end{restofpage}

Graue Box

Erstellen Sie eine einfache graue Box mit Text für ein paar Anmerkungen.

  • Standardmäßig aktiviert: Nein
  • Verwendete Pakete: tcolorbox
  • Verwendung: \graybox{<Text>}

Meldungs-Boxen (Hinweis, Wichtig und Warnung)

Erstellen Sie eine einfache, auffällige Box mit Text für Hinweise, Warnungen oder wichtige Mitteilungen.

  • Standardmäßig aktiviert Ja
  • Verwendete Pakete: tcolorbox, fontawesome
  • Verwendung: 
    \begin{<Meldungs-Box>}[<Benutzerdefinierter Titel>]
  <Text>
\end{<Meldungs-Box>}
  • Beispiel: 
    \begin{note}
  Highlights information that users should take into account, even when skimming.
\end{note}

Verfügbare Meldungs-Boxen: note, important, warning:

image

Benutzerdefinierte Meldungs-Boxen können ebenfalls leicht erstellt werden. Zu diesem Zweck sind die Umgebungen alertbox und alerticonbox verfügbar:

alertbox Umgebung

Erstellen Sie eine einfache, auffällige Box mit einem Titel und Text für Mitteilungen.

  • Standardmäßig aktiviert: Ja
  • Verwendete Pakete: tcolorbox, fontawesome
  • Verwendung: 
    \begin{alertbox}{<Farbe>}{<Titel>}
  <Text>
\end{alertbox}
  • Beispiel: 
    \begin{alertbox}{teal}{Custom Alert Box}
  ...
\end{alertbox}

Ausgabe des Beispiels:

image

alerticonbox Umgebung

Erstellen Sie eine einfache, auffällige Box mit einem Symbol, einem Titel und einem Text für Mitteilungen.

  • Standardmäßig aktiviert: Ja
  • Verwendete Pakete: tcolorbox, fontawesome
  • Verwendung: 
    \begin{alerticonbox}{<Farbe>}{<Font-Awesome Symbol>}{<Titel>}
  <Text>
\end{alerticonbox}
  • Beispiel: 
    \begin{alerticonbox}{teal}{\faCheck}{Custom Alert Box}
  With an Icon
\end{alerticonbox}

Ausgabe des Beispiels:

image

Vorkonfigurierte Skripte/Tasks

Es gibt einige vorkonfigurierte Tasks in VS Code. Sie können Tasks über "Gehe zu Datei ..." (strg+P) ausführen, indem Sie task, Leerzeichen und den Befehlsnamen eingeben. Zum Beispiel task update template.

Die folgenden VS Code Tasks sind verfügbar:

  • clean: Entfernen Sie alle temporären Dateien
  • archive: Packen Sie alle relevanten Dokumentdateien in eine Zip-Archivdatei
  • update template: Ziehen Sie Vorlagenänderungen in Ihr Dokument
  • check template updates: Überprüfen Sie, ob die Vorlage neue Änderungen enthält
  • install requirements: Installieren und konfigurieren Sie alle erforderliche Software (nur Windows)

Empfohlene und vorkonfigurierte Pakete

Einige nützliche Pakete können in der Datei styles/main.sty im Abschnitt "Enable or disable packages" aktiviert werden. Um ein Paket zu aktivieren, kommentieren Sie die entsprechende Zeile aus. In manchen Fällen müssen mehrere Zeilen auskommentiert werden. Verwandte Zeilen sind mit | gekennzeichnet.

Literaturverwaltung

Um die Bibliographieverwaltung mit bibtex zu aktivieren, müssen Sie den Abschnitt "bibliography management" in der Datei styles/main.sty auskommentieren:

% ------- bibliography management --------
\usepackage[                            % ┝ easier and more flexible bibliography management
 backend=biber,                         % |
 style=iso-numeric,                     % | or iso-authoryear
]{biblatex}                             % |
\addbibresource{references.bib}         % |

Jetzt können Sie Ihre Quellen zur Datei references.bib hinzufügen. Die Datei enthält bereits Beispiele, wie man ein Buch oder einen Wikipedia-Artikel als Quelle hinzufügt. Um ein Beispiel auszukommentieren, fügen Sie ein @ am Anfang der Quelle ein.

Um Ihnen den Einstieg zu erleichtern, sind hier ein paar nützliche Bibtex-Befehle aufgelistet:

  • \cite{<cite_key>}: Fügen Sie einen Verweis auf die angegebene Quelle ein. Dabei ist <cite_key> der Name Ihrer Quelle, den Sie in der Datei references.bib angegeben haben.
  • \cite[<Seite>]{<cite_key>}: Fügen Sie einen Verweis auf die angegebene Quelle ein und verweisen Sie auf eine bestimmte Seite.
  • \printbibliography: Erstellen Sie ein Literaturverzeichnis der Quellen, auf die Sie sich beziehen.
  • \nocite{*}: Nehmen Sie beim Erstellen des Literaturverzeichnisses alle Einträge aus der Datenbank auf, unabhängig davon, ob sie referenziert sind oder nicht.

Nützliche Links:

Code mit Syntaxhervorhebung einfügen

Um die Code-Hervorhebung mit dem minted Paket zu aktivieren, müssen Sie den Abschnitt "source code formatting" in der Datei styles/main.sty auskommentieren:

% -------- source code formatting --------
\PassOptionsToPackage{outputdir=\auxDir}{minted}\usepackage{minted}

Jetzt können Sie mit der minted Umgebung einen Code mit Syntaxhervorhebung hinzufügen:

\begin{minted}{<Syntax>}
  ...
\end{minted}

Um beispielsweise Python-Quellcode hervorzuheben, können Sie die Umgebung wie folgt verwenden:

\begin{minted}{python}
  for x in "banana":
    print(x)
\end{minted}

Um Quellcode aus einer Datei zu importieren, können Sie \inputminted{<Syntax>}{<Datei>} verwenden.

ℹ️ Information

Das minted Paket verwendet das Pygments Python-Modul zur Syntaxhervorhebung. Daher muss Python auf Ihrem System installiert sein. Sie können es von der Python-Website herunterladen oder den Paketmanager Ihres Betriebssystems verwenden.

Manche Python-Distributionen enthalten Pygments nicht (siehe einige der Optionen unter "Alternative Implementations" auf der Python-Site). Daher müssen Sie Pygments möglicherweise manuell mit pip installieren: pip install Pygments.

Sie können überprüfen, ob Pygments auf Ihrem System installiert ist, indem Sie den Befehl pygmentize --help in einem Konsolenfenster ausführen.

Markdown einfügen

Um die Markdown-Unterstützung zu aktivieren, müssen Sie die Zeile "markdown support" des Abschnitts "markdown support" in der Datei styles/main.sty auskommentieren:

% ----------- markdown support -----------

    % ::::::: configuration ::::::::
    % \PassOptionsToPackage{smartEllipses}{markdown}                  % enable ellipses
    % \PassOptionsToPackage{hashEnumerators}{markdown}                % enable additional list declarations
    % \PassOptionsToPackage{pipeTables,tableCaptions}{markdown}       % enable tables
    % \PassOptionsToPackage{fencedCode}{markdown}                     % enable inline code-blocks
    % \PassOptionsToPackage{inlineFootnotes}{markdown}                % enable inline footnotes
    % \PassOptionsToPackage{hybrid}{markdown}                         % enable LaTeX in markdown
    %::::::::::::::::::::::::::::::

\usepackage{markdown}\def\markdownOptionOutputDir{\auxDir}          % markdown support

Die Markdown-Integration bietet einige Konfigurationsoptionen, um Unterstützung für Tabellen, Fußnoten und mehr hinzuzufügen. Je nach Anforderung können die Zeilen im Abschnitt "markdown support" unter "configuration" zur Konfiguration auskommentiert werden.

Jetzt können Sie Teile Ihres LaTeX-Dokuments mit der Markupsprache Markdown schreiben:

\begin{markdown}
  ...
\end{markdown}

Um externe Markdown-Dateien einzubinden, können Sie \markdownInput{<Datei>} verwenden.

Benutzerdefinierte Dokumentschriftart

Um eine benutzerdefinierte Schriftart für Ihr Dokument festzulegen, müssen Sie die folgenden Dateien der Schriftart zum Ordner fonts hinzufügen:

Erforderliche Schriftartendateien:

  • SchriftartName-Bold.ttf
  • SchriftartName-BoldItalic.ttf
  • SchriftartName-Italic.ttf
  • SchriftartName-Regular.ttf

Optionale Schriftartendateien (für Mono-Schrift):

  • SchriftartNameMono-Regular.ttf
  • SchriftartNameMono-Bold.ttf

Um die Schriftart auf das Dokument anzuwenden, müssen Sie die Konfiguration unter dem Abschnitt "document fonts" in der Datei styles/main.sty ändern. Setzen Sie dazu \setmainfont{} und optional \setmonofont{} auf Ihren SchriftartName.

Aktualisieren

Wenn neue Änderungen in das Vorlagen-Repository übertragen werden, können Sie Ihr Dokument mit dem integrierten Aktualisierungsskript aktualisieren, um die Änderungen einfach auf Ihr Dokument anzuwenden.

Das Öffnen eines Dokuments mit VS Code öffnet ein neues Konsolenfenster, welches automatisch den check template updates Task ausführt und Sie über neue Updates benachrichtigt.

Abschließend muss zum Aktualisieren der Task update template ausgeführt werden (z.B. über "Gehe zu Datei ..." (strg+P), indem Sie task update template eingeben). Sie können nun zwischen den beiden Optionen run or continue und abort wählen:

  • run or continue: Starten Sie den Update-Vorgang oder fahren Sie fort, nachdem das Update zu Konflikten geführt hat.
  • abort: Brechen Sie den Aktualisierungsvorgang ab und stellen Sie den Zustand vor der Aktualisierung wieder her. Kann nur ausgeführt werden, nachdem das Update zu Konflikten geführt hat.

Aktualisierungskonflikte

Wenn es Konflikte gibt, die nicht automatisch gelöst werden können, fordert das Aktualisierungsskript dazu auf, die Konflikte manuell zu lösen.

Konflikte können über Git-Befehlszeilentools oder über den VS Code Zusammenführungseditor (Merge-Editor) gelöst werden.

In Konflikt stehende Dateien werden in der Versionskontrollansicht (strg+shift+G G) unter dem Abschnitt "Merge Changes" bzw. "Änderungen zusammenführen" aufgelistet. Ein Klick auf einen Eintrag öffnet den Merge-Editor. Nachdem die Konflikte gelöst wurden, kann die Zusammenführung im Editor mit dem "Accept Merge"- bzw. "Zusammenführen abschließen"-Button akzeptiert werden, oder die Änderungen werden in der Versionskontrollansicht gestaged.

Um das Update abzuschließen, muss der Task update template erneut mit der Option run or continue ausgeführt werden.

Nützliche Links:

Git Versionsverlauf

Die Vorlage enthält eine vorkonfigurierte Zeitleiste und eine Tabelle, die den Git-Änderungsverlauf des Projekts innerhalb des Dokuments visualisieren können.

Wenn Ihr Dokument in ein öffentlich zugängliches GitHub-Repository hochgeladen wird, werden die visualisierten Commits automatisch mit dem GitHub-Repo verknüpft und das Profilbild des Committers angezeigt.

Sie können die Zeitleiste oder die Tabelle mit den folgenden LaTeX-Befehlen einbinden:

  • Zeitleiste: \IncludeHistoryTimeline
  • Tabelle: \IncludeHistoryTable

Die Konfigurationen finden Sie in der Datei main.sty. Sie können den Titel der generierten Zeitleiste ändern, die maximale Anzahl der in der Historie anzuzeigenden Commits festlegen und die zu ignorierenden Commits angeben.

Beispiel für die Zeitachse und Tabelle des Git-Änderungsverlaufs:

timeline table

Um also einen neuen Eintrag in Ihrer Zeitleiste/Tabelle zu erstellen, müssen Sie einen Git-Commit erstellen.

Öffnen Sie dazu die Versionskontrollansicht (strg+shift+G G). Unter dem ersten Abschnitt "Changes" bzw. "Änderungen" finden Sie eine Liste der geänderten Dateien seit Ihrem letzten Commit. Wenn Sie auf eine Datei klicken, sehen Sie die Änderungen, die Sie an der Datei vorgenommen haben.

Bewegen Sie nun den Mauszeiger über eine geänderte Datei in der Liste und klicken Sie auf das +-Symbol, um sie zum Commit hinzuzufügen. (auch stagen genannt) Um alle geänderten Dateien hinzuzufügen (stagen), bewegen Sie den Mauszeiger über den Bereichs-Titel "Changes" bzw. "Änderungen" und klicken Sie auf das +-Symbol.

Wenn Sie die gewünschten Dateien/Änderungen gestaged haben, geben Sie einfach eine Nachricht mit einer Beschreibung der Änderungen in das obere Textfeld ein. Diese Nachricht wird zu Ihrer Zeitleiste/Tabelle hinzugefügt. Klicken Sie abschließend auf den "Commit"-Button, um den Commit abzuschließen.

Unter dem Abschnitt "Commits" finden Sie alle Commits des Dokuments mit zusätzlichen Informationen und Aktionen.

Nützliche Links:

GitHub Workflows

Informationen über die vorkonfigurierten GitHub Workflows finden Sie im originalen hampoelz/LaTeX-Template Repository unter wiki/03-Customize-template#github-workflows.

Clone this wiki locally