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