generator-latex-template 0.2.0 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +24 -9
- package/generators/app/index.js +198 -106
- package/generators/app/templates/Dockerfile.dante +9 -0
- package/generators/app/templates/Dockerfile.reitzig +35 -0
- package/generators/app/templates/Makefile +0 -13
- package/generators/app/templates/README.en.md +68 -27
- package/generators/app/templates/Texlivefile +128 -0
- package/generators/app/templates/acronyms.de.tex +6 -0
- package/generators/app/templates/acronyms.en.tex +5 -0
- package/generators/app/templates/acronyms.example.de.tex +24 -0
- package/generators/app/templates/acronyms.example.en.tex +24 -0
- package/generators/app/templates/acronyms.preamble.en.tex +15 -0
- package/generators/app/templates/biblatex.preamble.de.tex +9 -0
- package/generators/app/templates/biblatex.preamble.en.tex +61 -0
- package/generators/app/templates/bibliography.bib +11 -0
- package/generators/app/templates/cleveref.example.en.tex +1 -1
- package/generators/app/templates/diagbox.example.en.tex +1 -1
- package/generators/app/templates/dot.dockerignore +429 -0
- package/generators/app/templates/figure.example.en.tex +5 -5
- package/generators/app/templates/font.preamble.en.tex +9 -6
- package/generators/app/templates/{dot.latexmkrc → latexmkrc} +11 -9
- package/generators/app/templates/main.de.tex +135 -11
- package/generators/app/templates/main.en.tex +244 -87
- package/generators/app/templates/microtype.preamble.en.tex +5 -0
- package/generators/app/templates/mindflow.example.en.tex +9 -0
- package/generators/app/templates/mindflow.preamble.en.tex +5 -0
- package/generators/app/templates/natbib.preamble.en.tex +1 -1
- package/generators/app/templates/scientific-thesis-cover.preamble.de.tex +12 -0
- package/generators/app/templates/scientific-thesis-cover.preamble.en.tex +12 -0
- package/generators/app/templates/siunitx.preamble.en.tex +0 -5
- package/generators/app/templates/subfloat.example.en.tex +4 -4
- package/generators/app/templates/url.preamble.en.tex +2 -0
- package/package.json +12 -12
- package/CHANGELOG.md +0 -58
- package/generators/app/templates/bibliography.bib.bak +0 -37
- package/generators/app/templates/main.de.pdf +0 -0
- package/generators/app/templates/main.de.synctex.gz +0 -0
- package/generators/app/templates/main.en.aux +0 -3
- package/generators/app/templates/main.en.fdb_latexmk +0 -38
- package/generators/app/templates/main.en.fls +0 -52
- package/generators/app/templates/main.en.log +0 -251
- package/generators/app/templates/main.en.pdf +0 -0
- package/generators/app/templates/main.en.synctex.gz +0 -0
|
@@ -1,12 +1,13 @@
|
|
|
1
|
-
<%
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
<%
|
|
5
|
-
|
|
1
|
+
<% if (preparereitzig) { -%>
|
|
2
|
+
\RequirePackage{snapshot}
|
|
3
|
+
<% } -%>
|
|
4
|
+
<% switch (documentclass) { case "lncs": -%>
|
|
5
|
+
% This template has been tested with LLNCS DOCUMENT CLASS -- version 2.21 (12-Jan-2022)
|
|
6
|
+
|
|
7
|
+
<% break; case "ieee": -%>
|
|
6
8
|
% This template has been tested with IEEEtran of 2015.
|
|
7
|
-
|
|
8
|
-
break;
|
|
9
|
-
} -%>
|
|
9
|
+
|
|
10
|
+
<% break; } -%>
|
|
10
11
|
% !TeX spellcheck = en-US
|
|
11
12
|
% !TeX encoding = utf8
|
|
12
13
|
% !TeX program = <%= latexcompiler %>
|
|
@@ -15,14 +16,7 @@ break;
|
|
|
15
16
|
<% } -%>
|
|
16
17
|
% !BIB program = <%= bibtextool %>
|
|
17
18
|
% -*- coding:utf-8 mod:LaTeX -*-
|
|
18
|
-
<%
|
|
19
|
-
|
|
20
|
-
% EN: The following package allows \\ at the title page
|
|
21
|
-
% For more information see https://github.com/latextemplates/scientific-thesis-cover/issues/4
|
|
22
|
-
\RequirePackage{kvoptions-patch}
|
|
23
|
-
<% } -%>
|
|
24
|
-
<% switch (documentclass) {
|
|
25
|
-
case "lncs": -%>
|
|
19
|
+
<% switch (documentclass) { case "lncs": -%>
|
|
26
20
|
|
|
27
21
|
% "a4paper" enables:
|
|
28
22
|
%
|
|
@@ -43,20 +37,33 @@ break;
|
|
|
43
37
|
% it is good to have title printed on the pages, too.
|
|
44
38
|
%
|
|
45
39
|
% To disable outputting page headers and footers, remove "runningheads"
|
|
46
|
-
\documentclass[runningheads,a4paper,english]{llncs}[
|
|
47
|
-
<%
|
|
48
|
-
|
|
40
|
+
\documentclass[runningheads,a4paper,english]{llncs}[2022/01/12]
|
|
41
|
+
<% break; case "acmart": -%>
|
|
42
|
+
|
|
43
|
+
<% if (texlive >= 2021) { -%>
|
|
44
|
+
% We balance the last page using the package "pbalance" (see https://ctan.org/pkg/pbalance), because it "just works" (in contrast to balance.sty or other solutions)
|
|
45
|
+
<% } -%>
|
|
46
|
+
\documentclass[<%= acm_format %>,<% if (acm_review) { %>review,<% } %><% if (texlive >= 2021) { %>pbalance<% } else { %>balance<% } %>]{acmart}
|
|
47
|
+
<% break; case "ieee": -%>
|
|
49
48
|
|
|
50
49
|
% DO NOT DOWNLOAD IEEEtran.cls - Use the one of your LaTeX distribution
|
|
51
50
|
% For the final version, replace "draftcls" by "final"
|
|
52
51
|
\documentclass[<%= ieee_variant %>,<%= papersize %>paper]{IEEEtran}[2015/08/26]
|
|
52
|
+
<% if (texlive >= 2021) { -%>
|
|
53
53
|
|
|
54
54
|
% Balance the last page
|
|
55
55
|
% The pbalance package (see https://ctan.org/pkg/pbalance) "just works" (in contrast to balance.sty or other solutions)
|
|
56
56
|
\usepackage{pbalance}
|
|
57
|
+
<% } else { -%>
|
|
58
|
+
|
|
59
|
+
% Balance the last page using the balance package (see https://ctan.org/pkg/balance)
|
|
60
|
+
\usepackage{balance}
|
|
61
|
+
<% } -%>
|
|
62
|
+
<% break; case "scientific-thesis": -%>
|
|
57
63
|
|
|
58
|
-
|
|
59
|
-
|
|
64
|
+
% EN: The following package allows \\ at the title page
|
|
65
|
+
% For more information see https://github.com/latextemplates/scientific-thesis-cover/issues/4
|
|
66
|
+
\RequirePackage{kvoptions-patch}
|
|
60
67
|
\documentclass[
|
|
61
68
|
% fontsize=11pt is the standard
|
|
62
69
|
numbers=noenddot,
|
|
@@ -72,7 +79,18 @@ default: -%>
|
|
|
72
79
|
% draft % um zu sehen, wo noch nachgebessert werden muss - wichtig, da Bindungskorrektur mit drin
|
|
73
80
|
draft=false
|
|
74
81
|
]{scrbook}
|
|
75
|
-
|
|
82
|
+
\usepackage{scrlayer-scrpage}
|
|
83
|
+
\ihead[]{}
|
|
84
|
+
\chead[]{}
|
|
85
|
+
\ohead[]{\headmark}
|
|
86
|
+
\cfoot[]{}
|
|
87
|
+
\ofoot[\usekomafont{pagenumber}\thepage]{\usekomafont{pagenumber}\thepage}
|
|
88
|
+
\ifoot[]{}
|
|
89
|
+
<% break; default: -%>
|
|
90
|
+
|
|
91
|
+
% not yet supported template. Please report to the author of generator-latex-template
|
|
92
|
+
\documentclass{scrbook}
|
|
93
|
+
<% } -%>
|
|
76
94
|
|
|
77
95
|
% backticks (`) are rendered as such in verbatim environments.
|
|
78
96
|
% See following links for details:
|
|
@@ -81,10 +99,16 @@ default: -%>
|
|
|
81
99
|
% - https://tex.stackexchange.com/a/166791/9075
|
|
82
100
|
\usepackage{upquote}
|
|
83
101
|
|
|
84
|
-
<%- include('babel.preamble.en.tex', this);
|
|
85
|
-
|
|
86
|
-
<%- include('
|
|
87
|
-
|
|
102
|
+
<%- include('babel.preamble.en.tex', this); -%>
|
|
103
|
+
|
|
104
|
+
<%- include('url.preamble.en.tex', this); -%>
|
|
105
|
+
<%# ACM already provides a very good font configuration; thus we do not need to override it -%>
|
|
106
|
+
<% if (documentclass != 'acmart') { %>
|
|
107
|
+
<%- include('font.preamble.en.tex', this); -%>
|
|
108
|
+
<% } -%>
|
|
109
|
+
|
|
110
|
+
<%- include('microtype.preamble.en.tex', this); -%>
|
|
111
|
+
|
|
88
112
|
\usepackage{graphicx}
|
|
89
113
|
|
|
90
114
|
<%- include('diagbox.preamble.en.tex', this); -%>
|
|
@@ -93,20 +117,30 @@ default: -%>
|
|
|
93
117
|
\usepackage{xcolor}
|
|
94
118
|
|
|
95
119
|
<% if (listings == 'listings') { -%>
|
|
96
|
-
<%- include('listings.preamble.en.tex', this);
|
|
120
|
+
<%- include('listings.preamble.en.tex', this); -%>
|
|
97
121
|
<% } else { -%>
|
|
98
|
-
<%- include('minted.preamble.en.tex', this);
|
|
122
|
+
<%- include('minted.preamble.en.tex', this); -%>
|
|
99
123
|
<% } -%>
|
|
100
124
|
|
|
101
|
-
<% if (enquotes == 'csquotes')
|
|
102
|
-
<% if (enquotes == 'textcmds')
|
|
125
|
+
<% if (enquotes == 'csquotes') { %><%- include('csquotes.preamble.en.tex', this); %><% } -%>
|
|
126
|
+
<% if (enquotes == 'textcmds') { %><%- include('textcmds.preamble.en.tex', this); %><% } -%>
|
|
103
127
|
|
|
104
|
-
<%- include('booktabs.preamble.en.tex', this);
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
128
|
+
<%- include('booktabs.preamble.en.tex', this); -%>
|
|
129
|
+
|
|
130
|
+
<%- include('paralist.preamble.en.tex', this); -%>
|
|
131
|
+
<% switch (documentclass) {
|
|
132
|
+
case "acmart":
|
|
133
|
+
case "ieee":
|
|
134
|
+
case "lncs": -%>
|
|
135
|
+
|
|
136
|
+
<%- include('natbib.preamble.en.tex', this); -%>
|
|
137
|
+
<% break; case "scientific-thesis": -%>
|
|
138
|
+
<%- include('biblatex.preamble.en.tex', this); -%>
|
|
139
|
+
<% break; } -%>
|
|
140
|
+
<% switch (documentclass) { case "acmart": -%>
|
|
141
|
+
|
|
142
|
+
\citestyle{acmnumeric} % alternative: acmauthoryear
|
|
143
|
+
<% break; case "lncs": -%>
|
|
110
144
|
|
|
111
145
|
% Prepare more space-saving rendering of the bibliography
|
|
112
146
|
% Source: https://tex.stackexchange.com/a/280936/9075
|
|
@@ -118,12 +152,14 @@ default: -%>
|
|
|
118
152
|
{ encoding = {OT1,T1,TS1} }
|
|
119
153
|
{ }
|
|
120
154
|
|
|
121
|
-
<%- include('floatflt.preamble.en.tex', this);
|
|
122
|
-
<% } -%>
|
|
155
|
+
<%- include('floatflt.preamble.en.tex', this); -%>
|
|
156
|
+
<% break; } -%>
|
|
123
157
|
<% if (todo == 'pdfcomment') { -%>
|
|
124
|
-
|
|
158
|
+
|
|
159
|
+
<%- include('pdfcomment.preamble.en.tex', this); -%>
|
|
125
160
|
<% } else { -%>
|
|
126
|
-
|
|
161
|
+
|
|
162
|
+
<%- include('plainlatextodo.preamble.en.tex', this); -%>
|
|
127
163
|
<% } -%>
|
|
128
164
|
|
|
129
165
|
% Put footnotes below floats
|
|
@@ -134,8 +170,10 @@ default: -%>
|
|
|
134
170
|
<%- include('siunitx.preamble.en.tex'); %>
|
|
135
171
|
<%- include('hyperref.preamble.en.tex', this); %>
|
|
136
172
|
<%- include('subfig.preamble.en.tex', this); %>
|
|
137
|
-
<% if (
|
|
138
|
-
|
|
173
|
+
<% if (texlive >= 2021) { %><%- include('mindflow.preamble.en.tex', this); %>
|
|
174
|
+
<% } -%>
|
|
175
|
+
<% if (cleveref) { %><%- include('cleveref.preamble.en.tex', this); %>
|
|
176
|
+
<% } -%>
|
|
139
177
|
\usepackage{lipsum}
|
|
140
178
|
<% if (examples) { -%>
|
|
141
179
|
|
|
@@ -144,13 +182,13 @@ default: -%>
|
|
|
144
182
|
\usepackage[math]{blindtext}
|
|
145
183
|
\usepackage{mwe}
|
|
146
184
|
<% if (useExampleEnvironment) { -%>
|
|
147
|
-
\usepackage{currfile}
|
|
185
|
+
\usepackage[realmainfile]{currfile}
|
|
148
186
|
\usepackage{tcolorbox}
|
|
149
187
|
\tcbuselibrary{<%= listings %>}
|
|
150
188
|
<% } -%>
|
|
151
189
|
<% } -%>
|
|
152
190
|
|
|
153
|
-
<%- include('powerset.preamble.en.tex', this);
|
|
191
|
+
<%- include('powerset.preamble.en.tex', this); -%>
|
|
154
192
|
|
|
155
193
|
\usepackage{xspace}
|
|
156
194
|
%\newcommand{\eg}{e.\,g.\xspace}
|
|
@@ -165,9 +203,19 @@ default: -%>
|
|
|
165
203
|
% Definition of "= taken from http://mirror.ctan.org/macros/latex/contrib/babel-contrib/german/ngermanb.dtx
|
|
166
204
|
\makeatother
|
|
167
205
|
|
|
206
|
+
% Add manual adapted hyphenation of English words
|
|
207
|
+
% See https://ctan.org/pkg/hyphenex and https://tex.stackexchange.com/a/22892/9075 for details
|
|
208
|
+
% Could not work on MiKTeX
|
|
209
|
+
\input{ushyphex}
|
|
210
|
+
|
|
168
211
|
% correct bad hyphenation here
|
|
169
212
|
\hyphenation{op-tical net-works semi-conduc-tor}
|
|
170
|
-
<%
|
|
213
|
+
<% switch (documentclass) { case "acmart": -%>
|
|
214
|
+
|
|
215
|
+
\acmConference[short-conference-name]{full-conference-name}{November 02--06, 2021}{City, Country}
|
|
216
|
+
\acmDOI{10.1145/9999997.9999999}
|
|
217
|
+
%\startPage{457}
|
|
218
|
+
<% break; case "lncs": -%>
|
|
171
219
|
|
|
172
220
|
% Add copyright
|
|
173
221
|
% Do that for the final version or if you send it to colleagues
|
|
@@ -182,7 +230,11 @@ default: -%>
|
|
|
182
230
|
%example: llncs{Anonymous et al. (eds). \emph{Proceedings of the International Conference on \LaTeX-Hacks}, LNCS~42. Some Publisher, 2016.}{0042}
|
|
183
231
|
\llncs{book editors and title}{0042} %% 0042 is the start page
|
|
184
232
|
\fi
|
|
185
|
-
<%
|
|
233
|
+
<% break; case "scientific-thesis": -%>
|
|
234
|
+
|
|
235
|
+
<% if (feature.acronyms) { -%><%- include('acronyms.preamble.en.tex', this); %><% } -%>
|
|
236
|
+
<%- include('scientific-thesis-cover.preamble.en.tex', this); %>
|
|
237
|
+
<% break; } -%>
|
|
186
238
|
<% if (latexcompiler == "pdflatex") { -%>
|
|
187
239
|
|
|
188
240
|
% Enable copy and paste of text from the PDF
|
|
@@ -231,6 +283,19 @@ default: -%>
|
|
|
231
283
|
|
|
232
284
|
\maketitle
|
|
233
285
|
|
|
286
|
+
\begin{abstract}
|
|
287
|
+
<% break; case "acmart": -%>
|
|
288
|
+
\title{Paper Title}
|
|
289
|
+
\author{First Author}
|
|
290
|
+
\orcid{ORCID}
|
|
291
|
+
\affiliation{%
|
|
292
|
+
\department{Department}
|
|
293
|
+
\institution{Institution}
|
|
294
|
+
\city{City}
|
|
295
|
+
\country{Country}
|
|
296
|
+
}
|
|
297
|
+
\email{first.last@example.com}
|
|
298
|
+
|
|
234
299
|
\begin{abstract}
|
|
235
300
|
<% break; case "ieee": -%>
|
|
236
301
|
% Enable following command if you need to typeset "IEEEpubid".
|
|
@@ -278,6 +343,15 @@ default: -%>
|
|
|
278
343
|
\fi
|
|
279
344
|
|
|
280
345
|
\begin{abstract}
|
|
346
|
+
<% break; case "scientific-thesis": -%>
|
|
347
|
+
\pagenumbering{arabic}
|
|
348
|
+
\Titelblatt
|
|
349
|
+
|
|
350
|
+
\pagestyle{plain.scrheadings}
|
|
351
|
+
\renewcommand*{\chapterpagestyle}{plain.scrheadings}
|
|
352
|
+
|
|
353
|
+
% Kurzfassung / abstract
|
|
354
|
+
% auch im Stil vom Inhaltsverzeichnis
|
|
281
355
|
<% break; default: -%>
|
|
282
356
|
\section*{Abstract}
|
|
283
357
|
<% break; } -%>
|
|
@@ -304,6 +378,10 @@ default: -%>
|
|
|
304
378
|
\begin{keywords}
|
|
305
379
|
keyword1, keyword2
|
|
306
380
|
\end{keywords}
|
|
381
|
+
<% break; case "acmart": -%>
|
|
382
|
+
\end{abstract}
|
|
383
|
+
|
|
384
|
+
\maketitle
|
|
307
385
|
<% break; case "ieee": -%>
|
|
308
386
|
\end{abstract}
|
|
309
387
|
|
|
@@ -316,6 +394,49 @@ default: -%>
|
|
|
316
394
|
% For peerreview papers, this IEEEtran command inserts a page break and
|
|
317
395
|
% creates the second title. It will be ignored for other modes.
|
|
318
396
|
\IEEEpeerreviewmaketitle
|
|
397
|
+
<% break; case "scientific-thesis": -%>
|
|
398
|
+
|
|
399
|
+
\microtypesetup{protrusion=false}
|
|
400
|
+
|
|
401
|
+
% In case you have trouble with headings reaching into the page numbers, enable the following three lines.
|
|
402
|
+
% Hint by http://golatex.de/inhaltsverzeichnis-schreibt-ueber-rand-t3106.html
|
|
403
|
+
%
|
|
404
|
+
%\makeatletter
|
|
405
|
+
%\renewcommand{\@pnumwidth}{2em}
|
|
406
|
+
%\makeatother
|
|
407
|
+
%
|
|
408
|
+
% In case of a strange break in the table of contents,
|
|
409
|
+
% a page break can be inserted by issuing the following command at the "right" place in the main text:
|
|
410
|
+
% \addtocontents{toc}{\protect\newpage}
|
|
411
|
+
\tableofcontents
|
|
412
|
+
|
|
413
|
+
\listoffigures
|
|
414
|
+
|
|
415
|
+
\listoftables
|
|
416
|
+
<% if (listings == 'listings') { -%>
|
|
417
|
+
|
|
418
|
+
% We use lstlisting environments with caption paramters.
|
|
419
|
+
% Thus, we need that command.
|
|
420
|
+
% Alternative: \listof{Listing}{List of Listings}
|
|
421
|
+
\lstlistoflistings
|
|
422
|
+
<% } else { -%>
|
|
423
|
+
\listof{Listing}{List of Listings}
|
|
424
|
+
<% } -%>
|
|
425
|
+
|
|
426
|
+
%mittels \newfloat wurde die Algorithmus-Gleitumgebung definiert.
|
|
427
|
+
%Mit folgendem Befehl werden alle floats dieses Typs ausgegeben
|
|
428
|
+
%\listof{Algorithmus}{List of Algorithms}
|
|
429
|
+
%\listofalgorithms %Ist nur für Algorithmen, die mittels \begin{algorithm} umschlossen werden, nötig
|
|
430
|
+
|
|
431
|
+
% Abbreviations
|
|
432
|
+
\printglossaries
|
|
433
|
+
% \printunsrtglossaries cannot be used, because then no indexing happens; source: https://tex.stackexchange.com/a/287128/9075
|
|
434
|
+
|
|
435
|
+
\microtypesetup{protrusion=true}
|
|
436
|
+
|
|
437
|
+
% Headline and footline
|
|
438
|
+
\renewcommand*{\chapterpagestyle}{scrplain}
|
|
439
|
+
\pagestyle{scrheadings}
|
|
319
440
|
<% break; default: -%>
|
|
320
441
|
|
|
321
442
|
\tableofcontents
|
|
@@ -330,7 +451,7 @@ default: -%>
|
|
|
330
451
|
%
|
|
331
452
|
\begin{itemize}
|
|
332
453
|
\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.
|
|
333
|
-
\item[SM2] Clearly and precisely
|
|
454
|
+
\item[SM2] Clearly and precisely \emph{formulate a research problem or hypothesis}.
|
|
334
455
|
\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}. The method must includes steps and criteria for evaluating whether you answered your question successfully or not.
|
|
335
456
|
\item[SM4] \emph{Provide execution details} on how you followed the method in the given, specific situation.
|
|
336
457
|
\item[SM5] \emph{Report your results} by describing and summarizing your measurements. You must not interpret your results.
|
|
@@ -339,7 +460,7 @@ default: -%>
|
|
|
339
460
|
%
|
|
340
461
|
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.
|
|
341
462
|
|
|
342
|
-
\emph{Purpose and scope of <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Chapter~\ref<% } %>{sec:introduction}}. 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. 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. Section~\ref{sec:introduction:topic} introduces the general topic of your research. Section~\ref{sec:introduction:state-of-art} discusses the state of the art and identifies a research. Section~\ref{sec:introduction:research-question} then states the research problem to investigate. Section~\ref{sec:problem-exposition:research-method} explains the research method that was followed, possibly with execution details. Section~\ref{sec:introduction:results} then presents the results and their interpretation. Only if a reader thinks they are not convinced or they need more details to reproduce your study, they shall have to read further. The individual chapters and sections provide the details for each of the steps in your scientific argument.
|
|
463
|
+
\emph{Purpose and scope of <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Chapter~\ref<% } %>{sec:introduction}}. 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. 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. Section~\ref{sec:introduction:topic} introduces the general topic of your research. Section~\ref{sec:introduction:state-of-art} discusses the state of the art and identifies a research. Section~\ref{sec:introduction:research-question} then states the research problem to investigate. Section~\ref{sec:problem-exposition:research-method} explains the research method that was followed, possibly with execution details. Section~\ref{sec:introduction:results} then presents the results and their interpretation. Only if a reader thinks they are not convinced or they need more details to reproduce your study, they shall have to read further. The individual chapters and sections provide the details for each of the steps in your scientific argument.
|
|
343
464
|
|
|
344
465
|
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..
|
|
345
466
|
|
|
@@ -349,8 +470,8 @@ You usually write the introduction chapter \emph{after} you wrote all other chap
|
|
|
349
470
|
<%= heading2 %>{Context and Topic (SM1)}\label{sec:introduction:topic}
|
|
350
471
|
% ---------------------------------------------------------------------------------
|
|
351
472
|
|
|
352
|
-
\emph{Purpose and scope}. You begin with providing the general scientific audience an introduction into the specific topic of your work. 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'').
|
|
353
|
-
It must be understandable by the general scientific public. Every \emph{term} with a specific meaning must be highlighted and introduced in precise language/concepts that only builds on a general scientific background.
|
|
473
|
+
\emph{Purpose and scope}. You begin with providing the general scientific audience an introduction into the specific topic of your work. 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'').
|
|
474
|
+
It must be understandable by the general scientific public. Every \emph{term} with a specific meaning must be highlighted and introduced in precise language/concepts that only builds on a general scientific background.
|
|
354
475
|
|
|
355
476
|
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'').
|
|
356
477
|
|
|
@@ -358,16 +479,16 @@ At the end of this section, you have explained and established a general goal th
|
|
|
358
479
|
<%= heading2 %>{State of the Art (SM1)}\label{sec:introduction:state-of-art}
|
|
359
480
|
% ---------------------------------------------------------------------------------
|
|
360
481
|
|
|
361
|
-
\emph{Purpose and scope}. 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 <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{sec:introduction:topic}. This introduction has to
|
|
482
|
+
\emph{Purpose and scope}. 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 <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{sec:introduction:topic}. This introduction has to
|
|
362
483
|
|
|
363
484
|
\begin{itemize}
|
|
364
|
-
\item present established facts, methods, and results that provide a deeper
|
|
485
|
+
\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.'')
|
|
365
486
|
\item discuss in which ways prior and recent ideas still fall short of reaching the general goal you explained in <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{sec:introduction:topic} (``prior work only sequenced the genome of one giraffe and did not consider genes of ancient ancestors'')
|
|
366
487
|
\end{itemize}
|
|
367
488
|
|
|
368
489
|
You have to provide citations/literature references for each of the statements and claims you are making. This section is usually a summary of the related work discussion in <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Chapter~\ref<% } %>{sec:background}.
|
|
369
490
|
|
|
370
|
-
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 <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{sec:introduction:topic}. \emph{Stating a (knowledge) gap between a status quo and a desired situation is the \emph{first step} of a writing scientific argument.}
|
|
491
|
+
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 <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{sec:introduction:topic}. \emph{Stating a (knowledge) gap between a status quo and a desired situation is the \emph{first step} of a writing scientific argument.}
|
|
371
492
|
|
|
372
493
|
|
|
373
494
|
% ---------------------------------------------------------------------------------
|
|
@@ -388,7 +509,7 @@ You will usually break your general research question down into sub-research que
|
|
|
388
509
|
% ---------------------------------------------------------------------------------
|
|
389
510
|
<%= heading2 %>{Method or Approach (SM3, SM4)}\label{sec:introduction:method}
|
|
390
511
|
% ---------------------------------------------------------------------------------
|
|
391
|
-
|
|
512
|
+
|
|
392
513
|
\emph{Purpose and scope}. 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. It is a summary of the steps that someone else has to take in order to reproduce your steps. 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).
|
|
393
514
|
|
|
394
515
|
The section is most readable if you give each of the steps in your method its own paragraph. 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.
|
|
@@ -405,11 +526,9 @@ You state the evaluation method that is in line with your research question from
|
|
|
405
526
|
|
|
406
527
|
\subsection*{Interpretation (SM6)}
|
|
407
528
|
|
|
408
|
-
You summarize your interpretation of the results and draw conclusions. State whether and to which degree the research question from <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{sec:introduction:research-question} has been answered successfully or not.
|
|
409
|
-
|
|
410
|
-
Finally state briefly how much closer society and science have come in answering the general objective you outlined in <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{sec:introduction:topic}.
|
|
411
|
-
|
|
529
|
+
You summarize your interpretation of the results and draw conclusions. State whether and to which degree the research question from <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{sec:introduction:research-question} has been answered successfully or not.
|
|
412
530
|
|
|
531
|
+
Finally state briefly how much closer society and science have come in answering the general objective you outlined in <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{sec:introduction:topic}.
|
|
413
532
|
|
|
414
533
|
%%% ===============================================================================
|
|
415
534
|
<%= heading1 %>{Background (SM1)}\label{sec:background}
|
|
@@ -419,9 +538,9 @@ Finally state briefly how much closer society and science have come in answering
|
|
|
419
538
|
\begin{itemize}
|
|
420
539
|
|
|
421
540
|
\item \emph{Preliminaries.} 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. 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. Which concepts, terms, definitions, etc. does the student have to know? Which formulas, symbols, etc. are standard in this topic? Only introduce definitions if you actually need them in any of the subsequent chapters.
|
|
422
|
-
|
|
423
|
-
\item \emph{Related Work.} It has to provide a comprehensive discussion of all prior work in the area on this subject. Your discussion has to summarize these prior works and has to explain in which way the research question you are solving (<% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{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 <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{sec:introduction:state-of-art}.
|
|
424
|
-
|
|
541
|
+
|
|
542
|
+
\item \emph{Related Work.} It has to provide a comprehensive discussion of all prior work in the area on this subject. Your discussion has to summarize these prior works and has to explain in which way the research question you are solving (<% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{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 <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{sec:introduction:state-of-art}.
|
|
543
|
+
|
|
425
544
|
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.
|
|
426
545
|
\end{itemize}
|
|
427
546
|
|
|
@@ -429,7 +548,7 @@ Finally state briefly how much closer society and science have come in answering
|
|
|
429
548
|
<%= heading1 %>{Problem Exposition (optional)}\label{sec:problem-exposition}
|
|
430
549
|
%%% ===============================================================================
|
|
431
550
|
|
|
432
|
-
\emph{Purpose and scope}. Introduce the problem context in more detail if <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{sec:introduction:topic} does not provide all necessary information about the problem to follow the rest of the report. This can include further details on the data you studied, context assumptions and requirements, etc.
|
|
551
|
+
\emph{Purpose and scope}. Introduce the problem context in more detail if <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{sec:introduction:topic} does not provide all necessary information about the problem to follow the rest of the report. This can include further details on the data you studied, context assumptions and requirements, etc.
|
|
433
552
|
|
|
434
553
|
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 <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{sec:introduction:research-question} more details for the method <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{sec:introduction:method} because you now have explained the problem much better. A typical structure can be.
|
|
435
554
|
|
|
@@ -449,15 +568,13 @@ provide details
|
|
|
449
568
|
<%= heading2 %>{Detailed Research Questions (SM2)}\label{sec:problem-exposition:research-problems}
|
|
450
569
|
% ---------------------------------------------------------------------------------
|
|
451
570
|
|
|
452
|
-
provide details based on <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{sec:problem-exposition:context-understanding} and
|
|
571
|
+
provide details based on <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{sec:problem-exposition:context-understanding} and \ref{sec:problem-exposition:data-understanding}
|
|
453
572
|
|
|
454
573
|
% ---------------------------------------------------------------------------------
|
|
455
574
|
<%= heading2 %>{Detailed Method (SM3)}\label{sec:problem-exposition:research-method}
|
|
456
575
|
% ---------------------------------------------------------------------------------
|
|
457
576
|
|
|
458
|
-
provide details based on <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{sec:problem-exposition:context-understanding} and
|
|
459
|
-
|
|
460
|
-
|
|
577
|
+
provide details based on <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{sec:problem-exposition:context-understanding} and \ref{sec:problem-exposition:data-understanding}
|
|
461
578
|
|
|
462
579
|
%%% ===============================================================================
|
|
463
580
|
<%= heading1 %>{First Real Chapter addressing first Research Problem}\label{sec:problem1}
|
|
@@ -465,7 +582,7 @@ provide details based on <% if (cleveref) { %>\cref<% } else if (documentclass =
|
|
|
465
582
|
|
|
466
583
|
\emph{Purpose and scope}. After you stated research context (SM1), research problem (SM2), and research method (SM3) in <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Chapter~\ref<% } %>{sec:introduction} and possibly <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Chapter~\ref<% } %>{sec:problem-exposition}, the remainder of your entire report addresses execution (SM4), results (SM5), and interpretation (SM6). You usually do this by addressing various sub-problems again through scientific arguments following the 6 steps SM1-SM6.
|
|
467
584
|
|
|
468
|
-
Have a short chapter introduction that recalls and explains the first research problem of your thesis. The problem has to show up in the introduction in <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{sec:introduction:research-question} or in <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{sec:problem-exposition:research-problems} already. 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.
|
|
585
|
+
Have a short chapter introduction that recalls and explains the first research problem of your thesis. The problem has to show up in the introduction in <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{sec:introduction:research-question} or in <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{sec:problem-exposition:research-problems} already. 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.
|
|
469
586
|
|
|
470
587
|
Next, explain in the chapter intro how you solve the research problem in this chapter by breaking it down in further sub-problems. By this, you outline the method (SM3) through which you are going to solve the problem of this chapter. 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. Explain that you will address the first sub-problem in <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{sec:problem1:subproblem1} and the second sub-problem in <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{sec:problem1:subproblem2}, etc. The sections then provide the details for execution and results.
|
|
471
588
|
|
|
@@ -476,10 +593,10 @@ Next, explain in the chapter intro how you solve the research problem in this ch
|
|
|
476
593
|
\emph{The first paragraph describes the first sub-problem and develops the requirements a solution has to satisfy (SM2 for this section).} The requirements have to be based on the knowledge and reasoning developing in the preceding chapters and sections. Try to use an example to illustrate the problem and the desired properties of the solution. Check that every term/concept you use here has already been defined already in a previous section. 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.
|
|
477
594
|
|
|
478
595
|
\emph{The second paragraph describes the method/approach how you address the problem (SM3 for this section).} Describe the method in a level of detail that allows another student to reproduce your steps.
|
|
479
|
-
Make use of appendices % (see <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{sec:appendix1})
|
|
596
|
+
Make use of appendices % (see <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{sec:appendix1})
|
|
480
597
|
if certain details take too much space.
|
|
481
598
|
|
|
482
|
-
\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.
|
|
599
|
+
\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.
|
|
483
600
|
|
|
484
601
|
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 (``<% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Fig.~\ref<% } else { %>Figure~\ref<% } %>{fig:my_label} shows...'') and describe the results in text. 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. Describe to them how to read these, explain the meaning of particular elements, point out special observations. But you may only describe the results you must not interpret them. Make use of appendices if certain details take too much space.
|
|
485
602
|
|
|
@@ -498,9 +615,9 @@ Ideally, your interpretation leads to the next sub-problem in <% if (cleveref) {
|
|
|
498
615
|
<%= heading2 %>{Second Sub-Problem}\label{sec:problem1:subproblem2}
|
|
499
616
|
% ---------------------------------------------------------------------------------
|
|
500
617
|
|
|
501
|
-
You now build on the solution to the first sub-problem of <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{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).
|
|
618
|
+
You now build on the solution to the first sub-problem of <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{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).
|
|
502
619
|
|
|
503
|
-
Note that not all sections may not include all parts SM1-SM6 in all detail. 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. Sometimes, a section is only dedicated to describing the method (SM3) and execution (SM4) and does not contain any results or interpretations. Sometimes results (SM5) and interpretations (SM6) only come in the evaluation chapter.
|
|
620
|
+
Note that not all sections may not include all parts SM1-SM6 in all detail. 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. Sometimes, a section is only dedicated to describing the method (SM3) and execution (SM4) and does not contain any results or interpretations. Sometimes results (SM5) and interpretations (SM6) only come in the evaluation chapter.
|
|
504
621
|
|
|
505
622
|
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:
|
|
506
623
|
%
|
|
@@ -561,7 +678,7 @@ You only report the measurements. You must present and reference them (``<% if (
|
|
|
561
678
|
An interpretation can only be followed after all results have been described. The interpretation must be based on the written description in <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{sec:evaluation:results} only. Then you can be sure that your readers can follow your interpretation and reach the same conclusions as you have.
|
|
562
679
|
|
|
563
680
|
<% } else { -%>
|
|
564
|
-
<%=
|
|
681
|
+
<%= heading1 %>{Introduction}
|
|
565
682
|
\label{sec:introduction}
|
|
566
683
|
\lipsum[1-3]\todo{Refine me}
|
|
567
684
|
|
|
@@ -570,7 +687,7 @@ The remainder of the paper starts with a presentation of related work (<% if (cl
|
|
|
570
687
|
<% if (!examples && (documentclass == 'ieee')) { %>Afterwards, we present some Lorem Ipsum (<% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{sec:loremipsum}).<% } -%>
|
|
571
688
|
Finally, a conclusion is drawn and outlook on future work is made (<% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{sec:outlook}).
|
|
572
689
|
|
|
573
|
-
<%=
|
|
690
|
+
<%= heading1 %>{Related Work}
|
|
574
691
|
\label{sec:relatedwork}
|
|
575
692
|
|
|
576
693
|
Winery~\cite{Winery} is a graphical \commentontext{modeling}{modeling with one ``l'', because of AE} tool.
|
|
@@ -639,12 +756,18 @@ This <% if (heading1 == "\\chapter") {%>chapter<% } else { %>section<% } %> cont
|
|
|
639
756
|
It focuses on minimal examples, which can be directly adapted to the content
|
|
640
757
|
|
|
641
758
|
<%- include('paragraphs.example.en.tex', this); %>
|
|
759
|
+
<% if (texlive >= 2021) { %><%- include('mindflow.example.en.tex', this); %>
|
|
760
|
+
<% } -%>
|
|
642
761
|
<%- include('hyphenation.example.en.tex', this); %>
|
|
643
762
|
<%- include('siunitx.example.en.tex', this); %>
|
|
644
|
-
<% if (enquotes == 'csquotes') { %><%- include('csquotes.example.en.tex', this);
|
|
645
|
-
<%
|
|
646
|
-
<% if (enquotes == '
|
|
647
|
-
<%
|
|
763
|
+
<% if (enquotes == 'csquotes') { %><%- include('csquotes.example.en.tex', this); %>
|
|
764
|
+
<% } -%>
|
|
765
|
+
<% if (enquotes == 'textcmds') { %><%- include('textcmds.example.en.tex', this); %>
|
|
766
|
+
<% } -%>
|
|
767
|
+
<% if (enquotes == 'plainlatex') { %><%- include('plainlatex.enquotes.example.en.tex', this); %>
|
|
768
|
+
<% } -%>
|
|
769
|
+
<% if (cleveref) { %><%- include('cleveref.example.en.tex', this); %>
|
|
770
|
+
<% } -%>
|
|
648
771
|
<%- include('figure.example.en.tex', this); %>
|
|
649
772
|
<%- include('subfloat.example.en.tex', this); %>
|
|
650
773
|
<%- include('tables.example.en.tex', this); %>
|
|
@@ -654,6 +777,8 @@ It focuses on minimal examples, which can be directly adapted to the content
|
|
|
654
777
|
<%- include('minted.example.en.tex', this); %>
|
|
655
778
|
<% } -%>
|
|
656
779
|
<%- include('paralist.example.en.tex', this); %>
|
|
780
|
+
<% if (feature.acronyms) { %><%- include('acronyms.example.en.tex', this); %>
|
|
781
|
+
<% } -%>
|
|
657
782
|
<%- include('otherfeatures.example.en.tex', this); %>
|
|
658
783
|
<% } -%>
|
|
659
784
|
<% if (howtotext) { -%>
|
|
@@ -664,9 +789,9 @@ It focuses on minimal examples, which can be directly adapted to the content
|
|
|
664
789
|
|
|
665
790
|
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 <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{sec:introduction:state-of-art}. You specifically outline which concrete findings or methodological contributions advance our knowledge towards the general objective you introduced in <% if (cleveref) { %>\cref<% } else if (documentclass == 'lncs') { %>Sect.~\ref<% } else { %>Section~\ref<% } %>{sec:introduction:topic}. Objectively discuss which parts you solved and in which parts you failed.
|
|
666
791
|
|
|
667
|
-
You should explicitly discuss limitations and shortcomings of your work and detail what kind of future studies are needed to overcome these limitations. Be specific in the sense that your arguments for future work should be based on concrete findings and insights you obtained in your report.
|
|
792
|
+
You should explicitly discuss limitations and shortcomings of your work and detail what kind of future studies are needed to overcome these limitations. Be specific in the sense that your arguments for future work should be based on concrete findings and insights you obtained in your report.
|
|
668
793
|
<% } else { -%>
|
|
669
|
-
<% if (!examples && (documentclass == 'ieee')) { -%>
|
|
794
|
+
<% if (!examples && ((documentclass == 'acmart') || (documentclass == 'ieee'))) { -%>
|
|
670
795
|
|
|
671
796
|
<%= heading1 %>{Lorem ipsum}
|
|
672
797
|
\label{sec:loremipsum}
|
|
@@ -680,17 +805,25 @@ You should explicitly discuss limitations and shortcomings of your work and deta
|
|
|
680
805
|
|
|
681
806
|
<% switch (documentclass) { case "lncs": -%>
|
|
682
807
|
\subsubsection*{Acknowledgments}
|
|
683
|
-
<% break; case "ieee": -%>
|
|
684
808
|
|
|
809
|
+
<% break; case "acmart": -%>
|
|
810
|
+
\begin{acks}
|
|
811
|
+
<% break; case "ieee": -%>
|
|
685
812
|
% regular IEEE prefers the singular form
|
|
686
813
|
\section*{Acknowledgment}
|
|
814
|
+
|
|
687
815
|
<% break; default: -%>
|
|
688
816
|
<% break; } -%>
|
|
689
|
-
<% if ((documentclass == 'lncs') || (documentclass
|
|
817
|
+
<% if ((documentclass == 'acmart') || (documentclass == 'lncs') || (documentclass == 'ieee')) { -%>
|
|
818
|
+
Identification of funding sources and other support, and thanks to individuals and groups that assisted in the research and the preparation of the work should be included in an acknowledgment section, which is placed just before the reference section in your document \cite{acmart}.
|
|
690
819
|
<% if (howtotext) { -%>
|
|
820
|
+
|
|
691
821
|
The hints on writing a paper/thesis are taken from Dirk Fahland's \href{https://github.com/dfahland/Master-or-Bachelor-thesis-Template-Eindhoven-University-of-Technology}{LaTeX template for Bachelor and Master theses at Eindhoven University of Technology}.
|
|
692
|
-
<% }
|
|
693
|
-
|
|
822
|
+
<% } -%>
|
|
823
|
+
<% if (documentclass == 'acmart') { -%>
|
|
824
|
+
|
|
825
|
+
For more \LaTeX{} hints for ACM read on at \url{https://www.acm.org/publications/taps/latex-best-practices}.
|
|
826
|
+
\end{acks}
|
|
694
827
|
<% } -%>
|
|
695
828
|
<% } -%>
|
|
696
829
|
|
|
@@ -714,6 +847,10 @@ See \url{https://help.jabref.org/en/CleanupEntries} for an overview of the clean
|
|
|
714
847
|
\small % ensure correct font size for the bibliography
|
|
715
848
|
\bibliography{<%= filenames.bib %>}
|
|
716
849
|
\endgroup
|
|
850
|
+
<% break; case "acmart": -%>
|
|
851
|
+
|
|
852
|
+
\bibliographystyle{ACM-Reference-Format}
|
|
853
|
+
\bibliography{<%= filenames.bib %>}
|
|
717
854
|
<% break; case "ieee": -%>
|
|
718
855
|
|
|
719
856
|
% trigger a \newpage just before the given reference
|
|
@@ -730,7 +867,10 @@ See \url{https://help.jabref.org/en/CleanupEntries} for an overview of the clean
|
|
|
730
867
|
\bibliographystyle{IEEEtranN} % IEEEtranN is the natbib compatible bst file
|
|
731
868
|
% argument is your BibTeX string definitions and bibliography database(s)
|
|
732
869
|
\bibliography{<%= filenames.bib %>}
|
|
733
|
-
<%
|
|
870
|
+
<% break; case "scientific-thesis": -%>
|
|
871
|
+
|
|
872
|
+
\printbibliography
|
|
873
|
+
<% break; default: -%>
|
|
734
874
|
|
|
735
875
|
\bibliographystyle{plain}
|
|
736
876
|
\bibliography{<%= filenames.bib %>}
|
|
@@ -740,10 +880,11 @@ See \url{https://help.jabref.org/en/CleanupEntries} for an overview of the clean
|
|
|
740
880
|
\ \\
|
|
741
881
|
%
|
|
742
882
|
All links were last followed on October 5, 2020.
|
|
743
|
-
|
|
883
|
+
|
|
884
|
+
<% switch (documentclass) { case "lncs": -%>
|
|
744
885
|
|
|
745
886
|
%%% ===============================================================================
|
|
746
|
-
%\appendix
|
|
887
|
+
%\appendix
|
|
747
888
|
%\addcontentsline{toc}{chapter}{APPENDICES}
|
|
748
889
|
|
|
749
890
|
%\listoffigures
|
|
@@ -753,6 +894,22 @@ All links were last followed on October 5, 2020.
|
|
|
753
894
|
%%% ===============================================================================
|
|
754
895
|
%<%= heading1 %>{My first appendix}\label{sec:appendix1}
|
|
755
896
|
%%% ===============================================================================
|
|
756
|
-
<%
|
|
897
|
+
<% break; case "scientific-thesis": -%>
|
|
898
|
+
|
|
899
|
+
%%% ===============================================================================
|
|
900
|
+
\appendix
|
|
901
|
+
\addcontentsline{toc}{chapter}{Appendices}
|
|
902
|
+
|
|
903
|
+
%\listoffigures
|
|
904
|
+
%\listoftables
|
|
905
|
+
%%% ===============================================================================
|
|
757
906
|
|
|
907
|
+
%%% ===============================================================================
|
|
908
|
+
%<%= heading1 %>{My first appendix}\label{sec:appendix1}
|
|
909
|
+
%%% ===============================================================================
|
|
910
|
+
|
|
911
|
+
\pagestyle{empty}
|
|
912
|
+
\renewcommand*{\chapterpagestyle}{empty}
|
|
913
|
+
\Versicherung
|
|
914
|
+
<% break; } -%>
|
|
758
915
|
\end{document}
|