Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
latextemplates
GitHub Repository: latextemplates/scientific-thesis-template
Path: blob/main/main-minted-german-university-of-hamburg.tex
431 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
\definecolor{uhhred}{cmyk}{0,100,100,0}
284
285
% See https://github.com/gpoore/minted
286
\usepackage[newfloat]{minted}
287
288
\setminted{
289
% Line numbers not flowing out of the margin
290
numbersep=5pt,
291
xleftmargin=12pt,
292
%
293
% Better listing breaking
294
breakafter=-/\{,
295
breakbefore=\\
296
%
297
% Alternative: Rely on pygment's tokenizer. Does not work well with LaTeX and comments
298
% breakbytoken=true,
299
% breakbytokenanywhere=true
300
}
301
302
%\usemintedstyle{bw} %black and white style
303
%\usemintedstyle{vs} %visual studio
304
\usemintedstyle{friendly_grayscale}
305
%\usemintedstyle{friendly}
306
%\usemintedstyle{eclipse} %http://www.jevon.org/wiki/Eclipse_Pygments_Style
307
%\usemintedstyle{autumn}
308
%\usemintedstyle{rrt}
309
%\usemintedstyle{borland}
310
311
% We need to load caption to have a bold font on the label
312
% The other parameters mimic the layout of the LNCS class
313
\usepackage[labelfont=bf,font=small,skip=4pt]{caption}
314
\SetupFloatingEnvironment{listing}{name=List.,within=none}
315
316
% When using both minted and listings
317
% Compatibility of packages minted and listings with respect to the numbering of "List." caption
318
% Source: https://tex.stackexchange.com/a/269510/9075
319
% \AtBeginEnvironment{listing}{\setcounter{listing}{\value{lstlisting}}}
320
% \AtEndEnvironment{listing}{\stepcounter{lstlisting}}
321
322
% Intermediate solution for hyperlinked refs. See https://tex.stackexchange.com/q/132420/9075 for more information.
323
\newcommand{\labelline}[1]{\label[line]{#1}\hypertarget{#1}{}}
324
\newcommand{\refline}[1]{\hyperlink{#1}{\FancyVerbLineautorefname~\ref*{#1}}}
325
326
% For easy quotations: \enquote{text}
327
% This package is very smart when nesting is applied, otherwise textcmds (see below) provides a shorter command
328
\usepackage[autostyle=true]{csquotes}
329
330
% Enable using "`quote"' - see https://tex.stackexchange.com/a/150954/9075
331
\defineshorthand{"`}{\openautoquote}
332
\defineshorthand{"'}{\closeautoquote}
333
334
% bessere Abstaende innerhalb der Tabelle (Layout))
335
% -------------------------------------------------
336
% \toprule, \midrule, \bottomrule
337
% Doc: https://texdoc.org/serve/booktabs/0
338
\usepackage{booktabs}
339
340
% Extended enumerate, such as \begin{compactenum}
341
\usepackage{paralist}
342
\usepackage[
343
backend = biber, %biber does not work with 64x versions alternative: bibtex8; minalphanames only works with biber backend
344
sortcites = true,
345
bibstyle = alphabetic,
346
citestyle = alphabetic,
347
giveninits = true,
348
useprefix = false, %"von, van, etc." will be printed, too. See below.
349
minnames = 1,
350
minalphanames = 3,
351
maxalphanames = 4,
352
maxbibnames = 99,
353
maxcitenames = 2,
354
natbib = true,
355
eprint = true,
356
url = true,
357
doi = true, %source: http://tex.stackexchange.com/a/23118/9075
358
isbn = true, %source: http://tex.stackexchange.com/a/23118/9075
359
backref = true]{biblatex}
360
361
% enable more breaks at URLs. See https://tex.stackexchange.com/a/134281.
362
\setcounter{biburllcpenalty}{7000}
363
\setcounter{biburlucpenalty}{8000}
364
365
\bibliography{bibliography}
366
%\addbibresource[datatype=bibtex]{\bibliography{bibliography}}
367
368
% Do not put "vd" in the label, but put it at "\citeauthor"
369
% Source: http://tex.stackexchange.com/a/30277/9075
370
\makeatletter
371
\AtBeginDocument{\toggletrue{blx@useprefix}}
372
\AtBeginBibliography{\togglefalse{blx@useprefix}}
373
\makeatother
374
375
% Thin spaces between initials
376
% http://tex.stackexchange.com/a/11083/9075
377
\renewrobustcmd*{\bibinitdelim}{\,}
378
379
% Keep first and last name together in the bibliography
380
% http://tex.stackexchange.com/a/196192/9075
381
\renewcommand*\bibnamedelimc{\addnbspace}
382
\renewcommand*\bibnamedelimd{\addnbspace}
383
384
% Replace last "and" by comma in bibliography
385
% See http://tex.stackexchange.com/a/41532/9075
386
\AtBeginBibliography{%
387
\renewcommand*{\finalnamedelim}{\addcomma\space}%
388
}
389
390
% enable hyperlinked author names when using \citeauthor
391
% source: http://tex.stackexchange.com/a/75916/9075
392
\DeclareCiteCommand{\citeauthor}
393
{
394
\boolfalse{citetracker}%
395
\boolfalse{pagetracker}%
396
\usebibmacro{prenote}
397
}
398
{
399
\ifciteindex
400
{\indexnames{labelname}}
401
{}%
402
\printtext[bibhyperref]{\printnames{labelname}}
403
}
404
{\multicitedelim}
405
{\usebibmacro{postnote}}
406
407
% Farbige Tabellen
408
% ----------------
409
% Das Paket colortbl wird inzwischen automatisch durch xcolor geladen
410
%
411
% Erweiterte Funktionen innerhalb von Tabellen
412
% --------------------------------------------
413
%%% Doc: http://mirror.ctan.org/tex-archive/macros/latex/contrib/multirow/multirow.sty
414
\usepackage{multirow} % Mehrfachspalten
415
%
416
%%% Doc: Documentation inside dtx Package
417
\usepackage{dcolumn} % Ausrichtung an Komma oder Punkt
418
419
%%% Doc: http://mirror.ctan.org/tex-archive/macros/latex/contrib/supertabular/supertabular.pdf
420
%\usepackage{supertabular}
421
422
%%% Fussnoten/Endnoten ===================================================
423
424
%%% Doc: http://mirror.ctan.org/tex-archive/macros/latex/contrib/footmisc/footmisc.pdf
425
%
426
\usepackage[
427
bottom, % Footnotes appear always on bottom. This is necessary specially when floats are used
428
stable, % Make footnotes stable in section titles
429
% perpage, % Reset on each page
430
% para, % Place footnotes side by side of in one paragraph.
431
% side, % Place footnotes in the margin
432
ragged, % Use RaggedRight
433
% norule, % Suppress rule above footnotes
434
multiple, % Rearrange multiple footnotes intelligent in the text.
435
% symbol, % Use symbols instead of numbers
436
]{footmisc}
437
438
\counterwithout{footnote}{chapter} % Continuous numbering of footnotes across chapters
439
440
\interfootnotelinepenalty=10000 % Verhindert das Fortsetzen von Fussnoten auf der gegenüberligenden Seite
441
442
% EN: Put footnotes below floats
443
% DE: Fußnoten unter Gleitumgebungen ("floats") platzieren
444
% Source: https://tex.stackexchange.com/a/32993/9075
445
\usepackage{stfloats}
446
\fnbelowfloat
447
448
% EN: Extended support for footnotes
449
% DE: Fußnoten
450
%
451
%\usepackage{dblfnote} %Zweispaltige Fußnoten
452
%
453
% Keine hochgestellten Ziffern in der Fußnote (KOMA-Script-spezifisch):
454
%\deffootnote[1.5em]{0pt}{1em}{\makebox[1.5em][l]{\bfseries\thefootnotemark}}
455
%
456
% Abstand zwischen Fußnoten vergrößern:
457
%\setlength{\footnotesep}{.85\baselineskip}
458
%
459
% EN: Following command disables the separting line of the footnote
460
% DE: Folgendes Kommando deaktiviert die Trennlinie zur Fußnote
461
%\renewcommand{\footnoterule}{}
462
%
463
%\addtolength{\skip\footins}{\baselineskip} % Abstand Text <-> Fußnote
464
465
% DE: Fußnoten immer ganz unten auf einer \raggedbottom-Seite
466
% DE: fnpos kommt aus dem yafoot package
467
%\usepackage{fnpos}
468
%\makeFNbelow
469
%\makeFNbottom
470
471
% TODO (and comment) configuration
472
%
473
% - \todo (from todo, easy-todo, todonotes) / \TODO (from fixmetodonotes) - for "normal" TODOs
474
% - \todofix - "important" TODOs
475
%
476
% - \textcomment - highlights text and has a hover comment
477
% - \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)
478
%
479
% - \missingfigure
480
%
481
% - \textmarker
482
% - \modified
483
% - \change - adresses a review comment
484
485
% Enable nice comments
486
\usepackage{pdfcomment}
487
488
\newcommand{\textcomment}[2]{\colorbox{yellow!60}{#1}\pdfcomment[color={0.234 0.867 0.211},hoffset=-6pt,voffset=10pt,opacity=0.5]{#2}}
489
490
% Small PDF comment
491
% 1. Parameter: Comment
492
\newcommand{\sidecomment}[1]{\pdfcomment[color={0.045 0.278 0.643},voffset=4pt,icon=Note]{#1}}
493
% Disabled variant - for the final PDF
494
%\newcommand{\sidecomment}[1]{}
495
496
\newcommand{\todo}[1]{TODO!\sidecomment{#1}}
497
498
% Änderungen
499
%
500
% 1. Parameter: Review-Kommentar
501
% 2. Parameter: Neuer Text
502
\newcommand{\change}[2]{{\color{red}#2}\pdfcomment[color={0.234 0.867 0.211},voffset=8pt,opacity=0.5]{#1}}
503
% Disabled variant - for the final PDF
504
%\newcommand{\change}[2]{#2}
505
506
% Define default commands
507
\makeatletter
508
\@ifundefined{missingfigure}{\newcommand{\missingfigure}{... missing figure ...}}{}
509
\@ifundefined{textcomment}{\newcommand{\textcomment}[2]{#1 \todo{#2}}}{}
510
\@ifundefined{sidecomment}{\newcommand{\sidecomment}[1]{\marginpar{#1}}}{}
511
\@ifundefined{todo}{\newcommand{\todo}[1]{\sidecomment{#1}}}{}
512
\@ifundefined{TODO}{\newcommand{\TODO}[1]{\todo{#1}}}{}
513
\@ifundefined{todofix}{\newcommand{\todofix}[1]{\todo{#1}}}{}
514
\@ifundefined{change}{\newcommand{\change}[2]{#1 $\rightarrow$ #2}}{}
515
\makeatother
516
517
% Textmarker (Textfarbe rot)
518
\newcommand{\textmarker}[1]{{\color{red} #1}\xspace}
519
520
% Modified (Text blau)
521
\newcommand{\modified}[1]{{\color{blue!60!black} #1}\xspace}
522
523
\usepackage[group-minimum-digits=4,per-mode=fraction]{siunitx}
524
\addto\extrasgerman{\sisetup{locale = DE}}
525
526
% See http://tex.stackexchange.com/a/83051/9075
527
% Normally, doesn't work with hyperref, but cleveref fixes that
528
\usepackage[ngerman]{varioref}
529
530
531
% 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
532
\usepackage{hyperref}
533
534
% Enable hyperref without colors and without bookmarks
535
\hypersetup{
536
hidelinks,
537
colorlinks=true, % Links erhalten Farben statt Kaeten
538
raiselinks=true, % calculate real height of the link
539
allcolors=black,
540
pdfstartview=Fit,
541
breaklinks=true, % Links ueberstehen Zeilenumbruch
542
hypertexnames=false, % Fix jumping to algorithm line - http://tex.stackexchange.com/a/156404/9075
543
}
544
545
% Enable correct jumping to figures when referencing
546
\usepackage[all]{hypcap}
547
548
% Hint by https://tex.stackexchange.com/a/193370/9075 to suppress strange outputs of the babel package
549
% Example strange output: Package babel Info: Redefining ngerman shorthand "|
550
\usepackage{etoolbox}
551
\makeatletter
552
\patchcmd{\@decl@short}{\bbl@info}{\@gobble}{}{}
553
\makeatother
554
555
556
%%%
557
% Ermoeglicht es, Abbildungen um 90 Grad zu drehen
558
% Alternatives Paket: rotating Allerdings wird hier nur das Bild gedreht, während bei lscape auch die PDF-Seite gedreht wird.
559
%Das Paket lscape dreht die Seite auch nicht
560
\usepackage{pdflscape}
561
562
\usepackage[caption=false,font=footnotesize]{subfig}
563
564
% Alternative for making subfigures:
565
% Part of the caption package. See http://www.ctan.org/pkg/caption
566
% Ersetzt die Pakete subfigure und subfig - siehe https://tex.stackexchange.com/a/13778/9075
567
%
568
% (subfigure is outdated. subfig is maintained, but subcaption is better)
569
% See: http://tex.stackexchange.com/questions/13625/subcaption-vs-subfig-best-package-for-referencing-a-subfigure
570
%\usepackage[hypcap=true]{subcaption}
571
572
\usepackage{mindflow}
573
574
% https://ctan.org/pkg/algorithms
575
% Consists of two environments: algorithm and algorithmic
576
% Although oudated, it defines the "algorithm" float enviornment
577
% TODO: Define floating environment "algorithm" in other ways
578
\usepackage[chapter]{algorithm}
579
580
% https://ctan.org/pkg/algpseudocodex
581
% Successor of algorithmicx; more modern than https://ctan.org/pkg/algorithms
582
\usepackage{algpseudocodex}
583
584
\floatname{algorithm}{Algorithmus}
585
\renewcommand{\listalgorithmname}{Algorithmenverzeichnis}
586
587
\newcommand{\commentchar}{\ensuremath{/\mkern-4mu/}}
588
\algrenewcommand{\algorithmiccomment}[1]{\hfill $\commentchar$ #1}
589
590
% cleveref für cref statt autoref, da cleveref auch bei Definitionen funktioniert
591
\usepackage[capitalise,nameinlink,noabbrev]{cleveref}
592
593
\crefname{table}{Tabelle}{Tabellen}
594
\Crefname{table}{Tabelle}{Tabellen}
595
\crefname{figure}{Abbildung}{Abbildungen}
596
\Crefname{figure}{Abbildung}{Abbildungen}
597
\crefname{equation}{Gleichung}{Gleichungen}
598
\Crefname{equation}{Gleichung}{Gleichungen}
599
\crefname{theorem}{Theorem}{Theoreme}
600
\Crefname{theorem}{Theorem}{Theoreme}
601
\crefname{listing}{Listing}{Listings}
602
\Crefname{listing}{Listing}{Listings}
603
\crefname{section}{Abschnitt}{Abschnitte}
604
\Crefname{section}{Abschnitt}{Abschnitte}
605
\crefname{paragraph}{Abschnitt}{Abschnitte}
606
\Crefname{paragraph}{Abschnitt}{Abschnitte}
607
\crefname{subparagraph}{Abschnitt}{Abschnitte}
608
\Crefname{subparagraph}{Abschnitt}{Abschnitte}
609
610
% Intermediate solution for hyperlinked refs. See https://tex.stackexchange.com/q/132420/9075 for more information.
611
\newcommand{\llabel}[1]{\label[line]{#1}\hypertarget{#1}{}}
612
\newcommand{\lref}[1]{\hyperlink{#1}{\FancyVerbLineautorefname~\ref*{#1}}}
613
614
\usepackage{lipsum}
615
616
% For demonstration purposes only
617
% These packages can be removed when all examples have been deleted
618
\usepackage[math]{blindtext}
619
\usepackage{mwe}
620
\usepackage[realmainfile]{currfile}
621
\usepackage{tcolorbox}
622
\tcbuselibrary{minted}
623
624
%introduce \powerset - hint by http://matheplanet.com/matheplanet/nuke/html/viewtopic.php?topic=136492&post_id=997377
625
\DeclareFontFamily{U}{MnSymbolC}{}
626
\DeclareSymbolFont{MnSyC}{U}{MnSymbolC}{m}{n}
627
\DeclareFontShape{U}{MnSymbolC}{m}{n}{
628
<-6> MnSymbolC5
629
<6-7> MnSymbolC6
630
<7-8> MnSymbolC7
631
<8-9> MnSymbolC8
632
<9-10> MnSymbolC9
633
<10-12> MnSymbolC10
634
<12-> MnSymbolC12%
635
}{}
636
\DeclareMathSymbol{\powerset}{\mathord}{MnSyC}{180}
637
638
\addto\captionsngerman{%
639
\renewcommand*{\glossaryname}{Bedeutung}%
640
}
641
\usepackage[
642
translate=babel,
643
abbreviations, % create "abbreviations" glossary
644
nomain, % don't create "main" glossary
645
stylemods=longbooktabs % do the adjustments for the longbooktabs styles
646
]{glossaries-extra}
647
\setglossarystyle{long3col-booktabs}
648
649
% Hint by https://tex.stackexchange.com/a/463188/9075
650
% \usepackage{glossary-longextra}
651
652
% Following is required if the abbreviation list should be sorted automatically (\printglossary / \printglossaries)
653
% Not required, if we printed the entries in-order (using \printunsrtglossaries)
654
% Required to have the German chapter name % Source: https://tex.stackexchange.com/a/426392/9075
655
\makeglossaries
656
657
\input{abbreviations}
658
659
660
\usepackage{xspace}
661
% Macht \xspace und \enquote kompatibel
662
\makeatletter
663
\xspaceaddexceptions{\grqq \grq \csq@qclose@i \} }
664
\makeatother
665
666
% Enable hyphenation at other places as the dash.
667
% Example: applicaiton\hydash specific
668
\makeatletter
669
\newcommand{\hydash}{\penalty\@M-\hskip\z@skip}
670
% Definition of "= taken from http://mirror.ctan.org/macros/latex/contrib/babel-contrib/german/ngermanb.dtx
671
\makeatother
672
673
\ifluatex
674
% Enable correct rendering of ligatures - provided by https://ctan.org/pkg/autotype
675
% See ADR-0008 for alternatives
676
\usepackage{autotype}
677
\fi
678
679
% correct bad hyphenation here
680
\hyphenation{
681
Spe-zi-fi-ka-tion
682
In-te-gra-tion
683
An-for-de-rung An-for-de-run-gen
684
Be-nut-zer-ober-flä-che
685
Mes-sung-en
686
aus-zu-tau-schen
687
Lauf-zeit-in-for-ma-tionen
688
% May not be hypphenated
689
AROMA TOSCA BPMN OASIS OMG DMTF IT DevOps
690
}
691
692
\input{commands}
693
694
\usepackage{geometry}
695
% Package URL: https://ctan.org/pkg/scientific-thesis-cover
696
\usepackage[
697
title={Is Oil the future?},
698
author={Lars K.},
699
type=bachelor,
700
institute=iaas, % or other institute names - or just a plain string using {Demo\\Demo...}
701
course={Medieninformatik},
702
examiner={Prof.\ Dr.\ Uwe Fessor},
703
supervisor={Dipl.-Inf.\ Roman Tiker,\\Dipl.-Inf.\ Laura Stern,\\Otto Normalverbraucher,\ M.Sc.},
704
startdate={July 5, 2018},
705
enddate={January 5, 2019}
706
]{scientific-thesis-cover}
707
708
709
\ifpdftex
710
% Enable copy and paste of text from the PDF
711
% Only required for pdflatex. It "just works" in the case of lualatex.
712
% Alternative: cmap or mmap package
713
% mmap enables mathematical symbols, but does not work with the newtx font set
714
% See: https://tex.stackexchange.com/a/64457/9075
715
% 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
716
% Trouble shooting outlined at https://tex.stackexchange.com/a/100618/9075
717
%
718
% According to https://tex.stackexchange.com/q/451235/9075 this is the way to go
719
\input{glyphtounicode}
720
\pdfgentounicode=1
721
\fi
722
% DM: line-breaking-description env vom daniel w.
723
724
% credit goes to daniel w. :-)
725
%% --- Descriptions with line breaks in labels ---------------------------------
726
\usepackage{calc}
727
728
\newcommand*\Descriptionlabel[1]{%
729
\raisebox{0pt}[1ex][0pt]{
730
\makebox[\labelwidth][1]{
731
\parbox[t]{\labelwidth}{
732
\hspace{0pt}\textbf{#1:}}}}
733
}
734
735
\newcommand*\Descriptionlabelx[1]{%
736
\parbox[t]{\textwidth}{
737
\textbf{#1}\\\mbox{}}
738
}
739
740
\newenvironment{Description}{
741
\begin{list}{}{
742
\let\makelabel\Descriptionlabelx
743
\setlength\labelwidth{1em}
744
\setlength\leftmargin{\labelwidth+\labelsep}
745
}
746
}
747
{
748
\end{list}
749
}
750
751
% globally change line spacing of lists
752
% paralist has suspended development since 10 years.
753
% enumitem has been updated 2011-09-28
754
\usepackage[inline]{enumitem}
755
\setlist{partopsep=0pt,itemsep=1pt}
756
757
%------------------------------------------------------------------------
758
% fquote Fancy Quotation environment
759
% supports empty/optional author
760
761
% Use \sloppy to make right-margin easier?
762
% Set picture units to be relative to font size (em)?
763
% Use begingroup to rest units afterwards?
764
765
\usepackage{xifthen}% provides \isempty test
766
\definecolor{quotemark}{gray}{0.7}
767
768
%fquote environment with author as optional parameter
769
%usage: \begin{fquote}quote\end{fquote} or \begin{fquote}[Author]quote\end{fquote}
770
\newenvironment{fquote}[1][]{%
771
\newcommand{\fqauthor}{\relax}
772
\ifthenelse{\isempty{#1}}
773
{}% do nothing
774
{\renewcommand{\fqauthor}{\hfill\textsc{--- #1}}}
775
\vspace{1em}
776
\begin{list}{}{%
777
\setlength{\leftmargin}{0.2\textwidth}
778
\setlength{\rightmargin}{0.2\textwidth}
779
}
780
\item[]%
781
\begin{picture}(0,0)(0,0)
782
\put(-15,-5){\makebox(0,0){%
783
\scalebox{4.5}{\textcolor{quotemark}{\bfseries``}}}%
784
}
785
\end{picture}\em\ignorespaces%
786
}{%
787
\newline%
788
\makebox[0pt][l]{\hspace{0.6\textwidth}%
789
\begin{picture}(0,0)(0,0)
790
\put(15,10){\makebox(0,0){%
791
\scalebox{4.5}{\textcolor{quotemark}{\rmfamily\bfseries''}}}%
792
}
793
\end{picture}}%
794
\fqauthor
795
\end{list}
796
}
797
798
%German fquote
799
% 1 parameter for the author's name, may be empty ("{}")
800
% guaranteed German quotes (works with lualatex and babel package)
801
% usage: \begin{gfquote}{Author}quote\end{gfquote}
802
\newenvironment{gfquote}[1]{%
803
\newcommand{\fqauthor}{\relax}
804
\ifthenelse{\isempty{#1}}
805
{}% do nothing
806
{\renewcommand{\fqauthor}{\hfill\textsc{\textemdash #1}}}
807
\vspace{1em}
808
\begin{list}{}{%
809
\setlength{\leftmargin}{0.2\textwidth}
810
\setlength{\rightmargin}{0.2\textwidth}
811
}
812
\item[]%
813
\begin{picture}(0,0)(0,0)
814
\put(-15,-5){\makebox(0,0){%
815
\scalebox{4.5}{\textcolor{quotemark}{\bfseries \glqq}}}%
816
}
817
\end{picture}\em\ignorespaces%
818
}{%
819
\newline%
820
\makebox[0pt][l]{\hspace{0.6\textwidth}%
821
\begin{picture}(0,0)(0,0)
822
\put(15,10){\makebox(0,0){%
823
\scalebox{4.5}{\textcolor{quotemark}{\rmfamily\bfseries \grqq}}}%
824
}
825
\end{picture}}%
826
\fqauthor
827
\end{list}
828
}
829
830
% fix incompatibilities between KOMA and other packages, mainly float.
831
% should be loaded at the very end - see http://tex.stackexchange.com/a/156256/9075
832
\usepackage{scrhack}
833
834
835
\begin{document}
836
\raggedbottom % Variable Seitenhoehen zulassen
837
\ifluatex
838
% Enable correct rendering of ligatures - provided by https://ctan.org/pkg/autotype
839
% See ADR-0008 for alternatives
840
\autotypelangoptions{ngerman}{ligbreak}
841
\fi
842
843
\pagenumbering{arabic}
844
\frontmatter
845
\newgeometry{centering,left=2cm,right=2cm,top=2cm,bottom=2cm}
846
\begin{titlepage}
847
%\includegraphics[scale=0.3]{figures/UHH-Logo_2010_Farbe_CMYK.pdf}
848
\includegraphics[scale=0.3]{figures/UHH-Logo_2010_Farbe_CMYK.png}
849
\vspace*{2cm}
850
\Large
851
\begin{center}
852
{\color{uhhred}\textbf{\so{BACHELORTHESIS}}}
853
%TODO ...oder {\color{uhhred}\textbf{\so{MASTERTHESIS}}}
854
\vspace*{2.0cm}\\
855
{\LARGE \textbf{Titel}}
856
\vspace*{2.0cm}\\
857
vorgelegt von
858
\vspace*{0.4cm}\\
859
Max Musterstudent
860
\end{center}
861
\vfill
862
863
\noindent
864
{\small
865
MIN-Fakultät\\[.2cm]
866
Fachbereich Informatik \\[.2cm]
867
Ggf. Professur/Institut \\[.2cm] %TODO Optional, entweder "Ggf. " oder ganze Zeile löschen
868
Studiengang: Wirtschaftsinformatik \\[.2cm]
869
Matrikelnummer: 1234567 \\[.5cm]
870
Ggf. Abgabedatum: XX.XX.20XX \\[.5cm] %TODO Optional, entweder "Ggf. " oder ganze Zeile löschen
871
Erstgutachterin: Prof. Dr. Bertha Beispiel \\[.25cm]
872
Zweitgutachter: Dr. Eduard Exempel %TODO Bei Bedarf Geschlechter der Gutachter/innen anpassen
873
}
874
\end{titlepage}
875
876
\restoregeometry
877
878
\pagestyle{plain.scrheadings}
879
\renewcommand*{\chapterpagestyle}{plain.scrheadings}
880
881
% Kurzfassung / abstract
882
% auch im Stil vom Inhaltsverzeichnis
883
\section*{Kurzfassung}
884
% Silbentrennung auf Englisch
885
\begin{otherlanguage}{american}
886
\emph{Write an abstract for your work.
887
Replace each of the points below with one sentence (two if you must) and you have your abstract.
888
Write it when you finished your entire report.
889
\footnote{https://www.easterbrook.ca/steve/2010/01/how-to-write-a-scientific-abstract-in-six-easy-steps/}}
890
891
\emph{Introduction.}
892
In one sentence, what’s the topic?
893
Phrase it in a way that your reader will understand.
894
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.
895
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.
896
897
\emph{State the problem you tackle.}
898
What’s the key research question?
899
Again, in one sentence.
900
(Note: For a more general essay, I’d adjust this slightly to state the central question that you want to address)
901
Remember, your first sentence introduced the overall topic, so now you can build on that, and focus on one key question within that topic.
902
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.
903
Keep working at this step until you have a single, concise (and understandable) question.
904
905
\emph{Summarize (in one sentence) why nobody else has adequately answered the research question yet.}
906
For a PhD thesis, you’ll have an entire chapter, covering what’s been done previously in the literature.
907
Here you have to boil that down to one sentence.
908
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).
909
But here you’re phrasing it in such a way that it’s clear it’s a gap in the literature.
910
So use a phrase such as “previous work has failed to address.
911
(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)
912
913
\emph{Explain, in one sentence, how you tackled the research question.}
914
What’s your big new idea?
915
(Again for a more general essay, you might want to adapt this slightly: what’s the new perspective you have adopted? or:
916
What’s your overall view on the question you introduced in step 2?)
917
918
\emph{In one sentence, how did you go about doing the research that follows from your big idea.}
919
Did you run experiments?
920
Build a piece of software?
921
Carry out case studies?
922
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.
923
But don’t overdo it we’re still looking for a sentence that you could read aloud without having to stop for breath.
924
Remember, the word ‘abstract means a summary of the main ideas with most of the detail left out.
925
So feel free to omit detail!
926
(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).
927
928
\emph{As a single sentence, what’s the key impact of your research?
929
Here we’re not looking for the outcome of an experiment.
930
}
931
We’re looking for a summary of the implications.
932
What’s it all mean?
933
Why should other people care?
934
What can they do with your research.
935
(Essay folks: all the same questions apply: what conclusions did you draw, and why would anyone care about them?)
936
\end{otherlanguage}
937
938
\microtypesetup{protrusion=false}
939
940
% In case you have trouble with headings reaching into the page numbers, enable the following three lines.
941
% Hint by http://golatex.de/inhaltsverzeichnis-schreibt-ueber-rand-t3106.html
942
%
943
%\makeatletter
944
%\renewcommand{\@pnumwidth}{2em}
945
%\makeatother
946
%
947
% Bei einem ungünstigen Seitenumbruch im Inhaltsverzeichnis, kann dieser mit
948
% \addtocontents{toc}{\protect\newpage}
949
% an der passenden Stelle im Fließtext erzwungen werden.
950
\tableofcontents
951
952
\listoffigures
953
954
\listoftables
955
\listoflistings
956
957
%mittels \newfloat wurde die Algorithmus-Gleitumgebung definiert.
958
%Mit folgendem Befehl werden alle floats dieses Typs ausgegeben
959
%\listof{Algorithmus}{Verzeichnis der Algorithmen}
960
%\listofalgorithms %Ist nur für Algorithmen, die mittels \begin{algorithm} umschlossen werden, nötig
961
962
% Abkürzungsverzeichnis / Acronyms / Abbreviations
963
\printglossary[type=\acronymtype,title={Abkürzungsverzeichnis}]
964
% \printglossaries
965
% \printnoidxglossaries
966
% \printunsrtglossaries cannot be used, because then no indexing happens; source: https://tex.stackexchange.com/a/287128/9075
967
968
\microtypesetup{protrusion=true}
969
970
% Headline and footline
971
\renewcommand*{\chapterpagestyle}{scrplain}
972
\pagestyle{scrheadings}
973
\mainmatter
974
975
%%% ===============================================================================
976
\chapter{Introduction}\label{sec:introduction}
977
%%% ===============================================================================
978
979
\emph{Purpose and scope of your entire report}.
980
The purpose of your entire report is to make a \emph{scientific argument using the scientific method}.
981
A scientific argument always has the following steps that all must come in this order.
982
%
983
\begin{itemize}
984
\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.
985
\item[SM2] Clearly and precisely \emph{formulate a research problem or hypothesis}.
986
\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}.
987
The method must includes steps and criteria for evaluating whether you answered your question successfully or not.
988
\item[SM4] \emph{Provide execution details} on how you followed the method in the given, specific situation.
989
\item[SM5] \emph{Report your results} by describing and summarizing your measurements.
990
You must not interpret your results.
991
\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.
992
\end{itemize}
993
%
994
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.
995
996
\emph{Purpose and scope of \cref{sec:introduction}}.
997
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.
998
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.
999
Section~\ref{sec:introduction:topic} introduces the general topic of your research.
1000
Section~\ref{sec:introduction:state-of-art} discusses the state of the art and identifies a research.
1001
Section~\ref{sec:introduction:research-question} then states the research problem to investigate.
1002
Section~\ref{sec:problem-exposition:research-method} explains the research method that was followed, possibly with execution details.
1003
Section~\ref{sec:introduction:results} then presents the results and their interpretation.
1004
Only if a reader thinks they are not convinced or they need more details to reproduce your study, they shall have to read further.
1005
The individual chapters and sections provide the details for each of the steps in your scientific argument.
1006
1007
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.
1008
.
1009
1010
\emph{Purpose and scope of the introduction paragraph to a chapter}.
1011
The paragraph you are reading above is a typical introductory paragraph to a chapter.
1012
It is a high-level summary of the chapters' topic (SM1 and SM2).
1013
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).
1014
It may close with announcing the result you obtain (SM6) but this is usually not done in the opening paragraph of the introduction.
1015
1016
% ---------------------------------------------------------------------------------
1017
\section{Context and Topic (SM1)}\label{sec:introduction:topic}
1018
% ---------------------------------------------------------------------------------
1019
1020
\emph{Purpose and scope}.
1021
You begin with providing the general scientific audience an introduction into the specific topic of your work.
1022
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'').
1023
It must be understandable by the general scientific public.
1024
Every \emph{term} with a specific meaning must be highlighted and introduced in precise language/concepts that only builds on a general scientific background.
1025
1026
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'').
1027
1028
% ---------------------------------------------------------------------------------
1029
\section{State of the Art (SM1)}\label{sec:introduction:state-of-art}
1030
% ---------------------------------------------------------------------------------
1031
1032
\emph{Purpose and scope}.
1033
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}.
1034
This introduction has to
1035
1036
\begin{itemize}
1037
\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.'')
1038
\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'')
1039
\end{itemize}
1040
1041
You have to provide citations/literature references for each of the statements and claims you are making.
1042
This section is usually a summary of the related work discussion in \cref{sec:background}.
1043
1044
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}.
1045
\emph{Stating a (knowledge) gap between a status quo and a desired situation is the \emph{first step} of a writing scientific argument.}
1046
1047
% ---------------------------------------------------------------------------------
1048
\section{Research Question (SM2)}\label{sec:introduction:research-question}
1049
% ---------------------------------------------------------------------------------
1050
1051
\emph{Purpose and scope}.
1052
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}.
1053
You usually cannot address and resolve the entire knowledge gap in your work.
1054
The purpose of this section is to clearly detail the specific part of the knowledge that you will address.
1055
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'').
1056
1057
Your general research question states
1058
\begin{itemize}
1059
\item The starting point/assumptions you are making from which your research starts (``for the given 13 genomes of female giraffes...''), and
1060
\item the final objective/solution you want to reach (``...identify the genes involved in color expression of giraffe tongues...'')
1061
\item and the evaluation criteria that will determine whether you are successful (``...that are present in at least 75\% of the studied giraffes'')
1062
\end{itemize}
1063
1064
You will usually break your general research question down into sub-research questions.
1065
You may do this here.
1066
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.
1067
1068
% ---------------------------------------------------------------------------------
1069
\section{Method or Approach (SM3, SM4)}\label{sec:introduction:method}
1070
% ---------------------------------------------------------------------------------
1071
1072
\emph{Purpose and scope}.
1073
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.
1074
It is a summary of the steps that someone else has to take in order to reproduce your steps.
1075
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).
1076
1077
The section is most readable if you give each of the steps in your method its own paragraph.
1078
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.
1079
1080
% ---------------------------------------------------------------------------------
1081
\section{Findings (SM5, SM6)}\label{sec:introduction:results}
1082
% ---------------------------------------------------------------------------------
1083
1084
\emph{Purpose and scope}.
1085
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.
1086
It is most likely a summary of your evaluation in \cref{sec:evaluation}.
1087
1088
\section*{Results (SM5)}
1089
1090
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.
1091
1092
\section*{Interpretation (SM6)}
1093
1094
You summarize your interpretation of the results and draw conclusions.
1095
State whether and to which degree the research question from \cref{sec:introduction:research-question} has been answered successfully or not.
1096
1097
Finally state briefly how much closer society and science have come in answering the general objective you outlined in \cref{sec:introduction:topic}.
1098
1099
%%% ===============================================================================
1100
\section{Background (SM1)}\label{sec:background}
1101
%%% ===============================================================================
1102
1103
\emph{Purpose and scope}.
1104
The background chapter has multiple roles.
1105
\begin{itemize}
1106
1107
\item \emph{Preliminaries.}
1108
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.
1109
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.
1110
Which concepts, terms, definitions, etc. does the student have to know?
1111
Which formulas, symbols, etc. are standard in this topic?
1112
Only introduce definitions if you actually need them in any of the subsequent chapters.
1113
1114
\item \emph{Related Work.}
1115
It has to provide a comprehensive discussion of all prior work in the area on this subject.
1116
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}.
1117
1118
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.
1119
\end{itemize}
1120
1121
%%% ===============================================================================
1122
\section{Problem Exposition (optional)}\label{sec:problem-exposition}
1123
%%% ===============================================================================
1124
1125
\emph{Purpose and scope}.
1126
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.
1127
This can include further details on the data you studied, context assumptions and requirements, etc.
1128
1129
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.
1130
A typical structure can be.
1131
1132
% ---------------------------------------------------------------------------------
1133
\section{Context/Business Understanding (SM1)}\label{sec:problem-exposition:context-understanding}
1134
% ---------------------------------------------------------------------------------
1135
1136
provide details
1137
1138
% ---------------------------------------------------------------------------------
1139
\section{Data Understanding (SM1)}\label{sec:problem-exposition:data-understanding}
1140
% ---------------------------------------------------------------------------------
1141
1142
provide details
1143
1144
% ---------------------------------------------------------------------------------
1145
\section{Detailed Research Questions (SM2)}\label{sec:problem-exposition:research-problems}
1146
% ---------------------------------------------------------------------------------
1147
1148
provide details based on \cref{sec:problem-exposition:context-understanding} and \ref{sec:problem-exposition:data-understanding}
1149
1150
% ---------------------------------------------------------------------------------
1151
\section{Detailed Method (SM3)}\label{sec:problem-exposition:research-method}
1152
% ---------------------------------------------------------------------------------
1153
1154
provide details based on \cref{sec:problem-exposition:context-understanding} and \ref{sec:problem-exposition:data-understanding}
1155
1156
%%% ===============================================================================
1157
\section{First Real Chapter addressing first Research Problem}\label{sec:problem1}
1158
%%% ===============================================================================
1159
1160
\emph{Purpose and scope}.
1161
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).
1162
You usually do this by addressing various sub-problems again through scientific arguments following the 6 steps SM1-SM6.
1163
1164
Have a short chapter introduction that recalls and explains the first research problem of your thesis.
1165
The problem has to show up in the introduction in \cref{sec:introduction:research-question} or in \cref{sec:problem-exposition:research-problems} already.
1166
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.
1167
1168
Next, explain in the chapter intro how you solve the research problem in this chapter by breaking it down in further sub-problems.
1169
By this, you outline the method (SM3) through which you are going to solve the problem of this chapter.
1170
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.
1171
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.
1172
1173
% ---------------------------------------------------------------------------------
1174
\section{First Sub-Problem}\label{sec:problem1:subproblem1}
1175
% ---------------------------------------------------------------------------------
1176
1177
\emph{The first paragraph describes the first sub-problem and develops the requirements a solution has to satisfy (SM2 for this section).}
1178
The requirements have to be based on the knowledge and reasoning developing in the preceding chapters and sections.
1179
Try to use an example to illustrate the problem and the desired properties of the solution.
1180
Check that every term/concept you use here has already been defined already in a previous section.
1181
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.
1182
1183
\emph{The second paragraph describes the method/approach how you address the problem (SM3 for this section).}
1184
Describe the method in a level of detail that allows another student to reproduce your steps.
1185
Make use of appendices % (see \cref{sec:appendix1})
1186
if certain details take too much space.
1187
1188
\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.
1189
1190
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.
1191
..'') and describe the results in text.
1192
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.
1193
Describe to them how to read these, explain the meaning of particular elements, point out special observations.
1194
But you may only describe the results you must not interpret them.
1195
Make use of appendices if certain details take too much space.
1196
1197
\begin{figure}
1198
\centering
1199
%%%\includegraphics{/path/to/figure.pdf}
1200
\caption{A scientific figure that has to be explained in the text}
1201
\label{fig:my_label}
1202
\end{figure}
1203
1204
\emph{After describing the results, you may interpret them (SM6).}
1205
Here you can infer what a particular observation means (for you), how it can be applied, or what others can do with it.
1206
You must not write interpretations before completely describing your results.
1207
This is a common mistake done by most beginner writers.
1208
You want to quickly get to the point, which is the final finding or interpretation.
1209
But you forget that your reader does not understand yet what you are interpreting - they do not know yet what you do know.
1210
An interpretation can only be followed after all results have been described.
1211
The interpretation must be based on the written description only.
1212
Then you can be sure that your readers can follow your interpretation and reach the same conclusions as you have.
1213
1214
Ideally, your interpretation leads to the next sub-problem in \cref{sec:problem1:subproblem2}.
1215
1216
% ---------------------------------------------------------------------------------
1217
\section{Second Sub-Problem}\label{sec:problem1:subproblem2}
1218
% ---------------------------------------------------------------------------------
1219
1220
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).
1221
1222
Note that not all sections may not include all parts SM1-SM6 in all detail.
1223
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.
1224
Sometimes, a section is only dedicated to describing the method (SM3) and execution (SM4) and does not contain any results or interpretations.
1225
Sometimes results (SM5) and interpretations (SM6) only come in the evaluation chapter.
1226
1227
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:
1228
%
1229
\begin{itemize}
1230
\item Which step of a scientific argument am I currently writing (SM1, SM2, ..., SM6)?
1231
\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)?
1232
\item Are you really \emph{not} writing interpretation SM6 before SM5, SM4, or SM3?
1233
\item Is it clear to the reader which part of the scientific argument you are currently making?
1234
\end{itemize}
1235
1236
%%% ===============================================================================
1237
\section{Second Real Chapter}\label{sec:sub-problem2}
1238
%%% ===============================================================================
1239
1240
Have a short chapter introduction that recalls what you already achieved in \cref{sec:problem1} and explain the second research problem of your thesis.
1241
The problem has to show up in the introduction in \cref{sec:introduction:research-question} or in \cref{sec:problem-exposition:research-problems} already.
1242
etc.
1243
1244
%%% ===============================================================================
1245
\section{Evaluation}\label{sec:evaluation}
1246
%%% ===============================================================================
1247
1248
\emph{Purpose and scope}.
1249
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.
1250
1251
% ---------------------------------------------------------------------------------
1252
\section{Objective (SM2)}\label{sec:evaluation:objective}
1253
% ---------------------------------------------------------------------------------
1254
1255
Clearly state what you want to evaluate and what you want to measure.
1256
1257
% ---------------------------------------------------------------------------------
1258
\section{Setup (SM3)}\label{sec:evaluation:setup}
1259
% ---------------------------------------------------------------------------------
1260
1261
State which data, participants, tools, etc. you chose and why.
1262
Clearly state how you measure outcomes and how you compare them to baselines, reference groups, etc.
1263
1264
% ---------------------------------------------------------------------------------
1265
\section{Execution (SM4)}\label{sec:evaluation:execution}
1266
% ---------------------------------------------------------------------------------
1267
1268
Provide all details on the execution that are necessary to allows another person to reproduce your results at a later point.
1269
1270
% ---------------------------------------------------------------------------------
1271
\section{Results (SM5)}\label{sec:evaluation:results}
1272
% ---------------------------------------------------------------------------------
1273
1274
You only report the measurements.
1275
You must present and reference them (``\cref{fig:my_label2} shows.
1276
..'') and describe the results in text.
1277
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.
1278
Describe to them how to read these, explain the meaning of particular elements, point out special observations.
1279
But you may only describe the results you must not interpret them.
1280
Make use of appendices if certain details take too much space.
1281
1282
\begin{figure}
1283
\centering
1284
%%%\includegraphics{/path/to/figure.pdf}
1285
\caption{Another scientific figure that has to be explained in the text}
1286
\label{fig:my_label2}
1287
\end{figure}
1288
1289
% ---------------------------------------------------------------------------------
1290
\section{Discussion (SM6)}\label{sec:evaluation:discussion}
1291
% ---------------------------------------------------------------------------------
1292
1293
An interpretation can only be followed after all results have been described.
1294
The interpretation must be based on the written description in \cref{sec:evaluation:results} only.
1295
Then you can be sure that your readers can follow your interpretation and reach the same conclusions as you have.
1296
1297
1298
\chapter{LaTeX Hinweise}
1299
\label{sec:latexhints}
1300
1301
% Benötigt für eine korrekte Darstellung der Hinweise im erzeugten PDF
1302
\newcount\LTGbeginlineexample
1303
\newcount\LTGendlineexample
1304
\newenvironment{ltgexample}%
1305
{\LTGbeginlineexample=\numexpr\inputlineno+1\relax}%
1306
{\LTGendlineexample=\numexpr\inputlineno-1\relax%
1307
\tcbinputlisting{%
1308
listing only,
1309
listing file=\currfilepath,
1310
colback=green!5!white,
1311
colframe=green!25,
1312
coltitle=black!90,
1313
coltext=black!90,
1314
left=8mm,
1315
title=Zugehöriger \LaTeX{}-Quelltext aus \texttt{\currfilepath},
1316
minted language=TeX,
1317
minted style=vs,
1318
minted options={
1319
fontsize=\footnotesize,
1320
firstline=\the\LTGbeginlineexample,
1321
lastline=\the\LTGendlineexample,
1322
firstnumber=\the\LTGbeginlineexample,
1323
breaklines,
1324
linenos,
1325
numbersep=8pt
1326
}
1327
}
1328
}%
1329
1330
Hier sollen allgemeine \LaTeX-Hinweise gegeben werden, damit man Minimalbeispiele vorliegen hat, um sofort loszulegen.
1331
1332
\section{Trennung von Absätzen}
1333
1334
\begin{ltgexample}
1335
Pro Satz eine neue Zeile.
1336
Das ist wichtig, um sauber versionieren zu können.
1337
In LaTeX werden Absätze durch eine Leerzeile getrennt.
1338
Analogie zu Word: Bei Word werden neue Absätze durch einmal Eingabetaste herbeigeführt.
1339
Dies führt bei LaTeX jedoch nicht zu einem neuen Absatz, da LaTeX direkt aufeinanderfolgende Zeilen zu einer Zeile zusammenfügt.
1340
Mächte man nun einen Absatz haben, muss man zweimal die Eingabetaste drücken.
1341
Dies führt zu einer leeren Zeile.
1342
In Word gibt es die Funktion Großschreibetaste und Eingabetaste gleichzeitig.
1343
Wenn man dies drückt, wird einer harter Umbruch erzwungen.
1344
Der Text fängt am Anfang der neuen Zeile an.
1345
In LaTeX erreicht man dies durch Doppelbackslashes (\textbackslash\textbackslash) erzeugt.
1346
\\
1347
Dies verwendet man quasi nie.
1348
1349
Folglich werden neue Abstäze insbesondere \emph{nicht} durch Doppelbackslashes erzeugt.
1350
Beispielsweise begann der letzte Satz in einem neuen Absatz.
1351
Eine ausführliche Motivation hierfür findet sich in \url{http://loopspace.mathforge.org/HowDidIDoThat/TeX/VCS/#section.3}.
1352
\end{ltgexample}
1353
1354
Möchte man die Art des Absatzes ändern, so kann man die Dokumentklassenoption \texttt{parskip} verwenden.
1355
Beispielsweise kann man mit \texttt{parskip=off} erreichen, dass statt eines freien Bereichs die erste Zeile des Absatzes eingezogen wird.
1356
1357
\section{Notes separated from the text}
1358
1359
The package mindflow enables writing down notes and annotations in a way so that they are separated from the main text.
1360
1361
\begin{ltgexample}
1362
\begin{mindflow}
1363
This is a small note.
1364
\end{mindflow}
1365
\end{ltgexample}
1366
1367
\section{Handling TODOs}
1368
1369
\begin{ltgexample}
1370
\textmarker{Markierter Text.}
1371
\end{ltgexample}
1372
1373
Bei \verb1\textmarker1 wird nur die Textfarbe geändert, da dies auch bei einigen Worten gut funktioniert.
1374
1375
\begin{ltgexample}
1376
\textcomment{Markierter Text.}{Kommentar dazu.}
1377
\end{ltgexample}
1378
1379
\begin{ltgexample}
1380
\hl{In Gelb hervorgehoben.}
1381
Provided indirectly by pdfcomment.sty (soulpos).
1382
\end{ltgexample}
1383
1384
\begin{ltgexample}
1385
\modified{Manuelle Markierung für Text, der seit der letzten Version geändert wurde.}
1386
\end{ltgexample}
1387
1388
\begin{ltgexample}
1389
Das ist ein Text.
1390
\change{FL1: Text angepasst}{Geänderter Text}.
1391
\end{ltgexample}
1392
1393
\begin{ltgexample}
1394
Hier nur ein Kommentar\sidecomment{Kommentar}.
1395
\end{ltgexample}
1396
1397
\begin{ltgexample}
1398
\todo{Hier muss noch kräftig Text produziert werden}
1399
\end{ltgexample}
1400
1401
\section{Hyphenation}
1402
1403
\LaTeX{} automatically hyphenates words.
1404
When using \href{https://ctan.org/pkg/microtype}{microtype}, there should be fewer hyphenations than in other settings.
1405
It might be necessary to tweak the hyphenations nevertheless.
1406
Here are some hints:
1407
1408
\begin{ltgexample}
1409
In case you write \enquote{application-specific}, then the word will only be hyphenated at the dash.
1410
You can also write \verb1applica\allowbreak{}tion-specific1 (result: applica\allowbreak{}tion-specific), but this is much more effort.
1411
1412
You can now write words containing hyphens which are hyphenated at other places in the word.
1413
For instance, \verb1application"=specific1 gets application"=specific.
1414
This is enabled by an additional configuration of the babel package.
1415
\end{ltgexample}
1416
1417
\section{Typesetting Units}
1418
1419
\begin{ltgexample}
1420
Numbers can be written plain text (such as 100), by using the \href{https://ctan.org/pkg/siunitx}{siunitx} package as follows:
1421
\SI{100}{\km\per\hour},
1422
or by using plain \LaTeX{} (and math mode):
1423
$100 \frac{\mathit{km}}{h}$.
1424
\end{ltgexample}
1425
1426
\begin{ltgexample}
1427
\SI{5}{\percent} of \SI{10}{kg}
1428
\end{ltgexample}
1429
1430
\begin{ltgexample}
1431
Numbers are automatically grouped: \num{123456}.
1432
\end{ltgexample}
1433
1434
\section{Surrounding Text by Quotes}
1435
1436
\begin{ltgexample}
1437
Please use the \enquote{enquote command} to quote something.
1438
Quoting with "`quote"' or ``quote'' also works.
1439
1440
\end{ltgexample}
1441
1442
\section{Cleveref examples}
1443
\label{sec:ex:cref}
1444
1445
Cleveref demonstration: Cref at beginning of sentence, cref in all other cases.
1446
1447
\begin{figure}
1448
\centering
1449
\includegraphics[width=.75\linewidth]{example-image-a}
1450
\caption{Example figure for cref demo}
1451
\label{fig:ex:cref}
1452
\end{figure}
1453
1454
\begin{table}
1455
\centering
1456
\begin{tabular}{ll}
1457
\toprule
1458
Heading1 & Heading2 \\
1459
\midrule
1460
One & Two \\
1461
Thee & Four \\
1462
\bottomrule
1463
\end{tabular}
1464
\caption{Example table for cref demo}
1465
\label{tab:ex:cref}
1466
\end{table}
1467
1468
\begin{ltgexample}
1469
\Cref{fig:ex:cref} shows a simple fact, although \cref{fig:ex:cref} could also show something else.
1470
1471
\Cref{tab:ex:cref} shows a simple fact, although \cref{tab:ex:cref} could also show something else.
1472
1473
\Cref{sec:ex:cref} shows a simple fact, although \cref{sec:ex:cref} could also show something else.
1474
\end{ltgexample}
1475
1476
\section{Abbildungen}
1477
1478
\begin{ltgexample}
1479
\Cref{fig:label} zeigt etwas Interessantes
1480
1481
\begin{figure}
1482
\centering
1483
Füge deine Abbildung hier ein.
1484
\caption{Bildunterschrift.}
1485
\label{fig:label}
1486
\end{figure}
1487
\end{ltgexample}
1488
1489
\section{Sub Figures}
1490
1491
An example of two sub figures is shown in \cref{fig:two_sub_figures}.
1492
1493
\begin{ltgexample}
1494
\begin{figure}[!b]
1495
\centering
1496
\subfloat[Case I]{\includegraphics[width=.4\linewidth]{example-image-a}%
1497
\label{fig:first_case}}
1498
\hfil
1499
\subfloat[Case II]{\includegraphics[width=.4\linewidth]{example-image-b}%
1500
\label{fig:second_case}}
1501
\caption{Example figure with two sub figures.}
1502
\label{fig:two_sub_figures}
1503
\end{figure}
1504
\end{ltgexample}
1505
1506
\section{Tables}
1507
1508
\begin{ltgexample}
1509
\begin{table}
1510
\caption{Simple Table}
1511
\label{tab:simple}
1512
\centering
1513
\begin{tabular}{ll}
1514
\toprule
1515
Heading1 & Heading2 \\
1516
\midrule
1517
One & Two \\
1518
Thee & Four \\
1519
\bottomrule
1520
\end{tabular}
1521
\end{table}
1522
\end{ltgexample}
1523
1524
\begin{ltgexample}
1525
% Source: https://tex.stackexchange.com/a/468994/9075
1526
\begin{table}
1527
\caption{Table with diagonal line}
1528
\label{tab:diag}
1529
\begin{center}
1530
\begin{tabular}{|l|c|c|}
1531
\hline
1532
\diagbox[width=10em]{Diag \\Column Head I}{Diag Column\\Head II} & Second & Third \\
1533
\hline
1534
& foo & bar \\
1535
\hline
1536
\end{tabular}
1537
\end{center}
1538
\end{table}
1539
\end{ltgexample}
1540
1541
1542
\section{Source Code}
1543
1544
\href{https://github.com/gpoore/minted}{minted} is a sophisticated package to enable properly highlighted listings.
1545
It uses the \href{http://pygments.org/}{pygments} library, which in turn requires Python.
1546
1547
\begin{ltgexample}
1548
\Cref{lst:XML} shows source code written in XML.
1549
\refline{line:comment} contains a comment.
1550
1551
\begin{listing}[htbp]
1552
\begin{minted}[linenos=true,escapeinside=||]{xml}
1553
<listing name="example">
1554
<!-- comment --> |\labelline{line:comment}|
1555
<content>not interesting</content>
1556
</listing>
1557
\end{minted}
1558
\caption{Example XML listing using minted}
1559
\label{lst:XML}
1560
\end{listing}
1561
\end{ltgexample}
1562
1563
One can also typeset JSON as shown in \cref{lst:flJSON}.
1564
1565
\begin{ltgexample}
1566
\begin{listing}[htbp]
1567
\begin{minted}[linenos=true,escapeinside=||]{json}
1568
{
1569
key: "value"
1570
}
1571
\end{minted}
1572
\caption{Example JSON listing using minted}
1573
\label{lst:flJSON}
1574
\end{listing}
1575
\end{ltgexample}
1576
1577
Java is also possible as shown in \cref{lst:flJava}.
1578
1579
\begin{ltgexample}
1580
\begin{listing}[htbp]
1581
\begin{minted}[linenos=true,escapeinside=||]{java}
1582
public class Hello {
1583
public static void main (String[] args) {
1584
System.out.println("Hello World!");
1585
}
1586
}
1587
\end{minted}
1588
\caption{Java code rendered using minted}
1589
\label{lst:flJava}
1590
\end{listing}
1591
\end{ltgexample}
1592
1593
\section{Itemization}
1594
1595
One can list items as follows:
1596
1597
\begin{ltgexample}
1598
\begin{itemize}
1599
\item Item One
1600
\item Item Two
1601
\end{itemize}
1602
\end{ltgexample}
1603
1604
With the package paralist, one can create itemizations with lesser spacing:
1605
1606
\begin{ltgexample}
1607
\begin{compactitem}
1608
\item Item One
1609
\item Item Two
1610
\end{compactitem}
1611
\end{ltgexample}
1612
1613
One can enumerate items as follows:
1614
1615
\begin{ltgexample}
1616
\begin{enumerate}
1617
\item Item One
1618
\item Item Two
1619
\end{enumerate}
1620
\end{ltgexample}
1621
1622
With the package paralist, one can create enumerations with lesser spacing:
1623
1624
\begin{ltgexample}
1625
\begin{compactenum}
1626
\item Item One
1627
\item Item Two
1628
\end{compactenum}
1629
\end{ltgexample}
1630
1631
With paralist, one can even have all items typeset after each other and have them clean in the TeX document:
1632
1633
\begin{ltgexample}
1634
\begin{inparaenum}
1635
\item All these items...
1636
\item ...appear in one line
1637
\item This is enabled by the paralist package.
1638
\end{inparaenum}
1639
\end{ltgexample}
1640
1641
\section{Abkürzungen}
1642
1643
Mit \verb+\gls{...}+ können Abkürzungen eingebaut werden, beim ersten Aufrufen wird die lange Form eingesetzt.
1644
Beim wiederholten Verwenden von \verb+\gls{...}+ wird automatisch die Kurzform angezeigt.
1645
Außerdem wird die Abkürzung automatisch in die Abkürzungsliste eingefügt.
1646
Mit \verb+\glspl{...}+ wird die Pluralform verwendet.
1647
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.
1648
Das Gegenteil erreicht man mit \verb+\glsreset{...}+.
1649
1650
Definiert werden Abkürzungen in der Datei \textit{abbreviationstex} mithilfe von \verb+\newacronym{...}{...}{...}+.
1651
1652
Mehr Infos unter: \url{https://ctan.org/pkg/bib2gls}.
1653
1654
\begin{ltgexample}
1655
Beim ersten Durchlauf betrug die \gls{fr} 5.
1656
Beim zweiten Durchlauf war die \gls{fr} 3.
1657
Die Pluralform sieht man hier: \glspl{er}.
1658
Um zu demonstrieren, wie das Abkürzungsverzeichnis bei längeren Beschreibungstexten aussieht, muss hier noch \glspl{rdbms} erwähnt werden.
1659
1660
\gls{dante} is a local \TeX\ user group.
1661
The German-speaking local \TeX\ user group is \gls{dante}.
1662
A \gls{gp} is a medical doctor.
1663
I went to my surgery to see the \gls{gp}.
1664
\end{ltgexample}
1665
1666
\section{Other Features}
1667
1668
\begin{ltgexample}
1669
The words \enquote{workflow} and \enquote{dwarflike} can be copied from the PDF and pasted to a text file.
1670
\end{ltgexample}
1671
1672
\begin{ltgexample}
1673
The symbol for powerset is now correct: $\powerset$ and not a Weierstrass p ($\wp$).
1674
1675
$\powerset({1,2,3})$
1676
\end{ltgexample}
1677
1678
\begin{ltgexample}
1679
Brackets work as designed:
1680
<test>
1681
One can also input backticks in verbatim text: \verb|`test`|.
1682
\end{ltgexample}
1683
1684
1685
\section{Varioref examples}
1686
\label{sec:ex:vref}
1687
1688
Varioref demonstration: Vref at beginning of sentence, vref in all other cases.
1689
1690
\begin{ltgexample}
1691
\Vref{fig:ex:cref} shows a simple fact, although \vref{fig:ex:cref} could also show something else.
1692
1693
\Vref{tab:ex:cref} shows a simple fact, although \vref{tab:ex:cref} could also show something else.
1694
1695
\Vref{sec:ex:cref} shows a simple fact, although \vref{sec:ex:cref} could also show something else.
1696
\end{ltgexample}
1697
1698
\section{Citations}
1699
1700
When referencing something from the bibliography file, it will automatically appear in the references section.
1701
If a reference is not cited, it is not appearing there.
1702
1703
\begin{ltgexample}
1704
Standard case: Citing indirectly citing something~\cite{mwe}.
1705
In case one wants to name the author: \textcite{mwe} shows a minimal \LaTeX{} example.
1706
\end{ltgexample}
1707
1708
Note that \texttt{\textbackslash textcite\{mwe\}} prints both the author and the reference to the bibliography entry.
1709
1710
Remember that you have to call \texttt{biber main-german} to generate the bibliography data for \texttt{lualatex}.
1711
You will need to run \texttt{lualatex} twice to ensure that the page numbers are updated correctly.
1712
1713
1714
In the bibliography, use \texttt{\textbackslash textsuperscript} for \enquote{st}, \enquote{nd}, \ldots:
1715
E.g., \enquote{The 2\textsuperscript{nd} conference on examples}.
1716
When you use \href{https://www.jabref.org}{JabRef}, you can use the clean up command to achieve that.
1717
See \url{https://help.jabref.org/en/CleanupEntries} for an overview of the cleanup functionality.
1718
1719
\section{Miscellaneous Examles}
1720
\label{ssec:example}
1721
1722
Referencetest: \Cref{ssec:example}, \cref{fig:Abbildung} und \cref{alg:example}.
1723
1724
\begin{ltgexample}
1725
Checkmark: \dingcheck.
1726
Crossmark: \dingcross.
1727
\end{ltgexample}
1728
1729
\begin{figure}
1730
\missingfigure{}
1731
\caption{Abbildung}
1732
\label{fig:Abbildung}
1733
\end{figure}
1734
1735
\begin{landscape}
1736
\begin{figure}
1737
\missingfigure{}
1738
\caption{Gedrehte Abbildung}
1739
\label{fig:AbbildungGedreht}
1740
\end{figure}
1741
\end{landscape}
1742
1743
\subsection{Algorithmen}
1744
1745
\begin{algorithm}
1746
\caption{$algo$}
1747
\label{alg:example}
1748
\begin{algorithmic}[1]
1749
\State $a \gets 0$
1750
\State State 2\label{alg1:state2}
1751
\end{algorithmic}
1752
\end{algorithm}
1753
1754
\begin{algorithm}
1755
\caption{Algorithmus 2}
1756
\label{alg:example2}
1757
\begin{algorithmic}[1]
1758
\State $a \gets 0$
1759
\State State 2\label{alg2:state2}
1760
\end{algorithmic}
1761
\end{algorithm}
1762
1763
\Cref{alg:example} hat bereits einen Algorithmus gezeigt.
1764
Test der Zeilenreferenzierung: Zeile~\ref{alg1:state2} (\cref{alg:example}) und Zeile~\ref{alg2:state2} (\cref{alg:example2}).
1765
1766
\subsection{Definitionen}
1767
\begin{definition}[Title]
1768
\label{def:def1}
1769
Definition Text
1770
\end{definition}
1771
1772
\Cref{def:def1} zeigt \ldots
1773
1774
\subsection{Aufzählungen}
1775
1776
\begin{enumerate}[label=\alph*)]
1777
\item a
1778
\item b
1779
\item c
1780
\item d
1781
\end{enumerate}
1782
1783
Equivalent to paralist's inparaenum:
1784
\begin{enumerate*}[label=\alph*)]
1785
\item a
1786
\item b
1787
\item c
1788
\item d
1789
\end{enumerate*}
1790
1791
\begin{description}
1792
\item[first] Erstens
1793
\item[second] Zweitens
1794
\item[third] Drittens
1795
\end{description}
1796
1797
\begin{description}
1798
\item[\texttt{first}] Erstens
1799
\item[\texttt{second}] Zweitens
1800
\item[\texttt{third}] Drittens
1801
\end{description}
1802
1803
%works only if package enumitem is loaded
1804
\begin{description}[font=\ttfamily]
1805
\item[first] Erstens
1806
\item[second] Zweitens
1807
\item[third] Drittens
1808
\end{description}
1809
1810
\begin{description}[style=unboxed]
1811
\item[first label with a long description text breaking over one line. Enabled by enumitem package] Erstens
1812
\item[second] Zweitens
1813
\item[third] Drittens
1814
\end{description}
1815
1816
\begin{Description}
1817
\item[first label with a long description text breaking over one line. Defined in template.tex] Erstens
1818
\item[second] Zweitens
1819
\item[third] Drittens
1820
\end{Description}
1821
1822
\begin{itemize}
1823
\item Erstens
1824
\item Zweitens
1825
\item Drittens
1826
\end{itemize}
1827
1828
Optionaler Parameter ändert den Marker, der vorangestellt ist.
1829
Siehe \url{http://www.weinelt.de/latex/item.html}.
1830
\begin{itemize}
1831
\item[A] Erstens
1832
\item[B] Zweitens
1833
\item[C] Drittens
1834
\end{itemize}
1835
1836
Falsche Benutzung des optionalen Parameters wie folgt:
1837
\begin{itemize}
1838
\item[first] Erstens
1839
\item[second] Zweitens
1840
\item[third] Drittens
1841
\end{itemize}
1842
Dabei ist zu beachten, dass es sich bei Einbindung von \texttt{enumitem} anders verhält als bei \texttt{paralist}.
1843
1844
\subsection{fquote}
1845
1846
\begin{fquote}[T.\ Informatiker]
1847
Bis nächsten Freitag ist das Programm fertig.
1848
\end{fquote}
1849
1850
\begin{gfquote}{T.\ Informatiker}
1851
Bis nächsten Freitag ist das Programm fertig.
1852
\end{gfquote}
1853
1854
%%% ===============================================================================
1855
\chapter{Zusammenfassung und Ausblick}\label{sec:conclusion}
1856
%%% ===============================================================================
1857
1858
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}.
1859
You specifically outline which concrete findings or methodological contributions advance our knowledge towards the general objective you introduced in \cref{sec:introduction:topic}.
1860
Objectively discuss which parts you solved and in which parts you failed.
1861
1862
You should explicitly discuss limitations and shortcomings of your work and detail what kind of future studies are needed to overcome these limitations.
1863
Be specific in the sense that your arguments for future work should be based on concrete findings and insights you obtained in your report.
1864
1865
1866
%%% ===============================================================================
1867
%%% Bibliography
1868
%%% ===============================================================================
1869
1870
1871
\printbibliography
1872
1873
% Enfore empty line after bibliography
1874
\ \\
1875
%
1876
\noindent
1877
Alle Links wurden zuletzt am 29.03.2021 geprüft.
1878
1879
%%% ===============================================================================
1880
1881
%\IfDefined{printindex}{\printindex}
1882
%\IfDefined{printnomenclature}{\printnomenclature}
1883
1884
\clearpage
1885
\appendix
1886
% 'Anhang' ins Inhaltsverzeichnis
1887
%\phantomsection
1888
%\addcontentsline{toc}{chapter}{Anhang}
1889
\addcontentsline{toc}{part}{Anhang}
1890
1891
%%% ===============================================================================
1892
\chapter{My first appendix}\label{sec:appendix1}
1893
%%% ===============================================================================
1894
1895
\lipsum[1]
1896
1897
\pagestyle{empty}
1898
\renewcommand*{\chapterpagestyle}{empty}
1899
\clearpage
1900
\backmatter
1901
\thispagestyle{empty}
1902
1903
\vspace*{\fill}
1904
\pagestyle{empty}
1905
1906
{\normalsize
1907
\begin{center}\textbf{Eidesstattliche Erklärung}\end{center}
1908
\blindtext[1]
1909
\vspace*{1cm}\\
1910
Hamburg, den XX.XX.20XX
1911
\hspace*{\fill}\begin{tabular}{@{}l@{}}\hline
1912
\makebox[5cm]{Vorname Nachname}
1913
\end{tabular}
1914
\vspace*{3cm}
1915
1916
%TODO Dies ist optional, ggf. löschen!
1917
\begin{center}\textbf{Veröffentlichung}\end{center}
1918
\blindtext[1]
1919
\vspace*{1cm}\\
1920
Hamburg, den XX.XX.20XX
1921
\hspace*{\fill}\begin{tabular}{@{}l@{}}\hline
1922
\makebox[5cm]{Vorname Nachname}
1923
\end{tabular}
1924
}
1925
\vspace*{\fill}
1926
\end{document}
1927
1928