\documentclass[draft,ngerman]{vorlage-ausarbeitung/vorlage}% draft entfernen, um die "Entwurf"-Markierung in der Fußzeile zu deaktivieren, wenn Arbeit fertig
Die Vorlage enthält sehr viele und umfangreiche Makros. Um diese auch den Studenten zugänglich zu machen sollen sie in diesem Kapitel beschrieben werden. Außerdem sind alle von der Vorlage eingebunden Packages in der Tabelle \ref{tab:packages} aufgelistet.
\newcommand{\link}[2]{\href{#1}{\texttt{#2}}}
\begin{table}
\centering
\caption{Alle Packages die standardmäßig mit der Vorlage eingebunden werden.}\label{tab:packages}
\begin{tabular}{llp{.5\textwidth}}\toprule
Name &Optionale Argumente & Beschreibung \\
\midrule
\link{http://mirrors.ctan.org/macros/latex/base/ifthen.pdf}{ifthen}&& The package's basic command is ifthenelse, which can use a wide array of tests. Also provided is a simple loop command\\
\link{http://ctan.org/pkg/microtype}{microtype}& siehe Code & Minimale Anpassung der Breite von Schrift und Leerzeichen, um eine bessere Silbentrennung zu erreichen.\\
\link{http://mirrors.ctan.org/graphics/pgf/base/doc/pgfmanual.pdf}{tikz}&& Makros um Grafiken zu erstellen. Weitere Hilfe: \link{http://cremeronline.com/LaTeX/minimaltikz.pdf}{Minimal Introduction}\\
\link{http://mirrors.ctan.org/graphics/pgf/contrib/pgfplots/doc/pgfplots.pdf}{pgfplots}&& Zeichnen von Plots \\
\link{http://mirrors.ctan.org/macros/latex/contrib/blindtext/blindtext.pdf}{blindtext}&& Makro für blindtext \\
\link{http://ctan.org/pkg/ziffer}{ziffer}&& Komma als Trennzeichen bei Zahlen (Abweichend vom Standard dieses Packages ist hier in der Vorlage der Dezimalpunkt sichtbar geschaltet)\\
\caption{Alle Packages die standardmäßig mit der Vorlage eingebunden werden.\label{tab:packages}}\\
\toprule
Name & Argumente & Beschreibung \\
\midrule\endhead
\link{http://mirrors.ctan.org/macros/latex/base/ifthen.pdf}{ifthen}&& The package's basic command is ifthenelse, which can use a wide array of tests. Also provided is a simple loop command\\
\link{http://ctan.org/pkg/microtype}{microtype}& siehe Code & Minimale Anpassung der Breite von Schrift und Leerzeichen, um eine bessere Silbentrennung zu erreichen.\\
\link{http://mirrors.ctan.org/graphics/pgf/base/doc/pgfmanual.pdf}{tikz}&& Makros um Grafiken zu erstellen. Weitere Hilfe: \link{http://cremeronline.com/LaTeX/minimaltikz.pdf}{Minimal Introduction}\\
\link{http://mirrors.ctan.org/graphics/pgf/contrib/pgfplots/doc/pgfplots.pdf}{pgfplots}&& Zeichnen von Plots \\
\link{http://mirrors.ctan.org/macros/latex/contrib/blindtext/blindtext.pdf}{blindtext}&& Makro für blindtext \\
\link{http://ctan.org/pkg/ziffer}{ziffer}&& Komma als Trennzeichen bei Zahlen (Abweichend vom Standard dieses Packages ist hier in der Vorlage der Dezimalpunkt sichtbar geschaltet)\\
@@ -51,11 +52,11 @@ In diesem Abschnitt werden die Makros beschrieben die in der Datei \texttt{baseM
\subsection{\texttt{bspl} - Beispielumgebung}
\begin{bspl}{Demonstration der Beispielumgebung:}
Mit der Beispielumgebung können Beispiele vom restlichen Text abgesetzt werden. Die Beispielumgebung startet mit \textbf{Beispiel} dann kommt eine dem Kapitel nach gezählte Nummer und dann eine Überschrift in kursiven Text. Das Ende des Beipspiels wird durch ein schwarzes Dreieck markiert.
Mit der Beispielumgebung können Beispiele vom restlichen Text abgesetzt werden. Die Beispielumgebung startet mit \textbf{Beispiel}, dann kommt eine dem Kapitel nach gezählte Nummer und dann eine Überschrift in kursiven Text. Das Ende des Beispiels wird durch ein schwarzes Dreieck markiert.
\end{bspl}
\paragraph{Verwendung:}
\begin{lstlisting}
\begin{lstlisting}[caption={Code für eine Umgebung zur Abhebung von Beispielen.}]
\begin{bspl}{name}
...
\end{bspl}
...
...
@@ -63,8 +64,8 @@ In diesem Abschnitt werden die Makros beschrieben die in der Datei \texttt{baseM
Zentrierte Umgebung, bei der vor und nach der Umgebung kein zusätzlicher Abstand eingefügt wird. Ist ab und zu beim erstellen von Folien hilfreich.
\begin{lstlisting}
Zentrierte Umgebung, bei der vor und nach der Umgebung kein zusätzlicher Abstand eingefügt wird. Kann beim erstellen von Folien hilfreich sein.
\begin{lstlisting}[caption={Umgebung in welcher der Text zentriert wird ohne zusätzlichen Abstand darüber oder darunter einzufügen.}]
\begin{nscenter}
...
\end{nscenter}
...
...
@@ -81,7 +82,7 @@ weiteres blablablba als komischer Text unterhalb des zentrierten teils...
\section{Blockdiagramm}
Die Makros für Blockdiagramme liegen in der Datei \texttt{tikzBlockdiagram}. Mit diesen wurde das in Bild \ref{fig:blockschaltbild} dargestellte Blockschaltbild gezeichnet.
Die Makros für Blockdiagramme liegen in der Datei \texttt{tikz\-Block\-diagram.tex}. Mit diesen wurde das in Bild \ref{fig:blockschaltbild} dargestellte Blockschaltbild gezeichnet.
\newcommand{\docblockrow}[1]{
\texttt{\string#1}
...
...
@@ -132,23 +133,31 @@ Die Makros für Blockdiagramme liegen in der Datei \texttt{tikzBlockdiagram}. Mi
}
\begin{figure}
\resizebox{\textwidth}{!}{%
\blockbild
}
\caption{Beispiel für ein Blockschaltbild}\label{fig:blockschaltbild}
\end{figure}
\paragraph{Benötigte Dateien}
Um mit der Markrosammlung Strukturbilder zeichnen zu können, müssen die Dateien \texttt{tikzBase.tex} und \texttt{tikzBlockdiagram.tex} eingebunden sein, sowie das Package \texttt{pgf-extrect}.
Um mit der Markrosammlung Strukturbilder zeichnen zu können, müssen die Dateien \texttt{tikz\-Base\-.tex} und \texttt{tikzBlockdiagram.tex} eingebunden sein, sowie das Package \texttt{pgf-extrect}.
\paragraph{Einstellungen der TIKZ Umgebung}
Einstellungen die sich für das Zeichen von Strukturbildern bewährt haben sind in
\begin{figure}
\begin{lstlisting}
\begin{lstlisting}[breaklines,breakatwhitespace,caption={TIKZ-Code für die Erstellung des Strukturbildes in Bild \ref{fig:blockschaltbild}.}]
Dies soll eine Sammlung von nützlichen code-Schnipseln werden.
\section{Feintuning}\label{sec:tuning}
In \LaTeX Dokumenten hat man ab und zu das Problem das sehr Große Abstände zwischen Absätzen oder unter Bildern entstehen. Dies kann oft schon durch Kleinigkeiten behoben werden. Der erste und einfachste Ansatz sollte sein, die Abmessungen des Bildes zu ändern. Oft kann man ein Bild ja ohne großen Einfluss etwas größer oder kleiner machen. Wenn man viele Gleichungen im Text hat, kann man versuchen schönere Seitenumbrüche zu ermöglichen in dem man mittels dem Befehl \lstinline|\allowdisplaybreaks| Zeilenumbrüche innerhalb von Gleichungen zulässt. Allerdings muss man hiernach aufpassen, dass die Gleichungen noch lesbar bleiben. Etwas komplizierter wird es dann schon mit dem Befehl \lstinline|\looseness=n|. Damit können die Eigenschaften des Blocksatzes verändert werden. Der nach diesem Befehl folgende Absatz wird um $n$ Zeilen verlängert oder wenn $n<0$ um $n$ Zeilen verkürzt. Dies ist natürlich nur innerhalb eines gewissen Rahmens möglich, mehr als eine Zeile lässt sich hiermit selten heraus holen. In Beispiel \ref{bspl:looseness} wird gezeigt wie sich diese Veränderung auf den Text auswirkt.
\begin{bsplFL}
\onehalfspacing
\begin{bspl}{Einfluss auf Zeilenanzahl eines Abschnitts}\label{bspl:looseness}
\minisec{looseness = 0}
\looseness=0
Dies hier ist ein Blindtext zum Testen von Textausgaben. Wer diesen Text
liest, ist selbst 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 Lesbarkeit einer Schrift, ihre Anmutung, wie harmonisch die
Figuren zueinander stehen und prüfe, wie 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.
\minisec{looseness = 1}
\looseness=1
Dies hier ist ein Blindtext zum Testen von Textausgaben. Wer diesen Text
liest, ist selbst 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 Lesbarkeit einer Schrift, ihre Anmutung, wie harmonisch die
Figuren zueinander stehen und prüfe, wie 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.
\end{bspl}
\end{bsplFL}
In \LaTeX Dokumenten hat man ab und zu das Problem das sehr Große Abstände zwischen Absätzen oder unter Bildern entstehen. Dies kann oft schon durch Kleinigkeiten behoben werden. Der erste und einfachste Ansatz sollte sein, die Abmessungen des Bildes zu ändern. Oft kann man ein Bild ja ohne großen Einfluss etwas größer oder kleiner machen. Wenn man viele Gleichungen im Text hat, kann man versuchen schönere Seitenumbrüche zu ermöglichen in dem man mittels dem Befehl \lstinline|\allowdisplaybreaks| Zeilenumbrüche innerhalb von Gleichungen zulässt. Allerdings muss man hiernach aufpassen, dass die Gleichungen noch lesbar bleiben. Etwas komplizierter wird es dann schon mit dem Befehl \lstinline|\looseness=n|. Damit können die Eigenschaften des Blocksatzes verändert werden. Der nach diesem Befehl folgende Absatz wird um $n$ Zeilen verlängert oder wenn $n<0$ um $n$ Zeilen verkürzt. Dies ist natürlich nur innerhalb eines gewissen Rahmens möglich, mehr als eine Zeile lässt sich hiermit selten heraus holen.
Falls dies nichts hilft, kann noch versucht werden durch die optionale Platzierung eines Fließumgebung deren Position im Text zu beeinflussen.
%\subsection{Einbinden von Plots}
...
...
@@ -46,7 +14,6 @@ Falls dies nichts hilft, kann noch versucht werden durch die optionale Platzieru
\newcommand{\entwurfsmarkierung}{\ifdraft{\textsl{Entwurf, Stand \today}}}
\cfoot[\entwurfsmarkierung]{\entwurfsmarkierung}
\KOMAoptions{paper=a4, fontsize=12pt}
\KOMAoptions{headsepline, footsepline, plainfootsepline}% Querlinien als Trennung zwischen Inhal und Kopf- und Fußzeile; Fußzeilenlinie auch bei Kapitelanfang (Seitenstil plain)
% (Seitenstil plain)
\setkomafont{pageheadfoot}{\scshape}% Kopf- und Fußzeile in Kapitälchen
\addtokomafont{sectioning}{\rmfamily}% alle Überschriften in Serif-Schrift
\addtokomafont{descriptionlabel}{\rmfamily}% Item-Description (\item[description]) in Serif-Schrift
\KOMAoptions{BCOR=18mm}% Bindekorrektur: wieviel wird innenliegende Rand einer halben Doppelseite durch die Bindung und das "Knicken" einer Seite kleiner?
% Satzspiegel - hingebastelt damit es ähnlich zur alten LRT Vorlage ist.
\KOMAoptions{footinclude=false}
\KOMAoptions{DIV=14}% Satzspiegel - DIV ist ein ganzzahliger "Frickelfaktor", je größer desto weniger Seitenrand. Das Verhältnis der Seitenränder zueinander folgt dann typographischen Vorgaben, man sollte es deshalb nicht antasten.
% TODO der Wert 14 kommt der alten Vorlage am nächsten, typographisch wäre ggf. ein größerer automatisch berechneter Rand DIV=calc sinnvoll.
\KOMAoptions{titlepage=firstiscover}% TODO
\KOMAoptions{parskip=half-}% TODO Absatzabstand... ungefähr der alten Vorlage nachgemacht
\KOMAoptions{numbers=noenddot}% keine Punkte nach Nummerierungen wie Kapitelüberschrifen oder Abbildungen (z.B. 1 Einleitung statt 1. Einleitung)
\KOMAoptions{%
paper=a4,
fontsize=12pt,
headsepline, % Querlinien als Trennung zwischen Inhalt und Kopfzeile
footsepline, % Querlinien als Trennung zwischen Inhalt und Fußzeile
plainfootsepline, % Fußzeilenlinie auch bei Kapitelanfang
footinclude=false,
DIV=14, % Satzspiegel - DIV ist ein ganzzahliger "Frickelfaktor", je größer desto weniger Seitenrand. Das Verhältnis der Seitenränder zueinander folgt dann typographischen Vorgaben, man sollte es deshalb nicht antasten.
% TODO der Wert 14 kommt der alten Vorlage am nächsten, typographisch wäre ggf. ein größerer automatisch berechneter Rand DIV=calc sinnvoll.
titlepage=firstiscover,
parskip=half-, % TODO Absatzabstand... ungefähr der alten Vorlage nachgemacht
numbers=noenddot, % keine Punkte nach Nummerierungen wie Kapitelüberschrifen oder Abbildungen (z.B. 1 Einleitung statt 1. Einleitung)
BCOR=18mm, % Bindekorrektur: wieviel wird innenliegende Rand einer halben Doppelseite durch die Bindung und das "Knicken" einer Seite kleiner?
}
% Seitennummerierung nach \frontmatter anpassen:
% Seitennummerierung anfangs alphabetisch, damit nicht das Deckblatt die gleiche Seitennummer hat wie eine spätere Inhaltsseite
