improve and cleanup documentation

main-report.tex

@@ -189,7 +189,11 @@
     \hfill\\%
 }
 
-%% Command \author{name}: sets the author's name; use \prefix{} and \suffix{} to add academic titles and suffixes, use \matno{} to add the immatriculation number
+%% Command \author{name}: sets the author name(s); separate multiple authors with \and; use \prefix{}
+%%   and \suffix{} to add academic titles and suffixes (if needed); use \affiliation{} to add an
+%%   affiliation, use \authornewline to add line breaks (e.g. to separate authors from contact
+%%   information), use \authormail{}, \authorweb{}, \authorphone{} and \authorfax{} to add contact
+%%   information)
 \author{%
     Firstname1 Lastname1 \and Firstname2 Lastname2 \and Firstname3 Lastname3
     \affiliation{Institute of Networks~and~Security}
@@ -200,25 +204,25 @@
     \authornewline
 }
 
-% Command \date{YYYY-MM-DD}: set the day of publication (defaults to today)
+%% Command \date{YYYY-MM-DD}: set the day of publication (defaults to today)
 %\date{2020-04-09}
 
-% Command \partnerlogo{filename}: use filename as partnerlogo, filename may be blank to disable the logo
+%% Command \partnerlogo{filename}: use filename as partnerlogo, filename may be blank to disable the logo
 %\partnerlogo{logos/ins}
 
-% Command \revisionblock{text}: set the document revision block on the title page
+%% Command \revisionblock{text}: set the document revision block on the title page
 \revisionblock{Space for your revision block, acknowledgements, etc.}
 
-% Command \reportnumber{number}: set the report number
+%% Command \reportnumber{number}: set the report number
 %\reportnumber{Space for your report number}
 
-% Command \setbottommark{text}: set the bottom mark (in document footer)
+%% Command \setbottommark{text}: set the bottom mark (in document footer)
 %\setbottommark{Space for your bottom mark}
 
-% Command \abstract{text}: set the document abstract on the title page
+%% Command \abstract{text}: set the document abstract on the title page
 \abstract{Space for your (short) abstract.}
 
-% Command \keywords{text}: set the document keywords
+%% Command \keywords{text}: set the document keywords
 %\keywords{Space for your comma-separated keywords}
 
 

main-seminarreport.tex

@@ -184,7 +184,8 @@
 %% Command \subtitle{subtitle}: sets the subtitle for seminar/technical reports (not used for theses)
 \subtitle{Seminar Report}
 
