Merge pull request #26 from schnes4/develop

Template Version 2.0.0

.gitignore

@@ -223,5 +223,26 @@ TSWLatexianTemp*
 # TeXnicle
 *.texnicle
 
-images/cover/Thumbs.db
-images/Thumbs.db
+## Windows specific files ##
+# Windows thumbnail cache files
+Thumbs.db
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+Desktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk

ads/cover.tex

@@ -3,15 +3,24 @@
 \begin{titlepage}
 	\begin{longtable}{p{8cm} p{8cm}}
 		\raggedright {\raisebox{\ht\strutbox-\totalheight}{\includegraphics[height=2.5cm]{images/cover/logo-dhbw.png}}} &
-		\raggedleft {\raisebox{\ht\strutbox-\totalheight}{\includegraphics[height=2.5cm]{images/cover/logo-company.png}}}
+		\ifDocType{T2\_3100}{%
+			% no company logo for semester paper
+		}{%
+			\raggedleft {\raisebox{\ht\strutbox-\totalheight}{\includegraphics[height=2.5cm]{images/cover/logo-company.png}}}
+		}%
 	\end{longtable}
 	\enlargethispage{20mm}
 	\begin{center}
     \doublespacing{
 		\vspace*{12mm}	{\LARGE\textbf \documentTitle }}\\
 		\vspace*{12mm}	{\large\textbf {\documentTypePhrase}}\\
-		\vspace*{12mm}	\degreePhrase\\
-		\vspace*{3mm}		{\textbf \degree}\\
+
+		% degre only for bachelor thesis
+		\ifDocType{T2\_3300}{
+			\vspace*{12mm}	\degreePhrase\\
+			\vspace*{3mm}		{\textbf \degree}\\
+		}
+
 		\vspace*{12mm}	\departmentPhrase{} \department\\
     \vspace*{0mm}		\locationUniversityPhrase{} \locationUniversity\\
 		\vspace*{12mm}	\documentAuthorPhrase\\
@@ -24,9 +33,18 @@
 		mmmmmmmmmmmmmmmmmmmmmmmmmm             \= \kill
 		\textbf{\documentPeriodPhrase}       \>  \documentPeriod\\
 		\textbf{\matriculationNumberPhrase, \coursePhrase}  \>  \matriculationNumber, \course\\
-		\textbf{\companyPhrase}                  \>  \companyName, \companyLocation\\
+
+		\ifDocType{T2\_3100}{%
+			% no company for the semester paper
+		}{%
+			\textbf{\companyPhrase}                  \>  \companyName, \companyLocation\\
+		}%
 		\textbf{\tutorPhrase}               \>  \tutor\\
-		\textbf{\evaluatorPhrase}              \>  \evaluator
+
+		% evaluator only for bachelor thesis
+		\ifDocType{T2\_3300}{
+			\textbf{\evaluatorPhrase}              \>  \evaluator
+		}{}
 	\end{tabbing}
 	\end{spacing}
 \end{titlepage}

ads/declaration.tex

@@ -7,26 +7,27 @@ \section*{\declarationPhrase}
 \vspace*{2em}
 
 \iflang{de}{%
-  Ich versichere hiermit, dass ich meine {\documentTypePhrase} mit dem Thema: {\itshape \documentTitle } 
-  selbstständig verfasst und  keine anderen als die angegebenen Quellen und Hilfsmittel benutzt habe. 
-  Ich versichere zudem, dass die eingereichte elektronische Fassung mit der gedruckten Fassung 
+  \ifMultipleAuthors{Wir versichern}{Ich versichere} hiermit, dass \ifMultipleAuthors{wir unsere}{ich meine} 
+  {\documentTypePhrase} mit dem Thema: {\itshape \documentTitle } 
+  selbstständig verfasst und  keine anderen als die angegebenen Quellen und Hilfsmittel benutzt \ifMultipleAuthors{haben}{habe}. 
+  \ifMultipleAuthors{Wir versichern}{Ich versichere} zudem, dass die eingereichte elektronische Fassung mit der gedruckten Fassung 
   übereinstimmt. 
 }
 
 
 \iflang{en}{%
-  Hereby I solemnly declare:
+  Hereby \ifMultipleAuthors{we}{I} solemnly declare:
   \begin{enumerate}
-  \item that this {\documentTypePhrase}, titled {\itshape \documentTitle } is entirely the product of my 
+  \item that this {\documentTypePhrase}, titled {\itshape \documentTitle } is entirely the product of \ifMultipleAuthors{our}{my} 
             own scholarly work, unless otherwise indicated in the text or references, or acknowledged below;
-  \item I have indicated the thoughts adopted directly or indirectly from other sources at the appropriate 
+  \item \ifMultipleAuthors{we}{I} have indicated the thoughts adopted directly or indirectly from other sources at the appropriate 
             places within the document;
   \item this {\documentTypePhrase} has not been submitted either in whole or part, for a degree at this or 
             any other university or institution;
-  \item I have not published this {\documentTypePhrase} in the past;
+  \item \ifMultipleAuthors{we}{I} have not published this {\documentTypePhrase} in the past;
   \item the printed version is equivalent to the submitted electronic one.
   \end{enumerate}
-  I am aware that a dishonest declaration will entail legal consequences.
+  \ifMultipleAuthors{We are}{I am} aware that a dishonest declaration will entail legal consequences.
 }
 
 \vspace{3em}

