generator-latex-template 0.7.0 → 0.8.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.
Files changed (28) hide show
  1. package/README.md +19 -17
  2. package/generators/app/index.js +222 -568
  3. package/generators/app/options.js +375 -0
  4. package/generators/app/templates/Dockerfile.dante +3 -1
  5. package/generators/app/templates/Dockerfile.iot +14 -0
  6. package/generators/app/templates/Dockerfile.reitzig +12 -11
  7. package/generators/app/templates/README.en.md +4 -10
  8. package/generators/app/templates/Texlivefile +28 -3
  9. package/generators/app/templates/babel.preamble.de.tex +3 -1
  10. package/generators/app/templates/babel.preamble.en.tex +1 -1
  11. package/generators/app/templates/csquotes.example.de.tex +1 -1
  12. package/generators/app/templates/csquotes.example.en.tex +1 -1
  13. package/generators/app/templates/csquotes.preamble.en.tex +1 -1
  14. package/generators/app/templates/figure.example.de.tex +18 -0
  15. package/generators/app/templates/hyphenation.example.en.tex +1 -1
  16. package/generators/app/templates/latexmkrc +1 -3
  17. package/generators/app/templates/main.de.tex +581 -139
  18. package/generators/app/templates/main.en.tex +11 -17
  19. package/generators/app/templates/microtype.preamble.de.tex +5 -0
  20. package/generators/app/templates/natbib.preamble.en.tex +1 -1
  21. package/generators/app/templates/siunitx.example.en.tex +1 -1
  22. package/generators/app/templates/siunitx.preamble.de.tex +2 -0
  23. package/generators/app/templates/siunitx.preamble.en.tex +0 -1
  24. package/generators/app/templates/subfig.preamble.en.tex +1 -1
  25. package/generators/app/templates/url.preamble.de.tex +2 -0
  26. package/package.json +15 -16
  27. package/generators/app/templates/refcheck.example.en.tex +0 -36
  28. package/generators/app/templates/refcheck.preamble.en.tex +0 -4
@@ -1,36 +1,64 @@
1
1
  <% if (preparereitzig) { -%>
2
2
  \RequirePackage{snapshot}
3
3
  <% } -%>
4
- <% if (documentclass == 'lncs') { -%>
4
+ <% switch (documentclass) { case "lncs": -%>
5
5
  % Dieses Template wurde mit der "LLNCS DOCUMENT CLASS -- version 2.21 (12-Jan-2022)" getestet
6
6
 
7
- <% } -%>
7
+ <% break; case "ieee": -%>
8
+ % This template has been tested with IEEEtran of 2015.
9
+
10
+ <% break; } -%>
8
11
  % !TeX spellcheck = de-DE
9
12
  % LTeX: language=de-DE
10
13
  % !TeX encoding = utf8
11
14
  % !TeX program = <%= latexcompiler %>
15
+ <% if (requiresShellEscape) { -%>
16
+ % !TeX TXS-program:compile = txs:///<%= latexcompiler %>/[--shell-escape]
17
+ <% } -%>
12
18
  % !BIB program = <%= bibtextool %>
13
19
  % -*- coding:utf-8 mod:LaTeX -*-
