diff --git a/.gitignore b/.gitignore index 859f705..42099fa 100644 --- a/.gitignore +++ b/.gitignore @@ -136,7 +136,7 @@ acs-*.bib # knitr *-concordance.tex # TODO Comment the next line if you want to keep your tikz graphics files -*.tikz +# *.tikz *-tikzDictionary # listings @@ -274,3 +274,5 @@ TSWLatexianTemp* # Makeindex log files *.lpz +clear.bat +htwsaar-i-mst-vorlage.tcp diff --git a/Bibliography.bib b/Bibliography.bib new file mode 100644 index 0000000..9102b72 --- /dev/null +++ b/Bibliography.bib @@ -0,0 +1,63 @@ +% This file was created with JabRef 2.8.1. +% Encoding: Cp1252 + +@BOOK{bentley:1999, + title = {{P}rogramming {P}earls}, + publisher = {Addison--Wesley}, + year = {1999}, + author = {Jon Bentley} +} + +@BOOK{bringhurst:2002, + title = {{T}he {E}lements of {T}ypographic {S}tyle}, + publisher = {Hartley \& Marks Publishers}, + year = {2008}, + author = {Robert Bringhurst} +} + +@BOOK{cormen:2001, + title = {{I}ntroduction to {A}lgorithms}, + publisher = {The MIT Press}, + year = {2001}, + author = {Cormen, Thomas H. and Leiserson, Charles E. and Rivest, Ronald L. + and Clifford Stein} +} + +@BOOK{dueck:trio, + title = {{D}uecks {T}rilogie: {O}mnisophie -- {S}upramanie -- {T}opothesie}, + publisher = {Springer}, + year = {2005}, + author = {Gunter Dueck}, + note = {\url{http://www.omnisophie.com}} +} + +@ARTICLE{knuth:1976, + author = {Knuth, Donald E.}, + title = {{B}ig {O}micron and {B}ig {O}mega and {B}ig {T}heta}, + journal = {SIGACT News}, + year = {1976}, + volume = {8}, + pages = {18--24}, + number = {2}, + publisher = {ACM Press} +} + +@ARTICLE{knuth:1974, + author = {Knuth, Donald E.}, + title = {{C}omputer {P}rogramming as an {A}rt}, + journal = {Communications of the ACM}, + year = {1974}, + volume = {17}, + pages = {667--673}, + number = {12}, + publisher = {ACM Press} +} + +@BOOK{sommerville:1992, + title = {{S}oftware {E}ngineering}, + publisher = {Addison-Wesley}, + year = {1992}, + author = {Ian Sommerville}, + address = {Boston, MA, USA} +} + diff --git a/Chapters/Anhang-A.tex b/Chapters/Anhang-A.tex new file mode 100644 index 0000000..c0ebc2e --- /dev/null +++ b/Chapters/Anhang-A.tex @@ -0,0 +1,10 @@ +%******************************************************************** +% Appendix +%******************************************************* +\chapter{Erster Abschnitt des Anhangs} +In den Anhang gehören "`Hintergrundinformationen"', also weiterführende Information, ausführliche Listings, Graphen, Diagramme oder Tabellen, die den Haupttext mit detaillierten Informationen ergänzen. + +\blindtext +\blindtext +\blindtext + diff --git a/Examples/Beispiele.tex b/Examples/Beispiele.tex new file mode 100644 index 0000000..c0d6825 --- /dev/null +++ b/Examples/Beispiele.tex @@ -0,0 +1,15 @@ +%***************************************** +\chapter{Beispiele}\label{ch:examples} +%***************************************** + +\input{Examples/Beispiele/Acronyme} +\input{Examples/Beispiele/Biblatex} +\input{Examples/Beispiele/Referenzierung} +\input{Examples/Beispiele/DateienEinbinden} +\input{Examples/Beispiele/Tabellen} +\input{Examples/Beispiele/Abbildungen} +\input{Examples/Beispiele/Listings} +\input{Examples/Beispiele/Formeln} +\input{Examples/Beispiele/Todonotes} + + diff --git a/Examples/Beispiele/Abbildungen.tex b/Examples/Beispiele/Abbildungen.tex new file mode 100644 index 0000000..c2254e9 --- /dev/null +++ b/Examples/Beispiele/Abbildungen.tex @@ -0,0 +1,76 @@ +\section{Abbildungen} +%============================= + +\textit{LaTeX} unterstützt generell die Formate \textit{*.jpeg}, \textit{*.png} und \textit{*.pdf}. +Handelt es sich z.B. um Strichgrafiken oder skalierbare Farbflächen, sollte \textit{*.pdf} die erste Wahl sein, +da sich in diesem Format Vektorgrafiken ohne Qualitätsverlust darstellen bzw. skalieren lassen. + +\begin{figure}[bth] + \centering + \includegraphics[width=0.7\textwidth]{Examples/example_5.png} + \caption{Erstes Bild, Völklinger Hütte} + \label{fig:Huette} +\end{figure} + + +\subsection{Wrapfigure} +Abbildung~\ref{fig:Huette} ist zwar ganz nett anzusehen, aber vielleicht sähe es eleganter aus, wenn die Abbildung +von unserem Textabschnitt umflossen werden würde. Diese Art von Abbildungen sollte jedoch sparsam und mit großer Sorgfalt eingesetzt werden, da es zu unschönen Darstellungen kommen kann. +\blindtext +\begin{wrapfigure}{l}{0.4\textwidth} + \centering + \includegraphics[width=0.4\textwidth]{Examples/example_5.jpg} + \caption{Völklinger Hütte, *.jpg} + \label{fig:Huette2} +\end{wrapfigure} +\blindtext + + +\subsection{Subfigures} +Es ist ebenso möglich, mehrere Abbildungen nebeneinander zu setzen, wie in Abbildung~\ref{fig:Beide} zu sehen ist. Eine separate Referenzierung ist auch möglich: Abbildung~\ref{subfig:abbone}. +\begin{figure}[bth] + \subfloat[Erstes ...]{\includegraphics[width=0.49\textwidth]{Examples/example_5.png}\label{subfig:abbone}}\hfill + \subfloat[... und zweites Bild]{\includegraphics[width=0.49\textwidth]{Examples/example_5.png}\label{subfig:abbtwo}} + \caption{Mehrere Abbildungen nebeneinander} + \label{fig:Beide} +\end{figure} + + +\subsection{Qualitätsunterschiede} +\begin{figure}[p] + \centering + \subfloat[\textit{PDF}-Format]{\includegraphics[width=0.65\textwidth]{Examples/bpmn.pdf}} \\ + \subfloat[\textit{JPG}-Format]{\includegraphics[width=0.65\textwidth]{Examples/bpmn.jpg}} + \caption{Beide Formate im Vergleich} + \label{fig:pdfvsjpg} +\end{figure} + +\begin{figure}[p] + \centering + \includegraphics[width=0.65\textwidth]{Examples/jabref.png} + \caption{\textit{PNG}-Format} + \label{fig:pngvsjpg1} +\end{figure} + +\begin{figure}[p] + \centering + \includegraphics[width=0.65\textwidth]{Examples/jabref.jpg} + \caption{\textit{JPG}-Format} + \label{fig:pngvsjpg2} +\end{figure} + +Leider haben die unterschiedlichen Grafikformate bedingt durch die unterschiedlichen Kompressionsverfahren einige Schwächen, insbesondere die Umwandlung in das \textit{JPG}-Format erzeugt unangenehme Artefakte im Bild. \autoref{fig:pdfvsjpg} zeigt die Unterschiede zwischen \textit{PDF-Format} und \textit{JPG-Format} im Vergleich. + +Wenn eine \textit{*.pdf}-Datei nicht infrage kommt, beispielsweise bei Screenshots, ist unbedingt das \textit{PNG-Format} vorzuziehen. +Den Unterschied machen \autoref{fig:pngvsjpg1} und \autoref{fig:pngvsjpg2} deutlich. + +\glqq Faustregeln\grqq im Umgang mit Abbildungen: +\begin{itemize} + \item Diagramme bzw. alles, was Linien usw. enthält: \textit{PDF} (im Vektorformat). + \item Screenshots bzw. alles, was größere gleichfarbige Flächen enthält: \textit{PNG}. + \item Der Rest (in der Regel Fotos): \textit{JPEG}. +\end{itemize} + + + + diff --git a/Examples/Beispiele/Acronyme.tex b/Examples/Beispiele/Acronyme.tex new file mode 100644 index 0000000..a22f49a --- /dev/null +++ b/Examples/Beispiele/Acronyme.tex @@ -0,0 +1,12 @@ +%************************************************ +%* Abkürzungen ********************************* +%************************************************ + +\section{Abkürzungen} + +Um Abkürzungen zu verwenden, muss über \lstinline|\usepackage{acronym}| das benötigte Package geladen werden. Danach kann man lange Begriffe ganz bequem abkürzen: + +So muss man nicht ständig \ac{WLAN} ausschreiben, auch \ac{TCP} lässt sich abkürzen. Würde man im Text \acs{WLAN} oft verwenden, kann man sie, wie hier, nur als +Abkürzung anzeigen lassen - oder bei Bedarf die Erklärung mitliefern (\acf{WLAN}). Weiteres Beispiel könnte die \ac{GoF} sein. + +Weitere Informationen sind im \href{http://www.ctan.org/tex-archive/macros/latex/contrib/acronym}{Acronym-Manual} zu finden. \ No newline at end of file diff --git a/Examples/Beispiele/Biblatex.tex b/Examples/Beispiele/Biblatex.tex new file mode 100644 index 0000000..c39e18e --- /dev/null +++ b/Examples/Beispiele/Biblatex.tex @@ -0,0 +1,24 @@ +%********************************************* +%* Biblatex-Beispiel +%********************************************* +\section{Beispiel für BibLaTeX} + +BibLaTeX ist ein Package, das einem die Arbeit mit Zitaten bzw. Quellenangaben erleichtern kann. Mit JabRef (\autoref{sec:Werkzeuge}) ist es möglich +\textit{*.bib}-Dateien zu erstellen, in denen alle Angaben zu Autor, Buchtitel, Erscheinungsdatum usw. hinterlegt werden, welche zum passenden Zeitpunkt +abgerufen werden können. Das Literaturverzeichnis wird mittels \lstinline{\printbibliography} ausgegeben. + +Im Allgemeinen wird im Literaturverzeichnis auch nur jene Literatur aufgenommen, die auch in der \textit{*.tex}-Datei referenziert wird. Danach ist es wichtig +nicht nur mit \textit{Pdf\-LaTeX}, sondern auch mit \textit{BibLaTeX} zu kompilieren, damit die zitierten Einträge in die verschiedenen Hilfsdateien aufgenommen +werden können. %Hinweis: Pdf\-LaTeX teilt LaTeX mit, dass nur zwischen Pdf und LaTeX getrennt werden darf + + +\subsection*{Einige Zitate} +In diesem Satz könnten wir auf \cite{knuth:1976} verweisen, ebenso auf das wichtige Werk \cite{dueck:trio}. Wenn uns das nicht genug ist, sollten wir das anmerken, +was in \cite{sommerville:1992} geschrieben wurde. Im Zweifelsfall verweisen wir auf eine einzelne Seite, wie in \cite[112]{bentley:1999} zu finden. + +Üblicherweise wird auch der Name des Autors bzw. der Autoren genannt, also beispielsweise bei einem Verweis auf \citeauthor{knuth:1976} \cite{knuth:1976} oder +auch bei mehreren Autoren \citeauthor{cormen:2001} \cite{cormen:2001}. LaTeX stellt Mechanismen zur Verfügung, auch dies automatisiert zu erledigen. + + + + diff --git a/Examples/Beispiele/DateienEinbinden.tex b/Examples/Beispiele/DateienEinbinden.tex new file mode 100644 index 0000000..6d94c32 --- /dev/null +++ b/Examples/Beispiele/DateienEinbinden.tex @@ -0,0 +1,10 @@ +\section{Dateien einbinden} + +Damit man nicht alle Einstellungen, Optionen, Packages und Texte, Abbildungen etc. in einer Datei unterbringen muss, werden +zwei Befehle bereitgestellt, um externe \textit{*.tex}-Dateien einzubinden: \lstinline|\include{PFAD}| und \lstinline|\input{PFAD}|. +Mit dem erstem Befehl wird eine neue Seite angelegt, danach kommen die Inhalte aus der angegebenen Datei; mit dem zweiten +Befehl wird keine neue Seite angelegt -- der Inhalt der angegebenen Datei wird direkt an die betroffene Stelle eingefügt. + +\textbf{Wichtig:} Der \textit{Pfad} wird sinnigerweise \textit{relativ} angegeben, wobei als Stammverzeichnis jenes Verzeichnis +angesehen wird, in dem die \textit{*.tex}-Datei mit der \textit{Document}-Umgebung abgelegt ist (in diesem Fall ist es +\textit{htwsaar-i-mst-config.tex}). \ No newline at end of file diff --git a/Examples/Beispiele/Formeln.tex b/Examples/Beispiele/Formeln.tex new file mode 100644 index 0000000..fd87a18 --- /dev/null +++ b/Examples/Beispiele/Formeln.tex @@ -0,0 +1,76 @@ +\section{Mathematische Ausdrücke} +Mathematische Ausdrücke sind eine kleine Kunst für sich. Am allereinfachsten kann man eine Formel, wie \(a + b = c\) in den Fließtext einbinden, wobei LaTeX die Höhe der Ausdrücke der Zeile anpasst, +wie hier zu sehen \(\sum_{y=0}^{x} a\) . In einer Umgebung sieht das schon anders aus: +\begin{equation} + \sum_{y=0}^{x} a +\end{equation} + +Griechische Buchstaben: +\begin{equation} + \alpha\beta\gamma\delta\epsilon\varepsilon\zeta\eta + \theta\iota\kappa\lambda\mu\nu\xi\pi\varpi\rho\varrho + \sigma\tau\upsilon\phi\varphi\chi\psi\omega +\end{equation} + +Brüche: +\begin{equation} + Ergebnis = \frac{a}{b} +\end{equation} + +\begin{equation} + \frac{\sin{\alpha}^2 + \cos{\alpha}^2}{1} = 1 +\end{equation} + +\begin{equation} + \frac{-9x}{\frac{2y}{3z+2}} +\end{equation} + +Text innerhalb von Formeln: +\begin{equation} +\sum_{y=1}^{n} y = \frac{n*(n+1)}{2} +\quad +\text{Gaußsche Summenformel} +\end{equation} + +Hoch- bzw. Tiefstellungen: +\begin{equation} + x_{i,j}^2 +\end{equation} + +\begin{equation} + {x_{i,j}}^2 +\end{equation} + +\begin{equation} + x_{n_0} +\end{equation} + + +Matrizen: +Matrizen werden innerhalb der mathematischen Umgebung als wiederum neue Umgebung eingebunden. Wie bei Tabellen auch werden Zeilen durch \lstinline{\\} und Spalten durch \lstinline{&} getrennt. + +\begin{equation} + \begin{pmatrix} + a&b\\ + c&d + \end{pmatrix} +\end{equation} + +\begin{equation} + \begin{vmatrix} + a&b\\ + c&d + \end{vmatrix} +\end{equation} + +Fallunterscheidung: +\begin{equation} + f(x) = + \begin{cases} + 0, &\text{falls } x < 0 \\ + 1, &\text{falls } x \geq 0 + \end{cases} +\end{equation} + + + diff --git a/Examples/Beispiele/Listings.tex b/Examples/Beispiele/Listings.tex new file mode 100644 index 0000000..bd34766 --- /dev/null +++ b/Examples/Beispiele/Listings.tex @@ -0,0 +1,25 @@ +%******************************* +% Listings * +%******************************* + +\section{Quellcode einbinden} +Das Package \textit{lstlisting} ermöglicht es, Quellcode ansprechend in das Dokument einzubinden. Man kann Quellcode einzeilig einbinden +mittels \lstinline{\lstinline|Quellcode|}. Dabei ist darauf zu achten, dass der Befehl einmal mit \{ \} und einmal mit | | aufgerufen werden kann, je nachdem, +welche Zeichen im angegebenen Quelltext genutzt werden. +Es ist auch möglich eine eigene Umgebung für Quelltext zu schaffen: + +\begin{lstlisting}[caption=Erstes Listing,style=Java] +private Umgebung(int i, int k) +{ + System.out.println("Eine Funktion mit " + i + "und" + k "."); +} +\end{lstlisting} + +Wer Quelltext aus externen Dateien einbinden möchte, geht wie folgt vor: + +\lstinputlisting +[caption={Externer Quellcode},style=Java] +{Examples/Code.java} + +Wie genau der Quellcode formatiert und gefärbt ist, ist in \textit{htwsaar.i.mst.config.tex} hinterlegt, wobei fü verschiedene Sprachen auch eigene Styles angelegt werden +können (hier z.B. für Java). \ No newline at end of file diff --git a/Examples/Beispiele/Referenzierung.tex b/Examples/Beispiele/Referenzierung.tex new file mode 100644 index 0000000..914ae93 --- /dev/null +++ b/Examples/Beispiele/Referenzierung.tex @@ -0,0 +1,12 @@ +\section{Referenzierungen} +Mit Referenzierungen kann ich ganz bequem auf Textpassagen, Kapitel, Sections oder Abbildungen im weiteren Text verweisen. +Dies ist ein Verweis auf \autoref{subsec:Beispieltext}, der sich auf \autoref{subsec:Beispieltext} befindet. + +Auch ein Verweis auf \autoref{tab:beispieltabelle1} auf Seite~\pageref{tab:beispieltabelle1} ist möglich. + +Man sollte beachten, dass man sein Dokument, wenn es Referenzierungen enthält, mehrmals kompiliert, da sonst manche +Verweise nicht aufgelöst werden können. + + +\subsection{Beispieltext}\label{subsec:Beispieltext} +\blindtext diff --git a/Examples/Beispiele/Tabellen.tex b/Examples/Beispiele/Tabellen.tex new file mode 100644 index 0000000..f3d5c8d --- /dev/null +++ b/Examples/Beispiele/Tabellen.tex @@ -0,0 +1,105 @@ +%************************ +%* Tabellen * +%************************ + +\section{Tabellen} +\label{sec:Tabellen} + +\subsection{Einfache Tabelle} +In LaTeX lassen sich Tabellen unterschiedlicher Ausprägung einfach erzeugen. Das allgemeine Format einer Tabelle sieht aus wie folgt: + +\begin{lstlisting}[caption={Allgemeines Format}] +\begin{table} + \caption{BESCHRIFTUNG} + \begin{tabular}{FORMATIERUNG} + TABELLENINHALT + \end{tabular} +\end{table} +\end{lstlisting} + +Eine Beispieltabelle (Tabelle \ref{tab:beispieltabelle1}) könnte also so aussehen: + +\begin{lstlisting}[caption={Tabelle \ref{tab:beispieltabelle1}}] +\begin{table} + \caption{Beispiel 1} + \begin{tabular}{lrcr} + \toprule + \textbf{Name} & \textbf{Vorname} & \textbf{Matrikelnummer} & \textbf{Lieblingsspeise}\\ + \midrule + Jackson & Michael & 123456 & Erdbeereis \\ + Springsteen & Bruce & 234567 & Schwedisches Lakritz \\ + Bach & Anna, Magdalena & 3456789 & Frankfurter Kranz \\ + Schumann & Clara & 4567890 & Bisquitt\"ortchen \\ + \bottomrule + \end{tabular} + \label{tab:beispieltabelle1} +\end{table} +\end{lstlisting} + +Mit \lstinline|\caption{Beispiel 1}| bekommt unsere Tabelle eine Beschriftung am Tabellenkopf. \lstinline{l|r|c|r} legt die Textausrichtung der einzelnen Spalten fest: \lstinline|l| bedeutet linksausgerichtet, \lstinline|r| rechtsausgerichtet und \lstinline|c| zentriert. Durch \lstinline{|} werden Spaltenlinien gezogen. \lstinline|\toprule|, \lstinline|\midrule| und \lstinline|\bottomrule| erzeugen Kopf-, Mittel- und Abschlusslinie in der Tabelle. Als Spaltentrenner wird das \lstinline{&} genutzt, Zeilentrenner ist der doppelte Backslash (\lstinline|\\|). Am Ende kann die Tabelle auch mit einem Label versehen werden (\lstinline|\label{tab:beispieltabelle1}|), über welches diese referenziert wird. + +%\begin{center} +\begin{table}[b] + + \caption{Beispiel 1} + \begin{tabular}{lrcr} + \toprule + \textbf{Name} & \textbf{Vorname} & \textbf{Matrikelnummer} & \textbf{Lieblingsspeise}\\ + \midrule + Jackson & Michael & 123456 & Erdbeereis \\ + Springsteen & Bruce & 234567 & Schwedisches Lakritz \\ + Bach & Anna, Magdalena & 3456789 & Frankfurter Kranz \\ + Schumann & Clara & 4567890 & Bisquittörtchen \\ + \bottomrule + \end{tabular} + \label{tab:beispieltabelle1} +\end{table} +%\end{center} + +\subsection{Erweiterte Tabellenbefehle} +Um Tabellen in LaTeX flexibler zu gestalten gibt es weitere Befehle bzw. zusätzliche Pakete, die einem das Leben leichter machen (Tabelle \ref{tab:beispieltabelle2}). Hierzu ein weiteres Beispiel: + +\begin{lstlisting}[caption={Tabelle \ref{tab:beispieltabelle2}}] +\begin{table} + \centering + \caption{Beispiel 2} + \begin{tabular}{lll} + \hline + Author & Title & Year \\ + \hline + \hline + \multirow{3}{*}{Stanislav Lem} & Solaris & 1961 \\ + & Roboterm\"archen & 1967 \\ + & Der futurologische Kongress & 1971 \\ + \hline + \multirow{3}{*}{Isaac Asimov} & Ich, der Robot & 1952 \\ + & Der Tausendjahresplan & 1966 \\ + & Doctor Schapirows Gehirn & 1988 \\ + \hline + \end{tabular} +\label{tab:beispieltabelle2} +\end{table} +\end{lstlisting} + +Mit \lstinline|\centering| wird die Tabelle zentriert ausgerichtet, analoge Befehle für rechts- bzw. linksausrichtung sind z.B. \lstinline|\raggedleft| und \lstinline|\raggedright|. \\ + +Eine weitere Form der Tabellen ist das Package \textit{tabularx}, das variable Spaltenbreiten unterstützt, und \textit{booktabs}, welches mit horizontalen Linien besser arbeiten kann. +\begin{table} + \centering + \caption{So sollte man es nicht machen! Beispiel für einen schlechten Tabellenstil} + \begin{tabular}{|l|l|l|} + \hline + Author & Title & Year \\ + \hline + \hline + \multirow{3}{*}{Stanislav Lem} & Solaris & 1961 \\ + & Robotermärchen & 1967 \\ + & Der futurologische Kongress & 1971 \\ + \hline + \multirow{3}{*}{Isaac Asimov} & Ich, der Robot & 1952 \\ + & Der Tausendjahresplan & 1966 \\ + & Doctor Schapirows Gehirn & 1988 \\ + \hline + \end{tabular} +\label{tab:beispieltabelle2} +\end{table} \ No newline at end of file diff --git a/Examples/Beispiele/Todonotes.tex b/Examples/Beispiele/Todonotes.tex new file mode 100644 index 0000000..25b0c22 --- /dev/null +++ b/Examples/Beispiele/Todonotes.tex @@ -0,0 +1,51 @@ +%############################################################ +\clearpage\section{To-Do-Notes} +Um bei einer längeren Arbeit nicht den Überblick zu verlieren, an welcher Stelle es nötig ist +weiter zu arbeiten, bietet es sich an, kleine Notizen einzufügen. Das Package \textit{todonotes} +stellt eine elegante Lösung bereit, um differenziert und vielfarbig jene Abschnitte zu kennzeichnen, +die einer weiteren Bearbeitung bedürfen. + +\subsection*{Beispiel für To-Do-Notes} +Dies hier ist ein Blindtext zum Testen von Textausgaben. Wer diesen Text liest, ist selbst +\todo{Plain todonotes.} schuld. Der Text gibt lediglich den Grauwert der Schrift an. Ist das wirklich so? Ist es +gleichgültig, ob ich schreibe: Dies ist ein Blindtext? oder Huardest gefburn? Kjift? +mitnichten! Ein Blindtext bietet mir wichtige Informationen. An ihm messe ich die Les- +barkeit einer Schrift, ihre Anmutung, \todo{Plain todonotes.}wie harmonisch die Figuren zueinander stehen +und prüfe, wie breit oder schmal sie läuft. Ein Blindtext sollte möglichst viele verschie- +dene Buchstaben enthalten und in der Originalsprache gesetzt sein. Er muss keinen +Sinn ergeben, sollte aber lesbar sein.\todo[nolist]{Todonote that is only shown in the margin and not in +the list of todos.}% +Fremdsprachige Texte wie Lorem ipsum dienen +nicht dem eigentlichen Zweck, da sie eine falsche Anmutung vermitteln. Dies hier ist +ein Blindtext zum Testen von Textausgaben. Wer diesen Text liest, ist selbst schuld. + +\todo[inline]{A very long todonote that certainly will fill more +than a single line in the list of todos. Just to make sure let's add +some more text \ldots} + +Der Text gibt lediglich den Grauwert der Schrift an. Ist das wirklich so? Ist es gleichgültig, +ob ich schreibe: Dies ist ein Blindtext? oder Huardest gefburn? Kjift? mitnichten! +\todo[noline]{A note with no line back to the text.} +Ein Blindtext bietet mir wichtige Informationen. An ihm messe ich die Lesbarkeit einer +Schrift, ihre Anmutung, wie harmonisch die Figuren zueinander stehen und prüfe, wie +\todo[caption={A short entry in the list of todos}]{A very long +todonote that certainly will fill more than a single line in the +list of todos \ldots} +breit oder schmal sie läuft. Ein Blindtext sollte möglichst viele verschiedene Buchstaben +enthalten und in der Originalsprache gesetzt sein. Er muss keinen Sinn ergeben, sollte +aber lesbar sein. Fremdsprachige Texte wie Lorem ipsum dienen nicht dem eigentlichen Zweck, +da sie eine falsche Anmutung vermitteln. +\missingfigure{A figure I have to make \ldots} + +%Nummerierte ToDo-Notes +\todox{Erste Nummer...} +\todox{Zweite Nummer...} + +%Alles To-Dos als Liste ausgegeben +Nachfolgend wird noch eine Liste aller To-Dos auf einer separaten +Seite ausgegeben. +%\begingroup + %\let\clearpage\relax + %\let\cleardoublepage\relax + \listoftodos +%\endgroup \ No newline at end of file diff --git a/Examples/Code.java b/Examples/Code.java new file mode 100644 index 0000000..ed6015b --- /dev/null +++ b/Examples/Code.java @@ -0,0 +1,5 @@ + public class HalloWelt { + public static void main(String[] args) { + System.out.println("Hallo Welt!"); + } + } diff --git a/Examples/Einleitung.tex b/Examples/Einleitung.tex new file mode 100644 index 0000000..8994ff3 --- /dev/null +++ b/Examples/Einleitung.tex @@ -0,0 +1,110 @@ +%========================================= +% Einleitung = +%========================================= +\chapter{Einleitung} + +\section{\LaTeX\ installieren und einrichten} +\subsection{Unter Windows} + +Als LaTeX-Distribution unter Windows steht \href{http://www.miktex.org/}{\textit{MikTeX}} zu Verfügung, die als freie Software im Internet erhältlich ist. +\textit{MikTeX} unterstützt Windows XP, Vista und Windows 7. Neben \textit{MikTeX} wird noch ein PostScript-Interpreter benötigt, +z.B. GhostScript, zu finden auf \href{http://www.chip.de}{Chip.de}. + +\textit{Wichtig:} Bei \textit{MikTeX} unbedingt Vollinstallation auswählen, sonst sind eventuell benötigte Packages nicht vorhanden. + +\subsection{Unter Linux} + +Unter Linux existiert die LaTeX-Distribution \textit{texlive}, die als aktuelle Version aus den Paketquellen geladen werden kann (unter Ubuntu mit +\lstinline{apt-get install texlive-full}). Auch hier ist ganz wichtig, die volle Distribution zu laden, damit alle Packages zur Verfügung stehen. + +\section{Entwicklungsumgebungen} + +Hat man die passende Distribution installiert, bieten sich vielerlei Möglichkeiten an ein LaTeX-Projekt anzugehen oder einzelne Dokumente zu editieren. Unter +Windows könnten dies folgende sein: + +\begin{description} + \item [TeXnicCenter] Umfangreiche Entwicklungsumgebung mit Projektorganisation und Autovervollständigung + \item [TeXLipse] Eclipse-Plugin, das alle Vorteile der Eclipseumgebung mit LaTeX verbindet + \item [TeXmaker] Einfacher LaTeX-Editor mit Pdf-Direktvorschau +\end{description} + + +Unter Linux stehen bereit: + +\begin{description} + \item [Gummi] Ebenfalls einfacher LaTeX-Editor mit Direktvorschau + \item [TeXLipse] Auch für Linux erhältlich + \item [Kile] Umfangreiche Entwicklungsumgebung, ähnlich wie TeXnicCenter +\end{description} + +Nach der Installation muss die Entwicklungsumgebung eingerichtet werden; dazu finden sich viele Anleitungen im Internet, die genau erklären, welche Distribution +auf welche Weise eingerichtet wird. Insbesondere sollte der PDF-Viewer festgelegt werden, damit bei Gummi und TeXmaker die Direktvorschau funktioniert. Manchmal kommt es vor, dass die Ausgabe +nach dem Kompilieren Umlaute und Sonderzeichen nicht richtig darstellt. Unter Linux hängt dies mit den unterschiedlichen Zeichensätzen zusammen, die unterstützt +werden. Um diese Vorlage zu verwenden ist es notwendig, den verwendeten Zeichensatz des Editors bzw. der Entwicklungsumgebung auf den in diesem Dokument +verwendeten Zeichensatz umzustellen: UTF-8 ohne BOM (Byte Order Mark). + +\section{Werkzeuge} +\label{sec:Werkzeuge} + +\begin{description} + \item [\href{http://jabref.sourceforge.net/}{JabRef}] Ein Literaturverwaltungsprogramm, welches das \textit{BibTeX}-Format einsetzt + und mithilfe einer graphischen Oberfläche das Anlegen von Literaturverzeichnissen vereinfacht. + +\end{description} + +\section{Struktur und Gebrauch der Vorlage} + +Die vorliegende Vorlage für Abschlussarbeiten besteht aus einer internen Struktur, die grundsätzlich nicht verändert werden sollte. % Außer, der Student weiß genau, was er tut. + +\subsection{Struktur der Vorlage} +\label{subsec:strukturvorlage} + +%\begin{figure} + %\centering + %\includegraphics[width=0.85\textwidth]{Examples/strukturvorlage} + %\caption{Verzeichnisbaum der Vorlage} + %\label{fig:strukturvorlage} + %\end{figure} + + +\begin{description} + \item [htw-i-mst-config.tex] Enthält alle zu ladenden Packages, Styleparameter für Hyperlinks, Codelistings und Literaturverzeichnis sowie globale Parameter + für Tabellen und Beschriftungen. Im Besonderen befinden sich hier die Variablen für den eigenen Namen, Titel, Datum der Arbeit, den betreuenden Professor etc. + + \item [htw-i-mst-vorlage.tex] Dies ist die Hauptdatei, in der alle notwendigen \textit{*.tex}-Dateien eingebunden werden, die zu dem Dokument gehören. Es empfiehlt sich + die interne Struktur \textit{nicht} zu verändern. Eigene Kapitel werden an der dafür markierten Stelle eingebunden. + + \item [Bibliography.bib] Zentrale Datei für die Literaturangaben, welche man z.B. mit JabRef verwalten kann. + + \item [Chapters/] Ablageort für alle selbst angelegten Kapitel der Arbeit. Die Aufteilung in eigene Dateien erleichtert die Übersicht über den Quellcode. + + \item [Graphics/] Ablageort für alle im Dokument benötigten Grafikdateien. Gerne darf man hier Unterverzeichnisse zur besseren Strukturierung anlegen. + + \item [Examples/] Dieser Ordner enthält die in dieser Vorlage beigefügten LaTeX-Beispiele, welche vor der Abgabe der Arbeit selbstverständlich gelöscht werden sollten. + + \item [Frontbackmatter/] + In diesem Ordner sind all jene Dateien abgelegt, die -- außer dem Kerntext in \textit{Chapters/} -- die Gesamtheit der Abschlussarbeit ausmachen. + \begin{description} + \item [Titlepage.tex] Definiert die Titelseite der Abschlussarbeit. Diese Datei muss normalerweise nicht verändert werden. + \item [Abbreviations.tex] Hier werden alle Abkürzungen hinterlegt, die im Dokument verwendet werden. + \item [Abstract.tex] Eine kurze Zusammenfassung der Abschlussarbeit wird in diese Datei eingefügt. + \item [Acknowledgements.tex] Dort finden Danksagungen ihren Platz. + \item [ConfidentialityClause.tex] Beinhaltet den Sperrvermerk und ist nur zu verwenden, falls dies beispielsweise vom beteiligten Unternehmen gefordert wird. + \item [Contents.tex] Enthält wichtige Eintragungen in die \textit{Table-of-Contents}. Diese Datei muss normalerweise nicht geändert werden. + \item [Declaration.tex] Enthält die Selbständigkeitserklärung. Diese Datei darf nicht geändert werden. + \item [Colophon.tex] Enthält einen Hinweis auf die Urheber dieser Vorlage. Diese Datei darf nicht geändert werden. + \item [ListOfs.tex] Enthält die Einträge für die Tabellen- und Abbildungsverzeichnisse etc. und muss gewöhnlich nicht verändert werden. + \end{description} + +\end{description} + + +\subsection{Gebrauch der Vorlage} + +Grundsätzlich ist nicht viel zu tun, um die Vorlage für Abschlussarbeiten zu verwenden. Man entpackt den Hauptordner in das gewünschte Verzeichnis und nutzt die Dateien so, wie in +\autoref{subsec:strukturvorlage} beschrieben. Danach werden \textit{alle} Dateien gespeichert und die Hauptdatei, \textit{htwsaar-i-mst-vorlage.tex}, mehrfach kompiliert +(LaTeX benötigt mehrere Durchgänge um z.B. Referenzen richtig zuzuordnen). +Hat man Änderungen in \textit{Bibliography.bib} bzw. \textit{Bibliography.tex} vorgenommen oder neue Zitate z.B. mittels \lstinline{\cite} eingefügt, muss erst mit +\textit{BibLaTeX} und anschließend mitdem entsprechenden LaTeX-nach-PDF-Compiler übersetzt werden. + + diff --git a/Examples/bpmn.jpg b/Examples/bpmn.jpg new file mode 100644 index 0000000..fadb9aa Binary files /dev/null and b/Examples/bpmn.jpg differ diff --git a/Examples/bpmn.pdf b/Examples/bpmn.pdf new file mode 100644 index 0000000..fa9e11d Binary files /dev/null and b/Examples/bpmn.pdf differ diff --git a/Examples/example_5.jpg b/Examples/example_5.jpg new file mode 100644 index 0000000..d770544 Binary files /dev/null and b/Examples/example_5.jpg differ diff --git a/Examples/example_5.pdf b/Examples/example_5.pdf new file mode 100644 index 0000000..72e5575 Binary files /dev/null and b/Examples/example_5.pdf differ diff --git a/Examples/example_5.png b/Examples/example_5.png new file mode 100644 index 0000000..5e18587 Binary files /dev/null and b/Examples/example_5.png differ diff --git a/Examples/jabref.jpg b/Examples/jabref.jpg new file mode 100644 index 0000000..7d73c84 Binary files /dev/null and b/Examples/jabref.jpg differ diff --git a/Examples/jabref.png b/Examples/jabref.png new file mode 100644 index 0000000..143a4e1 Binary files /dev/null and b/Examples/jabref.png differ diff --git a/FrontBackmatter/Abbreviations.tex b/FrontBackmatter/Abbreviations.tex new file mode 100644 index 0000000..584bd80 --- /dev/null +++ b/FrontBackmatter/Abbreviations.tex @@ -0,0 +1,14 @@ +%******************************************************* +% Abkürzungsverzeichnis +%******************************************************* +\chapter*{Abkürzungsverzeichnis} +\markboth{Abkürzungsverzeichnis}{} +\addcontentsline{toc}{chapter}{Abkürzungsverzeichnis} + %Hier alle benötigten Abkürzungen einfügen + \begin{acronym}[WLAN] % LONGEST ACRONYM HERE FOR CORRECT SPACING + \acro{WLAN}{Wireless Local Area Network} + \acro{TCP}{Transmission Control Protocol} + \acro{GoF}{Gang of Four} + \end{acronym} + + \ No newline at end of file diff --git a/FrontBackmatter/Abstract.tex b/FrontBackmatter/Abstract.tex new file mode 100644 index 0000000..3acf303 --- /dev/null +++ b/FrontBackmatter/Abstract.tex @@ -0,0 +1,8 @@ +%******************************************************* +% Abstract +%******************************************************* +\pdfbookmark[0]{Zusammenfassung}{Zusammenfassung} +\chapter*{Zusammenfassung} +Kurze Zusammenfassung des Inhaltes in deutscher Sprache, der Umfang beträgt zwischen einer halben und einer ganzen DIN A4-Seite. + +Orientieren Sie sich bei der Aufteilung bzw. dem Inhalt Ihrer Zusammenfassung an Kent Becks Artikel: \url{http://plg.uwaterloo.ca/~migod/research/beckOOPSLA.html}. \ No newline at end of file diff --git a/FrontBackmatter/Acknowledgments.tex b/FrontBackmatter/Acknowledgments.tex new file mode 100644 index 0000000..4258dea --- /dev/null +++ b/FrontBackmatter/Acknowledgments.tex @@ -0,0 +1,28 @@ +%******************************************************* +% Acknowledgments +%******************************************************* +\pdfbookmark[0]{Danksagung}{acknowledgments} + +% Beispiel für ein sinnvolles Zitat +\begin{flushright}{\slshape + We have seen that computer programming is an art, \\ + because it applies accumulated knowledge to the world, \\ + because it requires skill and ingenuity, and especially \\ + because it produces objects of beauty.} \\ \medskip + --- Donald E. Knuth \cite{knuth:1974} +\end{flushright} + +\bigskip + +\begingroup + \let\clearpage\relax + \let\cleardoublepage\relax + \let\cleardoublepage\relax + \chapter*{Danksagung} + Hier können Sie Personen danken, die zum Erfolg der Arbeit beigetragen haben, beispielsweise Ihren Betreuern in der Firma, Ihren Professoren/Dozenten an der htw saar, Freunden, Familie usw. + + + + +\endgroup + diff --git a/FrontBackmatter/Bibliography.tex b/FrontBackmatter/Bibliography.tex new file mode 100644 index 0000000..53913eb --- /dev/null +++ b/FrontBackmatter/Bibliography.tex @@ -0,0 +1,4 @@ +%******************************************************************** +% Bibliography +%******************************************************* +\printbibliography \ No newline at end of file diff --git a/FrontBackmatter/Colophon.tex b/FrontBackmatter/Colophon.tex new file mode 100644 index 0000000..c4f6994 --- /dev/null +++ b/FrontBackmatter/Colophon.tex @@ -0,0 +1,11 @@ +\pagestyle{empty} + +\hfill + +\vfill + + +\pdfbookmark[0]{Kolophon}{colophon} +\section*{Kolophon} +Dieses Dokument wurde mit der \LaTeX-Vorlage für Abschlussarbeiten an der htw saar im Bereich Informatik/Mechatronik-Sensortechnik erstellt (\currentVersion). Die Vorlage wurde von Yves Hary und Andr\'e Miede entwickelt (mit freundlicher Unterstützung von Thomas Kretschmer, Helmut G. Folz und Martina Lehser). Daten: (F)\makeatletter\f@size\makeatother\ -- (B)\the\textwidth\ -- (H)\the\textheight\ + diff --git a/FrontBackmatter/Colophon_en.tex b/FrontBackmatter/Colophon_en.tex new file mode 100644 index 0000000..14aa4f9 --- /dev/null +++ b/FrontBackmatter/Colophon_en.tex @@ -0,0 +1,12 @@ +\pagestyle{empty} + +\hfill + +\vfill + + +\pdfbookmark[0]{Colophon}{colophon} +\section*{Colophon} +%Dieses Dokument wurde mit der \LaTeX-Vorlage für Abschlussarbeiten an der htw saar im Bereich Informatik/Mechatronik-Sensortechnik erstellt (\currentVersion). Die Vorlage wurde von Yves Hary und Andr\'e Miede entwickelt (mit freundlicher Unterstützung von Thomas Kretschmer, Helmut G. Folz und Martina Lehser). Daten: (F)\makeatletter\f@size\makeatother\ -- (B)\the\textwidth\ -- (H)\the\textheight\ + +This document has been created with the theses \LaTeX template provided by htw saar, Saarland University of Applied Sciences, Informatics/Mechatronics and Sensor Technology (\currentVersion). This template has been created by Yves Hary and Andr\'e Miede (with kind support from Thomas Kretschmer, Helmut G. Folz and Martina Lehser). Data: (F)\makeatletter\f@size\makeatother\ -- (B)\the\textwidth\ -- (H)\the\textheight\ diff --git a/FrontBackmatter/ConfidentialityClause.tex b/FrontBackmatter/ConfidentialityClause.tex new file mode 100644 index 0000000..e06f5e5 --- /dev/null +++ b/FrontBackmatter/ConfidentialityClause.tex @@ -0,0 +1,19 @@ +%******************************************************* +% Sperrvermerk +% [Nicht übersetzen, +% weil Prüfungsleistung an dt. Hochschule] +%******************************************************* +% Der Sperrvermerk kann entfernt werden, wenn die Arbeit z.B. nicht im +% Zusammenarbeit mit einem Unternehmen angefertigt wurde oder kein +% Sperrvermerk verlangt wird. + +\pdfbookmark[0]{Sperrvermerk}{sperrvermerk} +\chapter*{Sperrvermerk} +%\thispagestyle{empty} + +Die vorliegende Arbeit mit dem Titel "`\myTitle"' enthält vertrauliche Daten des Unternehmens \myCompany. + +Die Arbeit darf nur dem Erst- und Zweitgutachter sowie befugten Mitgliedern des Prüfungsausschusses zugänglich gemacht werden. +Eine Veröffentlichung und Vervielfältigung der Arbeit ist -- auch in Auszügen -- nicht gestattet. + +Eine Einsichtnahme der Arbeit durch Unbefugte bedarf einer ausdrücklichen Genehmigung des Verfassers und des Unternehmens \myCompany. diff --git a/FrontBackmatter/Contents.tex b/FrontBackmatter/Contents.tex new file mode 100644 index 0000000..4b82f6d --- /dev/null +++ b/FrontBackmatter/Contents.tex @@ -0,0 +1,12 @@ +%******************************************************* +% Table of Contents +%******************************************************* +\setcounter{tocdepth}{2} % <-- 2 includes up to subsections in the ToC +\setcounter{secnumdepth}{3} % <-- 3 numbers up to subsubsections + +\pdfbookmark[0]{\contentsname}{toc} +\tableofcontents + +% Die weiteren Verzeichnisse folgen am Ende des Dokuments + + diff --git a/FrontBackmatter/Declaration.tex b/FrontBackmatter/Declaration.tex new file mode 100644 index 0000000..f932d51 --- /dev/null +++ b/FrontBackmatter/Declaration.tex @@ -0,0 +1,31 @@ +%******************************************************* +% Declaration +% [Nicht übersetzen, +% weil Prüfungsleistung an dt. Hochschule] +%******************************************************* +\pdfbookmark[0]{Selbständigkeitserklärung}{declaration} +\chapter*{Selbständigkeitserklärung} +%\thispagestyle{empty} + +Ich versichere, dass ich die vorliegende Arbeit (bei einer Gruppenarbeit: den entsprechend gekennzeichneten +Anteil der Arbeit) selbständig verfasst und keine anderen als die angegebenen Quellen und +Hilfsmittel benutzt habe. + +Ich erkläre hiermit weiterhin, dass die vorgelegte Arbeit zuvor weder von mir noch von einer anderen Person an dieser oder einer +anderen Hochschule eingereicht wurde. + +Darüber hinaus ist mir bekannt, dass die Unrichtigkeit dieser Erklärung eine Benotung der +Arbeit mit der Note \glqq nicht ausreichend\grqq zur Folge hat und einen Ausschluss von der Erbringung +weiterer Prüfungsleistungen zur Folge haben kann. +\bigskip + +\noindent\textit{\myLocation, \myTime} + +\smallskip + +\begin{flushright} + \begin{tabular}{m{5cm}} + \\ \hline + \centering\myName \\ + \end{tabular} +\end{flushright} \ No newline at end of file diff --git a/FrontBackmatter/ListOfs.tex b/FrontBackmatter/ListOfs.tex new file mode 100644 index 0000000..ef34d7e --- /dev/null +++ b/FrontBackmatter/ListOfs.tex @@ -0,0 +1,12 @@ +%******************************************************* +% Verzeichnisse (Abbildungen, Tabellen, Listings, etc.) +%******************************************************* +\cleardoublepage +\begingroup + \let\clearpage\relax + \let\cleardoublepage\relax + \listoffigures + \listoftables + %\addcontentsline{toc}{chapter}{\lstlistlistingname} + \lstlistoflistings +\endgroup \ No newline at end of file diff --git a/FrontBackmatter/Titlepage.tex b/FrontBackmatter/Titlepage.tex new file mode 100644 index 0000000..32aeb58 --- /dev/null +++ b/FrontBackmatter/Titlepage.tex @@ -0,0 +1,45 @@ +%******************************************************* +% Titlepage +% [Nicht zu verändern] +%******************************************************* +\begin{titlepage}\linespread{1.5}\selectfont +\includegraphics[width=\linewidth]{Graphics/htwsaar_Logo_inwi_head_VF_4C_crop} + \begin{center} + \large + \hfill + \vfill + \begingroup + \Large\bfseries\myDegreeType-Thesis + \endgroup + + \bigskip + + zur Erlangung des akademischen Grades \\ + \myDegree \\ + an der \myUni \\ + im Studiengang \myDegreeCourse \\ + der Fakultät für Ingenieurwissenschaften \\  + + \vfill + + \begingroup + \Large\bfseries\myTitle + \endgroup + + \bigskip + + vorgelegt von \\ + \myName + + \vfill + + betreut und begutachtet von \\ + \myFirstProf \\ + \mySecondProf + + \vfill + + \myLocation, \myTime + + \end{center} +\end{titlepage} \ No newline at end of file diff --git a/Graphics/htwsaar_Logo_inwi_head_VF_4C_crop.pdf b/Graphics/htwsaar_Logo_inwi_head_VF_4C_crop.pdf new file mode 100644 index 0000000..f008325 Binary files /dev/null and b/Graphics/htwsaar_Logo_inwi_head_VF_4C_crop.pdf differ diff --git a/README.md b/README.md index b2b20fe..652040e 100644 --- a/README.md +++ b/README.md @@ -1 +1,11 @@ -# htwsaar-i-mst-vorlage \ No newline at end of file +# htwsaar-i-mst-vorlage + +![Version](https://img.shields.io/badge/version-2.2-blue) ![Language](https://img.shields.io/badge/language-LaTeX-lightgrey) + +Eine LaTeX-Vorlage für Abschlussarbeiten im Bereich Informatik/Mechatronik-Sensortechnik an der htw saar. + +Details zur Installation und Konfiguration sind in der Vorlage selbst enthalten. + + +### Hinweis zu Absätzen und Zeilenumbrüchen +Gedankengänge bitte durch Absätze trennen, das ist im LaTeX-Quelltext eine Leerzeile. Leerzeilen nicht in Kombination mit `\\` verwenden. Idealerweise `\\` gar nicht verwenden. :innocent: \ No newline at end of file diff --git a/htwsaar-i-mst-config.tex b/htwsaar-i-mst-config.tex new file mode 100644 index 0000000..f5b2f18 --- /dev/null +++ b/htwsaar-i-mst-config.tex @@ -0,0 +1,248 @@ +% **************************************************************************************************** +% htwsaar-i-mst-config.tex +% **************************************************************************************************** +\RequirePackage[utf8]{inputenc} + \DeclareUnicodeCharacter{00A0}{~} +\RequirePackage[T1]{fontenc} + +% **************************************************************************************************** +% 1. Personal data and user ad-hoc commands +% **************************************************************************************************** +\newcommand{\myTitle}{Eine \LaTeX-Vorlage für Abschlussarbeiten im Bereich Informatik/ Mechatronik-Sensortechnik an der htw saar} +\newcommand{\myDegree}{Bachelor of Science (B.\,Sc.)\xspace} +%\newcommand{\myDegree}{Master of Science (M.\,Sc.)\xspace} +\newcommand{\myDegreeType}{Bachelor\xspace} +%\newcommand{\myDegreeType}{Master\xspace} +\newcommand{\myDegreeCourse}{Praktische Informatik} +%\newcommand{\myDegreeCourse}{Kommunikationsinformatik} +\newcommand{\myName}{Max Muster\xspace} +\newcommand{\myUni}{Hochschule für Technik und Wirtschaft des Saarlandes\xspace} +\newcommand{\myCompany}{SoftwareCenter Musterhausen\xspace} +\newcommand{\myFirstProf}{Prof. Dr.-Ing. Andr\'e Miede\xspace} +\newcommand{\mySecondProf}{Prof. Dr. Thomas Kretschmer\xspace} +\newcommand{\myLocation}{Saarbrücken\xspace} +\newcommand{\myTime}{Tag.~Monat~Jahr\xspace} +\newcommand{\currentVersion}{Version 2.2, September 2021\xspace} % TODO: ggf. über git Versionsinformationen automatisch bereitstellen und verwenden + +% ******************************************************************** +% Setup, finetuning, and useful commands +% ******************************************************************** +\newcounter{dummy} % necessary for correct hyperlinks (to index, bib, etc.) +% **************************************************************************************************** + + +% **************************************************************************************************** +% 2. Loading some handy packages +% **************************************************************************************************** +% ******************************************************************** +% Packages with options that might require adjustments +% ******************************************************************** +\PassOptionsToPackage{ngerman}{babel} % change this to your language(s) + \RequirePackage{babel} + \RequirePackage{csquotes} + +\PassOptionsToPackage{language=auto,style=numeric-comp,backend=bibtex8,bibencoding=ascii,maxbibnames=50}{biblatex} + \RequirePackage{biblatex} + \bibliography{Bibliography} + +\PassOptionsToPackage{fleqn}{amsmath} % math environments and more by the AMS + \RequirePackage{amsmath} + +% ******************************************************************** +% Setting up the page and margins +% ******************************************************************** +\usepackage{geometry} + \geometry{a4paper,left=25mm,right=35mm,top=25mm,bottom=30mm} +% DIESE WERTE SIND NICHT ZU VERÄNDERN -- DO NOT CHANGE THESE VALUES + +% ******************************************************************** +% General useful packages +% ******************************************************************** +%\usepackage[automark]{scrpage2} +\PassOptionsToPackage{dvipsnames}{xcolor} + \RequirePackage{xcolor} % [dvipsnames] + \definecolor{ingwi}{cmyk}{.9,0,0,0} +\usepackage{textcomp} % fix warning with missing font shapes +\usepackage{scrhack} % fix warnings when using KOMA with listings package +\usepackage{xspace} % to get the spacing after macros right +\usepackage{mparhack} % get marginpar right +%\usepackage{fixltx2e} % fixes some LaTeX stuff <-- ist seit 2015 nicht mehr notwendig +\PassOptionsToPackage{printonlyused}{acronym} + \usepackage{acronym} % nice macros for handling all acronyms in the thesis +%\renewcommand{\bflabel}[1]{{#1}\hfill} % fix the list of acronyms +\usepackage{booktabs} +\usepackage{multirow} +\usepackage[shadow]{todonotes} %Settings for ToDoNotes +% Eigene Shortcuts fuer laengere Befehle + \newcommand{\todox}[1]{\todo[inline, size=\small]{#1}} + %Nummerierte Anmerkungen + \newcounter{todocounter} + \renewcommand{\todox}[2][]{\stepcounter{todocounter}\todo[inline, size=\small,caption={\thetodocounter: #2}, #1]{\renewcommand{\baselinestretch}{0.5}\selectfont\thetodocounter: #2\par}} +\usepackage{blindtext} +%\usepackage{footmisc} +% **************************************************************************************************** + + +% **************************************************************************************************** +% 3. Setup floats: tables, (sub)figures, and captions +% **************************************************************************************************** +\usepackage{tabularx} % better tables + \setlength{\extrarowheight}{3pt} % increase table row height +%\newcommand{\myfloatalign}{\centering} % to be used with each float for alignment +\usepackage{caption} +\captionsetup{format=hang,font=small} +\usepackage{subfig} +\usepackage{wrapfig} +% **************************************************************************************************** + + +% **************************************************************************************************** +% 6. Setup code listings +% **************************************************************************************************** +\usepackage{listings} +%\lstset{emph={trueIndex,root},emphstyle=\color{BlueViolet}}%\underbar} % for special keywords +\lstset{language=[LaTeX]Tex,%C++, + keywordstyle=\color{RoyalBlue},%\bfseries, + basicstyle=\small\ttfamily, + %identifierstyle=\color{NavyBlue}, + commentstyle=\color{Green}\ttfamily, + stringstyle=\rmfamily, + numbers=none,%left,% + numberstyle=\scriptsize,%\tiny + stepnumber=5, + numbersep=8pt, + showstringspaces=false, + breaklines=true, + frameround=ftff, + frame=single, + texcl=true, + belowcaptionskip=.75\baselineskip + %frame=L +} +%Styles für verschiedene Sprachen festlegen, z.B. Java +\lstdefinestyle{Java}{ +belowcaptionskip=1\baselineskip, + breaklines=true, + xleftmargin=\parindent, + language=Java, + texcl=true, + showstringspaces=false, + basicstyle=\footnotesize\ttfamily, + keywordstyle=\bfseries\color{green!40!black}, + commentstyle=\itshape\color{purple!40!black}, + identifierstyle=\color{blue}, + stringstyle=\color{orange}} +% **************************************************************************************************** + + +% **************************************************************************************************** +% 6. PDFLaTeX, hyperreferences and citation backreferences +% **************************************************************************************************** +% ******************************************************************** +% Using PDFLaTeX +% ******************************************************************** +\PassOptionsToPackage{pdftex,hyperfootnotes=false,pdfpagelabels}{hyperref} + \usepackage{hyperref} % backref linktocpage pagebackref +\pdfcompresslevel=9 +\pdfadjustspacing=1 +\PassOptionsToPackage{pdftex}{graphicx} + \usepackage{graphicx} + + +% ******************************************************************** +% Hyperreferences +% ******************************************************************** +\hypersetup{% + %draft, % = no hyperlinking at all (useful in b/w printouts) + pdfstartpage=1, pdfstartview=Fit,% + colorlinks=true, linktocpage=true, + %urlcolor=Black, linkcolor=Black, citecolor=Black, %pagecolor=Black,% + %urlcolor=brown, linkcolor=RoyalBlue, citecolor=green, %pagecolor=RoyalBlue,% + % uncomment the following line if you want to have black links (e.g., for printing) + colorlinks=false, pdfborder={0 0 0}, + breaklinks=true, pdfpagemode=UseNone, pageanchor=true, pdfpagemode=UseOutlines,% + plainpages=false, bookmarksnumbered, bookmarksopen=true, bookmarksopenlevel=1,% + hypertexnames=true, pdfhighlight=/O,%nesting=true,%frenchlinks,% + pdftitle={\myTitle},% + pdfauthor={\textcopyright\ \myName, \myUni},% + pdfsubject={},% + pdfkeywords={},% + pdfcreator={pdfLaTeX},% + pdfproducer={LaTeX with hyperref}% +} + +% ******************************************************************** +% Setup autoreferences +% ******************************************************************** +% There are some issues regarding autorefnames +% http://www.ureader.de/msg/136221647.aspx +% http://www.tex.ac.uk/cgi-bin/texfaq2html?label=latexwords +% you have to redefine the makros for the +% language you use, e.g., american, ngerman +% (as chosen when loading babel/AtBeginDocument) +% ******************************************************************** +\makeatletter +\@ifpackageloaded{babel}% + {% + \addto\extrasamerican{% + \renewcommand*{\figureautorefname}{Figure}% + \renewcommand*{\tableautorefname}{Table}% + \renewcommand*{\partautorefname}{Part}% + \renewcommand*{\chapterautorefname}{Chapter}% + \renewcommand*{\sectionautorefname}{Section}% + \renewcommand*{\subsectionautorefname}{Section}% + \renewcommand*{\subsubsectionautorefname}{Section}% + }% + \addto\extrasngerman{% + \renewcommand*{\chapterautorefname}{Kapitel}% + \renewcommand*{\sectionautorefname}{Abschnitt}% + \renewcommand*{\subsectionautorefname}{Abschnitt}% + \renewcommand*{\subsubsectionautorefname}{Abschnitt}% + \renewcommand*{\paragraphautorefname}{Absatz}% + \renewcommand*{\subparagraphautorefname}{Absatz}% + \renewcommand*{\footnoteautorefname}{Fu\"snote}% + \renewcommand*{\FancyVerbLineautorefname}{Zeile}% + \renewcommand*{\theoremautorefname}{Theorem}% + \renewcommand*{\appendixautorefname}{Anhang}% + \renewcommand*{\equationautorefname}{Gleichung}% + \renewcommand*{\itemautorefname}{Punkt}% + }% + % Fix to getting autorefs for subfigures right (thanks to Belinda Vogt for changing the definition) + \providecommand{\subfigureautorefname}{\figureautorefname}% + }{\relax} +\makeatother + + +% **************************************************************************************************** +% 6. Last calls before the bar closes +% **************************************************************************************************** +% ******************************************************************** +% Development Stuff +% ******************************************************************** +%\listfiles +\PassOptionsToPackage{l2tabu,orthodox,abort}{nag} + \usepackage{nag} +%\PassOptionsToPackage{warning, all}{onlyamsmath} +% \usepackage{onlyamsmath} + + +% **************************************************************************************************** +% 7. Further adjustments (experimental) +% **************************************************************************************************** +%\usepackage{tocbibind} %Allows us to add Bibliography to ToC +\usepackage{enumitem} +\setdescription{font=\normalfont\bfseries} %Changes the appearance of description items +\usepackage[activate={true,nocompatibility},final,tracking=true,kerning=true,spacing=true,factor=1100,stretch=10,shrink=10]{microtype} + + +% ******************************************************************** +% Using different fonts +% ******************************************************************** +%\usepackage{lmodern} % <-- no osf support :-( +%\usepackage[tt=false]{libertine} % [osf] +%\usepackage{luximono} +\usepackage{mathpazo} +%\usepackage[urw-garamond]{mathdesign} <-- no osf support :-( + +\setkomafont{disposition}{\bfseries} +% **************************************************************************************************** \ No newline at end of file diff --git a/htwsaar-i-mst-vorlage.pdf b/htwsaar-i-mst-vorlage.pdf new file mode 100644 index 0000000..7cd9f57 Binary files /dev/null and b/htwsaar-i-mst-vorlage.pdf differ diff --git a/htwsaar-i-mst-vorlage.tex b/htwsaar-i-mst-vorlage.tex new file mode 100644 index 0000000..89ed8f4 --- /dev/null +++ b/htwsaar-i-mst-vorlage.tex @@ -0,0 +1,72 @@ +% ****************************************************************** ******************************************** +% +% ************************************************************************************************************** +\documentclass[ twoside,openright,titlepage,numbers=noenddot,% + toc=bibliography,toc=listof,% + footinclude=false,headinclude=false,cleardoublepage=empty,% + BCOR=5mm,paper=a4,fontsize=11pt,%DIV=14,% + ngerman% + ]{scrreprt} + +%*************************************************************************************************************** +% Note: Make all your adjustments in here +%*************************************************************************************************************** +\input{htwsaar-i-mst-config} + +%******************************************************************** +% Hyphenation +%******************************************************* +%\hyphenation{put special hyphenation here} + +% ******************************************************************** +% GO!GO!GO! MOVE IT! +%******************************************************* +\begin{document} +\frenchspacing +\raggedbottom +\selectlanguage{ngerman} % american ngerman +\pagenumbering{roman} +\pagestyle{plain} +%******************************************************* +% Frontmatter +%******************************************************* +\include{FrontBackmatter/Titlepage} +\cleardoublepage\include{FrontBackmatter/Declaration} +%\cleardoublepage\include{FrontBackmatter/ConfidentialityClause} % <-- sollte in der Regel nicht notwendig sein und mit Betreuer/Unternehmen abgeklärt werden +\cleardoublepage\include{FrontBackmatter/Abstract} +\cleardoublepage\include{FrontBackmatter/Acknowledgments} +\cleardoublepage\include{FrontBackmatter/Contents} + +%******************************************************* +% Mainmatter +%******************************************************* +\cleardoublepage +\pagenumbering{arabic} +\pagestyle{headings} +%\pagestyle{scrheadings} +\cleardoublepage\include{Examples/Einleitung} % Diese Einbindungen werden natürlich entfernt, wenn es an die richtige +\cleardoublepage\include{Examples/Beispiele} % Abschlussarbeit geht! +%\cleardoublepage\include{Chapters/KapitelBachelorarbeit} % <<< Hier alle Chapter der Abschlussarbeit (einzeln) einbinden + +%******************************************************************** +% Bibliography/References +%******************************************************* +\cleardoublepage\include{FrontBackmatter/Bibliography} + +%******************************************************************** +% List of Figures etc. +%******************************************************* +\cleardoublepage\include{FrontBackmatter/ListOfs} +\include{FrontBackmatter/Abbreviations} + +% ******************************************************************** +% Appendix/Anhang +%*************************************************************** +\appendix +\part*{Anhang} +\cleardoublepage\include{Chapters/Anhang-A} + +%******************************************************* +\cleardoublepage\include{FrontBackmatter/Colophon} +\end{document} +% ********************************************************************