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