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