ads/header.tex

@@ -27,12 +27,17 @@
 
 % iflang command definition
 \newcommand{\iflang}[2]{%
-  \IfStrEq{\documentLanguage}{#1}{#2}{}
+  \IfStrEq{\documentLanguage}{#1}{#2}{}%
 }
 
 % ifDocType comand definition
-\newcommand{\ifDocType}[2]{%
-  \IfStrEq{\documentType}{#1}{#2}{}
+\newcommand{\ifDocType}[3]{%
+  \IfStrEq{\documentType}{#1}{#2}{#3}%
+}
+
+% ifMultipleAuthors definition
+\newcommand{\ifMultipleAuthors}[2]{%
+  \IfStrEq{\multipleAuthors}{true}{#1}{#2}%
 }
 
 % Include main settings
@@ -91,6 +96,9 @@
 \usepackage{bookmark}
 \usepackage[nonumberlist,toc]{glossaries}
 
+% Generate glossary
+\makeglossaries{}
+
 % Load colors
 \defineColors{}
 

lang/de.tex

@@ -7,8 +7,17 @@
 \newcommand{\documentPeriodPhrase}{Bearbeitungszeitraum}
 \newcommand{\matriculationNumberPhrase}{Matrikelnummer}
 \newcommand{\coursePhrase}{Kurs}
-\newcommand{\companyPhrase}{Ausbildungsbetrieb}
-\newcommand{\tutorPhrase}{Erstgutachter}
+\newcommand{\companyPhrase}{Ausbildungsbetrieb}%
+
+\newcommand{\tutorPhrase}{%
+	\IfStrEqCase{\documentType}{%
+		{T2\_1000}{Gutachter}%
+      	{T2\_2000}{Gutachter}%
+      	{T2\_3100}{Gutachter}%
+      	{T2\_3300}{Erstgutachter}%
+	}
+}
+
 \newcommand{\evaluatorPhrase}{Zweitgutachter}
 \newcommand{\restrictionNoticesPhrase}{Sperrvermerk}
 \newcommand{\declarationPhrase}{Erklärung}
@@ -19,7 +28,7 @@
 \newcommand{\authorListingPhrase}{Listing}
 \newcommand{\acronymsPhrase}{Abkürzungsverzeichnis}
 
-\newcommand{\documentTypePhrase}{
+\newcommand{\documentTypePhrase}{%
   \IfStrEqCase{\documentType}{%
       {T2\_1000}{Projektarbeit}%
       {T2\_2000}{Projektarbeit}%

lang/en.tex

@@ -8,7 +8,16 @@
 \newcommand{\matriculationNumberPhrase}{Student ID}
 \newcommand{\coursePhrase}{Course}
 \newcommand{\companyPhrase}{Company}
-\newcommand{\tutorPhrase}{First Reviewer}
+
+\newcommand{\tutorPhrase}{%
+	\IfStrEqCase{\documentType}{%
+		{T2\_1000}{Reviewer}%
+      	{T2\_2000}{Reviewer}%
+      	{T2\_3100}{Reviewer}%
+      	{T2\_3300}{First Reviewer}%
+	}
+}
+
 \newcommand{\evaluatorPhrase}{Second Reviewer}
 \newcommand{\restrictionNoticesPhrase}{Confidentiality Statement} %Restriction Notice}
 \newcommand{\declarationPhrase}{Author's declaration}
@@ -21,7 +30,7 @@
 \newcommand{\authorListingPhrase}{Listing}
 \newcommand{\acronymsPhrase}{Acronyms}
 
-\newcommand{\documentTypePhrase}{
+\newcommand{\documentTypePhrase}{%
   \IfStrEqCase{\documentType}{%
       {T2\_1000}{Project Thesis}%
       {T2\_2000}{Project Thesis}%

main.tex

@@ -23,8 +23,12 @@
 	\pagenumbering{Roman}
 
 	% Restriction notices
-	\input{ads/restrictionNotices}
-	\newpage
+	\ifDocType{T2\_3100}{%
+		% no restricition notices for semester paper
+	}{%
+		\input{ads/restrictionNotices}
+		\newpage
+	}%
 
 	% Declaration
 	\input{ads/declaration}
@@ -44,8 +48,8 @@
 	\begin{spacing}{1.1}
 		\begingroup
 
-		        % set subchapter depth
-			\setcounter{tocdepth}{1}
+		    % set subchapter depth
+			\setcounter{tocdepth}{2}
 
 			\tableofcontents
 			\clearpage
@@ -55,7 +59,7 @@
 
 	% Acronyms
 	\cleardoublepage
-        \input{content/acronyms}
+    \input{content/acronyms}
 
 	% List of Figures
 	\cleardoublepage
@@ -92,7 +96,9 @@
 	\printbibliography
 
 	% Glossar
+	\cleardoublepage
 	\printglossary[style=altlist,title=\glossaryPhrase]
+	\input{content/glossary}
 
 	% Appendix
 	\clearpage

readme.md

@@ -3,13 +3,14 @@
 Dieses LaTeX Template ist für alle Arbeiten der Fakultät Informatik der DHBW Heidenheim geeignet.
 
 **Inhalt:**
-* [Templatestrucktur](#templatestruktur)
-* [Komponenten einer Wissenschaftlichen Arbeit](#komponenten einer wissenschaftlichen arbeit)
+* [Templatestruktur](#templatestruktur)
+* [Document Types](#document-types)
+* [Komponenten einer Wissenschaftlichen Arbeit](#komponenten-einer-wissenschaftlichen-arbeit)
 * [Contributors](#contributors)
 
 ## Templatestruktur
 
-Das Template ist im Wesentlichen in 6 Teile unterteil:
+Das Template ist im Wesentlichen in 6 Teile unterteilt:
 
 * main.tex
 * ads/
@@ -20,7 +21,7 @@ Das Template ist im Wesentlichen in 6 Teile unterteil:
 
 ### Main.tex
 
-main.tex ist die Kerndatei des Templates und damit auch die Datei, welche kompiliert werden muss. Durch Importe anderer Datein wird die Dokumentenstrucktur beschrieben (kann bei Bedarf geändert werden wenn z.B. kein Sperrvermerk gewünscht wird).
+main.tex ist die Kerndatei des Templates und damit auch die Datei, die kompiliert werden muss. Durch Importe anderer Dateien wird die Dokumentenstruktur beschrieben (kann bei Bedarf geändert werden wenn z.B. kein Sperrvermerk gewünscht wird).
 
 ### ads
 
@@ -33,23 +34,24 @@ Im Ordner ads befinden sich folgende vordefinierte Vorlagen, welche nicht angepa
 
 ### lang
 
-Im Ordner lang befinden sich alle nötigen Übersetzungen.
+Im Ordner lang befinden sich alle notwendigen Übersetzungen.
 
 ### settings
 
-Im Ordner settings gibt es zwei Datein:
+Der Ordner settings beinhaltet zwei Dateien:
 
 * general.tex
 * document.tex
 
-In der Datei general.tex sind Grundlegende Einstellungen vordefiniert, welche nicht geändert werden müssen.
+In der Datei general.tex sind grundlegende Einstellungen vordefiniert, welche nicht geändert werden müssen.
 
 In der Datei document.tex müssen einige Angaben über die zu schreibende Arbeit gemacht werden:
 
 | Variable | Beschreibung | Mögliche Werte |
 | -------- | ------------ | -------------- |
 | documentLanguage| Sprache der Arbeit | de<br/> en |
 | documentType | Art der Arbeit | T2\\_1000 Projektarbeit (Semester 1 & 2) <br/> T2\\_2000 Projektarbeit (Semester 3 & 4) <br/> T2\\_3100 Studienarbeit (Semester 5) <br/> T2\\_3300 Bachelorarbeit |
+| multipleAuthors | Wurde die Arbeit von mehreren Autoren verfasst? | true<br/> false |
 | documentAuthor | Autor der Arbeit | |
 | documentTitle | Titel der Arbeit | |
 | documentPeriod | Dauer der Arbeit | |
@@ -70,6 +72,23 @@ In der Datei document.tex müssen einige Angaben über die zu schreibende Arbeit
 ### images
 
 
+# Document Types
+
+Das Template bietet die folgenden verschiedenen Document Types an:
+
+* T2_1000 Project Thesis (Semester 1 & 2)
+* T2_2000 Project Thesis (Semester 3 & 4)
+* T2_3100 Seminar Paper (Semester 5 & 6)
+* T2_3300 Bachelor Thesis
+
+Das Template passt alle relevanten Einstellungen automatisch an, sobald der Document Type geändert wird.
+
+## Document Type spezifische Besonderheiten
+
+### T2_3100
+
+Die Studienarbeit ist eine reine Hochschularbeit. Aus diesem Grund wird der Ort der Firma und der Sperrvermerk entfernt. Desweiteren ist es möglich die Studienarbeit als Gruppe abzugeben. Hierfür gibt es die Variable multipleAuthors. Ist diese auf true gesetzt, passt sich die Eigenständigkeitserklärungs selbst von der Ich- zur Wir-Form an. Mehrere Autoren sind lediglich mit Komma getrent in die Variable documentAuthor einzutragen.
+
 # Komponenten einer Wissenschaftlichen Arbeit
 
 ## Abstract
@@ -83,7 +102,7 @@ Quelle: http://en.wikipedia.org/wiki/Abstract_(summary)
 
 ## Acronyms
 
-nur verwendete Akronyme werden letztlich im Abkürzungsverzeichnis des Dokuments angezeigt
+Nur verwendete Akronyme werden letztlich im Abkürzungsverzeichnis des Dokuments angezeigt.
 Verwendung: 
 		\ac{Abk.}   --> fügt die Abkürzung ein, beim ersten Aufruf wird zusätzlich automatisch die ausgeschriebene Version davor eingefügt bzw. in einer Fußnote (hierfür muss in header.tex \usepackage[printonlyused,footnote]{acronym} stehen) dargestellt
 		\acs{Abk.}   -->  fügt die Abkürzung ein
@@ -154,3 +173,4 @@ Die Archivdatei wurde zusammen mit der Online-Version dieser Ausarbeitung auf di
 * Prof. Dr. Rolf Assfalg
 * Stefan Schneider
 * Andreas Kießling
+* Sarah Willibald

settings/document.tex

@@ -10,6 +10,7 @@
 % T2\_3300 Bachelor Thesis
 \newcommand{\documentType}{T2\_3300}
 
+\newcommand{\multipleAuthors}{false}
 \newcommand{\documentAuthor}{Max Mustermann}
 \newcommand{\documentTitle}{Titel der Arbeit}
 \newcommand{\documentPeriod}{12 Wochen}
@@ -25,11 +26,11 @@
 % INF2014 - INF2016 (IA/IM) :   Bachelor of Engineering
 % INF2017 (all):                Bachelor of Science
 
-\newcommand{\releaseDate}{Septemper 20XX}
+\newcommand{\releaseDate}{September 20XX}
 \newcommand{\releaseLocation}{Abgabeort}
 
 \newcommand{\companyName}{Firma GmbH}
 \newcommand{\companyLocation}{Firmenort}
 
 \newcommand{\tutor}{Dipl.-Ing.~(FH) Peter Pan}
-\newcommand{\evaluator}{Prof. Dr.\ Rolf Assfalg}
+\newcommand{\evaluator}{Prof. Dr.\ Rolf Assfalg}

settings/main.tex

@@ -25,7 +25,7 @@
 %% Color settings
 \newcommand{\defineColors}{%
 	\definecolor{LinkColor}{HTML}{00007A}
-	\definecolor{ListingBackground}{HTML}{FCF7DE}
+	\definecolor{ListingBackground}{HTML}{F8F8F8}
 }
 
 %% Syntax Highlighting (Listings)
@@ -45,12 +45,13 @@
 		extendedchars=true,		% show all Latin1 characters (true, false)
 		captionpos=b,			% sets the caption-position to bottom
 		backgroundcolor=\color{ListingBackground}, % source code background
-		xleftmargin=0pt,		        % margin left
-		xrightmargin=0pt,		        % margin right
+		xleftmargin=10pt,		        % margin left
+		xrightmargin=5pt,		        % margin right
 		frame=single,			        % border settings
 		frameround=ffff,
 		rulecolor=\color{darkgray},	% border color
 		fillcolor=\color{ListingBackground},
+		aboveskip=20pt,
 		keywordstyle=\color[rgb]{0.133,0.133,0.6},
 		commentstyle=\color[rgb]{0.133,0.545,0.133},
 		stringstyle=\color[rgb]{0.627,0.126,0.941}