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