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