-%% Command \author{name}: sets the author's name; use \prefix{} and \suffix{} to add academic titles and suffixes, use \matno{} to add the immatriculation number
+%% Command \author{name}: sets the author's name; use \prefix{} and \suffix{} to add academic titles
+%%   and suffixes, use \matno{} to add the immatriculation number
 \author{\prefix{DI} Firstname~Lastname \suffix{BSc}\matno{12345678}}
 
 %% Command \supervisor[number,gender]{name}: sets the name of the supervisor (where number optionally
@@ -193,16 +194,17 @@
 %\supervisor[1]{\prefix{Prof. Dr.} Firstname~Lastname}
 %\supervisor[2]{\prefix{Prof. Dr.} Firstname~Lastname}
 
-% Command \submissiondepartment{institute or department}: set the course or department that the thesis is submitted at
+%% Command \submissiondepartment{institute or department}: set the course or department that the thesis
+%%   is submitted at
 \submissiondepartment{Special Topics: Smart~Cards \&~NFC (353.039)}
 
-% Command \date{YYYY-MM-DD}: set the day of submission (defaults to today)
+%% Command \date{YYYY-MM-DD}: set the day of submission (defaults to today)
 %\date{2020-04-09}
 
-% Command \abstract{text}: set the document abstract on the title page
+%% Command \abstract{text}: set the document abstract on the title page
 \abstract{Space for your (short) abstract.}
 
-% Command \keywords{text}: set the document keywords
+%% Command \keywords{text}: set the document keywords
 %\keywords{Space for your comma-separated keywords}
 
 

main-thesis.tex

@@ -84,7 +84,7 @@
 %% 
 %% Use the JKU LaTeX technical report template for this document.
 %% 
-\usepackage[phdthesis,fancyfonts]{jkureport}
+\usepackage[mathesis,fancyfonts]{jkureport}
 %% 
 %% The comma-separated list in square brackets are theme options. Useful options that you
 %% might want to use:
@@ -193,31 +193,46 @@
 %% Command \subtitle{subtitle}: sets the subtitle for seminar/technical reports (not used for theses)
 %\subtitle{Seminar Report}
 
-%% Command \author{name}: sets the author's name; use \prefix{} and \suffix{} to add academic titles and suffixes, use \matno{} to add the immatriculation number
+%% Command \author{name}: sets the author's name; use \prefix{} and \suffix{} to add academic titles
+%%   and suffixes, use \matno{} to add the immatriculation number
 \author{\prefix{DI} Firstname~Lastname \suffix{BSc}\matno{12345678}}
 
 %% Command \supervisor[number,gender]{name}: sets the name of the supervisor (where number optionally
-%%   defines the rank of the supervisor (1-3) and gender specifies if the supervisor is male or female
-%%   to adapt gender-specific terms in German)
+%%   defines the rank of the supervisor (1-3) and gender specifies if the supervisor is male (m) or
+%%   female (f/w) to adapt gender-specific terms in German)
 \supervisor{\prefix{Prof. Dr.} Firstname~Lastname}
-\supervisor[2]{\prefix{Prof. Dr.} Firstname~Lastname}
 
-% Command \assistantsupervisor{name}: sets the name of the assistant supervisor(s)
+%% Command \assistantsupervisor{name}: sets the name of the assistant supervisor(s)
 \assistantsupervisor{\prefix{Dr.} Firstname~Lastname \suffix{MSc}}
 
-% Command \degree{degree}{degree program}: sets the degree and degree program name
+%% Command \degree{degree}{degree program}: sets the degree and degree program name
 \degree{Master of Science}{Computer Science}
-
-% Command \submissiondepartment{institute or department}: set the department that the thesis is submitted at
+%% Please make sure to insert the _correct_ degree and degree program names for your studies before
+%% submission. Examples for degrees at JKU:
+%%  * Diplom-Ingenieurin / Diplom-Ingenieur
+%%  * Doctor medicinae universae
+%%  * Master of Arts
+%%  * Master of Laws
+%%  * Master of legal and business aspects in technics
+%%  * Master of Science
+%%  * Master of Science in Digital Business Management
+%%  * Master of Science Global Business
+%%  * Master of Social Sciences
+%%  * Doktorin / Doktor der Geistes- und Kulturwissenschaften
+%%  * Doktorin / Doktor der Medizinischen Wissenschaften
+%%  * Doktorin / Doktor der Naturwissenschaften
+%%  * Doktorin / Doktor der Rechtswissenschaften
+%%  * Doktorin / Doktor der Sozial- und Wirtschaftswissenschaften
+%%  * Doktorin / Doktor der technischen Wissenschaften
+%%  * Doctor of Philosophy
+
+%% Command \submissiondepartment{institute or department}: set the department that the thesis is submitted at
 \submissiondepartment{Institute of Networks~and~Security}
 
-% Command \submissionplace{place}: set the place of submission (typically `Linz', which is also the default)
-%\submissionplace{Linz}
-
-% Command \date{YYYY-MM-DD}: set the day of submission (defaults to today)
+%% Command \date{YYYY-MM-DD}: set the day of submission (defaults to today)
 %\date{2020-04-09}
 
-% Command \keywords{text}: set the document keywords
+%% Command \keywords{text}: set the document keywords
 %\keywords{Space for your comma-separated keywords}