Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
latextemplates
GitHub Repository: latextemplates/scientific-thesis-template
Path: blob/main/main-german.tex
482 views
1
% !TeX spellcheck = de-DE
2
% LTeX: language=de-DE
3
% !TeX encoding = utf8
4
% !TeX program = lualatex
5
% !TeX TXS-program:compile = txs:///lualatex/[--shell-escape]
6
% !BIB program = biber
7
% -*- coding:utf-8 mod:LaTeX -*-
8
9
% The following package allows \\ at the title page
10
% For more information see https://github.com/latextemplates/scientific-thesis-cover/issues/4
11
\RequirePackage{kvoptions-patch}
12
\documentclass[
13
% fontsize=11pt is the standard
14
% ()Aus scrguide.pdf - der Dokumentation von KOMA-Script)
15
% Nach DUDEN steht in Gliederungen, in denen ausschließlich arabische Ziffern für die Nummerierung
16
% verwendet werden, am Ende der Gliederungsnummern kein abschließender Punkt
17
% (siehe [DUD96, R3]). Wird hingegen innerhalb der Gliederung auch mit römischen Zahlen
18
% oder Groß- oder Kleinbuchstaben gearbeitet, so steht am Ende aller Gliederungsnummern ein
19
% abschließender Punkt (siehe [DUD96, R4])
20
numbers=autoendperiod,
21
ngerman, % Neue deutsche Rechtschreibung; der Parameter wird an andere Pakete weiter gegeben
22
a4paper, % KOMAScript allows for both paper=a4 and (standard) a4paper - https://tex.stackexchange.com/a/61044/9075
23
twoside, % We are optimizing for both screen and two-side printing. So the page numbers will jump, but the content is configured to stay in the middle (by using the geometry package)
24
bibliography=totoc,
25
% idxtotoc, % Index ins Inhaltsverzeichnis
26
% liststotoc, % List of * ins Inhaltsverzeichnis, mit liststotocnumbered werden die Abbildungsverzeichnisse nummeriert
27
headsepline,
28
cleardoublepage=empty,
29
parskip=half,
30
% draft % um zu sehen, wo noch nachgebessert werden muss - wichtig, da Bindungskorrektur mit drin
31
draft=false
32
]{scrbook}
33
\usepackage{scrlayer-scrpage}
34
35
\usepackage{iftex}
36
37
\usepackage{ifplatform}
38
39
% backticks (`) werden als solches in verbatim-Umgebungen dargestellt
40
% Details unter:
41
% - https://tex.stackexchange.com/a/341057/9075
42
% - https://tex.stackexchange.com/a/47451/9075
43
% - https://tex.stackexchange.com/a/166791/9075
44
\usepackage{upquote}
45
46
% Setze Deutsch als Sprache
47
\usepackage[english,main=ngerman]{babel}
48
% Neue deutsche Trennmuster
49
\babelprovide[hyphenrules=ngerman-x-latest]{german}
50
%
51
% Hinweis von http://tex.stackexchange.com/a/321066/9075
52
% Ermögliche die Benutzung von "= als Trennstriche
53
\addto\extrasenglish{\languageshorthands{ngerman}\useshorthands{"}}
54
55
% Ein "abstract" ist eine "Kurzfassung", keine "Zusammenfassung"
56
\addto\captionsngerman{%
57
\renewcommand\abstractname{Kurzfassung}%
58
}
59
60
% Links verhalten sich so, wie sie sollen
61
% Zeilenumbrüche bei URLs auch bei Bindestrichen erlauben, auch wenn es verwirrend sein könnte: Gehört der Bindestrich zur URL oder ist es ein Trennstrich?
62
% Siehe https://tex.stackexchange.com/a/3034/9075.
63
\usepackage[hyphens]{url}
64
% \urlstyle{same}
65
%
66
% Hinweis von http://tex.stackexchange.com/a/10419/9075.
67
\makeatletter
68
\g@addto@macro{\UrlBreaks}{\UrlOrds}
69
\makeatother
70
71
%math stuff
72
\usepackage[
73
centertags, % (default) center tags vertically
74
% tbtags, % 'Top-or-bottom tags': For a split equation, place equation numbers level with the last (resp. first) line, if numbers are on the right (resp. left).
75
sumlimits, % (default) Place the subscripts and superscripts of summation symbols above and below
76
% nosumlimits, % Always place the subscripts and superscripts of summation-type symbols to the side, even in displayed equations.
77
intlimits, % Like sumlimits, but for integral symbols.
78
% nointlimits, % (default) Opposite of intlimits.
79
namelimits, % (default) Like sumlimits, but for certain 'operator names' such as det, inf, lim, max, min, that traditionally have subscripts placed underneath when they occur in a displayed equation.
80
% nonamelimits, % Opposite of namelimits.
81
% leqno, % Place equation numbers on the left.
82
% reqno, % Place equation numbers on the right.
83
fleqn, % Position equations at a fixed indent from the left margin rather than centered in the text column.
84
]{amsmath}
85
\SetMathAlphabet{\mathcal}{normal}{OMS}{amsa}{m}{n} %% AMS font for mathcal
86
87
%%% Doc: http://mirror.ctan.org/tex-archive/macros/latex/contrib/mh/doc/mathtools.pdf
88
% Erweitert amsmath und behebt einige Bugs
89
\usepackage[fixamsmath,disallowspaces]{mathtools}
90
91
%%% Doc: http://www.ctan.org/info?id=fixmath
92
% LaTeX's default style of typesetting mathematics does not comply
93
% with the International Standards ISO31-0:1992 to ISO31-13:1992
94
% which indicate that uppercase Greek letters always be typeset
95
% upright, as opposed to italic (even though they usually
96
% represent variables) and allow for typesetting of variables in a
97
% boldface italic style (even though the required fonts are
98
% available). This package ensures that uppercase Greek be typeset
99
% in italic style, that upright $\Delta$ and $\Omega$ symbols are
100
% available through the commands \upDelta and \upOmega; and
101
% provides a new math alphabet \mathbold for boldface
102
% italic letters, including Greek.
103
\usepackage{fixmath}
104
105
%for theorems, replacement for amsthm
106
\usepackage[amsmath,hyperref]{ntheorem}
107
\theorempreskipamount 2ex plus1ex minus0.5ex
108
\theorempostskipamount 2ex plus1ex minus0.5ex
109
\theoremstyle{break}
110
\newtheorem{definition}{Definition}[chapter]
111
112
%%% Doc: http://mirror.ctan.org/tex-archive/macros/latex/contrib/onlyamsmath/onlyamsmath.dvi
113
% Warnt bei Benutzung von Befehlen die mit amsmath inkompatibel sind.
114
115
% Braucht man evtl. nicht.
116
% \usepackage[
117
% all,
118
% warning
119
% ]{onlyamsmath}
120
121
%% !!! If you change the font, be sure that words such as "workflow" can
122
%% !!! still be copied from the PDF. If this is not the case, you have
123
%% !!! to use glyphtounicode. See comment at cmap package.
124
%%
125
%% Background: "workflow" contains "fl" which is a ligature, which in turn
126
%% is rendered as one character in the PDF and needs to be split
127
%% whily copying.
128
129
\ifluatex
130
\usepackage[no-math]{fontspec}
131
\usepackage{unicode-math}
132
133
% See https://tug.org/FontCatalogue/texgyretermes/ for more information
134
\setmainfont{texgyretermes}[
135
Extension = .otf,
136
UprightFont = *-regular,
137
BoldFont = *-bold,
138
ItalicFont = *-italic,
139
BoldItalicFont = *-bolditalic,
140
Ligatures=TeX
141
]
142
% See https://tug.org/FontCatalogue/texgyreheros/ for more information
143
\setsansfont[Scale=.9]{TeX Gyre Heros Regular}
144
% shapely l, upright quotes
145
% Normal scaling is too large --> thus, we use ",Scale=.9"
146
\ifwindows
147
\setmonofont[StylisticSet={1,3},Scale=.9]{Inconsolata}
148
\else
149
\setmonofont[StylisticSet={1,3},Scale=.9]{Inconsolatazi4}
150
\fi
151
152
% Enable proper ligatures
153
% For more information see https://ctan.org/pkg/selnolig
154
% language "english" or "ngerman" is passed to selnolig by the document class
155
\usepackage{selnolig}
156
157
\else
158
\RequirePackage{newtxtext}
159
\RequirePackage{newtxmath}
160
\RequirePackage[zerostyle=b,scaled=.9]{newtxtt}
161
162
% Has to be loaded AFTER any font packages. See https://tex.stackexchange.com/a/2869/9075.
163
\usepackage[T1]{fontenc}
164
\fi
165
166
% DE: Noch mehr Symbole
167
%\usepackage{stmaryrd} %fuer \ovee, \owedge, \otimes
168
%\usepackage{marvosym} %fuer \Writinghand %patched to not redefine \Rightarrow
169
%\usepackage{mathrsfs} %mittels \mathscr{} schoenen geschwungenen Buchstaben erzeugen
170
%\usepackage{calrsfs} %\mathcal{} ein bisserl dickeren buchstaben erzeugen - sieht net so gut aus.
171
172
% EN: Fallback font - if the subsequent font packages do not define a font (e.g., monospaced)
173
% This is the modern package for "Computer Modern".
174
% In case this gets activated, one has to switch from cmap package to glyphtounicode (in the case of pdflatex)
175
% DE: Fallback-Schriftart
176
%\usepackage[%
177
% rm={oldstyle=false,proportional=true},%
178
% sf={oldstyle=false,proportional=true},%
179
% tt={oldstyle=false,proportional=true,variable=true},%
180
% qt=false%
181
%]{cfr-lm}
182
183
% EN: Headings are typeset in Helvetica (which is similar to Arial)
184
% DE: Schriftart fuer die Ueberschriften - ueberschreibt lmodern
185
%\usepackage[scaled=.95]{helvet}
186
187
% DE: Für Schreibschrift würde tun, muss aber nicht
188
%\usepackage{mathrsfs} % \mathscr{ABC}
189
190
% EN: Font for the main text
191
% DE: Schriftart fuer den Fliesstext - ueberschreibt lmodern
192
% Linux Libertine, siehe http://www.linuxlibertine.org/
193
% Packageparamter [osf] = Minuskel-Ziffern
194
% rm = libertine im Brottext, Linux Biolinum NICHT als serifenlose Schrift, sondern helvet (von oben) beibehalten
195
%\usepackage[rm]{libertine}
196
197
% EN: Alternative Font: Palantino. It is recommeded by Prof. Ludewig for German texts
198
% DE: Alternative Schriftart: Palantino, Packageparamter [osf] = Minuskel-Ziffern
199
% Bitte nur in deutschen Texten
200
%\usepackage{mathpazo} %ftp://ftp.dante.de/tex-archive/fonts/mathpazo/ - Tipp aus DE-TEX-FAQ 8.2.1
201
% EN: The euro sign
202
% DE: Das Euro Zeichen
203
% Fuer Palatino (mathpazo.sty): richtiges Euro-Zeichen
204
% Alternative: \usepackage{eurosym}
205
% \newcommand{\EUR}{\ppleuro}
206
207
% DE: Schriftart fuer Programmcode - ueberschreibt lmodern
208
% Falls auskommentiert, wird die Standardschriftart lmodern genommen
209
% Fuer schreibmaschinenartige Schluesselwoerter in den Listings - geht bei alten Installationen nicht, da einige Fontshapes (<>=) fehlen
210
%\usepackage[scaled=.92]{luximono}
211
%\usepackage{courier}
212
% DE: BeraMono als Typewriter-Schrift, Tipp von http://tex.stackexchange.com/a/71346/9075
213
%\usepackage[scaled=0.83]{beramono}
214
215
\usepackage{setspace}
216
% Alternative package: https://ctan.org/pkg/leading
217
218
% Symbole Check und Cross
219
\usepackage{pifont}
220
\newcommand{\dingcheck}{\ding{51}}
221
\newcommand{\dingcross}{\ding{55}}
222
%for scaling see http://tex.stackexchange.com/a/130236/9075
223
224
% DE: Noch mehr Symbole
225
%\usepackage{stmaryrd} %fuer \ovee, \owedge, \otimes
226
%\usepackage{marvosym} %fuer \Writinghand %patched to not redefine \Rightarrow
227
%\usepackage{mathrsfs} %mittels \mathscr{} schoenen geschwungenen Buchstaben erzeugen
228
%\usepackage{calrsfs} %\mathcal{} ein bisserl dickeren buchstaben erzeugen - sieht net so gut aus.
229
230
\automark[section]{chapter}
231
\setkomafont{pageheadfoot}{\normalfont\sffamily}
232
\setkomafont{pagenumber}{\normalfont\sffamily}
233
234
\ihead[]{}
235
\chead[]{}
236
\ohead[]{\headmark}
237
\cfoot[]{}
238
\ofoot[\usekomafont{pagenumber}\thepage]{\usekomafont{pagenumber}\thepage}
239
\ifoot[]{}
240
241
% Optischer Randausgleich und Grauwertkorrektur. Siehe See http://www.ctan.org/tex-archive/macros/latex/contrib/microtype/
242
243
\usepackage[
244
babel=true,
245
expansion=alltext,
246
protrusion=alltext-nott,
247
final
248
]{microtype}
249
250
% \texttt{test -- test} - diese Einstellung behält "--" bei (und konveriert sie nicht zu einem Bindestrich)
251
\DisableLigatures{encoding = T1, family = tt* }
252
253
% tracking=true muss als Parameter des microtype-packages mitgegeben werden
254
% Deaktiviert, da dies bei Algorithmen seltsam aussieht
255
256
%\DeclareMicrotypeSet*[tracking]{my}{ font = */*/*/sc/* }%
257
258
% Hier wird festgelegt, dass alle Passagen in Kapitälchen automatisch leicht gesperrt werden.
259
% Quelle: http://homepage.ruhr-uni-bochum.de/Georg.Verweyen/pakete.html
260
% Deaktiviert, da sonst "BPEL", "BPMN" usw. wirklich komisch aussehen.
261
% Macht wohl nur bei geisteswissenschaftlichen Arbeiten Sinn.
262
%\SetTracking{ encoding = *, shape = sc }{ 45 }
263
264
\usepackage{graphicx}
265
266
% Base folder, so there is no need to repeat this over and over again.
267
\graphicspath{ {figures/} }
268
269
%%% Doc: http://mirror.ctan.org/tex-archive/macros/latex/contrib/pdfpages/pdfpages.pdf
270
\usepackage{pdfpages} % Include pages from external PDF documents in LaTeX documents
271
272
% Diagonal lines in a table - http://tex.stackexchange.com/questions/17745/diagonal-lines-in-table-cell
273
% Slashbox is not available in texlive (due to licensing) and also gives bad results. Thus, we use diagbox
274
\usepackage{diagbox}
275
276
\ifluatex
277
\usepackage{spelling}
278
\spellingoutput{off}
279
\fi
280
281
\usepackage[dvipsnames, table]{xcolor}
282
283
% Code Listings
284
\usepackage{listings}
285
286
\definecolor{eclipseStrings}{RGB}{42,0.0,255}
287
\definecolor{eclipseKeywords}{RGB}{127,0,85}
288
\colorlet{numb}{magenta!60!black}
289
290
% JSON definition
291
% Source: https://tex.stackexchange.com/a/433961/9075
292
293
\lstdefinelanguage{json}{
294
basicstyle=\normalfont\ttfamily,
295
commentstyle=\color{eclipseStrings}, % style of comment
296
stringstyle=\color{eclipseKeywords}, % style of strings
297
numbers=left,
298
numberstyle=\scriptsize,
299
stepnumber=1,
300
numbersep=8pt,
301
showstringspaces=false,
302
breaklines=true,
303
frame=lines,
304
% backgroundcolor=\color{gray}, %only if you like
305
string=[s]{"}{"},
306
comment=[l]{:\ "},
307
morecomment=[l]{:"},
308
literate=
309
*{0}{{{\color{numb}0}}}{1}
310
{1}{{{\color{numb}1}}}{1}
311
{2}{{{\color{numb}2}}}{1}
312
{3}{{{\color{numb}3}}}{1}
313
{4}{{{\color{numb}4}}}{1}
314
{5}{{{\color{numb}5}}}{1}
315
{6}{{{\color{numb}6}}}{1}
316
{7}{{{\color{numb}7}}}{1}
317
{8}{{{\color{numb}8}}}{1}
318
{9}{{{\color{numb}9}}}{1}
319
}
320
321
\lstset{
322
% everything between (* *) is a latex command
323
escapeinside={(*}{*)},
324
%
325
language=json,
326
%
327
showstringspaces=false,
328
%
329
basicstyle=\footnotesize\ttfamily,
330
%
331
commentstyle=\slshape,
332
%
333
% Default: \rmfamily, damit werden die Strings im Quellcode hervorgehoben. Zusaetzlich evtl.: \scshape oder \rmfamily durch \ttfamily ersetzen. Dann sieht's aus, wie bei fancyvrb
334
stringstyle=\ttfamily,
335
%
336
breaklines=true, % Zeilen werden umbrochen
337
%
338
breakatwhitespace=true,
339
%
340
% Alternative: fixed
341
columns=flexible,
342
%
343
tabsize=2, % Groesse von Tabs
344
%
345
numbers=left,
346
%
347
numberstyle=\tiny,
348
%
349
basewidth=.5em,
350
%
351
xleftmargin=.5cm,
352
%
353
% aboveskip=0mm,
354
%
355
% belowskip=0mm,
356
%
357
captionpos=b
358
}
359
360
\ifpdftex
361
% Ermögliche Umlaute falls \lstinputputlisting genutzt wird
362
% Siehe https://stackoverflow.com/a/29260603/873282 und https://tex.stackexchange.com/a/24532/9075 für Details.
363
% listingsutf8 hat im Juni 2020 nicht funktioniert.
364
\lstset{extendedchars=true, literate=
365
{á}{{\'a}}1 {é}{{\'e}}1 {í}{{\'i}}1 {ó}{{\'o}}1 {ú}{{\'u}}1
366
{Á}{{\'A}}1 {É}{{\'E}}1 {Í}{{\'I}}1 {Ó}{{\'O}}1 {Ú}{{\'U}}1
367
{à}{{\`a}}1 {è}{{\`e}}1 {ì}{{\`i}}1 {ò}{{\`o}}1 {ù}{{\`u}}1
368
{À}{{\`A}}1 {È}{{\'E}}1 {Ì}{{\`I}}1 {Ò}{{\`O}}1 {Ù}{{\`U}}1
369
{ä}{{\"a}}1 {ë}{{\"e}}1 {ï}{{\"i}}1 {ö}{{\"o}}1 {ü}{{\"u}}1
370
{Ä}{{\"A}}1 {Ë}{{\"E}}1 {Ï}{{\"I}}1 {Ö}{{\"O}}1 {Ü}{{\"U}}1
371
{â}{{\^a}}1 {ê}{{\^e}}1 {î}{{\^i}}1 {ô}{{\^o}}1 {û}{{\^u}}1
372
{Â}{{\^A}}1 {Ê}{{\^E}}1 {Î}{{\^I}}1 {Ô}{{\^O}}1 {Û}{{\^U}}1
373
{Ã}{{\~A}}1 {ã}{{\~a}}1 {Õ}{{\~O}}1 {õ}{{\~o}}1
374
{œ}{{\oe}}1 {Œ}{{\OE}}1 {æ}{{\ae}}1 {Æ}{{\AE}}1 {ß}{{\ss}}1
375
{ű}{{\H{u}}}1 {Ű}{{\H{U}}}1 {ő}{{\H{o}}}1 {Ő}{{\H{O}}}1
376
{ç}{{\c c}}1 {Ç}{{\c C}}1 {ø}{{\o}}1 {å}{{\r a}}1 {Å}{{\r A}}1
377
}
378
\fi
379
380
\lstloadlanguages{% Check dokumentation for further languages...
381
%[Visual]Basic
382
%Pascal
383
%C
384
%C++
385
%XML
386
%HTML
387
}
388
389
% For easy quotations: \enquote{text}
390
% This package is very smart when nesting is applied, otherwise textcmds (see below) provides a shorter command
391
\usepackage[autostyle=true]{csquotes}
392
393
% Enable using "`quote"' - see https://tex.stackexchange.com/a/150954/9075
394
\defineshorthand{"`}{\openautoquote}
395
\defineshorthand{"'}{\closeautoquote}
396
397
% bessere Abstaende innerhalb der Tabelle (Layout))
398
% -------------------------------------------------
399
% \toprule, \midrule, \bottomrule
400
% Doc: https://texdoc.org/serve/booktabs/0
401
\usepackage{booktabs}
402
403
% Extended enumerate, such as \begin{compactenum}
404
\usepackage{paralist}
405
\usepackage[
406
backend = biber, %biber does not work with 64x versions alternative: bibtex8; minalphanames only works with biber backend
407
sortcites = true,
408
bibstyle = alphabetic,
409
citestyle = alphabetic,
410
giveninits = true,
411
useprefix = false, %"von, van, etc." will be printed, too. See below.
412
minnames = 1,
413
minalphanames = 3,
414
maxalphanames = 4,
415
maxbibnames = 99,
416
maxcitenames = 2,
417
natbib = true,
418
eprint = true,
419
url = true,
420
doi = true, %source: http://tex.stackexchange.com/a/23118/9075
421
isbn = true, %source: http://tex.stackexchange.com/a/23118/9075
422
backref = true]{biblatex}
423
424
% enable more breaks at URLs. See https://tex.stackexchange.com/a/134281.
425
\setcounter{biburllcpenalty}{7000}
426
\setcounter{biburlucpenalty}{8000}
427
428
\bibliography{bibliography}
429
%\addbibresource[datatype=bibtex]{\bibliography{bibliography}}
430
431
% Do not put "vd" in the label, but put it at "\citeauthor"
432
% Source: http://tex.stackexchange.com/a/30277/9075
433
\makeatletter
434
\AtBeginDocument{\toggletrue{blx@useprefix}}
435
\AtBeginBibliography{\togglefalse{blx@useprefix}}
436
\makeatother
437
438
% Thin spaces between initials
439
% http://tex.stackexchange.com/a/11083/9075
440
\renewrobustcmd*{\bibinitdelim}{\,}
441
442
% Keep first and last name together in the bibliography
443
% http://tex.stackexchange.com/a/196192/9075
444
\renewcommand*\bibnamedelimc{\addnbspace}
445
\renewcommand*\bibnamedelimd{\addnbspace}
446
447
% Replace last "and" by comma in bibliography
448
% See http://tex.stackexchange.com/a/41532/9075
449
\AtBeginBibliography{%
450
\renewcommand*{\finalnamedelim}{\addcomma\space}%
451
}
452
453
% enable hyperlinked author names when using \citeauthor
454
% source: http://tex.stackexchange.com/a/75916/9075
455
\DeclareCiteCommand{\citeauthor}
456
{
457
\boolfalse{citetracker}%
458
\boolfalse{pagetracker}%
459
\usebibmacro{prenote}
460
}
461
{
462
\ifciteindex
463
{\indexnames{labelname}}
464
{}%
465
\printtext[bibhyperref]{\printnames{labelname}}
466
}
467
{\multicitedelim}
468
{\usebibmacro{postnote}}
469
470
% Farbige Tabellen
471
% ----------------
472
% Das Paket colortbl wird inzwischen automatisch durch xcolor geladen
473
%
474
% Erweiterte Funktionen innerhalb von Tabellen
475
% --------------------------------------------
476
%%% Doc: http://mirror.ctan.org/tex-archive/macros/latex/contrib/multirow/multirow.sty
477
\usepackage{multirow} % Mehrfachspalten
478
%
479
%%% Doc: Documentation inside dtx Package
480
\usepackage{dcolumn} % Ausrichtung an Komma oder Punkt
481
482
%%% Doc: http://mirror.ctan.org/tex-archive/macros/latex/contrib/supertabular/supertabular.pdf
483
%\usepackage{supertabular}
484
485
%%% Fussnoten/Endnoten ===================================================
486
487
%%% Doc: http://mirror.ctan.org/tex-archive/macros/latex/contrib/footmisc/footmisc.pdf
488
%
489
\usepackage[
490
bottom, % Footnotes appear always on bottom. This is necessary specially when floats are used
491
stable, % Make footnotes stable in section titles
492
% perpage, % Reset on each page
493
% para, % Place footnotes side by side of in one paragraph.
494
% side, % Place footnotes in the margin
495
ragged, % Use RaggedRight
496
% norule, % Suppress rule above footnotes
497
multiple, % Rearrange multiple footnotes intelligent in the text.
498
% symbol, % Use symbols instead of numbers
499
]{footmisc}
500
501
\counterwithout{footnote}{chapter} % Continuous numbering of footnotes across chapters
502
503
\interfootnotelinepenalty=10000 % Verhindert das Fortsetzen von Fussnoten auf der gegenüberligenden Seite
504
505
% EN: Put footnotes below floats
506
% DE: Fußnoten unter Gleitumgebungen ("floats") platzieren
507
% Source: https://tex.stackexchange.com/a/32993/9075
508
\usepackage{stfloats}
509
\fnbelowfloat
510
511
% EN: Extended support for footnotes
512
% DE: Fußnoten
513
%
514
%\usepackage{dblfnote} %Zweispaltige Fußnoten
515
%
516
% Keine hochgestellten Ziffern in der Fußnote (KOMA-Script-spezifisch):
517
%\deffootnote[1.5em]{0pt}{1em}{\makebox[1.5em][l]{\bfseries\thefootnotemark}}
518
%
519
% Abstand zwischen Fußnoten vergrößern:
520
%\setlength{\footnotesep}{.85\baselineskip}
521
%
522
% EN: Following command disables the separting line of the footnote
523
% DE: Folgendes Kommando deaktiviert die Trennlinie zur Fußnote
524
%\renewcommand{\footnoterule}{}
525
%
526
%\addtolength{\skip\footins}{\baselineskip} % Abstand Text <-> Fußnote
527
528
% DE: Fußnoten immer ganz unten auf einer \raggedbottom-Seite
529
% DE: fnpos kommt aus dem yafoot package
530
%\usepackage{fnpos}
531
%\makeFNbelow
532
%\makeFNbottom
533
534
% TODO (and comment) configuration
535
%
536
% - \todo (from todo, easy-todo, todonotes) / \TODO (from fixmetodonotes) - for "normal" TODOs
537
% - \todofix - "important" TODOs
538
%
539
% - \textcomment - highlights text and has a hover comment
540
% - \sidecomment - just puts a comment to the side. Note: \comment MUST NOT be used as command name, it is already defined by much packages (mathdesign, mindflow, verbatim, and others)
541
%
542
% - \missingfigure
543
%
544
% - \textmarker
545
% - \modified
546
% - \change - adresses a review comment
547
548
% Enable nice comments
549
\usepackage{pdfcomment}
550
551
\newcommand{\textcomment}[2]{\colorbox{yellow!60}{#1}\pdfcomment[color={0.234 0.867 0.211},hoffset=-6pt,voffset=10pt,opacity=0.5]{#2}}
552
553
% Small PDF comment
554
% 1. Parameter: Comment
555
\newcommand{\sidecomment}[1]{\pdfcomment[color={0.045 0.278 0.643},voffset=4pt,icon=Note]{#1}}
556
% Disabled variant - for the final PDF
557
%\newcommand{\sidecomment}[1]{}
558
559
\newcommand{\todo}[1]{TODO!\sidecomment{#1}}
560
561
% Änderungen
562
%
563
% 1. Parameter: Review-Kommentar
564
% 2. Parameter: Neuer Text
565
\newcommand{\change}[2]{{\color{red}#2}\pdfcomment[color={0.234 0.867 0.211},voffset=8pt,opacity=0.5]{#1}}
566
% Disabled variant - for the final PDF
567
%\newcommand{\change}[2]{#2}
568
569
% Define default commands
570
\makeatletter
571
\@ifundefined{missingfigure}{\newcommand{\missingfigure}{... missing figure ...}}{}
572
\@ifundefined{textcomment}{\newcommand{\textcomment}[2]{#1 \todo{#2}}}{}
573
\@ifundefined{sidecomment}{\newcommand{\sidecomment}[1]{\marginpar{#1}}}{}
574
\@ifundefined{todo}{\newcommand{\todo}[1]{\sidecomment{#1}}}{}
575
\@ifundefined{TODO}{\newcommand{\TODO}[1]{\todo{#1}}}{}
576
\@ifundefined{todofix}{\newcommand{\todofix}[1]{\todo{#1}}}{}
577
\@ifundefined{change}{\newcommand{\change}[2]{#1 $\rightarrow$ #2}}{}
578
\makeatother
579
580
% Textmarker (Textfarbe rot)
581
\newcommand{\textmarker}[1]{{\color{red} #1}\xspace}
582
583
% Modified (Text blau)
584
\newcommand{\modified}[1]{{\color{blue!60!black} #1}\xspace}
585
586
\usepackage[group-minimum-digits=4,per-mode=fraction]{siunitx}
587
\addto\extrasgerman{\sisetup{locale = DE}}
588
589
% See http://tex.stackexchange.com/a/83051/9075
590
% Normally, doesn't work with hyperref, but cleveref fixes that
591
\usepackage[ngerman]{varioref}
592
593
594
% Enable that parameters of \cref{}, \ref{}, \cite{}, ... are linked so that a reader can click on the number an jump to the target in the document
595
\usepackage{hyperref}
596
597
% Enable hyperref without colors and without bookmarks
598
\hypersetup{
599
hidelinks,
600
colorlinks=true, % Links erhalten Farben statt Kaeten
601
raiselinks=true, % calculate real height of the link
602
allcolors=black,
603
pdfstartview=Fit,
604
breaklinks=true, % Links ueberstehen Zeilenumbruch
605
hypertexnames=false, % Fix jumping to algorithm line - http://tex.stackexchange.com/a/156404/9075
606
}
607
608
% Enable correct jumping to figures when referencing
609
\usepackage[all]{hypcap}
610
611
% Hint by https://tex.stackexchange.com/a/193370/9075 to suppress strange outputs of the babel package
612
% Example strange output: Package babel Info: Redefining ngerman shorthand "|
613
\usepackage{etoolbox}
614
\makeatletter
615
\patchcmd{\@decl@short}{\bbl@info}{\@gobble}{}{}
616
\makeatother
617
618
619
%%%
620
% Ermoeglicht es, Abbildungen um 90 Grad zu drehen
621
% Alternatives Paket: rotating Allerdings wird hier nur das Bild gedreht, während bei lscape auch die PDF-Seite gedreht wird.
622
%Das Paket lscape dreht die Seite auch nicht
623
\usepackage{pdflscape}
624
625
\usepackage[caption=false,font=footnotesize]{subfig}
626
627
% Alternative for making subfigures:
628
% Part of the caption package. See http://www.ctan.org/pkg/caption
629
% Ersetzt die Pakete subfigure und subfig - siehe https://tex.stackexchange.com/a/13778/9075
630
%
631
% (subfigure is outdated. subfig is maintained, but subcaption is better)
632
% See: http://tex.stackexchange.com/questions/13625/subcaption-vs-subfig-best-package-for-referencing-a-subfigure
633
%\usepackage[hypcap=true]{subcaption}
634
635
\usepackage{mindflow}
636
637
% https://ctan.org/pkg/algorithms
638
% Consists of two environments: algorithm and algorithmic
639
% Although oudated, it defines the "algorithm" float enviornment
640
% TODO: Define floating environment "algorithm" in other ways
641
\usepackage[chapter]{algorithm}
642
643
% https://ctan.org/pkg/algpseudocodex
644
% Successor of algorithmicx; more modern than https://ctan.org/pkg/algorithms
645
\usepackage{algpseudocodex}
646
647
\floatname{algorithm}{Algorithmus}
648
\renewcommand{\listalgorithmname}{Algorithmenverzeichnis}
649
650
\newcommand{\commentchar}{\ensuremath{/\mkern-4mu/}}
651
\algrenewcommand{\algorithmiccomment}[1]{\hfill $\commentchar$ #1}
652
653
% cleveref für cref statt autoref, da cleveref auch bei Definitionen funktioniert
654
\usepackage[capitalise,nameinlink,noabbrev]{cleveref}
655
656
\crefname{table}{Tabelle}{Tabellen}
657
\Crefname{table}{Tabelle}{Tabellen}
658
\crefname{figure}{Abbildung}{Abbildungen}
659
\Crefname{figure}{Abbildung}{Abbildungen}
660
\crefname{equation}{Gleichung}{Gleichungen}
661
\Crefname{equation}{Gleichung}{Gleichungen}
662
\crefname{theorem}{Theorem}{Theoreme}
663
\Crefname{theorem}{Theorem}{Theoreme}
664
\crefname{listing}{Listing}{Listings}
665
\Crefname{listing}{Listing}{Listings}
666
\crefname{section}{Abschnitt}{Abschnitte}
667
\Crefname{section}{Abschnitt}{Abschnitte}
668
\crefname{paragraph}{Abschnitt}{Abschnitte}
669
\Crefname{paragraph}{Abschnitt}{Abschnitte}
670
\crefname{subparagraph}{Abschnitt}{Abschnitte}
671
\Crefname{subparagraph}{Abschnitt}{Abschnitte}
672
673
\usepackage{lipsum}
674
675
% For demonstration purposes only
676
% These packages can be removed when all examples have been deleted
677
\usepackage[math]{blindtext}
678
\usepackage{mwe}
679
\usepackage[realmainfile]{currfile}
680
\usepackage{tcolorbox}
681
\tcbuselibrary{listings}
682
683
%introduce \powerset - hint by http://matheplanet.com/matheplanet/nuke/html/viewtopic.php?topic=136492&post_id=997377
684
\DeclareFontFamily{U}{MnSymbolC}{}
685
\DeclareSymbolFont{MnSyC}{U}{MnSymbolC}{m}{n}
686
\DeclareFontShape{U}{MnSymbolC}{m}{n}{
687
<-6> MnSymbolC5
688
<6-7> MnSymbolC6
689
<7-8> MnSymbolC7
690
<8-9> MnSymbolC8
691
<9-10> MnSymbolC9
692
<10-12> MnSymbolC10
693
<12-> MnSymbolC12%
694
}{}
695
\DeclareMathSymbol{\powerset}{\mathord}{MnSyC}{180}
696
697
\addto\captionsngerman{%
698
\renewcommand*{\glossaryname}{Bedeutung}%
699
}
700
\usepackage[
701
translate=babel,
702
abbreviations, % create "abbreviations" glossary
703
nomain, % don't create "main" glossary
704
stylemods=longbooktabs % do the adjustments for the longbooktabs styles
705
]{glossaries-extra}
706
\setglossarystyle{long3col-booktabs}
707
708
% Hint by https://tex.stackexchange.com/a/463188/9075
709
% \usepackage{glossary-longextra}
710
711
% Following is required if the abbreviation list should be sorted automatically (\printglossary / \printglossaries)
712
% Not required, if we printed the entries in-order (using \printunsrtglossaries)
713
% Required to have the German chapter name % Source: https://tex.stackexchange.com/a/426392/9075
714
\makeglossaries
715
716
\input{abbreviations}
717
718
719
\usepackage{xspace}
720
% Macht \xspace und \enquote kompatibel
721
\makeatletter
722
\xspaceaddexceptions{\grqq \grq \csq@qclose@i \} }
723
\makeatother
724
725
% Enable hyphenation at other places as the dash.
726
% Example: applicaiton\hydash specific
727
\makeatletter
728
\newcommand{\hydash}{\penalty\@M-\hskip\z@skip}
729
% Definition of "= taken from http://mirror.ctan.org/macros/latex/contrib/babel-contrib/german/ngermanb.dtx
730
\makeatother
731
732
\ifluatex
733
% Enable correct rendering of ligatures - provided by https://ctan.org/pkg/autotype
734
% See ADR-0008 for alternatives
735
\usepackage{autotype}
736
\fi
737
738
% correct bad hyphenation here
739
\hyphenation{
740
Spe-zi-fi-ka-tion
741
In-te-gra-tion
742
An-for-de-rung An-for-de-run-gen
743
Be-nut-zer-ober-flä-che
744
Mes-sung-en
745
aus-zu-tau-schen
746
Lauf-zeit-in-for-ma-tionen
747
% May not be hypphenated
748
AROMA TOSCA BPMN OASIS OMG DMTF IT DevOps
749
}
750
751
\input{commands}
752
753
% Package URL: https://ctan.org/pkg/scientific-thesis-cover
754
\usepackage[
755
title={Is Oil the future?},
756
author={Lars K.},
757
type=bachelor,
758
institute=iaas, % or other institute names - or just a plain string using {Demo\\Demo...}
759
course={Medieninformatik},
760
examiner={Prof.\ Dr.\ Uwe Fessor},
761
supervisor={Dipl.-Inf.\ Roman Tiker,\\Dipl.-Inf.\ Laura Stern,\\Otto Normalverbraucher,\ M.Sc.},
762
startdate={July 5, 2018},
763
enddate={January 5, 2019}
764
]{scientific-thesis-cover}
765
766
767
\ifpdftex
768
% Enable copy and paste of text from the PDF
769
% Only required for pdflatex. It "just works" in the case of lualatex.
770
% Alternative: cmap or mmap package
771
% mmap enables mathematical symbols, but does not work with the newtx font set
772
% See: https://tex.stackexchange.com/a/64457/9075
773
% Other solutions outlined at http://goemonx.blogspot.de/2012/01/pdflatex-ligaturen-und-copynpaste.html and http://tex.stackexchange.com/questions/4397/make-ligatures-in-linux-libertine-copyable-and-searchable
774
% Trouble shooting outlined at https://tex.stackexchange.com/a/100618/9075
775
%
776
% According to https://tex.stackexchange.com/q/451235/9075 this is the way to go
777
\input{glyphtounicode}
778
\pdfgentounicode=1
779
\fi
780
% DM: line-breaking-description env vom daniel w.
781
782
% credit goes to daniel w. :-)
783
%% --- Descriptions with line breaks in labels ---------------------------------
784
\usepackage{calc}
785
786
\newcommand*\Descriptionlabel[1]{%
787
\raisebox{0pt}[1ex][0pt]{
788
\makebox[\labelwidth][1]{
789
\parbox[t]{\labelwidth}{
790
\hspace{0pt}\textbf{#1:}}}}
791
}
792
793
\newcommand*\Descriptionlabelx[1]{%
794
\parbox[t]{\textwidth}{
795
\textbf{#1}\\\mbox{}}
796
}
797
798
\newenvironment{Description}{
799
\begin{list}{}{
800
\let\makelabel\Descriptionlabelx
801
\setlength\labelwidth{1em}
802
\setlength\leftmargin{\labelwidth+\labelsep}
803
}
804
}
805
{
806
\end{list}
807
}
808
809
% globally change line spacing of lists
810
% paralist has suspended development since 10 years.
811
% enumitem has been updated 2011-09-28
812
\usepackage[inline]{enumitem}
813
\setlist{partopsep=0pt,itemsep=1pt}
814
815
%------------------------------------------------------------------------
816
% fquote Fancy Quotation environment
817
% supports empty/optional author
818
819
% Use \sloppy to make right-margin easier?
820
% Set picture units to be relative to font size (em)?
821
% Use begingroup to rest units afterwards?
822
823
\usepackage{xifthen}% provides \isempty test
824
\definecolor{quotemark}{gray}{0.7}
825
826
%fquote environment with author as optional parameter
827
%usage: \begin{fquote}quote\end{fquote} or \begin{fquote}[Author]quote\end{fquote}
828
\newenvironment{fquote}[1][]{%
829
\newcommand{\fqauthor}{\relax}
830
\ifthenelse{\isempty{#1}}
831
{}% do nothing
832
{\renewcommand{\fqauthor}{\hfill\textsc{--- #1}}}
833
\vspace{1em}
834
\begin{list}{}{%
835
\setlength{\leftmargin}{0.2\textwidth}
836
\setlength{\rightmargin}{0.2\textwidth}
837
}
838
\item[]%
839
\begin{picture}(0,0)(0,0)
840
\put(-15,-5){\makebox(0,0){%
841
\scalebox{4.5}{\textcolor{quotemark}{\bfseries``}}}%
842
}
843
\end{picture}\em\ignorespaces%
844
}{%
845
\newline%
846
\makebox[0pt][l]{\hspace{0.6\textwidth}%
847
\begin{picture}(0,0)(0,0)
848
\put(15,10){\makebox(0,0){%
849
\scalebox{4.5}{\textcolor{quotemark}{\rmfamily\bfseries''}}}%
850
}
851
\end{picture}}%
852
\fqauthor
853
\end{list}
854
}
855
856
%German fquote
857
% 1 parameter for the author's name, may be empty ("{}")
858
% guaranteed German quotes (works with lualatex and babel package)
859
% usage: \begin{gfquote}{Author}quote\end{gfquote}
860
\newenvironment{gfquote}[1]{%
861
\newcommand{\fqauthor}{\relax}
862
\ifthenelse{\isempty{#1}}
863
{}% do nothing
864
{\renewcommand{\fqauthor}{\hfill\textsc{\textemdash #1}}}
865
\vspace{1em}
866
\begin{list}{}{%
867
\setlength{\leftmargin}{0.2\textwidth}
868
\setlength{\rightmargin}{0.2\textwidth}
869
}
870
\item[]%
871
\begin{picture}(0,0)(0,0)
872
\put(-15,-5){\makebox(0,0){%
873
\scalebox{4.5}{\textcolor{quotemark}{\bfseries \glqq}}}%
874
}
875
\end{picture}\em\ignorespaces%
876
}{%
877
\newline%
878
\makebox[0pt][l]{\hspace{0.6\textwidth}%
879
\begin{picture}(0,0)(0,0)
880
\put(15,10){\makebox(0,0){%
881
\scalebox{4.5}{\textcolor{quotemark}{\rmfamily\bfseries \grqq}}}%
882
}
883
\end{picture}}%
884
\fqauthor
885
\end{list}
886
}
887
888
% fix incompatibilities between KOMA and other packages, mainly float.
889
% should be loaded at the very end - see http://tex.stackexchange.com/a/156256/9075
890
\usepackage{scrhack}
891
892
893
\begin{document}
894
\raggedbottom % Variable Seitenhoehen zulassen
895
\ifluatex
896
% Enable correct rendering of ligatures - provided by https://ctan.org/pkg/autotype
897
% See ADR-0008 for alternatives
898
\autotypelangoptions{ngerman}{ligbreak}
899
\fi
900
901
\pagenumbering{arabic}
902
\Titelblatt
903
904
\pagestyle{plain.scrheadings}
905
\renewcommand*{\chapterpagestyle}{plain.scrheadings}
906
907
% Kurzfassung / abstract
908
% auch im Stil vom Inhaltsverzeichnis
909
\section*{Kurzfassung}
910
% Silbentrennung auf Englisch
911
\begin{otherlanguage}{american}
912
\emph{Write an abstract for your work.
913
Replace each of the points below with one sentence (two if you must) and you have your abstract.
914
Write it when you finished your entire report.
915
\footnote{https://www.easterbrook.ca/steve/2010/01/how-to-write-a-scientific-abstract-in-six-easy-steps/}}
916
917
\emph{Introduction.}
918
In one sentence, what’s the topic?
919
Phrase it in a way that your reader will understand.
920
If you’re writing a PhD thesis, your readers are the examiners assume they are familiar with the general field of research, so you need to tell them specifically what topic your thesis addresses.
921
Same advice works for scientific papers the readers are the peer reviewers, and eventually others in your field interested in your research, so again they know the background work, but want to know specifically what topic your paper covers.
922
923
\emph{State the problem you tackle.}
924
What’s the key research question?
925
Again, in one sentence.
926
(Note: For a more general essay, I’d adjust this slightly to state the central question that you want to address)
927
Remember, your first sentence introduced the overall topic, so now you can build on that, and focus on one key question within that topic.
928
If you can’t summarize your thesis/paper/essay in one key question, then you don’t yet understand what you’re trying to write about.
929
Keep working at this step until you have a single, concise (and understandable) question.
930
931
\emph{Summarize (in one sentence) why nobody else has adequately answered the research question yet.}
932
For a PhD thesis, you’ll have an entire chapter, covering what’s been done previously in the literature.
933
Here you have to boil that down to one sentence.
934
But remember, the trick is not to try and cover all the various ways in which people have tried and failed; the trick is to explain that there’s this one particular approach that nobody else tried yet (hint: it’s the thing that your research does).
935
But here you’re phrasing it in such a way that it’s clear it’s a gap in the literature.
936
So use a phrase such as “previous work has failed to address.
937
(if you’re writing a more general essay, you still need to summarize the source material you’re drawing on, so you can pull the same trick explain in a few words what the general message in the source material is, but expressed in terms of what’s missing)
938
939
\emph{Explain, in one sentence, how you tackled the research question.}
940
What’s your big new idea?
941
(Again for a more general essay, you might want to adapt this slightly: what’s the new perspective you have adopted? or:
942
What’s your overall view on the question you introduced in step 2?)
943
944
\emph{In one sentence, how did you go about doing the research that follows from your big idea.}
945
Did you run experiments?
946
Build a piece of software?
947
Carry out case studies?
948
This is likely to be the longest sentence, especially if it’s a PhD thesis after all you’re probably covering several years worth of research.
949
But don’t overdo it we’re still looking for a sentence that you could read aloud without having to stop for breath.
950
Remember, the word ‘abstract means a summary of the main ideas with most of the detail left out.
951
So feel free to omit detail!
952
(For those of you who got this far and are still insisting on writing an essay rather than signing up for a PhD, this sentence is really an elaboration of sentence 4 explore the consequences of your new perspective).
953
954
\emph{As a single sentence, what’s the key impact of your research?
955
Here we’re not looking for the outcome of an experiment.
956
}
957
We’re looking for a summary of the implications.
958
What’s it all mean?
959
Why should other people care?
960
What can they do with your research.
961
(Essay folks: all the same questions apply: what conclusions did you draw, and why would anyone care about them?)
962
\end{otherlanguage}
963
964
\microtypesetup{protrusion=false}
965
966
% In case you have trouble with headings reaching into the page numbers, enable the following three lines.
967
% Hint by http://golatex.de/inhaltsverzeichnis-schreibt-ueber-rand-t3106.html
968
%
969
%\makeatletter
970
%\renewcommand{\@pnumwidth}{2em}
971
%\makeatother
972
%
973
% Bei einem ungünstigen Seitenumbruch im Inhaltsverzeichnis, kann dieser mit
974
% \addtocontents{toc}{\protect\newpage}
975
% an der passenden Stelle im Fließtext erzwungen werden.
976
\tableofcontents
977
978
\listoffigures
979
980
\listoftables
981
982
% We use lstlisting environments with caption paramters.
983
% Thus, we need that command.
984
% Alternative: \listof{Listing}{List of Listings}
985
\lstlistoflistings
986
987
%mittels \newfloat wurde die Algorithmus-Gleitumgebung definiert.
988
%Mit folgendem Befehl werden alle floats dieses Typs ausgegeben
989
%\listof{Algorithmus}{Verzeichnis der Algorithmen}
990
%\listofalgorithms %Ist nur für Algorithmen, die mittels \begin{algorithm} umschlossen werden, nötig
991
992
% Abkürzungsverzeichnis / Acronyms / Abbreviations
993
\printglossary[type=\acronymtype,title={Abkürzungsverzeichnis}]
994
% \printglossaries
995
% \printnoidxglossaries
996
% \printunsrtglossaries cannot be used, because then no indexing happens; source: https://tex.stackexchange.com/a/287128/9075
997
998
\microtypesetup{protrusion=true}
999
1000
% Headline and footline
1001
\renewcommand*{\chapterpagestyle}{scrplain}
1002
\pagestyle{scrheadings}
1003
1004
%%% ===============================================================================
1005
\chapter{Introduction}\label{sec:introduction}
1006
%%% ===============================================================================
1007
1008
\emph{Purpose and scope of your entire report}.
1009
The purpose of your entire report is to make a \emph{scientific argument using the scientific method}.
1010
A scientific argument always has the following steps that all must come in this order.
1011
%
1012
\begin{itemize}
1013
\item[SM1] \emph{Explicate the assumptions and state of the art} on which you are going to conduct your research to investigate your research problem/test the hypothesis.
1014
\item[SM2] Clearly and precisely \emph{formulate a research problem or hypothesis}.
1015
\item[SM3] \emph{Describe the (research) method} that you followed to investigate the problem / to test the hypothesis in a way that \emph{allows someone else to reproduce your steps}.
1016
The method must includes steps and criteria for evaluating whether you answered your question successfully or not.
1017
\item[SM4] \emph{Provide execution details} on how you followed the method in the given, specific situation.
1018
\item[SM5] \emph{Report your results} by describing and summarizing your measurements.
1019
You must not interpret your results.
1020
\item[SM6] \emph{Now interpret your results} by contextualizing the measurements and drawing conclusion that lead to answering your research problem or defining further follow-up research problems.
1021
\end{itemize}
1022
%
1023
This template will mark various parts of the structure with SM1-SM6 to recall to you which step of a scientific argument is used and where.
1024
1025
\emph{Purpose and scope of \cref{sec:introduction}}.
1026
The introduction chapter is a summary of your work and your scientific argument that shall be understandable to anyone in your scientific field, e.g., anyone in Data Science.
1027
A reader must be able to comprehend the problem, method, relevant execution details, results, and their interpretation by reading the introduction and the introduction alone.
1028
Section~\ref{sec:introduction:topic} introduces the general topic of your research.
1029
Section~\ref{sec:introduction:state-of-art} discusses the state of the art and identifies a research.
1030
Section~\ref{sec:introduction:research-question} then states the research problem to investigate.
1031
Section~\ref{sec:problem-exposition:research-method} explains the research method that was followed, possibly with execution details.
1032
Section~\ref{sec:introduction:results} then presents the results and their interpretation.
1033
Only if a reader thinks they are not convinced or they need more details to reproduce your study, they shall have to read further.
1034
The individual chapters and sections provide the details for each of the steps in your scientific argument.
1035
1036
You usually write the introduction chapter \emph{after} you wrote all other chapters, but you should keep on making notes for each of the sections as you write the later chapters.
1037
.
1038
1039
\emph{Purpose and scope of the introduction paragraph to a chapter}.
1040
The paragraph you are reading above is a typical introductory paragraph to a chapter.
1041
It is a high-level summary of the chapters' topic (SM1 and SM2).
1042
It gives the reader some guidance by breaking down the chapter topic into subtopics that are clearly named (SM3) in the right order with forward references to the corresponding sections (SM4).
1043
It may close with announcing the result you obtain (SM6) but this is usually not done in the opening paragraph of the introduction.
1044
1045
% ---------------------------------------------------------------------------------
1046
\section{Context and Topic (SM1)}\label{sec:introduction:topic}
1047
% ---------------------------------------------------------------------------------
1048
1049
\emph{Purpose and scope}.
1050
You begin with providing the general scientific audience an introduction into the specific topic of your work.
1051
The aim of this section is to first introduce the \emph{general subject of study} (``Giraffes are well-known animals and everyone's favorite''), the \emph{specific topic of societal or scientific interest} to investigate (``Giraffes have blue tongues'') and the \emph{objective of society/science towards} this topic (``it is unknown at the moment how the blue color tone evolved'').
1052
It must be understandable by the general scientific public.
1053
Every \emph{term} with a specific meaning must be highlighted and introduced in precise language/concepts that only builds on a general scientific background.
1054
1055
At the end of this section, you have explained and established a general goal that society/science universally agrees to be worth achieving (``knowing how everyone's favorite animal evolved the colour of their tongue'').
1056
1057
% ---------------------------------------------------------------------------------
1058
\section{State of the Art (SM1)}\label{sec:introduction:state-of-art}
1059
% ---------------------------------------------------------------------------------
1060
1061
\emph{Purpose and scope}.
1062
You provide a more in-depth introduction into the research topic by contrasting the current state of the art in society/science in relation to the research topic you introduced in \cref{sec:introduction:topic}.
1063
This introduction has to
1064
1065
\begin{itemize}
1066
\item present established facts, methods, and results that provide a deeper understanding of the research topic (``prior work on giraffe genomes, relevance of giraffes for societal well-being, giraffes being a model-animal for various other studies, etc.'')
1067
\item discuss in which ways prior and recent ideas still fall short of reaching the general goal you explained in \cref{sec:introduction:topic} (``prior work only sequenced the genome of one giraffe and did not consider genes of ancient ancestors'')
1068
\end{itemize}
1069
1070
You have to provide citations/literature references for each of the statements and claims you are making.
1071
This section is usually a summary of the related work discussion in \cref{sec:background}.
1072
1073
At the end of this section, you have established a \emph{knowledge gap} between the state of the art and the general objective you developed in \cref{sec:introduction:topic}.
1074
\emph{Stating a (knowledge) gap between a status quo and a desired situation is the \emph{first step} of a writing scientific argument.}
1075
1076
% ---------------------------------------------------------------------------------
1077
\section{Research Question (SM2)}\label{sec:introduction:research-question}
1078
% ---------------------------------------------------------------------------------
1079
1080
\emph{Purpose and scope}.
1081
In this section you state in which way you will address the knowledge gap you identified at the end of \cref{sec:introduction:state-of-art}.
1082
You usually cannot address and resolve the entire knowledge gap in your work.
1083
The purpose of this section is to clearly detail the specific part of the knowledge that you will address.
1084
You thereby make all the assumptions explicit that underlie your work (``in this report we focus on genomes of female giraffes who lived in the years 1950-2000 in South Africa'').
1085
1086
Your general research question states
1087
\begin{itemize}
1088
\item The starting point/assumptions you are making from which your research starts (``for the given 13 genomes of female giraffes...''), and
1089
\item the final objective/solution you want to reach (``...identify the genes involved in color expression of giraffe tongues...'')
1090
\item and the evaluation criteria that will determine whether you are successful (``...that are present in at least 75\% of the studied giraffes'')
1091
\end{itemize}
1092
1093
You will usually break your general research question down into sub-research questions.
1094
You may do this here.
1095
The sub-research questions have to form a chain that take you in smaller steps from the starting point/assumptions of your general research question to your final objective and evaluation.
1096
1097
% ---------------------------------------------------------------------------------
1098
\section{Method or Approach (SM3, SM4)}\label{sec:introduction:method}
1099
% ---------------------------------------------------------------------------------
1100
1101
\emph{Purpose and scope}.
1102
In this section you outline the method that you applied to answer the research questions, or the new technical approach that you developed to answer it.
1103
It is a summary of the steps that someone else has to take in order to reproduce your steps.
1104
Mention here the data sets you had to obtain/gather/analyze, interviews with stakeholders you had to make to further develop the research questions, technical artifacts (programs, algorithms, models) you could apply or that you had to develop (and how they work).
1105
1106
The section is most readable if you give each of the steps in your method its own paragraph.
1107
In each paragraph you first briefly explain the concept of the step in your method (SM3, ``we explored the data through visual analytics'') and then provide details in execution (SM4, ``we used tool X, we developed dashboard Y'') include a forward reference to the respective chapter that provides more details.
1108
1109
% ---------------------------------------------------------------------------------
1110
\section{Findings (SM5, SM6)}\label{sec:introduction:results}
1111
% ---------------------------------------------------------------------------------
1112
1113
\emph{Purpose and scope}.
1114
You close the introduction by clearly stating the evaluation setup you designed to evaluate the success of your study regarding the research objective, which comes in two steps.
1115
It is most likely a summary of your evaluation in \cref{sec:evaluation}.
1116
1117
\section*{Results (SM5)}
1118
1119
You state the evaluation method that is in line with your research question from \cref{sec:introduction:research-question} and summarize the measurements you obtained but you do not interpret them, i.e., you only report the numbers but you do not include judging statements.
1120
1121
\section*{Interpretation (SM6)}
1122
1123
You summarize your interpretation of the results and draw conclusions.
1124
State whether and to which degree the research question from \cref{sec:introduction:research-question} has been answered successfully or not.
1125
1126
Finally state briefly how much closer society and science have come in answering the general objective you outlined in \cref{sec:introduction:topic}.
1127
1128
%%% ===============================================================================
1129
\section{Background (SM1)}\label{sec:background}
1130
%%% ===============================================================================
1131
1132
\emph{Purpose and scope}.
1133
The background chapter has multiple roles.
1134
\begin{itemize}
1135
1136
\item \emph{Preliminaries.}
1137
It has to provide all (and exactly the) information that is necessary to understand the methodological and technical parts of your work in the specific area of study.
1138
Assume as starting point another student in your degree who did not study the specific subject you are studying but has the task to understand your work.
1139
Which concepts, terms, definitions, etc. does the student have to know?
1140
Which formulas, symbols, etc. are standard in this topic?
1141
Only introduce definitions if you actually need them in any of the subsequent chapters.
1142
1143
\item \emph{Related Work.}
1144
It has to provide a comprehensive discussion of all prior work in the area on this subject.
1145
Your discussion has to summarize these prior works and has to explain in which way the research question you are solving (\cref{sec:introduction:research-question}) has not bee solved yet because prior work had more limiting assumptions, addressed a different angle, their results are not complete etc. Depending on the subject you are studying, the related work part can be larger and warrant an entire chapter on its own, or be fully concluded within \cref{sec:introduction:state-of-art}.
1146
1147
You can close the related work discussion by clarifying the positioning and formulation of your research question (SM2) in relation to all the prior work, making more explicit whether you address an existing research question under different premises or whether you work on a modified or completely new research question.
1148
\end{itemize}
1149
1150
%%% ===============================================================================
1151
\section{Problem Exposition (optional)}\label{sec:problem-exposition}
1152
%%% ===============================================================================
1153
1154
\emph{Purpose and scope}.
1155
Introduce the problem context in more detail if \cref{sec:introduction:topic} does not provide all necessary information about the problem to follow the rest of the report.
1156
This can include further details on the data you studied, context assumptions and requirements, etc.
1157
1158
If you have to expose the problem in more detail here, then this chapter should also provide a more detailed explanation of research question and the method you are applying, i.e., you can now provide more concrete sub-problems compared to \cref{sec:introduction:research-question} more details for the method \cref{sec:introduction:method} because you now have explained the problem much better.
1159
A typical structure can be.
1160
1161
% ---------------------------------------------------------------------------------
1162
\section{Context/Business Understanding (SM1)}\label{sec:problem-exposition:context-understanding}
1163
% ---------------------------------------------------------------------------------
1164
1165
provide details
1166
1167
% ---------------------------------------------------------------------------------
1168
\section{Data Understanding (SM1)}\label{sec:problem-exposition:data-understanding}
1169
% ---------------------------------------------------------------------------------
1170
1171
provide details
1172
1173
% ---------------------------------------------------------------------------------
1174
\section{Detailed Research Questions (SM2)}\label{sec:problem-exposition:research-problems}
1175
% ---------------------------------------------------------------------------------
1176
1177
provide details based on \cref{sec:problem-exposition:context-understanding} and \ref{sec:problem-exposition:data-understanding}
1178
1179
% ---------------------------------------------------------------------------------
1180
\section{Detailed Method (SM3)}\label{sec:problem-exposition:research-method}
1181
% ---------------------------------------------------------------------------------
1182
1183
provide details based on \cref{sec:problem-exposition:context-understanding} and \ref{sec:problem-exposition:data-understanding}
1184
1185
%%% ===============================================================================
1186
\section{First Real Chapter addressing first Research Problem}\label{sec:problem1}
1187
%%% ===============================================================================
1188
1189
\emph{Purpose and scope}.
1190
After you stated research context (SM1), research problem (SM2), and research method (SM3) in \cref{sec:introduction} and possibly \cref{sec:problem-exposition}, the remainder of your entire report addresses execution (SM4), results (SM5), and interpretation (SM6).
1191
You usually do this by addressing various sub-problems again through scientific arguments following the 6 steps SM1-SM6.
1192
1193
Have a short chapter introduction that recalls and explains the first research problem of your thesis.
1194
The problem has to show up in the introduction in \cref{sec:introduction:research-question} or in \cref{sec:problem-exposition:research-problems} already.
1195
This provides the background (SM1) for this chapter while the first research problem of the thesis becomes the research question/hypothesis (SM2) for this chapter.
1196
1197
Next, explain in the chapter intro how you solve the research problem in this chapter by breaking it down in further sub-problems.
1198
By this, you outline the method (SM3) through which you are going to solve the problem of this chapter.
1199
This is necessary to give the reader guidance of what's to come in this chapter and how it fits into the thesis as a whole.
1200
Explain that you will address the first sub-problem in \cref{sec:problem1:subproblem1} and the second sub-problem in \cref{sec:problem1:subproblem2}, etc. The sections then provide the details for execution and results.
1201
1202
% ---------------------------------------------------------------------------------
1203
\section{First Sub-Problem}\label{sec:problem1:subproblem1}
1204
% ---------------------------------------------------------------------------------
1205
1206
\emph{The first paragraph describes the first sub-problem and develops the requirements a solution has to satisfy (SM2 for this section).}
1207
The requirements have to be based on the knowledge and reasoning developing in the preceding chapters and sections.
1208
Try to use an example to illustrate the problem and the desired properties of the solution.
1209
Check that every term/concept you use here has already been defined already in a previous section.
1210
If you cannot describe your problem without defining new terms, you may have to add another section before this one that develops the terms and concepts you need to explain the problem.
1211
1212
\emph{The second paragraph describes the method/approach how you address the problem (SM3 for this section).}
1213
Describe the method in a level of detail that allows another student to reproduce your steps.
1214
Make use of appendices % (see \cref{sec:appendix1})
1215
if certain details take too much space.
1216
1217
\emph{The third, fourth, and following paragraph provides details on applying the method or developing a new approach, i.e., execution (SM4) and may explain results (SM5)}, i.e. details on the steps needed to reproduce the results.
1218
1219
Results (SM5) can come in many forms, e.g., conceptual diagrams, algorithms, tables, charts, a list of articles from a literature research etc. You must reference them (``\cref{fig:my_label} shows.
1220
..'') and describe the results in text.
1221
If you use diagrams, tables, or charts, you cannot expect the reader to know what to you expect them to see in a diagram, table or chart.
1222
Describe to them how to read these, explain the meaning of particular elements, point out special observations.
1223
But you may only describe the results you must not interpret them.
1224
Make use of appendices if certain details take too much space.
1225
1226
\begin{figure}
1227
\centering
1228
%%%\includegraphics{/path/to/figure.pdf}
1229
\caption{A scientific figure that has to be explained in the text}
1230
\label{fig:my_label}
1231
\end{figure}
1232
1233
\emph{After describing the results, you may interpret them (SM6).}
1234
Here you can infer what a particular observation means (for you), how it can be applied, or what others can do with it.
1235
You must not write interpretations before completely describing your results.
1236
This is a common mistake done by most beginner writers.
1237
You want to quickly get to the point, which is the final finding or interpretation.
1238
But you forget that your reader does not understand yet what you are interpreting - they do not know yet what you do know.
1239
An interpretation can only be followed after all results have been described.
1240
The interpretation must be based on the written description only.
1241
Then you can be sure that your readers can follow your interpretation and reach the same conclusions as you have.
1242
1243
Ideally, your interpretation leads to the next sub-problem in \cref{sec:problem1:subproblem2}.
1244
1245
% ---------------------------------------------------------------------------------
1246
\section{Second Sub-Problem}\label{sec:problem1:subproblem2}
1247
% ---------------------------------------------------------------------------------
1248
1249
You now build on the solution to the first sub-problem of \cref{sec:problem1:subproblem1} (SM1) and recall second sub-problem (SM2, you detailed in the introduction of this chapter) and follow the same pattern as before (SM3-SM6).
1250
1251
Note that not all sections may not include all parts SM1-SM6 in all detail.
1252
Some sections do not require to repeatedly state the background (SM1) or the research problem (SM2) if they were already clearly defined in a previous section.
1253
Sometimes, a section is only dedicated to describing the method (SM3) and execution (SM4) and does not contain any results or interpretations.
1254
Sometimes results (SM5) and interpretations (SM6) only come in the evaluation chapter.
1255
1256
What is important for you when you are writing a scientific argument is not to slavishly have SM1-SM6 in each section explicitly, but that you are always fully aware of the following:
1257
%
1258
\begin{itemize}
1259
\item Which step of a scientific argument am I currently writing (SM1, SM2, ..., SM6)?
1260
\item Does the step that I am writing come in the right order, i.e., if you are writing about execution (SM4, e.g., details of building a model), is there a preceding paragraph or section that describes the method (SM3) and is that one preceded by a clear statement of the (sub-)problem addressed (SM2)?
1261
\item Are you really \emph{not} writing interpretation SM6 before SM5, SM4, or SM3?
1262
\item Is it clear to the reader which part of the scientific argument you are currently making?
1263
\end{itemize}
1264
1265
%%% ===============================================================================
1266
\section{Second Real Chapter}\label{sec:sub-problem2}
1267
%%% ===============================================================================
1268
1269
Have a short chapter introduction that recalls what you already achieved in \cref{sec:problem1} and explain the second research problem of your thesis.
1270
The problem has to show up in the introduction in \cref{sec:introduction:research-question} or in \cref{sec:problem-exposition:research-problems} already.
1271
etc.
1272
1273
%%% ===============================================================================
1274
\section{Evaluation}\label{sec:evaluation}
1275
%%% ===============================================================================
1276
1277
\emph{Purpose and scope}.
1278
The evaluation chapter should be the most formal and rigorously structured chapter of your thesis as the validity of your evaluation argument depends on it.
1279
1280
% ---------------------------------------------------------------------------------
1281
\section{Objective (SM2)}\label{sec:evaluation:objective}
1282
% ---------------------------------------------------------------------------------
1283
1284
Clearly state what you want to evaluate and what you want to measure.
1285
1286
% ---------------------------------------------------------------------------------
1287
\section{Setup (SM3)}\label{sec:evaluation:setup}
1288
% ---------------------------------------------------------------------------------
1289
1290
State which data, participants, tools, etc. you chose and why.
1291
Clearly state how you measure outcomes and how you compare them to baselines, reference groups, etc.
1292
1293
% ---------------------------------------------------------------------------------
1294
\section{Execution (SM4)}\label{sec:evaluation:execution}
1295
% ---------------------------------------------------------------------------------
1296
1297
Provide all details on the execution that are necessary to allows another person to reproduce your results at a later point.
1298
1299
% ---------------------------------------------------------------------------------
1300
\section{Results (SM5)}\label{sec:evaluation:results}
1301
% ---------------------------------------------------------------------------------
1302
1303
You only report the measurements.
1304
You must present and reference them (``\cref{fig:my_label2} shows.
1305
..'') and describe the results in text.
1306
If you use diagrams, tables, or charts, you cannot expect the reader to know what to you expect them to see in a diagram, table or chart.
1307
Describe to them how to read these, explain the meaning of particular elements, point out special observations.
1308
But you may only describe the results you must not interpret them.
1309
Make use of appendices if certain details take too much space.
1310
1311
\begin{figure}
1312
\centering
1313
%%%\includegraphics{/path/to/figure.pdf}
1314
\caption{Another scientific figure that has to be explained in the text}
1315
\label{fig:my_label2}
1316
\end{figure}
1317
1318
% ---------------------------------------------------------------------------------
1319
\section{Discussion (SM6)}\label{sec:evaluation:discussion}
1320
% ---------------------------------------------------------------------------------
1321
1322
An interpretation can only be followed after all results have been described.
1323
The interpretation must be based on the written description in \cref{sec:evaluation:results} only.
1324
Then you can be sure that your readers can follow your interpretation and reach the same conclusions as you have.
1325
1326
1327
\chapter{LaTeX Hinweise}
1328
\label{sec:latexhints}
1329
1330
% Benötigt für eine korrekte Darstellung der Hinweise im erzeugten PDF
1331
\newcount\LTGbeginlineexample
1332
\newcount\LTGendlineexample
1333
\newenvironment{ltgexample}%
1334
{\LTGbeginlineexample=\numexpr\inputlineno+1\relax}%
1335
{\LTGendlineexample=\numexpr\inputlineno-1\relax%
1336
\tcbinputlisting{%
1337
listing only,
1338
listing file=\currfilepath,
1339
colback=green!5!white,
1340
colframe=green!25,
1341
coltitle=black!90,
1342
coltext=black!90,
1343
left=8mm,
1344
title=Zugehöriger \LaTeX{}-Quelltext aus \texttt{\currfilepath},
1345
listing options={
1346
frame=none,
1347
language={[LaTeX]TeX},
1348
escapeinside={},
1349
firstline=\the\LTGbeginlineexample,
1350
lastline=\the\LTGendlineexample,
1351
firstnumber=\the\LTGbeginlineexample,
1352
basewidth=.5em,
1353
aboveskip=0mm,
1354
belowskip=0mm,
1355
numbers=left,
1356
xleftmargin=0mm,
1357
numberstyle=\tiny,
1358
numbersep=8pt%
1359
}
1360
}
1361
}%
1362
1363
Hier sollen allgemeine \LaTeX-Hinweise gegeben werden, damit man Minimalbeispiele vorliegen hat, um sofort loszulegen.
1364
1365
\section{Trennung von Absätzen}
1366
1367
\begin{ltgexample}
1368
Pro Satz eine neue Zeile.
1369
Das ist wichtig, um sauber versionieren zu können.
1370
In LaTeX werden Absätze durch eine Leerzeile getrennt.
1371
Analogie zu Word: Bei Word werden neue Absätze durch einmal Eingabetaste herbeigeführt.
1372
Dies führt bei LaTeX jedoch nicht zu einem neuen Absatz, da LaTeX direkt aufeinanderfolgende Zeilen zu einer Zeile zusammenfügt.
1373
Mächte man nun einen Absatz haben, muss man zweimal die Eingabetaste drücken.
1374
Dies führt zu einer leeren Zeile.
1375
In Word gibt es die Funktion Großschreibetaste und Eingabetaste gleichzeitig.
1376
Wenn man dies drückt, wird einer harter Umbruch erzwungen.
1377
Der Text fängt am Anfang der neuen Zeile an.
1378
In LaTeX erreicht man dies durch Doppelbackslashes (\textbackslash\textbackslash) erzeugt.
1379
\\
1380
Dies verwendet man quasi nie.
1381
1382
Folglich werden neue Abstäze insbesondere \emph{nicht} durch Doppelbackslashes erzeugt.
1383
Beispielsweise begann der letzte Satz in einem neuen Absatz.
1384
Eine ausführliche Motivation hierfür findet sich in \url{http://loopspace.mathforge.org/HowDidIDoThat/TeX/VCS/#section.3}.
1385
\end{ltgexample}
1386
1387
Möchte man die Art des Absatzes ändern, so kann man die Dokumentklassenoption \texttt{parskip} verwenden.
1388
Beispielsweise kann man mit \texttt{parskip=off} erreichen, dass statt eines freien Bereichs die erste Zeile des Absatzes eingezogen wird.
1389
1390
\section{Notes separated from the text}
1391
1392
The package mindflow enables writing down notes and annotations in a way so that they are separated from the main text.
1393
1394
\begin{ltgexample}
1395
\begin{mindflow}
1396
This is a small note.
1397
\end{mindflow}
1398
\end{ltgexample}
1399
1400
\section{Handling TODOs}
1401
1402
\begin{ltgexample}
1403
\textmarker{Markierter Text.}
1404
\end{ltgexample}
1405
1406
Bei \verb1\textmarker1 wird nur die Textfarbe geändert, da dies auch bei einigen Worten gut funktioniert.
1407
1408
\begin{ltgexample}
1409
\textcomment{Markierter Text.}{Kommentar dazu.}
1410
\end{ltgexample}
1411
1412
\begin{ltgexample}
1413
\hl{In Gelb hervorgehoben.}
1414
Provided indirectly by pdfcomment.sty (soulpos).
1415
\end{ltgexample}
1416
1417
\begin{ltgexample}
1418
\modified{Manuelle Markierung für Text, der seit der letzten Version geändert wurde.}
1419
\end{ltgexample}
1420
1421
\begin{ltgexample}
1422
Das ist ein Text.
1423
\change{FL1: Text angepasst}{Geänderter Text}.
1424
\end{ltgexample}
1425
1426
\begin{ltgexample}
1427
Hier nur ein Kommentar\sidecomment{Kommentar}.
1428
\end{ltgexample}
1429
1430
\begin{ltgexample}
1431
\todo{Hier muss noch kräftig Text produziert werden}
1432
\end{ltgexample}
1433
1434
\section{Hyphenation}
1435
1436
\LaTeX{} automatically hyphenates words.
1437
When using \href{https://ctan.org/pkg/microtype}{microtype}, there should be fewer hyphenations than in other settings.
1438
It might be necessary to tweak the hyphenations nevertheless.
1439
Here are some hints:
1440
1441
\begin{ltgexample}
1442
In case you write \enquote{application-specific}, then the word will only be hyphenated at the dash.
1443
You can also write \verb1applica\allowbreak{}tion-specific1 (result: applica\allowbreak{}tion-specific), but this is much more effort.
1444
1445
You can now write words containing hyphens which are hyphenated at other places in the word.
1446
For instance, \verb1application"=specific1 gets application"=specific.
1447
This is enabled by an additional configuration of the babel package.
1448
\end{ltgexample}
1449
1450
\section{Typesetting Units}
1451
1452
\begin{ltgexample}
1453
Numbers can be written plain text (such as 100), by using the \href{https://ctan.org/pkg/siunitx}{siunitx} package as follows:
1454
\SI{100}{\km\per\hour},
1455
or by using plain \LaTeX{} (and math mode):
1456
$100 \frac{\mathit{km}}{h}$.
1457
\end{ltgexample}
1458
1459
\begin{ltgexample}
1460
\SI{5}{\percent} of \SI{10}{kg}
1461
\end{ltgexample}
1462
1463
\begin{ltgexample}
1464
Numbers are automatically grouped: \num{123456}.
1465
\end{ltgexample}
1466
1467
\section{Surrounding Text by Quotes}
1468
1469
\begin{ltgexample}
1470
Please use the \enquote{enquote command} to quote something.
1471
Quoting with "`quote"' or ``quote'' also works.
1472
1473
\end{ltgexample}
1474
1475
\section{Cleveref examples}
1476
\label{sec:ex:cref}
1477
1478
Cleveref demonstration: Cref at beginning of sentence, cref in all other cases.
1479
1480
\begin{figure}
1481
\centering
1482
\includegraphics[width=.75\linewidth]{example-image-a}
1483
\caption{Example figure for cref demo}
1484
\label{fig:ex:cref}
1485
\end{figure}
1486
1487
\begin{table}
1488
\centering
1489
\begin{tabular}{ll}
1490
\toprule
1491
Heading1 & Heading2 \\
1492
\midrule
1493
One & Two \\
1494
Thee & Four \\
1495
\bottomrule
1496
\end{tabular}
1497
\caption{Example table for cref demo}
1498
\label{tab:ex:cref}
1499
\end{table}
1500
1501
\begin{ltgexample}
1502
\Cref{fig:ex:cref} shows a simple fact, although \cref{fig:ex:cref} could also show something else.
1503
1504
\Cref{tab:ex:cref} shows a simple fact, although \cref{tab:ex:cref} could also show something else.
1505
1506
\Cref{sec:ex:cref} shows a simple fact, although \cref{sec:ex:cref} could also show something else.
1507
\end{ltgexample}
1508
1509
\section{Abbildungen}
1510
1511
\begin{ltgexample}
1512
\Cref{fig:label} zeigt etwas Interessantes
1513
1514
\begin{figure}
1515
\centering
1516
Füge deine Abbildung hier ein.
1517
\caption{Bildunterschrift.}
1518
\label{fig:label}
1519
\end{figure}
1520
\end{ltgexample}
1521
1522
\section{Sub Figures}
1523
1524
An example of two sub figures is shown in \cref{fig:two_sub_figures}.
1525
1526
\begin{ltgexample}
1527
\begin{figure}[!b]
1528
\centering
1529
\subfloat[Case I]{\includegraphics[width=.4\linewidth]{example-image-a}%
1530
\label{fig:first_case}}
1531
\hfil
1532
\subfloat[Case II]{\includegraphics[width=.4\linewidth]{example-image-b}%
1533
\label{fig:second_case}}
1534
\caption{Example figure with two sub figures.}
1535
\label{fig:two_sub_figures}
1536
\end{figure}
1537
\end{ltgexample}
1538
1539
\section{Tables}
1540
1541
\begin{ltgexample}
1542
\begin{table}
1543
\caption{Simple Table}
1544
\label{tab:simple}
1545
\centering
1546
\begin{tabular}{ll}
1547
\toprule
1548
Heading1 & Heading2 \\
1549
\midrule
1550
One & Two \\
1551
Thee & Four \\
1552
\bottomrule
1553
\end{tabular}
1554
\end{table}
1555
\end{ltgexample}
1556
1557
\begin{ltgexample}
1558
% Source: https://tex.stackexchange.com/a/468994/9075
1559
\begin{table}
1560
\caption{Table with diagonal line}
1561
\label{tab:diag}
1562
\begin{center}
1563
\begin{tabular}{|l|c|c|}
1564
\hline
1565
\diagbox[width=10em]{Diag \\Column Head I}{Diag Column\\Head II} & Second & Third \\
1566
\hline
1567
& foo & bar \\
1568
\hline
1569
\end{tabular}
1570
\end{center}
1571
\end{table}
1572
\end{ltgexample}
1573
1574
1575
\section{Quellcode}
1576
1577
\begin{ltgexample}
1578
\Cref{lst:XML} zeigt XML-Quelltext.
1579
\Cref{line:comment} enthält einen Kommentar.
1580
1581
\begin{lstlisting}[
1582
language=XML,
1583
caption={Beispiel-XML-Listing},
1584
label={lst:XML}]
1585
<listing name="example">
1586
<!-- comment --> (* \label{line:comment} *)
1587
<content>not interesting</content>
1588
</listing>
1589
\end{lstlisting}
1590
\end{ltgexample}
1591
1592
Der zusätzliche Paramter \verb+float+ führt dazu, dass das Listing auch floated.
1593
\Cref{lst:flXML} zeigt das gleitendede Listing.
1594
1595
\begin{ltgexample}
1596
\begin{lstlisting}[
1597
% Es ist möglcih, die Abstände bei Bedarf einzustellen
1598
% aboveskip=2.5\baselineskip,
1599
% belowskip=-.8\baselineskip,
1600
float,
1601
language=XML,
1602
caption={Beispiel-XML-Listing -- gleitend},
1603
label={lst:flXML}]
1604
<listing name="example">
1605
Floating
1606
</listing>
1607
\end{lstlisting}
1608
\end{ltgexample}
1609
1610
Es ist möglich auch JSON zu setzen, wie in \cref{lst:json} gezeigt.
1611
1612
\begin{ltgexample}
1613
\begin{lstlisting}[
1614
float,
1615
language=json,
1616
caption={Beispiel-JSON-listing},
1617
label={lst:json}]
1618
{
1619
key: "value"
1620
}
1621
\end{lstlisting}
1622
\end{ltgexample}
1623
1624
Java ist auch möglich -- \cref{lst:java}.
1625
1626
\begin{ltgexample}
1627
\begin{lstlisting}[
1628
caption={Example Java listing},
1629
label=lst:java,
1630
language=Java,
1631
float]
1632
public class Hello {
1633
public static void main (String[] args) {
1634
System.out.println("Hello World!");
1635
}
1636
}
1637
\end{lstlisting}
1638
\end{ltgexample}
1639
1640
\section{Itemization}
1641
1642
One can list items as follows:
1643
1644
\begin{ltgexample}
1645
\begin{itemize}
1646
\item Item One
1647
\item Item Two
1648
\end{itemize}
1649
\end{ltgexample}
1650
1651
With the package paralist, one can create itemizations with lesser spacing:
1652
1653
\begin{ltgexample}
1654
\begin{compactitem}
1655
\item Item One
1656
\item Item Two
1657
\end{compactitem}
1658
\end{ltgexample}
1659
1660
One can enumerate items as follows:
1661
1662
\begin{ltgexample}
1663
\begin{enumerate}
1664
\item Item One
1665
\item Item Two
1666
\end{enumerate}
1667
\end{ltgexample}
1668
1669
With the package paralist, one can create enumerations with lesser spacing:
1670
1671
\begin{ltgexample}
1672
\begin{compactenum}
1673
\item Item One
1674
\item Item Two
1675
\end{compactenum}
1676
\end{ltgexample}
1677
1678
With paralist, one can even have all items typeset after each other and have them clean in the TeX document:
1679
1680
\begin{ltgexample}
1681
\begin{inparaenum}
1682
\item All these items...
1683
\item ...appear in one line
1684
\item This is enabled by the paralist package.
1685
\end{inparaenum}
1686
\end{ltgexample}
1687
1688
\section{Abkürzungen}
1689
1690
Mit \verb+\gls{...}+ können Abkürzungen eingebaut werden, beim ersten Aufrufen wird die lange Form eingesetzt.
1691
Beim wiederholten Verwenden von \verb+\gls{...}+ wird automatisch die Kurzform angezeigt.
1692
Außerdem wird die Abkürzung automatisch in die Abkürzungsliste eingefügt.
1693
Mit \verb+\glspl{...}+ wird die Pluralform verwendet.
1694
Möchte man, dass bei der ersten Verwendung direkt die Kurzform erscheint, so kann man mit \verb+\glsunset{...}+ eine Abkürzung als bereits verwendet markieren.
1695
Das Gegenteil erreicht man mit \verb+\glsreset{...}+.
1696
1697
Definiert werden Abkürzungen in der Datei \textit{abbreviationstex} mithilfe von \verb+\newacronym{...}{...}{...}+.
1698
1699
Mehr Infos unter: \url{https://ctan.org/pkg/bib2gls}.
1700
1701
\begin{ltgexample}
1702
Beim ersten Durchlauf betrug die \gls{fr} 5.
1703
Beim zweiten Durchlauf war die \gls{fr} 3.
1704
Die Pluralform sieht man hier: \glspl{er}.
1705
Um zu demonstrieren, wie das Abkürzungsverzeichnis bei längeren Beschreibungstexten aussieht, muss hier noch \glspl{rdbms} erwähnt werden.
1706
1707
\gls{dante} is a local \TeX\ user group.
1708
The German-speaking local \TeX\ user group is \gls{dante}.
1709
A \gls{gp} is a medical doctor.
1710
I went to my surgery to see the \gls{gp}.
1711
\end{ltgexample}
1712
1713
\section{Other Features}
1714
1715
\begin{ltgexample}
1716
The words \enquote{workflow} and \enquote{dwarflike} can be copied from the PDF and pasted to a text file.
1717
\end{ltgexample}
1718
1719
\begin{ltgexample}
1720
The symbol for powerset is now correct: $\powerset$ and not a Weierstrass p ($\wp$).
1721
1722
$\powerset({1,2,3})$
1723
\end{ltgexample}
1724
1725
\begin{ltgexample}
1726
Brackets work as designed:
1727
<test>
1728
One can also input backticks in verbatim text: \verb|`test`|.
1729
\end{ltgexample}
1730
1731
1732
\section{Varioref examples}
1733
\label{sec:ex:vref}
1734
1735
Varioref demonstration: Vref at beginning of sentence, vref in all other cases.
1736
1737
\begin{ltgexample}
1738
\Vref{fig:ex:cref} shows a simple fact, although \vref{fig:ex:cref} could also show something else.
1739
1740
\Vref{tab:ex:cref} shows a simple fact, although \vref{tab:ex:cref} could also show something else.
1741
1742
\Vref{sec:ex:cref} shows a simple fact, although \vref{sec:ex:cref} could also show something else.
1743
\end{ltgexample}
1744
1745
\section{Citations}
1746
1747
When referencing something from the bibliography file, it will automatically appear in the references section.
1748
If a reference is not cited, it is not appearing there.
1749
1750
\begin{ltgexample}
1751
Standard case: Citing indirectly citing something~\cite{mwe}.
1752
In case one wants to name the author: \textcite{mwe} shows a minimal \LaTeX{} example.
1753
\end{ltgexample}
1754
1755
Note that \texttt{\textbackslash textcite\{mwe\}} prints both the author and the reference to the bibliography entry.
1756
1757
Remember that you have to call \texttt{biber main-german} to generate the bibliography data for \texttt{lualatex}.
1758
You will need to run \texttt{lualatex} twice to ensure that the page numbers are updated correctly.
1759
1760
1761
In the bibliography, use \texttt{\textbackslash textsuperscript} for \enquote{st}, \enquote{nd}, \ldots:
1762
E.g., \enquote{The 2\textsuperscript{nd} conference on examples}.
1763
When you use \href{https://www.jabref.org}{JabRef}, you can use the clean up command to achieve that.
1764
See \url{https://help.jabref.org/en/CleanupEntries} for an overview of the cleanup functionality.
1765
1766
\section{Miscellaneous Examles}
1767
\label{ssec:example}
1768
1769
Referencetest: \Cref{ssec:example}, \cref{fig:Abbildung} und \cref{alg:example}.
1770
1771
\begin{ltgexample}
1772
Checkmark: \dingcheck.
1773
Crossmark: \dingcross.
1774
\end{ltgexample}
1775
1776
\begin{figure}
1777
\missingfigure{}
1778
\caption{Abbildung}
1779
\label{fig:Abbildung}
1780
\end{figure}
1781
1782
\begin{landscape}
1783
\begin{figure}
1784
\missingfigure{}
1785
\caption{Gedrehte Abbildung}
1786
\label{fig:AbbildungGedreht}
1787
\end{figure}
1788
\end{landscape}
1789
1790
\subsection{Algorithmen}
1791
1792
\begin{algorithm}
1793
\caption{$algo$}
1794
\label{alg:example}
1795
\begin{algorithmic}[1]
1796
\State $a \gets 0$
1797
\State State 2\label{alg1:state2}
1798
\end{algorithmic}
1799
\end{algorithm}
1800
1801
\begin{algorithm}
1802
\caption{Algorithmus 2}
1803
\label{alg:example2}
1804
\begin{algorithmic}[1]
1805
\State $a \gets 0$
1806
\State State 2\label{alg2:state2}
1807
\end{algorithmic}
1808
\end{algorithm}
1809
1810
\Cref{alg:example} hat bereits einen Algorithmus gezeigt.
1811
Test der Zeilenreferenzierung: Zeile~\ref{alg1:state2} (\cref{alg:example}) und Zeile~\ref{alg2:state2} (\cref{alg:example2}).
1812
1813
\subsection{Definitionen}
1814
\begin{definition}[Title]
1815
\label{def:def1}
1816
Definition Text
1817
\end{definition}
1818
1819
\Cref{def:def1} zeigt \ldots
1820
1821
\subsection{Aufzählungen}
1822
1823
\begin{enumerate}[label=\alph*)]
1824
\item a
1825
\item b
1826
\item c
1827
\item d
1828
\end{enumerate}
1829
1830
Equivalent to paralist's inparaenum:
1831
\begin{enumerate*}[label=\alph*)]
1832
\item a
1833
\item b
1834
\item c
1835
\item d
1836
\end{enumerate*}
1837
1838
\begin{description}
1839
\item[first] Erstens
1840
\item[second] Zweitens
1841
\item[third] Drittens
1842
\end{description}
1843
1844
\begin{description}
1845
\item[\texttt{first}] Erstens
1846
\item[\texttt{second}] Zweitens
1847
\item[\texttt{third}] Drittens
1848
\end{description}
1849
1850
%works only if package enumitem is loaded
1851
\begin{description}[font=\ttfamily]
1852
\item[first] Erstens
1853
\item[second] Zweitens
1854
\item[third] Drittens
1855
\end{description}
1856
1857
\begin{description}[style=unboxed]
1858
\item[first label with a long description text breaking over one line. Enabled by enumitem package] Erstens
1859
\item[second] Zweitens
1860
\item[third] Drittens
1861
\end{description}
1862
1863
\begin{Description}
1864
\item[first label with a long description text breaking over one line. Defined in template.tex] Erstens
1865
\item[second] Zweitens
1866
\item[third] Drittens
1867
\end{Description}
1868
1869
\begin{itemize}
1870
\item Erstens
1871
\item Zweitens
1872
\item Drittens
1873
\end{itemize}
1874
1875
Optionaler Parameter ändert den Marker, der vorangestellt ist.
1876
Siehe \url{http://www.weinelt.de/latex/item.html}.
1877
\begin{itemize}
1878
\item[A] Erstens
1879
\item[B] Zweitens
1880
\item[C] Drittens
1881
\end{itemize}
1882
1883
Falsche Benutzung des optionalen Parameters wie folgt:
1884
\begin{itemize}
1885
\item[first] Erstens
1886
\item[second] Zweitens
1887
\item[third] Drittens
1888
\end{itemize}
1889
Dabei ist zu beachten, dass es sich bei Einbindung von \texttt{enumitem} anders verhält als bei \texttt{paralist}.
1890
1891
\subsection{fquote}
1892
1893
\begin{fquote}[T.\ Informatiker]
1894
Bis nächsten Freitag ist das Programm fertig.
1895
\end{fquote}
1896
1897
\begin{gfquote}{T.\ Informatiker}
1898
Bis nächsten Freitag ist das Programm fertig.
1899
\end{gfquote}
1900
1901
%%% ===============================================================================
1902
\chapter{Zusammenfassung und Ausblick}\label{sec:conclusion}
1903
%%% ===============================================================================
1904
1905
Your conclusions are not just a factual summary of your work, but they position, interpret, and defend your findings against the state of the art that you discussed in \cref{sec:introduction:state-of-art}.
1906
You specifically outline which concrete findings or methodological contributions advance our knowledge towards the general objective you introduced in \cref{sec:introduction:topic}.
1907
Objectively discuss which parts you solved and in which parts you failed.
1908
1909
You should explicitly discuss limitations and shortcomings of your work and detail what kind of future studies are needed to overcome these limitations.
1910
Be specific in the sense that your arguments for future work should be based on concrete findings and insights you obtained in your report.
1911
1912
1913
%%% ===============================================================================
1914
%%% Bibliography
1915
%%% ===============================================================================
1916
1917
1918
\printbibliography
1919
1920
% Enfore empty line after bibliography
1921
\ \\
1922
%
1923
\noindent
1924
Alle Links wurden zuletzt am 29.03.2021 geprüft.
1925
1926
%%% ===============================================================================
1927
1928
%\IfDefined{printindex}{\printindex}
1929
%\IfDefined{printnomenclature}{\printnomenclature}
1930
1931
\clearpage
1932
\appendix
1933
% 'Anhang' ins Inhaltsverzeichnis
1934
%\phantomsection
1935
%\addcontentsline{toc}{chapter}{Anhang}
1936
\addcontentsline{toc}{part}{Anhang}
1937
1938
%%% ===============================================================================
1939
\chapter{My first appendix}\label{sec:appendix1}
1940
%%% ===============================================================================
1941
1942
\lipsum[1]
1943
1944
\pagestyle{empty}
1945
\renewcommand*{\chapterpagestyle}{empty}
1946
\Versicherung
1947
\end{document}
1948
1949