14
- <% if (documentclass == 'scientific-thesis') { -%>
20
+ <% switch (documentclass) { case "lncs": -%>
21
+
22
+ % "a4paper" enables:
23
+ %
24
+ % - easy print out on DIN A4 paper size
25
+ %
26
+ % One can configure a4 vs. letter in the LaTeX installation. So it is configuration dependend, what the paper size will be.
27
+ % This option present, because the current word template offered by Springer is DIN A4.
28
+ % We accept that DIN A4 cause WTFs at persons not used to A4 in USA.
29
+ %
30
+ % "runningheads":
31
+ %
32
+ % - zeigt Author + Titel auf jeder Seite.
33
+ % - Während des Schreibens und das Review des Papers hilft das, um z.B. auf konkrete Seitenzahlen einfach verweisen zu können.
34
+ %
35
+ % This is good for other readers to enable proper archiving among other papers and pointing to
36
+ % content. Even if the title page states the title, when printed and stored in a folder, when
37
+ % blindly opening the folder, one could hit not the title page, but an arbitrary page. Therefore,
38
+ % it is good to have title printed on the pages, too.
39
+ %
40
+ % Diese Option nach Aufforderung durch die Herausgeber entfernen.
41
+ %
42
+ % To disable outputting page headers and footers, remove "runningheads"
43
+ \documentclass[runningheads,<%= papersize %>paper,ngerman]{llncs}[2022/01/12]
44
+ <% break; case "acmart": -%>
45
+
46
+ % Alternative to balance is the pbalance package (see https://ctan.org/pkg/pbalance), which sometimes works better
47
+ \documentclass[<%= acmformat %>,<% if (acmreview) { %>review,<% } %><%= papersize %>paper,balance]{acmart}
48
+ <% break; case "ieee": -%>
49
+
50
+ % DO NOT DOWNLOAD IEEEtran.cls - Use the one of your LaTeX distribution
51
+ % For the final version, replace "draftcls" by "final"
52
+ \documentclass[<%= ieeevariant %>,<%= papersize %>paper,ngerman]{IEEEtran}[2015/08/26]
53
+
54
+ % Balance the last page using the balance package (see https://ctan.org/pkg/balance)
55
+ % Alternative to balance is the pbalance package (see https://ctan.org/pkg/pbalance), which sometimes works better
56
+ \usepackage{balance}
57
+ <% break; case "scientific-thesis": -%>
15
58
 
16
59
  % The following package allows \\ at the title page
17
60
  % For more information see https://github.com/latextemplates/scientific-thesis-cover/issues/4
18
61
  \RequirePackage{kvoptions-patch}
19
- <% } -%>
20
- <% if (latexcompiler !== 'lualatex') { -%>
21
-
22
- % Neue deutsche Trennmuster
23
- % Siehe http://www.ctan.org/pkg/dehyph-exptl und http://projekte.dante.de/Trennmuster/WebHome
24
- % Nur für pdflatex, nicht für lualatex
25
- \RequirePackage[ngerman=ngerman-x-latest]{hyphsubst}
26
- <% } -%>
27
-
28
- <% if (documentclass == 'lncs') { -%>
29
- % "runningheads" zeigt Author + Titel auf jeder Seite.
30
- % Diese Option nach Aufforderung durch die Herausgeber entfernen.
31
- % Während des Schreibens und das Review des Papers hilft das, um z.B. auf konkrete Seitenzahlen einfach verweisen zu können.
32
- \documentclass[runningheads,a4paper,ngerman]{llncs}[2022/01/12]
33
- <% } else {-%>
34
62
  \documentclass[
35
63
  % fontsize=11pt is the standard
36
64
  % ()Aus scrguide.pdf - der Dokumentation von KOMA-Script)
@@ -45,13 +73,24 @@
45
73
  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)
46
74
  bibliography=totoc,
47
75
  % idxtotoc, % Index ins Inhaltsverzeichnis
48
- % liststotoc, % List of X ins Inhaltsverzeichnis, mit liststotocnumbered werden die Abbildungsverzeichnisse nummeriert
76
+ % liststotoc, % List of * ins Inhaltsverzeichnis, mit liststotocnumbered werden die Abbildungsverzeichnisse nummeriert
49
77
  headsepline,
50
78
  cleardoublepage=empty,
51
79
  parskip=half,
52
80
  % draft % um zu sehen, wo noch nachgebessert werden muss - wichtig, da Bindungskorrektur mit drin
53
81
  draft=false
54
82
  ]{scrbook}
83
+ \usepackage{scrlayer-scrpage}
84
+ \ihead[]{}
85
+ \chead[]{}
86
+ \ohead[]{\headmark}
87
+ \cfoot[]{}
88
+ \ofoot[\usekomafont{pagenumber}\thepage]{\usekomafont{pagenumber}\thepage}
89
+ \ifoot[]{}
90
+ <% break; default: -%>
91
+
92
+ % not yet supported template. Please report to the author of generator-latex-template
93
+ \documentclass{scrbook}
55
94
  <% } -%>
56
95
 
57
96
  % backticks (`) werden als solches in verbatim-Umgebungen dargestellt
@@ -62,9 +101,15 @@
62
101
  \usepackage{upquote}
63
102
 
64
103
  <%- include('babel.preamble.de.tex', this); %>
65
- <%- include('url.preamble.de.tex', this); %>
66
- <%- include('font.preamble.en.tex', this); %>
67
- <%- include('microtype.preamble.de.tex', this); %>
104
+
105
+ <%- include('url.preamble.de.tex', this); -%>
106
+ <%# ACM already provides a very good font configuration; thus we do not need to override it -%>
107
+ <% if (documentclass != 'acmart') { %>
108
+ <%- include('font.preamble.en.tex', this); -%>
109
+ <% } -%>
110
+
111
+ <%- include('microtype.preamble.de.tex', this); -%>
112
+
68
113
  \usepackage{graphicx}
69
114
 
70
115
  <%- include('diagbox.preamble.en.tex', this); -%>
@@ -73,34 +118,30 @@
73
118
  \usepackage{xcolor}
74
119
 
75
120
  <% if (listings == 'listings') { -%>
76
- <%- include('listings.preamble.de.tex', this); %>
121
+ <%- include('listings.preamble.de.tex', this); -%>
77
122
  <% } else { -%>
78
- <%- include('minted.preamble.en.tex', this); %>
123
+ <%- include('minted.preamble.en.tex', this); -%>
79
124
  <% } -%>
80
125
 
81
- <% if (enquotes == 'csquotes') { %><%- include('csquotes.preamble.en.tex', this); %><% } -%>
82
- <% if (enquotes == 'textcmds') { %><%- include('textcmds.preamble.en.tex', this); %><% } -%>
83
-
84
- <%- include('booktabs.preamble.en.tex', this); %>
85
- <%- include('paralist.preamble.en.tex', this); %>
86
- <% if (documentclass == 'lncs') { -%>
87
- <%- include('floatflt.preamble.en.tex', this); %>
88
- % Bibliopgraphy enhancements
89
- % - enable \cite[prenote][]{ref}
90
- % - enable \cite{ref1,ref2}
91
- % Alternative: \usepackage{cite}, which enables \cite{ref1, ref2} only (otherwise: Error message: "White space in argument")
92
-
93
- % Doc: http://texdoc.net/natbib
94
- \usepackage[%
95
- square, % for square brackets
96
- comma, % use commas as separators
97
- numbers, % for numerical citations;
98
- % sort, % orders multiple citations into the sequence in which they appear in the list of references;
99
- sort&compress, % as sort but in addition multiple numerical citations
100
- % are compressed if possible (as 3-6, 15);
101
- ]{natbib}
102
- % In the bibliography, references have to be formatted as 1., 2., ... not [1], [2], ...
103
- \renewcommand{\bibnumfmt}[1]{#1.}
126
+ <% if (enquotes == 'csquotes') { %><%- include('csquotes.preamble.en.tex', this); %><% } -%>
127
+ <% if (enquotes == 'textcmds') { %><%- include('textcmds.preamble.en.tex', this); %><% } -%>
128
+
129
+ <%- include('booktabs.preamble.en.tex', this); -%>
130
+
131
+ <%- include('paralist.preamble.en.tex', this); -%>
132
+ <% switch (documentclass) {
133
+ case "acmart":
134
+ case "ieee":
135
+ case "lncs": -%>
136
+
137
+ <%- include('natbib.preamble.en.tex', this); -%>
138
+ <% break; case "scientific-thesis": -%>
139
+ <%- include('biblatex.preamble.en.tex', this); -%>
140
+ <% break; } -%>
141
+ <% switch (documentclass) { case "acmart": -%>
142
+
143
+ \citestyle{acmnumeric} % alternative: acmauthoryear
144
+ <% break; case "lncs": -%>
104
145
 
105
146
  % Prepare more space-saving rendering of the bibliography
106
147
  % Source: https://tex.stackexchange.com/a/280936/9075
@@ -112,11 +153,14 @@
112
153
  { encoding = {OT1,T1,TS1} }
113
154
  { }
114
155
 
115
- <% } -%>
156
+ <%- include('floatflt.preamble.en.tex', this); -%>
157
+ <% break; } -%>
116
158
  <% if (todo == 'pdfcomment') { -%>
117
- <%- include('pdfcomment.preamble.en.tex', this); %>
159
+
160
+ <%- include('pdfcomment.preamble.en.tex', this); -%>
118
161
  <% } else { -%>
119
- <%- include('plainlatextodo.preamble.en.tex', this); %>
162
+
163
+ <%- include('plainlatextodo.preamble.en.tex', this); -%>
120
164
  <% } -%>
121
165
 
122
166
  % Fußnoten unter Gleitumgebungen ("floats") platzieren
@@ -124,9 +168,12 @@
124
168
  \usepackage{stfloats}
125
169
  \fnbelowfloat
126
170
 
127
- <%- include('siunitx.preamble.en.tex'); %>
171
+ <%- include('siunitx.preamble.de.tex'); %>
128
172
  <%- include('hyperref.preamble.de.tex', this); %>
129
- <% if (texlive >= 2021) { %><%- include('mindflow.preamble.en.tex', this); %><% } -%>
173
+ <%- include('subfig.preamble.en.tex', this); %>
174
+ <% if (texlive >= 2021) { %><%- include('mindflow.preamble.en.tex', this); %>
175
+ <% } -%>
176
+ <% if (feature.acronyms) { -%>\usepackage{amsmath}<% } // acronyms load amsmath, which has to be loaded before cleveref -%>
130
177
  <%- include('cleveref.preamble.de.tex', this); %>
131
178
  \usepackage{lipsum}
132
179
  <% if (examples) { -%>
@@ -142,7 +189,13 @@
142
189
  <% } -%>
143
190
  <% } -%>
144
191
 
145
- <%- include('powerset.preamble.en.tex', this); %>
192
+ <%- include('powerset.preamble.en.tex', this); -%>
193
+
194
+ \usepackage{xspace}
195
+ %\newcommand{\eg}{e.\,g.\xspace}
196
+ %\newcommand{\ie}{i.\,e.\xspace}
197
+ \newcommand{\eg}{e.\,g.,\ }
198
+ \newcommand{\ie}{i.\,e.,\ }
146
199
 
147
200
  % Enable hyphenation at other places as the dash.
148
201
  % Example: applicaiton\hydash specific
@@ -153,27 +206,34 @@
153
206
 
154
207
  % correct bad hyphenation here
155
208
  \hyphenation{op-tical net-works semi-conduc-tor}
156
- <% if (documentclass == 'lncs') { -%>
209
+ <% switch (documentclass) { case "acmart": -%>
210
+
211
+ \acmConference[short-conference-name]{full-conference-name}{November 02--06, 2021}{City, Country}
212
+ \acmDOI{10.1145/9999997.9999999}
213
+ %\startPage{457}
214
+ <% break; case "lncs": -%>
157
215
 
158
216
  % Add copyright
159
- % Do that for the final version or if you send it to colleagues
217
+ %
218
+ % This is recommended if you intend to send the version to colleagues
219
+ % See https://ctan.org/pkg/llncsconf for details
160
220
  \iffalse
161
- %state: intended|submitted|llncs
162
- %you can add "crop" if the paper should be cropped to the format Springer is publishing
221
+ % state: intended | submitted | llncs
222
+ % you can add "crop" if the paper should be cropped to the format Springer is publishing
163
223
  \usepackage[intended]{llncsconf}
164
224
 
165
225
  \conference{name of the conference}
166
226
 
167
- %in case of "llncs" (final version!)
168
- %example: llncs{Anonymous et al. (eds). \emph{Proceedings of the International Conference on \LaTeX-Hacks}, LNCS~42. Some Publisher, 2016.}{0042}
169
- \llncs{book editors and title}{0042} %% 0042 is the start page
227
+ % in case of "proceedings" (final version!)
228
+ % example: \llncs{Anonymous et al. (eds). \emph{Proceedings of the International Conference on \LaTeX-Hacks}, LNCS~42. Some Publisher, 2016.}{0042}
229
+ % 0042 denotes an example start page
230
+ \llncs{book editors and title}{0042}
170
231
  \fi
171
- <% } -%>
172
- <% if (documentclass == 'scientific-thesis') { -%>
232
+ <% break; case "scientific-thesis": -%>
173
233
 
174
234
  <% if (feature.acronyms) { -%><%- include('acronyms.preamble.en.tex', this); %><% } -%>
175
- <%- include('scientific-thesis-cover.preamble.de.tex', this); %>
176
- <% } -%>
235
+ <%- include('scientific-thesis-cover.preamble.en.tex', this); %>
236
+ <% break; } -%>
177
237
  <% if (latexcompiler == "pdflatex") { -%>
178
238
 
179
239
  % Enable copy and paste of text from the PDF
@@ -223,47 +283,116 @@
223
283
  \maketitle
224
284
 
225
285
  \begin{abstract}
226
- \lipsum[1]
227
- \end{abstract}
286
+ <% break; case "acmart": -%>
287
+ \title{Paper Title}
288
+ \author{First Author}
289
+ \orcid{ORCID}
290
+ \affiliation{%
291
+ \department{Department}
292
+ \institution{Institution}
293
+ \city{City}
294
+ \country{Country}
295
+ }
296
+ \email{first.last@example.com}
228
297
 
229
- \begin{keywords}
230
- keyword1, keyword2
231
- \end{keywords}
298
+ \begin{abstract}
299
+ <% break; case "ieee": -%>
300
+ % Enable following command if you need to typeset "IEEEpubid".
301
+ % See https://bytefreaks.net/tag/ieeeoverridecommandlockouts for details.
302
+ %\IEEEoverridecommandlockouts
303
+
304
+ \title{Quick start for LaTeXing with IEEEtran.cls for\\ IEEE Computer Society Conferences}
305
+
306
+ \author{%
307
+ \IEEEauthorblockN{First Author, Second Author}
308
+ \IEEEauthorblockA{University of Examples, Germany\\
309
+ \{lastname\}@example.org}
310
+ \and
311
+ \IEEEauthorblockN{Third Author}
312
+ \IEEEauthorblockA{School of Electrical and\\Computer Examples\\
313
+ Georgia Institute of Examples\\
314
+ Atlanta, Georgia 30332--0250\\
315
+ \url{http://www.example.org}}
316
+ }
232
317
 
233
- \section{Introduction}
234
- \label{sec:intro}
235
- \lipsum[1-3]\todo{Refine me}
318
+ % use for special paper notices
319
+ %\IEEEspecialpapernotice{(Invited Paper)}
236
320
 
237
- The remainder of the paper starts with a presentation of related work (\cref{sec:relatedwork}).
238
- <% if (examples) { %>It is followed by a presentation of hints on \LaTeX{} (\cref{sec:latexhints}).
239
- <% } -%>
240
- <% if (!examples && (documentclass == 'ieee')) { %>Afterwards, we present some Lorem Ipsum (\cref{sec:loremipsum}).
241
- <% } -%>
242
- Finally, a conclusion is drawn and outlook on future work is made (\cref{sec:outlook}).
321
+ % make the title area
322
+ \maketitle
243
323
 
244
- \section{Related Work}
245
- \label{sec:relatedwork}
324
+ % In case you want to add a copyright statement.
325
+ % Works only in the compsoc conference mode.
326
+ %
327
+ % Source: https://tex.stackexchange.com/a/325013/9075
328
+ %
329
+ % All possible solutions:
330
+ % - https://tex.stackexchange.com/a/325013/9075
331
+ % - https://tex.stackexchange.com/a/279134/9075
332
+ % - https://tex.stackexchange.com/q/279789/9075 (TikZ)
333
+ % - https://tex.stackexchange.com/a/200330/9075 - for non-compsocc papers
334
+ \iffalse
335
+ \IEEEoverridecommandlockouts
336
+ \IEEEpubid{\begin{minipage}{\textwidth}\ \\[12pt] \centering
337
+ 1551-3203 \copyright 2015 IEEE.
338
+ Personal use is permitted, but republication/redistribution requires IEEE permission.
339
+ \\
340
+ See \url{https://www.ieee.org/publications_standards/publications/rights/index.html} for more information.
341
+ \end{minipage}}
342
+ \fi
246
343
 
247
- Winery~\cite{Winery} is a graphical \commentontext{modeling}{modeling with one ``l'', because of AE} tool.
248
- The whole idea of TOSCA is explained by <% if (available.citet) { %>\citet<% } else { %>Binz et al.~\cite<% } %>{Binz2009}.
249
- <% break;
250
- default: -%>
344
+ \begin{abstract}
345
+ <% break; case "scientific-thesis": -%>
251
346
  \pagenumbering{arabic}
252
347
  \Titelblatt
253
348
 
254
- %Eigener Seitenstil fuer die Kurzfassung und das Inhaltsverzeichnis
255
- \deftriplepagestyle{preamble}{}{}{}{}{}{\pagemark}
256
- %Doku zu deftriplepagestyle: scrguide.pdf
257
- \pagestyle{preamble}
258
- \renewcommand*{\chapterpagestyle}{preamble}
349
+ \pagestyle{plain.scrheadings}
350
+ \renewcommand*{\chapterpagestyle}{plain.scrheadings}
259
351
 
260
- %Kurzfassung / abstract
261
- %auch im Stil vom Inhaltsverzeichnis
352
+ % Kurzfassung / abstract
353
+ % auch im Stil vom Inhaltsverzeichnis
262
354
  \section*{Kurzfassung}
355
+ <% break; default: -%>
356
+ <% break; } -%>
357
+ <% if (howtotext) { -%>
358
+ \emph{Write an abstract for your work. Replace each of the points below with one sentence (two if you must) and you have your abstract. Write it when you finished your entire report.\footnote{https://www.easterbrook.ca/steve/2010/01/how-to-write-a-scientific-abstract-in-six-easy-steps/}}
359
+
360
+ \emph{Introduction.} In one sentence, what’s the topic? Phrase it in a way that your reader will understand. 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. 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.
263
361
 
362
+ \emph{State the problem you tackle.} What’s the key research question? Again, in one sentence. (Note: For a more general essay, I’d adjust this slightly to state the central question that you want to address) Remember, your first sentence introduced the overall topic, so now you can build on that, and focus on one key question within that topic. 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. Keep working at this step until you have a single, concise (and understandable) question.
363
+
364
+ \emph{Summarize (in one sentence) why nobody else has adequately answered the research question yet.} For a PhD thesis, you’ll have an entire chapter, covering what’s been done previously in the literature. Here you have to boil that down to one sentence. 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). But here you’re phrasing it in such a way that it’s clear it’s a gap in the literature. So use a phrase such as “previous work has failed to address…”. (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)
365
+
366
+ \emph{Explain, in one sentence, how you tackled the research question.} What’s your big new idea? (Again for a more general essay, you might want to adapt this slightly: what’s the new perspective you have adopted? or: What’s your overall view on the question you introduced in step 2?)
367
+
368
+ \emph{In one sentence, how did you go about doing the research that follows from your big idea.} Did you run experiments? Build a piece of software? Carry out case studies? 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. But don’t overdo it – we’re still looking for a sentence that you could read aloud without having to stop for breath. Remember, the word ‘abstract’ means a summary of the main ideas with most of the detail left out. So feel free to omit detail! (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).
369
+
370
+ \emph{As a single sentence, what’s the key impact of your research? Here we’re not looking for the outcome of an experiment.} We’re looking for a summary of the implications. What’s it all mean? Why should other people care? What can they do with your research. (Essay folks: all the same questions apply: what conclusions did you draw, and why would anyone care about them?)
371
+ <% } else { -%>
264
372
  <Kurzfassung der Arbeit>
373
+ <% } -%>
374
+ <% switch (documentclass) { case "lncs": -%>
265
375
 
266
- \cleardoublepage
376
+ \keywords{First keyword \and Second keyword \and Third keyword}
377
+ \end{abstract}
378
+
379
+ <% break; case "acmart": -%>
380
+ \end{abstract}
381
+
382
+ \maketitle
383
+ <% break; case "ieee": -%>
384
+ \end{abstract}
385
+
386
+ % For peer review papers, you can put extra information on the cover
387
+ % page as needed:
388
+ % \ifCLASSOPTIONpeerreview
389
+ % \begin{center} \bfseries EDICS Category: 3-BBND \end{center}
390
+ % \fi
391
+ %
392
+ % For peerreview papers, this IEEEtran command inserts a page break and
393
+ % creates the second title. It will be ignored for other modes.
394
+ \IEEEpeerreviewmaketitle
395
+ <% break; case "scientific-thesis": -%>
267
396
 
268
397
  \microtypesetup{protrusion=false}
269
398
 
@@ -289,8 +418,7 @@ default: -%>
289
418
  % Alternative: \listof{Listing}{List of Listings}
290
419
  \lstlistoflistings
291
420
  <% } else { -%>
292
-
293
- \listof{Listing}{Verzeichnis der Listings}
421
+ \listoflistings
294
422
  <% } -%>
295
423
 
296
424
  %mittels \newfloat wurde die Algorithmus-Gleitumgebung definiert.
@@ -299,59 +427,283 @@ default: -%>
299
427
  %\listofalgorithms %Ist nur für Algorithmen, die mittels \begin{algorithm} umschlossen werden, nötig
300
428
 
301
429
  % Abkürzungsverzeichnis
302
- \printnoidxglossaries
430
+ \printglossaries
431
+ % \printnoidxglossaries
432
+ % \printunsrtglossaries cannot be used, because then no indexing happens; source: https://tex.stackexchange.com/a/287128/9075
303
433
 
304
434
  \microtypesetup{protrusion=true}
305
435
 
306
436
  % Headline and footline
307
437
  \renewcommand*{\chapterpagestyle}{scrplain}
308
438
  \pagestyle{scrheadings}
309
- \pagestyle{scrheadings}
310
- \ihead[]{}
311
- \chead[]{}
312
- \ohead[]{\headmark}
313
- \cfoot[]{}
314
- \ofoot[\usekomafont{pagenumber}\thepage]{\usekomafont{pagenumber}\thepage}
315
- \ifoot[]{}
439
+ <% break; default: -%>
316
440
 
317
- \chapter{Einleitung}
318
- In diesem Kapitel steht die Einleitung zu dieser Arbeit.
319
- Sie soll nur als Beispiel dienen und hat nichts mit dem Buch \cite{WSPA} zu tun.
320
- Nun viel Erfolg bei der Arbeit!
441
+ \tableofcontents
442
+ <% break; } -%>
321
443
 
322
- Bei \LaTeX\ werden Absätze durch freie Zeilen angegeben.
323
- Da die Arbeit über ein Versionskontrollsystem versioniert wird, ist es sinnvoll, pro \emph{Satz} eine neue Zeile im \texttt{.tex}-Dokument anzufangen.
324
- So kann einfacher ein Vergleich von Versionsständen vorgenommen werden.
444
+ <% if (howtotext) { -%>
445
+ %%% ===============================================================================
446
+ <%= heading1 %>{Introduction}\label{sec:introduction}
447
+ %%% ===============================================================================
325
448
 
326
- Die Arbeit ist in folgender Weise gegliedert:
327
- In \cref{chap:k2} werden die Grundlagen dieser Arbeit beschrieben.
328
- Schließlich fasst \cref{chap:zusfas} die Ergebnisse der Arbeit zusammen und stellt Anknüpfungspunkte vor.
449
+ \emph{Purpose and scope of your entire report}. The purpose of your entire report is to make a \emph{scientific argument using the scientific method}. A scientific argument always has the following steps that all must come in this order.
450
+ %
451
+ \begin{itemize}
452
+ \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.
453
+ \item[SM2] Clearly and precisely \emph{formulate a research problem or hypothesis}.
454
+ \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.
455
+ \item[SM4] \emph{Provide execution details} on how you followed the method in the given, specific situation.
456
+ \item[SM5] \emph{Report your results} by describing and summarizing your measurements. You must not interpret your results.
457
+ \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.
458
+ \end{itemize}
459
+ %
460
+ 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.
329
461
 
462
+ \emph{Purpose and scope of \cref{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.
330
463
 
331
- \chapter{Kapitel zwei}
332
- \label{chap:k2}
464
+ 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..
333
465
 
334
- Hier wird der Hauptteil stehen.
335
- Falls mehrere Kapitel gewünscht, entweder mehrmals \texttt{\textbackslash{}chapter} benutzen oder pro Kapitel eine eigene Datei anlegen und \texttt{ausarbeitung.tex} anpassen.
466
+ \emph{Purpose and scope of the introduction paragraph to a chapter}. The paragraph you are reading above is a typical introductory paragraph to a chapter. It is a high-level summary of the chapters' topic (SM1 and SM2). 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). It may close with announcing the result you obtain (SM6) but this is usually not done in the opening paragraph of the introduction.
336
467
 
337
- LaTeX-Hinweise stehen in \cref{chap:latextipps}.
468
+ % ---------------------------------------------------------------------------------
469
+ <%= heading2 %>{Context and Topic (SM1)}\label{sec:introduction:topic}
470
+ % ---------------------------------------------------------------------------------
338
471
 
339
- %noch etwas Fülltext
340
- \blinddocument
472
+ \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'').
473
+ 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.
341
474
 
342
- \chapter{Verwandte Arbeiten}
343
- Eine Beschreibung relevanter wissenschaftlicher Arbeiten mit Bezug zur eigenen Arbeit. Der Abschnitt kann je nach Kontext auch an anderer Stelle stehen.
475
+ 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'').
344
476
 
345
- \chapter{Zusammenfassung und Ausblick}\label{chap:zusfas}
346
- Hier bitte einen kurzen Durchgang durch die Arbeit.
477
+ % ---------------------------------------------------------------------------------
478
+ <%= heading2 %>{State of the Art (SM1)}\label{sec:introduction:state-of-art}
479
+ % ---------------------------------------------------------------------------------
347
480
 
348
- \section*{Ausblick}
349
- ...und anschließend einen Ausblick
350
- <% break; } -%>
481
+ \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 \cref{sec:introduction:topic}. This introduction has to
482
+
483
+ \begin{itemize}
484
+ \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.'')
485
+ \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'')
486
+ \end{itemize}
487
+
488
+ 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 \cref{sec:background}.
489
+
490
+ 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}. \emph{Stating a (knowledge) gap between a status quo and a desired situation is the \emph{first step} of a writing scientific argument.}
491
+
492
+
493
+ % ---------------------------------------------------------------------------------
494
+ <%= heading2 %>{Research Question (SM2)}\label{sec:introduction:research-question}
495
+ % ---------------------------------------------------------------------------------
496
+
497
+ \emph{Purpose and scope}. 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}. You usually cannot address and resolve the entire knowledge gap in your work. The purpose of this section is to clearly detail the specific part of the knowledge that you will address. 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'').
498
+
499
+ Your general research question states
500
+ \begin{itemize}
501
+ \item The starting point/assumptions you are making from which your research starts (``for the given 13 genomes of female giraffes...''), and
502
+ \item the final objective/solution you want to reach (``...identify the genes involved in color expression of giraffe tongues...'')
503
+ \item and the evaluation criteria that will determine whether you are successful (``...that are present in at least 75\% of the studied giraffes'')
504
+ \end{itemize}
505
+
506
+ You will usually break your general research question down into sub-research questions. You may do this here. 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.
507
+
508
+ % ---------------------------------------------------------------------------------
509
+ <%= heading2 %>{Method or Approach (SM3, SM4)}\label{sec:introduction:method}
510
+ % ---------------------------------------------------------------------------------
511
+
512
+ \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).
513
+
514
+ 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.
515
+
516
+ % ---------------------------------------------------------------------------------
517
+ <%= heading2 %>{Findings (SM5, SM6)}\label{sec:introduction:results}
518
+ % ---------------------------------------------------------------------------------
519
+
520
+ \emph{Purpose and scope}. 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. It is most likely a summary of your evaluation in \cref{sec:evaluation}.
521
+
522
+ \subsection*{Results (SM5)}
523
+
524
+ 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.
525
+
526
+ \subsection*{Interpretation (SM6)}
527
+
528
+ You summarize your interpretation of the results and draw conclusions. State whether and to which degree the research question from \cref{sec:introduction:research-question} has been answered successfully or not.
529
+
530
+ Finally state briefly how much closer society and science have come in answering the general objective you outlined in \cref{sec:introduction:topic}.
531
+
532
+ %%% ===============================================================================
533
+ <%= heading1 %>{Background (SM1)}\label{sec:background}
534
+ %%% ===============================================================================
535
+
536
+ \emph{Purpose and scope}. The background chapter has multiple roles.
537
+ \begin{itemize}
538
+
539
+ \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.
540
+
541
+ \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 (\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}.
542
+
543
+ 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.
544
+ \end{itemize}
545
+
546
+ %%% ===============================================================================
547
+ <%= heading1 %>{Problem Exposition (optional)}\label{sec:problem-exposition}
548
+ %%% ===============================================================================
549
+
550
+ \emph{Purpose and scope}. 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. This can include further details on the data you studied, context assumptions and requirements, etc.
551
+
552
+ 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. A typical structure can be.
553
+
554
+ % ---------------------------------------------------------------------------------
555
+ <%= heading2 %>{Context/Business Understanding (SM1)}\label{sec:problem-exposition:context-understanding}
556
+ % ---------------------------------------------------------------------------------
557
+
558
+ provide details
559
+
560
+ % ---------------------------------------------------------------------------------
561
+ <%= heading2 %>{Data Understanding (SM1)}\label{sec:problem-exposition:data-understanding}
562
+ % ---------------------------------------------------------------------------------
563
+
564
+ provide details
565
+
566
+ % ---------------------------------------------------------------------------------
567
+ <%= heading2 %>{Detailed Research Questions (SM2)}\label{sec:problem-exposition:research-problems}
568
+ % ---------------------------------------------------------------------------------
569
+
570
+ provide details based on \cref{sec:problem-exposition:context-understanding} and \ref{sec:problem-exposition:data-understanding}
571
+
572
+ % ---------------------------------------------------------------------------------
573
+ <%= heading2 %>{Detailed Method (SM3)}\label{sec:problem-exposition:research-method}
574
+ % ---------------------------------------------------------------------------------
575
+
576
+ provide details based on \cref{sec:problem-exposition:context-understanding} and \ref{sec:problem-exposition:data-understanding}
577
+
578
+ %%% ===============================================================================
579
+ <%= heading1 %>{First Real Chapter addressing first Research Problem}\label{sec:problem1}
580
+ %%% ===============================================================================
581
+
582
+ \emph{Purpose and scope}. 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). You usually do this by addressing various sub-problems again through scientific arguments following the 6 steps SM1-SM6.
583
+
584
+ 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 \cref{sec:introduction:research-question} or in \cref{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
+
586
+ 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 \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.
587
+
588
+ % ---------------------------------------------------------------------------------
589
+ <%= heading2 %>{First Sub-Problem}\label{sec:problem1:subproblem1}
590
+ % ---------------------------------------------------------------------------------
591
+
592
+ \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.
593
+
594
+ \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.
595
+ Make use of appendices % (see \cref{sec:appendix1})
596
+ if certain details take too much space.
597
+
598
+ \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
+
600
+ 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...'') 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.
601
+
602
+ \begin{figure}
603
+ \centering
604
+ %%%\includegraphics{/path/to/figure.pdf}
605
+ \caption{A scientific figure that has to be explained in the text}
606
+ \label{fig:my_label}
607
+ \end{figure}
608
+
609
+ \emph{After describing the results, you may interpret them (SM6).} Here you can infer what a particular observation means (for you), how it can be applied, or what others can do with it. You must not write interpretations before completely describing your results. This is a common mistake done by most beginner writers. You want to quickly get to the point, which is the final finding or interpretation. But you forget that your reader does not understand yet what you are interpreting - they do not know yet what you do know. An interpretation can only be followed after all results have been described. The interpretation must be based on the written description only. Then you can be sure that your readers can follow your interpretation and reach the same conclusions as you have.
610
+
611
+ Ideally, your interpretation leads to the next sub-problem in \cref{sec:problem1:subproblem2}.
612
+
613
+ % ---------------------------------------------------------------------------------
614
+ <%= heading2 %>{Second Sub-Problem}\label{sec:problem1:subproblem2}
615
+ % ---------------------------------------------------------------------------------
616
+
617
+ 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).
618
+
619
+ 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
+
621
+ 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:
622
+ %
623
+ \begin{itemize}
624
+ \item Which step of a scientific argument am I currently writing (SM1, SM2, ..., SM6)?
625
+ \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)?
626
+ \item Are you really \emph{not} writing interpretation SM6 before SM5, SM4, or SM3?
627
+ \item Is it clear to the reader which part of the scientific argument you are currently making?
628
+ \end{itemize}
629
+
630
+ %%% ===============================================================================
631
+ <%= heading1 %>{Second Real Chapter}\label{sec:sub-problem2}
632
+ %%% ===============================================================================
633
+
634
+ Have a short chapter introduction that recalls what you already achieved in \cref{sec:problem1} and explain the second research problem of your thesis. The problem has to show up in the introduction in \cref{sec:introduction:research-question} or in \cref{sec:problem-exposition:research-problems} already. etc.
635
+
636
+ %%% ===============================================================================
637
+ <%= heading1 %>{Evaluation}\label{sec:evaluation}
638
+ %%% ===============================================================================
639
+
640
+ \emph{Purpose and scope}. 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.
641
+
642
+ % ---------------------------------------------------------------------------------
643
+ <%= heading2 %>{Objective (SM2)}\label{sec:evaluation:objective}
644
+ % ---------------------------------------------------------------------------------
645
+
646
+ Clearly state what you want to evaluate and what you want to measure.
647
+
648
+ % ---------------------------------------------------------------------------------
649
+ <%= heading2 %>{Setup (SM3)}\label{sec:evaluation:setup}
650
+ % ---------------------------------------------------------------------------------
651
+
652
+ State which data, participants, tools, etc. you chose and why. Clearly state how you measure outcomes and how you compare them to baselines, reference groups, etc.
653
+
654
+ % ---------------------------------------------------------------------------------
655
+ <%= heading2 %>{Execution (SM4)}\label{sec:evaluation:execution}
656
+ % ---------------------------------------------------------------------------------
657
+
658
+ Provide all details on the execution that are necessary to allows another person to reproduce your results at a later point.
659
+
660
+ % ---------------------------------------------------------------------------------
661
+ <%= heading2 %>{Results (SM5)}\label{sec:evaluation:results}
662
+ % ---------------------------------------------------------------------------------
663
+
664
+ You only report the measurements. You must present and reference them (``\cref{fig:my_label2} 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.
665
+
666
+ \begin{figure}
667
+ \centering
668
+ %%%\includegraphics{/path/to/figure.pdf}
669
+ \caption{Another scientific figure that has to be explained in the text}
670
+ \label{fig:my_label2}
671
+ \end{figure}
672
+
673
+ % ---------------------------------------------------------------------------------
674
+ <%= heading2 %>{Discussion (SM6)}\label{sec:evaluation:discussion}
675
+ % ---------------------------------------------------------------------------------
676
+
677
+ An interpretation can only be followed after all results have been described. The interpretation must be based on the written description in \cref{sec:evaluation:results} only. Then you can be sure that your readers can follow your interpretation and reach the same conclusions as you have.
678
+
679
+ <% } else { -%>
680
+ <%= heading1 %>{Einleitung}
681
+ \label{sec:introduction}
682
+ Hier steht die Einleitung zu dieser Ausarbeitung.
683
+ Sie soll nur als Beispiel dienen.
684
+ Nun viel Erfolg bei der Arbeit!
685
+
686
+ Die Arbeit ist in folgender Weise gegliedert:
687
+ Zuerst werden Grundlagen und verwandte Arbeiten vorgestellt (\cref{sec:relatedwork}).
688
+ <% if (examples) { %>It is followed by a presentation of hints on \LaTeX{} (\cref{sec:latexhints}).
689
+ <% } -%>
690
+ <% if (!examples && (documentclass == 'ieee')) { %>Afterwards, we present some Lorem Ipsum (\cref{sec:loremipsum}).
691
+ <% } -%>
692
+ Schließlich fasst \cref{sec:outlook} die Ergebnisse der Arbeit zusammen und stellt Anknüpfungspunkte vor.
693
+
694
+ <%= heading1 %>{Verwandte Arbeiten}
695
+ \label{sec:relatedwork}
696
+
697
+ Eine Beschreibung relevanter wissenschaftlicher Arbeiten mit Bezug zur eigenen Arbeit.
698
+ Der Abschnitt kann je nach Kontext auch an anderer Stelle stehen.
699
+
700
+ Winery~\cite{Winery} is a graphical \commentontext{modeling}{modeling with one ``l'', because of AE} tool.
701
+ The whole idea of TOSCA is explained by <% if (available.citet) { %>\citet<% } else { %>Binz et al.~\cite<% } %>{Binz2009}.
702
+ <% } -%>
351
703
 
352
704
  <% if (examples) { -%>
353
705
  <%= heading1 %>{LaTeX Hinweise}
354
- \label{chap:latexhints}
706
+ \label{sec:latexhints}
355
707
 
356
708
  <% if (useExampleEnvironment) { -%>
357
709
  % Benötigt für eine korrekte Darstellung der Hinweise im erzeugten PDF
@@ -359,9 +711,8 @@ Hier bitte einen kurzen Durchgang durch die Arbeit.
359
711
  \newcount\LTGendlineexample
360
712
  \newenvironment{ltgexample}%
361
713
  {\LTGbeginlineexample=\numexpr\inputlineno+1\relax}%
362
- {%
363
- \LTGendlineexample=\numexpr\inputlineno-1\relax%
364
-
714
+ {\LTGendlineexample=\numexpr\inputlineno-1\relax%
715
+ %
365
716
  \tcbinputlisting{%
366
717
  listing only,
367
718
  listing file=\currfilepath,
@@ -407,13 +758,19 @@ Hier bitte einen kurzen Durchgang durch die Arbeit.
407
758
  Hier sollen allgemeine \LaTeX-Hinweise gegeben werden, damit man Minimalbeispiele vorliegen hat, um sofort loszulegen.
408
759
 
409
760
  <%- include('paragraphs.example.de.tex', this); %>
410
- <% if (texlive >= 2021) { %><%- include('mindflow.example.en.tex', this); %><% } -%>
761
+ <% if (texlive >= 2021) { %><%- include('mindflow.example.en.tex', this); %>
762
+ <% } -%>
411
763
  <%- include('hyphenation.example.en.tex', this); %>
412
764
  <%- include('siunitx.example.en.tex', this); %>
413
- <% if (enquotes == 'csquotes') { %><%- include('csquotes.example.en.tex', this); %><% } -%>
414
- <% if (enquotes == 'plainlatex') { %><%- include('plainlatex.enquotes.example.de.tex', this); %><% } -%>
765
+ <% if (enquotes == 'csquotes') { %><%- include('csquotes.example.en.tex', this); %>
766
+ <% } -%>
767
+ <% if (enquotes == 'textcmds') { %><%- include('textcmds.example.en.tex', this); %>
768
+ <% } -%>
769
+ <% if (enquotes == 'plainlatex') { %><%- include('plainlatex.enquotes.example.de.tex', this); %>
770
+ <% } -%>
415
771
  <%- include('cleveref.example.en.tex', this); %>
416
772
  <%- include('figure.example.de.tex', this); %>
773
+ <%- include('subfloat.example.en.tex', this); %>
417
774
  <%- include('tables.example.en.tex', this); %>
418
775
  <% if (listings == 'listings') { -%>
419
776
  <%- include('listings.example.de.tex', this); %>
@@ -425,19 +782,65 @@ Hier sollen allgemeine \LaTeX-Hinweise gegeben werden, damit man Minimalbeispiel
425
782
  <% } -%>
426
783
  <%- include('otherfeatures.example.en.tex', this); %>
427
784
  <% } -%>
785
+ <% if (howtotext) { -%>
428
786
 
429
- <% if (documentclass == 'lncs') { -%>
430
- \section{Zusammenfassung und Ausblick}
787
+ %%% ===============================================================================
788
+ <%= heading1 %>{Zusammenfassung und Ausblick}\label{sec:conclusion}
789
+ %%% ===============================================================================
790
+
791
+ 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}. You specifically outline which concrete findings or methodological contributions advance our knowledge towards the general objective you introduced in \cref{sec:introduction:topic}. Objectively discuss which parts you solved and in which parts you failed.
792
+
793
+ 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.
794
+ <% } else { -%>
795
+ <% if (!examples && ((documentclass == 'acmart') || (documentclass == 'ieee'))) { -%>
796
+
797
+ <%= heading1 %>{Lorem ipsum}
798
+ \label{sec:loremipsum}
799
+ \lipsum[1-4]
800
+ <% } -%>
801
+
802
+ <%= heading1 %>{Zusammenfassung und Ausblick}
431
803
  \label{sec:outlook}
804
+ Hier bitte einen kurzen Durchgang durch die Arbeit.
805
+
432
806
  \lipsum[1-2]
433
807
 
808
+ ...und anschließend einen Ausblick.
809
+ <% } -%>
810
+
811
+ <% switch (documentclass) { case "lncs": -%>
434
812
  \subsubsection*{Danksagungen}
435
- \ldots
813
+
814
+ <% break; case "acmart": -%>
815
+ \begin{acks}
816
+ <% break; case "ieee": -%>
817
+ % regular IEEE prefers the singular form
818
+ \section*{Danksagung}
819
+
820
+ <% break; default: -%>
821
+ <% break; } -%>
822
+ <% if ((documentclass == 'acmart') || (documentclass == 'lncs') || (documentclass == 'ieee')) { -%>
823
+ 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}.
824
+ <% if (howtotext) { -%>
825
+
826
+ 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}.
827
+ <% } -%>
828
+ <% if (documentclass == 'acmart') { -%>
829
+
830
+ For more \LaTeX{} hints for ACM read on at \url{https://www.acm.org/publications/taps/latex-best-practices}.
831
+ \end{acks}
832
+ <% } -%>
833
+ <% } -%>
834
+
835
+ %%% ===============================================================================
836
+ %%% Bibliography
837
+ %%% ===============================================================================
436
838
 
437
839
  In the bibliography, use \texttt{\textbackslash textsuperscript} for <%- bquote %>st<%- equote %>, <%- bquote %>nd<%- equote %>, \ldots:
438
840
  E.g., <%- bquote %>The 2\textsuperscript{nd} conference on examples<%- equote %>.
439
841
  When you use \href{https://www.jabref.org}{JabRef}, you can use the clean up command to achieve that.
440
842
  See \url{https://help.jabref.org/en/CleanupEntries} for an overview of the cleanup functionality.
843
+ <% switch (documentclass) { case "lncs": -%>
441
844
 
442
845
  \renewcommand{\bibsection}{\section*{Literatur}} % requried for natbib to have "References" printed and as section*, not chapter*
443
846
  % Use natbib compatbile splncs04nat style.
@@ -449,14 +852,53 @@ See \url{https://help.jabref.org/en/CleanupEntries} for an overview of the clean
449
852
  \small % ensure correct font size for the bibliography
450
853
  \bibliography{<%= filenames.bib %>}
451
854
  \endgroup
855
+ <% break; case "acmart": -%>
856
+
857
+ \bibliographystyle{ACM-Reference-Format}
858
+ \bibliography{<%= filenames.bib %>}
859
+ <% break; case "ieee": -%>
860
+
861
+ % trigger a \newpage just before the given reference
862
+ % number - used to balance the columns on the last page
863
+ % adjust value as needed - may need to be readjusted if
864
+ % the document is modified later
865
+ %\IEEEtriggeratref{8}
866
+ % The "triggered" command can be changed if desired:
867
+ %\IEEEtriggercmd{\enlargethispage{-5in}}
868
+
869
+ % Enable to reduce spacing between bibitems (source: https://tex.stackexchange.com/a/25774)
870
+ % \def\IEEEbibitemsep{0pt plus .5pt}
871
+
872
+ \bibliographystyle{IEEEtranN} % IEEEtranN is the natbib compatible bst file
873
+ % argument is your BibTeX string definitions and bibliography database(s)
874
+ \bibliography{<%= filenames.bib %>}
875
+ <% break; case "scientific-thesis": -%>
876
+
877
+ \printbibliography
878
+ <% break; default: -%>
879
+
880
+ \bibliographystyle{plain}
881
+ \bibliography{<%= filenames.bib %>}
882
+ <% break; } -%>
452
883
 
453
884
  % Enfore empty line after bibliography
454
885
  \ \\
455
886
  %
456
887
  Alle Links wurden zuletzt am 29.03.2021 geprüft.
457
- <% } -%>
458
- <% if (documentclass == 'scientific-thesis') { -%>
459
888
 
889
+ <% switch (documentclass) { case "lncs": -%>
890
+ %%% ===============================================================================
891
+ %\appendix
892
+ %\addcontentsline{toc}{chapter}{APPENDICES}
893
+
894
+ %\listoffigures
895
+ %\listoftables
896
+ %%% ===============================================================================
897
+
898
+ %%% ===============================================================================
899
+ %<%= heading1 %>{My first appendix}\label{sec:appendix1}
900
+ %%% ===============================================================================
901
+ <% break; case "scientific-thesis": -%>
460
902
  %%% ===============================================================================
461
903
  \appendix
462
904
  \addcontentsline{toc}{chapter}{Anhang}
@@ -472,5 +914,5 @@ Alle Links wurden zuletzt am 29.03.2021 geprüft.
472
914
  \pagestyle{empty}
473
915
  \renewcommand*{\chapterpagestyle}{empty}
474
916
  \Versicherung
475
- <% } -%>
917
+ <% break; } -%>
476
918
  \end{document}