From 3aa238920ab2b4f7bf8645eeb19bcee22186ba8b Mon Sep 17 00:00:00 2001
From: rschoene <rene.schoene@tu-dresden.de>
Date: Wed, 7 Dec 2022 12:28:43 +0100
Subject: [PATCH] align with german template

- remove German parts
- add example for a table
---
 .gitlab-ci.yml            |  37 ++------------
 Makefile                  |   9 ++--
 README.md                 |   8 +--
 sections/appendix.tex     | 102 +-------------------------------------
 sections/figures.tex      |  26 +++++++++-
 sections/install.tex      |   3 +-
 sections/introduction.tex |   4 +-
 7 files changed, 40 insertions(+), 149 deletions(-)

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index a6d9aad..dd05a8d 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -1,43 +1,14 @@
 image: texlive/texlive
 
-variables:
-  FILENAME: thesis
-  FILEDIR: .
-  DIFFCMD: bash git-latexdiff --exclude-textcmd="section,subsection" -b --main $FILENAME.tex --latexmk
-
 stages:
   - build
-  - diff
 
 build:
   stage: build
-  tags:
-    - dockered
-  artifacts:
-    paths:
-      - $FILEDIR/$FILENAME.pdf
-      - $FILEDIR/build_$FILENAME.log
-  script:
-    - cd "$FILEDIR"
-    - latexmk -pdf "$FILENAME.tex" 2>&1 | tee build_"$FILENAME".log
-    - 'grep -v "LaTeX Warning: There were undefined references." build_"$FILENAME".log'
-
-diff:
-  stage: diff
-  tags:
-    - dockered
   artifacts:
+    when: always
     paths:
-      - $FILEDIR/difftag_$FILENAME.pdf
-      - $FILEDIR/diffcommit_$FILENAME.pdf
+      - thesis.pdf
+      - thesis.log
   script:
-    - cd "$FILEDIR"
-    - LAST_TAG=$(git describe --abbrev=0 --tags HEAD~1)
-    - wget https://gitlab.com/git-latexdiff/git-latexdiff/raw/ef53cddc761ce2d278ba5016d17828cf63e30af5/git-latexdiff
-    - if [ "$LAST_TAG" ] ; then
-    -   $DIFFCMD -o "difftag_$FILENAME.pdf" "$LAST_TAG"
-    - fi
-    - if [ "$CI_BEFORE_SHA" ] ; then
-    -   $DIFFCMD -o "diffcommit_$FILENAME.pdf" "$CI_BEFORE_SHA"
-    - fi
-  allow_failure: true
+    - make
diff --git a/Makefile b/Makefile
index ff3b8ca..26ad736 100644
--- a/Makefile
+++ b/Makefile
@@ -1,6 +1,7 @@
-target:
-	latexmk thesis.tex
+.PHONY: all
+all:
+	latexmk thesis
 
+.PHONY: clean
 clean:
