2
0

Transfer der Vorlage nach GitHub.

This commit is contained in:
André Miede
2021-09-30 20:35:09 +02:00
committed by Tim Wall
parent 43056bb5dc
commit bb885e3d7f
38 changed files with 1124 additions and 2 deletions

View File

@@ -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}

View File

@@ -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.

View File

@@ -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.

View File

@@ -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}).

View File

@@ -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}

View File

@@ -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).

View File

@@ -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

View File

@@ -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}

View File

@@ -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