-	latexmk -C thesis.tex
-	rm -f *.bbl *.tdo *.bpn *.run.xml
+	latexmk -C
diff --git a/README.md b/README.md
index 4dd851c..4745cb5 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1 @@
-[Latest PDF online](/../-/jobs/artifacts/main/file/thesis.pdf?job=build) ([Build Log](/../-/jobs/artifacts/main/file/build_thesis.log?job=build))
-
-Diff to [last tag](/../-/jobs/artifacts/main/file/difftag_thesis.pdf?job=diff) | [last commit](/../-/jobs/artifacts/main/file/diffcommit_thesis.pdf?job=diff)
-
-Helpful documents
-* [(German) manual for the TU LaTeX template](http://mirrors.ctan.org/macros/latex/contrib/tudscr/doc/tudscr.pdf)
-* [Ein Anwenderleitfaden für das Erstellen einer wissenschaftlichen Abhandlung](http://mirrors.ctan.org/macros/latex/contrib/tudscr/doc/tutorials/treatise.pdf)
+[Latest PDF online](/../-/jobs/artifacts/main/file/thesis.pdf?job=build) ([Build Log](/../-/jobs/artifacts/main/file/thesis.log?job=build))
diff --git a/sections/appendix.tex b/sections/appendix.tex
index 13a85dd..8b71ebe 100644
--- a/sections/appendix.tex
+++ b/sections/appendix.tex
@@ -1,101 +1,3 @@
-\chapter{Weitere Latex-Dokumentation}
+\chapter{Appendix}
 
-\emph{Unfortunately, this is only available in German.}
-
-Nachdem nun der Vorspann und~-- bis auf das Literaturverzeichnis am
-Ende des Dokumentes auf Seite~\pageref{sec:bibliography}~-- alle
-Verzeichnisse erfolgreich ausgegeben wurden, wird nun die Verwendung
-der weiteren Umgebungen und Befehle demonstriert, welche im Tutorial
-\texturn{treatise.pdf} vorgestellt wurden.
-
-\section{Referenzen und das Literaturverzeichnis}
-Das Literaturverzeichnis wird auf Basis der nachfolgend verwendeten
-Zitate erstellt und ist auf Seite~\pageref{sec:bibliography} zu finden.
-In diesem Textabschnitt werden die zwei bekannten \LaTeX-Bücher
-\cite{knuth84} und \cite{goossens94} sowie das Anwenderhandbuch
-\cite{hanisch14} zitiert.p
-
-\section{Grafiken und Tabellen in Gleitumgebungen}
-Es folgt die Demonstration von Gleitumgebungen, welche sowohl für
-Grafiken als auch Tabellen verwendet werden sollten. Im vorliegenden
-Beispiel kann unter Umständen der Eindruck entstehen, dass diese Seite
-etwas zu überladen mit Gleitobjekten ist. Dies liegt nicht an der
-Verwendung der Gleitobjekte sondern vielmehr am zu geringen Textvolumen
-und den eingeschränkten Möglichkeiten von \LaTeX{}, diese an geeigneten
-Stellen zu platzieren.
-
-\subsection{Abbildungen als Gleitobjekte und das Einbinden von Grafiken}
-In \autoref{fig:example} wird dargestellt, wie eine Grafik im PDF"~Format
-in ein Dokument eingebunden und auf diese verwiesen werden kann. Ein
-Querverweis auf ein Gleitobjekt sollte im Fließtext am besten mit Befehl
-\texttt{\textbackslash autoref\{\emph{<Label>}\}} erstellt werden.
-Hierfür ist ein entsprechender Anker am zu referenzierenden Objekt nötig,
-welcher mit dem Makro \texttt{\textbackslash label} erzeugt wird. Dabei
-ist entscheidend, dass dieser Anker erst \emph{nach} der Beschriftung des
-Objektes, welche mit \texttt{\textbackslash caption} zu erstellen ist,
-definiert werden sollte.
-
-\begin{figure}
-\centering
-\includegraphics{TUD-black}
-\caption{Beispielgrafik}\label{fig:example}
-\end{figure}
-
-\subsection{Tabellen als Gleitobjekte}
-Tabellen sollten in der \texttt{table}"=Gleitumgebung gesetzt werden.
-Welche Umgebung für die Tabelle selbst dabei genutzt wird ist dabei
-nicht relevant. Es können sowohl die normale \texttt{tabular}"=Umgebung
-als auch die Umgebungen \texttt{tabularx}, \texttt{tabulary} sowie
-\texttt{tabu} für variable Spaltenbreiten bei einer fest vorgegebenen
-Tabellenbreite oder jede andere Tabellenumgebung genutzt werden.
-Nachfolgend wird dies an mehreren Beispielen demonstriert.
-
-\subsubsection{Eine gleitende tabularx-Tabelle}
-Es wird eine Tabelle mithilfe der \texttt{tabularx}"=Umgebung erstellt.
-Zu sehen ist diese in \autoref{tab:tabularx}. Für diese werden zuvor
-neue Spaltentypen definiert.
-
-\newcolumntype{Y}{>{\hspace{0pt}}X}
-\newcolumntype{D}{>{\raggedright}Y}
-\newcolumntype{E}{>{\centering}Y}
-\newcolumntype{F}{>{\raggedleft}Y}
-
-\begin{table}
-\begin{tabularx}{\textwidth}{@{}DEFY@{}}
-\toprule
-\textbf{Linksbündig} & \textbf{Zentriert} &
-\textbf{Rechtsbündig} & \textbf{Blocksatz} \tabularnewline
-\midrule
-Ein linksbündiger Blindtext zur Demonstration einer S"~Spalte &
-Ein zentrierter Blindtext zur Demonstration einer T"~Spalte &
-Ein rechtsbündiger Blindtext zur Demonstration einer U"~Spalte &
-Ein längerer Blindtext im Blocksatz zur besseren Demonstration
-einer Y"~Spalte\tabularnewline
-\bottomrule
-\end{tabularx}
-\caption{Eine \texttt{tabularx}"=Tabelle}\label{tab:tabularx}
-\end{table}
-
-\section{Zitate}
-Bei der Verwendung von wörtlichen Zitaten sollten diese als solche
-gekennzeichnet werden.
-\enquote{Dies ist ein zugegebenermaßen nicht sehr sinnvolles Zitat.}
-\cite[58]{hanisch14}
-Für eine möglichst gut nachvollziehbare Referenz sollte nicht nur
-das Werk selber sondern zumindest die Seitenzahl und gegebenenfalls
-der Absatz der originalen Textstelle angegeben werden.
-\begin{quoting}
-\enquote{%
-  Dies ist ein noch sinnloseres Zitat. Allerdings wird zumindest die
-  Wirkung der Umgebung \texttt{quoting} bei der Absatzauszeichnung
-  deutlich.
-
-  Wie zu sehen ist, wird der zweite Absatz~-- wie jeder weitere~--
-  aufgrund der Option \texttt{parskip=false} eingezogen.
-}
-\cite[sinngemäß nach][\pno{} 12, zweiter Absatz]{hanisch14}
-\end{quoting}
-Ebenfalls sollten sinngemäße Zitate mit einer möglichst genauen Referenz
-angegeben werden. Dies kann im Laufe der Arbeit auch für einen selbst von
-Vorteil sein, wenn beispielsweise die originale Textpassage noch einmal
-analysiert werden soll.
+Here, you can put long listings or informative figures not important to understand the main thesis.
diff --git a/sections/figures.tex b/sections/figures.tex
index e9cfab6..2c510c3 100644
--- a/sections/figures.tex
+++ b/sections/figures.tex
@@ -1,4 +1,4 @@
-\section{Figures, Zitate, Mathe}
+\section{Figures, Citations, Math}
 \begin{figure}[h]
 \centering
 \includegraphics[scale=0.8]{OMG_MOF_4levels}
@@ -19,3 +19,27 @@ $A = \{x | x \in Y\}$
 \end{defs}
 
 Petrinets are defined in~\Cref{def:abc}. See at the head of this document how to create your own definitions/lemma environments.
+
+\section{Tables}
+
+\begin{table}[b]
+\centering
+\caption{Example of a table}
+\label{tab:example}
+\begin{tabular}{llrrr}
+\toprule
+\textbf{type} &
+  \textbf{entity} &
+  \textbf{A} &
+  \textbf{B} &
+  \textbf{C} \\ \midrule
+T1 & e1                   & 27  & 0  & 27  \\
+T2 & e2                   & 0   & 18 & 88  \\
+T2 & e3                   & 1   & 27 & 1   \\ \midrule
+\multicolumn{2}{r}{Total} & 28  & 45 & 116 \\ \bottomrule
+\end{tabular}
+\end{table}
+
+The table in \cref{tab:example} shows a simple table using the booktabs syntax.
+Remember to never use vertical lines and nor use double lines.
+As a start, \url{https://www.tablesgenerator.com/} or other tools can be used.
diff --git a/sections/install.tex b/sections/install.tex
index 3b4f83a..a6cc851 100644
--- a/sections/install.tex
+++ b/sections/install.tex
@@ -5,5 +5,4 @@
 
 \textbf{GUI-Editor} texstudio
 
-Konfiguration vom Editor: Preferences > Build
-* default compiler: \emph{latexmk}
+Configuration of the editor: Go to Preferences, then in Build set \emph{latexmk} as default compiler.
diff --git a/sections/introduction.tex b/sections/introduction.tex
index c70558e..069aa46 100644
--- a/sections/introduction.tex
+++ b/sections/introduction.tex
@@ -1,6 +1,6 @@
 \chapter{Introduction}
 \label{ch:introduction}
 
-Show the agenda of the thesis
+Show the agenda of the thesis \dots
 
-In~\cref{ch:conclusion} the thesis will be concluded.
+How to use references to other chapters: In~\cref{ch:conclusion} the thesis will be concluded.
-- 
GitLab