summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/tudscr/doc
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/tudscr/doc')
-rw-r--r--Master/texmf-dist/source/latex/tudscr/doc/examples/evaluation.tex8
-rw-r--r--Master/texmf-dist/source/latex/tudscr/doc/examples/mathswap-example.tex8
-rw-r--r--Master/texmf-dist/source/latex/tudscr/doc/examples/notice.tex19
-rw-r--r--Master/texmf-dist/source/latex/tudscr/doc/examples/poster.tex45
-rw-r--r--Master/texmf-dist/source/latex/tudscr/doc/examples/task.tex21
-rw-r--r--Master/texmf-dist/source/latex/tudscr/doc/examples/thesis.tex16
-rw-r--r--Master/texmf-dist/source/latex/tudscr/doc/examples/treatise-example.tex135
-rw-r--r--Master/texmf-dist/source/latex/tudscr/doc/tudscr-additional.tex35
-rw-r--r--Master/texmf-dist/source/latex/tudscr/doc/tudscr-bundle.tex739
-rw-r--r--Master/texmf-dist/source/latex/tudscr/doc/tudscr-examples.tex94
-rw-r--r--Master/texmf-dist/source/latex/tudscr/doc/tudscr-hints.tex682
-rw-r--r--Master/texmf-dist/source/latex/tudscr/doc/tudscr-index.tex114
-rw-r--r--Master/texmf-dist/source/latex/tudscr/doc/tudscr-installation.tex164
-rw-r--r--Master/texmf-dist/source/latex/tudscr/doc/tudscr-introduction.tex253
-rw-r--r--Master/texmf-dist/source/latex/tudscr/doc/tudscr-mainclasses.tex3416
-rw-r--r--Master/texmf-dist/source/latex/tudscr/doc/tudscr-obsolete.tex1008
-rw-r--r--Master/texmf-dist/source/latex/tudscr/doc/tudscr-packages.tex879
-rw-r--r--Master/texmf-dist/source/latex/tudscr/doc/tudscr-poster.tex395
-rw-r--r--Master/texmf-dist/source/latex/tudscr/doc/tudscr-preface.tex24
-rw-r--r--Master/texmf-dist/source/latex/tudscr/doc/tudscr-supervisor.tex421
-rw-r--r--Master/texmf-dist/source/latex/tudscr/doc/tudscr.tex63
-rw-r--r--Master/texmf-dist/source/latex/tudscr/doc/tutorials/mathswap.tex49
-rw-r--r--Master/texmf-dist/source/latex/tudscr/doc/tutorials/mathtype.tex53
-rw-r--r--Master/texmf-dist/source/latex/tudscr/doc/tutorials/treatise.tex2063
24 files changed, 6368 insertions, 4336 deletions
diff --git a/Master/texmf-dist/source/latex/tudscr/doc/examples/evaluation.tex b/Master/texmf-dist/source/latex/tudscr/doc/examples/evaluation.tex
index c4137a4251a..c70743c9029 100644
--- a/Master/texmf-dist/source/latex/tudscr/doc/examples/evaluation.tex
+++ b/Master/texmf-dist/source/latex/tudscr/doc/examples/evaluation.tex
@@ -9,7 +9,7 @@
\begin{document}
\faculty{Juristische Fakultät}\department{Fachrichtung Strafrecht}
\institute{Institut für Kriminologie}\chair{Lehrstuhl für Kriminalprognose}
-\date{18.02.2015}
+\date{16.10.2015}
\author{Mickey Mouse}
\title{%
Entwicklung eines optimalen Verfahrens zur Eroberung des
@@ -24,9 +24,9 @@
\referee{Dagobert Duck}
\evaluationform[pagestyle=empty]{%
Als Ziel dieser Arbeit sollte identifiziert werden, warum das Thema
- gerade so omnipräsent ist und wie man diesen Effekt abschwächen
- könnte. Zusätzlich sollten Methoden entwickelt werden, wie sich ein
- ähnlicher Vorgang zukünftig vermeiden ließe.
+ gerade so omnipräsent ist und wie sich dieser Effekt abschwächen
+ ließe. Zusätzlich waren Methoden zu entwickeln, mit denen ein
+ ähnlicher Vorgang zukünftig vermieden werden könnte.
}{%
Die Arbeitet gliedert sich in mehrere Kapitel auf unzähligen Seiten. Im den
ersten beiden Kapiteln wird dies und das besprochen. Im darauffolgenden auch
diff --git a/Master/texmf-dist/source/latex/tudscr/doc/examples/mathswap-example.tex b/Master/texmf-dist/source/latex/tudscr/doc/examples/mathswap-example.tex
index 5120b3e45ee..1b064b73e11 100644
--- a/Master/texmf-dist/source/latex/tudscr/doc/examples/mathswap-example.tex
+++ b/Master/texmf-dist/source/latex/tudscr/doc/examples/mathswap-example.tex
@@ -22,13 +22,13 @@
\(4,523.58\)
\endgroup
-\begingroup%
+\begingroup
\selectlanguage{english}%
- \(4,523.58\)\par
- \(4.523,58\)\par
+ \(4,523.58\)\\
+ \(4.523,58\)\\
\commaswap{.}
\dotswap{\,}
- \(4.523,58\)%
+ \(4.523,58\)
\endgroup
\end{document}
diff --git a/Master/texmf-dist/source/latex/tudscr/doc/examples/notice.tex b/Master/texmf-dist/source/latex/tudscr/doc/examples/notice.tex
index c7cd3028bc4..954eca71f78 100644
--- a/Master/texmf-dist/source/latex/tudscr/doc/examples/notice.tex
+++ b/Master/texmf-dist/source/latex/tudscr/doc/examples/notice.tex
@@ -9,7 +9,7 @@
\begin{document}
\faculty{Juristische Fakultät}\department{Fachrichtung Strafrecht}
\institute{Institut für Kriminologie}\chair{Lehrstuhl für Kriminalprognose}
-\date{18.02.2015}
+\date{16.10.2015}
\title{%
Entwicklung eines optimalen Verfahrens zur Eroberung des
Geldspeichers in Entenhausen
@@ -22,15 +22,16 @@
\emailaddress{mac.moneysac@tu-dresden.de}\telephone{+49 351 463-54321}
}
\noticeform[Angebot für eine Studien-/Diplomarbeit,pagestyle=empty]{%
- Momentan ist das besagte Thema in aller Munde. Insbesondere wird es gerade
- in vielen~-- wenn nicht sogar in allen~-- Medien diskutiert. Es ist momentan
- nicht abzusehen, ob und wann sich diese Situation ändert. Eine kurzfristige
- Verlagerung aus dem Fokus der Öffentlichkeit wird nicht erwartet.
+ Momentan ist das besagte Thema in aller Munde. Insbesondere wird es
+ gerade in vielen~-- wenn nicht sogar in allen~-- Medien diskutiert.
+ Es ist momentan noch nicht abzusehen, ob und wann sich diese Situation
+ ändert. Eine kurzfristige Verlagerung aus dem Fokus der Öffentlichkeit
+ wird nicht erwartet.
- Als Ziel dieser Arbeit soll identifiziert werden, warum das Thema gerade so
- omnipräsent ist und wie man diesen Effekt abschwächen könnte. Zusätzlich
- sollen Methoden entwickelt werden, wie sich ein ähnlicher Vorgang zukünftig
- vermeiden ließe.
+ Als Ziel dieser Arbeit soll identifiziert werden, warum das Thema
+ gerade so omnipräsent ist und wie dieser Effekt abgeschwächt werden
+ könnte. Zusätzlich sind Methoden zu entwickeln, mit denen sich ein
+ ähnlicher Vorgang zukünftig vermeiden lässt.
\begin{center}
\medskip\includegraphics[width=.7\linewidth]{DDC-21}
\renewcommand*{\figureformat}{\figurename}
diff --git a/Master/texmf-dist/source/latex/tudscr/doc/examples/poster.tex b/Master/texmf-dist/source/latex/tudscr/doc/examples/poster.tex
new file mode 100644
index 00000000000..33ddd7ddc81
--- /dev/null
+++ b/Master/texmf-dist/source/latex/tudscr/doc/examples/poster.tex
@@ -0,0 +1,45 @@
+\RequirePackage[ngerman=ngerman-x-latest]{hyphsubst}
+\RequirePackage{fix-cm}
+\documentclass[ngerman,paper=A1,fontsize=22pt,cdfoot=5ex,ddcfoot]{tudscrposter}
+\usepackage{selinput}\SelectInputMappings{adieresis={ä},germandbls={ß}}
+\usepackage[T1]{fontenc}
+\usepackage{babel}
+\usepackage{blindtext}
+\usepackage{multicol}
+\begin{document}
+\faculty{Juristische Fakultät}
+\department[]{Fachrichtung Strafrecht}
+\institute{Institut für Kriminologie}
+\chair[]{Lehrstuhl für Kriminalprognose}
+\date{18.02.2015}
+\title{%
+ Entwicklung eines optimalen Verfahrens zur Eroberung des
+ Geldspeichers in Entenhausen
+}
+\contactperson{%
+ Mickey Mouse%
+ \office{Büro 58}%
+ \telephone{463--xxxxx}%
+ \emailaddress{mickey.mouse@tu-dresden.de}%
+}
+\professor{Prof. Dr. Kater Karlo}
+\maketitle
+\begin{abstract}%[columns=2]
+\noindent\blindtext
+\end{abstract}
+
+\begin{multicols}{2}[\section*{Test}]
+\blindtext[3]
+\end{multicols}
+\bigskip
+
+\begin{center}
+\includegraphics[width=.7\linewidth]{TUD-black}
+\end{center}
+
+\begin{multicols}{2}[\section*{Test}]
+\blindmathtrue
+\blindtext[1]
+\end{multicols}
+
+\end{document}
diff --git a/Master/texmf-dist/source/latex/tudscr/doc/examples/task.tex b/Master/texmf-dist/source/latex/tudscr/doc/examples/task.tex
index d9e688ede34..2ac847e63e3 100644
--- a/Master/texmf-dist/source/latex/tudscr/doc/examples/task.tex
+++ b/Master/texmf-dist/source/latex/tudscr/doc/examples/task.tex
@@ -15,27 +15,28 @@
}
\thesis{master}\graduation[M.Sc.]{Master of Science}
\author{%
- Mickey Mouse\matriculationnumber{12345678}
- \dateofbirth{2.1.1990}\placeofbirth{Dresden}
- \course{Klinische Prognostik}\discipline{Individualprognose}
+ Mickey Mouse\matriculationnumber{12345678}%
+ \dateofbirth{2.1.1990}\placeofbirth{Dresden}%
+ \course{Klinische Prognostik}\discipline{Individualprognose}%
\and%
- Donald Duck\matriculationnumber{87654321}
- \dateofbirth{1.2.1990}\placeofbirth{Berlin}
- \course{Statistische Prognostik}\discipline{Makrosoziologische Prognosen}
+ Donald Duck\matriculationnumber{87654321}%
+ \dateofbirth{1.2.1990}\placeofbirth{Berlin}%
+ \course{Statistische Prognostik}\discipline{Makrosoziologische Prognosen}%
}\matriculationyear{2010}\issuedate{1.4.2015}\duedate{1.10.2015}
\supervisor{Dagobert Duck \and Mac Moneysac}
+\referee{Prof. Dr. Kater Karlo}
\professor{Prof. Dr. Kater Karlo}\chairman{Prof. Dr. Primus von Quack}
\taskform[pagestyle=empty]{%
Momentan ist das besagte Thema in aller Munde. Insbesondere wird es
gerade in vielen~-- wenn nicht sogar in allen~-- Medien diskutiert.
- Es ist momentan noch nicht abzusehen, ob und wann sich diese Situation
+ Es ist momentan noch nicht abzusehen, ob und wann sich diese Situation
ändert. Eine kurzfristige Verlagerung aus dem Fokus der Öffentlichkeit
wird nicht erwartet.
Als Ziel dieser Arbeit soll identifiziert werden, warum das Thema
- gerade so omnipräsent ist und wie man diesen Effekt abschwächen
- könnte. Zusätzlich sollen Methoden entwickelt werden, wie sich ein
- ähnlicher Vorgang zukünftig vermeiden ließe.
+ gerade so omnipräsent ist und wie dieser Effekt abgeschwächt werden
+ könnte. Zusätzlich sind Methoden zu entwickeln, mit denen sich ein
+ ähnlicher Vorgang zukünftig vermeiden lässt.
}{%
\item Recherche
\item Analyse
diff --git a/Master/texmf-dist/source/latex/tudscr/doc/examples/thesis.tex b/Master/texmf-dist/source/latex/tudscr/doc/examples/thesis.tex
index 7099e9669cb..c59eb63f2b4 100644
--- a/Master/texmf-dist/source/latex/tudscr/doc/examples/thesis.tex
+++ b/Master/texmf-dist/source/latex/tudscr/doc/examples/thesis.tex
@@ -17,15 +17,15 @@
\subject{master}
\graduation[M.Sc.]{Master of Science}
\author{%
- Mickey Mouse
- \matriculationnumber{12345678}
- \dateofbirth{2.1.1990}
- \placeofbirth{Dresden}
+ Mickey Mouse%
+ \matriculationnumber{12345678}%
+ \dateofbirth{2.1.1990}%
+ \placeofbirth{Dresden}%
\and%
- Donald Duck
- \matriculationnumber{87654321}
- \dateofbirth{1.2.1990}
- \placeofbirth{Berlin}
+ Donald Duck%
+ \matriculationnumber{87654321}%
+ \dateofbirth{1.2.1990}%
+ \placeofbirth{Berlin}%
}
\matriculationyear{2010}
\supervisor{Dagobert Duck \and Mac Moneysac}
diff --git a/Master/texmf-dist/source/latex/tudscr/doc/examples/treatise-example.tex b/Master/texmf-dist/source/latex/tudscr/doc/examples/treatise-example.tex
index 56e18adc611..ee552b76ef6 100644
--- a/Master/texmf-dist/source/latex/tudscr/doc/examples/treatise-example.tex
+++ b/Master/texmf-dist/source/latex/tudscr/doc/examples/treatise-example.tex
@@ -1,27 +1,28 @@
\RequirePackage[ngerman=ngerman-x-latest]{hyphsubst}
\documentclass[english,ngerman]{tudscrreprt}
\usepackage{babel}
-\usepackage{selinput}
-\SelectInputMappings{adieresis={ä},germandbls={ß}}
+\usepackage{selinput}\SelectInputMappings{adieresis={ä},germandbls={ß}}
\usepackage[T1]{fontenc}
\usepackage{scrhack}
\usepackage{tudscrsupervisor}
\AfterPackage*{hyperref}{%
\usepackage[%
- automake,%
-% mit Tex Live einfach verwendbar
-% xindy,
acronym,% Abkürzungen
symbols,% Formelzeichen
nomain,% kein Glossar
- translate=babel,%
nogroupskip,%
toc,%
section=chapter,%
+ nostyles,%
+ translate=babel,%
+% mit Tex Live einfach verwendbar
+ xindy={language=german-din},
]{glossaries}
\makeglossaries
+}% Ende von AfterPackage
+\AfterPackage*{glossaries}{%
\newglossarystyle{acrotabu}{%
\renewenvironment{theglossary}{%
\begin{tabu}spread 0pt{@{}lX<{\strut}l@{}}%
@@ -42,8 +43,8 @@
\newcommand*{\newsymbol}[5][]{%
\newglossaryentry{#2}{%
type=symbols,%
- description={},%
name={#3},%
+ description={\nopostdesc},%
symbol={\ensuremath{#4}},%
user1={\ensuremath{\mathrm{#5}}},%
sort={#2},%
@@ -64,15 +65,15 @@
}{%
\end{longtabu}%
}%
+ \renewcommand*{\glsgroupheading}[1]{}%
+ \renewcommand*{\glsgroupskip}{}%
\renewcommand*{\glossaryheader}{%
\toprule
- \bfseries Symbol & \bfseries Einheit &
- \bfseries Name & \bfseries Seite(n)
+ \bfseries Formelzeichen & \bfseries Einheit &
+ \bfseries Bezeichnung & \bfseries Seite(n)
\tabularnewline\midrule\endhead%
\bottomrule\endfoot%
}%
- \renewcommand*{\glsgroupheading}[1]{}%
- \renewcommand*{\glsgroupskip}{}%
\renewcommand*{\glossentry}[2]{%
\glsentryitem{##1}% Entry number if required
\glstarget{##1}{\glossentrysymbol{##1}} &
@@ -81,7 +82,7 @@
##2\tabularnewline%
}%
}
-}% Ende von AfterPackage*
+}% Ende von AfterPackage
\usepackage{csquotes}
\usepackage[backend=biber,style=alphabetic]{biblatex}
@@ -109,9 +110,8 @@
}
@manual{hanisch14,
author = {Hanisch, Falk},
- title = {Ein \LaTeX"=Bundle für Dokumente
- im neuen Corporate Design
- der Technischen Universität Dresden},
+ title = {Ein \LaTeX"=Bundle für Dokumente im neuen Corporate
+ Design der Technischen Universität Dresden},
date = {2014},
subtitle = {Benutzerhandbuch},
location = {Dresden},
@@ -135,6 +135,7 @@
\usepackage{tabularx}
\usepackage{tabulary}
\usepackage{tabu}
+\usepackage{longtable}
\usepackage{quoting}
@@ -165,29 +166,28 @@
\thesis{master}
\graduation[M.Sc.]{Master of Science}
\author{%
- Mickey Mouse
- \matriculationnumber{12345678}
- \dateofbirth{2.1.1990}
- \placeofbirth{Dresden}
- \course{Klinische Prognostik}
- \discipline{Individualprognose}
+ Mickey Mouse%
+ \matriculationnumber{12345678}%
+ \dateofbirth{2.1.1990}%
+ \placeofbirth{Dresden}%
+ \course{Klinische Prognostik}%
+ \discipline{Individualprognose}%
\and%
- Donald Duck
- \matriculationnumber{87654321}
- \dateofbirth{1.2.1990}
- \placeofbirth{Berlin}
- \course{Statistische Prognostik}
- \discipline{Makrosoziologische Prognosen}
+ Donald Duck%
+ \matriculationnumber{87654321}%
+ \dateofbirth{1.2.1990}%
+ \placeofbirth{Berlin}%
+ \course{Statistische Prognostik}%
+ \discipline{Makrosoziologische Prognosen}%
}
\matriculationyear{2010}
\supervisor{Dagobert Duck \and Mac Moneysac}
\professor{Prof. Dr. Kater Karlo}
\date{10.09.2014}
-
\makecover
\maketitle
-\newcommand\taskcontent{%
+\newcommand{\taskcontent}{%
Momentan ist das besagte Thema in aller Munde. Insbesondere wird es
gerade in vielen~-- wenn nicht sogar in allen~-- Medien diskutiert.
Es ist momentan noch nicht abzusehen, ob und wann sich diese Situation
@@ -195,9 +195,9 @@
wird nicht erwartet.
Als Ziel dieser Arbeit soll identifiziert werden, warum das Thema
- gerade so omnipräsent ist und wie man diesen Effekt abschwächen
- könnte. Zusätzlich sollen Methoden entwickelt werden, wie sich ein
- ähnlicher Vorgang zukünftig vermeiden ließe.
+ gerade so omnipräsent ist und wie dieser Effekt abgeschwächt werden
+ könnte. Zusätzlich sind Methoden zu entwickeln, mit denen sich ein
+ ähnlicher Vorgang zukünftig vermeiden lässt.
}
\taskform[pagestyle=empty]{\taskcontent}{%
\item Recherche
@@ -227,7 +227,7 @@
\printsymbols[style=symblongtabu]
\setchapterpreamble{%
- \renewcommand*\dictumwidth{.4\textwidth}%
+ \renewcommand*{\dictumwidth}{.4\textwidth}%
\dictum[Johann Wolfgang von Goethe]{%
Es irrt der Mensch, solang er strebt.%
}%
@@ -266,7 +266,7 @@ Punktmasse lautet:
\[\gls{F} = \gls{m} \cdot \gls{a}\]
\section{Referenzen und das Literaturverzeichnis}
-Das Literaturverzeichnis wir auf Basis der nachfolgend verwendeten
+Das Literaturverzeichnis wird auf Basis der nachfolgend verwendeten
Zitate erstellt und ist auf Seite~\pageref{sec:bibliography} zu finden.
In diesem Textabschnitt werden die zwei bekannten \LaTeX-Bücher
\cite{knuth84} und \cite{goossens94} sowie das Anwenderhandbuch
@@ -278,7 +278,7 @@ Grafiken als auch Tabellen verwendet werden sollten. Im vorliegenden
Beispiel kann unter Umständen der Eindruck entstehen, dass diese Seite
etwas zu überladen mit Gleitobjekten ist. Dies liegt nicht an der
Verwendung der Gleitobjekte sondern vielmehr am zu geringen Textvolumen
-und den eingeschränkten Möglichkeiten von \LaTeX{}, diese an geigneten
+und den eingeschränkten Möglichkeiten von \LaTeX{}, diese an geeigneten
Stellen zu platzieren.
\subsection{Abbildungen als Gleitobjekte und das Einbinden von Grafiken}
@@ -286,11 +286,11 @@ In \autoref{fig:example} wird dargestellt, wie eine Grafik im PDF-Format
in ein Dokument eingebunden und auf diese verwiesen werden kann. Ein
Querverweis auf ein Gleitobjekt sollte im Fließtext am besten mit Befehl
\texttt{\textbackslash autoref\{\emph{<Label>}\}} erstellt werden.
-Hierfür ist ein entsprechender Anker am zu referenziereden Objekt nötig,
+Hierfür ist ein entsprechender Anker am zu referenzierenden Objekt nötig,
welcher mit dem Makro \texttt{\textbackslash label} erzeugt wird. Dabei
ist entscheidend, dass dieser Anker erst \emph{nach} der Beschriftung des
-Objektes, welche mit \texttt{\textbackslash caption} erstellt wird,
-gesetzt wird.
+Objektes, welche mit \texttt{\textbackslash caption} zu erstellen ist,
+definiert werden sollte.
\begin{figure}
\centering
@@ -320,7 +320,7 @@ sowohl auf \autoref{fig:logos} als auch auf \autoref{fig:tud} sowie
\subsection{Tabellen als Gleitobjekte}
Tabellen sollten in der \texttt{table}"=Gleitumgebung gesetzt werden.
-Welche Umgebung für die Tabelle selbst dabie genutzt wird ist dabei
+Welche Umgebung für die Tabelle selbst dabei genutzt wird ist dabei
nicht relevant. Es können sowohl die normale \texttt{tabular}"=Umgebung
als auch die Umgebungen \texttt{tabularx}, \texttt{tabulary} sowie
\texttt{tabu} für variable Spaltenbreiten bei einer fest vorgegebenen
@@ -328,7 +328,7 @@ Tabellenbreite oder jede andere Tabellenumgebung genutzt werden.
Nachfolgend wird dies an mehreren Beispielen demonstriert.
\subsubsection{Eine gleitende tabularx-Tabelle}
-Es wird eine Tabelle mithilfe der \texttt{tabularx}-Umgebung erstellt.
+Es wird eine Tabelle mithilfe der \texttt{tabularx}"=Umgebung erstellt.
Zu sehen ist diese in \autoref{tab:tabularx}. Für diese werden zuvor
neue Spaltentypen definiert.
@@ -350,28 +350,26 @@ Ein längerer Blindtext im Blocksatz zur besseren Demonstration
einer Y"~Spalte\tabularnewline
\bottomrule
\end{tabularx}
-\caption{Eine \texttt{tabularx}-Tabelle}\label{tab:tabularx}
+\caption{Eine \texttt{tabularx}"=Tabelle}\label{tab:tabularx}
\end{table}
\subsubsection{Eine gleitende tabulary-Tabelle}
-Es wird eine Tabelle mithilfe der \texttt{tabulary}-Umgebung erstellt.
+Es wird eine Tabelle mithilfe der \texttt{tabulary}"=Umgebung erstellt.
Zu sehen ist diese in \autoref{tab:tabulary}.
\begin{table}
\begin{tabulary}{\textwidth}{@{}LCRJ@{}}
\toprule
\textbf{Linksbündig} & \textbf{Zentriert} &
-\textbf{Rechtsbündig} & \textbf{Blocksatz} \tabularnewline
-\midrule
+\textbf{Rechtsbündig} & \textbf{Blocksatz} \tabularnewline\midrule
Ein linksbündiger Blindtext zur Demonstration einer L"~Spalte &
Ein zentrierter Blindtext zur Demonstration einer C"~Spalte &
Ein rechtsbündiger Blindtext zur Demonstration einer R"~Spalte &
Ein wesentlich längerer und absolut inhaltsleerer Blindtext im
Blocksatz für eine um einiges bessere Demonstration einer J"~Spalte
-\tabularnewline
-\bottomrule
+\tabularnewline\bottomrule
\end{tabulary}
-\caption{Eine \texttt{tabulary}-Tabelle}\label{tab:tabulary}
+\caption{Eine \texttt{tabulary}"=Tabelle}\label{tab:tabulary}
\end{table}
\subsubsection{Eine gleitende tabu-Tabelle}
@@ -384,31 +382,30 @@ die Beschriftung auf die Breite der Tabelle begrenzt.
\makeatletter
\newcolumntype{Z}{}
-\renewcommand*\NC@rewrite@Z[1][]{%
+\renewcommand*{\NC@rewrite@Z}[1][]{%
\NC@find>{\hspace{0pt}}X[#1]<{\@finalstrut\@arstrutbox}%
}
\makeatother
\begin{table}
\ttabbox{%
-\begin{tabu} to .8\textwidth {@{}Z[3,l]Z[3,c]Z[3,r]Z[2,j]@{}}
- \toprule
- \textbf{Linksbündig} & \textbf{Zentriert} &
- \textbf{Rechtsbündig} & \textbf{Blocksatz} \tabularnewline
- \midrule
- Ein linksbündiger Blindtext zur Demonstration einer Z[l]"~Spalte &
- Ein zentrierter Blindtext zur Demonstration einer Z[c]"~Spalte &
- Ein rechtsbündiger Blindtext zur Demonstration einer Z[r]"~Spalte &
- Ein Blindtext im Blocksatz innerhalb einer Z"~Spalte
- \tabularnewline
- \bottomrule
+ \begin{tabu} to .8\textwidth {@{}Z[3,l]Z[3,c]Z[3,r]Z[2,j]@{}}
+ \toprule
+ \textbf{Linksbündig} & \textbf{Zentriert} &
+ \textbf{Rechtsbündig} & \textbf{Blocksatz} \tabularnewline\midrule
+ Ein linksbündiger Blindtext zur Demonstration einer Z[l]"~Spalte &
+ Ein zentrierter Blindtext zur Demonstration einer Z[c]"~Spalte &
+ Ein rechtsbündiger Blindtext zur Demonstration einer Z[r]"~Spalte &
+ Ein Blindtext im Blocksatz innerhalb einer Z"~Spalte
+ \tabularnewline\bottomrule
\end{tabu}%
}{%
- \caption[Eine \texttt{tabu}-Tabelle]{%
- Eine \texttt{tabu}-Tabelle in Verbindung mit dem Befehl
+ \caption[Eine \texttt{tabu}"=Tabelle]{%
+ Eine \texttt{tabu}"=Tabelle in Verbindung mit dem Befehl
\texttt{\textbackslash ttabbox}, welcher vom Paket \texttt{floatrow}
für Beschriftungen in Objektbreite bereitgestellt wird%
- }\label{tab:tabu}%
+ }%
+ \label{tab:tabu}%
}
\end{table}
@@ -418,7 +415,7 @@ gekennzeichnet werden.
\enquote{Dies ist ein zugegebenermaßen nicht sehr sinnvolles Zitat.}
\cite[58]{hanisch14}
Für eine möglichst gut nachvollziehbare Referenz sollte nicht nur
-das Werk selber sondern zumindest die Seitenzahl und gegebenfalls
+das Werk selber sondern zumindest die Seitenzahl und gegebenenfalls
der Absatz der originalen Textstelle angegeben werden.
\begin{quoting}
\enquote{%
@@ -426,17 +423,17 @@ der Absatz der originalen Textstelle angegeben werden.
Wirkung der Umgebung \texttt{quoting} bei der Absatzauszeichnung
deutlich.
- Wie man sieht, ist der zweite Absatz~-- wie jeder weitere~-- aufgrund
- der Einstellung \texttt{parskip=false} eingezogen.
+ Wie zu sehen ist, wird der zweite Absatz~-- wie jeder weitere~--
+ aufgrund der Option \texttt{parskip=false} eingezogen.
}
\cite[sinngemäß nach][\pno{} 12, zweiter Absatz]{hanisch14}
\end{quoting}
Ebenfalls sollten sinngemäße Zitate mit einer möglichst genauen Referenz
-angegeben werden. Dies kann im Laufe der Arbeit acuh für einen selbst von
-Vorteil sein, wenn man beispielsweise die originale Textpassage noch
-einmal analysieren möchte.
+angegeben werden. Dies kann im Laufe der Arbeit auch für einen selbst von
+Vorteil sein, wenn beispielsweise die originale Textpassage noch einmal
+analysiert werden soll.
-\printbibliography[heading=bibintoc]\label{sec:bibliography}
+\printbibliography[heading=bibintoc]\label{sec:bibliography}%
\end{document}
diff --git a/Master/texmf-dist/source/latex/tudscr/doc/tudscr-additional.tex b/Master/texmf-dist/source/latex/tudscr/doc/tudscr-additional.tex
index 7dd02ec71a3..67d05b73534 100644
--- a/Master/texmf-dist/source/latex/tudscr/doc/tudscr-additional.tex
+++ b/Master/texmf-dist/source/latex/tudscr/doc/tudscr-additional.tex
@@ -5,7 +5,7 @@ Pakete. Ein Teil dieser Pakete~-- genauer \Package{tudscrsupervisor} und
andere wiederum~-- die beiden Pakete für Belange des \CDs \Package{tudscrfonts}
(Schriften) und \Package{tudscrcolor} (Farben) sowie die davon vollkommen
unabhängigen Pakete \Package{mathswap} und \Package{twocolfix}~-- können mit
-allen existierenden \hologo{LaTeXe}-Dokumentklassen genutzt werden. Sämtliche
+allen existierenden \hologo{LaTeXe}"=Dokumentklassen genutzt werden. Sämtliche
Klassen und Pakete aus dem \TUDScript-Bundle enthalten Befehle, welche diese
als Bestandteil identifizieren.
@@ -18,7 +18,20 @@ Teils. Dieser Befehl wird von allen Klassen und Paketen des \TUDScript-Bundles
mit \Macro*{DeclareRobustCommand}.
\end{Declaration}
-\begin{Declaration}[v2.04]{\Macro{TUDVersion}}
+\begin{Declaration}[v2.04]{\Macro{TUDScriptClassName}}
+\printdeclarationlist%
+%
+Die Bezeichnung der im Dokument verwendeten \TUDScript-Klasse ist im Makro
+\Macro{TUDScriptClassName} abgelegt. Soll also in Erfahrung gebracht werden,
+ob~-- und wenn ja, welche~-- \TUDScript-Klasse verwendet wird, so kann einfach
+auf diese Anweisung getestet werden. \KOMAScript{} stellt zusätzlich noch die
+beiden Anweisungen \Macro*{KOMAClassName} und \Macro*{ClassName} bereit, welche
+den Namen der zugrundeliegenden \KOMAScript-Klasse sowie die durch diese
+ersetzte Standardklasse enthalten.
+\end{Declaration}
+
+\begin{Declaration}[v2.04]{\Macro{TUDScriptVersion}}
+\begin{Declaration}[v2.05]{\Macro{TUDScriptVersionNumber}}
\printdeclarationlist%
%
In dieser Anweisung ist die Hauptversion von \TUDScript in der Form
@@ -27,17 +40,13 @@ In dieser Anweisung ist die Hauptversion von \TUDScript in der Form
\end{quoting}
abgelegt. Diese Version ist im \TUDScript-Bundle für alle Klassen und Pakete
gleich und kann daher nach dem Laden einer Klasse oder eines Paketes abgefragt
-werden. Diese Anleitung wurde beispielsweise mit \enquote{\TUDVersion{}}
+werden. Diese Anleitung wurde beispielsweise mit \enquote{\TUDScriptVersion{}}
erstellt.
-\end{Declaration}
-\begin{Declaration}[v2.04]{\Macro{TUDClassName}}
-\printdeclarationlist%
-%
-In \Macro{TUDClassName} ist der Name der aktuell verwendeten \TUDScript-Klasse
-abgelegt. Will man also wissen, ob eine oder welche \TUDScript-Klasse verwendet
-wird, so kann man einfach auf diese Anweisung testen. Von \KOMAScript{} werden
-zusätzlich noch die Anweisungen \Macro*{KOMAClassName} und \Macro*{ClassName}
-definiert, welche den Namen der zugrundeliegenden \KOMAScript-Klasse sowie die
-durch diese ersetzte Standardklasse enthalten.
+Eventuell will der Anwender auf die aktuell verwendete Version von \TUDScript
+prüfen, um gegebenenfalls eigene Anpassungen in Abhängigkeit der verwendeten
+Version vorzunehmen. Hierfür kann \Macro{TUDScriptVersionNumber} verwendet
+werden. Darin ist alleinig die Versionsnummer enthalten. Die für das Handbuch
+verwendete Version lautet \enquote{\TUDScriptVersionNumber{}} .
+\end{Declaration}
\end{Declaration}
diff --git a/Master/texmf-dist/source/latex/tudscr/doc/tudscr-bundle.tex b/Master/texmf-dist/source/latex/tudscr/doc/tudscr-bundle.tex
index 655c2a37c7a..97a409b8ebc 100644
--- a/Master/texmf-dist/source/latex/tudscr/doc/tudscr-bundle.tex
+++ b/Master/texmf-dist/source/latex/tudscr/doc/tudscr-bundle.tex
@@ -1,418 +1,20 @@
\setchapterpreamble{%
\begin{abstract}
- Zusätzlich zu den eigentlichen Hauptklassen werden im \TUDScript-Bundle
- weitere Paket bereitgestellt. Diese werden im Folgenden vorgestellt.%
+ Zusätzlich zu den bisher im Anwenderhandbuch vorgestellten Klassen und
+ Paketen werden im \TUDScript-Bundle weitere Paket bereitgestellt. Diese
+ sind nicht zwingend an die Verwendung einer der \TUDScript-Klassen
+ angewiesen sondern können prinzipiell mit jeder \hologo{LaTeXe}"=Klasse
+ genutzt werden.%
\end{abstract}
}
\chapter{Zusätzliche Pakete im \TUDScript-Bundle}
-\label{sec:bundle}
-\section{Das Paket \Package*{tudscrsupervisor} -- Studentische Betreuung}
-\begin{Declaration*}{\Package{tudscrsupervisor}}
-Dieses Paket stellt für das Erstellen von Aufgabenstellungen und Gutachten
-wissenschaftlicher Arbeiten sowie offiziellen Aushängen im \CD passende
-Umgebungen und Befehle für den Anwender bereit. Deshalb richtet es sich
-vornehmlich an Mitarbeiter an der \TnUD, kann jedoch natürlich auch von
-Studenten genutzt werden.
-
-
-\subsection{Aufgabenstellung für eine wissenschaftliche Arbeit}
-\begin{Declaration}{\Environment{task}[\OLParameter{Überschrift}]}{%
- \Environment{tudpage}'auto'%
-}
-\begin{Declaration}{\Key{\Environment{task}}{headline}[\PName{Überschrift}]}
-\printdeclarationlist%
-\index{Aufgabenstellung|!(}%
-%
-Mit der \Environment{task}"=Umgebung kann ein Aufgabenstellung für eine
-wissenschaftliche Arbeit ausgegeben werden. Diese basiert auf der Umgebung
-\Environment{tudpage} und akzeptiert deshalb im optionalen Argument alle
-Parameter, welche bei der Beschreibung von \Environment{tudpage}'full'
-erläutert wurden.
-
-Für die Aufgabenstellung wird normalerweise eine Überschrift gesetzt, welche
-sich aus \Term{taskname} und~-- falls der Typ der Abschlussarbeit angegeben
-wurde~-- noch aus \Term{tasktext} und \Macro{thesis} zusammensetzt. Der
-Parameter \Key{\Environment{task}}{headline} kann genutzt werden, um diese
-automatisch generierte Überschrift anzupassen.
-
-Zu Beginn der Aufgabenstellung erscheint eine Tabelle mit den angegebenen
-Informationen zum Autor respektive zu den Autoren der Abschlussarbeit. Zwingend
-anzugeben sind dafür lediglich der Name des oder der Verfasser (\Macro{author})
-sowie der Titel der Arbeit (\Macro{title}), welcher am Ende der Tabelle in
-fetter Schrift aufgeführt wird. Optional werden noch die Felder für den
-Studiengang (\Macro{course}), die Fachrichtung (\Macro{discipline}) sowie die
-Matrikelnummer (\Macro{matriculationnumber}) und das Immatrikulationsjahr
-(\Macro{matriculationyear}) ausgegeben, wobei nicht angegebene Felder bei der
-Ausgabe ignoriert werden. Der eigentliche Inhalt der Umgebung~-- sprich die
-Aufgabenstellung selbst~-- wird nach dem generierten Kopf ausgegeben
-
-Nach der Ausgabe des Inhaltes der Aufgabenstellung werden der oder die mit
-\Macro{supervisor} definierten Betreuer aufgelistet. Dabei wird unter dem
-jeweiligen Namen selbst der sprachabhängige Bezeichner (\Term{supervisorname},
-\Term{supervisorothername}) gesetzt. Darauf folgend erscheint das Ausgabedatum
-(\Macro{issuedate}) und der verpflichtende Abgabetermin (\Macro{duedate}). Zum
-Schluss wird die Unterschriftzeile für den Prüfungsausschussvorsitzenden
-(\Macro{chairman}) und den betreuenden Hochschullehrer (\Macro{professor})
-gesetzt. Für genannte Personen werden unter dem Namen selbst die Bezeichner
-ausgegeben (\Term{chairmanname} und \Term{professorname}).
-\end{Declaration}
-\end{Declaration}
-
-\begin{Declaration}{\Macro{taskform}\LParameter%
- \Parameter{Ziele}\Parameter{Schwerpunkte}%
-}
-\printdeclarationlist%
+\tudhyperdef*{sec:bundle}%
%
-Zusätzlich zur der frei gestaltbaren Umgebung \Environment{task} zur Erstellung
-einer Aufgabenstellung wird ein separater Befehl für eine standardisierte
-Ausgabe zur Verfügung gestellt. Dieser strukturiert die Aufgabenstellung in die
-zwei Bereiche \emph{Ziele} und \emph{Schwerpunkte} der Arbeit mit dazugehörigen
-Überschriften (\Term{objectivesname}, \Term{focusname}).
-
-Im optionalen Argument können alle Parameter der Umgebung \Environment{task}
-verwendet werden. Im ersten obligatorischen Argument sollte ein Text mit einer
-kurzen thematischen Einordnung und dem eigentlichen Ziel der Arbeit erscheinen.
-im zweiten Argument sollen die thematischen Schwerpunkte in Stichpunkten
-benannt werden. Der Inhalt des zweiten notwendigen Argumentes wird in einer
-\Environment{itemize}"=Umgebung gesetzt. Deshalb \emph{muss} jedem Stichpunkt
-\Macro*{item} vorangestellt werden.
-\index{Aufgabenstellung|!)}%
-\end{Declaration}
-%
-\begin{Example}
-Die empfohlene Verwendung des Befehls \Macro{taskform} ist wie folgt:
-\begin{Code}[escapechar=§]
-\taskform{%
- Motivation der Arbeit im ersten Absatz§\dots§
-
- Ziele der Arbeit im zweiten Absatz§\dots§
-}{%
- \item Schwerpunkt 1
- \item Schwerpunkt 2
-}
-\end{Code}
-Hierzu sei auch auf das Minimalbeispiel in \autoref{sec:exmpl:task} verwiesen.
-\end{Example}
-
-\begin{Declaration}{\Macro{course}\Parameter{Studiengang}}
-\begin{Declaration}[v2.02]{\Macro{discipline}\Parameter{Studienrichtung}}
-\printdeclarationlist%
-\index{Kollaboratives Schreiben}%
-%
-Mit diesen beiden Befehlen kann der Studiengang sowie die Studienrichtung für
-den Autor oder die Autoren angegeben werden. Diese Informationen werden zu
-Beginn der \Environment{task}"=Umgebung gesetzten Tabelle ausgegeben. Werden
-diese Befehle innerhalb des Makros \Macro{author} verwendet, können auch
-unterschiedliche Angaben für mehrere Autoren gemacht werden. Dabei sind die
-Autoren mit \Macro{and} voneinander zu trennen.
-\end{Declaration}
-\end{Declaration}
-
-\begin{Declaration}{\Macro{chairman}\Parameter{Prüfungsausschussvorsitzender}}
-\printdeclarationlist%
-%
-Wird dieses Feld genutzt, wird neben dem betreuenden Hochschullehrer
-(\Macro{professor}) auch der Vorsitzende des Prüfungsausschusses am Ende der
-Aufgabenstellung aufgeführt. Dies wird zumeist für Abschlussarbeiten wie
-beispielsweise \masterthesisname{} oder \diplomathesisname{} benötigt.
-\end{Declaration}
-
-\begin{Declaration}{\Macro{issuedate}\Parameter{Ausgabedatum}}
-\begin{Declaration}{\Macro{duedate}\Parameter{Abgabetermin}}
-\printdeclarationlist%
-%
-Mit diesen beiden Befehlen sollte das Datum der Ausgabe der Aufgabenstellung
-sowie der spätest mögliche Abgabetermin angegeben werden. Ist das Paket
-\Package{isodate} geladen, wird die damit eingestellte Formatierung des Datums
-durch den Befehl \Macro{printdate} aus diesem Paket für \Macro{issuedate} und
-\Macro{duedate} verwendet.
-\end{Declaration}
-\end{Declaration}
-
-
-\subsection{Gutachten für wissenschaftliche Arbeiten}
-\begin{Declaration}{\Environment{evaluation}[\OLParameter{Überschrift}]}{%
- \Environment{tudpage}'auto'%
-}
-\begin{Declaration}{%
- \Key{\Environment{evaluation}}{headline}[\PName{Überschrift}]%
-}
-\begin{Declaration}{\Key{\Environment{evaluation}}{grade}[\PName{Note}]}
-\printdeclarationlist%
-\index{Gutachten|!(}%
-%
-Diese Umgebung wird für das Erstellen eines Gutachtens einer wissenschaftlichen
-Arbeit bereitgestellt. Auch diese unterstützt alle Parameter, welche für die
-Umgebung \Environment{tudpage}'full' beschrieben wurden.
-
-Für ein Gutachten wird gewöhnlich eine Überschrift aus \Term{evaluationname}
-und~-- falls der Abschlussarbeitstyp angegeben wurde~-- \Term{evaluationtext}
-sowie \Macro{thesis} generiert. Diese automatisch generierte Überschrift kann
-mit dem Parameter \Key{\Environment{evaluation}}{headline} ersetzt werden. Am
-Ende des Gutachtens wird die mit \Key{\Environment{evaluation}}{grade}
-gegebene Note in fetter Schrift ausgezeichnet.
-
-Am Anfang der \Environment{evaluation}"=Umgebung wird die gleiche Tabelle mit
-Autorenangaben ausgegeben, wie dies bei der \Environment{task}"=Umgebung der
-Fall ist. Nach dem Tabellenkopf folgt auch hier der eigentliche Inhalt, sprich
-das Gutachten der Abschlussarbeit. Abgeschlossen wird die Umgebung mit der
-gegebenen Note~-- welche innerhalb von \Term{gradetext} ausgegeben wird~--
-sowie der Orts- und Datumsangabe (\Macro{place}, \Macro{date}) und der
-darauffolgenden Unterschriftzeile für den oder die Gutachter (\Macro{referee}),
-welche wiederum mit den entsprechenden sprachabhängigen Bezeichner
-(\Term{refereename}, \Term{refereeothername}) ergänzt werden.
-\end{Declaration}
-\end{Declaration}
-\end{Declaration}
-
-\begin{Declaration}{\Macro{evaluationform}\LParameter%
- \Parameter{Aufgabe}\Parameter{Inhalt}\Parameter{Bewertung}\Parameter{Note}%
-}
-\printdeclarationlist%
-%
-Neben der individuell nutzbaren Umgebung \Environment{evaluation} wird ein
-separater Befehl zur Erstellung eines standardisierten Gutachtens
-bereitgestellt. Dieser strukturiert die Ausgabe in die vier Bereiche
-\emph{Aufgabe}, \emph{Inhalt}, \emph{Bewertung} und \emph{Note} und versieht
-diese jeweils mit der dazugehörigen Überschrift beziehungsweise Textausgabe
-(\Term{taskname}, \Term{contentname}, \Term{assessmentname} und
-\Term{gradetext}). Das optionale Argument unterstützt alle Parameter der
-\Environment{evaluation}"=Umgebung.
-\index{Gutachten|!)}%
-\end{Declaration}
-%
-\begin{Example}
-Die empfohlene Verwendung des Befehls \Macro{evaluationform} ist wie folgt:
-\begin{Code}[escapechar=§]
-\evaluationform{%
- Kurzbeschreibung der Aufgabenstellung§\dots§
-}{%
- Zusammenfassung von Inhalt und Struktur§\dots§
-}{%
- Bewertung der schriftlichen Abschlussarbeit§\dots§
-}{%
- Zahl (Note)
-}
-\end{Code}
-Hierzu sei auch auf das Minimalbeispiel in \autoref{sec:exmpl:evaluation}
-verwiesen.
-\end{Example}
-
-\begin{Declaration}{\Macro{grade}\Parameter{Note}}
-\printdeclarationlist%
-%
-Neben der Angabe der Note für ein Gutachten über den Parameter
-\Key{\Environment{evaluation}}{grade} kann dafür auch dieser global wirkende
-Befehl verwendet werden.
-\end{Declaration}
-
-
-\subsection{Aushang}
-\begin{Declaration}{\Environment{notice}[\OLParameter{Überschrift}]}{%
- \Environment{tudpage}'auto'%
-}
-\begin{Declaration}{\Key{\Environment{notice}}{headline}[\PName{Überschrift}]}
-\printdeclarationlist%
-\index{Aushang|!(}%
-%
-Für das Anfertigen eines Aushangs kann diese Umgebung verwendet werden. Diese
-basiert abermals auf der Umgebung \Environment{tudpage} und unterstützt alle
-deren Parameter.
-
-Wurde ein Datum angegeben, wird dieses in der oberen rechten Ecke gesetzt.
-Anschließend wird die Überschrift ausgegeben, welche für gewöhnlich dem Inhalt
-von \Term{noticename} entspricht und mit \Key{\Environment{notice}}{headline}
-geändert werden kann. Nach der Überschrift wird bereits der Inhalt der Umgebung
-ausgegeben. Wurde mit \Macro{contactperson} ein oder mehrere Ansprechpartner
-angegeben, werden diese Informationen am Ende der Umgebung ausgegeben.
-\end{Declaration}
-\end{Declaration}
-
-\begin{Declaration}{\Macro{noticeform}\LParameter%
- \Parameter{Inhalt}\Parameter{Schwerpunkte}%
-}
-\printdeclarationlist%
-%
-Auch für diese Umgebung gibt es einen Befehl für eine normierte Form. Diese
-soll vor allem Verwendung für den Aushang studentischer Arbeitsthemen finden.
-Für das optionale Argument können sämtliche Parameter verwendet werden, die
-auch die \Environment{notice}"=Umgebung unterstützt.
-
-Das erste obligatorische Argument sollte für eine kurze Inhaltsbeschreibung
-verwendet werden. Neben dem textuellen Teil sollte hier wenn möglich eine
-thematisch passende Abbildung eingebunden werden (\Macro{includegraphics}). Das
-zweite Argument wird~--wie schon bei \Macro{taskform}~-- dazu verwendet, einige
-Schwerpunkte aufzuzählen. Auch hier kommt nach der gliedernden Überschrift
-(\Term{focusname}) eine \Environment{itemize}"=Umgebung zum Einsatz, allen
-Schwerpunkten muss ein \Macro*{item} vorangestellt werden.
-\index{Aushang|!)}%
-\end{Declaration}
-%
-\begin{Example}
-Die empfohlene Verwendung des Befehls \Macro{noticeform} ist wie folgt:
-\begin{Code}[escapechar=§]
-\noticeform{%
- Kurzbeschreibung des Inhaltes der studentischen Arbeit§\dots§
-
- Bild (optional), einzubinden mit:
- \includegraphics[§\PName{Optionen}§]{§\PName{Datei}§}
-}{%
- \item Schwerpunkt 1
- \item Schwerpunkt 2
-}
-\end{Code}
-Hierzu sei auch auf das Minimalbeispiel in \autoref{sec:exmpl:notice} verwiesen.
-\end{Example}
-
-\begin{Declaration}[v2.02]{\Macro{contactperson}\Parameter{Kontaktperson(en)}}
-\begin{Declaration}{\Macro{office}\Parameter{Dienstsitz}}
-\begin{Declaration}[v2.02]{\Macro{telephone}\Parameter{Telefonnummer}}
-\begin{Declaration}[v2.02]{\Macro{emailaddress}\Parameter{E-Mail-Adresse}}
-\printdeclarationlist%
-%
-Am Ende eines Aushangs können mit \Macro{contactperson} Kontaktinformationen
-für eine oder mehrere Ansprechpartner angegeben werden. Soll mehr als eine
-Kontaktperson genannt werden, so müssen diese innerhalb des Befehls
-\Macro{contactperson} mit dem Befehl \Macro{and} getrennt werden. Für jede
-Person kann innerhalb des Argumentes von \Macro{contactperson} der Dienstsitz
-(\Macro{office}), die dienstliche Telefonnummer (\Macro{telephone}) sowie die
-geschäftliche E"~Mail"=Adresse (\Macro{emailaddress}) angegeben werden. Sollte
-das Paket \Package{hyperref} geladen werden, wird die gegebene E"~Mail"=Adresse
-direkt in einen entsprechenden Link gewandelt.
-\end{Declaration}
-\end{Declaration}
-\end{Declaration}
-\end{Declaration}
-
-
-\subsection{Zusätzliche sprachabhängige Bezeichner}
-\index{Bezeichner|!(}
-Für das Paket \Package{tudscrsupervisor} werden für die zusätzlichen Befehle
-und Umgebungen weitere Bezeichner definiert. Für eine etwaige Anpassung dieser
-sei auf \autoref{sec:localization} verwiesen.
-
-\begin{Declaration}{\Term{taskname}}
-\begin{Declaration}{\Term{tasktext}}
-\printdeclarationlist%
-%
-Die Bezeichnung der Aufgabenstellung selbst ist in \Term{taskname} enthalten.
-Für die Generierung einer Überschrift wird dieser verwendet. Wurde außerdem mit
-\Macro{thesis} oder \Macro{subject} der Typ der Abschlussarbeit%
-\footnote{%
- \Option{subjectthesis} oder spezieller Wert aus \autoref{tab:thesis}
-}
-angegeben, wird die Überschrift zusammen mit dem Bezeichner \Term{tasktext}
-um die Typisierung erweitert. Falls gewünscht, kann die automatisch generierte
-Überschrift mit dem Parameter \Key{\Environment{task}}{headline} der Umgebung
-\Environment{task} überschrieben werden.
-\TermTable{taskname,tasktext}
-\end{Declaration}
-\end{Declaration}
-
-\begin{Declaration}[v2.04]{\Term{namesname}}
-\begin{Declaration}{\Term{titlename}}
-\begin{Declaration}{\Term{coursename}}
-\begin{Declaration}[v2.02]{\Term{disciplinename}}
-\printdeclarationlist%
-%
-Diese Bezeichner werden in der Tabelle mit den Autoreninformationen zu Beginn
-der Aufgabenstellung verwendet. Dabei werden \Term{coursename} und
-\Term{disciplinename} nur genutzt, wenn für mindestens einen Autor die Befehle
-\Macro{course} und/oder \Macro{discipline} verwendet wurden.
-\TermTable{namesname,titlename,coursename,disciplinename}
-\end{Declaration}
-\end{Declaration}
-\end{Declaration}
-\end{Declaration}
-
-\begin{Declaration}{\Term{issuedatetext}}
-\begin{Declaration}{\Term{duedatetext}}
-\printdeclarationlist%
-%
-Am Ende der Aufgabenstellung wird nach dem oder der Betreuer das Ausgabe- und
-Abgabedatum (\Macro{issuedate}, \Macro{duedate}) der Abschlussarbeit mit
-folgenden Bezeichner erläutert.
-\TermTable{issuedatetext,duedatetext}
-\end{Declaration}
-\end{Declaration}
-
-\begin{Declaration}{\Term{chairmanname}}
-\printdeclarationlist%
-%
-Wurde der Prüfungsausschussvorsitzende (\Macro{chairman}) angegeben, erfolgt
-unter dem Namen selbst die Ausgabe des Bezeichners.
-\TermTable{chairmanname}
-\end{Declaration}
-
-\begin{Declaration}{\Term{focusname}}
-\begin{Declaration}{\Term{objectivesname}}
-\printdeclarationlist%
-%
-Die Vorlagen für Aufgabenstellung (\Macro{taskform}) beziehungsweise Aushang
-(\Macro{noticeform}) nutzen für die gesetzten Überschriften diese Bezeichner.
-\TermTable{focusname,objectivesname}
-\end{Declaration}
-\end{Declaration}
-
-\begin{Declaration}{\Term{evaluationname}}
-\begin{Declaration}{\Term{evaluationtext}}
-\printdeclarationlist%
-%
-Die Bezeichnung des Gutachten selbst ist in \Term{evaluationname} enthalten.
-Für die Generierung der Überschrift wird der Bezeichner \Term{evaluationtext}
-sowie der mit \Macro{thesis} oder gegebenenfalls mit \Macro{subject} gegebenen
-Typ der Abschlussarbeit verwendet. Diese automatisch generierte Überschrift
-kann mit dem Parameter \Key{\Environment{evaluation}}{headline} der
-Umgebung \Environment{evaluation} durch den Anwender überschrieben werden.
-\TermTable{evaluationname,evaluationtext}
-\end{Declaration}
-\end{Declaration}
-
-\begin{Declaration}{\Term{contentname}}
-\begin{Declaration}{\Term{assessmentname}}
-\printdeclarationlist%
-%
-Bei der standardisierten Form des Gutachten (\Macro{evaluationform}) werden die
-darin~-- zur strukturierter Gliederung~-- erzeugten Überschriften mit den
-Bezeichnern \Term{taskname}, \Term{contentname} und \Term{assessmentname}
-gesetzt.
-\TermTable{taskname,contentname,assessmentname}
-\end{Declaration}
-\end{Declaration}
-
-\begin{Declaration}{\Term{gradetext}}
-\printdeclarationlist%
-%
-Wird für das Gutachten einer wissenschaftlichen Arbeit die erzielte Note
-entweder mit dem Befehl \Macro{grade}\Parameter{Note} oder alternativ dazu mit
-dem Parameter \Key{\Environment{evaluation}}{grade}[\PName{Note}] angegeben, so
-wird diese innerhalb von \Term{gradetext} verwendet.
-\grade{\PName{Note}}
-\TermTable*{gradetext}{.7\textwidth}
-\end{Declaration}
-
-\begin{Declaration}{\Term{noticename}}
-\begin{Declaration}[v2.02]{\Term{contactpersonname}}
-\printdeclarationlist%
-%
-Die Bezeichnung des Aushangs selbst ist in \Term{noticename} enthalten. Für
-die Generierung einer Überschrift wird dieser verwendet. Falls gewünscht, kann
-diese mit dem Parameter \Key{\Environment{notice}}{headline} der Umgebung
-\Environment{notice} überschrieben werden. Wurde eine Kontaktperson mit dem
-Befehl \Macro{contactperson} angegeben, wird als Überschrift der Kontaktdaten
-der Bezeichner \Term{contactpersonname} verwendet.
-
-\TermTable{noticename,contactpersonname}
-\end{Declaration}
-\end{Declaration}
-\index{Bezeichner|!)}
-\end{Declaration*}
-
-
-\section{Das Paket \Package*{tudscrcolor} -- Farben im \CD}%
-\begin{Declaration*}{\Package{tudscrcolor}}
-\index{Farben|!}%
+\section{Das Paket \Package{tudscrcolor} -- Farben im \CD}%
+\index{Farben|(}%
+\index{Layout!Farben|?(}%
%
+\begin{Bundle*}{\Package{tudscrcolor}}
Zur Verwendung der Farben des \CDs wird das Paket \Package{tudscrcolor}
genutzt. Falls dieses nicht in der Präambel geladen wird~-- um beispielsweise
zusätzliche Optionen aufzurufen~-- binden die \TUDScript"=Klassen dieses
@@ -425,35 +27,39 @@ Hausfarbe \Color{HKS41}, danach folgen die Farben für Auszeichnungen der ersten
Diese Farben dürfen sowohl in ihrer Grundform als auch in helleren Tönen mit
einer Abstufung in 10\,\%"~Schritten verwendet werden. Das ohnehin verwendete
Paket \Package{xcolor} stellt genau diese Funktionalität zur Verfügung. Jede
-der Farben kann sowohl über \Color*{HKS}\PName{Zahl} als auch über ein
-Pseudonym \Color*{cd}\PName{Farbe} genutzt werden.
+der Farben kann sowohl mit \Color*{HKS\PName{Zahl}}() als auch über ein
+Pseudonym \Color*{cd\PName{Farbe}}() genutzt werden.
%
\begin{Example*}
-Die Grundfarbe \Color*{HKS44} soll in der auf 20\% reduzierten, helleren
+Die Grundfarbe \Color{HKS44} soll in der auf 20\% reduzierten, helleren
Abstufung genutzt werden. Innerhalb eines Befehls, der als Argument eine
-gültige Farbe erwartet, muss lediglich \Color*{HKS44}\PValue{!20} angegeben
-werden. Dies wird hier exemplarisch mit dieser \colorbox{HKS44!20}{%
- Box \Macro*{colorbox}\PParameter{HKS44!20}\PParameter{Box}%
-} demonstriert.
+gültige Farbe erwartet, muss lediglich \PValue{HKS44!20} angegeben werden.
+Dies wird hier exemplarisch mit der folgenden \colorbox{HKS44!20}{%
+ Box \Macro{colorbox}[%
+ \PParameter{HKS44!20}\PParameter{Box}%
+ ](\Package{xcolor})'none'%
+}
+demonstriert.
\end{Example*}
%
-Bei der farbigen Gestaltung des \CDs (\Option{cd}[color]) ist der Hintergrund
-von Umschlagseite, Titel sowie Teilen in \Color*{HKS41} und die Schrift auf
-selbigen in \Color*{HKS41}\PValue{!30} gehalten. Der Kapitelseitenhintergrund
-erscheint in \Color*{HKS41}\PValue{!10}, die Schrift in \Color*{HKS41}. Bei
-geringerem Farbeinsatz werden lediglich die Schriften der Gliederungsseiten auf
-\Color*{HKS41} gesetzt.
+Bei der farbigen Gestaltung des \CDs (\Option{cd=color}) ist der Hintergrund
+von Umschlagseite, Titel sowie Teilen in \Color{HKS41} und die Schrift auf
+selbigen in \Color{HKS41}[!30] gehalten. Der Hintergrund von Kapitelseiten
+erscheint in \Color{HKS41}[!10], die Schrift in \Color{HKS41}. Bei geringerem
+Farbeinsatz werden lediglich die Schriften der Gliederungsseiten auf
+\Color{HKS41} gesetzt.
Sollen bestimmte Optionen an das Paket \Package{xcolor} weitergereicht werden,
gibt es dafür zwei Möglichkeiten. Diese kann entweder vor dem Laden der Klasse
direkt an \Package{xcolor} übergeben werden%
\footnote{%
- \Macro{PassOptionsToPackage}\Parameter{Option}\PParameter{xcolor} gefolgt von
- \Macro*{documentclass}\OParameter{Klassenoptionen}\PParameter{tudscr\dots}
-} oder es wird \Package{tudscrcolor} mit der entsprechenden Option geladen.%
-\footnote{
- \Macro*{usepackage}\OParameter{Option}\PParameter{\Package{tudscrcolor}};
- \Package{tudscrcolor} reicht \PName{Option} an \Package{xcolor} weiter
+ \Macro{PassOptionsToPackage}[\Parameter{Paketoptionen}\PParameter{xcolor}] vor
+ \Macro*{documentclass}[\OParameter{Klassenoptionen}\PParameter{tudscr\dots}]%
+}
+oder es wird \Package{tudscrcolor} mit der entsprechenden Option geladen.%
+\footnote{%
+ \Macro*{usepackage}[\OParameter{Paketoptionen}\PParameter{tudscrcolor}];
+ \Package{tudscrcolor} reicht \PName{Paketoptionen} an \Package{xcolor} weiter%
}
\newcommand*\cdcolorcalc{}
\newcommand*\cdcolorname{}
@@ -461,9 +67,11 @@ direkt an \Package{xcolor} übergeben werden%
\newcommand*\cdcolortext{}
\newcommand*\cdcolor[2][0]{%
\noindent%
- \begin{tikzpicture}[every node/.style={%
- rectangle,minimum height=.1\linewidth,minimum width=25mm%
- }]%
+ \begin{tikzpicture}[%
+ every node/.style={%
+ rectangle, minimum height=.1\linewidth, minimum width=7em%
+ }%
+ ]%
\def\cdcolorcalc##1##2{%
\pgfmathparse{100-##1*10}%
\xdef\cdcolorname{HKS##2!\pgfmathresult}%
@@ -479,7 +87,7 @@ direkt an \Package{xcolor} übergeben werden%
\fi%
\node [fill=\cdcolorname,rotate=90] at (.\x\linewidth,0)%
{\textcolor{\cdcolortext}{HKS#2!\pgfmathprintnumber\cdcolorvalue}};%
- };%
+ }%
\end{tikzpicture}%
}
@@ -508,9 +116,9 @@ direkt an \Package{xcolor} übergeben werden%
\begin{Declaration}{\Color{HKS57}[cddarkgreen]}
\begin{Declaration}{\Color{HKS65}[cdgreen]}
\printdeclarationlist%
-\cdcolor[4]{36}\vskip\baselineskipglue
-\cdcolor[4]{33}\vskip\baselineskipglue
-\cdcolor[2]{57}\vskip\baselineskipglue
+\cdcolor[4]{36}\vskip\medskipamount
+\cdcolor[4]{33}\vskip\medskipamount
+\cdcolor[2]{57}\vskip\medskipamount
\cdcolor{65}
\end{Declaration}
\end{Declaration}
@@ -526,27 +134,28 @@ direkt an \Package{xcolor} übergeben werden%
\subsection{Zusätzliche Farbdefinitionen}
Das Paket \Package{tudscrcolor} definiert im Normalfall lediglich die zuvor
-beschriebenen Grundfarben \Color*{HKS41}, \Color*{HKS92}, \Color*{HKS44},
-\Color*{HKS36}, \Color*{HKS33}, \Color*{HKS57}, \Color*{HKS65} sowie
-\Color*{HKS07}. Alle anderen farblichen Abstufungen können mit den beschrieben
-Möglichkeiten des Paketes \Package{xcolor} generiert werden.
+beschriebenen Grundfarben \Color{HKS41}, \Color{HKS92}, \Color{HKS44},
+\Color{HKS36}, \Color{HKS33}, \Color{HKS57}, \Color{HKS65} sowie \Color{HKS07}.
+Alle anderen farblichen Abstufungen können mit den beschrieben Möglichkeiten
+des Paketes \Package{xcolor} generiert werden.
\begin{Declaration}{\Option{oldcolors}}
\printdeclarationlist%
%
-In den letzten Jahren sind viele verschiedene Klassen und Pakete für das \CD
-der \TnUD entstanden. Innerhalb dieser existieren abweichende Farbdefinitionen.
-Um eine Migration von den benannten Klassen und Paketen auf \TUDScript zu
-ermöglichen, existiert die Paketoption \Option{oldcolors}. Wird diese genutzt,
-so werden zusätzliche Farben nach dem Schema \Color*{HKS41K}\PName{Zahl} und
-\Color*{HKS41-}\PName{Zahl} definiert, wobei der hinten angestellte Zahlenwert
-aus der 10er-Reihe kommen muss.
+In den letzten Jahren sind viele verschiedene Klassen und Pakete für das \TUDCD
+entstanden. Innerhalb dieser existieren abweichende Farbdefinitionen. Um eine
+Migration von den benannten Klassen und Paketen auf \TUDScript zu ermöglichen,
+existiert die Paketoption \Option{oldcolors}. Wird diese genutzt, so werden
+zusätzliche Farben nach dem Schema \Color*{HKS41K\PName{Zahl}}() und
+\Color*{HKS41-\PName{Zahl}}() definiert, wobei der hinten angestellte
+Zahlenwert aus der 10er-Reihe kommen muss.
\end{Declaration}
\subsection{Umstellung des Farbmodells}
\index{Farben!Farbmodell}%
+%
Normalerweise verwendet \Package{tudscrcolor} das CMYK"=Farbmodell. Außerdem
wird weiterhin noch der RGB"=Farbraum unterstützt. Eine Umschaltung des
Farbmodells ist beispielsweise für gewisse Funktionen des Paketes
@@ -560,7 +169,7 @@ die Farben nicht nach dem CMYK"=Farbmodell sondern im RGB"=Farbraum global
definiert.
\end{Declaration}
-\begin{Declaration}{\Macro{setcdcolors}\Parameter{Farbmodell}}
+\begin{Declaration}{\Macro{setcdcolors}[\Parameter{Farbmodell}]}
\printdeclarationlist%
%
Mit diesem Befehl kann innerhalb des Dokumentes das verwendete Farbmodell
@@ -577,62 +186,91 @@ CMYK"=Farbmodell in den RGB"=Farbraum zu wechseln. Unterstützte Werte für
(\PValue{CMYK} oder \PValue{RGB}) je nach verwendeter Bildschirm- Drucker-
und Softwarekonfiguration verschieden ausfallen kann. Die verwendeten
RGB-Werte entstammen aus dem Handbuch zum \CD und sind lediglich
- Näherungswerte. Abweichungen vom gedruckten \Color*{HKS}-Farbregister und
- selbst ermittelten Werten sind technisch nicht zu vermeiden.
+ Näherungswerte. Abweichungen vom gedruckten HKS-Farbregister und selbst
+ ermittelten Werten sind technisch nicht zu vermeiden.
}%
-\end{Declaration*}
+\index{Farben|)}%
+\index{Layout!Farben|?)}%
+\end{Bundle*}
-\section{Das Paket \Package*{tudscrfonts} -- Schriften im \CD}
-\begin{Declaration*}[v2.02]{\Package{tudscrfonts}}
-\printchangedatlist
+\section{Das Paket \Package{tudscrfonts} -- Schriften im \CD}
+\begin{Bundle*}[v2.02]{\Package{tudscrfonts}}
+\printchangedatlist%
%
-Dieses Paket stellt die Schriften des \CDs für \hologo{LaTeXe}-Klassen bereit,
+Dieses Paket stellt die Schriften des \CDs für \hologo{LaTeXe}"=Klassen bereit,
welche \emph{nicht} zum \TUDScript-Bundle gehören. Das Paket unterstützt einen
-Großteil der in \fullref{sec:fonts} beschriebenen Optionen und Befehle. Die
-nutzbaren Paketoptionen sind für den Fließtext \Option{cdfont}~-- ohne die
+Großteil der für die \TUDScript-Klassen bereitgestellten Optionen und Befehle
+für die Schriftauswahl. Um Dopplungen in der Dokumentation zu vermeiden, wird
+auf eine abermalige Erläuterung der im Paket \Package{tudscrfonts} verfügbaren
+Optionen und Befehle verzichtet. Diese werden im Folgenden lediglich noch
+einmal genannt, die dazugehörigen Erläuterungen sind in \fullref{sec:fonts} zu
+finden.
+
+Die nutzbaren Paketoptionen sind für den Fließtext \Option{cdfont}~-- ohne die
Einstellungsmöglichkeiten für den Querbalken des \CDs (\Option{cdhead})~-- und
für die mathematischen Schriften \Option{cdmath} sowie \Option{slantedgreek}.
-Da von \Package{tudscrfonts} intern das Paket \Package{tudscrbase}() geladen
-wird, können diese entweder als Paketoptionen im optionalen Argument von
-\Macro*{usepackage}\OParameter{Paketoption}\PParameter{tudscrfonts} oder direkt
-als Klassenoption angegeben werden. Zusätzlich ist nach dem Laden des Paketes
-die späte Optionenwahl mit \Macro{TUDoption} beziehungsweise \Macro{TUDoptions}
-möglich.
-
-Des Weiteren wird das Paket \Package{textcase} geladen, welches die Befehle
-\Macro{MakeTextUppercase} und \Macro{NoCaseChange} zur Verfügung stellt. Der
-Befehl \Macro{ifdin} wird ebenso wie die in \autoref{sec:fonts} beschriebenen
-Textschalter und "~kommandos sowie die Befehle für die griechischen Buchstaben
-bereitgestellt.
-
-Das Paket \Package{tudscrfonts} ist insbesondere für die Verwendung zusammen
-mit einer der Klassen \Class{tudbook}, \Class{tudbeamer}, \Class{tudletter},
-\Class{tudfax}, \Class{tudhaus} sowie \Class{tudform} vorgesehen. Zusätzlich
-werden seit der Version~v2.04
+Weiterhin wird die Option \Option{relspacing} bereitgestellt. Alle genannten
+Optionen können dabei entweder als Paketoptionen im optionalen Argument von
+\Macro*{usepackage}[\OParameter{Paketoptionen}\PParameter{tudscrfonts}] oder
+direkt als Klassenoption angegeben werden. Zusätzlich ist nach dem Laden des
+Paketes die späte Optionenwahl mit \Macro{TUDoption} beziehungsweise
+\Macro{TUDoptions} möglich.
+
+Die in \autoref{sec:fonts} beschriebenen Textschalter und "~kommandos zur
+expliziten Auswahl einzelnen Schnitte der Hausschriften sowie die Befehle für
+griechische Buchstaben werden ebenso wie der Befehl \Macro{ifdin} zur Prüfung
+auf die Verwendung von \DIN bereitgestellt. Dabei muss der Anwender das Setzen
+der Gliederungsüberschriften in Majuskeln der \DIN~-- wie es im \CD vorgesehen
+ist~-- selbst umsetzen. Hierfür sollten die Textauswahlbefehle \Macro{textdbn}
+und \Macro{dinbn} sowie \Macro{MakeTextUppercase}(\Package{textcase})'none' zur
+automatisierten Großschreibung genutzt werden. Der letztgenannte Befehl wird
+zusammen mit \Macro{NoCaseChange}(\Package{textcase}) von \Package{textcase}
+zur Verfügung stellt, welches durch \Package{tudscrfonts} geladen wird.
+
\ChangedAt{%
- v2.04!\Package{tudscrfonts}: Unterstützung von \Class{tudposter} und
- \Class{tudmathposter}%
+ v2.04:Unterstützung der Klassen \Class{tudposter} und \Class{tudmathposter};%
+ v2.05:Neues Schriftpaket \Package{fix-tudscrfonts} für Dokumentklassen
+ im \CD der \TnUD, welche nicht zu \TUDScript gehören%
}
-auch \Class{tudmathposter} und \Class{tudposter} unterstützt. Das Paket kann
-prinzipiell mit jeder beliebigen \hologo{LaTeXe}-Klasse verwendet werden. Wird
-keine der zuvor genannten Klassen genutzt, muss der Anwender das Setzen der
-Gliederungsüberschriften in Majuskeln der \DIN~-- wie es im \CD vorgesehen
-ist~-- selbst umsetzen. Dafür sei abermals auf die Textauswahlbefehle
-\Macro{textdbn} und \Macro{dinbn} sowie den Befehl \Macro{MakeTextUppercase}
-zur automatisierten Großschreibung hingewiesen.
-
+Ursprünglich war das Paket \Package{tudscrfonts} für die Verwendung zusammen
+mit einer der Klassen \Class{tudbook}, \Class{tudbeamer}, \Class{tudletter},
+\Class{tudfax}, \Class{tudhaus}, \Class{tudform} und seit der Version~v2.04
+auch \Class{tudmathposter} sowie \Class{tudposter} vorgesehen. Allerdings
+traten bei der Verwendung des Paketes mit einer dieser Klassen einige kleinere
+Unzulänglichkeiten auf. Deshalb wird seit der Version~v2.05 empfohlen, für
+diese Klassen das Paket \Package{fix-tudscrfonts} zu verwenden.
+\end{Bundle*}
+
+
+
+\section{Das Paket \Package{fix-tudscrfonts} -- Schriftkompatibilität}
+\begin{Bundle*}[v2.05]{\Package{fix-tudscrfonts}}
+\printchangedatlist%
+%
+Dieses Paket ist für die alleinige Verwendung mit einer der folgenden Klassen
+vorgesehen:
+\begin{itemize}
+\item \Class{tudbook}
+\item \Class{tudbeamer}
+\item \Class{tudletter}
+\item \Class{tudfax}
+\item \Class{tudhaus}
+\item \Class{tudform}
+\item \Class{tudmathposter}
+\item \Class{tudposter}
+\end{itemize}
+%
Die Schriftinstallation für das \TUDScript-Bundle unterscheidet sich von der
für die gerade genannten Klassen sehr stark. Dabei wurde auch die Bezeichnung
-der Schriftfamilien geändert. Dies hatte zwei Gründe, wobei der letztere der
-entscheidende ist:
+der Schriftfamilien geändert. Dies hatte zwei Gründe, wobei letzterer von
+entscheidender Bedeutung ist:
%
\begin{enumerate}
\item
- Die bisherige Schriftbenennung entsprach nicht dem offiziellen
- \hrfn{http://mirrors.ctan.org/info/fontname/fontname.pdf}%
- {\hologo{TeX}-Namensschema}
+ Die bisherige Schriftbenennung entsprach nicht dem offiziellen
+ \hrfn{http://mirrors.ctan.org/info/fontname/fontname.pdf}{\hologo{TeX}"=Namensschema}
\item
Bei der Installation für das \TUDScript-Bundle werden sowohl die Metriken
als auch das Kerning der Schriften für Fließtext und den Mathematikmodus
@@ -642,44 +280,48 @@ entscheidende ist:
einen neuen Namen erhalten.
\end{enumerate}
%
-Wird nun das Paket \Package{tudscrfonts} einer der zuvor genannten, älteren
-Klassen verwendet, hat dies den Vorteil, dass auch in diesen das angepasste
-Kerning der Schriften sowie der stark verbesserte Mathematiksatz zum Tragen
-kommen. Außerdem kann bei der Verwendung von \Package{tudscrfonts} auf eine
-Installation der Schriften des \CDs in der alten Variante verzichtet werden.
+Wird nun das Paket \Package{fix-tudscrfonts} zusammen mit einer der zuvor
+genannten Klassen verwendet, hat dies den Vorteil, dass auch bei diesen sowohl
+das angepasste Kerning der Schriften als auch der stark verbesserte
+Mathematiksatz zum Tragen kommen. Außerdem kann bei der Verwendung von
+\Package{fix-tudscrfonts} auf eine Installation der Schriften des \CDs in der
+alten Variante verzichtet werden.
\Attention{%
In diesem Fall kann sich das Ausgabeergebnis im Vergleich zu der Varianten
mit den alten Schriften ändern. Alternativ zur Verwendung des Paketes
- \Package{tudscrfonts} können die alten Schriftfamilien auch parallel zu den
- neuen installiert werden. Hierfür werden die Skripte
+ \Package{fix-tudscrfonts} können die alten Schriftfamilien auch parallel zu
+ den neuen installiert werden. Hierfür werden die Skripte
\hrfn{https://github.com/tud-cd/tudscrold/releases/download/fonts/tudfonts_install.bat}{\File{tudfonts\_install.bat}}
beziehungsweise
\hrfn{https://github.com/tud-cd/tudscrold/releases/download/fonts/tudfonts_install.sh}{\File{tudfonts\_install.sh}}
bereitgestellt.
}%
-\end{Declaration*}
-\ToDo[doc,nxt]{%
- Optimale Verwendung des Paketes \Package{tudscrfonts} mit alten Klassen,
- Laden des Paketes \Package{rescalefont} bei \Class{tudmathposter} unterbinden
-% \RequirePackage{scrlfile}\PreventPackageFromLoading{rescalefont}%
-}[v2.05]
-%title: tudmathposter wird unterstützt
-%\sectionfont: tudmathposter wird unterstützt
-%\subsectionfont: tudmathposter wird unterstützt
-%\subtitlefont: tudmathposter wird unterstützt
-%\tudfont: tudmathposter wird unterstützt
-\ToDo[imp,nxt]{%
- Unterstützung für alle Klassen von Klaus Bergmann implementieren%
-}[v2.05]
-
-
-
-\section{Das Paket \Package*{mathswap}}
-\begin{Declaration*}{\Package{mathswap}}
-\index{Trennzeichen}\index{Mathematiksatz}%
-\index{Trennzeichen!Dezimaltrennzeichen}%
-\index{Trennzeichen!Tausendertrennzeichen}%
%
+Um alle notwendigen Einstellung korrekt und ohne unnötige Warnungen vornehmen
+zu können, muss das Paket \Package{fix-tudscrfonts} bereits \emph{vor} der
+Dokumentklasse geladen werden, wobei die gleichen Paketoptionen wie für das
+Paket \Package{tudscrfonts} verwendet werden können:
+%
+\begin{Code}[escapechar=§]
+\RequirePackage§\OParameter{Paketoptionen}§{fix-tudscrfonts}
+\documentclass§\OParameter{Klassenoptionen}§{tudbook}
+§\dots§
+\begin{document}
+§\dots§
+\end{document}
+\end{Code}
+%
+Dabei wird spätestens zum Ende der Präambel das Paket \Package{tudscrfonts}
+geladen. Alternativ kann dies auch durch den Benutzer in der Dokumentpräambel
+erfolgen.
+\end{Bundle*}
+
+
+\section{Das Paket \Package{mathswap}}
+\index{Mathematiksatz|(}%
+\index{Zifferngruppierung|(}%
+%
+\begin{Bundle*}{\Package{mathswap}}
Die Verwendung von Dezimal- und Tausendertrennzeichen im mathematischen Satz
sind regional sehr unterschiedlich. In den meisten englischsprachigen Ländern
wird der Punkt als Dezimaltrennzeichen und das Komma zur Zifferngruppierung
@@ -706,8 +348,8 @@ zwischen Trennzeichen und Ziffer Leerraum befinden, wird dieser als solcher
auch gesetzt. Für ein Beispiel zur Verwendung des Paketes sei auf das Tutorial
\Tutorial{mathswap} in \autoref{sec:exmpl:mathswap} hingewiesen.
-\begin{Declaration}{\Macro{commaswap}\Parameter{Trennzeichen}}
-\begin{Declaration}{\Macro{dotswap}\Parameter{Trennzeichen}}
+\begin{Declaration}{\Macro{commaswap}[\Parameter{Trennzeichen}]}
+\begin{Declaration}{\Macro{dotswap}[\Parameter{Trennzeichen}]}
\printdeclarationlist%
%
Die beiden Befehle \Macro{commaswap} und \Macro{dotswap} sind die zentrale
@@ -724,61 +366,66 @@ genutzt wird, ist hierfür standardmäßig ein halbes geschütztes Leerzeichen
definiert (\Macro*{,}).
\end{Declaration}
\end{Declaration}
+
+\ChangedAt*{v2.02:Funktionalität im Dokument umschaltbar}%
\begin{Declaration}[v2.02]{\Macro{mathswapon}}
\begin{Declaration}[v2.02]{\Macro{mathswapoff}}
\printdeclarationlist%
%
-\ChangedAt*{v2.02!\Package{mathswap}: Funktionalität im Dokument umschaltbar}%
Die Funktionalität von \Package{mathswap} kann innerhalb des Dokumentes mit
diesen beiden Befehlen an- und abgeschaltet werden. Beim Laden des Paketes ist
es standardmäßig aktiviert.
\end{Declaration}
\end{Declaration}
-\end{Declaration*}
+\index{Mathematiksatz|)}%
+\index{Zifferngruppierung|)}%
+\end{Bundle*}
-\section{Das Paket \Package*{twocolfix}}
-\begin{Declaration*}{\Package{twocolfix}}
-\index{Zweispaltensatz|?}%
+\section{Das Paket \Package{twocolfix}}
+\begin{Bundle*}{\Package{twocolfix}}
+\index{Satzspiegel!zweispaltig|?}%
%
-Der \hologo{LaTeXe}-Kernel enthält einen Fehler, der Kapitelüberschriften im
+Der \hologo{LaTeXe}"=Kernel enthält einen Fehler, der Kapitelüberschriften im
zweispaltigen Layout höher setzt, als im einspaltigen. Der
\hrfn{http://www.latex-project.org/cgi-bin/ltxbugs2html?pr=latex/3126}{Fehler}
ist zwar schon länger bekannt, allerdings bisher noch nicht in den
-\hologo{LaTeXe}-Kernel übernommen worden. Das Paket \Package{twocolfix} behebt
+\hologo{LaTeXe}"=Kernel übernommen worden. Das Paket \Package{twocolfix} behebt
das Problem. Eine Integration dieses Bugfixes in \KOMAScript{} wurde bereits
bei Markus Kohm angefragt, jedoch von ihm bis jetzt
\hrfn{http://www.komascript.de/node/1681}{nicht weiter verfolgt}.
-\end{Declaration*}
+\end{Bundle*}
\addsec*{Zukünftige Arbeiten}
Diese Dinge sollen langfristig in das \TUDScript-Bundle eingearbeitet werden:
%\chapter{Das Paket \Package{tudscrletter} -- Briefe im \CD}
-%\begin{Declaration*}{\Package{tudscrletter}}
-\ToDo[imp,nxt]{Paket \Package*{tudscrletter} für Briefe im \CD}[v2.07]
-Es soll das Paket \Package*{tudscrletter}(tudscr) für Briefe im \CD der \TnUD
-entstehen. Auch Vorlagen für Fax und Hausmitteilungen sollen dabei abfallen.
-%\end{Declaration*}
-%
+%\begin{Bundle*}{\Package{tudscrletter}}
+\ToDo[imp]{Paket \Package*{tudscrletter} für Briefe im \CD}[v2.07]
+Es soll das Paket \Package*{tudscrletter}<tudscr> für Briefe im \TUDCD
+entstehen. Auch Klassen für Fax und Hausmitteilungen sollen dabei abfallen.
+%\end{Bundle*}
+
%\chapter{Das Paket \Package{tudscrbeamer} -- Präsentationen im \CD}
-%\begin{Declaration*}{\Package{tudscrbeamer}}
-\ToDo[imp,nxt]{Paket \Package*{tudscrbeamer} für Präsentationen im \CD}[v2.08]
-Mit \Package*{tudscrbeamer}(tudscr) soll ein Paket entwickelt werden, mit dem
-sich \hologo{LaTeX}-Beamer-Präsentationen im Stil der \TnUD erstellt werden
+%\begin{Bundle*}{\Package{tudscrbeamer}}
+\ToDo[imp]{Paket \Package*{tudscrbeamer} für Präsentationen im \CD}[v2.08]
+Mit \Package*{tudscrbeamer}<tudscr> soll ein Paket entstehen, mit dem
+\hologo{LaTeX}"=Beamer-Präsentationen im Stil des \TUDCDs erstellt werden
können.
-%\end{Declaration*}
-%
+%\end{Bundle*}
+
%\chapter{Das Paket \Package{tudscrlayout} -- Seitenstil und Satzspiegel im \CD}
-%\begin{Declaration*}{\Package{tudscrlayout}}
-\ToDo[imp,nxt]{%
+%\begin{Bundle*}{\Package{tudscrlayout}}
+\ToDo[imp]{%
Paket \Package*{tudscrlayout} \url{https://github.com/tud-cd/tud-cd/issues/6}
- % \Option{cdgeometry}[forced] für Satzspiegel
+ für Satzspiegel, evtl. auch für die Klasse über \Option*{cdgeometry=forced}
}[v2.09]
-Außerdem ist ein Paket \Package*{tudscrlayout}(tudscr) vorstellbar, mit dem
-entweder die \PageStyle{tudheadings}-Seitenstile in anderen Klassen genutzt
-werden können oder der durch das \CD vorgegebene Satzspiegel ohne den
-Seitenstil selbst verwendet wird, um vorgedrucktes Papier verwenden zu können.
-%\end{Declaration*}
+Außerdem ist ein Paket \Package*{tudscrlayout}<tudscr> vorstellbar, welches
+den durch das \CD vorgegebene Satzspiegel aktiviert ohne den Seitenstil selbst
+zu verwenden, um beispielsweise bereits mit dem Kopf der \TnUD bedrucktes
+Papier nutzen zu können. Ebenfalls wäre es denkbar, für andere Klassen die
+\PageStyle{tudheadings}"=Seitenstile verfügbar zu machen ohne dabei den
+Satzspiegel des \CDs umzusetzen.
+%\end{Bundle*}
diff --git a/Master/texmf-dist/source/latex/tudscr/doc/tudscr-examples.tex b/Master/texmf-dist/source/latex/tudscr/doc/tudscr-examples.tex
index dc14f23cf73..93390fea8b9 100644
--- a/Master/texmf-dist/source/latex/tudscr/doc/tudscr-examples.tex
+++ b/Master/texmf-dist/source/latex/tudscr/doc/tudscr-examples.tex
@@ -12,37 +12,40 @@
\end{abstract}
}
\chapter{Minimalbeispiele und Tutorials}
-\label{sec:exmpl}
-\index{Minimalbeispiel|(}
-
+\tudhyperdef*{sec:exmpl}%
+\index{Minimalbeispiel|!(}%
+%
\section{Dokument}
-\index{Minimalbeispiel!Dokument}
-Hier wird gezeigt, wie die Präambel eines minimalen \hologo{LaTeXe}-Dokumentes
+\index{Minimalbeispiel!Dokument}%
+%
+Hier wird gezeigt, wie die Präambel eines minimalen \hologo{LaTeXe}"=Dokumentes
gestaltet werden sollte. Dieser Ausschnitt kann prinzipiell als Grundlage für
ein neu zu erstellendes Dokument verwendet werden. Lediglich das Einbinden des
-Paketes \Package{blindtext} mit \Macro*{usepackage}\PParameter{blindtext} und
+Paketes \Package{blindtext} mit \Macro*{usepackage}[\PParameter{blindtext}] und
die Verwendung des daraus stammenden Befehls \Macro*{blinddocument} können
weggelassen werden.
\IncludeExample{document}
\section{Dissertation}
-\label{sec:exmpl:dissertation}
-\index{Minimalbeispiel!Dissertation}
+\tudhyperdef*{sec:exmpl:dissertation}%
+\index{Minimalbeispiel!Dissertation}%
+%
Eine Abschlussarbeit oder ähnliches könnte wie hier gezeigt begonnen werden.
\IncludeExample{dissertation}
\section{Abschlussarbeit (kollaborativ)}
-\label{sec:exmpl:thesis}
-\index{Minimalbeispiel!Abschlussarbeit}
-\index{Minimalbeispiel!Kollaboratives Schreiben}
+\tudhyperdef*{sec:exmpl:thesis}%
+\index{Minimalbeispiel!Abschlussarbeit}%
+\index{Minimalbeispiel!Kollaboratives Schreiben}%
+%
Alle zusätzlichen Angaben außerhalb des Argumentes von \Macro{author} werden
für beide Autoren gleichermaßen übernommen.%
-\footnote{In diesem Beispiel \Macro{matriculationyear}.}
+\footnote{In diesem Beispiel \Macro{matriculationyear}}
Die Angaben innerhalb des Argumentes von \Macro{author} werden den jeweiligen,
mit \Macro{and} getrennten Autoren zugeordnet.%
\footnote{%
In diesem Beispiel \Macro{matriculationnumber}, \Macro{dateofbirth} und
- \Macro{placeofbirth}.
+ \Macro{placeofbirth}%
}
Ohne die Verwendung von \Macro{and} kann natürlich auch nur ein Autor
aufgeführt werden. Außerdem sei auf die Verwendung von \Macro{subject} anstelle
@@ -50,36 +53,52 @@ von \Macro{thesis} mit einem speziellen Wert aus \autoref{tab:thesis}
hingewiesen.
\IncludeExample{thesis}
+\begin{Bundle}{\Package{tudscrsupervisor}}
\section{Aufgabenstellung (kollaborativ)}
-\label{sec:exmpl:task}
-\index{Minimalbeispiel!Aufgabenstellung}
-\index{Minimalbeispiel!Kollaboratives Schreiben}
+\tudhyperdef*{sec:exmpl:task}%
+\index{Minimalbeispiel!Aufgabenstellung}%
+\index{Minimalbeispiel!Kollaboratives Schreiben}%
+%
Eine Aufgabenstellung für eine wissenschaftliche Arbeit ist mithilfe der
-Umgebung \Environment{task} oder dem Befehl \Macro{taskform} aus dem Paket
-\Package{tudscrsupervisor} folgendermaßen dargestellt werden.
+Umgebung \Environment{task}|?| oder dem Befehl \Macro{taskform}|?| aus dem
+Paket \Package{tudscrsupervisor} folgendermaßen dargestellt werden.
\IncludeExample{task}
\section{Gutachten}
-\label{sec:exmpl:evaluation}
-\index{Minimalbeispiel!Gutachten}
+\tudhyperdef*{sec:exmpl:evaluation}%
+\index{Minimalbeispiel!Gutachten}%
+%
Nach dem Laden des Paketes \Package{tudscrsupervisor} kann ein Gutachten für
-eine wissenschaftliche Arbeit mit der \Environment{evaluation}"=Umgebung oder
-dem Befehl \Macro{evaluationform} erstellt werden.
+eine wissenschaftliche Arbeit mit der \Environment{evaluation}|?|"=Umgebung
+oder dem Befehl \Macro{evaluationform}|?| erstellt werden.
\IncludeExample{evaluation}
\section{Aushang}
-\label{sec:exmpl:notice}
-\index{Minimalbeispiel!Aushang}
-Das Paket \Package{tudscrsupervisor} stellt die Umgebung \Environment{notice}
-für das Anfertigen allgemeiner Aushänge sowie den Befehl \Macro{noticeform}
+\tudhyperdef*{sec:exmpl:notice}%
+\index{Minimalbeispiel!Aushang}%
+%
+Das Paket \Package{tudscrsupervisor} stellt die Umgebung \Environment{notice}|?|
+für das Anfertigen allgemeiner Aushänge sowie den Befehl \Macro{noticeform}|?|
für die Ausschreibung wissenschaftlicher Arbeiten bereit.
\IncludeExample{notice}
-\index{Minimalbeispiel|)}
+\end{Bundle}
+
+\begin{Bundle}{\Class{tudscrposter}}
+\section{Poster}
+\tudhyperdef*{sec:exmpl:poster}%
+\index{Minimalbeispiel!Poster}%
+%
+Mit der Klasse \Class{tudscrposter}|?| lässt sich ein Poster im \TUDCD
+erstellen. Dabei ist die Angabe des gewünschten Papierformates sowie der
+passenden Schriftgröße zu beachten.
+\IncludeExample{poster}
+\index{Minimalbeispiel|!)}%
+\end{Bundle}
-\section{Vorlage für eine wissenschaftlichen Arbeit}
-\label{sec:exmpl:treatise}
-\index{Tutorial|(}
-\index{Tutorial!Abschlussarbeit}
+\section{Leitfaden für eine wissenschaftlichen Arbeit}
+\tudhyperdef*{sec:exmpl:treatise}%
+\index{Tutorials|!(}%
+%
Die meisten Anwender der \TUDScript-Klassen sind Studenten oder angehörige der
\TnUD, die ihre ersten Schritte mit \hologo{LaTeXe} beim Verfassen einer
wissenschaftlichen Arbeit oder ähnlichem machen. Während der Einstiegsphase in
@@ -94,16 +113,19 @@ anderen \hologo{LaTeX}"=Veteran~-- als Leitfaden für die Erstellung einer
wissenschaftlichen Arbeit gedacht.
\section{Ein Beitrag zum mathematischen Satz in \NoCaseChange{\hologo{LaTeXe}}}
-\label{sec:exmpl:mathtype}
-\index{Tutorial!Mathematiksatz}
+\tudhyperdef*{sec:exmpl:mathtype}%
+\index{Mathematiksatz}%
+%
Das Tutorial \Tutorial{mathtype}|!| richtet sich an alle Anwender, die in ihrem
\hologo{LaTeX}"=Dokument mathematische Formeln setzen wollen. In diesem wird
ausführlich darauf eingegangen, wie mit wenigen Handgriffen ein typografisch
sauberer Mathematiksatz zu bewerkstelligen ist.
\section{Änderung der Trennzeichen im Mathematikmodus}
-\label{sec:exmpl:mathswap}
-\index{Tutorial!Trennzeichen Mathematikmodus}
+\tudhyperdef*{sec:exmpl:mathswap}%
+\index{Mathematiksatz}%
+\index{Zifferngruppierung}%
+%
Sollen beim Verfassen eines \hologo{LaTeX}"=Dokumentes Daten in einem
Zahlenformat importiert werden, welches nicht den Gepflogenheiten der
Dokumentsprache entspricht, kommt es meist zu unschönen Ergebnissen bei der
@@ -114,4 +136,4 @@ normalerweise allesamt angepasst und das ursprüngliche Dezimaltrennzeichen
durch ein Komma ersetzt werden. Dieser Schritt wird mit dem \TUDScript-Paket
\Package{mathswap} automatisiert. Wie dies genau funktioniert, wird im Tutorial
\Tutorial{mathswap}|!| erläutert.
-\index{Tutorial|)}
+\index{Tutorials|!)}%
diff --git a/Master/texmf-dist/source/latex/tudscr/doc/tudscr-hints.tex b/Master/texmf-dist/source/latex/tudscr/doc/tudscr-hints.tex
index 3dbae620946..4aa650d3c32 100644
--- a/Master/texmf-dist/source/latex/tudscr/doc/tudscr-hints.tex
+++ b/Master/texmf-dist/source/latex/tudscr/doc/tudscr-hints.tex
@@ -1,15 +1,15 @@
-\newcommand*\TaT{\hyperref[sec:tips]{Tipps \& Tricks}}
+\newcommand*\TaT{\hyperref[sec:tips]{Tipps \& Tricks}:\xspace}
\chapter{Praktische Tipps \& Tricks}
-\manualhyperdef{sec:tips}%
+\tudhyperdef*{sec:tips}%
\section{\NoCaseChange{\hologo{LaTeX}}-Editoren}
-\label{sec:tips:editor}
+\tudhyperdef*{sec:tips:editor}%
+%
Hier werden die gängigsten Editoren zum Erzeugen von \hologo{LaTeX}"=Dateien
genannt. Ich persönlich bin mittlerweile sehr überzeugter Nutzer von
\Application{\hologo{TeX}studio}, da dieser viele Unterstützungs- und
Assistenzfunktionen bietet. Neben diesen gibt es noch weitere, gut nutzbare
-\hologo{LaTeX}-Editoren. Egal, für welchen Editor man sich letztendlich
-entscheidet, sollte dieser auf jeden Fall eine Unicode"=Unterstützung~(UTF"~8)
-enthalten:
+\hologo{LaTeX}"=Editoren. Unabhängig von der Auswahl des Editors, sollte dieser
+auf jeden Fall eine Unicode"=Unterstützung~(UTF"~8) enthalten:
%
\begin{itemize}
\item \Application{\hologo{TeX}maker}
@@ -23,20 +23,20 @@ enthalten:
\end{itemize}
%
Für \Application{\hologo{TeX}studio} wird im \GitHubRepo* das Archiv
-\hrfn{https://github.com/tud-cd/tudscr/releases/download/TeXstudio/tudscr4texstudio.zip}%
-{\File{tudscr4texstudio.zip}} bereitgestellt, welches Dateien zur Erweiterung
-der automatischen Befehlsvervollständigung für \TUDScript enthält. Diese müssen
-unter Windows in \Path{\%APPDATA\%\textbackslash texstudio} beziehungsweise
-unter unixoiden Betriebssystemen in \Path{.config/texstudio} eingefügt werden.
+\hrfn{https://github.com/tud-cd/tudscr/releases/download/TeXstudio/tudscr4texstudio.zip}{\File{tudscr4texstudio.zip}}
+bereitgestellt, welches Dateien zur Erweiterung der automatischen
+Befehlsvervollständigung für \TUDScript enthält. Diese müssen unter Windows in
+\Path{\%APPDATA\%\textbackslash texstudio} beziehungsweise unter unixoiden
+Betriebssystemen in \Path{.config/texstudio} eingefügt werden.
-Möchten Sie das grafische \hologo{LaTeX}-Frontend~\Application{\hologo{LyX}}
+Möchten Sie das grafische \hologo{LaTeX}"~Frontend~\Application{\hologo{LyX}}
für das Erstellen eines Dokumentes mit \TUDScript nutzen, so werden dafür
spezielle Layout-Dateien benötigt, um die Klassendateien verwenden zu können.
-Diese sind zusammen mit einem \Application{\hologo{LyX}}-Dokument als Archiv
-\hrfn{https://github.com/tud-cd/tudscr/releases/download/LyX/tudscr4lyx.zip}%
-{\File{tudscr4lyx.zip}} im \GitHubRepo* verfügbar. Die Layout-Dateien müssen
-dafür im \Application{\hologo{LyX}}"=Installationspfad in den passenden
-Unterordner kopiert werden. Dieser ist bei Windows
+Diese sind zusammen mit einem \Application{\hologo{LyX}}"~Dokument als Archiv
+\hrfn{https://github.com/tud-cd/tudscr/releases/download/LyX/tudscr4lyx.zip}{\File{tudscr4lyx.zip}}
+im \GitHubRepo* verfügbar. Die Layout-Dateien müssen dafür im
+\Application{\hologo{LyX}}"=Installationspfad in den passenden Unterordner
+kopiert werden. Dieser ist bei Windows
\Path{\%PROGRAMFILES(X86)\%\textbackslash{}LyX~2.1\textbackslash{}Resources\textbackslash{}layouts}
beziehungsweise bei unixoiden Betriebssystemen \Path{/usr/share/lyx/layouts}.
Anschließend muss LyX über den Menüpunkt \emph{Werkzeuge} neu konfiguriert
@@ -45,9 +45,9 @@ werden.
\section{Literaturverwaltung in \NoCaseChange{\hologo{LaTeX}}}
-\ChangedAt{v2.02!\TaT: Literaturverwaltung}
+\ChangedAt{v2.02:\TaT Literaturverwaltung}
%
-Die simpelste Variante, eine \hologo{LaTeX}-Literaturdatenbank zu verwalten,
+Die simpelste Variante, eine \hologo{LaTeX}"=Literaturdatenbank zu verwalten,
ist dies mit dem Editor manuell zu erledigen. Wesentlich komfortabler ist es
jedoch, die Referenzverwaltung mit einer darauf spezialisierten Anwendung zu
bewerkstelligen. Dafür gibt es zwei sehr gute Programme:
@@ -61,7 +61,7 @@ Das Programm \Application{Citavi} ermöglicht den Import von bibliografischen
Informationen aus dem Internet. Allerdings sind diese teilweise unvollständig
oder mangelhaft. Mit \Application{JabRef} hingegen muss die Literaturdatenbank
manuell erstellt werden. Allerdings lassen sich einzelne Einträge aus
-.bib-Dateien sehr importieren. Beide Anwendungen unterstützen den Export
+\File*{.bib}"~Dateien importieren. Beide Anwendungen unterstützen den Export
beziehungsweise die Erstellung von Datenbanken im Stil von \Package{biblatex}.
Für \Application{JabRef} muss diese durch den Anwender explizit aktiviert
werden.\footnote{Optionen/Einstellungen/Erweitert/BibLaTeX-Modus}
@@ -72,14 +72,13 @@ Zur Verwendung der beiden Programme in Verbindung mit \Package{biblatex} und
\section{Worttrennungen in deutschsprachigen Texten}
-\manualhyperdef'{sec:tips:hyphenation}
-%
-\ChangedAt{v2.02!\TaT: Worttrennungen}
+\tudhyperdef*{sec:tips:hyphenation}
+\ChangedAt{v2.02:\TaT Worttrennungen}
%
Die möglichen Trennstellen von Wörtern werden von \hologo{LaTeXe} mithilfe
eines Algorithmus berechnet. Dieser ist jedoch in seiner ursprünglichen Form
für die englische Sprache konzipiert worden. Für deutschsprachige Texte wird
-die Worttrennung~-- insbesondere für zusammengeschriebenen Wörtern~-- mit dem
+die Worttrennung~-- insbesondere bei zusammengeschriebenen Wörtern~-- mit dem
Paket \Package{hyphsubst} entscheidend verbessert. Dafür wird ein um vielerlei
Trennungsmuster ergänztes Wörterbuch aus dem Paket \Package{dehyph-exptl}
genutzt.
@@ -116,34 +115,35 @@ nichts anderes eingestellt ist, liegen sowohl Binde- als auch Trennstrich auf
Position~\PValue{45} der Zeichentabelle. In der \PValue{T1}"~Schriftkodierung
befindet sich auf der Position~\PValue{127} glücklicherweise für gewöhnlich das
gleiche Zeichen noch einmal. Dies ist jedoch von der verwendeten Schrift
-abhängig. Wird der Ausdruck \Macro{defaulthyphenchar}\PValue{=127} in der
+abhängig. Wird der Ausdruck \Macro*{defaulthyphenchar}[\PValue{=127}] in der
Dokumentpräambel verwendet, kann dieses Zeichen für den Trennstrich genutzt
-werden. Bei den Schriften des \CDs der \TnUD ist dies bereits automatisch
-eingestellt.
+werden. Bei den Schriften des \TUDCDs ist dies bereits automatisch eingestellt.
Sollte trotz aller Maßnahmen dennoch einmal ein bestimmtes Wort falsch getrennt
werden, so kann die Worttrennung dieses Wortes manuell und global geändert
-werden. Dies wird mit \Macro{hyphenation}\PParameter{Sil-ben-tren-nung}
+werden. Dies wird mit \Macro{hyphenation}[\PParameter{Sil-ben-tren-nung}]
gemacht. Es ist zu beachten, dass dies für alle Flexionsformen des Wortes
erfolgen sollte. Für eine lokale/temporäre Worttrennung kann mit Befehlen aus
dem Paket \Package{babel} gearbeitet werden. Diese sind:
-\vskip\baselineskipglue\noindent
+\vskip\medskipamount\noindent
+\begingroup
+\newcommand*\listhyphens[2]{#1 & \PValue{#2} \tabularnewline}%
\begin{tabular}{@{}ll}
-\textbf{Beschreibung} & \textbf{Befehl}\tabularnewline
-ausschließliche Trennstellen & \PValue{\textbackslash-}\tabularnewline
-zusätzliche Trennstellen & \PValue{"'-}\tabularnewline
-Umbruch ohne Trennstrich & \PValue{"'"'}\tabularnewline
-Bindestrich ohne Umbruch & \PValue{"'\textasciitilde}\tabularnewline
-Bindestrich, der weitere Trennstellen erlaubt & \PValue{"'=}\tabularnewline
+ \textbf{Beschreibung} & \textbf{Befehl} \tabularnewline
+ \listhyphens{ausschließliche Trennstellen}{\textbackslash-}
+ \listhyphens{zusätzliche Trennstellen}{"'-}
+ \listhyphens{Umbruch ohne Trennstrich}{"'"'}
+ \listhyphens{Bindestrich ohne Umbruch}{"'\textasciitilde}
+ \listhyphens{Bindestrich, der weitere Trennstellen erlaubt}{"'=}
\end{tabular}
+\endgroup
\section{Lokale Änderungen von Befehlen und Einstellungen}
-\index{Befehle!Geltungsbereich}\index{Befehle!Deklaration}
-%
-\ChangedAt{v2.02!\TaT: Lokale Änderungen}
+\index{Befehlsdeklaration!Geltungsbereich}%
+\ChangedAt{v2.02:\TaT Lokale Änderungen}
%
Ein zentraler Bestandteil von \hologo{LaTeX} ist die Verwendung von Gruppen
oder Gruppierungen. Innerhalb dieser bleiben alle vorgenommenen Änderungen an
@@ -152,7 +152,7 @@ wenn beispielsweise das Verhalten eines bestimmten Makros einmalig oder
innerhalb von selbst definierten Befehlen oder Umgebungen geändert werden, im
Normalfall jedoch die ursprüngliche Funktionalität behalten soll.
\begin{Example}
-\index{Schriftauszeichnung}
+\index{Schriftauszeichnung}%
Der Befehl \Macro{emph} wird von \hologo{LaTeX} für Hervorhebungen im Text
bereitgestellt und führt normalerweise zu einer kursiven oder~-- falls kein
Schriftschnitt mit echten Kursiven vorhanden ist~-- kursivierten Auszeichnung.
@@ -163,32 +163,33 @@ und verändert werden. Wird diese beendet, verhält sich der Befehl wie gewohnt.
In diesem Text wird ein bestimmtes \emph{Wort} hervorgehoben.
\begingroup
-\renewcommand*\emph[1]{\textbf{#1}}%
-In diesem Text wird ein bestimmtes \emph{Wort} hervorgehoben.
+ \renewcommand*{\emph}[1]{\textbf{#1}}%
+ In diesem Text wird ein bestimmtes \emph{Wort} hervorgehoben.
\endgroup
In diesem Text wird ein bestimmtes \emph{Wort} hervorgehoben.
\end{Code}
\end{Example}
Eine Gruppierung kann entweder mit \Macro*{begingroup} und \Macro*{endgroup}
-oder einfach mit einem geschweiften Klammerpaar \texttt{\{\dots\}} definiert
+oder einfach mit einem geschweiften Klammerpaar \PParameter{\dots} definiert
werden.
-\section{Bezeichnung der Gliederungsebenen durch \Package*{hyperref}}
-\index{Querverweise}
-%
-\ChangedAt{v2.02!\TaT: Bezeichnungen der Gliederungsebenen}
+\section{Bezeichnung der Gliederungsebenen durch \Package{hyperref}}
+\tudhyperdef*{sec:tips:references}
+\index{Querverweise}%
+\ChangedAt{v2.02:\TaT Bezeichnungen der Gliederungsebenen}
%
Das Paket \Package{hyperref} stellt für Querverweise unter anderem den Befehl
-\Macro{autoref}\Parameter{label} zur Verfügung. Mit diesem wird~-- im
-Gegensatz zur Verwendung von \Macro{ref}~-- bei einer Referenz nicht nur die
-Nummerierung selber sondern auch das entsprechende Element wie Kapitel oder
-Abbildung vorangestellt. Bei der Benennung des referenzierten Elementes wird
-sequentiell geprüft, ob das Makro \Macro*{}\PName{Element}\PValue{autorefname}
-oder \Macro*{}\PName{Element}\PValue{name} existiert. Soll die Bezeichnung
-eines Elementes geändert werden, muss man den entsprechende Bezeichner anpassen.
+\Macro{autoref}[\Parameter{label}](\Package{hyperref})'none' zur Verfügung. Mit
+diesem wird~-- im Gegensatz zur Verwendung von \Macro{ref}~-- bei einer
+Referenz nicht nur die Nummerierung selber sondern auch das entsprechende
+Element wie Kapitel oder Abbildung vorangestellt. Bei der Benennung des
+referenzierten Elementes wird sequentiell geprüft, ob das Makro
+\Macro*{\PName{Element}\PValue{autorefname}} oder
+\Macro*{\PName{Element}\PValue{name}} existiert. Soll die Bezeichnung eines
+Elementes geändert werden, muss der entsprechende Bezeichner angepasst werden.
%
\begin{Example}
Bezeichnungen von Gliederungsebenen können folgendermaßen verändert werden.
@@ -201,37 +202,48 @@ Bezeichnungen von Gliederungsebenen können folgendermaßen verändert werden.
-\section{URL-Umbrüche im Literaturverzeichnis mit \Package*{biblatex}}
-\index{Literaturverzeichnis}
-%
-\ChangedAt{v2.02!\TaT: URL-Umbrüche im Literaturverzeichnis}
+\section{URL-Umbrüche im Literaturverzeichnis mit \Package{biblatex}}
+\index{Literaturverzeichnis}%
+\ChangedAt{v2.02:\TaT URL-Umbrüche im Literaturverzeichnis}
%
Wird das Paket \Package{biblatex} verwendet, kann es unter Umständen dazu
kommen, das eine URL nicht vernünftig umbrochen werden. Ist dies der Fall,
-können die Zählern \Counter{biburlnumpenalty}, \Counter{biburlucpenalty} und
-\Counter{biburllcpenalty} erhöht werden. Die möglichen Werte liegen zwischen 0
-und 10000, wobei es bei höheren Werte der Zähler zu mehr URL-Umbrüchen an
-Ziffern (\Counter{biburlnumpenalty}), Groß- (\Counter{biburlucpenalty}) und
-Kleinbuchstaben (\Counter{biburllcpenalty}) kommt. Genaueres hierzu ist der
-Dokumentation des \Package{biblatex}"=Paketes zu entnehmen.
+können die Zählern \Counter{biburlnumpenalty}(\Package{biblatex})'none',
+\Counter{biburlucpenalty}(\Package{biblatex})'none' und
+\Counter{biburllcpenalty}(\Package{biblatex})'none' erhöht werden. Das
+Manipulieren eines Zähler kann mit \Macro*{setcounter}[\Parameter{Zähler}] oder
+lokal mit \Macro*{defcounter}[\Parameter{Zähler}] aus dem Paket
+\Package{etoolbox} erfolgen. Die möglichen Werte liegen zwischen 0~und~10000,
+wobei es bei höheren Zählerwerten zu mehr URL-Umbrüchen an
+Ziffern~(\Counter{biburlnumpenalty}(\Package{biblatex})'none'),
+Groß-~(\Counter{biburlucpenalty}(\Package{biblatex})'none') und
+Kleinbuchstaben~(\Counter{biburllcpenalty}(\Package{biblatex})'none') kommt.
+Genaueres hierzu in der Dokumentation zu \Package{biblatex}.
\section{Zeilenabstände in Überschriften}
-\label{sec:tips:headings}
+\tudhyperdef*{sec:tips:headings}%
+%
Mit dem Paket \Package{setspace} kann der Zeilenabstand beziehungsweise der
Durchschuss innerhalb des Dokumentes geändert werden. Sollte dieser erhöht
worden sein, können die Abstände bei mehrzeiligen Überschriften als zu groß
-erscheinen. Um dies zu korrigieren kann mit dem Befehl \Macro{addtokomafont}%
-\PParameter{disposition}\PParameter{\Macro{setstretch}\PParameter{1}} der
-Zeilenabstand aller Überschriften auf einzeilig zurückgeschaltet werden. Soll
-dies nur für eine bestimmte Gliederungsebene erfolgen, so ist der Parameter
-\PValue{disposition} durch das entsprechende Schriftelement zu ersetzen.
+erscheinen. Um dies zu korrigieren kann mit dem Befehl
+\Macro{addtokomafont}[%
+ \PParameter{disposition}\PParameter{%
+ \Macro{setstretch}[\PParameter{1}](\Package{setspace})'none'%
+ }%
+](\Package{koma-script})'none'
+der Zeilenabstand aller Überschriften auf einzeilig zurückgeschaltet werden.
+Soll dies nur für eine bestimmte Gliederungsebene erfolgen, so ist der
+Parameter \PValue{disposition} durch das dazugehörige Schriftelement zu
+ersetzen.
\section{Warnung wegen zu geringer Höhe der Kopf-/Fußzeile}
-\label{sec:tips:headline}
+\tudhyperdef*{sec:tips:headline}%
+%
Wird das Paket \Package{setspace} verwendet, kann es passieren, dass nach der
Änderung des Zeilenabstandes \emph{innerhalb} des Dokumentes eine oder beide
der folgenden Warnungen erscheinen:
@@ -245,23 +257,23 @@ scrlayer-scrpage Warning: \footheight to low.
%
Dies liegt an dem durch den vergrößerten Zeilenabstand erhöhten Bedarf für die
Kopf- und Fußzeile, die Höhen können in diesem Fall direkt mit der Verwendung
-von \Macro{recalctypearea} angepasst werden. Allerdings ändert das den
-Satzspiegel im Dokument, was eine andere und durchaus berechtigte Warnung von
-\Package{typearea} zur Folge hat. Falls die Änderung des Durchschusses wirklich
-nötig ist, sollte dies in der Präambel des Dokumentes einmalig passieren. Dann
-entfallen auch die Warnungen.
+von \Macro{recalctypearea}(\Package{typearea})'none' angepasst werden.
+Allerdings ändert das den Satzspiegel im Dokument, was eine andere und durchaus
+berechtigte Warnung von \Package{typearea} zur Folge hat. Falls die Änderung
+des Durchschusses wirklich nötig ist, sollte dies in der Präambel des
+Dokumentes einmalig passieren. Dann entfallen auch die Warnungen.
\section{Einrückung von Tabellenspalten verhindern}%
-\manualhyperdef'{sec:tips:table}
-\index{Tabellen}
+\tudhyperdef*{sec:tips:table}
+\index{Tabellen}%
%
Normalerweise wird in einer Tabelle vor \emph{und} nach jeder Spalte durch
-\hologo{LaTeXe} etwas horizontaler Raum mit \Macro{hskip}\Macro{tabcolsep}
+\hologo{LaTeXe} etwas horizontaler Raum mit \Macro*{hskip}\Length{tabcolsep}
eingefügt.%
\footnote{%
- Der Abstand zweier Spalten beträgt folglich \PValue{2}\Macro{tabcolsep}.%
+ Der Abstand zweier Spalten beträgt folglich \PValue{2}\Length{tabcolsep}.%
}
Dies geschieht auch \emph{vor} der ersten und \emph{nach} der letzten Spalte.
Diese optische Einrückung an den äußeren Rändern kann unter Umständen stören,
@@ -270,16 +282,16 @@ insbesondere bei Tabellen, die willentlich~-- beispielsweise mit den Paketen
komplette Seitenbreite aufgespannt werden.
Das Paket \Package{tabularborder} versucht, dieses Problem automatisiert zu
-beheben, ist jedoch nicht zu allen \hologo{LaTeXe}-Paketen für den Tabellensatz
-kompatibel, unter anderem auch nicht zu den drei zuvor genannten. Allerdings
-lässt sich dieses Problem manuell durch den Anwender lösen.
+beheben, ist jedoch nicht zu allen \hologo{LaTeXe}"=Paketen für den
+Tabellensatz kompatibel, unter anderem auch nicht zu den drei zuvor genannten.
+Allerdings lässt sich dieses Problem manuell durch den Anwender lösen.
Bei der Deklaration einer Tabelle kann mit~\PValue{@}\PParameter{\dots} vor und
nach dem Spaltentyp angegeben werden, was anstelle von \Length{tabcolsep} vor
beziehungsweise nach der eigentlichen Spalte eingeführt werden soll. Dies kann
-für das Entfernen der Einrückungen genutzt werden, indem~\PValue{@\{\}} an den
-entsprechenden Stellen bei der Angabe der Spaltentypen vor der ersten und nach
-der letzten Tabellenspalte verwendet wird.
+für das Entfernen der Einrückungen genutzt werden, indem an den entsprechenden
+Stellen~\PValue{@\PParameter{}} bei der Angabe der Spaltentypen vor der ersten
+und nach der letzten Tabellenspalte verwendet wird.
%
\begin{Example}
Eine Tabelle mit zwei Spalten, wobei bei einer die Breite automatisch berechnet
@@ -297,39 +309,45 @@ vor der ersten und nach der letzten entfernt werden.
\section{Unterdrückung des Einzuges eines Absatzes}
-\index{Absatzauszeichnung}
-Verwendet man~-- wie es aus typografischer Sicht zumeist sinnvoll ist~--
-Einzüge und keine vertikalen Abstände zur Auszeichnung von Absätzen im Dokument
-(\Option{parskip}[false]), kann es vorkommen, dass ein bestimmter Absatz~--
-beispielsweise der nach einer gewissen Umgebung folgende~-- ungewollt
-eingerückt ist. Dies kann sehr einfach behoben werden, indem direkt zu Beginn
-des Absatzes das Makro \Macro{noindent} verwendet wird. Möchte man das für
-bestimmte Umgebungen oder Befehle automatisiert gestalten, ist das Paket
-\Package{noindentafter} zu empfehlen.
+\index{Absatzauszeichnung}%
+%
+Werden zur Absatzauszeichnung im Dokument~-- wie es aus typografischer Sicht
+zumeist sinnvoll ist~-- Einzüge und keine vertikalen Abstände verwendet
+(\KOMAScript-Option \Option*{parskip=false}(\Package{koma-script})'none'), kann
+es vorkommen, dass ein ganz bestimmter Absatz~-- beispielsweise der nach einer
+zuvor genutzten Umgebung folgende~-- ungewollt eingerückt ist. Dies kann sehr
+einfach manuell behoben werden, indem direkt zu Beginn des Absatzes das Makro
+\Macro{noindent} aufgerufen wird. Soll das Einrücken von Absätzen nach ganz
+bestimmten Umgebungen oder Befehlen automatisiert unterbunden werden, ist das
+Paket \Package{noindentafter} zu empfehlen.
\section{Unterbinden des Zurücksetzens von Fußnoten}%
-\label{sec:tips:counter}
-\index{Fußnoten}
-Oft taucht die Frage auf, wie man auch über Kapitel fortlaufende Fußnoten
-erhalten kann. Dies ist sehr einfach mit dem Paket \Package{chngcntr} möglich.
-Nach dem Laden des Paketes, kann das Rücksetzen des Zählers nach einem Kapitel
-mit \Macro{counterwithout*}\PParameter{footnote}\PParameter{chapter}
-deaktiviert werden. Auch andere \hologo{LaTeX}-Zähler~-- wie beispielsweise der
-bereits vorgestellte \Counter{symbolheadings}~-- lassen sich mit diesem
-Paket manipulieren.
+\tudhyperdef*{sec:tips:counter}%
+\index{Fußnoten}%
+%
+Oft taucht die Frage auf, wie sich über Kapitel fortlaufende Fußnoten
+realisieren lassen. Dies ist sehr einfach mit dem Paket \Package{chngcntr}
+möglich. Nach dem Laden des Paketes, kann das Zurücksetzen des Zählers nach
+einem Kapitel mit \Macro{counterwithout*}[%
+ \PParameter{footnote}\PParameter{chapter}%
+](\Package{chngcntr})'none' deaktiviert werden. Auch andere
+\hologo{LaTeXe}"=Zähler~-- wie beispielsweise der bereits vorgestellte
+\Counter{symbolheadings}~-- lassen sich mit diesem Paket manipulieren.
-\section{Setzen von Einheiten mit \Package*{siunitx}}
-\label{sec:tips:siunitx}
-\index{Einheiten}
+\section{Setzen von Einheiten mit \Package{siunitx}}
+\tudhyperdef*{sec:tips:siunitx}%
+\index{Einheiten}%
+%
Wenn \Package{siunitx} in einem deutschsprachigen Dokument genutzt soll
-werden, muss zumindest mit \Macro{sisetup}\PParameter{locale = DE} die
-richtige Lokalisierung angegeben werden. Sollen auch die Zahlen richtig
-formatiert sein, müssen weitere Einstellungen vorgenommen werden. Die meiner
-Meinung nach besten sind die folgenden.
+werden, muss zumindest die richtige Lokalisierung mit
+\Macro{sisetup}[\PParameter{locale = DE}](\Package{siunitx})'none' angegeben
+werden. Sollen auch die Zahlen richtig formatiert sein, müssen weitere
+Einstellungen vorgenommen werden. Die meiner Meinung nach besten sind die
+folgenden.
%
\begin{quoting}
\begin{Code}
@@ -350,12 +368,12 @@ verwendet werden.
\section{Warnung beim Erzeugen des Inhaltsverzeichnisses}
\index{Inhaltsverzeichnis}%
+\ChangedAt{v2.02:\TaT Warnung beim Erzeugen des Inhaltsverzeichnisses}
+\ChangedAt{v2.02:\TaT Hinweis auf Rand bei mehrzeiligen Einträgen ergänzt}
%
-\ChangedAt{v2.02!\TaT: Warnung beim Erzeugen des Inhaltsverzeichnisses}
-%
-Erstellt man ein Inhaltsverzeichnis für ein Dokument mit einer dreistelligen
-Seitenanzahl, so erhält man bei der Verwendung von \Macro{tableofcontents}
-viele Warnungen mit der Meldung:
+Wird mit \Macro{tableofcontents}(\Package{koma-script})'none' das
+Inhaltsverzeichnis für ein Dokument mit einer dreistelligen Seitenanzahl
+erstellt, so erscheinen unter Umständen viele Warnungen mit der Meldung:
%
\begin{quoting}
\begin{Code}
@@ -363,26 +381,26 @@ overfull \hbox
\end{Code}
\end{quoting}
%
-Das liegt daran, dass die Seitenzahl in einer Box mit der Breite
-\Macro*{@pnumwidth} gesetzt wird. Der hierfür standardmäßig verwendete Wert
-von~\PValue{1.55em} ist in diesem Fall zu klein. Dieser kann folgendermaßen
-geändert werden:
+Die Seitenzahlen im Verzeichnis werden in einer Box mit einer festen Breite
+von~\PValue{1.55em} gesetzt, welche im Makro \Macro*{@pnumwidth} hinterlegt ist
+und im Zweifel vergrößert werden sollte. Dabei ist auch der rechte Rand für
+mehrzeilige Einträge im Verzeichnis \Macro*{@tocrmarg} zu vergrößern, welcher
+mit~\PValue{2.55em} voreingestellt ist. Die Werte sollten nur minimal geändert
+werden:
%
\begin{quoting}
\begin{Code}
\makeatletter
-\renewcommand*\@pnumwidth{1.7em}
+\renewcommand*{\@pnumwidth}{1.7em}\renewcommand*{\@tocrmarg}{2.7em}
\makeatother
\end{Code}
\end{quoting}
-%
-Dabei sollte der eingesetzte Wert nicht zu groß ausfallen.
\section{Leer- und Satzzeichen nach \NoCaseChange{\hologo{LaTeX}}-Befehlen}%
-\label{sec:tips:xspace}
-\index{Typografie}
+\tudhyperdef*{sec:tips:xspace}%
+\index{Typografie}%
%
Normalerweise \enquote{schluckt} \hologo{LaTeX} die Leerzeichen nach einem
Makro ohne Argumente. Dies ist jedoch nicht immer~-- genau genommen in den
@@ -390,14 +408,14 @@ seltensten Fällen~-- erwünscht. Für dieses Handbuch ist beispielsweise der
Befehl \Macro*{TUD} definiert worden, um \enquote{\TUD{}} nicht ständig
ausschreiben zu müssen. Um sich bei der Verwendung des Befehl innerhalb eines
Satzes für den Erhalt eines folgenden Leerzeichens das Setzen der geschweiften
-Klammer nach dem Befehl zu sparen (\Macro*{TUD}\PParameter{}), kann
-\Macro{xspace} aus dem Paket \Package{xspace} genutzt werden. Damit wird
-ein folgendes Leerzeichen erhalten. Der Befehl \Macro*{TUD} ist wie folgt
-definiert:
+Klammer nach dem Befehl zu sparen (\Macro*{TUD}[\PParameter{}]), kann
+\Macro{xspace}(\Package{xspace})'none' aus dem Paket \Package{xspace} genutzt
+werden. Damit wird ein folgendes Leerzeichen erhalten. Der Befehl \Macro*{TUD}
+ist wie folgt definiert:
%
\begin{quoting}
\begin{Code}
-\newcommand*\TUD{Technische Universit\"at Dresden\xspace}
+\newcommand*{\TUD}{Technische Universit\"at Dresden\xspace}
\end{Code}
\end{quoting}
%
@@ -407,17 +425,16 @@ ignoriert wird:
%
\begin{quoting}
\begin{Code}
-\newcommand*\zB{z.\,B\xperiod}
+\newcommand*{\zB}{z.\,B\xperiod}
\end{Code}
\end{quoting}
\section{Das Setzen von Auslassungspunkten}
-\manualhyperdef{sec:tips:dots}
-\index{Typografie}
-%
-\ChangedAt{v2.02!\TaT: Das Setzen von Auslassungspunkten}
+\tudhyperdef*{sec:tips:dots}%
+\index{Typografie}%
+\ChangedAt{v2.02:\TaT Das Setzen von Auslassungspunkten}
%
Auslassungspunkte werden mit \hologo{LaTeXe} mit den Befehlen \Macro{dots} oder
\Macro{textellipsis} gesetzt. Für gewöhnlich folgt diesen \emph{immer} ein
@@ -453,40 +470,44 @@ eingefügt werden:
\begin{quoting}
\begin{Code}
\let\ellipsispunctuation\relax
-\newcommand*\qdots{[\dots{}]\xspace}
+\newcommand*{\qdots}{[\dots{}]\xspace}
\end{Code}
\end{quoting}
%
Der Befehl \Macro*{qdots} wird definiert, um Auslassungspunkte in eckigen
-Klammern ([\dots{}]) setzen zu können, wie sie für das Kürzen von wörtlichen
-Zitaten häufig verwendet werden.
+Klammern (\POParameter{\dots}) setzen zu können, wie sie für das Kürzen von
+wörtlichen Zitaten häufig verwendet werden.
\section{Finden von unbekannten \NoCaseChange{\hologo{LaTeX}}-Symbolen}
-\index{Symbole}
+\index{Symbole}%
+%
Für \hologo{LaTeX} stehen jede Menge Symbole zur Verfügung, die allerdings
nicht immer einfach zu finden sind. In der Zusammenfassung
-\hrfn{http://mirrors.ctan.org/info/symbols/comprehensive/symbols-a4.pdf}%
-{\File{symbols-a4.pdf}} werden viele Symbole aus mehreren Paketen aufgeführt.
-Alternativ kann \hrfn{http://detexify.kirelabs.org/classify.html}{Detexify}
-verwendet werden. Auf dieser Web-Seite wird das gesuchte Symbol einfach
-gezeichnet, die dazu ähnlichsten werden zurückgegeben.
+\hrfn{http://mirrors.ctan.org/info/symbols/comprehensive/symbols-a4.pdf}{\File{symbols-a4.pdf}}
+werden viele Symbole aus mehreren Paketen aufgeführt. Alternativ kann
+\hrfn{http://detexify.kirelabs.org/classify.html}{Detexify} verwendet werden.
+Auf dieser Web-Seite wird das gesuchte Symbol einfach gezeichnet, die dazu
+ähnlichsten werden zurückgegeben.
\section{Änderung des Papierformates}
-\index{Papierformat}
-Es kann vorkommen, dass man innerhalb eines Dokumentes kurzzeitig das
-Papierformat ändern möchte, um beispielsweise eine Konstruktionsskizze in der
-digitalen PDF"~Datei einzubinden. Dabei ist es sowohl möglich, lediglich die
-Ausrichtung mit \Option{paper}[landscape] in ein Querformat zu ändern, als
-auch die Größe des Papierformates selber.
+\index{Papierformat}%
+%
+Es kann vorkommen, dass innerhalb eines Dokumentes kurzzeitig das Papierformat
+geändert werden soll, um beispielsweise eine Konstruktionsskizze in der
+digitalen PDF"~Datei einzubinden. Dabei ist es mit der \KOMAScript-Option
+\Option{paper=\PSet}(\Package{typearea})'none' sowohl möglich, lediglich die
+Ausrichtung in ein Querformat zu ändern, als auch die Größe des Papierformates
+selber.
%
\begin{Example}
Ein Dokument im A4"~Format soll kurzzeitig auf ein A3"=Querformat geändert
-werden. Das folgende Minimalbeispiel zeigt, wie das Papierformat mit den
-Mitteln von \KOMAScript{} geändert werden kann.
+werden. Das folgende Minimalbeispiel zeigt, wie dies mit \KOMAScript-Mitteln
+über die Optionen \Option*{paper=landscape}(\Package{typearea})'none' und
+\Option*{paper=A3}(\Package{typearea})'none' geändert werden kann.
\begin{Code}
\documentclass[paper=a4,pagesize]{tudscrreprt}
\usepackage{selinput}
@@ -513,40 +534,117 @@ Mitteln von \KOMAScript{} geändert werden kann.
\end{Code}
\end{Example}
-\ToDo[doc,nxt]{Schnittmarken mit \Package{crop} dokumentieren}[v2.05]
-%\section{Schnittmarken}
\section{Vermeiden des Skalierens einer PDF-Datei beim Druck}
-%
-\ChangedAt{v2.04!\TaT: Vermeiden des Skalierens einer PDF-Datei beim Druck}
+\ChangedAt{v2.04:\TaT Vermeiden des Skalierens einer PDF-Datei beim Druck}
%
Beim Erzeugen eines Druckauftrages einer PDF-Datei kann es unter Umständen dazu
führen, dass diese durch den verwendeten PDF-Betrachter unnötigerweise vorher
skaliert wird und dabei die Seitenränder vergrößert werden. Um dieses Verhalten
-für Dokumente, die mit \hologo{pdfTeX} erzeugt werden, zu unterdrücken, gibt es
+für Dokumente, die mit \Engine{pdfTeX} erzeugt werden, zu unterdrücken, gibt es
zwei Möglichkeiten:
%
\begin{enumerate}
-\item Es kann \Macro*{hypersetup}\PParameter{pdfprintscaling=None} verwendet
- werden, wenn im Dokument ohnehin das Paket \Package{hyperref} geladen wird.
-\item Mit dem Low-Level-Befehl
- \Macro*{pdfcatalog}\PParameter{/ViewerPreferences<</PrintScaling/None>>}
- lässt sich auch ohne das Paket das gleiche Verhalten erreichen.
+\item Wenn im Dokument ohnehin das Paket \Package{hyperref} verwendet wird,
+ ist der simple Aufruf von
+ \Macro{hypersetup}[%
+ \PParameter{pdfprintscaling=None}%
+ ](\Package{hyperref})'none'
+ ausreichend.
+\item Der Low-Level-Befehl
+ \Macro*{pdfcatalog}[\PParameter{/ViewerPreferences<{}</PrintScaling/None>{}>}]
+ hat das gleiche Verhalten und kann auch ohne das Paket \Package{hyperref}
+ genutzt werden.
\end{enumerate}
%
Weitere Informationen dazu sind unter \url{http://www.komascript.de/node/1897}
zu finden.
-\section{Warnung bei der Schriftgrößenwahl}
+\section{Beschnittzugabe und Schnittmarken}
+\tudhyperdef*{sec:tips:crop}%
+\index{Beschnittzugabe|!}%
+\index{Schnittmarken|!}%
%
-\ChangedAt{v2.04!\TaT: Warnung bei der Schriftgrößenwahl}
+Beim Plotten von Postern oder anderen farbigen Druckerzeugnissen besteht
+oftmals das Problem, dass ein randloses Drucken nur schwer realisierbar ist.
+Deshalb wird zu oftmals damit beholfen, dass der Druck des fertigen Dokumentes
+auf einem größeren Papierbogen erfolgt und anschließend auf das gewünschte
+Zielformat zugeschnitten wird, womit das Problem des nicht bedruckbaren Randes
+entfällt. Dies kann über zwei verschiedene Wege realisiert werden.
+
+Der einfachste Weg ist die Verwendung des Paketes \Package{crop}. Mit diesem
+kann das Dokument ganz normal im gewünschten Zielformat erstellt werden. Vor
+dem Druck wird dieses Paket geladen und einfach das gewünschte Format des
+Papierbogens angegeben.
+%
+\begin{quoting}
+\begin{Code}[escapechar=§]
+\RequirePackage{fix-cm}
+\documentclass[%
+ paper=a1,
+ fontsize=36pt
+]{tudscrposter}
+\usepackage{selinput}
+\SelectInputMappings{adieresis={ä},germandbls={ß}}
+\usepackage[T1]{fontenc}
+§\dots§
+\usepackage{graphicx}
+\usepackage[b1,center,cam]{crop}
+\begin{document}
+§\dots§
+\end{document}
+\end{Code}
+\end{quoting}
+%
+Alternativ dazu kann für die \TUDScript-Klassen auf die Funktionalität des
+Paketes \Package{geometry} zurückgegriffen werden. Dieses Paket stellt den
+Befehl \Macro{geometry}(\Package{geometry})'none' bereit, in dessen Argument mit
+\Key{\Macro{geometry}(\Package{geometry})}{paper=\PName{Papierformat}}|default|
+das Papierformat festgelegt werden kann. Wird zusätzlich noch der Parameter
+\Key{\Macro{geometry}(\Package{geometry})}{layout=\PName{Zielformat}}|default|
+angegeben, so wird damit das gewünschte Zielformat definiert. Dabei sollte mit
+\Key{\Macro{geometry}(\Package{geometry})}{layoutoffset=\PName{Längenwert}}|default|
+dieser Bereich gegebenenfalls etwas eingerückt werden. Die Angabe von
+\Key{\Macro{geometry}(\Package{geometry})}{showcrop=\PBoolean}|default|
+generiert außerdem noch visuelle Schnittmarken.
+%
+\begin{quoting}
+\begin{Code}[escapechar=§]
+\RequirePackage{fix-cm}
+\documentclass[%
+ paper=a1,
+ fontsize=36pt
+]{tudscrposter}
+\usepackage{selinput}
+\SelectInputMappings{adieresis={ä},germandbls={ß}}
+\usepackage[T1]{fontenc}
+§\dots§
+\geometry{paper=b1,layout=a1,layoutoffset=1in,showcrop}
+\begin{document}
+§\dots§
+\end{document}
+\end{Code}
+\end{quoting}
+%
+Für genauere Erläuterungen sowie weitere Einstellmöglichkeiten sei auf die
+Dokumentation von \Package{crop} beziehungsweise \Package{geometry} verwiesen.
+Mit der \TUDScript-Option \Option{bleedmargin}(\Class{tudscrposter}) können
+zusätzlich ie farbigen Bereiche der \PageStyle{tudheadings}-Seitenstile
+erweitert werden, um ein \enquote{Zuschneiden in die Farbe} zu ermöglichen.
+
+
+
+\section{Warnung bei der Schriftgrößenwahl}
+\tudhyperdef*{sec:tips:fontsize}%
+\ChangedAt{v2.04:\TaT Warnung bei der Schriftgrößenwahl}
%
Die im Dokument verwendete Schriftgröße kann bei den \KOMAScript-Klassen sehr
-einfach über die Option~\Option{fontsize} eingestellt werden, wobei diese immer
-als Klassenoption angegeben werden sollte. Bei relativ großen und kleinen
-Schriftgrößen kann dabei eine Warnung in der Gestalt
+einfach über die Option~\Option{fontsize}(\Package{koma-script})'none'
+eingestellt werden, wobei diese immer als Klassenoption angegeben werden
+sollte. Bei relativ großen und kleinen Schriftgrößen kann dabei eine Warnung in
+der Gestalt
%
\begin{quoting}
\begin{Code}[escapechar=§]
@@ -559,11 +657,12 @@ den Computer-Modern-Standardschriften gesucht wird, unabhängig davon, ob im
Nachhinein ein anderes Schriftpaket geladen wird. Diese sind de-facto nicht in
alle Größen skalierbar. Um die Warnungen zu beseitigen, sollte das Paket
\Package{fix-cm} mit \Macro*{RequirePackage} \emph{vor} der Dokumentklasse
-geladen werden:
+geladen werden:
+%
\begin{quoting}[rightmargin=0pt]
\begin{Code}[escapechar=§]
\RequirePackage{fix-cm}
-\documentclass[<Optionen>]{<Klasse>}
+\documentclass§\OParameter{Klassenoptionen}\Parameter{Klasse}§
\usepackage{selinput}\SelectInputMappings{adieresis={ä},germandbls={ß}}
\usepackage[T1]{fontenc}
§\dots§
@@ -577,79 +676,79 @@ Damit werden die Warnungen behoben.
\section{Platzierung von Gleitobjekten}
-\manualhyperdef'{sec:tips:floats}{}%
-\index{Gleitobjekte|?}\index{Gleitobjekte!Platzierung}%
+\tudhyperdef*{sec:tips:floats}%
+\index{Gleitobjekte!Platzierung|?}%
%
Mit den beiden Paketen \Package{flafter} sowie \Package{placeins} gibt es die
Möglichkeit, den für \hologo{LaTeX} zur Verfügung stehenden Raum für die
Platzierung von Gleitobjekten einzuschränken. Darüber hinaus kann diese auch
durch die im Folgenden aufgezählten Befehle beeinflusst werden. Die Makros
-lassen sich mit \Macro*{renewcommand*}\Parameter{Befehl}\Parameter{Wert} sehr
-einfach ändern.
+lassen sich mit \Macro*{renewcommand*}[\Parameter{Befehl}\Parameter{Wert}]
+sehr einfach ändern.
-\begin{Declaration}{\Macro{floatpagefraction}}[0\floatpagefraction]
-\begin{Declaration}{\Macro{dblfloatpagefraction}}[0\dblfloatpagefraction]
-\printdeclarationlist*%
+\begin{Declaration}{\Macro*{floatpagefraction}}[0\floatpagefraction]
+\begin{Declaration}{\Macro*{dblfloatpagefraction}}[0\dblfloatpagefraction]
+\printdeclarationlist%
%
Der Wert gibt die relative Größe eines Gleitobjektes bezogen auf die Texthöhe
(\Length*{textheight}) an, die mindestens erreicht sein muss, damit für dieses
gegebenenfalls vor dem Beginn eines neuen Kapitels eine separate Seite erzeugt
-wird. Dabei wird einspaltiges (\Macro{floatpagefraction}) und zweispaltiges
-(\Macro{dblfloatpagefraction}) Layout unterschieden. Der Wert für beide
-Befehle sollte im Bereich von~\PValue{0.5\dots 0.8} liegen.
+wird. Dabei wird einspaltiges (\Macro*{floatpagefraction}) und zweispaltiges
+(\Macro*{dblfloatpagefraction}) Layout unterschieden. Der Wert für beide
+Befehle sollte im Bereich von~\PValue{0.5}\dots\PValue{0.8} liegen.
\end{Declaration}
\end{Declaration}
-\begin{Declaration}{\Macro{topfraction}}[0\topfraction]
-\begin{Declaration}{\Macro{dbltopfraction}}[0\dbltopfraction]
-\printdeclarationlist*%
+\begin{Declaration}{\Macro*{topfraction}}[0\topfraction]
+\begin{Declaration}{\Macro*{dbltopfraction}}[0\dbltopfraction]
+\printdeclarationlist%
%
Diese Werte geben den maximalen Seitenanteil für Gleitobjekte, die am oberen
Seitenrand platziert werden, für einspaltiges und zweispaltiges Layout an. Er
-sollte im Bereich von \PValue{0.5\dots 0.8} liegen und größer als
-\Macro{floatpagefraction} beziehungsweise \Macro{dblfloatpagefraction} sein.
+sollte im Bereich von \PValue{0.5}\dots\PValue{0.8} liegen und größer als
+\Macro*{floatpagefraction} beziehungsweise \Macro*{dblfloatpagefraction} sein.
\end{Declaration}
\end{Declaration}
-\begin{Declaration}{\Macro{bottomfraction}}[0\bottomfraction]
-\printdeclarationlist*%
+\begin{Declaration}{\Macro*{bottomfraction}}[0\bottomfraction]
+\printdeclarationlist%
%
Dies ist der maximale Seitenanteil für Gleitobjekte, die am unteren Seitenrand
platziert werden. Er sollte zwischen~\PValue{0.2} und~\PValue{0.5} betragen.
\end{Declaration}
-\begin{Declaration}{\Macro{textfraction}}[0\textfraction]
-\printdeclarationlist*%
+\begin{Declaration}{\Macro*{textfraction}}[0\textfraction]
+\printdeclarationlist%
%
Dies ist der Mindestanteil an Text, der auf einer Seite mit Gleitobjekten
vorhanden sein muss, wenn diese nicht auf einer eigenen Seite ausgegeben
-werden. Er sollte im Bereich von~\PValue{0.1\dots 0.3} liegen.
+werden. Er sollte im Bereich von~\PValue{0.1}\dots\PValue{0.3} liegen.
\end{Declaration}
-\begin{Declaration}{\Counter{totalnumber}}[\arabic{totalnumber}]
-\begin{Declaration}{\Counter{topnumber}}[\arabic{topnumber}]
-\begin{Declaration}{\Counter{dbltopnumber}}[\arabic{dbltopnumber}]
-\begin{Declaration}{\Counter{bottomnumber}}[\arabic{bottomnumber}]
-\printdeclarationlist*%
+\begin{Declaration}{\Counter*{totalnumber}}[\arabic{totalnumber}]
+\begin{Declaration}{\Counter*{topnumber}}[\arabic{topnumber}]
+\begin{Declaration}{\Counter*{dbltopnumber}}[\arabic{dbltopnumber}]
+\begin{Declaration}{\Counter*{bottomnumber}}[\arabic{bottomnumber}]
+\printdeclarationlist%
%
Außerdem gibt es noch Zähler, welche die maximale Anzahl an Gleitobjekten pro
-Seite insgesamt (\Counter{totalnumber}), am oberen (\Counter{topnumber}) und
-am unteren Rand der Seite (\Counter{bottomnumber}) sowie im Zweispaltensatz
-beide Spalten überspannend (\Counter{dbltopnumber}) festlegen. Die Werte
-können mit \Macro*{setcounter}\Parameter{Zähler}\Parameter{Wert} geändert
+Seite insgesamt (\Counter*{totalnumber}), am oberen (\Counter*{topnumber}) und
+am unteren Rand der Seite (\Counter*{bottomnumber}) sowie im zweispaltigen Satz
+beide Spalten überspannend (\Counter*{dbltopnumber}) festlegen. Die Werte
+können mit \Macro*{setcounter}[\Parameter{Zähler}\Parameter{Wert}] geändert
werden.
\end{Declaration}
\end{Declaration}
\end{Declaration}
\end{Declaration}
-\begin{Declaration}{\Length{@fptop}}
-\begin{Declaration}{\Length{@fpsep}}
-\begin{Declaration}{\Length{@fpbot}}
-\begin{Declaration}{\Length{@dblfptop}}
-\begin{Declaration}{\Length{@dblfpsep}}
-\begin{Declaration}{\Length{@dblfpbot}}
-\printdeclarationlist*%
+\begin{Declaration}{\Length*{@fptop}}
+\begin{Declaration}{\Length*{@fpsep}}
+\begin{Declaration}{\Length*{@fpbot}}
+\begin{Declaration}{\Length*{@dblfptop}}
+\begin{Declaration}{\Length*{@dblfpsep}}
+\begin{Declaration}{\Length*{@dblfpbot}}
+\printdeclarationlist%
%
Sind vor Beginn eines Kapitels noch Gleitobjekte verblieben, so werden diese
durch \hologo{LaTeX} normalerweise auf einer separaten vertikal zentriert Seite
@@ -667,39 +766,79 @@ geschehen, können die Längen durch den Anwender geändert werden.
%
\begin{Example}
Alle Gleitobjekte auf einer dafür speziell gesetzten Seite sollen direkt zu
-Beginn dieser ausgegeben werden. In der Dokumentpräambel kann man dafür
-schreiben:
+Beginn dieser ausgegeben werden. In der Dokumentpräambel lässt sich für dieses
+Unterfangen Folgendes nutzen:
\begin{Code}
\makeatletter
\setlength{\@fptop}{0pt}
-\setlength{\@dblfptop}{0pt} % twocolumn
+\setlength{\@dblfptop}{0pt}% twocolumn
\makeatother
\end{Code}
\end{Example}
-\section{Automatisiertes Einbinden von \Application*{Inkscape}-Grafiken }
-\manualhyperdef'{sec:tips:svg}%
+\section{Automatisiertes Einbinden von \Application{Inkscape}-Grafiken }
+\tudhyperdef*{sec:tips:svg}%
\index{Grafiken}%
%
-In \hrfn{http://www.ctan.org/pkg/svg-inkscape}{\Package{svg-inkscape}} wird das
-automatisierte Einbinden von \Application{Inkscape}-Grafiken in ein
-\hologo{LaTeX}"=Dokument erläutert. Hier wird ein daraus abgeleiteter und
-verbesserter Ansatz vorgestellt. Nutzer von unixartigen Systemen können
-alternativ auch das Paket \Package{svg} nutzen, welches den folgend erläuterten
-Befehl \Macro{includesvg} definiert.
-
-Die mit \Application{Inkscape}|?| erstellte Grafik soll automatisch kompiliert
-und eingebunden werden. Dies soll allerdings nicht bei jeder Kompilierung des
-Hauptdokumentes erfolgen, sondern lediglich, wenn die originale Bilddatei
-geändert beziehungsweise aktualisiert wurde. Hierfür wird \Package{filemod}
-verwendet. Die automatisierte Übersetzung einer Grafik im SVG"~Format in eine
-PDF"~Datei und die daran anschließende Einbindung dieser in das Dokument ist
-mit der Definition von \Macro{includesvg}\OParameter{Breite}\Parameter{Datei}
+Das Einbinden von \Application{Inkscape}"=Grafiken in \hologo{LaTeX}"=Dokumente
+wird auf \CTAN[pkg/svg-inkscape]{\Package*{svg-inkscape}'none'} erläutert. Hier
+wird ein daraus abgeleiteter und verbesserter Ansatz vorgestellt, um den Export
+der \Application{Inkscape}"=Grafiken \textbf{automatisiert} direkt bei der
+Kompilierung durch \Engine{pdfLaTeX} auszuführen und diese in das Dokument
+einzubinden. Nutzer von unixartigen Systemen können alternativ dazu auch das
+Paket \Package{svg} nutzen, welches ebenfalls den folgend erläuterten Befehl
+\Macro{includesvg}~-- in etwas abgewandelter Form~-- definiert.
+
+Die mit \Application{Inkscape}|?| erstellte Grafik soll automatisch exportiert
+und eingebunden werden. Um die benötigte Zeit für die Kompilierung möglichst
+gering zu halten, sollte der Export nicht bei jedem \Engine{pdfLaTeX}"=Lauf
+erfolgen, sondern lediglich, falls die originale Bilddatei geändert respektive
+aktualisiert wurde. Hierfür wird das Paket \Package{filemod} verwendet. Die
+automatisierte Übersetzung einer Grafik im SVG"~Format in eine PDF"~Datei und
+die daran anschließende Einbindung dieser in das Dokument ist mit der
+\ToDo[imp]{Bugfix in \Package{svg} oder in tudscr oder eigenes Paket?}[v2.06]
+%\ChangedAt{%
+% v2.06:\TaT\Macro*{includesvg} Bugfix für \Application{Inkscape} Version~0.91;
+% v2.06:\TaT\Macro*{includesvg} in Funktionalität erweitert%
+%}
+Definition von \Macro{includesvg}[\OParameter{Breite}\Parameter{Datei}]
in der Präambel des Dokumentes wie folgt möglich:
-%
-\manualhyperdef{macros:includesvg}%
+%\usepackage{filemod}
+%\usepackage{kvsetkeys}
+%\usepackage{graphicx}
+%\graphicspath{{bla/}{blubb/}}
+%\DeclareUnicodeCharacter{2212}{\ensuremath{-}}
+%\makeatletter
+%\newcommand*{\includesvg}[2][\textwidth]{%
+% \def\svgwidth{#1}%
+% \filemodCmp{#2.pdf}{#2.svg}{}{%
+% \immediate\write18{%
+% inkscape -z -D --file=#2.svg --export-pdf=#2.pdf --export-latex%
+% }%
+% }%
+% \IfFileExists{#2.pdf}{%
+% \begingroup%
+% \pdfximage{#2.pdf}%
+% \let\saved@includegraphics\includegraphics%
+% \let\includegraphics\patch@includegraphics%
+% \InputIfFileExists{#2.pdf_tex}{}{}%
+% \endgroup%
+% }{}%
+%}
+%\newcommand*\saved@includegraphics{}
+%\newcommand*\patch@includegraphics[2][]{%
+% \define@key{svg}{page}{\@tempcnta=##1\relax}%
+% \kv@set@family@handler{svg}{}%
+% \kvsetkeys{svg}{#1}%
+% \ifnum\@tempcnta>\pdflastximagepages\relax\else%
+% \saved@includegraphics[#1]{#2}%
+% \fi%
+%}
+%\makeatother
+%
+\begin{Declaration*}{\Macro{includesvg}}
\begin{quoting}
\begin{Code}[escapechar=§]
\usepackage{filemod}
@@ -710,35 +849,35 @@ in der Präambel des Dokumentes wie folgt möglich:
inkscape -z -D --file=#2.svg --export-pdf=#2.pdf --export-latex
}%
}%
- \input{#2.pdf_tex}%
+ \InputIfFileExists{#2.pdf_tex}{}{}%
}
\end{Code}
\end{quoting}
+\end{Declaration*}
%
-Mit \Macro*{immediate}\Macro*{write18}\Parameter{externer Aufruf} wird das
+Mit \Macro*{immediate}\Macro*{write18}[\Parameter{externer Aufruf}] wird das
zwischenzeitliche Ausführen eines externen Programms beim Durchlauf von
-\hologo{pdfLaTeX}~-- in diesem Fall von \File{inkscape.exe}~-- möglich. Damit
-der externe Aufruf auch tatsächlich durchgeführt wird, ist die Ausführung von
-\hologo{pdfLaTeX} mit der Option \Path{-{}-shell-escape} beziehungsweise bei
-der Verwendung von \Distribution{\hologo{MiKTeX}} mit \Path{-{}-enable-write18}
-zwingend notwendig. Außerdem muss der Pfad zur Datei \File{inkscape.exe} dem
-System bekannt sein.%
+\Engine{pdfLaTeX}~-- in diesem Fall von \File{inkscape.exe}~-- möglich. Damit
+der externe Aufruf auch tatsächlich durchgeführt wird, ist die Ausführung von
+\Engine{pdfLaTeX} mit der Option \Path{-{}-shell-escape} beziehungsweise
+\Path{-{}-enable-write18} zwingend notwendig. Außerdem muss der Pfad zur Datei
+\File{inkscape.exe} dem System bekannt sein.%
\footnote{%
Der Pfad zu \File{inkscape.exe} in der Umgebungsvariable \Path{PATH} des
- Betriebssystems enthalten sein.
+ Betriebssystems enthalten sein.%
}
Bei der Verwendung des Befehls \Macro{includesvg} \emph{muss} der Dateiname
\emph{ohne Endung} angegeben werden. Die einzubindende SVG"~Datei sollte sich
hierbei im gleichen Pfad wie das Hauptdokument befinden. Ist die SVG"~Datei in
einem Unterordner relativ zum Pfad des Hauptdokumentes, kann dieser einfach mit
-\Macro{includesvg}\PParameter{\PName{Ordner}/\PName{Datei}} im Argument
+\Macro{includesvg}[\PParameter{\PName{Ordner}/\PName{Datei}}] im Argument
angegeben werden.
\section{Fehlermeldung: ! No room for a new \textbackslash write}
-%
-\ChangedAt{v2.02!\TaT: Fehler beim Schreiben von Hilfsdateien}
+\tudhyperdef*{sec:tips:write}
+\ChangedAt{v2.02:\TaT Fehler beim Schreiben von Hilfsdateien}
%
Für das Erstellen und Schreiben externer Hilfsdateien steht \hologo{LaTeXe} nur
eine begrenzte Anzahl sogenannter Ausgabe-Streams zur Verfügung. Allein für
@@ -756,28 +895,50 @@ schreibende Pakete, kann es zur der Fehlermeldung
\end{Code}
\end{quoting}
%
-kommen. Abhilfe schafft hier das Paket \Package{scrwfile}(koma-script), welches
-einige Änderungen am \hologo{LaTeX}-Kern vornimmt, um die Anzahl der benötigten
-Hilfsdateien für das Schreiben aller Verzeichnisse zu reduzieren. Es muss
-einfach in der Präambel eingebunden werden. Sollten mit diesem Paket
-unerwarteter Weise Probleme auftreten, ist dessen Anleitung in \scrguide zu
+kommen. Abhilfe schafft hier das Paket \Package{scrwfile}<koma-script>, welches
+einige Änderungen am \hologo{LaTeX}"=Kernel vornimmt, um die Anzahl der
+benötigten Hilfsdateien für das Schreiben aller Verzeichnisse zu reduzieren. Es
+muss einfach in der Präambel eingebunden werden. Sollten mit diesem Paket
+unerwarteter Weise Probleme auftreten, ist dessen Anleitung im \scrguide zu
finden. Eine weitere Möglichkeit, das beschriebene Problem der geringen Menge
an Ausgabe-Streams zu umgehen, stellt das Paket \Package{morewrites} dar.
Allerdings ist dessen Verwendung nicht in allen Fällen von Erfolg gekrönt.
-\section{Probleme bei der Verwendung von \Package*{auto-pst-pdf}}
-\manualhyperdef'{sec:tips:auto-pst-pdf}
+
+
+\section{Fehlermeldung beim Laden eines Paketes mit Optionen}
+\ChangedAt{v2.05:\TaT Fehler beim Laden eines Paketes mit Optionen}
+%
+Es kann unter Umständen passieren, dass beim Laden eines Paketes mit bestimmten
+Optionen via \Macro*{usepackage}[\OParameter{Paketoptionen}\Parameter{Paket}]
+folgender Fehler ausgegeben wird:
%
-\ChangedAt{v2.02!\TaT: Hinweise zu \Package{auto-pst-pdf}}
+\begin{quoting}
+\begin{Code}[escapechar=§]
+! LaTeX Error: Option clash for package <§\dots§>.
+\end{Code}
+\end{quoting}
+%
+Mit großer Sicherheit wird das angeforderte Paket bereits durch die verwendete
+Dokumentklasse oder ein anderes Paket geladen. Normalerweise genügt es, bereits
+vor dem Laden der Dokumentklasse mit \Macro*{documentclass} durch
+\Macro{PassOptionsToPackage}[\Parameter{Paketoptionen}\Parameter{Paket}] die
+gewünschten Optionen an das Paket weiterzureichen, welches den Konflikt meldet.
+
+
+
+\section{Probleme bei der Verwendung von \Package{auto-pst-pdf}}
+\tudhyperdef*{sec:tips:auto-pst-pdf}
+\ChangedAt{v2.02:\TaT Hinweise zum Paket \Package{auto-pst-pdf}}
%
-Bei der Verwendung von \hologo{pdfLaTeX} liest das Paket \Package{auto-pst-pdf}
+Bei der Verwendung von \Engine{pdfLaTeX} liest das Paket \Package{auto-pst-pdf}
die Präambel ein und erstellt anschließend über den PostScript"=Pfad
\Path{latex \textrightarrow{} dvips \textrightarrow{} ps2pdf} eine PDF-Datei,
-welche lediglich alle in den vorhandenen \Environment{pspicture}"=Umgebungen
-erstellten Grafiken enthält.
-Das Paket \Package{ifpdf}
-stellt das Makro \Macro{ifpdf} bereit, mit welchem unterschieden werden kann,
-ob \hologo{pdfLaTeX} als Dokumentprozessor verwendet wird. Abhängig davon
+welche lediglich alle in den vorhandenen
+\Environment{pspicture}(\Package{pstricks})'none'"=Umgebungen erstellten
+Grafiken enthält. Das Paket \Package{ifpdf} stellt das Makro
+\Macro{ifpdf}(\Package{ifpdf})'none' bereit, mit welchem unterschieden werden
+kann, ob \Engine{pdfLaTeX} als Textsatzsystem verwendet wird. Abhängig davon
können unterschiedliche Quelltexte ausgeführt werden, was genutzt wird, um die
nachfolgend beschriebenen Probleme zu beheben.
%
@@ -790,8 +951,8 @@ nachfolgend beschriebenen Probleme zu beheben.
\minisec{Die gleichzeitige Verwendung von \Package{floatrow}}
Das Paket \Package{floatrow} stellt Befehle bereit, mit denen die Beschriftung
von Gleitobjekten sehr bequem gesetzt werden können. Diese Setzen ihren Inhalt
-erst in einer Box, um deren Breite zu ermitteln. Anschließend wird dieser
-ausgegeben. In Kombination mit \Package{auto-pst-pdf} führt das zu einer
+erst in einer Box, um deren Breite zu ermitteln und diese anschließend
+auszugeben. In Kombination mit \Package{auto-pst-pdf} führt das zu einer
doppelten Erstellung der gewünschten Abbildung. Um dies zu vermeiden, müssen
die durch \Package{floatrow} bereitgestellten Befehle \enquote{unschädlich}
gemacht werden. Die fraglichen Befehlen akzeptieren allerdings bis zu drei
@@ -799,9 +960,10 @@ optionale Argumente \emph{vor} den beiden obligatorischen, was für die
Benutzerschnittstelle für die (Re-)Definition durch \hologo{LaTeXe}
normalerweise nicht vorgesehen ist. Deshalb wird das Paket \Package{xparse}
geladen, mit welchem dies möglich wird. Genaueres dazu ist der dazugehörigen
-Paketdokumentation zu entnehmen. Verwendet man folgenden Quelltextauszug in der
-Dokumentpräambel, kann man die \Package{floatrow}-Befehle auch in Verbindung
-mit der \Environment{pspicture}"=Umgebung wie gewohnt verwenden.
+Paketdokumentation zu entnehmen. Mit folgendem Quelltextauszug lassen sich die
+\Package{floatrow}"=Befehle zusammen mit der
+\Environment{pspicture}(\Package{pstricks})'none'"=Umgebung wie gewohnt
+verwenden.
%
\begin{quoting}
\begin{Code}
@@ -816,11 +978,11 @@ mit der \Environment{pspicture}"=Umgebung wie gewohnt verwenden.
\end{quoting}
\minisec{Die parallele Nutzung von \Package{tikz} und \Package{todonotes}}
-Mit dem Paket \Package{tikz}(pgf)~-- und auch allen anderen Paketen die
+Mit dem Paket \Package{tikz}~-- und auch allen anderen Paketen die
selbiges nutzen wie beispielsweise \Package{todonotes}~-- gibt es in Verbindung
-mit \Package{auto-pst-pdf} ebenfalls Probleme. Dies lässt sich lösen, indem man
-diese Pakete lediglich in der Präambel einbindet, wenn \hologo{pdfLaTeX} aktiv
-ist.
+mit \Package{auto-pst-pdf} ebenfalls Probleme. Lösen lässt sich dieses Dilemma,
+indem die fraglichen Pakete lediglich geladen werden, wenn \Engine{pdfLaTeX}
+aktiv ist.
%
\begin{quoting}[rightmargin=0pt]
\begin{Code}
diff --git a/Master/texmf-dist/source/latex/tudscr/doc/tudscr-index.tex b/Master/texmf-dist/source/latex/tudscr/doc/tudscr-index.tex
index a375853b65a..26d26c3187c 100644
--- a/Master/texmf-dist/source/latex/tudscr/doc/tudscr-index.tex
+++ b/Master/texmf-dist/source/latex/tudscr/doc/tudscr-index.tex
@@ -1,54 +1,83 @@
-\Index{Optionen}{options}%
-\Index{Befehle}[Befehle etc.]{macros}%
-\Index{Makro}[Befehle etc.]{macros}%
-\Index{Umgebungen}[Befehle etc.]{macros}%
-\Index{Befehle!Parameter}[Parameter]{keys}%
-\Index{Umgebungen!Parameter}[Parameter]{keys}%
-\Index{Parameter}{keys}%
-\Index{Bezeichner}{terms}%
-\Index{Schriftelemente}{fonts}%
-\Index{Farben}{colors}%
-\Index{Klassen}[Dateien etc.]{files}%
-\Index{Pakete}[Dateien etc.]{files}%
-\Index{Dateien}[Dateien etc.]{files}%
-\Changelog{Änderungen}
-\Changelog{Changelog}
-\Changelog{Version}
+\CrossIndex{Optionen}{options}%
+\CrossIndex*{Befehle}{macros}%
+\CrossIndex{Bezeichner}{terms}%
+\CrossIndex{Seitenstile,Schriftelemente,Farben}{elements}%
+\CrossIndex*{Längen}{misc}%
+\CrossIndex{Zähler}{misc}%
+\CrossIndex*{Klassen,Pakete,Dateien}[Index der Dateien etc.]{files}%
+\CrossIndex*{Änderungen,Changelog,Version}[Änderungsliste]{changelog}%
+%
+\SeeRef*{Distribution}{\Distribution{Mac\hologo{TeX}}}
+\SeeRef*{Distribution}{\Distribution{\hologo{TeX}~Live}}
+\SeeRef*{Distribution}{\Distribution{\hologo{MiKTeX}}}
+%
\index{Abbildungen|see{Grafiken}}%
+\index{Abschlussarbeit|see{Typisierung}}%
\index{Aktualisierung|see{Update}}%
\index{Aufzählungen|see{Listen}}%
+\index{Autorenangaben|see{Titel}}%
+\index{Bindekorrektur|see{Satzspiegel}}%
\index{Cover|see{Umschlagseite}}%
-\index{Dezimaltrennzeichen|see{Trennzeichen}}%
-\index{Distribution!\textsbn{Mac\hologo{TeX}}|see{\textsbn{Mac\hologoRobust{TeX}}~{\idxfont(Distribution)}}}
-\index{Distribution!\textsbn{\hologo{TeX}~Live}|see{\textsbn{\hologoRobust{TeX}~Live}~{\idxfont(Distribution)}}}
-\index{Distribution!\textsbn{\hologo{MiKTeX}}|see{\textsbn{\hologoRobust{MiKTeX}}~{\idxfont(Distribution)}}}
+\index{Dezimaltrennzeichen|see{Zifferngruppierung}}%
+\index{doppelseitiger Satz|see{Satzspiegel}}%
+\index{Dresden-concept-Logo@\DDC-Logo|see{Layout}}%
+\index{Drittlogo|see{Layout}}%
\index{Fachreferent|see{Referent}}%
-\index{Grafiken!Beschriftung|see{Gleitobjekte}}
+\index{Farben|see{Layout}}%
+\index{Fußzeile|see{Layout}}%
+\index{Installation|see{Update}}%
+\index{Gliederung|see{Layout!Überschriften}}%
+\index{Grafiken|see{Gleitobjekte}}%
\index{Großbuchstaben|see{Schriftauszeichnung}}%
+\index{Kapitelseiten|see{Layout}}%
+\index{Kapitelüberschriften|see{Layout}}%
\index{Klassenoptionen|see{Optionen}}%
\index{Kleinbuchstaben|see{Schriftauszeichnung}}%
+\index{Kolumnentitel|see{Layout}}%
+\index{Kopfzeile|see{Layout}}%
\index{Kurzfassung|see{Zusammenfassung}}%
+\index{Layout!Seitenränder|see{Satzspiegel}}%
+\index{Layout!Titel|see{Titel}}%
+\index{Layout!Umschlagseite|see{Umschlagseite}}%
+\index{Leerraum|see{Absatzauszeichnung}}%
\index{Leerseiten|see{Vakatseiten}}%
\index{Lokalisierung|see{Bezeichner}}%
\index{Majuskeln|see{Schriftauszeichnung}}%
-\index{Mathematiksatz!Einheiten|see{Einheiten}}
-\index{Mathematiksatz!Trennzeichen|see{Trennzeichen}}
+\index{Makros|see{Befehle}}%
+\index{Mathematiksatz|see{Einheiten}}%
+\index{Mathematiksatz|see{Griechische Buchstaben}}%
+\index{Mathematiksatz|see{Zifferngruppierung}}%
\index{Minuskeln|see{Schriftauszeichnung}}%
+\index{Nutzerinstallation|see{Installation}}%
\index{Outline-Eintrag|see{Lesezeichen}}%
+\index{Parameter|see{Befehle}}%
\index{Professor|see{Hochschullehrer}}%
-\index{Seitenränder|see{Satzspiegel}}
+\index{Querbalken|see{Layout}}%
+\index{Seitenränder|see{Satzspiegel}}%
+\index{Seitenstile|see{Layout}}%
\index{Silbentrennung|see{Worttrennung}}%
-\index{Sprachunterstützung!Lokalisierung|see{Bezeichner}}%
-\index{Sprachunterstützung!Worttrennung|see{Worttrennung}}%
-\index{Sprungmarken|see{Lesezeichen}}
-\index{Tabellen!Beschriftung|see{Gleitobjekte}}
-\index{Tausendertrennzeichen|see{Trennzeichen}}%
+\index{Sprachunterstützung|see{Bezeichner}}%
+\index{Sprachunterstützung|see{Worttrennung}}%
+\index{Sprungmarken|see{Lesezeichen}}%
+\index{Tabellen|see{Gleitobjekte}}%
+\index{Tausendertrennzeichen|see{Zifferngruppierung}}%
+\index{Teileseiten|see{Layout}}%
+\index{Teileüberschriften|see{Layout}}%
\index{Titel!Umschlagseite|see{Umschlagseite}}%
+\index{Überfüllung|see{Beschnittzugabe}}%
+\index{Umgebungen|see{Befehle}}%
\index{Trennmuster|see{Worttrennung}}%
\index{Vektorgrafiken|see{Grafiken}}%
+\index{Versalien|see{Schriftauszeichnung}}%
+\index{zweiseitiger Satz|see{Satzspiegel}}%
+\index{zweispaltiger Satz|see{Satzspiegel}}%
+\index{Zweitlogo|see{Layout}}%
+
+
\setchapterpreamble{%
+ \addparttocentry{}{\indexname}%
\begin{abstract}
- \noindent Die Formatierung der Einträge in allen aufgeführten Indizes ist
+ \noindent Die Formatierung der Einträge in allen aufgeführten Indexen ist
folgendermaßen aufzufassen: \textbf{Zahlen in fetter Schrift} verweisen auf
die \textbf{Erklärung} zu einem Stichwort, wobei in der digitalen Fassung
dieses Handbuchs dieser Eintrag selbst ein Hyperlink zu seiner Erläuterung
@@ -56,22 +85,17 @@
Informationen, wobei diese für \textit{kursiv hervorgehobene Zahlen} als
besonders \textit{wichtig} erachtet werden.
- Bei Einträgen für \hyperref[idx:options]{Klassen- und Paketoptionen}
- beziehungsweise für \hyperref[idx:macros]{Umgebungen und Befehle}, zu denen
- keine direkte \textbf{Erklärung} gegeben ist sondern lediglich zusätzliche
- Hinweise vorhanden sind, handelt es sich um \KOMAScript"=Optionen. Diese
- sind gegebenenfalls im dazugehörigen Handbuch nachzulesen
- (\scrguide*).
+ Bei Einträgen für \hyperref[idx:options]{Klassen- und Paketoptionen},
+ \hyperref[idx:macros]{Umgebungen und Befehlen} sowie
+ \hyperref[idx:elements]{Seitenstilen, Schriftelementen und Farben}
+ respektive \hyperref[idx:misc]{Längen und Zählern}, zu denen keine direkte
+ \textbf{Erklärung} existiert~-- und diese dementsprechend auch nicht als
+ Hyperlink dargestellt sind~-- handelt es sich um zusätzliche Hinweise für
+ Elemente, die nicht durch \TUDScript sondern von anderen Klassen oder
+ Paketen zur Verfügung gestellt werden, welche im Suffix des entsprechenden
+ Eintrages angegeben werden.
\end{abstract}
}
-\addchap*{\indexname}
-\addxcontentsline{toc}{part}{\indexname}
-\PrintIndexPrologue{%
- Die aufgelisteten Schlagworte sollen sowohl Antworten bei generellen Fragen
- als auch Lösungen für typische Probleme beim Umgang mit \hologo{LaTeXe}
- sowie dem \TUDScript-Bundle liefern.
-% Falls ein gesuchter Begriff hier nicht auftaucht, sollte das \Forum erster
-% Anlaufpunkt sein, um Fragen bei der Nutzung von \TUDScript zu beantworten.
-}
+\chapter*{\indexname}
\PrintIndex
\PrintChangelog
diff --git a/Master/texmf-dist/source/latex/tudscr/doc/tudscr-installation.tex b/Master/texmf-dist/source/latex/tudscr/doc/tudscr-installation.tex
index 5f96164e92b..83e4144b7e8 100644
--- a/Master/texmf-dist/source/latex/tudscr/doc/tudscr-installation.tex
+++ b/Master/texmf-dist/source/latex/tudscr/doc/tudscr-installation.tex
@@ -1,5 +1,5 @@
\chapter{Weiterführende Installationshinweise}
-\label{sec:install:ext}
+\tudhyperdef*{sec:install:ext}%
%
\noindent\Attention{%
Im Folgenden werden unterschiedliche Varianten erläutert, wie die jeweils
@@ -12,7 +12,7 @@
des \CDs für die Version~v2.02 nochmals angepasst werden musste. Dieser
Schritt ließ sich leider nicht vermeiden. Für zukünftige Versionen kann
darauf hoffentlich verzichtet werden, sodass Aktualisierungen ausschließlich
- über CTAN eingespielt werden können. In \autoref{sec:install} wird der
+ über CTAN eingespielt werden können. In \autoref{sec:install} wird der
Installationsprozess der PostScript"=Schriften beschrieben.
}
@@ -28,18 +28,17 @@ Fehlerkorrektur respektive eine Aktualisierung von \TUDScript nötig, kann
diese schnell und unkompliziert über das \GitHubRepo bereitgestellt und durch
den Anwender sofort genutzt werden.
-Dies hat allerdings für Anwender, welche das Forum relativ wenig oder gar
-nicht besuchen, den großen Nachteil, dass diese nicht von Aktualisierungen,
+Dies hat allerdings für alle Anwender, welche das Forum relativ wenig oder gar
+nicht besuchen, den großen Nachteil, dass Sie nicht von Aktualisierungen,
Verbesserungen und Fehlerkorrekturen neuer Versionen profitieren können. Auch
-sämtliche nachfolgenden Bugfixes und Aktualisierungen des \TUDScript-Bundles
-müssen durch den Anwender manuell durchgeführt werden. Daher wird in Zukunft
-die Verbreitung via \hrfn{http://www.ctan.org/pkg/tudscr}{CTAN} präferiert, so
-dass \TUDScript stets in der aktuellen Version verfügbar ist~-- eine durch den
-Anwender aktuell gehaltene \hologo{LaTeX}"=Distribution vorausgesetzt. Der
-einzige Nachteil bei diesem Ansatz ist, dass die Verbreitung eines Bugfixes
-über das \hrfn{http://www.ctan.org/}{Comprehensive TeX Archive Network (CTAN)}
-und die anschließende Bereitstellung durch die verwendete Distribution für
-gewöhnlich mehrere Tage dauert.
+alle nachfolgenden Bugfixes und Aktualisierungen des \TUDScript-Bundles müssen
+durch den Anwender manuell durchgeführt werden. Daher wird die Verbreitung via
+\CTAN[pkg/tudscr] präferiert, sodass \TUDScript stets in der gerade aktuellen
+Version verfügbar ist~-- eine durch den Anwender aktuell gehaltene
+\hologo{LaTeX}"=Distribution vorausgesetzt. Der einzige Nachteil bei diesem
+Ansatz ist, dass die Verbreitung eines Bugfixes und die anschließende
+Bereitstellung durch die verwendete Distribution für gewöhnlich bis zu zwei
+Tagen dauert.
Die gängigen \hologo{LaTeX}"=Distributionen durchsuchen im Regelfall zuerst das
lokale \Path{texmf}"=Nutzerverzeichnis nach Klassen und Paketen und erst daran
@@ -49,7 +48,7 @@ liegt. Sobald im Nutzerverzeichnis die gesuchte Datei gefunden wurde, wird die
Suche beendet.
\Attention{%
In der Konsequenz bedeutet dies, dass sämtliche Aktualisierungen über CTAN
- nicht zum Tragen kommen, falls \TUDScript als lokale Nutzerversion
+ nicht zum Tragen kommen, falls \TUDScript als lokale Nutzerversion
installiert wurde.
}
@@ -68,15 +67,15 @@ selbst verantwortlich ist.
\section{Lokale Deinstallation des \TUDScript-Bundles}
-\label{sec:local:uninstall}
-\index{Deinstallation}
+\tudhyperdef*{sec:local:uninstall}%
+\index{Deinstallation}%
%
Um die lokale Nutzerinstallation zu entfernen, kann für Windows
-\hrfn{https://github.com/tud-cd/tudscr/releases/download/uninstall/tudscr\_uninstall.bat}%
-{\File{tudscr\_uninstall.bat}} sowie für unixartige Betriebssysteme
-\hrfn{https://github.com/tud-cd/tudscr/releases/download/uninstall/tudscr\_uninstall.sh}%
-{\File{tudscr\_uninstall.sh}} verwendet werden. Nach der Ausführung des
-jeweiligen Skriptes kann in der Konsole beziehungsweise im Terminal mit
+\hrfn{https://github.com/tud-cd/tudscr/releases/download/uninstall/tudscr\_uninstall.bat}{\File{tudscr\_uninstall.bat}}
+sowie für unixartige Betriebssysteme
+\hrfn{https://github.com/tud-cd/tudscr/releases/download/uninstall/tudscr\_uninstall.sh}{\File{tudscr\_uninstall.sh}}
+verwendet werden. Nach der Ausführung des jeweiligen Skriptes kann in der
+Konsole beziehungsweise im Terminal mit
%
\begin{quoting}
\Path{kpsewhich --all tudscrbase.sty}
@@ -119,22 +118,22 @@ gefundene~-- zum Ordner der Distribution \emph{zusätzliche}~-- Pfad hat die
folgende Struktur:
%
\begin{quoting}
-\Path{\emph{<Installationspfad>}/tex/latex/tudscr/tudscrbase.sty}
+\Path{\PName{Installationspfad}/tex/latex/tudscr/tudscrbase.sty}
\end{quoting}
%
Um die Nutzerinstallation vollständig zu entfernen, muss als erstes zu
-\Path{\emph{<Installationspfad>}} navigiert werden. Anschließend ist in diesem
+\Path{\PName{Installationspfad}} navigiert werden. Anschließend ist in diesem
Pfad Folgendes durchzuführen:
%
\settowidth\tempdim{\Path{tex/latex/tudscr/}}%
\begin{description}[labelwidth=\tempdim,labelsep=1em]
-\item[\Path{tex/latex/tudscr/}]alle .cls- und .sty-Dateien löschen
+\item[\Path{tex/latex/tudscr/}]\File*{.cls}- und \File*{.sty}"~Dateien löschen
\item[\Path{tex/latex/tudscr/}]Ordner \Path{logo} vollständig löschen
\item[\Path{doc/latex/}] Ordner \Path{tudscr} vollständig löschen
\item[\Path{source/latex/}] Ordner \Path{tudscr} vollständig löschen
\end{description}
%
-Das Verzeichnis \Path{\emph{<Installationspfad>}/tex/latex/tudscr/fonts}
+Das Verzeichnis \Path{\PName{Installationspfad}/tex/latex/tudscr/fonts}
\textbf{sollte erhalten bleiben}. Andernfalls müssen die Schriften des \CDs
abermals wie unter \autoref{sec:install} beschrieben installiert werden.
Zum Abschluss ist in der Kommandozeile beziehungsweise im Terminal der Befehl
@@ -145,8 +144,8 @@ Distribution bereitgestellt wird.
\section{Lokale Installation des \TUDScript-Bundles}
-\label{sec:local:install}
-\index{Installation!Nutzerinstallation}\index{Nutzerinstallation (lokal)}
+\tudhyperdef*{sec:local:install}%
+\index{Installation!Nutzerinstallation|(}%
%
Für die lokale Nutzerinstallation von \TUDScript inklusive der Schriften des
\CDs werden für Windows sowie unixartige Betriebssysteme die passenden Skripte
@@ -155,15 +154,13 @@ die genau wissen, aus welchen Gründen dies geschehen soll.
\subsection{Lokale Installation von \TUDScript unter Windows}
-\index{Installation!Nutzerinstallation}\index{Nutzerinstallation (lokal)}
Für eine lokale Nutzerinstallation des \TUDScript-Bundles und der dazugehörigen
Schriften für die Distributionen \Distribution{\hologo{TeX}~Live} oder
\Distribution{\hologo{MiKTeX}} werden neben den Schriftarchiven die Dateien aus
-\hrfn{https://github.com/tud-cd/tudscr/releases/download/\vTUDScript/TUD-KOMA-Script\_\vTUDScript\_Windows\_full.zip}%
-{\File*{TUD-KOMA-Script\_\vTUDScript\_Windows\_full.zip}} benötigt. Vor der
-Verwendung des Skripts \File{tudscr\_\vTUDScript\_install.bat} sollte
-sichergestellt werden, dass sich \emph{alle} der folgenden Dateien im selben
-Verzeichnis befinden:
+\hrfn{https://github.com/tud-cd/tudscr/releases/download/\vTUDScript/TUD-KOMA-Script\_\vTUDScript\_Windows\_full.zip}{\File*{TUD-KOMA-Script\_\vTUDScript\_Windows\_full.zip}}
+benötigt. Vor der Nutzung des Skripts \File{tudscr\_\vTUDScript\_install.bat}
+sollte sichergestellt werden, dass sich \emph{alle} der folgenden Dateien im
+selben Verzeichnis befinden:
%
\settowidth\tempdim{\File{tudscr\_\vTUDScript\_install.bat}}%
\begin{description}[labelwidth=\tempdim,labelsep=1em]
@@ -171,7 +168,7 @@ Verzeichnis befinden:
\item[\File{tudscr\_\vTUDScript\_install.bat}]Installationsskript
\item[\File{Univers\_PS.zip}]Archiv mit Schriftdateien für \Univers
\item[\File{DIN\_Bd\_PS.zip}]Archiv mit Schriftdateien für \DIN
- \item[\File{tudscrfonts.zip}]Archiv mit Metriken für die
+ \item[\File{tudscr\_fonts\_install.zip}]Archiv mit Metriken für die
Schriftinstallation via \Package{fontinst}
\end{description}
%
@@ -189,15 +186,13 @@ Schriftinstallation sei auf \autoref{sec:install:win} verwiesen.
\subsection{Lokale Installation von \TUDScript unter Linux und OS~X}
-\index{Installation!Nutzerinstallation}\index{Nutzerinstallation (lokal)}
Für eine lokale Nutzerinstallation des \TUDScript-Bundles und der dazugehörigen
Schriften für die Distributionen \Distribution{\hologo{TeX}~Live} oder
\Distribution{Mac\hologo{TeX}} werden neben den Schriftarchiven die Dateien aus
-\hrfn{https://github.com/tud-cd/tudscr/releases/download/\vTUDScript/TUD-KOMA-Script\_\vTUDScript\_Unix\_full.zip}%
-{\File*{TUD-KOMA-Script\_\vTUDScript\_Unix\_full.zip}} benötigt. Vor der
-Verwendung des Skripts \File{tudscr\_\vTUDScript\_install.sh} sollte
-sichergestellt werden, dass sich \emph{alle} der folgenden Dateien im selben
-Verzeichnis befinden:
+\hrfn{https://github.com/tud-cd/tudscr/releases/download/\vTUDScript/TUD-KOMA-Script\_\vTUDScript\_Unix\_full.zip}{\File*{TUD-KOMA-Script\_\vTUDScript\_Unix\_full.zip}}
+benötigt. Vor der Verwendung des Skripts \File{tudscr\_\vTUDScript\_install.sh}
+sollte sichergestellt werden, dass sich \emph{alle} der folgenden Dateien im
+selben Verzeichnis befinden:
%
\begin{description}[labelwidth=\tempdim,labelsep=1em]
\settowidth\tempdim{\File{tudscr\_\vTUDScript\_install.sh}}%
@@ -206,7 +201,7 @@ Verzeichnis befinden:
(Terminal: \Path{bash tudscr\_\vTUDScript\_install.sh})
\item[\File{Univers\_PS.zip}]Archiv mit Schriftdateien für \Univers
\item[\File{DIN\_Bd\_PS.zip}]Archiv mit Schriftdateien für \DIN
- \item[\File{tudscrfonts.zip}]Archiv mit Metriken für die
+ \item[\File{tudscr\_fonts\_install.zip}]Archiv mit Metriken für die
Schriftinstallation via \Package{fontinst}
\end{description}
%
@@ -218,18 +213,15 @@ verwiesen.
\section{Lokales Update des \TUDScript-Bundles}
-\label{sec:local:update}
-\index{Update!Nutzerinstallation}\index{Nutzerinstallation (lokal)}
-
-
-
+\tudhyperdef*{sec:local:update}%
+\index{Update|!}%
+%
\subsection{Update des \TUDScript-Bundles ab Version~\NoCaseChange{v}2.02}
Für eine lokale Aktualisierung von \TUDScript auf \vTUDScript{} muss das Archiv
-\hrfn{https://github.com/tud-cd/tudscr/releases/download/\vTUDScript/TUD-KOMA-Script\_\vTUDScript\_Windows\_update.zip}%
-{TUD-KOMA-Script\_\vTUDScript\_Windows\_update.zip} respektive
-\hrfn{https://github.com/tud-cd/tudscr/releases/download/\vTUDScript/TUD-KOMA-Script\_\vTUDScript\_Unix\_update.zip}%
-{TUD-KOMA-Script\_\vTUDScript\_Unix\_update.zip} entpackt und anschließend
-\File{tudscr\_\vTUDScript\_update.bat} oder
+\hrfn{https://github.com/tud-cd/tudscr/releases/download/\vTUDScript/TUD-KOMA-Script\_\vTUDScript\_Windows\_update.zip}{TUD-KOMA-Script\_\vTUDScript\_Windows\_update.zip}
+respektive
+\hrfn{https://github.com/tud-cd/tudscr/releases/download/\vTUDScript/TUD-KOMA-Script\_\vTUDScript\_Unix\_update.zip}{TUD-KOMA-Script\_\vTUDScript\_Unix\_update.zip}
+entpackt und anschließend \File{tudscr\_\vTUDScript\_update.bat} oder
\File{tudscr\_\vTUDScript\_update.sh} ausgeführt werden.
\Attention{%
Die lokale Aktualisierung funktioniert nur, wenn \TUDScript bereits
@@ -244,11 +236,11 @@ angeboten. Die Aktualisierung kann durch den Anwender entweder~-- wie in
\autoref{sec:local:install} erläutert~-- mit einer skriptbasierten oder mit
einer manuellen Neuinstallation erfolgen. Für die zweite Variante muss
der Inhalt des Archivs
-\hrfn{https://github.com/tud-cd/tudscr/releases/download/\vTUDScript/tudscr\_\vTUDScript.zip}%
-{\File{tudscr\_\vTUDScript.zip}} in das lokale \Path{texmf}"=Nutzerverzeichnis
-kopiert werden. Des Weiteren wurde die Installation der Schriften überarbeitet.
-Deshalb wird auch für diese eine Neuinstallation (\autoref{sec:install}) sehr
-empfohlen.
+\hrfn{https://github.com/tud-cd/tudscr/releases/download/\vTUDScript/tudscr\_\vTUDScript.zip}{\File{tudscr\_\vTUDScript.zip}}
+in das lokale \Path{texmf}"=Nutzerverzeichnis kopiert werden. Des Weiteren
+wurde die Installation der Schriften überarbeitet. Deshalb wird auch für diese
+eine Neuinstallation (\autoref{sec:install}) sehr empfohlen.
+\index{Installation!Nutzerinstallation|)}%
\subsection{Update des \TUDScript-Bundles von Version \NoCaseChange{v}1.0}
@@ -259,7 +251,7 @@ empfohlen.
Ist \TUDScript in der veralteten Version~v1.0 installiert, so wird dringend zu
einer Deinstallation geraten. Andernfalls wird es zu Problemen kommen. Dafür
werden die Skripte
-\hrfn{https://github.com/tud-cd/tudscr/releases/download/uninstall/tudscr\_uninstall.bat}{\File{tudscr\_uninstall.bat}}
+\hrfn{https://github.com/tud-cd/tudscr/releases/download/uninstall/tudscr_uninstall.bat}{\File{tudscr\_uninstall.bat}}
respektive
\hrfn{https://github.com/tud-cd/tudscr/releases/download/uninstall/tudscr_uninstall.sh}{\File{tudscr\_uninstall.sh}}
bereitgestellt. Die aktuelle Version~\vTUDScript{} kann nach der Deinstallation
@@ -268,25 +260,24 @@ wie in \autoref{sec:install} beschrieben installiert werden.
Möchten Sie die obsoleten \TUDScript-Klassen in der Version~v1.0 nach einer
Aktualisierung weiterhin nutzen, so müssen diese nach der Deinstallation neu
installiert werden. Dafür steht das Archiv
-\hrfn{https://github.com/tud-cd/tudscrold/releases/download/v1.0/TUD-KOMA-Script_v1.0old.zip}%
-{\File*{TUD-KOMA-Script\_v1.0old.zip}} bereit, welches sowohl die genannten
-Skripte zur Deinstallation als auch die zur neuerlichen Installation der
-veralteten Klassen benötigten \File{tudscr\_v1.0old\_install.bat} oder
-\File{tudscr\_v1.0old\_install.sh} enthält. Nach Abschluss des Vorgangs sind
-die alten Klassen der Version~v1.0 mit \Class{tudscrbookold},
-\Class{tudscrreprtold} und \Class{tudscrartclold} parallel zur aktuellen
-Version~\vTUDScript{} verwendbar.
+\hrfn{https://github.com/tud-cd/tudscrold/releases/download/v1.0/TUD-KOMA-Script_v1.0old.zip}{\File*{TUD-KOMA-Script\_v1.0old.zip}}
+bereit, welches sowohl die genannten Skripte zur Deinstallation als auch die
+zur neuerlichen Installation der veralteten Klassen benötigten
+\File{tudscr\_v1.0old\_install.bat} oder \File{tudscr\_v1.0old\_install.sh}
+enthält. Nach Abschluss des Vorgangs sind die alten Klassen der Version~v1.0
+mit \Class{tudscrbookold}, \Class{tudscrreprtold} und \Class{tudscrartclold}
+parallel zur aktuellen Version~\vTUDScript{} verwendbar.
Im Vergleich zur Version~v1.0 hat sich an der Benutzerschnittstelle nicht sehr
viel verändert. Treten nach dem Umstieg auf die Version~\vTUDScript{} dennoch
-Probleme auf, sollte der Anwender als erstes in die Beschreibung des Paketes
-\Package{tudscrcomp}'full'(tudscr) sehen, welches eine Schnittstelle zur
-Nutzung alter und ursprünglich nicht mehr vorgesehener Befehle sowie Optionen
-bereitstellt. Allerdings werden einige von diesen auch durch das Paket
-\Package{tudscrcomp}(tudscr) nicht mehr bereitgestellt. Aufgeführt sind diese
-in \autoref{sec:obsolete}. Sollten trotz aller Hinweise dennoch Fehler oder
-Probleme beim Umstieg auf die neue \TUDScript-Version auftreten, ist eine
-Meldung im \Forum die beste Möglichkeit, um Hilfe zu erhalten.
+Probleme auf, sollte der Anwender als erstes die Beschreibung des Paketes
+\Package{tudscrcomp}'full' lesen, welches eine Schnittstelle zur Nutzung alter
+und ursprünglich nicht mehr vorgesehener Befehle sowie Optionen bereitstellt.
+Allerdings werden einige von diesen auch durch das Paket \Package{tudscrcomp}
+nicht mehr bereitgestellt. Aufgeführt sind diese in \autoref{sec:obsolete}.
+Sollten trotz aller Hinweise dennoch Fehler oder Probleme beim Umstieg auf die
+neue \TUDScript-Version auftreten, ist eine Meldung im \Forum die beste
+Möglichkeit, um Hilfe zu erhalten.
\end{Declaration*}
\end{Declaration*}
\end{Declaration*}
@@ -294,21 +285,20 @@ Meldung im \Forum die beste Möglichkeit, um Hilfe zu erhalten.
\section{Installationshinweise für portable Installationen}
-\label{sec:install:portable}
-
+\tudhyperdef*{sec:install:portable}%
+%
Prinzipiell ist die Installation der PostScript-Schriften bei der Nutzung von
\Distribution{\hologo{TeX}~Live~Portable}|?| beziehungsweise
\Distribution{\hologo{MiKTeX}~Portable}|?| äquivalent zur nicht-portablen
Variante, welche in \autoref{sec:install} beschrieben wird. Alle dort gegebenen
-Hinweise sollten sorgfältig berücksichtigt werden. Darüberhinaus ist bei
+Hinweise sollten sorgfältig berücksichtigt werden. Darüber hinaus ist bei
\Distribution{\hologo{MiKTeX}~Portable} darauf zu achten, den Installationspfad
nicht unbedingt auf der obersten Verzeichnisebene des externen Speichermediums
zu wählen.
Zur Installation der Schriften des \CDs wird das Archiv
-\hrfn{https://github.com/tud-cd/tudscr/releases/download/fonts/TUD-KOMA-Script_fonts_Windows.zip}%
-{\File*{TUD-KOMA-Script\_fonts\_Windows.zip}} benötigt. Dieses kann entweder
-auf der lokalen Festplatte oder auf dem externen Speichermedium entpackt
-werden. Danach wird folgendes Vorgehen empfohlen:
+\hrfn{https://github.com/tud-cd/tudscr/releases/download/fonts/TUD-KOMA-Script_fonts_Windows.zip}{\File*{TUD-KOMA-Script\_fonts\_Windows.zip}}
+benötigt. Dieses kann entweder auf der lokalen Festplatte oder auf dem externen
+Speichermedium entpackt werden. Danach wird folgendes Vorgehen empfohlen:
\minisec{\NoCaseChange{\hologo{TeX}}~Live~Portable}
Das folgende Vorgehen wurde mit Windows getestet. Empfehlungen für die portable
@@ -317,8 +307,8 @@ gesendet werden.
\begin{enumerate}
\item Installation von \Distribution{\hologo{TeX}~Live~Portable} in den Pfad
\Path{\PName{Laufwerk}:\textbackslash texlive}
-\item Die Datei \File{tl-tray-menu.exe} im Installationspfad öffnen
-\item Im Infobereich der Taskleiste mit einem Rechtsklick auf das Symbol von
+\item Die Datei \File*{tl-tray-menu.exe} im Installationspfad öffnen
+\item Im Infobereich der Taskleiste mit einem Rechtsklick auf das Symbol von
\Distribution{\hologo{TeX}~Live~Portable} das Kontextmenü öffnen und ein
Update entweder über die grafische Oberfläche (\emph{Package Manager}) oder
die Kommandozeile (\emph{Command Prompt}) durchführen
@@ -338,7 +328,7 @@ gesendet werden.
\item Installation von \Distribution{\hologo{MiKTeX}~Portable} in den Pfad
\Path{\PName{Laufwerk}:\textbackslash LaTeX\textbackslash MiKTeXportable}
\item Die Datei \File{miktex-portable.cmd} im Installationspfad öffnen
-\item Im Infobereich der Taskleiste mit einem Rechtsklick auf das Symbol von
+\item Im Infobereich der Taskleiste mit einem Rechtsklick auf das Symbol von
\Distribution{\hologo{MiKTeX}~Portable} das Kontextmenü öffnen und ein Update
durchführen
\item Über das Kontextmenü die Kommandozeile starten und über diese das
@@ -352,10 +342,10 @@ gesendet werden.
Ein Ausführen ohne die über \Distribution{\hologo{MiKTeX}~Portable}
geöffnete Kommandozeile führt zu Fehlern.
}%
-\item Bei der erstmaligen Verwendung einer der \TUDScript-Dokumentklassen
- werden die Pakete \Package{tudscr}, \Package{koma-script},
- \Package{etoolbox}, \Package{textcase}, \Package{environ},
- \Package{trimspaces}, \Package{xcolor}, \Package{mptopdf}() durch
+\item Bei der erstmaligen Verwendung einer der \TUDScript-Klassen werden die
+ Pakete \Package*{tudscr}, \Package{koma-script}, \Package{etoolbox},
+ \Package{textcase}, \Package{environ}, \Package{trimspaces},
+ \Package{xcolor} sowie \Package{mptopdf}<> durch
\Distribution{\hologo{MiKTeX}~Portable} nachinstalliert, falls diese nicht
schon vorhanden sind und die automatische Nachinstallation von Paketen
aktiviert ist.
diff --git a/Master/texmf-dist/source/latex/tudscr/doc/tudscr-introduction.tex b/Master/texmf-dist/source/latex/tudscr/doc/tudscr-introduction.tex
index edfc805f953..a8dffc2b95c 100644
--- a/Master/texmf-dist/source/latex/tudscr/doc/tudscr-introduction.tex
+++ b/Master/texmf-dist/source/latex/tudscr/doc/tudscr-introduction.tex
@@ -1,5 +1,5 @@
\chapter{Einleitung}
-\index{Distribution}
+%
Zur fehlerfreien Verwendung der \TUDScript-Klassen der Version~\vTUDScript{}
werden sowohl die \KOMAScript"=Klassen~\vKOMAScript{} oder später als auch die
beiden Hausschriften des \CDs \Univers und \DIN zwingend benötigt. Außerdem
@@ -7,10 +7,11 @@ müssen weitere Pakete durch die genutzte \hologo{LaTeX}"=Distribution
bereitgestellt werden.
Bei den aktuellen Distributionen
-\Distribution{\hologo{TeX}~Live}[2015]|?|,
-\Distribution{Mac\hologo{TeX}}[2015]|?| und
+\index{Distribution}%
+\Distribution{\hologo{TeX}~Live}[2016]|?|,
+\Distribution{Mac\hologo{TeX}}[2016]|?| und
\Distribution{\hologo{MiKTeX}}[2.9]|?|
-ist das mit großer Sicherheit kein Problem. Nutzen Sie jedoch eine ältere
+ist das mit großer Sicherheit kein Problem. Nutzen Sie jedoch eine frühere
Distribution, könnte dies zu Problemen führen. Dann sollte bestenfalls eine der
aktuellen Distributionen installiert werden. Ist dies nicht möglich, müssen die
unter \autoref{sec:packages:needed} aufgeführten Pakete sowie \TUDScript
@@ -22,7 +23,7 @@ Allerdings beinhaltet dieses weitere Klassen zum Erstellen von Folien
und Briefen.%
\footnote{%
\Class{tudbook}, \Class{tudbeamer}, \Class{tudletter}, \Class{tudfax},
- \Class{tudhaus}, \Class{tudform}
+ \Class{tudhaus}, \Class{tudform}%
}
Das \TUDScript"=Bundle ist hauptsächlich für das Erstellen wissenschaftlicher
Texte und Arbeiten gedacht und soll die ursprünglichen Vorlagen \emph{momentan}
@@ -32,99 +33,104 @@ Eine Umsetzung des \CDs für die \Class{beamer}"=Klasse sowie für Briefe und
Geschäftsschreiben auf Basis der \KOMAScript"=Brief"=Klasse \Class{scrlttr2}
ist bis jetzt leider noch nicht entstanden, soll jedoch langfristig
bereitgestellt werden. Allerdings existieren bereits im Bundle
-\Class{tudmathposter} für die \Class{beamer}"=Klasse mehrere Stile. Dieses
-Bundle ist sowohl bei \hrfn{https://github.com/tud-cd/tud-cd}{GitHub} als
-auch auf der \hrfn{http://tu-dresden.de/service/publizieren/cd/4_latex}
-{\hologo{LaTeX}-Seite der \TnUD} zu finden.
+\Class{tudmathposter} für die \Class{beamer}"=Klasse mehrere Stile. Das Bundle
+ist sowohl bei \hrfn{https://github.com/tud-cd/tud-cd}{GitHub} als auf der
+\hrfn{https://tu-dresden.de/cd/4_latex}{\hologo{LaTeX}"=Seite der \TnUD} zu
+finden.
\section{Zur Verwendung dieses Handbuchs}
Sämtliche neu definierten Optionen, Umgebungen und Befehle der
\TUDScript-Klassen und \TUDScript-Pakete werden im Handbuch aufgeführt und
-beschrieben. Am Ende des Dokumentes befinden sich mehrere Indizes, die das
+beschrieben. Am Ende des Dokumentes befinden sich mehrere Indexe, die das
Nachschlagen oder Auffinden von bisher unbekannten Befehlen oder Optionen
erleichtern sollen.
Die im Folgenden beschriebenen Optionen können~-- wie ein Großteil aller
Einstellungen für \KOMAScript~-- in der Syntax des \Package{keyval}"=Paketes
als Schlüssel"=Wert"=Paare bei der Wahl der Dokumentklasse angegeben werden:
-\Macro*{documentclass}\POParameter{\PName{Schlüssel}\PValue{=}\PName{Wert}}%
-\Parameter{Klasse}.
+\Macro*{documentclass}[%
+ \POParameter{\PName{Schlüssel}\PValue{=}\PName{Wert}}\Parameter{Klasse}%
+]
Des Weiteren eröffnen die \KOMAScript"=Klassen die Möglichkeit der späten
Optionenwahl. Damit können Optionen nicht nur direkt beim Laden als sogenannte
Klassenoptionen angegeben werden, sondern lassen sich auch noch innerhalb des
Dokumentes nach dem Laden der Klasse ändern. Die \KOMAScript"=Klassen sehen
-hierfür zwei Befehle vor. Mit \Macro{KOMAoptions}\Parameter{Optionenliste}
-kann man beliebig vielen Schlüsseln jeweils genau einen Wert zuweisen,
-\Macro{KOMAoption}\Parameter{Option}\Parameter{Werteliste} erlaubt das
-gleichzeitige Setzen mehrere Werte für genau einen Schlüssel. Äquivalent
-dazu werden für die \emph{zusätzlichen} Optionen der \TUDScript-Klassen mit
-die Befehle \Macro{TUDoptions}\Parameter{Optionenliste} und
-\Macro{TUDoption}\Parameter{Option}\Parameter{Werteliste} definiert. Damit kann
-das Verhalten von Optionen im Dokument~-- innerhalb einer Gruppe auch lokal~--
-geändert werden.
-
-Die Voreinstellung einer jeden Option wird durch \PValue{preset:\,}\PName{Wert}
-bei deren Beschreibung angeführt. Einige dieser Standardwerte sind nicht immer
-gleich sondern werden in Abhängigkeit der genutzten Benutzereinstellungen und
-Optionen gesetzt. Diese bedingten Voreinstellungen werden durch
-\PValue{preset:\,}\PName{Wert}\PValue{\,|\,}\PName{Bedingung}\PValue{:\,}%
-\PName{bedingter~Wert} angegeben. Jedem Schlüssel wird normalerweise durch den
-Benutzer ein gewünschter, gültiger Wert zugewiesen. Wird ein Schlüssel jedoch
-ohne Wertzuweisung genutzt, so wird~-- falls vorhanden~-- ein vordefinierter
-Säumniswert gesetzt, welcher in der Beschreibung der einzelnen Optionen durch
-die \PValue{\emph{kursive}} Schreibweise gekennzeichnet ist. In den meisten
-Fällen ist der Säumniswert eines Schlüssels \PValue{true}, er entspricht
-folglich der Angabe \PName{Schlüssel}\PValue{=true}. Mit der expliziten
-Wertzuweisung eines Schlüssels durch den Benutzer werden immer sowohl normale
-als auch bedingte Voreinstellungen überschrieben. Die neben den Optionen neu
-eingeführten Befehle und Umgebungen der Klassen werden im gleichen Stil
-erläutert.
+hierfür zwei Befehle vor. Mit
+\Macro{KOMAoptions}[\Parameter{Optionenliste}](\Package{koma-script})'none'
+lassen sich beliebig viele Schlüsseln jeweils genau einen Wert zuweisen,
+\Macro{KOMAoption}[%
+ \Parameter{Option}\Parameter{Werteliste}%
+](\Package{koma-script})'none'
+erlaubt das gleichzeitige Setzen mehrere Werte für genau einen Schlüssel.
+Äquivalent dazu werden für die von \TUDScript \emph{zusätzlich} zur Verfügung
+gestellten Optionen die Befehle \Macro{TUDoptions}[\Parameter{Optionenliste}]
+und \Macro{TUDoption}[\Parameter{Option}\Parameter{Werteliste}] definiert.
+Damit kann das Verhalten von Optionen im Dokument~-- innerhalb einer Gruppe
+auch lokal~-- geändert werden.
+
+Die Voreinstellung jeder Option wird mit \enquote{Standardwert:\,\PName{Wert}}
+bei deren Beschreibung angeführt. Einige dieser Voreinstellungen sind nicht
+immer gleich sondern werden in Abhängigkeit der genutzten Benutzereinstellungen
+und Optionen gesetzt. Diese bedingten Voreinstellungen werden durch
+\enquote{%
+ Standardwert:\,\PName{Wert}%
+ \PValue{\,|\,}Bedingung:\,\PName{bedingter~Wert}%
+}
+angegeben. Wird ein Schlüssel durch den Benutzer \emph{ohne} eine Wertzuweisung
+genutzt, so wird~-- falls vorhanden~-- ein vordefinierter Säumniswert gesetzt,
+welcher in der Beschreibung aller Optionen durch die~\PValue{\emph{kursive}}
+Schreibweise innerhalb der Werteliste gekennzeichnet ist. In den meisten Fällen
+ist der Säumniswert eines Schlüssels \PValue{true}, er entspricht folglich der
+Angabe \PName{Schlüssel}\PValue{=true}. Mit der expliziten Wertzuweisung eines
+Schlüssels durch den Benutzer werden immer sowohl normale als auch bedingte
+Voreinstellungen überschrieben. Die neben den Optionen neu eingeführten Befehle
+und Umgebungen der Klassen werden im gleichen Stil erläutert.
\section{Installation des \TUDScript-Bundles}
-\label{sec:install}%
-\index{Installation}\index{Update}%
+\tudhyperdef*{sec:install}%
+\index{Installation|!(}%
+\index{Update}%
%
\ChangedAt{%
- v2.01!\TUDScript-Bundle auf CTAN veröffentlicht,%
- v2.02!Installationsroutine der PostScript-Schriften angepasst,%
- v2.04!Installationsskripte robuster und verbessert und für die portablen
- Distributionen \Distribution*{\hologo{TeX}~Live~Portable} sowie
- \Distribution*{\hologo{MiKTeX}~Portable} erweitert
+ v2.01:\TUDScript-Bundle auf CTAN veröffentlicht;%
+ v2.02:Installationsroutine der PostScript-Schriften angepasst;%
+ v2.04:Installationsskripte verbessert und robuster gestaltet sowie für die
+ beiden portablen Distributionen \Distribution*{\hologo{TeX}~Live~Portable}
+ und \Distribution*{\hologo{MiKTeX}~Portable} erweitert
}
%
Das \TUDScript-Bundle ist seit der Version~v2.01~-- aufgrund lizenzrechtlicher
-Bedingungen \emph{ohne} die geschützten Schriften \Univers und \DIN~-- im
-\foreignlanguage{english}{%
- \hrfn{http://www.ctan.org/}{Comprehensive TeX Archive Network (CTAN)}
-} zu finden und kann dadurch die aktuellen \hologo{LaTeX}"=Distributionen wie
-\Distribution{\hologo{TeX}~Live}[2015]|?|,
-\Distribution{Mac\hologo{TeX}}[2015]|?| oder auch
+Bedingungen \emph{ohne} die geschützten Schriften \Univers und \DIN~-- im \CTAN
+zu finden und kann dadurch die aktuellen \hologo{LaTeX}"=Distributionen wie
+\Distribution{\hologo{TeX}~Live}[2016]|?|,
+\Distribution{Mac\hologo{TeX}}[2016]|?| oder auch
\Distribution{\hologo{MiKTeX}}[2.9]|?| genutzt werden. Es besteht momentan aus
den drei Hauptklassen \Class{tudscrbook}, \Class{tudscrreprt} sowie
\Class{tudscrartcl}~-- dokumentiert in \autoref{sec:mainclasses}~-- und sowohl
mit den \TUDScript-Klassen assoziierten als auch eigenständigen Paketen, welche
in \autoref{sec:bundle} beschrieben sind.
-Zur problemlosen Verwendung des \TUDScript-Bundles ist~-- neben \KOMAScript{} in
-der Version~\vKOMAScript und den in \autoref{sec:packages:needed} aufgeführten
-\hologo{LaTeX}-Paketen~-- lediglich eine Installation der PostScript"=Schriften
-des \CDs der \TnUD notwendig. Diese müssen über das Universitätsmarketing auf
-\hrfn{http://tu-dresden.de/service/publizieren/cd/1_basiselemente/03_hausschrift/schriftbestellung.html}%
-{Anfrage} mit dem Hinweis auf die Verwendung von \hologo{LaTeX} bestellt
-werden. Sobald Sie die notwendigen Archive \File{Univers\_PS.zip} und
-\File{DIN\_Bd\_PS.zip} erhalten haben, können die Schriften für Windows
-(\autoref{sec:install:win}) beziehungsweise unixoide Betriebssysteme
-(\autoref{sec:install:unix}) installiert werden. Die benötigten Skripte
-werden als \hrfn{https://github.com/tud-cd/tudscr/releases/tag/fonts}{Release}
+Zur problemlosen Verwendung des \TUDScript-Bundles ist~-- neben \KOMAScript{}
+mindestens in der Version~\vKOMAScript{} sowie den in
+\autoref{sec:packages:needed} aufgeführten \hologo{LaTeX}"=Paketen~-- lediglich
+eine Installation der PostScript"=Schriften des \TUDCDs notwendig. Diese müssen
+über das Universitätsmarketing auf
+\hrfn{https://tu-dresden.de/cd/1_basiselemente/03_hausschrift/}{Anfrage} mit
+dem Hinweis auf die Verwendung von \hologo{LaTeX} bestellt werden. Sobald Sie
+die notwendigen Archive \File{Univers\_PS.zip} und \File{DIN\_Bd\_PS.zip}
+erhalten haben, können die Schriften für Windows (\autoref{sec:install:win})
+beziehungsweise unixoide Betriebssysteme (\autoref{sec:install:unix})
+installiert werden. Die benötigten Skripte werden als
+\hrfn{https://github.com/tud-cd/tudscr/releases/tag/fonts}{Release}
im \GitHubRepo* bereitgestellt.%
\footnote{%
Die Verwendung von installierten Systemschriften im Open-Type-Format mit dem
- Paket \Package{fontspec} für \hologo{LuaLaTeX} oder \hologo{XeLaTeX} wird
+ Paket \Package{fontspec} für \Engine{LuaLaTeX} oder \Engine{XeLaTeX} wird
mittlerweile unterstützt, mehr dazu in \autoref{sec:fonts:fontspec}.%
}
@@ -168,17 +174,17 @@ Installation von \Distribution{\hologo{MiKTeX}}|?| in der Mehrbenutzervariante
mit Administratorrechten durchzuführen, da die Einzelbenutzervariante relativ
unregelmäßig und nicht immer nachvollziehbar zu Problemen führen kann.
-Es kann vorkommen, dass die für den Schriftinstallationsprozess notwendigen
+Möglicherweise sind einige der für den Schriftinstallationsprozess notwendigen
Pakete \Package{fontinst}, \Package{fontware} sowie \Package{cmbright},
\Package{hfbright}, \Package{cm-super}, \Package{lmodern} und \Package{iwona}
-noch nicht installiert sind. Ist die automatische Nachinstallation fehlender
-Pakete aktiviert, so reicht es im Normalfall das Installationsskript zu
-starten. Andernfalls müssen diese Pakete manuell durch den Benutzer über den
-\Distribution{\hologo{MiKTeX}}-Paketmanager hinzugefügt werden.
+noch nicht installiert. Ist die automatische Nachinstallation fehlender Pakete
+aktiviert, so reicht es im Normalfall das Installationsskript zu starten.
+Andernfalls müssen diese Pakete manuell durch den Benutzer über den
+\Distribution{\hologo{MiKTeX}}"=Paketmanager hinzugefügt werden.
Das Installationsskript scheitert außerdem bei einigen Anwendern~-- aufgrund
eingeschränkter Nutzerzugriffsrechte~-- beim Eintragen der Schriften in die
-Map-Datei. Dies muss gegebenenfalls durch den Anwender über die Kommandozeile
+Map"~Datei. Dies muss gegebenenfalls durch den Anwender über die Kommandozeile
\Path{initexmf -{}-edit-config-file updmap} erfolgen. In der sich öffnenden
Datei sollte sich der Eintrag \Path{Map tudscr.map} befinden. Ist dies nicht
der Fall, muss diese Zeile manuell eingetragen und die Datei anschließend
@@ -193,32 +199,31 @@ Für den Schriftinstallationsprozess werden die Pakete \Package{fontinst},
\Package{fontware} sowie \Package{cmbright}, \Package{hfbright},
\Package{cm-super}, \Package{lmodern} und \Package{iwona} benötigt. Sollte
keine Vollinstallation von \Distribution{\hologo{TeX}~Live} durchgeführt worden
-sein, müssen diese Pakete sehr aller Voraussicht nach manuell durch den
-Benutzer über den \Distribution{\hologo{TeX}~Live}-Paketmanager hinzugefügt
-werden.
-
-Sollte das Installationsskript fehlerfrei durchlaufen, die Schriften dennoch
-nicht verfügbar sein, so kann man mit \Path{updmap-sys -{}-syncwithtrees}
-die Synchronisierung aller Schriftdateien anstoßen. Anschließend sollte man
-\Path{updmap-sys -{}-enable Map=tudscr.map} und \Path{updmap-sys -{}-force}
-aufrufen. Sind die Schriften danach immer noch nicht verfügbar, so wurden auf
-dem System bestimmt schon andere Schriften lokal installiert. In diesem Fall
+sein, müssen diese Pakete sehr wahrscheinlich manuell durch den Benutzer über
+den \Distribution{\hologo{TeX}~Live}"=Paketmanager hinzugefügt werden.
+
+Sind nach einem fehlerfreien Durchlauf des Installationsskriptes die Schriften
+dennoch nicht verfügbar, so lässt sich mit \Path{updmap-sys -{}-syncwithtrees}
+die Synchronisierung aller Schriftdateien anstoßen. Daran anschließend muss mit
+\Path{updmap-sys -{}-enable Map=tudscr.map} die Map"~Datei und die dazugehörigen
+Schriftdateien mit \Path{updmap-sys -{}-force} registriert werden.
+
+Sind die Schriften danach immer noch nicht verfügbar, so wurden bestimmt schon
+weitere Schriften auf dem System \emph{lokal} installiert. In diesem Fall
sollte der Vorgang nochmals für eine lokale Schriftinstallation mit
\Path{updmap -{}-syncwithtrees}, \Path{updmap -{}-enable Map=tudscr.map} und
-\Path{updmap -{}-force} ausgeführt werden.
-
-Dieses Vorgehen macht den Befehl \Path{updmap-sys} allerdings von nun an
-wirkungslos. Erfolgt danach eine systemweite Installation neuer Schriften~--
-beispielsweise bei der Aktualisierung der Distribution~-- müssen diese über den
-manuellen Aufruf von \Path{updmap} zukünftig durch den Anwender lokal bei
-\Distribution{\hologo{TeX}~Live}|?| respektive \Distribution{Mac\hologo{TeX}}|?|
-registriert werden.
+\Path{updmap -{}-force} ausgeführt werden. Dieses Vorgehen macht allerdings den
+Befehl \Path{updmap-sys} von nun an wirkungslos. Nach einer systemweiten
+Installation neuer Schriften~-- beispielsweise bei der Aktualisierung der
+Distribution~-- müssen diese über den manuellen Aufruf von \Path{updmap}
+zukünftig durch den Anwender lokal bei \Distribution{\hologo{TeX}~Live}|?|
+respektive \Distribution{Mac\hologo{TeX}}|?| registriert werden.
\Attention{%
Für die Schriftinstallation werden die Skripte \Path{tftopl}, \Path{pltotf}
und \Path{vptovf} benötigt, welche bei \Distribution{\hologo{TeX}~Live}|?|
beziehungsweise \Distribution{Mac\hologo{TeX}}|?| über das Paket
- \Package*{fontware}() aus \Package*{collection-fontutils}()
+ \Package*{fontware} aus \Package*{collection-fontutils}<>
bereitgestellt werden und zwingend installiert sein müssen.
}
@@ -236,30 +241,29 @@ Soll eine bereits vorhandene, lokale Nutzerinstallation aktualisiert werden,
finden Sie die entsprechenden Skripte in \autoref{sec:local:update}.
Für die portablen Varianten von \Distribution{\hologo{TeX}~Live~Portable}
-repsektive \Distribution{\hologo{MiKTeX}~Portable} sind zusätzliche
+respektive \Distribution{\hologo{MiKTeX}~Portable} sind zusätzliche
Installationshinweise in \autoref{sec:install:portable} zu finden.
\subsection{Installation der PostScript-Schriften unter Windows}
-\label{sec:install:win}
-\index{Installation!Schriften}
+\tudhyperdef*{sec:install:win}%
%
Zur Installation der Schriften des \CDs für das \TUDScript-Bundle ist das Archiv
-\hrfn{https://github.com/tud-cd/tudscr/releases/download/fonts/TUD-KOMA-Script_fonts_Windows.zip}%
-{\File*{TUD-KOMA-Script\_fonts\_Windows.zip}} vorgesehen. Dieses ist sowohl für
-\Distribution{\hologo{TeX}~Live}|?| als auch \Distribution{\hologo{MiKTeX}}|?|
-nutzbar und enthält~-- bis auf die Schriftarchive selbst~-- alle benötigten
-Dateien. Diese sollten nach dem Entpacken des Archivs in das gleiche
-Verzeichnis kopiert werden. Vor der Verwendung des Skripts
-\File{tudscrfonts\_install.bat} sollte sichergestellt werden, dass sich
-\emph{alle} der folgenden Dateien im selben Verzeichnis befinden:
+\hrfn{https://github.com/tud-cd/tudscr/releases/download/fonts/TUD-KOMA-Script_fonts_Windows.zip}{\File*{TUD-KOMA-Script\_fonts\_Windows.zip}}
+vorgesehen. Dieses ist sowohl für \Distribution{\hologo{TeX}~Live}|?| als auch
+\Distribution{\hologo{MiKTeX}}|?| nutzbar und enthält~-- bis auf die jeweiligen
+Schriftarchive selbst~-- alle benötigten Dateien. Diese sollten nach dem
+Entpacken des Archivs in das gleiche Verzeichnis kopiert werden. Vor der
+Verwendung des Skripts \File{tudscrfonts\_install.bat} sollte sichergestellt
+werden, dass sich \emph{alle} der folgenden Dateien im selben Verzeichnis
+befinden:
%
\settowidth\tempdim{\File{tudscrfonts\_install.bat}}%
\begin{description}[labelwidth=\tempdim,labelsep=1em]
\item[\File{tudscrfonts\_install.bat}]Installationsskript
\item[\File{Univers\_PS.zip}]Archiv mit Schriftdateien für \Univers
\item[\File{DIN\_Bd\_PS.zip}]Archiv mit Schriftdateien für \DIN
- \item[\File{tudscrfonts.zip}]Archiv mit Metriken für die
+ \item[\File{tudscr\_fonts\_install.zip}]Archiv mit Metriken für die
Schriftinstallation via \Package{fontinst}
\end{description}
%
@@ -271,20 +275,20 @@ der \emph{für alle Nutzer} gültig und lesbar ist.
\subsection{Installation der PostScript-Schriften unter Linux und OS~X}
-\label{sec:install:unix}
-\index{Installation!Schriften}
+\tudhyperdef*{sec:install:unix}%
+%
Für die Erstellung des Installationsskripts für Linux und OS~X geht mein Dank
an Jons-Tobias Wamhoff, der sich für die erstmalige Portierung des Skripts
von Windows zu unixartigen Systemen freiwillig zur Verfügung stellte.
Zur Installation der Schriften des \CDs für das \TUDScript-Bundle ist das Archiv
-\hrfn{https://github.com/tud-cd/tudscr/releases/download/fonts/TUD-KOMA-Script_fonts_Unix.zip}%
-{\File*{TUD-KOMA-Script\_fonts\_Unix.zip}} vorgesehen. Dieses ist sowohl für
-\Distribution{\hologo{TeX}~Live}|?| als auch \Distribution{Mac\hologo{TeX}}|?|
-nutzbar und enthält~-- bis auf die Schriftdateien selbst~-- alle benötigten
-Dateien. Diese sollten nach dem Entpacken des Archivs in das gleiche
-Verzeichnis kopiert werden. Vor der Verwendung des Skripts
-\File{tudscrfonts\_install.sh} sollte sichergestellt werden, dass sich
-\emph{alle} der folgenden Dateien im selben Verzeichnis befinden:
+\hrfn{https://github.com/tud-cd/tudscr/releases/download/fonts/TUD-KOMA-Script_fonts_Unix.zip}{\File*{TUD-KOMA-Script\_fonts\_Unix.zip}}
+ vorgesehen. Dieses ist sowohl für \Distribution{\hologo{TeX}~Live}|?| als auch
+\Distribution{Mac\hologo{TeX}}|?| nutzbar und enthält~-- bis auf die jeweiligen
+Schriftdateien selbst~-- alle benötigten Dateien. Diese sollten nach dem
+Entpacken des Archivs in das gleiche Verzeichnis kopiert werden. Vor der
+Verwendung des Skripts \File{tudscrfonts\_install.sh} sollte sichergestellt
+werden, dass sich \emph{alle} der folgenden Dateien im selben Verzeichnis
+befinden:
%
\settowidth\tempdim{\File{tudscrfonts\_install.sh}}%
\begin{description}[labelwidth=\tempdim,labelsep=1em]
@@ -292,7 +296,7 @@ Verzeichnis kopiert werden. Vor der Verwendung des Skripts
(Terminal: \Path{bash tudscrfonts\_install.sh})
\item[\File{Univers\_PS.zip}]Archiv mit Schriftdateien für \Univers
\item[\File{DIN\_Bd\_PS.zip}]Archiv mit Schriftdateien für \DIN
- \item[\File{tudscrfonts.zip}]Archiv mit Metriken für die
+ \item[\File{tudscr\_fonts\_install.zip}]Archiv mit Metriken für die
Schriftinstallation via \Package{fontinst}
\end{description}
%
@@ -307,7 +311,18 @@ erfolgt die Installation \emph{für alle Nutzer} in den lokalen Systempfad
-\subsection{Probleme bei der Installation der PostScript-Schriften}
+\subsection*{Probleme bei der Installation der PostScript-Schriften}
+%
+Wird Windows verwendet, kann es unter Umständen vorkommen, dass notwendige
+Befehlsaufrufe für das Installationsskript nicht ausgeführt werden können. In
+diesem Fall ist der Pfad zu den benötigten Dateien, welche normalerweise unter
+\Path{\%SystemRoot\%\textbackslash System32} zu finden sind, nicht in der
+Umgebungsvariable \Path{PATH} enthalten. Einen Hinweis zur Problemlösung ist
+\hrfn{http://latex.wcms-file3.tu-dresden.de/phpBB3/viewtopic.php?t=359}{%
+ in diesem Beitrag im Forum%
+}
+zu finden.
+
Treten bei der Installation wider Erwarten Probleme auf, so sollte eine
Logdatei erstellt werden. Unter Windows muss das Skript, welches Probleme
verursacht, aus der Kommandozeile mit
@@ -316,7 +331,7 @@ doppelte Betätigen der Eingabetaste nötig ist. Für unixartige Systeme
ist der Aufruf \Path{bash \PName{Skript}.sh > \PName{Skript}.log} aus dem
Terminal heraus zu verwenden. Die erstellte Logdatei kann mit einer kurzen
Fehlerbeschreibung direkt an \Email{\tudscrmail} gesendet werden.
-
+\index{Installation|!)}%
\section{Schnelleinstieg}
@@ -326,12 +341,12 @@ Umgebungen und Befehle, die über die Funktionalität von \KOMAScript{}
hinausgehen, erläutert. \autoref{part:additional} enthält zum einen einfache
Minimalbeispiele, um den prinzipiellen Umgang und die Funktionalitäten von
\TUDScript zu demonstrieren. Zum anderen werden hier auch ausführliche und
-dokumentierte Tutorials vor allem für \hologo{LaTeX}-Neulinge angeboten.
+dokumentierte Tutorials vor allem für \hologo{LaTeX}"=Neulinge angeboten.
Insbesondere das Tutorial \Tutorial{treatise} ist mehr als einen Blick wert,
wenn eine wissenschaftliche Arbeit mit \hologo{LaTeXe} verfasst werden soll.
Abschließend werden verschiedenste Pakete vorgestellt, die nicht speziell für
-das \TUDScript-Bundle selber sondern auch für andere \hologo{LaTeX}-Klassen
-verwendet werden können und demzufolge für alle \hologo{LaTeX}-Anwender
+das \TUDScript-Bundle selber sondern auch für andere \hologo{LaTeX}"=Klassen
+verwendet werden können und demzufolge für alle \hologo{LaTeX}"=Anwender
interessant sein könnten. Außerdem werden hier einige Tipps \& Tricks beim
Umgang mit \hologo{LaTeX} beschrieben, um kleinere oder größere Probleme zu
lösen.
@@ -340,6 +355,6 @@ Die Klassen \Class{tudscrbook}, \Class{tudscrreprt} und \Class{tudscrartcl}
sind Wrapper"=Klassen der bekannten \KOMAScript-Klassen \Class{scrbook},
\Class{scrreprt} sowie \Class{scrartcl} und können einfach anstelle deren
verwendet werden. Auf diesen basierende Dokumente können durch das Umstellen
-der Dokumentklasse einfach in das \CD der \TnUD überführt werden. Bei
-Fragestellungen bezüglich Layout, Schriften oder ähnlichem ist in jedem Fall
-ein weiterer Blick in das hier vorliegende Handbuch empfehlenswert.
+der Dokumentklasse einfach in das \TUDCD überführt werden. Bei Fragestellungen
+bezüglich Layout, Schriften oder ähnlichem ist in jedem Fall ein weiterer Blick
+in das hier vorliegende Handbuch empfehlenswert.
diff --git a/Master/texmf-dist/source/latex/tudscr/doc/tudscr-mainclasses.tex b/Master/texmf-dist/source/latex/tudscr/doc/tudscr-mainclasses.tex
index eb3ef15258c..68d2dcd05ab 100644
--- a/Master/texmf-dist/source/latex/tudscr/doc/tudscr-mainclasses.tex
+++ b/Master/texmf-dist/source/latex/tudscr/doc/tudscr-mainclasses.tex
@@ -1,14 +1,18 @@
-\chapter[Die Klassen tudscrbook, tudscrreprt und tudscrartcl]{Die Hauptklassen}
-\label{sec:mainclasses}
+\chapter[%
+ Die Hauptklassen \Class*{tudscrbook}, \Class*{tudscrreprt} und
+ \Class*{tudscrartcl}%
+]{Die Hauptklassen}
+\tudhyperdef*{sec:mainclasses}%
+\index{Hauptklassen|!}%
+%
\ChangedAt*{%
- v2.00!Robustheit vieler Befehle und Optionen erhöht,%
- v2.02!Umbenennung einiger Befehle für Kompatibilität mit anderen Paketen,%
- v2.03!Anpassungen interner Befehle an \KOMAScript-Version~v3.15%
+ v2.02:Umbenennung einiger Befehle für Kompatibilität mit anderen Paketen;%
+ v2.03:Anpassungen interner Befehle an \KOMAScript-Version~v3.15%
}
+%
\begin{Declaration*}{\Class{tudscrbook}}
\begin{Declaration*}{\Class{tudscrreprt}}
\begin{Declaration*}{\Class{tudscrartcl}}
-\index{Hauptklassen|!}
Es werden die drei neuen Hauptklassen
%
\begin{description}
@@ -17,40 +21,46 @@ Es werden die drei neuen Hauptklassen
\item \Class{tudscrartcl}
\end{description}
%
-eingeführt, welche auf den \KOMAScript-Klassen basieren und grundsätzlich alle
-deren Optionen, Umgebungen und Befehle~-- beispielsweise \Option{parskip} für
-die Absatzeinstellungen oder \Option{BCOR} zur Festlegung der Bindekorrektur~--
-unterstützen. Zusätzlich zu den \KOMAScript"=Klassen werden weitere Pakete
-zwingend benötigt, welche unter \autoref{sec:packages:needed} aufgeführt sind
-und auf jeden Fall durch \TUDScript geladen werden.
-
-Es sei hier abermals auf die Anwenderdokumentation \scrguide von \KOMAScript{}
+eingeführt, welche auf den \KOMAScript-Klassen basieren und grundsätzlich alle
+deren Optionen~-- beispielsweise
+\Option{parskip=\PName{Methode}}(\Package{koma-script})'none' für die
+Absatzeinstellungen oder
+\Option{BCOR=\PName{Längenwert}}(\Package{typearea})'none' zur Festlegung der
+Bindekorrektur~-- sowie Umgebungen und Befehle unterstützen. Zusätzlich zu den
+\KOMAScript"=Klassen werden weitere Pakete zwingend benötigt, welche unter
+\autoref{sec:packages:needed} aufgeführt sind und auf jeden Fall durch
+\TUDScript geladen werden.
+
+Es sei hier abermals auf die \scrguide[Anwenderdokumentation von \KOMAScript]
hingewiesen, viele der folgend beschriebenen Befehle und Optionen beziehen sich
auf die darin vorgestellten Einstellungsmöglichkeiten. Die Anpassungen und
Erweiterungen der \KOMAScript"=Klassen an das \CD und die neu definierten
beziehungsweise geänderten Befehle und Optionen werden im Folgenden erläutert.
-\end{Declaration*}
-\end{Declaration*}
-\end{Declaration*}
-\begin{Declaration}{\Macro{TUDoptions}\Parameter{Optionenliste}}
-\begin{Declaration}{\Macro{TUDoption}\Parameter{Option}\Parameter{Werteliste}}
+\begin{Declaration}{\Macro{TUDoptions}[\Parameter{Optionenliste}]}
+\begin{Declaration}{\Macro{TUDoption}[\Parameter{Option}\Parameter{Werteliste}]}
\printdeclarationlist%
\index{Optionen|!}%
%
-Mit diesen Befehlen hat man bei den meisten der neuen Klassenoptionen die
-Möglichkeit, den Wert der Optionen noch nach dem Laden der Klasse zu ändern.
-Man kann wahlweise mit der Anweisung \Macro{TUDoptions} die Werte einer Reihe
-von Optionen ändern. Jede Option der Optionenliste hat dabei die Form
-\PName{Option}\PValue{=}\PName{Wert}. Die meisten Optionen besitzen auch einen
-Säumniswert\footnote{engl.: default value}. Versäumt man die Angabe eines
-Wertes~-- verwendet demzufolge einfach die Form \PName{Option}~-- so wird
-automatisch dieser Säumniswert angenommen.
-
-Manche Optionen können gleichzeitig mehrere Werte besitzen. Für diese besteht
-die Möglichkeit, mit \Macro{TUDoption} der einen Option nacheinander eine
-Reihe von Werten zuzuweisen. Die einzelnen Werte sind dabei in der Werteliste
-durch Komma voneinander getrennt.
+Mit diesen beiden Befehlen besteht für die meisten der neuen Klassen- respektive
+Paketoptionen die Möglichkeit, den Wert der Optionen noch nach dem Laden der
+Klasse beziehungsweise des Paketes zu ändern. Sie sind das Äquivalent zu den
+beiden \KOMAScript-Befehlen \Macro{KOMAoptions}(\Package{koma-script})'none'
+beziehungsweise \Macro{KOMAoption}(\Package{koma-script})'none'.
+
+Man kann wahlweise mit der Anweisung \Macro{TUDoptions} die Werte mehrerer
+Optionen gleichzeitig ändern, wobei diese durch Kommata zu trennen sind. Dabei
+muss innerhalb der Optionenliste jede zu ändernde Option in der Form
+\PName{Option}\PValue{=}\PName{Wert} angegeben werden. Die meisten der
+\TUDScript-Optionen besitzen auch einen Standard- beziehungsweise Säumniswert.
+Sollte die Angabe eines Wertes versäumt werden~-- es wird einfach die Form
+\PName{Option} verwendet~-- so wird der Option der gegebenenfalls vorgesehene
+Säumniswert zugewiesen.
+
+Manche Optionen können gleichzeitig mehrere, sich ergänzende Werte besitzen.
+Für diese besteht die Möglichkeit, mit \Macro{TUDoption} einer einzelnen Option
+nacheinander eine Reihe von Werten zuzuweisen, wobei diese in der Werteliste
+durch Komma voneinander zu trennen sind.
Mit diesen beiden Befehlen kann im Bedarfsfall das Verhalten von einer Option
oder mehreren Optionen im Dokument geändert werden. Werden diese Befehle in
@@ -62,20 +72,34 @@ innerhalb dieser lokal begrenzt.
\section{Die Schriften des \CDs}
-\label{sec:fonts}
-\index{Schrift|?(}
+\tudhyperdef*{sec:fonts}%
+\index{Schriftart|?(}%
%
\ChangedAt*{%
- v2.00!Schriften~-- insbesondere für den mathematischen Satz~-- verbessert,%
- v2.01!Unterschneidung (Kerning) der Ziffern für \Univers verbessert%
+ v2.00:Schriften~-- insbesondere für den mathematischen Satz~-- verbessert;%
+ v2.01:Unterschneidung (Kerning) der Ziffern für \Univers verbessert%
}
-Das \CD der \TnUD gibt die Verwendung der Schriften \Univers für den Fließtext
+%
+Das \TUDCD gibt die Verwendung der Schriften \Univers für den Fließtext
sowie \DIN für das Setzen von Überschriften vor, was durch \TUDScript in der
Standardkonfiguration auch so umgesetzt wird. Da jedoch in längeren Texten die
Verwendung von Serifenschriften zu empfehlen ist, gibt es die Möglichkeit, die
ursprünglich vorgesehenen Schriften des \CDs nicht zu laden und stattdessen die
-\hologo{LaTeX}-Standardschriften beziehungsweise ein anderes Schriftpaket zu
-verwenden. Die Erläuterungen dazu sind in \autoref{sec:text} zu finden.
+\hologo{LaTeX}"=Standardschriften beziehungsweise ein anderes Schriftpaket zu
+verwenden. Die Erläuterungen dazu sind in \autoref{sec:text} zu finden. Zur
+Verwendung der Schriften mit \hologo{LaTeXe}"=Klassen, welche nicht zum
+\TUDScript-Bundle gehören, lässt sich das Paket \Package{tudscrfonts} laden.
+
+\ChangedAt{%
+ v2.02;%
+ v2.04:Einfachere Verwendung des Paketes \Package{fontspec}%
+}
+Normalerweise kommen die Schriften des \CDs im PostScript"=Format zum Einsatz,
+wenn diese wie unter \autoref{sec:install} beschrieben installiert wurden.
+Wird entweder \Engine{LuaLaTeX} oder \Engine{XeLaTeX} als Textsatzsystem
+verwendet und das Paket \Package{fontspec} geladen, so werden die Schriften des
+\CDs im OpenType"=Format verwendet. Hierfür sind die Hinweise in
+\fullref{sec:fonts:fontspec} unbedingt zu beachten.
Durch das \CD werden keine Schriften für den Mathematiksatz festgelegt. Das ist
insbesondere für sowohl mathematische Abhandlungen als auch ingenieur- und
@@ -87,7 +111,7 @@ werden.%
\Package{iwona} für die Schrift \DIN und zusätzlich \Package{cmbright} für
die \Univers"=Schriftfamilie%
}
-Diese Grundeinstellung lässt sich ebenfalls deaktivieren, wodurch die
+Diese Einstellung lässt sich im Bedarfsfall deaktivieren, wodurch die
Standardschriften oder gegebenenfalls die eines zusätzlich geladenen Paketes
für den mathematischen Satz genutzt werden. Die dafür relevanten Einstellungen
werden in \autoref{sec:math} erläutert. In \autoref{sec:exmpl:mathtype} sowie
@@ -95,21 +119,74 @@ werden in \autoref{sec:math} erläutert. In \autoref{sec:exmpl:mathtype} sowie
Mathematiksatz zu finden.
+\subsection{Die Schriften des \CDs im PostScript-Format}
+\index{PostScript-Schriften}%
+%
+Für die bei \hologo{LaTeXe} gebräuchliche Verwendung der PostScript-Schriften
+ist lediglich die in \fullref{sec:install} beschriebene Installation notwendig.
+Geht diese reibungslos vonstatten, kann \TUDScript problemlos genutzt werden.
+
+
+
+\subsection{Die Schriften des \CDs im OpenType-Format}
+\tudhyperdef*{sec:fonts:fontspec}%
+\index{OpenType-Schriften}%
+%
+\ChangedAt{v2.02:OpenType-Schriften mit Paket \Package{fontspec} verwendbar}
+Das \TUDScript-Bundle unterstützt die Nutzung der Schriften des \CDs sowohl
+im PostScript- als auch im OpenType"=Format. Letztere müssen ebenfalls über das
+\hrfn{https://tu-dresden.de/cd/1_basiselemente/03_hausschrift/}{%
+ Universitätsmarketing auf Anfrage%
+}
+bestellt werden. Die in den beiden Archiven \File{Univers\_8\_TTF\/.zip} und
+\File{DIN\_TTF\/.zip} enthaltenen Schriften müssen erst für das Betriebssystem
+installiert werden und lassen sich nachfolgend mit dem Paket \Package{fontspec}
+verwenden.
+
+Auf die Installation der PostScript"=Schriften kann dennoch nicht ohne Weiteres
+verzichtet werden. Denn einerseits sind diese für die Kompilierung eines
+\hologo{LaTeX}"~Dokumentes über den klassischen Prozesspfad via
+\Path{latex \textrightarrow{} dvips \textrightarrow{} ps2pdf}~-- wie es
+beispielsweise für die Erstellung von Grafiken mit \Package{pstricks} notwendig
+ist~-- erforderlich. Andererseits liefern die Schriftfamilien des \CDs keine
+mathematische Glyphen, sodass diese bei der PostScript"=Schriftinstallation aus
+den Schriftpaketen \Package{cmbright} und \Package{iwona} entnommen werden. Bei
+den Schriften im OpenType"=Format ist dies leider nicht so einfach möglich, da
+es schlichtweg an passenden Schriftpaketen für den Mathematiksatz im
+OpenType"=Format mangelt, weshalb für den mathematischen Satz in jedem Fall die
+PostScript"=Schriften genutzt werden, falls diese installiert sind. Weiterhin
+kommt es beim Kerning der OpenType"=Schriften im Fließtext zu Problemen.
+
+Die Verwendung der Schriften des \CDs im OpenType"=Format sollte folglich nur
+erfolgen, wenn eine Installation der PostScript"=Schriften \emph{absolut} nicht
+möglich ist beziehungsweise \Engine{LuaLaTeX} oder \Engine{XeLaTeX} zwingend
+genutzt werden müssen. Hierfür ist es~-- nach der systemweiten Installation der
+OpenType"=Schriften~-- ausreichend, das Paket \Package{fontspec} zu laden.
+\index{Schriftart|?)}%
+
+
+
\subsection{Schriften für den Textsatz}
+\tudhyperdef*{sec:text}%
+\index{Schriftstärke}%
+%
\begin{Declaration}[%
- v2.02!Werte für Option \Option{cdhead} ergänzt%
-]{\Option{cdfont}[\PSet]}[true]%
+ v2.02!\Option{cdfont=head};
+ v2.02!\Option{cdfont=heavyhead};
+ v2.03!\Option{cdfont=din};
+ v2.03!\Option{cdfont=nodin};
+ v2.05!\Option{cdfont=normalbold};
+ v2.05!\Option{cdfont=ultrabold};
+]{\Option{cdfont=\PSet}}[true,normalbold,din]%
\printdeclarationlist%
-\label{sec:text}%
-\index{Schrift!Fließtext}\index{Schriftstärke}%
%
Mit der Option \Option{cdfont} können durch den Anwender alle zentralen
Schrifteinstellungen für die \TUDScript-Klassen vorgenommen werden. Dies
betrifft sowohl die Schriften für Überschriften als auch den Fließtext sowie
die Mathematikschriften. Die verwendete Schriftstärke im charakteristischen
-Querbalken der Kopfzeile lässt sich hiermit ebenfalls einstellen.
+Querbalken der Kopfzeile lässt sich hiermit ebenfalls einstellen.
%
-\begin{values}
+\begin{values}{\Option{cdfont}}
\itemfalse
Es werden die \hologo{LaTeX}"=Standardschriften und nicht die Hausschriften
des \CDs verwendet. Der Anwender kann beliebige Schriftpakete nutzen.%
@@ -117,194 +194,195 @@ Querbalken der Kopfzeile lässt sich hiermit ebenfalls einstellen.
Für die Verwendung der klassischen \hologo{LaTeX}"=Schriften, ist das Paket
\Package{lmodern} sehr empfehlenswert.%
}
- Sollte das Layout des \CDs aktiviert sein (\see*{\Option{cd}}), werden die
+ Sollte das Layout des \CDs aktiviert sein (\seeref{\Option{cd}}), werden die
Überschriften in Großbuchstaben und \DIN gesetzt und nur die Schriftart des
Fließtextes kann angepasst werden.
\itemtrue*[light/lightfont/noheavyfont]
- Es werden die Hausschriften im Stil des \CDs der \TnUD genutzt. Überschriften
- der obersten Gliederungsebenen bis einschließlich \Macro{subsubsection}
+ Es werden die Hausschriften im Stil des \CDs genutzt. Überschriften der
+ obersten Gliederungsebenen bis einschließlich \Macro*{subsubsection}
verwenden \DIN, darunter liegende%
- \footnote{\Macro{paragraph} und \Macro{subparagraph}}
+ \footnote{%
+ \Macro{paragraph}(\Package{koma-script})'none' und
+ \Macro{subparagraph}(\Package{koma-script})'none'%
+ }
\textubn{Univers~65~Bold}. Für den Fließtext im Dokument kommt
- \textuln{Univers~45~Light} zum Einsatz. Aus \Package{lmodern} wird die
- \texttt{Schreibmaschinenschrift} verwendet.
+ \textuln{Univers~45~Light} zum Einsatz. Aus dem Paket \Package{lmodern} wird
+ die \texttt{Schreibmaschinenschrift} verwendet.
\item[heavy/heavyfont]
Die Schriftstärke der Hausschriften wird erhöht. Die beiden untersten
Gliederungsebenen werden in \textuxn{Univers~75~Black} gesetzt, der Fließtext
in \texturn{Univers~55~Regular}. Ansonsten entspricht alles der Option
- \Option{cdfont}[true]. Die Mathematikschriften werden nicht beeinflusst,
+ \Option{cdfont=true}. Die Mathematikschriften werden nicht beeinflusst,
diese lassen sich gegebenenfalls mit \Macro{boldmath} auf den fetten Schnitt
umschalten.
+\end{values}
+%
+Falls die Hausschriften des \TUDCDs verwendet werden, lässt sich die Stärke der
+fetten Schriften mit folgenden Einstellungen anpassen.
+%
+\begin{values}{\Option{cdfont}}
+\item[normalbold]
+ \ChangedAt{v2.05}
+ Für den fetten Schriftschnitt wird \texturn{Univers~55~Regular} respektive
+ bei stärkeren Schriften (\Option{cdfont=heavy}) \textubn{Univers~65~Bold}
+ verwendet. Dies ist die Voreinstellung.
+\item[ultrabold/heavybold]
+ \ChangedAt{v2.05}
+ Die fetten Schriften werden stärker hervorgehoben. Es kommt
+ \textubn{Univers~65~Bold} respektive \textuxn{Univers~75~Black} bei erhöhter
+ Schriftstärke (\Option{cdfont=heavy}) zum Einsatz.
+\end{values}
+%
+Für die \TUDScript-Klassen sowie die vom Paket \Package{fix-tudscrfonts}
+unterstützten Dokumentklassen kann die für die Gliederungsebenen verwendete
+Schriftart angepasst werden.
+%
+\begin{values}{\Option{cdfont}}
\item[nodin]
- Für die Überschriften wird \DIN nicht verwendet. Für \Option{cdfont}[true]
- wird \Univers genutzt. Die Schriftstärke ist dabei abhängig von der
- Einstellung \Option{cdfont}[light/heavy]. Ist die Verwendung der Schriften
- des \CDs deaktiviert (\Option{cdfont}[false]), kommt die fette Schriftstärke
- der eingestellten serifenlosen Schriftfamilie zum Einsatz.
+ Für Überschriften wird \Univers anstatt \DIN verwendet, die Schriftstärke
+ kann mit \Option{cdfont=true} respektive \Option{cdfont=heavy} eingestellt
+ werden. Wurde mit \Option{cdfont=false} zusätzlich die Verwendung der
+ Schriften des \CDs deaktiviert, wird standardmäßig die fette Schriftstärke
+ der eingestellten serifenlosen Schriftfamilie genutzt.
\item[din]
Mit dieser Einstellung wird die Schrift \DIN in den Überschriften verwendet.
Diese ist standardmäßig aktiviert.
\end{values}
%
+Weiterhin dient die Option \Option{cdfont=\PSet} als erweiterte Schnittstelle
+für den Anwender, um zusätzliche Einstellungen für die Schriftnutzung vornehmen
+zu können, für welche normalerweise separate Optionen vorgesehen sind. Diese
+Möglichkeiten werden folgend kurz erläutert und auf die tatsächlich zugrunde
+liegende Option verweisen.
+
\ChangedAt{v2.02}
-Für den Text im Querbalken gibt es folgende Einstellmöglichkeiten:
+Für die \TUDScript-Klassen gibt es bei den \PageStyle{tudheadings}-Seitenstilen
+folgende Einstellmöglichkeiten für die Schriftart im Querbalken:
%
-\begin{values}
+\begin{values}{\Option{cdfont}}
+\item[nohead/noheadfont]
+ Bei deaktivierten Hausschriften für den Fließtext können diese ebenfalls im
+ Querbalken deaktiviert werden, \seeref{\Option{cdhead=false}}.
\item[head/lighthead/lightfonthead/noheavyfonthead]
- Für den Querbalken der Kopfzeile wird unabhängig von der Verwendung der
- Hausschriften die Schrift \Univers in normaler Schriftstärke verwendet,
- \see*{\Option{cdhead}[true]}.
+ Für den Querbalken der Kopfzeile wird~-- unabhängig von der Verwendung der
+ Hausschriften im Fließtext~-- die Schrift \Univers in normaler Schriftstärke
+ verwendet, \seeref{\Option{cdhead=true}}.
\item[heavyhead/heavyfonthead]
- Die im Querbalken verwendete Schrift ist \Univers in erhöhter Stärke,
- \see*{\Option{cdhead}[heavy]}.
+ Im Querbalken wird~-- unabhängig von der Dokumentschrift~-- \Univers in
+ erhöhter Stärke genutzt, \seeref{\Option{cdhead=heavy}}.
\end{values}
%
-Die verwendeten Mathematikschriften lassen sich mit folgenden Werte
-beeinflussen:
+Die genutzten Mathematikschriften können mit folgenden Werte beeinflusst werden:
%
-\begin{values}
-\item[nomath/nocdmath]
+\begin{values}{\Option{cdfont}}
+\item[nomath/nocdmath]
Diese Einstellung deaktiviert die Verwendung von serifenlosen Schriften für
den mathematischen Satz. Es werden die \hologo{LaTeX}"=Standardschriften
verwendet und der Benutzer kann beliebige Schriftpakete für den
- Mathematikmodus nutzen, \see*{\Option{cdmath}[false]}.
+ Mathematikmodus nutzen, \seeref{\Option{cdmath=false}}.
\item[math/cdmath]
- Es werden serifenlose Mathematikschriften für lateinische und griechische
- Lettern genutzt, \see*{\Option{cdmath}[true]}.
+ Serifenlose Mathematikschriften, \seeref{\Option{cdmath=true}}.
\item[upgreek/uprightgreek]
- Die großen griechischen Buchstaben werden im Mathematikmodus aufrecht gesetzt,
- \see*{\Option{slantedgreek}[false]}.
+ Griechische Großbuchstaben werden aufrecht gesetzt,
+ \seeref{\Option{slantedgreek=false}}.
\item[slgreek/slantedgreek]
- In mathematischen Umgebungen erfolgt die Ausgabe der griechischen Majuskeln
- kursiv, \see*{\Option{slantedgreek}[true]}.
+ Die Ausgabe der griechischen Majuskeln erfolgt kursiv,
+ \seeref{\Option{slantedgreek=true}}.
\end{values}
-%
-\ChangedAt{v2.02,v2.04!Einfachere Verwendung von \Package{fontspec}}
-Normalerweise kommen die Schriften des \CDs im PostScript"=Format zum Einsatz,
-wenn diese wie unter \autoref{sec:install} beschrieben installiert wurden.
-Wird entweder \hologo{LuaLaTeX} oder \hologo{XeLaTeX} als Dokumentprozessor
-verwendet und das Paket \Package{fontspec} geladen, so werden die Schriften des
-\CDs im OpenType"=Format verwendet. Hierfür sind die Hinweise in
-\fullref{sec:fonts:fontspec} unbedingt zu beachten.
\end{Declaration}
-\subsubsection{Auszeichnungen in Überschriften}
-\index{Schriftelemente}
-Für die Schriftauswahl der Überschriften aller Gliederungsebenen sind die durch
-\KOMAScript{} bereitgestellten Schriftelemente verantwortlich. Mehr dazu ist in
-\autoref{sec:fonts:elements} zu finden. Da die Überschriften der obersten
-Gliederungsebenen bis einschließlich \Macro{subsubsection} normalerweise in
-Majuskeln gesetzt werden, bestehen für den Anwender mit den folgenden Befehlen
-gewisse Einflussmöglichkeiten, deren Ausprägung anzupassen.
-
-\begin{Declaration}{\Macro{ifdin}\Parameter{Dann-Teil}\Parameter{Sonst-Teil}}%
-\printdeclarationlist%
-\index{Überschriften}\index{Schrift!Überschriften}\index{Schriftauszeichnung}%
-\index{Kolumnentitel}\index{Layout!Kolumnentitel}
+\subsubsection{Auszeichnungen im Text}
+\index{Schriftstärke}%
+\index{Schriftauszeichnung}%
%
-Der Befehl \Macro{ifdin} prüft, ob die Schriftfamilie \DIN aktiv ist und führt
-in diesem Fall \Parameter{Dann-Teil} aus, andernfalls \Parameter{Sonst-Teil}.
-Dies ist beispielsweise bei Überschriften sinnvoll, wenn innerhalb des
-obligatorischen Argumentes zwischen der Ausgabe im Dokument selber und dem
-Eintrag für das Inhaltsverzeichnis sowie der Ausprägung der automatischen
-Kolumnentitel unterschieden werden soll.
-\end{Declaration}
-
-\begin{Declaration}{\Macro{MakeTextUppercase}\Parameter{Text}}%
-\begin{Declaration}{\Macro{NoCaseChange}\Parameter{Text}}%
-\printdeclarationlist%
-\index{Überschriften}\index{Schrift!Überschriften}\index{Schriftauszeichnung}%
+Unabhängig davon, welche Schriftfamilie im Dokument verwendet wird, können die
+Schriften des \CDs jederzeit mit einem der hier aufgeführten Textschalter oder
+Textkommandos innerhalb des Dokumentes genutzt werden. Ein Textschalter wirkt
+sich~-- wenn er nicht lokal durch eine Gruppe oder Umgebung begrenzt wird~--
+global auf das Dokument aus, wie etwa beispielsweise \Macro*{bfseries}. Bei
+einem Textkommando hingegen kommt die Schriftart nur für das nachfolgend
+angegebene Argument zum Einsatz, wie bei \Macro*{textbf}[\Parameter{Text}].
%
-Der Befehl \Macro{MakeTextUppercase} stammt aus dem Paket \Package{textcase}
-und setzt den Text seines Argumentes in Majuskeln. Die Überschriften der
-Gliederungsebenen bis einschließlich \Macro{subsubsection} werden damit in
-Großbuchstaben der Schrift \DIN gesetzt, wenn das Layout des \CDs nicht
-deaktiviert wurde (\Option{cd}[false]). Sollen in einer Überschrift bestimmte
-Kleinbuchstaben erhalten bleiben, ist der Befehl \Macro{NoCaseChange} zu
-nutzen, welcher ebenfalls von besagtem Paket bereitgestellt wird.
+\begin{Declaration}[v2.04]{\Macro{cdfont}[\Parameter{Schriftart}]}
+\begin{Declaration}[v2.04]{%
+ \Macro{textcdfont}[\Parameter{Schriftart}\Parameter{Text}]%
+}
+\printdeclarationlist
+Diese beiden Befehle dienen zur gezielten Aktivierung einer Schriftart des \CDs
+in Stärke und Schnitt. Hierbei entspricht \Macro{cdfont} einem Textschalter und
+ändert die verwendete Schriftart unverzüglich im aktuellen Geltungsbereich auf
+\PName{Schriftart}, wohingegen \Macro{textcdfont} als Textkommando fungiert und
+den im zweiten Argument gegebenen \PName{Text} in \PName{Schriftart} setzt ohne
+dabei die Dokumentschriftart selbst zu ändern.
+
+Für die Schriftauswahl muss im ersten Argument die Bezeichnung der gewünschten
+Schriftart angegeben werden. Dieser ist der obigen Tabelle zu entnehmen. Für
+die Auswahl der Schriftfamilie \Univers kann der Vorsatz \PValue{Univers} im
+Argument \PName{Schriftart} entfallen. Ebenso sind weder Leerzeichen noch die
+passende Groß- und Kleinschreibung notwendig. Für die Wahl der Schriftstärke
+ist die entsprechende Zahl \emph{oder} die Bezeichnung allein ausreichend.%
+\footnote{\PValue{45/55/65/75} oder \PValue{Light/Regular/Bold/Black}}
+Anstelle des Suffix' \PValue{Oblique} ist auch die Nutzung von \PValue{Italic}
+oder \PValue{Slanted} als Alias für die geneigten Schriftschnitte möglich. Zur
+Auswahl von \DIN ist \PValue{din} als Argument hinreichend.
\end{Declaration}
\end{Declaration}
-%
-\begin{Example}
-In einer Kapitelüberschrift wird ein einzelnes Wort in Kleinbuchstaben
-geschrieben:
-\begin{Code}[escapechar=§]
-\chapter{§Ü§berschrift mit \NoCaseChange{kleinem} Wort}
-\end{Code}
-\end{Example}
-\subsubsection{Auszeichnungen im Text}
-\index{Schrift!Fließtext}\index{Schriftstärke}%
-\index{Schrift!Befehle}\index{Schrift!Schalter}%
-%
-Unabhängig davon, welche Schriftfamilie verwendet wird, können die Schriften
-des \CDs jederzeit entweder mit einem der hier aufgeführten Textschalter oder
-Textkommandos innerhalb des Dokumentes genutzt werden. Ein Textschalter wirkt
-sich~-- wenn er nicht in einer Gruppe oder einer Umgebung verwendet und damit
-lokal begrenzt wird~-- global auf das Dokument aus, wie etwa beispielsweise
-\Macro*{bfseries}. Bei einem Textkommando hingegen erfolgt die Änderung der
-Schriftart nur für das nachfolgend angegebene Argument, wie zum Beispiel bei
-\Macro*{textbf}\Parameter{Text}. Darauf ist bei der Nutzung zu achten.
-%
\begin{Declaration}{\Macro{univln}}
-\begin{Declaration}{\Macro{textuln}\Parameter{Text}}
+\begin{Declaration}{\Macro{textuln}[\Parameter{Text}]}
\begin{Declaration}{\Macro{univrn}}
-\begin{Declaration}{\Macro{texturn}\Parameter{Text}}
+\begin{Declaration}{\Macro{texturn}[\Parameter{Text}]}
\begin{Declaration}{\Macro{univbn}}
-\begin{Declaration}{\Macro{textubn}\Parameter{Text}}
+\begin{Declaration}{\Macro{textubn}[\Parameter{Text}]}
\begin{Declaration}{\Macro{univxn}}
-\begin{Declaration}{\Macro{textuxn}\Parameter{Text}}
+\begin{Declaration}{\Macro{textuxn}[\Parameter{Text}]}
\begin{Declaration}{\Macro{univls}}
-\begin{Declaration}{\Macro{textuls}\Parameter{Text}}
+\begin{Declaration}{\Macro{textuls}[\Parameter{Text}]}
\begin{Declaration}{\Macro{univrs}}
-\begin{Declaration}{\Macro{texturs}\Parameter{Text}}
+\begin{Declaration}{\Macro{texturs}[\Parameter{Text}]}
\begin{Declaration}{\Macro{univbs}}
-\begin{Declaration}{\Macro{textubs}\Parameter{Text}}
+\begin{Declaration}{\Macro{textubs}[\Parameter{Text}]}
\begin{Declaration}{\Macro{univxs}}
-\begin{Declaration}{\Macro{textuxs}\Parameter{Text}}
+\begin{Declaration}{\Macro{textuxs}[\Parameter{Text}]}
\begin{Declaration}{\Macro{dinbn}}
-\begin{Declaration}{\Macro{textdbn}\Parameter{Text}}
-\settowidth\tempdim{\Macro{textuln}\Parameter{Text}}%
+\begin{Declaration}{\Macro{textdbn}[\Parameter{Text}]}
+\settowidth\tempdim{\Macro{textuln}[\Parameter{Text}]}%
\addtolength\tempdim{\dimexpr 2\tabcolsep+2\arrayrulewidth-\textwidth}%
\printdeclarationlist(%
\begin{minipage}{-\tempdim}%
+ \newcommand*\listfonts[3]{%
+ \csuse{#3}{#1} & \Macro{#2} & \Macro{#3}[\Parameter{Text}]\tabularnewline
+ }%
\centering%
\begin{tabularm}{3}%
\toprule%
- \textbf{Schriftart} & \textbf{Schalter}
- & \textbf{Textkommando}\tabularnewline
+ \textbf{Schriftart} & \textbf{Schalter} & \textbf{Textkommando}
+ \tabularnewline
\midrule
- \textuln{Univers 45 Light} & \Macro{univln}{}
- & \Macro{textuln}\Parameter{Text}\tabularnewline
- \texturn{Univers 55 Regular} & \Macro{univrn}{}
- & \Macro{texturn}\Parameter{Text}\tabularnewline
- \textubn{Univers 65 Bold} & \Macro{univbn}{}
- & \Macro{textubn}\Parameter{Text}\tabularnewline
- \textuxn{Univers 75 Black} & \Macro{univxn}{}
- & \Macro{textuxn}\Parameter{Text}\tabularnewline
- \textuls{Univers 45 Light Oblique} & \Macro{univls}{}
- & \Macro{textuls}\Parameter{Text}\tabularnewline
- \texturs{Univers 55 Regular Oblique} & \Macro{univrs}{}
- & \Macro{texturs}\Parameter{Text}\tabularnewline
- \textubs{Univers 65 Bold Oblique} & \Macro{univbs}{}
- & \Macro{textubs}\Parameter{Text}\tabularnewline
- \textuxs{Univers 75 Black Oblique} & \Macro{univxs}{}
- & \Macro{textuxs}\Parameter{Text}\tabularnewline
- \DIN & \Macro{dinbn}{}
- & \Macro{textdbn}\Parameter{Text}\tabularnewline
+ \listfonts{Univers 45 Light}{univln}{textuln}
+ \listfonts{Univers 55 Regular}{univrn}{texturn}
+ \listfonts{Univers 65 Bold}{univbn}{textubn}
+ \listfonts{Univers 75 Black}{univxn}{textuxn}
+ \listfonts{Univers 45 Light Oblique}{univls}{textuls}
+ \listfonts{Univers 55 Regular Oblique}{univrs}{texturs}
+ \listfonts{Univers 65 Bold Oblique}{univbs}{textubs}
+ \listfonts{Univers 75 Black Oblique}{univxs}{textuxs}
+ \listfonts{DIN BOLD}{dinbn}{textdbn}
\bottomrule%
\allcolumnpar{\footnotesize\vskip0pt%
- Die Schrift \DIN darf laut \CD nur mit Majuskeln (Großbuchstaben)
- verwendet werden. Wird diese Schrift manuell verwendet, sollte dies mit
- \Macro{MakeTextUppercase}\PParameter{\Macro{textdbn}\Parameter{Text}}
- geschehen. Sollen dabei im Argument einzelne Teile zwingend klein
- geschrieben werden, wird der Befehl \Macro{NoCaseChange} benötigt.
+ Die Schrift \DIN darf laut \CD nur mit Majuskeln (Großbuchstaben)
+ verwendet werden. Wird diese Schrift manuell verwendet, sollte dies mit
+ \Macro{MakeTextUppercase}[%
+ \PParameter{\Macro{textdbn}[\Parameter{Text}]}%
+ ](\Package{textcase})'none' geschehen. Sollen dabei im Argument einzelne
+ Teile zwingend klein geschrieben werden, wird der Befehl
+ \Macro{NoCaseChange}(\Package{textcase}) benötigt.
}
\end{tabularm}%
\end{minipage}%
)%
-Alternativ zu den beschriebenen Textschaltern und -kommandos können seit der
+Alternativ zu den beschriebenen Textschaltern und "~kommandos können seit der
Version~v2.04 auch die beiden Befehle \Macro{cdfont} und \Macro{textcdfont}
verwendet werden, welche die gleiche Funktionalität wesentlich komfortabler
bereitstellen.
@@ -327,50 +405,76 @@ bereitstellen.
\end{Declaration}
\end{Declaration}
-\begin{Declaration}[v2.04]{\Macro{cdfont}\Parameter{Schriftart}}
-\begin{Declaration}[v2.04]{%
- \Macro{textcdfont}\Parameter{Schriftart}\Parameter{Text}%
-}
-\printdeclarationlist
-Diese beiden Befehle dienen ebenfalls zu gezielten Aktivierung einer Schriftart
-des \CDs in Stärke und Schnitt. Hierbei entspricht \Macro{cdfont} einem
-Textschalter und ändert die aktuell verwendete Schriftart im aktuellen
-Geltungsbereich auf \PName{Schriftart}, wohingegen \Macro{textcdfont} als
-Textkommando fungiert und den im zweiten Argument gegebenen \PName{Text} in
-\PName{Schriftart} setzt ohne dabei die Dokumentschriftart selbst zu ändern.
-
-Für die Schriftauswahl muss im ersten Argument der Name der zu verwendenden
-Schriftart angegeben werden. Dieser ist der obigen Tabelle zu entnehmen. Für
-die Auswahl der Schriftfamilie \Univers kann der Vorsatz \PValue{Univers} im
-Argument \PName{Schriftart} entfallen. Ebenso sind weder Leerzeichen noch die
-passende Groß- und Kleinschreibung notwendig. Für die Wahl der Schriftstärke
-ist die entsprechende Zahl \emph{oder} die Bezeichnung allein ausreichend.%
-\footnote{\PValue{45/55/65/75} oder \PValue{Light/Regular/Bold/Black}}
-Anstelle des Suffix' \PValue{Oblique} ist auch die Nutzung von \PValue{Italic}
-oder \PValue{Slanted} als Alias für die geneigten Schriftschnitte möglich. Zur
-Auswahl von \DIN ist \PValue{din} als Argument hinreichend.
+\subsubsection{Auszeichnungen in Überschriften}
+\index{Schriftelemente}%
+%
+Für die Schriftauswahl der Überschriften aller Gliederungsebenen sind die durch
+\KOMAScript{} bereitgestellten Schriftelemente verantwortlich. Mehr dazu ist in
+\autoref{sec:fonts:elements} zu finden. Da die Überschriften der obersten
+Gliederungsebenen bis einschließlich \Macro*{subsubsection} normalerweise in
+Majuskeln gesetzt werden, bestehen für den Anwender mit den folgenden Befehlen
+gewisse Einflussmöglichkeiten, deren Ausprägung anzupassen.
+
+\begin{Declaration}{\Macro{ifdin}[\Parameter{Dann-Teil}\Parameter{Sonst-Teil}]}%
+\printdeclarationlist%
+\index{Layout!Kolumnentitel}%
+\index{Layout!Überschriften|!}%
+\index{Schriftauszeichnung!Überschriften}%
+%
+Der Befehl \Macro{ifdin} prüft, ob die Schriftfamilie \DIN aktiv ist und führt
+in diesem Fall \Parameter{Dann-Teil} aus, andernfalls \Parameter{Sonst-Teil}.
+Dies ist beispielsweise bei Überschriften sinnvoll, wenn innerhalb des
+obligatorischen Argumentes zwischen der Ausgabe im Dokument selber und dem
+Eintrag für das Inhaltsverzeichnis sowie der Ausprägung der automatischen
+Kolumnentitel unterschieden werden soll.
\end{Declaration}
+
+\begin{Declaration}{\Macro{NoCaseChange}[\Parameter{Text}](\Package{textcase})}%
+\printdeclarationlist%
+\index{Layout!Überschriften|!}%
+\index{Schriftauszeichnung!Groß- und Kleinschreibung}%
+%
+Für alle Gliederungsebenen bis einschließlich \Macro*{subsubsection} werden die
+Überschriften in Großbuchstaben der Schrift \DIN gesetzt, wenn das Layout des
+\CDs nicht deaktiviert wurde (\Option{cd=false}). Hierfür wird intern der
+Befehl \Macro{MakeTextUppercase}(\Package{textcase})'none' aus dem Paket
+\Package{textcase} genutzt. Sollen in einer Überschrift gezielt bestimmte
+Kleinbuchstaben erhalten bleiben, ist der Befehl
+\Macro{NoCaseChange}(\Package{textcase}) zu nutzen, welcher ebenfalls von
+besagtem Paket bereitgestellt wird. Zur erzwungenen Kleinschreibung kann
+\Macro{MakeTextLowercase}(\Package{textcase})'none' genutzt werden.
\end{Declaration}
+%
+\begin{Example}
+In einer nicht nummerierten Kapitelüberschrift wird ein einzelnes Wort in
+Kleinbuchstaben geschrieben:
+\begin{Code}[escapechar=§]
+\addchap{§Ü§berschrift mit \NoCaseChange{kleinem} Wort}
+\end{Code}
+\end{Example}
+
\subsection{Schriften für den Mathematiksatz}
-\begin{Declaration}[v2.03]{\Option{cdmath}[\PBoolean]}%
- [true][\Option{cdfont}[false]:false]
+\tudhyperdef*{sec:math}%
+\index{Mathematiksatz|?(}%
+\index{Griechische Buchstaben|(}%
+%
+\begin{Declaration}[v2.03]{\Option{cdmath=\PBoolean}}%
+ [true][\Option{cdfont=false}:false]
\printdeclarationlist%
-\label{sec:math}
-\index{Schrift!Mathematiksatz}\index{Mathematiksatz|!}
-\index{Schrift!Griechische Buchstaben}\index{Griechische Buchstaben}
%
Diese Option dient zur Anpassung der Mathematikschriften. Wird diese aktiviert,
-so werden zu den Hausschriften passende im Mathematikmodus genutzt, mit
-\Option{cdmath}[false] wird auf die Standardschriften zurückgeschaltet. Ein
+so werden zu den Hausschriften passende Glyphen im Mathematikmodus genutzt,
+mit \Option{cdmath=false} wird auf die Standardschriften zurückgeschaltet. Ein
Umschalten innerhalb des Dokumentes ist~-- beispielsweise für Abbildungen oder
-Tabellen~-- durch \Macro{TUDoptions}\PParameter{\Option{cdmath}[true/false]}
-möglich. Mit \Macro{boldmath} kann auf fette Mathematikschriften umgeschaltet
-werden. Gültige Werte für die Option \Option{cdmath} sind:
+Tabellen~-- durch \Macro{TUDoptions}[\PParameter{\Option{cdmath=true}}] sowie
+\Macro{TUDoptions}[\PParameter{\Option{cdmath=false}}] möglich. Auf fette
+Mathematikschriften kann mit \Macro{boldmath} umgeschaltet werden. Gültige
+Werte für die Option \Option{cdmath} sind:
%
-\begin{values}
+\begin{values}{\Option{cdmath}}
\itemfalse
Es werden die normalen \hologo{LaTeX}"=Serifenschriften beziehungsweise die
Schriften beliebig nutzbarer Pakete für den Mathematiksatz verwendet.
@@ -380,17 +484,16 @@ werden. Gültige Werte für die Option \Option{cdmath} sind:
\Package{iwona} zum Einsatz.
\item[upgreek/uprightgreek]
Die griechischen Majuskeln werden aufrecht gesetzt,
- \see*{\Option{slantedgreek}[false]}.
+ \seeref{\Option{slantedgreek=false}}.
\item[slgreek/slantedgreek]
Die Ausgabe der griechischen Großbuchstaben erfolgt kursiv,
- \see*{\Option{slantedgreek}[true]}.
+ \seeref{\Option{slantedgreek=true}}.
\end{values}
\end{Declaration}
+
\subsubsection{Griechischen Buchstaben}
-\vskip-\lastskip%
-\label{sec:greek}%
-\index{Schrift!Griechische Buchstaben}\index{Griechische Buchstaben}%
+\tudhyperdef*{sec:greek}%
%
\begin{Declaration}{\Macro{varDelta}}
\begin{Declaration}{\Macro{varTheta}}
@@ -412,7 +515,6 @@ werden. Gültige Werte für die Option \Option{cdmath} sind:
\begin{Declaration}{\Macro{upPhi}}
\begin{Declaration}{\Macro{upPsi}}
\begin{Declaration}{\Macro{upOmega}}
-\index{Schrift!Griechische Buchstaben}\index{Griechische Buchstaben}%
\settowidth\tempdim{\Macro{varUpsilon}}%
\addtolength\tempdim{\dimexpr 2\tabcolsep+2\arrayrulewidth-\textwidth\relax}%
\printdeclarationlist(%
@@ -421,10 +523,12 @@ werden. Gültige Werte für die Option \Option{cdmath} sind:
\newcommand*\greekLetters{%
Delta,Theta,Lambda,Xi,Pi,Sigma,Upsilon,Phi,Psi,Omega%
}%
- \def\do#1{\appto\tablecontent{%
- \Macro*{var#1} & $\csuse{var#1}$ & &
- \Macro*{up#1} & $\csuse{up#1}$\tabularnewline
- }}%
+ \def\do#1{%
+ \appto\tablecontent{%
+ \Macro*{var#1} & $\csuse{var#1}$ & &
+ \Macro*{up#1} & $\csuse{up#1}$\tabularnewline
+ }%
+ }%
\expandafter\docsvlist\expandafter{\greekLetters}%
\centering%
\vspace{\intextsep}\noindent
@@ -434,7 +538,7 @@ werden. Gültige Werte für die Option \Option{cdmath} sind:
\textbf{Befehl (aufrecht)} & \textbf{Symbol}
\tabularnewline\midrule\tablecontent\bottomrule%
\allcolumnpar{\footnotesize\vskip0pt%
- Die Befehle \Macro*{up}\PName{Name} und \Macro*{var}\PName{Name}
+ Die Befehle \Macro*{up}[\PName{Name}] und \Macro*{var}[\PName{Name}]
werden normalerweise durch einige Pakete, unter anderem auch von
\Package{cmbright} oder \Package{amsmath}, bereitgestellt.
}
@@ -468,96 +572,289 @@ griechischen Minuskeln sind leider nur in der kursiven Variante verfügbar.
\end{Declaration}
\end{Declaration}
-\begin{Declaration}{\Option{slantedgreek}[\PBoolean]}[false]
+\begin{Declaration}{\Option{slantedgreek=\PBoolean}}[false]
\printdeclarationlist%
%
Die Option ändert die standardmäßige Neigung der griechischen Großbuchstaben im
Mathematikmodus bei der Verwendung der Befehle \Macro*{Delta}, \Macro*{Theta},
\Macro*{Lambda}, \Macro*{Xi}, \Macro*{Pi}, \Macro*{Sigma}, \Macro*{Upsilon},
-\Macro*{Phi}, \Macro*{Psi} und \Macro*{Omega}. Wie unabhängig von der Option
-\Option{slantedgreek} gezielt kursive und aufrechte Buchstaben gesetzt werden
-können, wird \vpageref{sec:greek} beschrieben.
+\Macro*{Phi}, \Macro*{Psi} und \Macro*{Omega}.
%
-\begin{values}
+\begin{values}{\Option{slantedgreek}}
\itemfalse
- Die griechischen Majuskeln werden wie bei den Standardklassen aufrecht
- gesetzt.
+ Die griechischen Majuskeln werden in Umgebungen für den Mathematiksatz wie
+ bei den Standardklassen aufrecht gesetzt.
\itemtrue*
- Die Ausgabe der griechischen Großbuchstaben erfolgt kursiv.
+ Die Ausgabe der griechischen Großbuchstaben erfolgt im Mathematikmodus kursiv.
\end{values}
+%
+Wie unabhängig von der Option \Option{slantedgreek} gezielt kursive und
+aufrechte Buchstaben gesetzt werden können, wurde zuvor \vpageref{sec:greek}
+beschrieben.
+\index{Griechische Buchstaben|)}%
\end{Declaration}
\subsubsection{Zusätzliche Hinweise zum Mathematiksatz}
Weitere Hinweise zum typografisch guten Mathematiksatz sind außerdem in
-\autoref{sec:exmpl:mathswap} sowie \autoref{sec:exmpl:mathtype} zu finden.
+\autoref{sec:exmpl:mathtype} sowie \autoref{sec:exmpl:mathswap} zu finden.
+\index{Mathematiksatz|?)}%
+
+
+\subsection{Vertikaler Leerraum in Abhängigkeit der Schriftgröße}
+\index{Leerraum}%
+\index{Schriftgröße}%
+%
+Bei den \TUDScript-Klassen sind im Normalfall mehrere Längen von der für das
+Dokument gewählten Schriftgröße abhängig~-- im Gegensatz zu \KOMAScript. Dies
+hat den großen Vorteil, dass bei einer Änderung der Schriftgröße die folgend
+genannten Befehle respektive Längen nicht separat durch den Anwender angepasst
+werden müssen, um weiterhin sinnvoll verwendet werden zu können.
+
+Die Anpassung an die Schriftgröße erfolgt sowohl die dehnbaren Längen
+\Length{bigskipamount}, \Length{medskipamount} und \Length{smallskipamount},
+welche von den Befehlen \Macro{bigskip}, \Macro{medskip} beziehungsweise
+\Macro{smallskip} für das Einfügen vertikaler Abstände genutzt werden, als auch
+die beiden Längen \Length{abovecaptionskip}(\Package{koma-script})'none' und
+\Length{belowcaptionskip}(\Package{koma-script})'none' für den Abstand zwischen
+einem Gleitobjekt~-- beispielsweise eine Abbildung oder eine Tabelle~-- und
+dessen mit \Macro{caption}(\Package{koma-script},\Package{caption})'none'
+gesetzten Beschreibung. Außerdem wird die Länge \Length{columnsep} als Maß für
+den horizontalen Abstand der einzelnen Textspalten im zwei- oder mehrspaltigen
+Layout, wie es beispielsweise mit dem Paket \Package{multicol} erzeugt werden
+kann, in Relation zur Schriftgröße sinnvoll festgelegt.
+
+Die verwendete Schriftgröße kann durch den Anwender über die \KOMAScript-Option
+\Option{fontsize=\PName{Schriftgröße}}(\Package{koma-script})'none' festgelegt
+werden.
+\Attention{%
+ Dabei ist zu beachten, dass diese immer als Klassenoption angegeben werden
+ sollte.%
+}
+Weitere Hinweise zur Wahl der passenden Schriftgröße sind außerdem in
+\autoref{sec:fontsize} zu finden.
+
+\begin{Declaration}[v2.05]{\Option{relspacing=\PBoolean}}[true]%
+\printdeclarationlist%
+%
+Mit der Option \Option{relspacing=\PBoolean} lässt sich die zuvor beschriebene
+Schriftgrößenabhängigkeit sowohl für vertikalen Leerraum zwischen zwei Absätzen
+oder bei Beschriftungen als auch für den horizontalen Abstand zwischen den
+Textspalten im mehrspaltigen Layout anpassen.
+%
+\begin{values}{\Option{relspacing}}
+\itemfalse[absolute/standard]
+ Die besagten Längen werden nicht angepasst, passende Werte sollten bei einer
+ Änderung der Schriftgröße durch den Anwender gewählt werden.
+\itemtrue*[relative/fontsize]
+ In Abhängigkeit von der gewählten Schriftgröße werden die zuvor genannten
+ Längen automatisch festgelegt.
+\end{values}
+\end{Declaration}
-\subsection{Die Schriften des \CDs im OpenType-Format}
-\label{sec:fonts:fontspec}
-\index{OpenType-Schriften}
+
+\section{Das Layout des \CDs}
+\index{Layout|(}%
+\subsection{Der Satzspiegel}
+\index{Satzspiegel|(}%
%
-\ChangedAt{v2.02!OpenType-Schriften mit \Package{fontspec} verwendbar}
-Das \TUDScript-Bundle unterstützt die Nutzung der Schriften des \CDs sowohl
-im PostScript- als auch im OpenType"=Format. Letztere müssen ebenfalls über das
-\hrfn{http://tu-dresden.de/service/publizieren/cd/1_basiselemente/03_hausschrift/schriftbestellung.html}%
-{Universitätsmarketing auf Anfrage} bestellt werden. Die in den beiden Archiven
-\File{Univers\_8\_TTF.zip} und \File{DIN\_TTF.zip} enthaltenen Schriften müssen
-für das Betriebssystem installiert werden und lassen sich anschließend mit dem
-Paket \Package{fontspec} verwenden.
+\begin{Declaration}[%
+ v2.03;
+ v2.05!\Option{cdgeometry=restricted};%
+ v2.05!\Option{cdgeometry=adapted};%
+ v2.05!\Option{cdgeometry=calculated};%
+ v2.05!\Option{cdgeometry=custom};%
+]{\Option{cdgeometry=\PSet}}[true,restricted]%
+\printdeclarationlist%
+\index{Layout!Seitenstil}%
+\index{Satzspiegel!doppelseitig}%
+%
+Diese Option ist für die Aufteilung beziehungsweise die Berechnung des
+Satzspiegels verantwortlich. Das Maß der Seitenränder ist im \CD fest
+vorgegeben und wird standardmäßig von den \TUDScript-Klassen eingehalten.
+Allerdings lassen sich die Seitenränder anpassen, um beispielsweise einen
+vernünftigen doppelseitigen Satz zu ermöglichen.%
+\footnote{Hierbei sollte der innere Rand schmaler als der äußere sein}
+Des Weiteren besteht die Möglichkeit, auf das \KOMAScript"=Standardverhalten
+zurückzufallen und die Satzspiegelberechnung durch das Paket \Package{typearea}
+vornehmen zu lassen. Hier hat insbesondere die Klassenoption
+\Option{DIV=\PSet}(\Package{typearea})'none'|declare| maßgeblichen Einfluss auf
+den Satzspiegel. Mehr dazu ist in der \scrguide[Dokumentation von \KOMAScript]
+zu finden.
+\ChangedAt{v2.05}
+Mit der Einstellung \Option{cdgeometry=custom} kann der Satzspiegel auch durch
+den Anwender (fast) beliebig festgelegt werden.
+%
+\begin{values}{\Option{cdgeometry}}
+\itemfalse
+ Die Satzspiegelberechnung erfolgt via \Package{typearea}, die Vorgaben des
+ \CDs bezüglich der Seitenränder werden ignoriert.
+\itemtrue*[asymmetric/cd]
+ Die Seitenränder werden im asymmetrischen Stil des \CDs fest definiert und
+ auch für den doppelseitigen Satz
+ (Klassenoption \Option{twoside=true}(\Package{typearea})'none') genutzt.%
+ \footnote{links: 30\,mm, rechts: 20\,mm, oben: 25\,mm, unten: 30\,mm}
+\item[symmetric/centred/centered]
+ Der Satzspiegel wird im einseitigen sowie doppelseitigen Satz auf der Seite
+ zentriert.%
+ \footnote{links: 25\,mm, rechts: 25\,mm, oben: 25\,mm, unten: 30\,mm}
+\item[twoside/balanced]
+ Diese Einstellung aktiviert den doppelseitigen Satz
+ (\Option{twoside=true}(\Package{typearea})'none') und ändert den Satzspiegel
+ derart, dass die Ränder der inneren Seiten schmaler sind als die der äußeren.%
+ \footnote{innen: 20\,mm, außen: 30\,mm, oben: 25\,mm, unten: 30\,mm}
+ \Attention{%
+ Der so erzeugte Satzspiegel ist jedoch nicht sehr vorteilhaft. Es ist zu
+ beachten, dass dabei das Logo der \TnUD sehr nah am inneren Seitenrand
+ des Dokumentes gesetzt wird, folglich insbesondere auf rechten respektive
+ ungeraden Seiten sehr weit an den Blattrand rückt.
+ }
+ Diesem Problem kann~-- bei \Class{tudscrbook} sowie \Class{tudscrreprt}~--
+ prinzipiell gelöst werden, indem Titel, Teile und Kapitel über das Aktivieren
+ der \KOMAScript-Option \Option{open=left}(\Package{koma-script})'none' immer
+ auf einer linken Seite beginnen, was allerdings aus typografischer Sicht eher
+ unüblich ist.
+\end{values}
+%
+\ChangedAt{v2.05:Neue Möglichkeiten bei der Satzspiegelberechnung im \CD}
+Mit den folgenden Werten lässt sich einstellen, in welcher Variante der
+Satzspiegel nach dem \TUDCD erstellt werden soll.
+%
+\begin{values}{\Option{cdgeometry}}
+\item[restricted]
+ Der Satzspiegel entspricht den expliziten Vorgaben des \CDs (Voreinstellung).
+\item[adapted]
+ Laut dem Handbuch zum \CD werden für Papierformate zwischen DIN~A6 und DIN~A4
+ \enquote{im Interesse größter Einheitlichkeit die Maßverhältnisse über einen
+ größeren Formatbereich hinweg \enquote{eingefroren}.} Dies kann jedoch zu
+ schlecht nutzbaren Satzspiegeln führen. Mit dieser Einstellung kann der
+ äquivalente Satzspiegel für das Format~DIN~A5 aktiviert werden, bei allen
+ anderen Formaten hat diese Einstellung keinen Einfluss.
+\item[calculated]
+ Der Satzspiegel wird anhand der Referenzmaße für das Format~DIN~A4 für das
+ eingestellte Papierformat \emph{skaliert}. Die eigentlich definierten
+ diskreten Maße bei unterschiedlichen Gestaltungshöhen werden ignoriert.
+\end{values}
+%
+\ChangedAt{v2.05}
+Da es häufig sehr restriktive~-- wenn auch meistens völlig willkürliche~--
+Vorgaben für die Seitenränder gibt, besteht außerdem die Möglichkeit, diese
+weitestgehend manuell einzustellen.
+\begin{values}{\Option{cdgeometry}}
+\item[custom]
+ Für die Festlegung der Seitenränder wird durch die \TUDScript-Klassen das
+ Paket \Package{geometry} genutzt. Der Anwender kann mit den durch dieses
+ Paket bereitgestellten Befehlen \Macro{geometry}(\Package{geometry})'none'
+ und \Macro{newgeometry}(\Package{geometry})'none' den Satzspiegel selbst
+ festlegen. Für Hinweise zur Verwendung der Befehle sollte die Dokumentation
+ von \Package{geometry} genutzt werden.
+\end{values}
+\end{Declaration}
-Auf die Installation der PostScript"=Schriften kann dennoch nicht ohne Weiteres
-verzichtet werden. Denn einerseits sind diese für die Kompilierung eines
-\hologo{LaTeX}"~Dokumentes über den klassischen Prozesspfad via
-\Path{latex \textrightarrow{} dvips \textrightarrow{} ps2pdf}~-- wie es
-beispielsweise für die Erstellung von Grafiken mit \Package{pstricks} notwendig
-ist~-- nötig. Andererseits liefern die Schriftfamilien des \CDs keinerlei
-mathematische Glyphen, sodass diese bei der PostScript"=Schriftinstallation aus
-den Schriftpaketen \Package{cmbright} und \Package{iwona} entnommen werden. Bei
-der Nutzung der Schriften im OpenType"=Format ist dies leider nicht so einfach
-möglich, da es schlichtweg an passenden Schriftpaketen für den Mathematiksatz
-im OpenType"=Format mangelt. Weiterhin kommt es auch beim Kerning der Schriften
-zu Problemen.
+\begin{Declaration}[v2.03]{\Option{extrabottommargin=\PName{Höhe}}}[0pt]%
+\printdeclarationlist%
+%
+Mit dieser Option kann die Größe des unteren Seitenrandes angepasst werden,
+wenn der Satzspiegel des \CDs verwendet wird (\seeref{\Option{cdgeometry}}).
+Insbesondere für den Fall, dass bei Seiten im Stil \PageStyle{tudheadings}
+im Fußbereich entweder mit \Macro{footlogo} Drittlogos verwendet werden und
+diese über das optionale Argument oder via \Option{footlogoheight} über die
+Standardhöhe hinaus vergrößert wurden oder mit \Macro{footcontent} ein
+übergroßer Inhalt angegeben wurde, kann dieser unter Umständen etwas zu klein
+sein. Mit der Option \Option{extrabottommargin} wird der Fußbereich durch
+positive Werte vergrößert, negative Werte verkleinern diesen entsprechend.
-Die Verwendung der Schriften des \CDs im OpenType"=Format sollte folglich nur
-erfolgen, wenn eine Installation der PostScript"=Schriften \emph{absolut} nicht
-möglich ist beziehungsweise \hologo{LuaLaTeX} oder \hologo{XeLaTeX} zwingend
-genutzt werden müssen. Hierfür ist es~-- nach der systemweiten Installation der
-OpenType"=Schriften~-- ausreichend, das Paket \Package{fontspec} zu laden.
-\index{Schrift|?)}%
+Alternativ zur Option \Option{extrabottommargin} kann auch die Einstellung
+\Option{cdfoot=\PValueName{Höhe}} mit einem Längenwert verwendet werden.
+Dabei spielt es für beide Optionen keine Rolle, ob eine \hologo{LaTeX}"=Länge,
+ein \hologo{TeX}"=Abstand oder eine \hologo{TeX}"=Ausdehnung als Länge bei der
+Wertzuweisung verwendet wird.
+\end{Declaration}
+
+\minisec{Kopf"~ und Fußzeile im Zusammenspiel mit dem Satzspiegel}
+\index{Layout!Kopfzeile|?}%
+\index{Layout!Fußzeile|?}%
+%
+Da im \CD nicht festgelegt ist, wie die Gestaltung der Kopf"~ und Fußzeilen in
+einer wissenschaftlichen Arbeit auszuführen ist, bleibt dem Nutzer dafür eine
+gewisse Freiheit. Dafür sollte idealerweise das zu \KOMAScript{} gehörige Paket
+\Package{scrlayer-scrpage} genutzt werden.
+In der Dokumentation zu \Package{typearea} wird auch darauf eingegangen, wann
+Kopf"~ und Fußzeile bei der Satzspiegelkonstruktion entweder dem Rand oder dem
+Textkörper zugeschlagen werden sollten. Dies sollte bei der Erstellung eigener
+Kopf"~ und Fußzeilen beachtet werden. Die Einstellung dafür erfolgt mit den
+beiden \KOMAScript"=Optionen
+\Option{headinclude=\PBoolean}(\Package{typearea})'none'|declare| sowie
+\Option{footinclude=\PBoolean}(\Package{typearea})'none'|declare|.
+Diese können~-- unabhängig von der Einstellung zur Satzspiegelgestaltung durch
+die Option \Option{cdgeometry}~-- verwendet werden.
+\minisec{Bindekorrektur}
+\index{Satzspiegel!Bindekorrektur|!}%
+%
+Im Zusammenhang mit den Seitenrändern oder besser dem Satzspiegel ist die durch
+das Paket \Package{typearea} zur Verfügung gesellte \KOMAScript-Option
+\Option{BCOR=\PName{Längenwert}}(\Package{typearea})'none'|declare| zu
+erwähnen. Mit dieser kann bei der Satzspiegelberechnung ein Heftrand respektive
+eine Bindekorrektur berücksichtigt werden. Durch die \TUDScript-Klassen wird
+der mit dieser Option angegebene Wert auch an das Paket \Package{geometry}
+weitergereicht, sodass der Benutzer unabhängig von der Satzspiegelgestaltung
+(\Option{cdgeometry}) die Option \Option{BCOR}(\Package{typearea})'none' nutzen
+kann. So lässt sich eine Bindekorrektur von beispielsweise \unit[5]{mm} mit der
+\emph{Klassenoption} \Option*{BCOR=5mm} festlegen.
+
+Eine Anpassung der Bindekorrektur hat natürlich \emph{immer} eine Änderung der
+verfügbaren Breite des Textbereichs zur Folge hat und führt somit zwingend zu
+einer Anpassung des Satzspiegels. Da die Bindekorrektur jedoch abhängig von der
+Höhe des Buchblocks gewählt werden sollte, welche letztendlich erst mit dem
+Druck des fertiggestellten Dokumentes bestimmt werden kann, muss diese zu
+Beginn abgeschätzt werden.
+%
+\begin{Example}
+Als Faustregel gilt, dass die erforderliche Bindekorrektur in etwa der halben
+Höhe des Buchblocks entsprechen sollte. Dessen Höhe wiederum ist abhängig von
+der Anzahl der Seiten sowie der Dichte des verwendeten Papiers. Wird normales
+Papier mit einer Dichte von \unit[80]{g/m²} verwendet, so entsprechen 100~Blatt
+in etwa einer Höhe von \unit[10]{mm}, bei \unit[100]{g/m²} ca. \unit[12]{mm}.
+Dementsprechend wäre eine Bindekorrektur von \Option*{BCOR=5mm} beziehungsweise
+\Option*{BCOR=6mm} bei diesem Beispiel zu wählen.
+\index{Satzspiegel|)}%
+\end{Example}
-\section{Das Layout des \CDs}
-Das Hauptaugenmerk der neuen Klassen liegt auf der Umsetzung des \CDs der
-\TnUD für \hologo{LaTeX}. Ein großer Teil der definierten Optionen und Befehle
-dient genau dazu und wird nachfolgend beschrieben.
-Einige spezielle Seiten werden im prägnanten Stil mit dem Logo der \TnUD und
+\subsection{Die Gestalt von Titel, Umschlagseite, Teilen sowie Kapiteln \& Co.}
+\index{Layout!Farben|(}%
+\index{Layout!Seitenstil|(}%
+\index{Layout!Überschriften|(}%
+%
+Falls die nachfolgend beschriebene Option \Option{cd=\PSet} aktiviert ist,
+werden einige, spezielle Seiten im prägnanten Stil mit dem Logo der \TnUD und
der dazugehörigen Kopfzeile mit Querbalken gesetzt. Dies betrifft insbesondere
\hyperref[sec:title]{die Umschlagseite und den Titel aus \autoref{sec:title}},
die \hyperref[sec:part]{Teileseiten in \autoref{sec:part}} sowie die
\hyperref[sec:chapter]{Kapitelseiten in \autoref{sec:chapter}}. Mit den
-\PageStyle{tudheadings}"=Seitenstilen oder der \Environment{tudpage}-Umgebung
+\PageStyle{tudheadings}"=Seitenstilen oder der \Environment{tudpage}"=Umgebung
können weitere Seiten in diesem Stil erzeugt werden. Wird das Paket
\Package{tudscrsupervisor} verwendet und mit den bereitgestellten Befehlen oder
Umgebungen eine Aufgabenstellung, ein Gutachten oder ein Aushang erstellt, so
erscheinen auch diese in besagtem Seitenstil.
-
-
-\subsection{Die Gestalt von Titel, Umschlagseite, Teilen und Kapiteln}
+%
\begin{Declaration}[%
- v2.03!neue Farbvarianten
- (\protect\PValue{bicolor} und \protect\PValue{fullcolor}),%
- v2.04!farbiger Querbalken möglich (\protect\PValue{barcolor})%
-]{\Option{cd}[\PSet]}[true]
+ v2.03!\Option{cd=bicolor}:%
+ Farbeinsatz nur im Kopf mit farbig abgesetztem Querbalken;
+ v2.03!\Option{cd=fullcolor}:%
+ voller Farbeinsatz mit farbig abgesetztem Querbalken;%
+ v2.04!\Option{cd=barcolor}:nur farbig abgesetzter Querbalken;%
+]{\Option{cd=\PSet}}[true]
\printdeclarationlist%
-\index{Layout}%
%
-Mit dieser Option wird festgelegt, ob und wie das \CD der \TnUD verwendet wird.
-Sie hat Einfluss auf die Ausprägung von Titel"~, Teil"~, und Kapitelseiten.
+Mit dieser Option wird festgelegt, ob und wie das \TUDCD im gesamten Dokument
+verwendet wird. Sie hat Einfluss auf die Ausprägung von Titel"~, Teil"~, und
+Kapitelseiten sowie die Überschriften der weiteren Gliederungsebenen.
%
-\begin{values}
+\begin{values}{\Option{cd}}
\itemfalse
Diese Einstellung erzeugt das Standard"=Verhalten der \KOMAScript"=Klassen,
es wird kein \CD genutzt.
@@ -566,60 +863,87 @@ Sie hat Einfluss auf die Ausprägung von Titel"~, Teil"~, und Kapitelseiten.
schwarze Schrift für Titel, Teil"~ und Kapitelüberschriften verwendet. Die
Ausprägung des Seitenkopfes ist abhängig von der Option \Option{cdhead}.
\item[lightcolor/pale]
- Die Einstellung entspricht weitestgehend der Option \Option{cd}[true],
+ Die Einstellung entspricht weitestgehend der Option \Option{cd=true},
allerdings wird die primäre Hausfarbe \Color{HKS41} für den Kopf des
- \PageStyle{tudheadings}"=Seitenstils und die Schrift genutzt.
+ \PageStyle{tudheadings}"=Seitenstils und die Überschriften genutzt.
\item[barcolor]
\ChangedAt{v2.04} Zusätzlich zur vorherigen Einstellung wird außerdem der
- Querbalken mit einem farbigen Hintergrund gesetzt.
+ Querbalken farbig abgesetzt.
\item[bicolor/bichrome]
\ChangedAt{v2.03} Der Kopf wird mit einem farbigen Hintergrund in der
- Hausfarbe gesetzt, auch der Querbalken wird farbig hinterlegt. Die Schrift
- wird in der primären Hausfarbe gesetzt.
+ Hausfarbe gesetzt, auch der Querbalken wird farbig hinterlegt. Für die
+ Überschriften wird die primären Hausfarbe verwendet.
\item[color]
Der Titel sowie Teil"~ und Kapitelseiten werden allesamt farbig und im \CD
gestaltet, der Seitenkopf wird in der primären Hausfarbe \Color{HKS41}
gesetzt, der Querbalken erhält Linien als Begrenzung.
-\item[full/fullcolor]
+\item[fullcolor/full]
\ChangedAt{v2.03} Entspricht der vorherigen Einstellung, allerdings wird der
Querbalken nicht durch Linien begrenzt sondern farbig hinterlegt.
\end{values}
\end{Declaration}
-\subsubsection{Einstellungen für Titel, Umschlagseite, Teile und Kapitel}
+\subsubsection{Individuelle Einstellungen für einzelne Elemente des Layouts}
Das Verhalten aller für das Layout relevanten Elemente wird von der eben zuvor
-erläuterten Option \Option{cd}[\PSet] bestimmt. Dies betrifft zum einen sowohl
+erläuterten Option \Option{cd=\PSet} bestimmt. Dies betrifft zum einen sowohl
den Titel~(\Macro{maketitle}) als auch die Umschlagseite~(\Macro{makecover})
-und zum anderen alle Teileseiten~(\Macro{part}, \Macro{addpart}) und
-Kapitelseiten~(\Macro{chapter}, \Macro{addchap}).
+und zum anderen alle Teileseiten
+(%
+ \Macro{part}(\Package{koma-script})'none',
+ \Macro{addpart}(\Package{koma-script})'none'%
+)
+und Kapitelseiten
+(%
+ \Macro{chapter}(\Package{koma-script})'none',
+ \Macro{addchap}(\Package{koma-script})'none'%
+)
+sowie alle darunter liegenden Gliederungsebenen.
+
+Soll ein bestimmtes Element des Layouts abweichend von der allgemeinen
+Einstellung für das gesamte Dokument erscheinen, so kann eine der folgenden
+Optionen genutzt werden, um dieses individuell anzupassen und die mit
+\Option{cd=\PSet} eingestellten Vorgaben für das jeweilige Element zu
+überschreiben.%
+\footnote{%
+ \Option{cdtitle} für den Titel, \Option{cdcover} für die Umschlagseite,
+ \Option{cdpart} für Teile, \Option{cdchapter} für Kapitel sowie
+ \Option{cdsection} für alle darunter liegenden Gliederungsebenen%
+}
+Die gültigen Wertzuweisungen für die einzelnen Elemente entsprechend dabei den
+möglichen Werten für die Option \Option{cd=\PSet}.
-Soll ein bestimmtes Element des Layouts abweichend erscheinen, so kann eine der
-folgenden Optionen genutzt werden, um dieses individuell anzupassen. Die
-gültigen Wertzuweisungen für die einzelnen Elemente entsprechend dabei den
-möglichen Werten für die Option \Option{cd}.
+Zu beachten ist dabei, dass die verwendete Schrift für die Elemente des Layouts
+abhängig von der Option \Option{cdfont=\PSet} ist. Für Titel- und Umschlagseite
+kann diese direkt über das optionale Argument von \Macro{maketitle} respektive
+\Macro{makecover} geändert werden.
\begin{Declaration}[%
- v2.03!neue Farbvarianten
- (\protect\PValue{bicolor} und \protect\PValue{fullcolor}),%
- v2.04!farbiger Querbalken möglich (\protect\PValue{barcolor})%
-]{\Option{cdtitle}[\PSet]}
+ v2.03!\Option{cdtitle=bicolor}:%
+ Farbeinsatz nur im Kopf mit farbig abgesetztem Querbalken;
+ v2.03!\Option{cdtitle=fullcolor}:%
+ voller Farbeinsatz mit farbig abgesetztem Querbalken;
+ v2.04!\Option{cdtitle=barcolor}:nur farbig abgesetzter Querbalken;%
+]{\Option{cdtitle=\PSet}}
\printdeclarationlist%
-\index{Titel}\index{Layout!Titel}%
+\index{Titel|?}%
%
Mit der Option \Option{cdtitle} kann die allgemeine Einstellung für den Titel
-überschrieben werden. Es kann zwischen dem normalen (\Option{cdtitle}[false])
+überschrieben werden. Es kann zwischen dem normalen (\Option*{cdtitle=false})
und dem im \CD umgeschaltet werden. Die neue Titelseite unterstützt alle durch
\KOMAScript{} definierten Befehle für den Titel.%
-\footnote{\raggedright%
- \Macro{extratitle}\Parameter{Schmutztitel},\Macro{titlehead}\Parameter{Kopf},
- \Macro{subject}\Parameter{Typisierung},\Macro{title}\Parameter{Titel},
- \Macro{subtitle}\Parameter{Untertitel},\Macro{author}\Parameter{Autor},
- \Macro{date}\Parameter{Datum},\Macro{publishers}\Parameter{Verlag},
- \Macro{and} und \Macro{thanks}\Parameter{Fußnote} sowie
- \Macro{uppertitleback}\Parameter{Titelrückseitenkopf},
- \Macro{lowertitleback}\Parameter{Titelrückseitenfuß}
- und \Macro{dedication}\Parameter{Widmung}
+\footnote{%
+ \Macro{extratitle}[\Parameter{Schmutztitel}](\Package{koma-script}),
+ \Macro{titlehead}[\Parameter{Kopf}](\Package{koma-script}),
+ \Macro{subject}[\Parameter{Typisierung}], \Macro{title}[\Parameter{Titel}],
+ \Macro{subtitle}[\Parameter{Untertitel}], \Macro{author}[\Parameter{Autor}],
+ \Macro{and}, \Macro{thanks}[\Parameter{Fußnote}](\Package{koma-script}),
+ \Macro{publishers}[\Parameter{Verlag}](\Package{koma-script}),
+ \Macro{date}[\Parameter{Datum}] und
+ \Macro{dedication}[\Parameter{Widmung}](\Package{koma-script}) sowie
+ \Macro{uppertitleback}[\Parameter{Titelrückseitenkopf}](\Package{koma-script})
+ und
+ \Macro{lowertitleback}[\Parameter{Titelrückseitenfuß}](\Package{koma-script})%
}
Zusätzlich werden viele neue Felder definiert, welche vor allem für eine
wissenschaftliche Arbeit von Relevanz sind. Genaueres dazu
@@ -628,51 +952,77 @@ der Titelseite wird diese immer mit \Macro{maketitle} erzeugt.
\end{Declaration}
\begin{Declaration}[%
- v2.02,%
- v2.03!neue Farbvarianten
- (\protect\PValue{bicolor} und \protect\PValue{fullcolor}),%
- v2.04!farbiger Querbalken möglich (\protect\PValue{barcolor})%
-]{\Option{cdcover}[\PSet]}
+ v2.02;%
+ v2.03!\Option{cdcover=bicolor}:%
+ Farbeinsatz nur im Kopf mit farbig abgesetztem Querbalken;
+ v2.03!\Option{cdcover=fullcolor}:%
+ voller Farbeinsatz mit farbig abgesetztem Querbalken;
+ v2.04!\Option{cdcover=barcolor}:nur farbig abgesetzter Querbalken;%
+]{\Option{cdcover=\PSet}}
\printdeclarationlist%
-\index{Umschlagseite|!}\index{Titel!Umschlagseite}\index{Layout!Umschlagseite}%
+\index{Umschlagseite|?}%
%
Die \TUDScript-Klassen führen zusätzlich den Befehl \Macro{makecover} ein, mit
dem sich neben dem Titel eine separate Umschlagseite erzeugen lässt. Diese ist
in ihrer Gestalt der Titelseite sehr ähnlich, wird normalerweise jedoch in
einem anderen Satzspiegel als dem des Buchblocks gesetzt. Mit der Option
-\Option{cdcover} kann~-- unabhängig von \Option{cd}~-- das Erscheinungsbild
-der Umschlagseite geändert werden. Wird \Option{cdcover}[false] gewählt,
-entspricht die Umschlagseite dem originalen \KOMAScript-Titel. Die Verwendung
-des Befehls \Macro{makecover} sowie die dazugehörigen Parameter werden
-detailliert in \autoref{sec:title} erläutert.
+\Option{cdcover} kann~-- unabhängig von \Option{cd=\PSet}~-- das Aussehen der
+Umschlagseite geändert werden. Wird \Option*{cdcover=false} gewählt, entspricht
+die Umschlagseite dem originalen \KOMAScript-Titel. Die Verwendung des Befehls
+\Macro{makecover} sowie die dazugehörigen Parameter werden detailliert in
+\autoref{sec:title} erläutert.
\end{Declaration}
\begin{Declaration}[%
- v2.03!neue Farbvarianten
- (\protect\PValue{bicolor} und \protect\PValue{fullcolor}),%
- v2.04!farbiger Querbalken möglich (\protect\PValue{barcolor})%
-]{\Option{cdpart}[\PSet]}
+ v2.03!\Option{cdpart=bicolor}:%
+ Farbeinsatz nur im Kopf mit farbig abgesetztem Querbalken;
+ v2.03!\Option{cdpart=fullcolor}:%
+ voller Farbeinsatz mit farbig abgesetztem Querbalken;
+ v2.04!\Option{cdpart=barcolor}:nur farbig abgesetzter Querbalken;%
+]{\Option{cdpart=\PSet}}
\printdeclarationlist%
-\index{Teileseiten}\index{Layout!Teileseiten}%
+\index{Layout!Teileseiten|?}%
%
-Für die Teileseiten kann der Wert des Schlüssels \Option{cd} separat
+Für die Teileseiten kann der Wert des Schlüssels \Option{cd=\PSet} separat
überschrieben und somit deren Layout respektive Erscheinungsbild beeinflusst
-werden, welches bei der Benutzung der Befehle \Macro{part} beziehungsweise
-\Macro{addpart} und deren Sternversionen genutzt wird.
+werden, welches bei der Benutzung der Befehle
+\Macro{part}(\Package{koma-script})'none' und
+\Macro{addpart}(\Package{koma-script})'none' sowie deren Sternversionen
+verwendet wird. In \autoref{sec:part} sind weitere Hinweise zur Teileseite im
+\CD zu finden.
\end{Declaration}
\begin{Declaration}[%
- v2.03!neue Farbvarianten
- (\protect\PValue{bicolor} und \protect\PValue{fullcolor}),%
- v2.04!farbiger Querbalken möglich (\protect\PValue{barcolor})%
-]{\Option{cdchapter}[\PSet]}
+ v2.03!\Option{cdchapter=bicolor}:%
+ Farbeinsatz nur im Kopf mit farbig abgesetztem Querbalken;
+ v2.03!\Option{cdchapter=fullcolor}:%
+ voller Farbeinsatz mit farbig abgesetztem Querbalken;
+ v2.04!\Option{cdchapter=barcolor}:nur farbig abgesetzter Querbalken;%
+]{\Option{cdchapter=\PSet}}
+\printdeclarationlist%
+\index{Layout!Kapitelseiten|?}%
+%
+Für Kapitelseiten kann der Schlüsselwert \Option{cd=\PSet} ebenfalls angepasst
+und damit das Layout respektive Erscheinungsbild geändert werden, das bei der
+Verwendung von \Macro{chapter}(\Package{koma-script})'none' beziehungsweise
+\Macro{addchap}(\Package{koma-script})'none' und den dazugehörigen
+Sternversionen genutzt wird. Weitere Hinweise zur Kapitelseite im \CD sind in
+\autoref{sec:chapter} zu finden.
+\end{Declaration}
+
+\begin{Declaration}[v2.05]{\Option{cdsection=\PSet}}
\printdeclarationlist%
-\index{Kapitelseiten}\index{Layout!Kapitelseiten}%
%
-Für Kapitelseiten kann der Schlüsselwert \Option{cd} ebenfalls angepasst und
-damit das Layout respektive Erscheinungsbild geändert werden, das bei der
-Verwendung von \Macro{chapter} beziehungsweise \Macro{addchap} und den
-dazugehörigen Sternversionen genutzt wird.
+Für Überschriften der weiteren Gliederungsebenen
+\Macro{section}(\Package{koma-script})'none',
+\Macro{subsection}(\Package{koma-script})'none',
+\Macro{subsubsection}(\Package{koma-script})'none' sowie
+\Macro{paragraph}(\Package{koma-script})'none' und
+\Macro{subparagraph}(\Package{koma-script})'none'
+werden in der primären Hausfarbe \Color{HKS41} ausgegeben, falls über die
+Option \Option{cd=\PSet} eine farbige Ausprägung des Layouts eingestellt wurde.
+Mit der Angabe von \Option*{cdsection=true} erscheinen die Überschriften der
+genannten Gliederungsebenen ohne Farbeinsatz.
\end{Declaration}
%
\begin{Example}
@@ -681,53 +1031,92 @@ Schrift gesetzt werden, so kann dies folgendermaßen erreicht werden:
\begin{Code}[escapechar=§]
\documentclass[cd=true,cdtitle=color]{§\PName{Dokumentklasse}§}
\end{Code}
+\index{Layout!Farben|)}%
+\index{Layout!Seitenstil|)}%
\end{Example}
-\subsubsection{Position von Überschriften}
-\begin{Declaration}[v2.02]{\Length{pageheadingsvskip}}
-\begin{Declaration}[v2.02]{\Length{headingsvskip}}
-\printdeclarationlist%
-\index{Überschriften!Position}\index{Titel!Position}%
-\index{Teileüberschriften}\index{Kapitelüberschriften}%
-\index{Kapitelseiten}\index{Layout!Kapitelseiten}\index{Layout!Überschriften}%
-%
-Diese beiden Längen haben Auswirkung auf die vertikale Position bestimmter
-Überschriften. Mit \Length{pageheadingsvskip} lassen sich sowohl der Titel auf
-der Titelseite (\Option{titlepage}[true]) als auch die Überschriften von Teilen
-und Kapiteln, welche als einzelne Kapitelseite (\Option{chapterpage}[true])
-gesetzt werden, verschieben. Demgegenüber erlaubt es \Length{headingsvskip},
-sowohl den Titel innerhalb eines Titelkopfes (\Option{titlepage}[false]) als
-auch die Überschrift eines Kapitels bei deaktivierter Kapitelseite
-(\Option{chapterpage}[false]) in ihrer vertikalen Position anzupassen.
+\subsubsection{Die vertikale Position der Überschriften}
+\begin{Declaration}[v2.05]{\Option{pageheadingsvskip=\PName{Längenwert}}}
+\begin{Declaration}[v2.05]{\Option{headingsvskip=\PName{Längenwert}}}
+\printdeclarationlist%
+\index{Layout!Teileseiten|?}%
+\index{Layout!Kapitelseiten|?}%
+%
+\ToDo[doc]{Attention raus, sobald neue Gliederungsbefehle umgesetzt}[v2.06]
+Mit diesen beiden Optionen kann die vertikale Position spezieller Überschriften
+verändert werden. Mit der Option \Option{pageheadingsvskip} lässt sich sowohl
+der Titel auf einer Titelseite
+(\KOMAScript-Option \Option{titlepage=true}(\Package{koma-script})'none') als
+auch die Überschriften von separaten Kapitelseiten (\Option{chapterpage=true})
+und Teilen vertikal verschieben. Demgegenüber kann mit der zweiten Option
+\Option{headingsvskip}, sowohl den Titel des Titelkopfes
+(\KOMAScript-Option \Option{titlepage=false}(\Package{koma-script})'none') als
+auch die Kapitelüberschrift bei deaktivierter Kapitelseite
+(\Option{chapterpage=false}) in ihrer vertikalen Position anzupassen.
+\Attention{%
+ Es ist zu beachten, dass von einer Änderung der \KOMAScript-Befehle
+ \Macro*{partheadstartvskip} und \Macro*{chapterheadstartvskip} dringlichst
+ abgeraten wird und stattdessen die hier erläuterten Längen genutzt werden
+ sollten, da ansonsten schwerwiegende Fehler auftreten können.
+}
Die zuvor genannten Überschriften werden normalerweise im Layout relativ tief
im Textbereich gesetzt. Mit negativen Werten werden die Überschriften nach oben
verschoben, wobei darauf geachtet werden sollte, dass diese sich danach noch
innerhalb des Satzspiegels befinden. Positive Werte setzen die Überschriften
dementsprechend tiefer.
+\index{Layout!Überschriften|)}%
\end{Declaration}
\end{Declaration}
\subsection{Seiten im Stil des \CDs}
+\tudhyperdef*{sec:tudheadings}%
+\index{Layout!Seitenstil|?(}%
+%
+\begin{Declaration}{\Macro{faculty}[\Parameter{Fakultät}]}
+\begin{Declaration}{\Macro{department}[\Parameter{Einrichtung}]}
+\begin{Declaration}{\Macro{institute}[\Parameter{Institut}]}
+\begin{Declaration}{\Macro{chair}[\Parameter{Lehrstuhl}]}
+\begin{Declaration}{\Macro{extraheadline}[\Parameter{Textzeile}]}
+\printdeclarationlist%
+\index{Layout!Kopfzeile}%
+\index{Layout!Querbalken}%
+%
+Für den Seitenstil des \TUDCDs charakteristisch ist die Kopfzeile mit dem
+prägnanten Querbalken. In dieser wird~-- falls angegeben~-- in fetter Schrift
+die Fakultät ausgegeben, danach folgen durch Kommas getrennt die Einrichtung,
+das Institut und der Lehrstuhl beziehungsweise die Professur. Sollte der Platz
+in der ersten Zeile nicht ausreichen, erfolgt ein automatischer Zeilenumbruch.
+
+In besonderen Ausnahmefällen erlaubt das \CD die Angabe einer zusätzlichen
+zweiten beziehungsweise dritten Zeile unterhalb der Angaben des Bereichs an der
+\TnUD, welche weitere, frei wählbare Angaben enthält. Diese kann mit dem Befehl
+\Macro{extraheadline}[\Parameter{Textzeile}] definiert werden.
+\end{Declaration}
+\end{Declaration}
+\end{Declaration}
+\end{Declaration}
+\end{Declaration}
+%
\begin{Declaration}[v2.02]{\PageStyle{tudheadings}}
\begin{Declaration}[v2.02]{\PageStyle{plain.tudheadings}}
\begin{Declaration}[v2.02]{\PageStyle{empty.tudheadings}}
\printdeclarationlist%
-\label{sec:tudheadings}
%
\ChangedAt*{%
- v2.03!Seitenstile um zweifarbigen Kopf und farbigen Fuß erweitert%
-}%
-Ein zentrales Element des \CDs der \TnUD ist der prägnante Seitenkopf mit der
-Angabe von Fakultät~(\Macro{faculty}), Einrichtung~(\Macro{department}),
+ v2.03:Seitenstile um zweifarbigen Kopf und farbigen Fuß erweitert%
+}
+Ein zentrales Element des \TUDCDs ist der prägnante Seitenkopf mit der Angabe
+von Fakultät~(\Macro{faculty}), Einrichtung~(\Macro{department}),
Institut~(\Macro{institute}) und Lehrstuhl~(\Macro{chair}) im dazugehörigen
Querbalken. Durch die Nutzung des Paketes \Package{scrlayer-scrpage} lassen
sich entweder einzelne Seiten oder auch ganze Dokumente sehr einfach in diesem
-Stil setzen. Hierzu muss lediglich mit \Macro{pagestyle}\Parameter{Seitenstil}
-einer der Seitenstile geladen werden.
+Stil setzen. Dazu muss lediglich mit
+\Macro{pagestyle}[\Parameter{Seitenstil}](\Package{koma-script})'none' einer
+der Seitenstile geladen werden.
Allen Seitenstilen gemein ist der typische Kopf mit dem charakteristischen
Querbalken, dessen Gestalt für \emph{alle} Seitenstile gleichermaßen über die
@@ -736,7 +1125,7 @@ lässt sich ein zusätzliches Zweitlogo im Kopfbereich ausgegeben.
\Attention{%
Für die speziellen Layout-Elemente Titel und Umschlagseite sowie Teile- und
Kapitelseiten wird die Einstellung von \Option{cdhead} durch die Nutzung der
- Option~\Option{cd} überschrieben.
+ Option~\Option{cd=\PSet} überschrieben.
}
Die Ausprägung des Fußes unterscheidet sich bei den einzelnen Seitenstilen.
@@ -745,103 +1134,71 @@ Stile~-- oder vielmehr das Seitenstil-Paar~-- \PageStyle{tudheadings} und
\PageStyle{plain.tudheadings} übernehmen die Einstellungen für die Fußzeile aus
der Anwenderschnittstelle von \Package{scrlayer-scrpage}.%
\footnote{%
- Es können die Befehle \Macro{lefoot}, \Macro{cefoot} und \Macro{refoot} sowie
- \Macro{lofoot}, \Macro{cofoot} und \Macro{rofoot} respektive \Macro{ofoot},
- \Macro{cfoot} und \Macro{ifoot} genutzt werden.
-}
-Wie diese zu verwenden ist, kann der \KOMAScript"=Anleitung entnommen werden.
-Alternativ zu einer eigenen Definition der Fußzeile lässt sich außerdem die
-Option \Option{cdfoot} verwenden. Zusätzlich kann über \Macro{footcontent} ein
-freier Inhalt für den Fußbereich definiert werden, mit \Macro{footlogo} ist die
+ Es können die Befehle
+ \Macro{lefoot}(\Package{scrlayer-scrpage})'none',
+ \Macro{cefoot}(\Package{scrlayer-scrpage})'none' und
+ \Macro{refoot}(\Package{scrlayer-scrpage})'none' sowie
+ \Macro{lofoot}(\Package{scrlayer-scrpage})'none',
+ \Macro{cofoot}(\Package{scrlayer-scrpage})'none' und
+ \Macro{rofoot}(\Package{scrlayer-scrpage})'none' respektive
+ \Macro{ofoot}(\Package{scrlayer-scrpage})'none',
+ \Macro{cfoot}(\Package{scrlayer-scrpage})'none' und
+ \Macro{ifoot}(\Package{scrlayer-scrpage})'none'
+ genutzt werden.%
+}
+Wie die einzelnen Befehle zur Individualisierung der Fußzeile zu verwenden
+sind, kann der \scrguide[\KOMAScript-Anleitung] entnommen werden. Alternativ
+zu einer eigenen Definition der Fußzeile lässt sich außerdem die Option
+\Option{cdfoot} verwenden. Zusätzlich kann über \Macro{footcontent} ein freier
+Inhalt für den Fußbereich definiert werden, mit \Macro{footlogo} ist die
Ausgabe von einem oder mehreren Logos in diesem möglich. Die verwendete Schrift
im Fußbereich wird durch das Schriftelement~\Font{tudheadings} festgelegt.
-Sobald einer der definierten Stile mit \Macro{pagestyle}\Parameter{Seitentil}
-aktiviert wurde, sind die beiden Seitenstile \PageStyle{tudheadings} sowie
+Sobald einer der definierten Stile mit
+\Macro{pagestyle}[\Parameter{Seitentil}](\Package{koma-script})'none' aktiviert
+wurde, sind die beiden Seitenstile \PageStyle{tudheadings} sowie
\PageStyle{plain.tudheadings} zusätzlich unter den Namen \PageStyle{headings}
respektive \PageStyle{plain} verwendbar. Dies hat den Vorteil, dass bei
Optionen oder Befehlen, welche automatisch zwischen den beiden Seitenstilen
\PageStyle{headings} und \PageStyle{plain} umschalten, durch die einmalige
-Auswahl von einem der \PageStyle{tudheadings}-Stilen nun zwischen diesen
+Auswahl von einem der \PageStyle{tudheadings}"=Stilen nun zwischen diesen
umgeschaltet wird.
Der Seitenstil \PageStyle{empty} erzeugt allerdings weiterhin eine komplett
leere Seite. Soll eine Seite mit der prägnanten Kopfzeile der \TnUD und leerem
-Seitenfuß erschienen, so muss \Macro{pagestyle}\PParameter{empty.tudheadings}
+Seitenfuß erschienen, so muss \Macro*{pagestyle}[\PParameter{empty.tudheadings}]
manuell aufgerufen werden. Um auf das normale Verhalten von \KOMAScript{}
-zurückzuschalten, muss einer der beiden Stile \PageStyle{scrheadings}
-beziehungsweise \PageStyle{plain.scrheadings} aktiviert werden.
-
-\Attention{%
- Die beschriebenen Seitenstile werden erst \emph{nach} dem Laden des Paketes
- \Package{scrlayer-scrpage} definiert. Wird dieses nicht durch den Anwender
- geladen, sollte \Macro{pagestyle}\Parameter{Seitenstil} erst nach
- \Macro*{begin}\PParameter{document} verwendet werden.
-}%
-\end{Declaration}
-\end{Declaration}
-\end{Declaration}
-
-\begin{Declaration}[v2.04]{\Font{tudheadings}}
-\printdeclarationlist%
-\index{Schriftelemente}
-%
-Im Fußbereich der Seiten im \PageStyle{tudheadings}-Seitenstil wird das
-Schriftelement~\Font{tudheadings} verwendet. Dieses wirkt sich auf die
-Seitenzahlen, den Kolumnentitel und die mit \Macro{footcontent} angegebenen
-Inhalte aus. Hierüber wird die Wahl der richtigen Schriftfarbe in Abhängigkeit
-vom Seitenhintergrund und den Einstellungen für die Optionen \Option{cdhead}
-sowie \Option{cdfoot} realisiert. Wie \Font{tudheadings} angepasst werden kann,
-ist in \autoref{sec:fonts:elements} zu finden.
-\end{Declaration}
-
-\begin{Declaration}{\Macro{faculty}\Parameter{Fakultät}}
-\begin{Declaration}{\Macro{department}\Parameter{Einrichtung}}
-\begin{Declaration}{\Macro{institute}\Parameter{Institut}}
-\begin{Declaration}{\Macro{chair}\Parameter{Lehrstuhl}}
-\begin{Declaration}{\Macro{extraheadline}\Parameter{Textzeile}}
-\printdeclarationlist%
-\index{Kopfzeile}\index{Layout!Kopfzeile}%
-\index{Querbalken}\index{Layout!Querbalken}%
-%
-Für den Seitenstil des \CDs der \TnUD typisch ist die Kopfzeile mit dem
-charakteristischen Querbalken. In dieser wird~-- falls angegeben~-- in fetter
-Schrift die Fakultät ausgegeben, danach folgen durch Kommas getrennt die
-Einrichtung, das Institut und der Lehrstuhl beziehungsweise die Professur.
-Sollte der Platz in der ersten Zeile nicht ausreichen, erfolgt ein
-automatischer Zeilenumbruch.
-
-In besonderen Ausnahmefällen erlaubt das \CD die Angabe einer zusätzlichen
-zweiten beziehungsweise dritten Zeile unterhalb der Angaben des Bereichs an der
-\TnUD, welche weitere, frei wählbare Angaben enthält. Diese kann mit dem Befehl
-\Macro{extraheadline}\Parameter{Textzeile} definiert werden.
-\end{Declaration}
-\end{Declaration}
+zurückzuschalten, muss mit \Macro*{pagestyle}[\Parameter{Seitentil}] einer der
+beiden Seitenstile \PageStyle{scrheadings}(\Package{scrlayer-scrpage})'none'
+oder \PageStyle{plain.scrheadings}(\Package{scrlayer-scrpage})'none' aktiviert
+werden.
+\index{Layout!Seitenstil|?)}%
\end{Declaration}
\end{Declaration}
\end{Declaration}
\begin{Declaration}[%
- v2.03,%
- v2.04!farbiger Querbalken möglich (\PValue{barcolor})%
-]{\Option{cdhead}[\PSet]}[true][%
- \Option{cdfont}[false]:false%
-]
+ v2.03;%
+ v2.04!\Option{cdhead=barcolor}:nur farbig abgesetzter Querbalken;%
+ v2.05!\Option{cdhead=date}:Datum zwischen Kopf- und Textbereich;%
+]{\Option{cdhead=\PSet}}[true]
\printdeclarationlist%
-\index{Kopfzeile}\index{Layout!Kopfzeile}%
-\index{Querbalken}\index{Layout!Querbalken}%
+\index{Layout!Seitenstil|(}%
+\index{Layout!Kopfzeile}%
+\index{Layout!Querbalken}%
+\index{Datum}%
%
Mit dieser Option lassen sich für die \PageStyle{tudheadings}"=Seitenstile
sowohl die Gestalt des Logos sowie des Querbalkens als auch die darin
verwendete Schrift beeinflussen. Die folgenden Werte können für eine Anpassung
der Schriftart im Balken verwendet werden:
%
-\begin{values}
+\begin{values}{\Option{cdhead}}
\itemfalse
- Sollte mit \Option{cdfont}[false] die Verwendung der Hausschrift im Stil des
- \CDs der \TnUD deaktiviert worden sein, wird die Kopfzeile im Querbalken in
- den Serifenlosen der genutzten Schrift gesetzt. Sind die Hausschriften
- aktiviert, hat diese Einstellung keinen Einfluss.
+ Sollte mit \Option{cdfont=false} die Verwendung der Hausschrift im Stil des
+ \TUDCDs deaktiviert worden sein, wird die Kopfzeile im Querbalken in den
+ Serifenlosen der genutzten Schrift gesetzt. Sind die Hausschriften aktiviert,
+ hat diese Einstellung keinen Einfluss.
\itemtrue*[light/lightfont/noheavyfont]
Im Querbalken wird für \Macro{faculty} \textubn{Univers~65~Bold} verwendet,
die Felder \Macro{department}, \Macro{institute}, \Macro{chair} und
@@ -854,7 +1211,7 @@ der Schriftart im Balken verwendet werden:
Bei der Ausprägung des Kopfes und des Querbalkens gibt es mehrere Varianten.
Einerseits kann der Querbalken mit zwei Außenlinien dargestellt werden:
%
-\begin{values}
+\begin{values}{\Option{cdhead}}
\item[nocolor/monochrome]
Der Kopf und die Linien des Querbalkens erscheinen in schwarzer Farbe.
\item[lightcolor/pale]
@@ -862,15 +1219,15 @@ Einerseits kann der Querbalken mit zwei Außenlinien dargestellt werden:
\end{values}
%
Andererseits ist auch eine Darstellung mit mehr Farbeinsatz möglich, bei
-welcher der Querbalken und gegebenenfalls der ganze Seitenkopf farblich
+welcher der Querbalken und gegebenenfalls der ganze Seitenkopf farbig
abgesetzt wird.
%
-\begin{values}
+\begin{values}{\Option{cdhead}}
\item[barcolor]
\ChangedAt{v2.04} Im Gegensatz zur vorherigen Einstellung wird der
Querbalken mit farbigem Hintergrund verwendet.
\item[bicolor/bichrome]
- \ChangedAt{v2.03} Die Kopfzeile wird farblich abgesetzt, wobei der
+ \ChangedAt{v2.03} Die Kopfzeile wird farbig abgesetzt, wobei der
Hintergrund des Logos und der Querbalken unterschiedlich ausfallen. Die
Außenlinien der Querbalkens entfallen.
\end{values}
@@ -878,83 +1235,117 @@ abgesetzt wird.
Für den Fall, dass der Querbalken lediglich mit zwei Außenlinien dargestellt
wird, kann zusätzlich dessen Laufweite festgelegt werden:
%
-\begin{values}
+\begin{values}{\Option{cdhead}}
\item[textwidth/slim]
Der Querbalken im Kopf erstreckt sich nur über den Textbereich. Diese
Einstellung ist insbesondere sinnvoll, wenn ein randloser Ausdruck technisch
- nicht möglich ist.
+ nicht möglich ist.
\item[paperwidth/wide]
Die horizontale Ausdehnung des Querbalkens erstreckt sich über die komplette
Seitenbreite bis an den Blattrand. Dieses Verhalten ist standardmäßig im
farbigen Layout aktiviert.
\end{values}
+%
+\ChangedAt{v2.05}
+Neben den zuvor beschriebenen Möglichkeiten zur Gestaltung des Kopfbereiches
+kann auf allen Seiten mit aktiviertem \PageStyle{tudheadings}"=Seitenstil
+unterhalb des Querbalkens das mit \Macro{date} angegebene Datum rechtsbündig
+eingeblendet werden.
+%
+\begin{values}{\Option{cdhead}}
+\item[date/showdate]
+ Das eingestellte Datum wird rechts oberhalb vom Textbereich eingeblendet.
+\item[nodate/hidedate]
+ Es erscheint kein Datum zwischen Kopf- und Textbereich.
+\end{values}
\end{Declaration}
\begin{Declaration}[%
- v2.03!farbiger Hintergrund der Fußzeile möglich%
-]{\Option{cdfoot}[\PSet]}[false]%
+ v2.03!\Option{cdfoot=color}:farbiger Hintergrund der Fußzeile;%
+ v2.03!\Option{cdfoot=\PValueName{Höhe}};%
+]{\Option{cdfoot=\PSet}}[false]%
\printdeclarationlist%
-\index{Kolumnentitel}\index{Layout!Kolumnentitel}
+\index{Layout!Fußzeile}%
+\index{Layout!Kolumnentitel}%
\index{Satzspiegel!doppelseitig}%
Die \TUDScript-Klassen sind~-- insbesondere aufgrund der Möglichkeit zur
Verwendung des Paketes \Package{scrlayer-scrpage}~-- bei der Gestaltung der
Kopf"~ und Fußzeilen sehr flexibel und individuell anpassbar. Die Ausprägung
und der Inhalt dieser ist nicht explizit durch das \CD vorgegeben und können
-durch den Anwender beliebig gewählt und geändert werden. Wird die Klassenoption
-\Option{automark} angegeben, werden für das automatische Setzen der Marken die
-Titel der Gliederungsebenen verwendet. Genaueres hierzu sowie der Möglichkeit,
-die Kolumnentitel manuell festzulegen, ist dem Handbuch von \KOMAScript{} zu
-entnehmen.
+durch den Anwender beliebig gewählt und geändert werden.
-Eine Möglichkeit für deren Gestaltung zeigt das Handbuch für das \CD der \TnUD.
-Dieses wird ohne Kopf"~ und mit einer einfachen Fußzeile gesetzt, welche den
-aktuellen Kolumnentitel sowie die Paginierung enthält. Mit \Option{cdfoot} kann
-diese Ausprägung aktiviert werden, was auch für dieses Anwenderhandbuch
-geschehen ist.
+Eine Möglichkeit für deren Gestaltung zeigt das Handbuch für das \TUDCD. Dieses
+wird ohne Kopf"~ und mit einer einfachen Fußzeile gesetzt, welche den aktuellen
+Kolumnentitel sowie die Paginierung enthält. Mit \Option{cdfoot} kann diese
+Ausprägung aktiviert werden, was auch für dieses Anwenderhandbuch geschehen ist.
%
-\begin{values}
+\begin{values}{\Option{cdfoot}}
\itemfalse
Die Kopf"~ und Fußzeilen zeigen Standardverhalten, zur manuellen Änderung
- dieser sollte unbedingt das \KOMAScript"=Paket \Package{scrlayer-scrpage}
- verwendet werden.
+ sollte unbedingt das \KOMAScript"=Paket \Package{scrlayer-scrpage} verwendet
+ werden.
\itemtrue*
- Die Fußzeilen des Dokumentes werden wie im Handbuch des \CDs der \TnUD
- mit Kolumnentitel und Seitenzahl gesetzt. Im doppelseitigen Satz
- (\Option{twoside}[true]) wird die Paginierung außen platziert.
+ Die Fußzeilen des Dokumentes werden äquivalent zum Handbuch des \TUDCDs mit
+ lebenden Kolumnentitel und Seitenzahl gesetzt, wobei im doppelseitigen Satz
+ (Klassenoption \Option{twoside=true}(\Package{typearea})'none') die
+ Paginierung außen platziert wird.
\end{values}
%
-\ChangedAt{v2.03}
-Sollte einer der \PageStyle{tudheadings}-Seitenstil aktiviert sein und es wird
+Wird beim Laden der Klasse respektive des Paketes \Package{scrlayer-scrpage}
+die Option \Option{manualmark}(\Package{scrlayer-scrpage})'none'|declare| nicht
+explizit angegeben, so werden mit \Option{cdfoot=true} über die
+\KOMAScript-Option \Option{automark}(\Package{scrlayer-scrpage})'none'|declare|
+auch gleichzeitig die automatischen Kolumnentitel aktiviert, welche als Marken
+die Titel der Gliederungsebenen verwendet. Genaueres dazu und der Möglichkeit,
+die Kolumnentitel manuell festzulegen, ist dem \scrguide zu entnehmen.
+
+\ChangedAt{v2.03}
+Sollte einer der \PageStyle{tudheadings}"=Seitenstil aktiviert sein und es wird
auf der erzeugten Seite ein farbiges Layout~-- beispielsweise der zweifarbige
-Kopf (\Option{cdhead}[bicolor]) oder ein farbiger Seitenhintergrund~-- genutzt,
+Kopf (\Option{cdhead=bicolor}) oder ein farbiger Seitenhintergrund~-- genutzt,
so kann auch die Fußzeile einen farbigen Hintergrund erhalten.
%
-\begin{values}
+\begin{values}{\Option{cdfoot}}
\item[nocolor/monochrome]
Der Fuß wird immer ohne farbigen Hintergrund gesetzt.
\item[color/bicolor/bichrome]
- Die Fußzeile wird farblich abgesetzt, falls entweder der zweifarbige Kopf
- (\Option{cdhead}[bicolor]) oder zumindest eine Seite mit einem farbigen
- Hintergrund in der Hausfarbe (Titel oder Kapitelseite) verwendet wurde.
+ Die Fußzeile wird farbig abgesetzt, falls entweder der Kopf in einer farbigen
+ Variante genutzt wird (\seeref{\Option{cdhead}}) oder eine Seite mit einem
+ farbigen Hintergrund in der Hausfarbe (Titel oder Kapitelseite) aktiv ist.
+\item[\PValueName{Höhe}]
+ Wird der Option ein Längenwert übergeben, entspricht dies exakt der
+ Verwendung von Option \Option{extrabottommargin=\PName{Höhe}}.
\end{values}
+\end{Declaration}
+
+\begin{Declaration}[v2.04]{\Font{tudheadings}}
+\printdeclarationlist%
+\index{Schriftelemente}%
%
-Wird der Option \Option{cdfoot} eine Längenmaß übergeben, entspricht dies der
-Verwendung von \Option{extrabottommargin}.
+Im Fußbereich der Seiten im \PageStyle{tudheadings}"=Seitenstil wird das
+Schriftelement~\Font{tudheadings} verwendet. Dieses wirkt sich auf die
+Seitenzahlen, den Kolumnentitel und die mit \Macro{footcontent} angegebenen
+Inhalte aus. Hierüber wird die Wahl der richtigen Schriftfarbe in Abhängigkeit
+vom Seitenhintergrund und den Einstellungen für die Optionen \Option{cdhead}
+sowie \Option{cdfoot} realisiert. Wie \Font{tudheadings} angepasst werden
+kann, ist in \autoref{sec:fonts:elements} zu finden.
\end{Declaration}
-\begin{Declaration}{\Macro{headlogo}\LParameter\Parameter{Dateiname}}
+\begin{Declaration}{\Macro{headlogo}[\LParameter\Parameter{Dateiname}]}
\printdeclarationlist%
-\index{Kopfzeile}\index{Layout!Kopfzeile}%
-\index{Zweitlogo|?}\index{Layout!Zweitlogo}\index{\DDC-Logo}%
+\index{Layout!Kopfzeile}%
+\index{Layout!Zweitlogo|?}%
+\index{Layout!Dresden-concept-Logo@\DDC-Logo}%
%
Neben dem Logo der \TnUD darf zusätzlich ein Zweitlogo im Kopf verwendet
werden. Dieses lässt sich mit diesem Befehl einbinden. Normalerweise wird es
auf die Höhe der Erstlogos skaliert. Über das optionale Argument können weitere
-Formatierungsbefehle an den verwendeten Befehl \Macro{includegraphics}
-durchgereicht werden, um beispielsweise die Größe des Zweitlogos anzupassen.
-Welche Parameter angepasst werden können, ist der Dokumentation des
-\Package{graphicx}-Paketes zu entnehmen.
+Formatierungsbefehle an den im Hintergrund verwendeten Befehl
+\Macro{includegraphics}(\Package{graphicx})'none' durchgereicht werden, um
+beispielsweise die Größe des Zweitlogos anzupassen. Welche Parameter angepasst
+werden können, ist der Dokumentation des \Package{graphicx}"=Paketes zu
+entnehmen.
Sollte die Option \Option{ddc} aktiviert sein, wird das \DDC-Logo nicht im Kopf
sondern automatisch im Fuß gesetzt. Die Option \Option{ddchead} setzt dieses
@@ -963,13 +1354,13 @@ angegebene Zweitlogo.
\end{Declaration}
\begin{Declaration}[v2.03]{%
- \Macro{footlogo}\LParameter\Parameter{Dateinamenliste}%
+ \Macro{footlogo}[\LParameter\Parameter{Dateinamenliste}]%
}
\begin{Declaration}[v2.03]{\Macro{footlogosep}}%
-\begin{Declaration}[v2.03]{\Length{footlogoheight}}%
\printdeclarationlist%
-\index{Drittlogo|?}\index{Layout!Drittlogo}\index{\DDC-Logo}%
-\index{Fußzeile}\index{Layout!Fußzeile}%
+\index{Layout!Fußzeile}%
+\index{Layout!Drittlogo}%
+\index{Layout!Dresden-concept-Logo@\DDC-Logo}%
Laut den Richtlinien des \CDs dürfen im Fußbereich weitere Logos erscheinen,
beispielsweise von kooperierenden Unternehmen oder Sponsoren. Die Dateinamen
@@ -977,95 +1368,132 @@ der gewünschten Logos können als kommaseparierte Liste im obligatorischen
Argument des Befehls \Macro{footlogo} angegeben werden. Sollte tatsächlich
nicht nur ein Dateiname sondern eine Liste übergeben worden sein, so wird bei
der Ausgabe der Logos zwischen diesen jeweils der in \Macro{footlogosep}
-gespeicherte Separator gesetzt. Die Voreinstellung dieses Befehls lautet
-\Macro*{newcommand*}\Macro{footlogosep}\PParameter{\Macro*{hfill}} und kann
-beliebig angepasst werden. Der Separator wird auch gesetzt, wenn in der
-\Parameter{Dateinamenliste} lediglich ein Komma verwendet wurde. So kann man
-beispielsweise ein Logo mit \Macro{footlogo}\PParameter{,\PName{Dateiname},}
-zentriert im Fuß setzen.
-
-Das optionale Argument von \Macro{footlogo} wird an \Macro{includegraphics}
-weitergereicht. Dies geschieht für alle angegeben Dateien aus der Liste
-gleichermaßen. Sollen für einzelne Logos individuelle Einstellungen vorgenommen
-werden, so sind die entsprechenden Parameter im obligatorischen Argument nach
-dem jeweiligen Dateinamen mit einem Doppelpunkt~\enquote{\PValue{:}} als
-Separator (\Macro{footlogo}\PParameter{\PName{Dateiname}:\PName{Parameter}}) zu
+gespeicherte Separator~-- standardmäßig \Macro*{hfill}~-- gesetzt. Dieser kann
+mit \Macro*{renewcommand*}[\PParameter{\Macro{footlogosep}}\PParameter{\dots}]
+beliebig durch den Anwender angepasst werden. Der Separator wird auch gesetzt,
+falls in \PName{Dateinamenliste} lediglich ein Komma verwendet wurde. Mit
+\Macro{footlogo}[\PParameter{,\PName{Dateiname},}] kann so beispielsweise ein
+Logo zentriert im Fuß gesetzt werden.
+\Attention{%
+ Dabei ist zu beachten, dass ein mit der Option \Option{ddc} beziehungsweise
+ \Option{ddcfoot} gesetztes \DDC-Logo im Fußbereich~-- im Gegensatz zur
+ Verwendung von \Macro{footcontent}~-- überlagert werden könnte. Hier muss der
+ Anwender im Zweifel durch das Einfügen von Separatoren~-- sprich Kommas~-- im
+ Argument von \Macro{footlogo} etwas Formatierungsarbeit leisten.
+}
+
+Das optionale Argument von \Macro{footlogo} wird an
+\Macro{includegraphics}(\Package{graphicx})'none' weitergereicht. Dies
+geschieht für alle angegeben Dateien aus der Liste gleichermaßen. Sollen für
+einzelne Logos individuelle Einstellungen vorgenommen werden, so sind die
+entsprechenden Parameter im obligatorischen Argument nach dem jeweiligen
+Dateinamen mit einem Doppelpunkt~\enquote{\PValue{:}} als Separator
+(\Macro{footlogo}[\PParameter{\PName{Dateiname}:\PName{Parameter}}]) zu
übergeben, wobei diese \emph{nach} den allgemeinen Einstellungen für alle Logos
angewendet werden. Die möglichen Parameter und Werte für die optionalen
-Argumente sind der Dokumentation des \Package{graphicx}-Paketes zu entnehmen.
-
-Ohne die Angabe eines optionalen Argumentes für die Größe werden alle Logos im
-Fuß auf die auf die Höhe des Logos der \TnUD skaliert. Der Anwender kann dies
-ändern, indem der Wert der Länge \Length{footlogoheight} mit \Macro*{setlength}
-auf einen von \PValue{0pt} verschiedenen gesetzt wird. Sollte die Höhe des
-Fußbereiches nicht ausreichen, um alle Logos in der gewünschten Größe
-darstellen zu können, kann diese über die Option \Option{extrabottommargin}
-beziehungsweise \Option{cdfoot} angepasst werden.
+Argumente sind der Dokumentation des \Package{graphicx}"=Paketes zu entnehmen.
\end{Declaration}
\end{Declaration}
+
+\begin{Declaration}[v2.05]{\Option{footlogoheight=\PName{Längenwert}}}%
+\printdeclarationlist%
+%
+Ohne die Angabe eines optionalen Argumentes bei \Macro{footlogo} für die Größe
+werden alle Logos im Fuß auf die auf die Höhe des Logos der \TnUD skaliert.
+Dies kann global für alle Logos geändert werden, indem vom Anwender die Option
+\Option{footlogoheight=\PName{Längenwert}} gesetzt wird. Sollte die Höhe des
+Fußbereiches nicht ausreichen, um alle Logos in der gewünschten Größe
+darstellen zu können, kann diese über \Option{extrabottommargin=\PName{Höhe}}
+beziehungsweise \Option{cdfoot=\PValueName{Höhe}} angepasst werden.
\end{Declaration}
-\begin{Declaration}[v2.04]{\Macro{footcontent}%
- \OParameter{Anweisungen}\Parameter{Inhalt}\OParameter{Inhalt}%
+\begin{Declaration}[%
+ v2.04;
+ v2.05:Änderung des Inhaltes nur einer Spalte möglich
+]{%
+ \Macro{footcontent}[%
+ \OParameter{Anweisungen}\Parameter{Inhalt}\OParameter{Inhalt}%
+ ]%
}
-\begin{Declaration}[v2.04]{\Macro*{footcontent*}
+\begin{Declaration}[v2.04]{%
+ \Macro{footcontent*}[%
\OParameter{Anweisungen}\Parameter{Inhalt}\OParameter{Inhalt}%
+ ]%
}
\printdeclarationlist%
-\index{Fußzeile}\index{Layout!Fußzeile}%
+\index{Layout!Fußzeile}%
%
Mit diesem Befehl kann beliebiger Inhalt entweder einspaltig oder zweispaltig
im Fußbereich der \PageStyle{tudheadings}"=Seitenstile gesetzt werden. In der
-Form \Macro{footcontent}\Parameter{Inhalt} wird der Inhalt über die komplette
+Form \Macro{footcontent}[\Parameter{Inhalt}] wird der Inhalt über die komplette
Textbreite im Fuß ausgegeben. Wird der Befehl jedoch in der zweiten Variante
-\Macro{footcontent}\Parameter{linker Inhalt}\OParameter{rechter Inhalt} mit
+\Macro{footcontent}[\Parameter{linker Inhalt}\OParameter{rechter Inhalt}] mit
einem optionalen \emph{nach} dem obligatorischen Argument verwendet, so
erscheint der Fußbereich zweispaltig, wobei der Inhalt aus dem ersten,
obligatorischen Argument in der linken und der Inhalt aus dem zweiten,
-optionalen Argument entsprechend in der rechten Fußspalte gesetzt wird.
-
-Im Normalfall wird das Schriftelement \Font{tudheadings} für die Schrift im
-Fußbereich verwendet. Mit dem ersten optionalen Argument können weitere
-Schrifteinstellungen respektive Anweisungen vor der eigentlichen Ausgabe des
-Inhaltes erfolgen. Soll die Definition des Inhalts für den Fußbereich gänzlich
-ohne die automatische Schriftformatierungen erfolgen, so kann die Sternversion
-\Macro{footcontent*} genutzt und gegebenenfalls die Schriftformatierung über
-das optionale Argument vorgenommen werden.
+optionalen Argument entsprechend in der rechten Fußspalte gesetzt wird. Dabei
+wird ein etwaiges \DDC-Logo, welches über die Option \Option{ddc} respektive
+\Option{ddcfoot} gesetzt wurde, beachtet und der für den Text zur Verfügung
+stehende Platz im Fuß reduziert.
+
+\ChangedAt{v2.05}
+Wird an das Argument für die linke oder die rechte Spalte lediglich ein Stern
+\PValue{*} übergeben, so bleibt der bis dahin definierte Inhalt in dieser
+Spalte erhalten. Beispielsweise kann die linke Fußbereichsspalte mit
+\Macro{footcontent}[\Parameter{Inhalt}\POParameter{*}] angepasst werden ohne
+dabei den Inhalt der rechten Spalte zu verändern oder es ließe sich lediglich
+die verwendete Schrift des Fußbereichs bei gleichbleibendem Inhalt mit
+\Macro{footcontent}[\OParameter{Anweisungen}\PParameter{*}\POParameter{*}]%
+anpassen.
+
+Im Fußbereich wird für die Schrift das Schriftelement \Font{tudheadings}
+verwendet. Dabei wird auch die Schriftgröße angepasst, wobei diese sich an der
+Kopfzeile orientiert. Zusätzlich können mit dem ersten optionalen Argument von
+\Macro{footcontent}~-- vor der eigentlichen Ausgabe des Inhaltes~-- zusätzliche
+Schrifteinstellungen respektive \PName{Anweisungen} ausgeführt werden. Soll die
+Definition des Inhalts im Fußbereich \emph{ohne} eine automatische Anpassung
+der Schriftgröße erfolgen, so ist die Sternversion \Macro{footcontent*} zu
+verwenden. Auch hier lässt sich gegebenenfalls das optionale Argument für die
+Schriftformatierung nutzen.
\end{Declaration}
\end{Declaration}
\begin{Declaration}[%
- v2.02!\protect\DDC-Logo automatisch in Kopf oder Fuß%
-]{\Option{ddc}[\PSet]}[false]
-\begin{Declaration}[v2.02]{\Option{ddchead}[\PSet]}[false]
-\begin{Declaration}[%
- v2.02!neue Werte für die Farbwahl des Logos von \protect\DDC%
-]{\Option{ddcfoot}[\PSet]}[false]
-\printdeclarationlist%
-\index{Zweitlogo}\index{Layout!Zweitlogo}\index{\DDC-Logo}%
-%
-Diese Optionen fügen das Logo von \DDC entweder im Kopf oder im Fuß der Seiten
-mit dem Stil \PageStyle{tudheadings} ein. Mit \Option{ddc} wird dieses
-automatisch entweder im Kopf oder~-- falls ein Zweitlogo mit \Macro{headlogo}
-angegeben wurde~-- im Fuß gesetzt. Die anderen beiden Optionen setzen das Logo
-zwingend entweder im Kopf (\Option{ddchead}) oder im Fuß (\Option{ddcfoot}),
-wobei erstgenannte ein optionales Zweitlogo dabei unterdrückt. Die Verwendung
-einer der drei Optionen führt zur Deaktivierung der anderen beiden, sie
-schließen sich folglich gegenseitig aus. Die möglichen Werte für diese Optionen
-sind:
-%
-\begin{values}
+ v2.02:Logo von \DDC automatisch in Kopf/Fuß;%
+ v2.02!\Option{ddc=colorblack};
+ v2.02!\Option{ddc=gray};
+ v2.02!\Option{ddc=black};
+ v2.02!\Option{ddc=blue};
+ v2.02!\Option{ddc=white};
+]{\Option{ddc=\PSet}}[false]
+\printdeclarationlist%
+\index{Layout!Fußzeile}%
+\index{Layout!Kopfzeile}%
+\index{Layout!Zweitlogo}%
+\index{Layout!Dresden-concept-Logo@\DDC-Logo}%
+%
+Diese Option fügt das Logo von \DDC entweder im Kopf oder Fuß der Seiten mit
+dem Stil \PageStyle{tudheadings} ein. Diese wird automatisch entweder im Kopf
+oder~-- falls mit \Macro{headlogo} ein Zweitlogo angegeben wurde~-- im Fuß
+gesetzt. Alternativ dazu können die Optionen \Option{ddchead} beziehungsweise
+\Option{ddcfoot} genutzt werden, welche das Logo zwingend entweder im Kopf oder
+Fuß setzen. Die Verwendung einer der drei Optionen führt zur Deaktivierung der
+anderen beiden, sie schließen sich folglich gegenseitig aus. Die möglichen
+Werte für diese Optionen sind:
+%
+\begin{values}{\Option{ddc}}
\itemfalse
- Bei den \PageStyle{tudheadings}-Seitenstile erscheint kein Logo von \DDC.
+ Bei den \PageStyle{tudheadings}"=Seitenstile erscheint kein Logo von \DDC.
\itemtrue*
Das Logo von \DDC wird im Kopf beziehungsweise im Fuß verwendet. Die Wahl der
Farbe des Logos geschieht passend zur farblichen Ausprägung der Seite selbst.
\end{values}
%
-Soll die Farbe des \DDC-Logos manuell erfolgen, können folgende Werte verwendet
-werden:
+Die Farbe des \DDC-Logos wird normalerweise in Abhängigkeit von der Einstellung
+für die farbliche Ausprägung (Option \Option{cd=\PSet}) automatisch gewählt.
+Soll dies manuell erfolgen, können folgende Werte verwendet werden:
%
-\begin{values}
+\begin{values}{\Option{ddc}}
\item[color]
Im Kopf oder Fuß wird die achtfarbige 4C"~Variante des \DDC-Logos genutzt.
\item[colorblack]
@@ -1084,67 +1512,88 @@ werden:
Das \DDC-Logo sowie der dazugehörige Schriftzug sind vollständig weiß.
\end{values}
%
-Die Größe des \DDC-Logos ist vorgegeben. Es wird sowohl im Kopf als auch im Fuß
-in der gleichen Höhe gesetzt, wie das Logo der \TnUD. Wird es im Fuß gesetzt,
-lässt sich die Größe allerdings über die Länge \Length{footlogoheight} ändern.
-Sollte nach einer Vergrößerung der Darstellung die Höhe des Fußbereiches nicht
-ausreichen, so kann diese über die Option \Option{cdfoot} beziehungsweise
-\Option{extrabottommargin} angepasst werden.
-\end{Declaration}
-\end{Declaration}
+Das \DDC-Logo wird standardmäßig sowohl im Kopf als auch im Fuß in der gleichen
+Höhe gesetzt, wie das Logo der \TnUD und kann zumindest für den Kopf nicht
+geändert. Wird es jedoch im Fuß verwendet, lässt sich die Größe allerdings über
+die Option \Option{footlogoheight} ändern. Sollte nach einer Vergrößerung der
+Darstellung die Höhe des Fußbereiches nicht ausreichen, so kann diese über die
+\Option{extrabottommargin=\PName{Höhe}} respektive
+\Option{cdfoot=\PValueName{Höhe}} angepasst werden.
\end{Declaration}
-\ToDo[imp,nxt]{%
- Spezialseite zur freien Gestaltung mit Hintergrundebene für Bilder und Texte
- (CD-Handbuch S. 80 ff.); Seitenstil: \PageStyle{special.tudheadings}
+\begin{Declaration}[v2.02]{\Option{ddchead=\PSet}}[false]
+\begin{Declaration}[%
+ v2.02!\Option{ddcfoot=colorblack};
+ v2.02!\Option{ddcfoot=gray};
+ v2.02!\Option{ddcfoot=black};
+ v2.02!\Option{ddcfoot=blue};
+ v2.02!\Option{ddcfoot=white};
+]{\Option{ddcfoot=\PSet}}[false]
+\printdeclarationlist%
+\index{Layout!Fußzeile}%
+\index{Layout!Kopfzeile}%
+\index{Layout!Zweitlogo}%
+\index{Layout!Dresden-concept-Logo@\DDC-Logo}%
+%
+Mit diesen beiden Optionen wird das Logo von \DDC explizit im Kopf oder Fuß
+verwendet. Wird eine der beiden Optionen genutzt, entfällt die automatische
+Wahl von Kopf oder Fuß bei der Platzierung des \DDC-Logos~-- wie es bei der
+Verwendung der Option \Option{ddc=\PSet} erfolgt~-- deaktiviert. Ein mit
+\Macro{headlogo} angegebenes Zweitlogo wird durch \Option{ddchead=\PSet}
+definitiv unterdrückt, \Option{ddcfoot=\PSet} setzt das \DDC-Logo in jedem Fall
+in den Seitenfuß. Die möglichen Werte der beiden Optionen entsprechen denen der
+Option \Option{ddc}.
+\index{Layout!Seitenstil|)}%
+\end{Declaration}
+\end{Declaration}
+
+\ToDo[imp]{%
+ Spezialseite zur freien Gestaltung mit Hintergrundebene für Bilder und Texte
+ (CD-Handbuch S. 80 ff.); Seitenstil: \PageStyle*{special.tudheadings}
}[v2.06]
-\begin{Declaration}[%
- v2.02!\Key{\Environment{tudpage}}{head} \emph{entfällt},
- v2.02!\Key{\Environment{tudpage}}{foot} \emph{entfällt},
- v2.03!\Key{\Environment{tudpage}}{color} \emph{entfällt}
-]{\Environment{tudpage}[\OLParameter{Sprache}]}
-\begin{Declaration}{\Key{\Environment{tudpage}}{language}[\PName{Sprache}]}
-\begin{Declaration}{\Key{\Environment{tudpage}}{columns}[\PName{Anzahl}]}
-\begin{Declaration}[v2.02]{\Key{\Environment{tudpage}}{pagestyle}[\PSet]}
-\begin{Declaration}{\Key{\Environment{tudpage}}{cdfont}[\PSet]}{%
- \see*{\Option{cdfont}'ppage'}%
+\begin{Declaration}{\Environment{tudpage}[\OLParameter{Sprache}]}
+\begin{Declaration}{\Key{\Environment{tudpage}}{language=\PName{Sprache}}}
+\begin{Declaration}{\Key{\Environment{tudpage}}{columns=\PName{Anzahl}}}
+\begin{Declaration}[v2.02]{\Key{\Environment{tudpage}}{pagestyle=\PSet}}
+\begin{Declaration}{\Key{\Environment{tudpage}}{cdfont=\PSet}}{%
+ \seeref{\Option{cdfont}'ppage'}%
}
-\begin{Declaration}[v2.03]{\Key{\Environment{tudpage}}{cdhead}[\PSet]}{%
- \see*{\Option{cdhead}'ppage'}%
+\begin{Declaration}[v2.03]{\Key{\Environment{tudpage}}{cdhead=\PSet}}{%
+ \seeref{\Option{cdhead}'ppage'}%
}
-\begin{Declaration}[v2.03]{\Key{\Environment{tudpage}}{cdfoot}[\PSet]}{%
- \see*{\Option{cdfoot}'ppage'}%
+\begin{Declaration}[v2.03]{\Key{\Environment{tudpage}}{cdfoot=\PSet}}{%
+ \seeref{\Option{cdfoot}'ppage'}%
}
-\begin{Declaration}{\Key{\Environment{tudpage}}{headlogo}[\PName{Dateiname}]}{%
- \see*{\Macro{headlogo}'ppage'}%
+\begin{Declaration}{\Key{\Environment{tudpage}}{headlogo=\PName{Dateiname}}}{%
+ \seeref{\Macro{headlogo}'ppage'}%
}
\begin{Declaration}[v2.03]{%
- \Key{\Environment{tudpage}}{footlogo}[\PName{Dateinamenliste}]
-}{\see*{\Macro{footlogo}'ppage'}}
-\begin{Declaration}[v2.02]{\Key{\Environment{tudpage}}{ddc}[\PSet]}{%
- \see*{\Option{ddc}'ppage'}%
+ \Key{\Environment{tudpage}}{footlogo=\PName{Dateinamenliste}}
+}{\seeref{\Macro{footlogo}'ppage'}}
+\begin{Declaration}[v2.02]{\Key{\Environment{tudpage}}{ddc=\PSet}}{%
+ \seeref{\Option{ddc}'ppage'}%
}
-\begin{Declaration}[v2.02]{\Key{\Environment{tudpage}}{ddchead}[\PSet]}{%
- \see*{\Option{ddchead}'ppage'}%
+\begin{Declaration}[v2.02]{\Key{\Environment{tudpage}}{ddchead=\PSet}}{%
+ \seeref{\Option{ddchead}'ppage'}%
}
-\begin{Declaration}[v2.02]{\Key{\Environment{tudpage}}{ddcfoot}[\PSet]}{%
- \see*{\Option{ddcfoot}'ppage'}%
+\begin{Declaration}[v2.02]{\Key{\Environment{tudpage}}{ddcfoot=\PSet}}{%
+ \seeref{\Option{ddcfoot}'ppage'}%
}
\printdeclarationlist%
-\index{Layout}\index{Layout!Seitenstil}%
-\index{Kopfzeile}\index{Layout!Kopfzeile}%
-\index{Fußzeile}\index{Layout!Fußzeile}%
+\index{Layout!Kopfzeile}%
+\index{Layout!Fußzeile}%
+\index{Layout!Seitenstil}%
%
Die \Environment{tudpage}"=Umgebung hat ihren Ursprung in einer früheren
Version, als die \PageStyle{tudheadings}"=Seitenstile noch nicht verfügbar
waren, welche mittlerweile anstelle dieser Umgebung verwendet werden können.
Für die \Environment{tudpage}"=Umgebung lassen sich verschiedene Parameter als
optionales Argument angegeben. Wird das Paket \Package{babel} genutzt, kann die
-verwendete Sprache mit \Key{\Environment{tudpage}}{language}[\PName{Sprache}]
+genutzte Sprache mit \Key{\Environment{tudpage}}{language=\PName{Sprache}}
geändert werden, was zur Anpassung der sprachspezifischen Trennungsmuster und
Bezeichner führt. Wurde das Paket \Package{multicol} geladen, wird mit dem
-Parameter \Key{\Environment{tudpage}}{columns}[\PName{Anzahl}] der Inhalt der
+Parameter \Key{\Environment{tudpage}}{columns=\PName{Anzahl}} der Inhalt der
Umgebung mehrspaltig gesetzt. Mit \Key{\Environment{tudpage}}{pagestyle} kann
der Seitenstil angepasst werden, wobei \PValue{headings}, \PValue{plain} und
\PValue{empty} gültige Werte sind.
@@ -1168,35 +1617,60 @@ Handbuchs nachgelesen werden.
\end{Declaration}
-
\subsection{Der Titel und die Umschlagseite}
-\label{sec:title}%\label{sec:cover}%
-\index{Titel|!(}\index{Umschlagseite|!}\index{Layout!Umschlagseite}%
+\tudhyperdef*{sec:title}%
+\index{Titel}%
+\index{Umschlagseite}%
%
\ChangedAt*{%
- v2.03!Bugfix für Umschlagseite und Titel beim Satzspiegel%
+ v2.03:Bugfix für Umschlagseite und Titel beim Satzspiegel%
}
-Für den Titel werden alle Felder unterstützt, die bereits durch \KOMAScript{}
-bereitgestellt werden. Darüber hinaus werden für die \TUDScript-Klassen weitere
-Felder definiert, die Auswirkungen auf die Gestalt des Titels haben. Diese
-werden nachfolgend in diesem \autorefname erläutert. Der Titel~-- bestehend aus
-möglichem Schmutztitel, der eigentlichen Titelseite und der nachgelagerten
-Elementen~-- kann mit dem Befehl \Macro{maketitle} ausgegeben werden. Außerdem
-kann im zweispaltigen Satz der \Macro{maketitleonecolumn} verwendet werden,
-welcher einen einspaltigen Einfügung nach dem Titel selbst ermöglicht.
+%
+Für das Erstellen eines Titels mit dem Befehl \Macro{maketitle} wird mit der
+\KOMAScript-Option
+\Option{titlepage=\PBoolean}(\Package{koma-script})'none'|declare|
+festgelegt, ob dieser in Gestalt einer ganzen Titelseite oder nur als Titelkopf
+erscheinen soll. Für den Titel im \TUDCD werden alle Felder unterstützt, welche
+bereits durch \KOMAScript{} definiert sind. Darüber hinaus werden für die
+\TUDScript-Klassen weitere Felder bereitgestellt, welche Auswirkungen auf die
+Gestalt des Titels haben. Diese werden nachfolgend in diesem \autorefname
+erläutert. Der Titel~-- bestehend aus einem möglichen Schmutztitel
+(\Macro{extratitle}(\Package{koma-script})), der eigentlichen Titelseite
+respektive des Titelkopfes und der nachgelagerten Elementen~-- kann mit
+\Macro{maketitle} ausgegeben werden. Außerdem kann im zweispaltigen Satz
+\Macro{maketitleonecolumn} verwendet werden, womit eine einspaltige Ergänzung
+nach dem Titel selbst ermöglicht wird.
Zusätzlich zum Titel lässt sich mit \Macro{makecover} eine Umschlagseite
erzeugen. Diese kann insbesondere für gebundene Arbeiten verwendet werden. Es
wird~-- im Vergleich zum Titel~-- lediglich einer reduzierte Anzahl an Feldern
auf dieser ausgegeben.
+\begin{Declaration}[v2.02]{\Font{titlepage}}
+\begin{Declaration}[v2.02]{\Font{thesis}}
+\printdeclarationlist%
+\index{Schriftelemente}%
+%
+Die \TUDScript-Klassen definieren diese neuen Schriftelemente. Dabei wird
+\Font{titlepage} auf der Titelseite für alle Felder verwendet, welche kein
+spezielles Schriftelement verwenden, welches ohnehin durch \KOMAScript{}
+bereitgestellt wird. Das mit \Macro{thesis} angegebene Feld, in welchem der Typ
+einer Abschlussarbeit angegeben wird, nutzt das Schriftelement~\Font{thesis}.
+
\ChangedAt{v2.02}
-Für alle Felder des Titels und der Umschlagseite lässt sich die verwendete
-Schrift anpassen. Dabei werden sowohl die bereits durch \KOMAScript{}
-bereitgestellten Schriftelemente \Font{titlehead}, \Font{subject},
-\Font{title}, \Font{subtitle}, \Font{author}, \Font{date}, \Font{publishers}
-und \Font{dedication} als auch die neuen \Font{titlepage} und \Font{thesis}
-unterstützt.
+Für alle Felder des Titels und der Umschlagseite lassen sich die verwendeten
+Schriften anpassen. In \autoref{sec:fonts:elements} lässt sich nachlesen, wie
+dies genau funktioniert. Dabei werden für Titel und Umschlagseite sowohl die
+bereits durch \KOMAScript{} bereitgestellten Schriftelemente
+\Font{titlehead}(\Package{koma-script})'none',
+\Font{subject}(\Package{koma-script})'none',
+\Font{title}(\Package{koma-script})'none',
+\Font{subtitle}(\Package{koma-script})'none',
+\Font{author}(\Package{koma-script})'none',
+\Font{publishers}(\Package{koma-script})'none',
+\Font{date}(\Package{koma-script})'none' und
+\Font{dedication}(\Package{koma-script})'none'
+als auch die neuen \Font{titlepage} und \Font{thesis} unterstützt.
%
\begin{Example}
In diesem Dokument wurde der Untertitel derart geändert, dass dieser nicht
@@ -1205,69 +1679,75 @@ standardmäßig in \DIN sondern in \textubn{Univers~65~Bold} ausgegeben wird.
\addtokomafont{subtitle}{\univbn}
\end{Code}
\end{Example}
+\end{Declaration}
+\end{Declaration}
\begin{Declaration}[%
- v2.01!Bugfix für Schriftstärke auf Titelseite,%
- v2.02!Unterstützung der Schriftelemente \Font*{titlehead}{,}
- \Font*{subject}{,} \Font*{title}{,} \Font*{subtitle}{,} \Font*{author}{,}
- \Font*{date}{,} \Font*{publishers}{,} \Font*{dedication}{,}
+ v2.01:Bugfix für Schriftstärke auf Titelseite;%
+ v2.02:Unterstützung der Schriftelemente \Font*{titlehead},
+ \Font*{subject}, \Font*{title}, \Font*{subtitle}, \Font*{author},
+ \Font*{date}, \Font*{publishers}, \Font*{dedication},
\Font*{titlepage} und \Font*{thesis}%
-]{\Macro{maketitle}\OLParameter{Seitenzahl}}
+]{\Macro{maketitle}[\OLParameter{Seitenzahl}]}
\begin{Declaration}[v2.02]{%
- \Key{\Macro{maketitle}}{pagenumber}[\PName{Seitenzahl}]%
+ \Key{\Macro{maketitle}}{pagenumber=\PName{Seitenzahl}}%
}
-\begin{Declaration}[v2.02]{\Key{\Macro{maketitle}}{cdfont}[\PSet]}{%
- \see*{\Option{cdfont}'ppage'}%
+\begin{Declaration}[v2.02]{\Key{\Macro{maketitle}}{cdfont=\PSet}}{%
+ \seeref{\Option{cdfont}'ppage'}%
}
-\begin{Declaration}[v2.03]{\Key{\Macro{maketitle}}{cdhead}[\PSet]}{%
- \see*{\Option{cdhead}'ppage'}%
+\begin{Declaration}[v2.03]{\Key{\Macro{maketitle}}{cdhead=\PSet}}{%
+ \seeref{\Option{cdhead}'ppage'}%
}
-\begin{Declaration}[v2.03]{\Key{\Macro{maketitle}}{cdfoot}[\PSet]}{%
- \see*{\Option{cdfoot}'ppage'}%
+\begin{Declaration}[v2.03]{\Key{\Macro{maketitle}}{cdfoot=\PSet}}{%
+ \seeref{\Option{cdfoot}'ppage'}%
}
\begin{Declaration}[v2.03]{%
- \Key{\Macro{maketitle}}{headlogo}[\PName{Dateiname}]%
-}{\see*{\Macro{headlogo}'ppage'}}
+ \Key{\Macro{maketitle}}{headlogo=\PName{Dateiname}}%
+}{\seeref{\Macro{headlogo}'ppage'}}
\begin{Declaration}[v2.03]{%
- \Key{\Macro{maketitle}}{footlogo}[\PName{Dateinamenliste}]
-}{\see*{\Macro{footlogo}'ppage'}}
-\begin{Declaration}[v2.03]{\Key{\Macro{maketitle}}{ddc}[\PSet]}{%
- \see*{\Option{ddc}'ppage'}%
+ \Key{\Macro{maketitle}}{footlogo=\PName{Dateinamenliste}}
+}{\seeref{\Macro{footlogo}'ppage'}}
+\begin{Declaration}[v2.03]{\Key{\Macro{maketitle}}{ddc=\PSet}}{%
+ \seeref{\Option{ddc}'ppage'}%
}
-\begin{Declaration}[v2.03]{\Key{\Macro{maketitle}}{ddchead}[\PSet]}{%
- \see*{\Option{ddchead}'ppage'}%
+\begin{Declaration}[v2.03]{\Key{\Macro{maketitle}}{ddchead=\PSet}}{%
+ \seeref{\Option{ddchead}'ppage'}%
}
-\begin{Declaration}[v2.03]{\Key{\Macro{maketitle}}{ddcfoot}[\PSet]}{%
- \see*{\Option{ddcfoot}'ppage'}%
+\begin{Declaration}[v2.03]{\Key{\Macro{maketitle}}{ddcfoot=\PSet}}{%
+ \seeref{\Option{ddcfoot}'ppage'}%
}
\printdeclarationlist%
-\index{Layout!Titel}%
+\index{Titel|!(}%
\index{Satzspiegel!doppelseitig}%
%
-Der Befehl \Macro{maketitle} setzt für \Option{cdtitle}[false] den normalen
-\KOMAScript"=Titel{}, ansonsten wird die Titelseite im \CD der \TnUD erzeugt.
-Die letztere Variante ist im Vergleich zum Standardtitel um eine Vielzahl von
+Der Befehl \Macro{maketitle} setzt für \Option{cdtitle=false} den normalen
+\KOMAScript"=Titel{}, ansonsten wird die Titelseite im \TUDCD erzeugt. Die
+letztere Variante ist im Vergleich zum Standardtitel um eine Vielzahl von
Feldern erweitert worden und erlaubt insbesondere die Angabe von Daten für das
Deckblatt einer akademischen Abschlussarbeit. Die einzelnen Felder werden
später in diesem \autorefname erläutert. Wird das Dokument doppelseitig und mit
rechts öffnenden Kapiteln gesetzt,%
\footnote{%
- \Option{twoside} und \Option{open}[right], Standard für \Class{tudscrbook}
+ \KOMAScript-Optionen \Option{twoside=true}(\Package{typearea})'none' und
+ \Option{open=right}(\Package{koma-script})'none', Standard für
+ \Class{tudscrbook}%
}
-so wird zusätzlich die Option \Option{clearcolor} beachtet. Dies gilt es
-insbesondere bei der Verwendung der Befehle \Macro{uppertitleback} respektive
-\Macro{lowertitleback} für die Titelrückseite zu beachten.
+so wird zusätzlich die Option \Option{clearcolor} einbezogen. Dies gilt es
+insbesondere bei den Befehlen \Macro{uppertitleback}(\Package{koma-script})
+respektive \Macro{lowertitleback}(\Package{koma-script}) für die Titelrückseite
+zu beachten.
Das optionale Argument erlaubt~-- ebenso wie bei den \KOMAScript"=Klassen~--
die Änderung der Seitenzahl der Titelseite. Diese wird jedoch nicht ausgegeben,
sondern beeinflusst lediglich die Zählung. Sie sollten hier unbedingt eine
ungerade Zahl wählen, da sonst die gesamte Zählung durcheinander gerät.
-Wird eine Titelseite (\Option{titlepage}[true]) im \CD der \TnUD gesetzt
-(\Option{cdtitle}[true]), können auch die weiterhin aufgeführten Parameter im
-optionalen Argument verwendet werden. Diese entsprechen in ihrem Verhalten den
-gleichnamigen Optionen respektive Befehlen, wirken sich jedoch nur lokal und
-einzig auf die Titelseite aus. So kann beispielsweise die Nutzung eines
-\DDC-Logos auf den Titel beschränkt bleiben.
+Wird eine Titelseite
+(\KOMAScript-Option \Option{titlepage=true}(\Package{koma-script})'none') im
+\TUDCD gesetzt (\Option{cdtitle=true}), können auch die weiterhin aufgeführten
+Parameter im optionalen Argument verwendet werden. Diese entsprechen in ihrem
+Verhalten den gleichnamigen Optionen respektive Befehlen, wirken sich jedoch
+nur lokal und einzig auf die Titelseite aus. So kann beispielsweise die Nutzung
+eines \DDC-Logos auf den Titel beschränkt bleiben.
\end{Declaration}
\end{Declaration}
\end{Declaration}
@@ -1280,99 +1760,108 @@ einzig auf die Titelseite aus. So kann beispielsweise die Nutzung eines
\end{Declaration}
\begin{Declaration}{%
- \Macro{maketitleonecolumn}\OLParameter{Seitenzahl}\Parameter{Einspaltentext}%
+ \Macro{maketitleonecolumn}[%
+ \OLParameter{Seitenzahl}\Parameter{Einspaltentext}%
+ ]%
}
\printdeclarationlist%
-\index{Layout!Titel}%
\index{Satzspiegel!doppelseitig}%
-\index{Zweispaltensatz}%
-%
-Im zweispaltigen Satz (\Option{twocolumn}) wird mit \Macro{maketitle} die
-Titelseite selbst immer einspaltig gesetzt. Direkt nach dem Titel folgt
-normalerweise der zweispaltige Fließtext. Mit dem \TUDScript-Befehl
-\Macro{maketitleonecolumn} kann nach dem Titel zusätzlich noch weiterer
-Inhalt~-- beispielsweise eine Zusammenfassung beziehungsweise eine
-Kurfassung~-- einspaltig gesetzt werden.
-
-Wird der Befehl bei einer Titelseite (\Option{titlepage}[true]) verwendet, wird
-der Inhalt des Argumentes (\PName{Einspaltentext}) direkt nach dieser auf einer
-oder gegebenenfalls mehreren neuen Seiten ebenfalls einspaltig ausgegeben.
-Kommt jedoch ein Titelkopf (\Option{titlepage}[false]) zum Einsatz, so folgt
-diesem die einspaltige Textpassage aus dem obligatorischen Argument direkt.
-Dabei erfolgt gegebenenfalls ein automatischer Seitenumbruch, falls der Inhalt
-nicht auf eine einzelne Seite passt. Nach dem \PName{Einspaltentext} des
-obligatorischen Argumentes wird direkt danach und ohne zusätzlichen Umbruch auf
-das zweispaltige Layout umgeschaltet.
+\index{Satzspiegel!zweispaltig}%
+%
+Im zweispaltigen Satz
+(Klassenoption~\Option{twocolumn}(\Package{typearea})'none'|declare|) wird mit
+\Macro{maketitle} die Titelseite selbst immer einspaltig gesetzt. Direkt nach
+dem Titel folgt normalerweise der zweispaltige Fließtext. Mit dem Befehl
+\Macro{maketitleonecolumn} kann nach dem Titel zusätzlich weiterer Inhalt~--
+zum Beispiel eine Zusammenfassung respektive eine Kurzfassung~-- einspaltig
+gesetzt werden.
+
+Bei einer aktivierten Titelseite
+(\KOMAScript-Option~\Option{titlepage=true}(\Package{koma-script})'none')
+erfolgt die Ausgabe des Argumentes (\PName{Einspaltentext}) direkt nach dieser
+auf einer oder gegebenenfalls mehreren neuen Seiten ebenfalls einspaltig. Wird
+der Befehl \Macro{maketitleonecolumn} statt mit einer Titelseite jedoch mit
+einem Titelkopf
+(\KOMAScript-Option~\Option{titlepage=false}(\Package{koma-script})'none') zum
+Einsatz, so folgt diesem die einspaltige Textpassage aus dem obligatorischen
+Argument direkt. Dabei erfolgt gegebenenfalls ein automatischer Seitenumbruch,
+falls der Inhalt nicht auf eine einzelne Seite passt. Nach dem obligatorischen
+Argument \PName{Einspaltentext} wird direkt und ohne zusätzlichen Seitenumbruch
+auf das zweispaltige Layout umgeschaltet.
Der optionale Parameter von \Macro{maketitleonecolumn} kann äquivalent zu
\Macro{maketitle} für die Änderung der Seitenzahl, der verwendeten Schrift
sowie zur Anpassung von Kopf und Fuß verwendet werden. Dabei ist zu beachten,
dass ein Großteil der Parameter nur Auswirkungen haben, falls eine Titelseite
-(\Option{titlepage}[true]) verwendet wird.
+(\KOMAScript-Option \Option{titlepage=true}(\Package{koma-script})'none')
+verwendet wird.
\end{Declaration}
\begin{Declaration}[%
- v2.02!Umschlagseite für Layout ohne \noexpand\CD hinzugefügt,%
- v2.02!Unterstützung der Schriftelemente \Font*{titlehead}{,}
- \Font*{subject}{,} \Font*{title}{,} \Font*{subtitle}{,} \Font*{author}{,}
- \Font*{publishers}{,} \Font*{titlepage} und \Font*{thesis}%
-]{\Macro{makecover}\OLParameter{Seitenzahl}}
+ v2.02:Umschlagseite für Layout ohne \noexpand\CD hinzugefügt;%
+ v2.02:Unterstützung der Schriftelemente \Font*{titlehead},
+ \Font*{subject}, \Font*{title}, \Font*{subtitle}, \Font*{author},
+ \Font*{publishers}, \Font*{titlepage} und \Font*{thesis}%
+]{\Macro{makecover}[\OLParameter{Seitenzahl}]}
\begin{Declaration}[v2.02]{%
- \Key{\Macro{makecover}}{pagenumber}[\PName{Seitenzahl}]%
+ \Key{\Macro{makecover}}{pagenumber=\PName{Seitenzahl}}%
}
-\begin{Declaration}{\Key{\Macro{makecover}}{cdgeometry}[\PBoolean]}
-\begin{Declaration}[v2.02]{\Key{\Macro{makecover}}{cdfont}[\PSet]}{%
- \see*{\Option{cdfont}'ppage'}%
+\begin{Declaration}{\Key{\Macro{makecover}}{cdgeometry=\PBoolean}}
+\begin{Declaration}[v2.02]{\Key{\Macro{makecover}}{cdfont=\PSet}}{%
+ \seeref{\Option{cdfont}'ppage'}%
}
-\begin{Declaration}[v2.03]{\Key{\Macro{makecover}}{cdhead}[\PSet]}{%
- \see*{\Option{cdhead}'ppage'}%
+\begin{Declaration}[v2.03]{\Key{\Macro{makecover}}{cdhead=\PSet}}{%
+ \seeref{\Option{cdhead}'ppage'}%
}
-\begin{Declaration}[v2.03]{\Key{\Macro{makecover}}{cdfoot}[\PSet]}{%
- \see*{\Option{cdfoot}'ppage'}%
+\begin{Declaration}[v2.03]{\Key{\Macro{makecover}}{cdfoot=\PSet}}{%
+ \seeref{\Option{cdfoot}'ppage'}%
}
\begin{Declaration}[v2.03]{%
- \Key{\Macro{makecover}}{headlogo}[\PName{Dateiname}]%
-}{\see*{\Macro{headlogo}'ppage'}}
+ \Key{\Macro{makecover}}{headlogo=\PName{Dateiname}}%
+}{\seeref{\Macro{headlogo}'ppage'}}
\begin{Declaration}[v2.03]{%
- \Key{\Macro{makecover}}{footlogo}[\PName{Dateinamenliste}]
-}{\see*{\Macro{footlogo}'ppage'}}
-\begin{Declaration}[v2.03]{\Key{\Macro{makecover}}{ddc}[\PSet]}{%
- \see*{\Option{ddc}'ppage'}%
+ \Key{\Macro{makecover}}{footlogo=\PName{Dateinamenliste}}
+}{\seeref{\Macro{footlogo}'ppage'}}
+\begin{Declaration}[v2.03]{\Key{\Macro{makecover}}{ddc=\PSet}}{%
+ \seeref{\Option{ddc}'ppage'}%
}
-\begin{Declaration}[v2.03]{\Key{\Macro{makecover}}{ddchead}[\PSet]}{%
- \see*{\Option{ddchead}'ppage'}%
+\begin{Declaration}[v2.03]{\Key{\Macro{makecover}}{ddchead=\PSet}}{%
+ \seeref{\Option{ddchead}'ppage'}%
}
-\begin{Declaration}[v2.03]{\Key{\Macro{makecover}}{ddcfoot}[\PSet]}{%
- \see*{\Option{ddcfoot}'ppage'}%
+\begin{Declaration}[v2.03]{\Key{\Macro{makecover}}{ddcfoot=\PSet}}{%
+ \seeref{\Option{ddcfoot}'ppage'}%
}
\printdeclarationlist%
+\index{Umschlagseite|!(}%
%
Eine Umschlagseite wird zumeist für gebundene Abschlussarbeiten verlangt, um
diese beispielsweise für einen Prägedruck auf dem Buchdeckel zu verwenden.
Deshalb ist die farbige Ausprägung der Umschlagseite auch deaktiviert, wenn
-diese für das restliche Dokument aktiv ist (\Option{cd}[color]). Dies kann
-jedoch jederzeit mit \Option{cdcover}[\PSet] überschrieben werden.
+diese für das restliche Dokument aktiv ist (\Option{cd=color}). Dies kann
+jedoch jederzeit mit \Option{cdcover=\PSet} überschrieben werden.
-Wird \Option{cdcover}[true] gewählt, so wird die Umschlagseite im \CD der
-\TnUD gesetzt. Auf dieser werden der Titel des Dokumentes, die Typisierung
+Wird \Option{cdcover=true} gewählt, so wird die Umschlagseite im \TUDCD
+gesetzt. Auf dieser werden der Titel des Dokumentes, die Typisierung
durch \Macro{thesis} und/oder \Macro{subject} sowie der Autor oder respektive
-die Autoren und gegebenenfalls der mit \Macro{publishers} angegebene Verlag
-ausgegeben.
+die Autoren und gegebenenfalls der mit \Macro{publishers}(\Package{koma-script})
+angegebene Verlag ausgegeben.
\ChangedAt{v2.02}
-Für die Einstellung \Option{cdcover}[false] wird lediglich der normale
+Für die Einstellung \Option{cdcover=false} wird lediglich der normale
\KOMAScript"=Titel als separate Umschlagseite ausgegeben.
Die Titelseite selbst gehört immer zum Buchblock und wird daher im gleichen
Satzspiegel gesetzt. Dem entgegen steht die Umschlagseite, welche zumeist in
einem anderen Layout erscheint. Normalerweise wird das Cover~-- unabhängig von
der Option \Option{cdgeometry}~-- im asymmetrischen Satzspiegel des \CDs
-gesetzt. Mit \Key{\Macro{makecover}}{cdgeometry}[false] im optionalen Argument
+gesetzt. Mit \Key*{\Macro{makecover}}{cdgeometry=false} im optionalen Argument
kann das Verhalten geändert werden. In diesem Fall erscheint auch die
Umschlagseite im Buchblock des restlichen Dokumentes. Allerdings können für
-diese Einstellung die Seitenränder mit den Befehlen \Macro{coverpagetopmargin},
-\Macro{coverpageleftmargin}, \Macro{coverpagerightmargin} sowie
-\Macro{coverpagebottommargin} durch den Nutzer frei angepasst werden. Mehr dazu
-ist im \KOMAScript"=Handbuch \scrguide zu finden.
+diese Einstellung die Seitenränder mit den Befehlen
+\Macro{coverpagetopmargin}(\Package{koma-script})'none',
+\Macro{coverpageleftmargin}(\Package{koma-script})'none',
+\Macro{coverpagerightmargin}(\Package{koma-script})'none' sowie
+\Macro{coverpagebottommargin}(\Package{koma-script})'none'
+durch den Nutzer frei angepasst werden. Mehr dazu ist im \scrguide zu finden.
Außerdem kann mit dem optionalen Argument die Seitenzahl der Umschlagseite
geändert werden. Diese wird jedoch nicht ausgegeben, sondern beeinflusst
@@ -1381,7 +1870,7 @@ sonst die gesamte Zählung durcheinander gerät. Die weiterhin aufgeführten
Parameter entsprechen in ihrem Verhalten beziehungsweise ihrer Funktion den
gleichnamigen Optionen respektive Befehlen, wirken sich jedoch nur lokal und
einzig auf die Umschlagseite aus.
-
+\index{Umschlagseite|!)}%
\end{Declaration}
\end{Declaration}
\end{Declaration}
@@ -1394,27 +1883,48 @@ einzig auf die Umschlagseite aus.
\end{Declaration}
\end{Declaration}
-\begin{Declaration}{\Macro{titledelimiter}\Parameter{Trennzeichen}}
+\begin{Declaration}{\Macro{title}[\Parameter{Titel}]}
+\begin{Declaration}[%
+ v2.01:Bugfix für Schriftstärke bei Verwendung des Untertitels%
+]{\Macro{subtitle}[\Parameter{Untertitel}]}
\printdeclarationlist%
-\index{Titel!Felder}\index{Titel!Trennzeichen}%%
+\index{Titel!Felder|(}%
%
-Für den Titel und die Umschlagseite werden durch die \TUDScript-Klassen
-eine Reihe von zusätzlichen Feldern bereitgestellt. Einigen dieser Felder wird
-eine Beschreibung (\see*{\autoref{sec:localization}}) vorangestellt. Dazwischen
+Die Befehle \Macro{title} und \Macro{subtitle} sind selbsterklärend. Anzumerken
+ist, dass sowohl Titel als auch Untertitel normalerweise in \DIN und deshalb
+mit Majuskeln gesetzt werden.
+\end{Declaration}
+\end{Declaration}
+
+\begin{Declaration}{\Macro{titledelimiter}[\Parameter{Trennzeichen}]}
+\printdeclarationlist%
+\index{Titel!Trennzeichen}%
+%
+Für den Titel und die Umschlagseite werden durch die \TUDScript-Klassen eine
+Reihe von zusätzlichen Feldern bereitgestellt. Einigen dieser Felder wird eine
+Beschreibung (\seeref{\autoref{sec:localization}}) vorangestellt. Dazwischen
wird bei der Ausgabe ein Trennzeichen eingefügt. Ein Doppelpunkt gefolgt von
einem Leerzeichen (:\Macro*{nobreakspace}) ist hierfür die Voreinstellung. Mit
dem Befehl \Macro{titledelimiter} lässt sich dieses Trennzeichen beliebig an
die individuellen Wünsche des Anwenders anpassen.
\end{Declaration}
-\begin{Declaration}{\Macro{author}\Parameter{Autor(en)}}
-\begin{Declaration}{\Macro{authormore}\Parameter{Autorenzusatz}}
-\begin{Declaration}{\Macro{dateofbirth}\Parameter{Geburtsdatum}}
-\begin{Declaration}{\Macro{placeofbirth}\Parameter{Geburtsort}}
-\begin{Declaration}{\Macro{matriculationnumber}\Parameter{Matrikelnummer}}
-\begin{Declaration}{\Macro{matriculationyear}\Parameter{Immatrikulationsjahr}}
+\begin{Declaration}{\Macro{author}[\Parameter{Autor(en)}]}
+\begin{Declaration}{\Macro{authormore}[\Parameter{Autorenzusatz}]}
+\begin{Declaration}{\Macro{dateofbirth}[\Parameter{Geburtsdatum}]}
+\begin{Declaration}{\Macro{placeofbirth}[\Parameter{Geburtsort}]}
+\begin{Declaration}{\Macro{matriculationnumber}[\Parameter{Matrikelnummer}]}
+\begin{Declaration}{\Macro{matriculationyear}[\Parameter{Immatrikulationsjahr}]}
+\begin{Declaration}[%
+ v2.05:Für Titel verwendbar%
+]{\Macro{course}[\Parameter{Studiengang}]}
+\begin{Declaration}[%
+ v2.02;%
+ v2.05:Für Titel verwendbar%
+]{\Macro{discipline}[\Parameter{Studienrichtung}]}
\printdeclarationlist%
-\index{Titel!Felder}\index{Autorenangaben|?}%
+\index{Autorenangaben|?}%
+\index{Kollaboratives Schreiben}%
\index{Datum!Geburtsdatum|?}%
%
Mit dem Befehl \Macro{author} wird der Autor angegeben. Innerhalb des
@@ -1427,9 +1937,15 @@ Mit \Macro{authormore} wird unter dem Autor eine Zeile ausgegeben, welche
durch den Anwender frei belegt werden kann. Sollte das Paket \Package{isodate}
geladen sein, so wird die damit eingestellte Formatierung des Datums durch
\Macro{dateofbirth}~-- wie übrigens bei jedem anderem Datumsfeld der
-\TUDScript-Klassen auch~-- verwendet. Dafür der Befehl \Macro{printdate} aus
-diesem Paket verwendet. Die weiteren Befehle als zusätzliche Angabe erklären
-sich von selbst.
+\TUDScript-Klassen auch~-- verwendet. Hierfür wird aus besagtem Paket das Makro
+\Macro{printdate}(\Package{isodate})'none' genutzt. Die weiteren Befehle als
+zusätzliche Angabe erklären sich quasi von selbst. Anzumerken ist, dass die mit
+den Befehlen \Macro{course}, \Macro{discipline}, \Macro{matriculationnumber}
+sowie \Macro{matriculationyear} angegebenen Informationen auch durch die
+\Environment{task}(\Package{tudscrsupervisor})"=Umgebung aus dem Paket
+\Package{tudscrsupervisor} genutzt werden, falls diese denn zum Einsatz kommt.
+\end{Declaration}
+\end{Declaration}
\end{Declaration}
\end{Declaration}
\end{Declaration}
@@ -1439,8 +1955,7 @@ sich von selbst.
\begin{Declaration}{\Macro{and}}
\printdeclarationlist%
-\index{Kollaboratives Schreiben|?}\index{Titel!Kollaboratives Schreiben}%
-\index{Autorenangaben!kollaborativ}
+\index{Kollaboratives Schreiben|?}%
%
Dieser Befehl wird sowohl bei den \hologo{LaTeX}"=Standardklassen als auch bei
den \KOMAScript"=Klassen lediglich auf der Titelseite dazu verwendet, mehrere
@@ -1452,25 +1967,29 @@ Abschlussarbeiten innerhalb des Befehls \Macro{author} möglich ist. Außerdem
kann er noch im Argument von \Macro{supervisor}, \Macro{referee} sowie
\Macro{advisor} verwendet werden, um mehrere Betreuer beziehungsweise Gutachter
und Fachreferenten anzugeben. Er ist dabei nicht auf die Verwendung für den
-Titel allein beschränkt. Auch bei den Umgebungen \Environment{task},
-\Environment{evaluation} und \Environment{notice} kann er eingesetzt werden.
+Titel allein beschränkt sondern kann auch bei der Angabe von Personen in den
+entsprechenden Feldern der Umgebungen
+\begin{Bundle}{\Package{tudscrsupervisor}}
+\Environment{task}, \Environment{evaluation} und \Environment{notice}
+\end{Bundle}
+aus dem Paket \Package{tudscrsupervisor} eingesetzt werden.
\end{Declaration}
%
\begin{Example}
-Angenommen, es soll eine Abschussarbeit von zwei unterschiedlichen Autoren in
-kollaborativer Gemeinschaft erstellt werden, so könnte man die Autorenangaben
+Angenommen, es soll eine Abschlussarbeit von zwei unterschiedlichen Autoren in
+kollaborativer Gemeinschaft erstellt werden, so lässt sich die Autorenangaben
folgendermaßen gestalten:
\begin{Code}
\author{%
- Mickey Mouse
- \matriculationnumber{12345678}
- \dateofbirth{2.1.1990}
- \placeofbirth{Dresden}
+ Mickey Mouse%
+ \matriculationnumber{12345678}%
+ \dateofbirth{2.1.1990}%
+ \placeofbirth{Dresden}%
\and%
- Donald Duck
- \matriculationnumber{87654321}
- \dateofbirth{1.2.1990}
- \placeofbirth{Berlin}
+ Donald Duck%
+ \matriculationnumber{87654321}%
+ \dateofbirth{1.2.1990}%
+ \placeofbirth{Berlin}%
}
\matriculationyear{2010}
\end{Code}
@@ -1480,11 +1999,59 @@ von \Macro{author} werden den jeweiligen, mit \Macro{and} getrennten Autoren
zugeordnet. Mehr dazu ist im Minimalbeispiel in \autoref{sec:exmpl:thesis}.
\end{Example}
-\begin{Declaration}{\Macro{thesis}\Parameter{Typisierung}}
-\begin{Declaration}{\Macro{subject}\Parameter{Typisierung}}
+\begin{Declaration}[%
+ v2.05:Angabe von Parametern für Prä- und Suffix bei Datumsausgabe möglich;
+]{\Macro{date}[\OLParameter{Suffix}\Parameter{Datum}]}
+\begin{Declaration}[v2.05]{%
+ \Macro{date*}[\OLParameter{Suffix}\Parameter{Datum}]%
+}
+\begin{Declaration}[v2.05]{%
+ \Key{\Macro{date}}{before=\PName{Präfix}}%
+}
+\begin{Declaration}[v2.05]{%
+ \Key{\Macro{date}}{after=\PName{Suffix}}%
+}
+\begin{Declaration}[v2.05]{%
+ \Key{\Macro{date}}{place=\PName{Ort}}%
+}
+\begin{Declaration}{\Macro{defensedate}[\Parameter{Verteidigungsdatum}]}
+\printdeclarationlist%
+\index{Datum|?}%
+\index{Datum!Abgabedatum|?}%
+\index{Datum!Verteidigungsdatum|?}%
+%
+Mit dem Befehl \Macro{date} kann das Datum angegeben werden.
+\ChangedAt{v2.05} Über das optionale Argument können die beiden Parameter
+\Key{\Macro{date}}{before} und \Key{\Macro{date}}{after} genutzt werden, um
+ergänzende Angaben vor beziehungsweise nach dem eigentlichen Datum auszugeben.
+Die Sternversion \Macro{date*} setzt den mit \Macro{place} angegebenen Ort vor
+das Datum. Dies geschieht auch für die normale Version von \Macro{date}, wenn
+der Parameter \Key{\Macro{date}}{place} verwendet wird.
+
+Das Datum wird bei normalen Dokumenten direkt nach dem Autor respektive den
+Autoren ausgegeben. Bei Abschlussarbeiten~-- aktiviert durch die Verwendung von
+\Macro{thesis} oder \Option{subjectthesis} in Verbindung mit \Macro{subject}~--
+erscheint dieses am Ende der Titelseite als Abgabedatum. Außerdem kann in
+diesem Fall mit dem Befehl\Macro{defensedate} das Datum der Verteidigung
+angegeben werden, wie es beispielsweise bei dem Druck von Dissertationen üblich
+ist.
+
+Sollte das Paket \Package{isodate} geladen sein, so wird die damit eingestellte
+Formatierung des Datums durch \Macro{printdate}(\Package{isodate})'none' aus
+diesem Paket für alle Datumsfelder des Dokumentes und folglich auch für die
+beiden Felder \Macro{date} und \Macro{defensedate} verwendet.
+\end{Declaration}
+\end{Declaration}
+\end{Declaration}
+\end{Declaration}
+\end{Declaration}
+\end{Declaration}
+
+\begin{Declaration}{\Macro{thesis}[\Parameter{Typisierung}]}
+\begin{Declaration}{\Macro{subject}[\Parameter{Typisierung}]}
\printdeclarationlist%
-\index{Titel!Felder}%
-\index{Abschlussarbeit|!}\index{Typisierung}%
+\index{Abschlussarbeit|!}%
+\index{Typisierung}%
%
Mit diesen beiden Befehlen kann der Typ der Dokumentes beziehungsweise der
Abschlussarbeit angegeben werden. Während der Befehl \Macro{thesis} den Inhalt
@@ -1506,50 +2073,51 @@ der genannten Werte führt immer dazu, dass das Dokument als Abschlussarbeiten
erkannt und die erweiterte Titelseite aktiviert wird. Gleichzeitig wird damit
die Option \Option{subjectthesis} beeinflusst. Sollte vom Anwender kein
explizites Verhalten für \Option{subjectthesis} definiert sein, so führt die
-Verwendung von \Macro{thesis}\Parameter{Wert} zu \Option{subjectthesis}[false]
-und \Macro{subject}\Parameter{Wert} zu \Option{subjectthesis}[true].
+Verwendung von \Macro{thesis}[\Parameter{Wert}] zu \Option{subjectthesis=false}
+und \Macro{subject}[\Parameter{Wert}] zu \Option{subjectthesis=true}.
%
\begin{table}
-\index{Bezeichner}\index{Bezeichner!Typisierung}%\\
-\index{Abschlussarbeit!Typisierung}%
+\index{Bezeichner}%
+\index{Typisierung}%
\caption{%
Spezielle Werte zur Typisierung des Dokumentes für
\Macro{thesis} und \Macro{subject}%
-}
-\label{tab:thesis}%
+}%
+\tudhyperdef{tab:thesis}%
+%
\centering%
-\makeatletter%
-\def\@tempa#1{%
- \Term{#1} & \@nameuse{#1} & \selectlanguage{english}\@nameuse{#1}%
+\newcommand*\typecast[2]{%
+ \PValue{#1} & \Term{#2} & \csuse{#2} & \selectlanguage{english}\csuse{#2}
\tabularnewline%
}%
\begin{tabular}{llll}
\toprule
- \textbf{Wert} & \textbf{Bezeichner}
- & \textbf{Deutsch} & \textbf{Englisch} \tabularnewline
+ \textbf{Wert} & \textbf{Bezeichner} & \textbf{Deutsch} & \textbf{Englisch}
+ \tabularnewline
\midrule
- diss & \@tempa{dissertationname}
- doctoral & \@tempa{dissertationname}
- phd & \@tempa{dissertationname}
- diploma & \@tempa{diplomathesisname}
- master & \@tempa{masterthesisname}
- bachelor & \@tempa{bachelorthesisname}
- student & \@tempa{studentresearchname}
- project & \@tempa{projectpapername}
- seminar & \@tempa{seminarpapername}
- research & \@tempa{researchname}
- log & \@tempa{logname}
- report & \@tempa{reportname}
- internship & \@tempa{internshipname}
+ \typecast{diss}{dissertationname}
+ \typecast{doctoral}{dissertationname}
+ \typecast{phd}{dissertationname}
+ \typecast{diploma}{diplomathesisname}
+ \typecast{master}{masterthesisname}
+ \typecast{bachelor}{bachelorthesisname}
+ \typecast{student}{studentthesisname}
+ \typecast{evidence}{studentresearchname}
+ \typecast{project}{projectpapername}
+ \typecast{seminar}{seminarpapername}
+ \typecast{term}{termpapername}
+ \typecast{research}{researchname}
+ \typecast{log}{logname}
+ \typecast{report}{reportname}
+ \typecast{internship}{internshipname}
\bottomrule
\end{tabular}
-\makeatother%
\end{table}
\end{Declaration}
\end{Declaration}
-\begin{Declaration}{\Option{subjectthesis}[\PBoolean]}%
- [false][\Macro{subject}\Parameter{\autoref{tab:thesis}}:true]
+\begin{Declaration}{\Option{subjectthesis=\PBoolean}}%
+ [false][\Macro{subject}[\Parameter{\autoref{tab:thesis}}]:true]
\printdeclarationlist%
%
Der Befehl \Macro{thesis} dient den \TUDScript"=Hauptklassen zur Unterscheidung
@@ -1557,22 +2125,22 @@ zwei unterschiedlicher Ausprägungen der Titelseite und ist speziell für
Abschlussarbeiten gedacht. Außerdem kann bei der Nutzung spezieller Werte
aus \autoref{tab:thesis} innerhalb des Argumentes von \Macro{subject} ebenfalls
das Verhalten für Abschlussarbeiten aktiviert werden, wobei hierdurch die
-Einstellung \Option{subjectthesis}[true] automatisch vorgenommen wird.
+Einstellung \Option{subjectthesis=true} automatisch vorgenommen wird.
-Für den Standardfall~-- bekanntlich \Option{subjectthesis}[false]~-- wird der
+Für den Standardfall~-- bekanntlich \Option{subjectthesis=false}~-- wird der
durch \Macro{thesis} gegebene Typ der Abschlussarbeit sowie der gegebenenfalls
durch \Macro{graduation} gesetzte angestrebte Abschluss in großen Lettern und
sehr zentral auf der Titelseite gesetzt. Die Verwendung von \Macro{subject} ist
hierbei weiterhin möglich.
%
-Wird die Option mit \Option{subjectthesis}[true] aktiviert, so wird die mit
+Wird die Option mit \Option{subjectthesis=true} aktiviert, so wird die mit
\Macro{thesis} gesetzte Bezeichnung nicht unterhalb sondern oberhalb des Titels
an der Stelle von \Macro{subject} ausgegeben. Der mit \Macro{graduation}
angegebene Abschluss wird weiterhin unter dem Titel, allerdings in schlankerer
Schrift gesetzt. Eine etwaige Verwendung des Befehls \Macro{subject} wird in
diesem Fall ignoriert.
%
-\begin{values}
+\begin{values}{\Option{subjectthesis}}
\itemfalse
Die Ausgabe des Typs der Abschlussarbeit (\Macro{thesis}) selbst sowie des
angestrebten Abschlusses (\Macro{graduation}) erfolgt in großen Lettern in
@@ -1580,13 +2148,14 @@ diesem Fall ignoriert.
\itemtrue*
Der Typ der Abschlussarbeit (\Macro{thesis}) wird oberhalb des Titels in der
Betreffzeile gesetzt. Der angestrebte Abschluss (\Macro{graduation}) wird
- zentral in der schlankeren \Univers ausgegeben.
+ zentral in \Univers ausgegeben.
\end{values}
\end{Declaration}
-\begin{Declaration}[v2.02]{\Macro{graduation}\OParameter{Kurzform}\Parameter{Grad}}
+\begin{Declaration}[v2.02]{%
+ \Macro{graduation}[\OParameter{Kurzform}\Parameter{Grad}]%
+}
\printdeclarationlist%
-\index{Titel!Felder}%
%
Mit diesem Befehl wird der angestrebte akademische Grad auf der Titelseite
ausgegeben. Da dies nur mit einer Abschlussarbeit erreicht werden kann erfolgt
@@ -1594,21 +2163,21 @@ die Ausgabe nur, wenn entweder \Macro{thesis} oder \Macro{subject} verwendet
wurde, wobei bei letzterem Befehl im Argument zwingend ein Wert aus
\autoref{tab:thesis} verwendet werden muss.
-Die Option \Option{subjectthesis} hat Einfluss auf die Ausgabe auf der
-Titelseite. Für die Einstellung \Option{subjectthesis}[false] wird der
-Abschuss~-- ähnlich wie
-der Typ der Abschlussarbeit~-- zentral und in relativ großen Lettern gesetzt.
-Für \Option{subjectthesis}[true] erfolgt die Ausgabe kleiner und in weniger
-starken Buchstaben.
+Bei der Ausgabe des akademischen Grades hat die Option \Option{subjectthesis}
+Einfluss auf die Ausgabe auf der Titelseite. Bei \Option{subjectthesis=false}
+wird der Abschluss~-- ähnlich wie der Typ der Abschlussarbeit~-- zentral und in
+relativ großen Lettern gesetzt. Für \Option{subjectthesis=true} erfolgt die
+Ausgabe kleiner und in weniger starken Buchstaben.
\end{Declaration}
-\begin{Declaration}{\Macro{supervisor}\Parameter{Name(n)}}
-\begin{Declaration}{\Macro{referee}\Parameter{Name(n)}}
-\begin{Declaration}{\Macro{advisor}\Parameter{Name(n)}}
-\begin{Declaration}{\Macro{professor}\Parameter{Name}}
+\begin{Declaration}{\Macro{supervisor}[\Parameter{Name(n)}]}
+\begin{Declaration}{\Macro{referee}[\Parameter{Name(n)}]}
+\begin{Declaration}{\Macro{advisor}[\Parameter{Name(n)}]}
+\begin{Declaration}{\Macro{professor}[\Parameter{Name}]}
\printdeclarationlist%
-\index{Titel!Felder}%
-\index{Betreuer|?}\index{Gutachter|?}\index{Referent|?}%
+\index{Betreuer|?}%
+\index{Gutachter|?}%
+\index{Referent|?}%
%
Mit \Macro{supervisor}, \Macro{referee} und \Macro{advisor} werden die Betreuer
einer Abschlussarbeit beziehungsweise die Gutachter und Fachreferenten einer
@@ -1616,50 +2185,24 @@ Dissertation angegeben. Zusätzlich kann mit \Macro{professor} der betreuende
Hochschullehrer beziehungsweise die betreuenden Professoren für studentische
Arbeiten angegeben werden. Die Angabe mehrerer Person erfolgt wie beim Befehl
\Macro{author} durch die Trennung mittels \Macro{and}.
+\index{Titel!Felder|)}%
\end{Declaration}
\end{Declaration}
\end{Declaration}
\end{Declaration}
-\begin{Declaration}{\Macro{date}\OParameter{Ergänzung}\Parameter{Datum}}
-\begin{Declaration}{\Macro{defensedate}\Parameter{Verteidigungsdatum}}
+\begin{Bundle}{\Package{koma-script}}
+\begin{Declaration}{\Macro{extratitle}[\Parameter{Schmutztitel}]}
+\begin{Declaration}{\Macro{titlehead}[\Parameter{Kopf}]}
+\begin{Declaration}{\Macro{publishers}[\Parameter{Verlag}]}
+\begin{Declaration}{\Macro{thanks}[\Parameter{Fußnote}]}
+\begin{Declaration}{\Macro{uppertitleback}[\Parameter{Titelrückseitenkopf}]}
+\begin{Declaration}{\Macro{lowertitleback}[\Parameter{Titelrückseitenfuß}]}
+\begin{Declaration}{\Macro{dedication}[\Parameter{Widmung}]}
\printdeclarationlist%
-\index{Titel!Felder}
-\index{Datum|?}\index{Datum!Verteidigungsdatum|?}%
-%
-Mit \Macro{date} kann das Datum angegeben werden. Das optionale Argument
-erlaubt eine zusätzliche Anmerkung, welche nach dem Datum ausgegeben wird. Das
-Datum wird bei normalen Dokumenten direkt nach dem Autor beziehungsweise den
-Autoren ausgegeben. Bei Abschlussarbeiten~-- aktiviert durch die Verwendung von
-\Macro{thesis} oder \Option{subjectthesis}~-- erscheint dieses am Ende der
-Titelseite als Abgabedatum. Außerdem kann in diesem Fall mit dem Befehl
-\Macro{defensedate} das Datum der Verteidigung angegeben werden, wie es
-beispielsweise bei dem Druck von Dissertationen üblich ist.
-
-Sollte das Paket \Package{isodate} geladen sein, so wird die damit eingestellte
-Formatierung des Datums durch den Befehl \Macro{printdate} aus diesem Paket für
-alle Datumsfelder des Dokumentes und folglich auch für die beiden Felder
-\Macro{date} und \Macro{defensedate} verwendet.
-\end{Declaration}
-\end{Declaration}
-
-\begin{Declaration}{\Macro{extratitle}\Parameter{Schmutztitel}}
-\begin{Declaration}{\Macro{titlehead}\Parameter{Kopf}}
-\begin{Declaration}{\Macro{title}\Parameter{Titel}}
-\begin{Declaration}[%
- v2.01!Bugfix für Schriftstärke bei Verwendung des Untertitels%
-]{\Macro{subtitle}\Parameter{Untertitel}}
-\begin{Declaration}{\Macro{publishers}\Parameter{Verlag}}
-\begin{Declaration}{\Macro{thanks}\Parameter{Fußnote}}
-\begin{Declaration}{\Macro{uppertitleback}\Parameter{Titelrückseitenkopf}}
-\begin{Declaration}{\Macro{lowertitleback}\Parameter{Titelrückseitenfuß}}
-\begin{Declaration}{\Macro{dedication}\Parameter{Widmung}}
-\printdeclarationlist%
-\index{Titel!Felder}%
%
Diese Befehle entsprechen den in ihrem Verhalten den originalen Pendants der
-\KOMAScript"=Klassen{} und sollen hier der Vollständigkeit halber erwähnt
-werden.
+\KOMAScript"=Klassen und sollen hier der Vollständigkeit halber erwähnt werden.
Die Ausgabe des mit \Macro{extratitle} definierten Schmutztitels~-- welcher
beliebig gestaltet und formatiert werden kann~-- erfolgt als Bestandteil der
@@ -1669,20 +2212,17 @@ der Typisierung und des Titels ausgegeben werden. Da die vertikale Position des
Dokumenttitels durch das \CD fest vorgegeben ist, kann es~-- im Gegensatz zu
den \KOMAScript"=Klassen~-- passieren, dass der Kopf des Haupttitels selbst in
die Kopfzeile ragt. Dies wird durch die \TUDScript-Klassen nicht geprüft und
-muss gegebenenfalls vom Anwender kontrolliert werden.
-
-Die Befehle \Macro{title} und \Macro{subtitle} bedürfen keiner weiteren
-Erklärung. Anzumerken ist, dass sowohl Titel als auch Untertitel normalerweise
-in Majuskeln und \DIN gesetzt werden. Der mit dem Befehl \Macro{publishers}
-definierte Inhalt muss nicht zwingende einen Verlag bezeichnen sondern kann
-auch andere Informationen beinhalten, welche am Ende der Titelseite ausgegeben
-werden sollen.
-
-Fußnoten werden auf dem Titel nicht mit \Macro{footnote}, sondern mit der
-Anweisung \Macro{thanks} erzeugt. Diese dienen in der Regel für Anmerkungen bei
-Titel oder den Autoren. Als Fußnotenzeichen werden dabei Symbole statt Zahlen
-verwendet. Der Befehl \Macro{thanks} kann nur innerhalb des Arguments einer
-der Anweisungen für die Titelseite wie beispielsweise \Macro{author} oder
+muss gegebenenfalls vom Anwender kontrolliert werden. Der mit dem Befehl
+\Macro{publishers} definierte Inhalt muss nicht zwingende einen Verlag
+bezeichnen sondern kann auch andere Informationen beinhalten, welche am Ende
+der Titelseite ausgegeben werden sollen.
+
+Fußnoten werden auf dem Titel nicht mit
+\Macro{footnote}(\Package{koma-script})'none', sondern mit der Anweisung
+\Macro{thanks} erzeugt. Diese dienen in der Regel für Anmerkungen bei Titel
+oder den Autoren. Als Fußnotenzeichen werden dabei Symbole statt Zahlen
+verwendet. Der Befehl \Macro{thanks} kann nur innerhalb des Arguments einer der
+Anweisungen für die Titelseite wie beispielsweise \Macro{author} oder
\Macro{title} verwendet werden.
\index{Satzspiegel!doppelseitig}%
@@ -1695,6 +2235,7 @@ Mit \Macro{dedication} lässt eine separate Widmungsseite zentriert und in etwas
größerer Schrift setzen. Die Rückseite ist~-- wie auch die des Schmutztitels~--
grundsätzlich leer. Die Widmung wird mit der restlichen Titelei ausgegeben und
muss daher vor der Nutzung von \Macro{maketitle} angegeben werden.
+\index{Titel|!)}%
\end{Declaration}
\end{Declaration}
\end{Declaration}
@@ -1702,49 +2243,37 @@ muss daher vor der Nutzung von \Macro{maketitle} angegeben werden.
\end{Declaration}
\end{Declaration}
\end{Declaration}
-\end{Declaration}
-\end{Declaration}
-
-\begin{Declaration}[v2.02]{\Font{titlepage}}
-\begin{Declaration}[v2.02]{\Font{thesis}}
-\printdeclarationlist%
-\index{Schriftelemente}
-%
-Die \TUDScript-Klassen definieren diese neuen Schriftelemente. Dabei wird
-\Font{titlepage} auf der Titelseite für alle Felder verwendet, welche kein
-spezielles Schriftelement verwenden, welches ohnehin durch \KOMAScript{}
-bereitgestellt wird. Das mit \Macro{thesis} angegebene Feld, in welchem der Typ
-einer Abschlussarbeit angegeben wird, nutzt das Schriftelement~\Font{thesis}.
-Wie diese Elemente angepasst werden können, ist in \autoref{sec:fonts:elements}
-zu finden.
-\end{Declaration}
-\end{Declaration}
-\index{Titel|!)}
-
+\end{Bundle}
\subsection{Die Teileseite}
-\label{sec:part}
+\tudhyperdef*{sec:part}%
%
-\ChangedAt{%
- v2.02!\PageStyle{plain.tudheadings} wird genutzt!\Macro{partpagestyle}%
-}[Implementierung]
+\ChangedAt[\Macro{partpagestyle}(\Package{koma-script})]{%
+ v2.02:Seitenstil \PageStyle{plain.tudheadings} wird genutzt%
+}
Wird für die Teileseiten das Layout des \CDs verwendet, so wird der Seitenstil
-dieser (\Macro{partpagestyle}) auf \PageStyle{plain.tudheadings} gesetzt.
-Möchten Sie stattdessen einen anderen Seitenstil nutzen, so kann dieser mit
-\Macro*{renewcommand*}\PParameter{\Macro{partpagestyle}}\Parameter{Seitenstil}
+dieser (\Macro{partpagestyle}(\Package{koma-script})'none') auf
+\PageStyle{plain.tudheadings} gesetzt. Möchten Sie stattdessen einen anderen
+Seitenstil nutzen, so kann dieser mit
+\Macro*{renewcommand*}[%
+ \PParameter{\Macro{partpagestyle}(\Package{koma-script})'none'}%
+ \Parameter{Seitenstil}%
+]
angepasst werden.
-\begin{Declaration}{\Option{parttitle}[\PBoolean]}[false]%
+\begin{Declaration}{\Option{parttitle=\PBoolean}}[false]%
\printdeclarationlist%
-\index{Teileseiten|?}\index{Layout!Teileseiten}%
+\index{Layout!Teileseiten|?}%
+\index{Layout!Überschriften}%
%
Diese Option ermöglicht es, den mit \Macro{title} gegebenen Titel des
Dokumentes selbst in großer Schrift auf einer Teileseite auszugeben, die
-Bezeichnung des mit \Macro{part}\Parameter{Bezeichnung} erzeugten Teils wird
-in diesem Fall in kleiner Schrift direkt darunter gesetzt. Diese
-Layout"=Variante findet sich im Handbuch für das \CD der \TnUD. \notudscrartcl
+Bezeichnung des mit
+\Macro{part}[\Parameter{Bezeichnung}](\Package{koma-script})'none' erzeugten
+Teils wird in diesem Fall in kleiner Schrift direkt darunter gesetzt. Diese
+Layout"=Variante findet sich im Handbuch für das \TUDCD. \notudscrartcl
%
-\begin{values}
+\begin{values}{\Option{parttitle}}
\itemfalse
Die Bezeichnung des Teils erscheint in großer Schrift auf der Seite, der
Titel des Dokumentes gar nicht.
@@ -1756,326 +2285,232 @@ Layout"=Variante findet sich im Handbuch für das \CD der \TnUD. \notudscrartcl
\begin{Declaration}[v2.02]{\Font{parttitle}}
\printdeclarationlist%
-\index{Schriftelemente}
+\index{Schriftelemente}%
%
-Mit dem Schriftelement~\Font{parttitle} lässt sich~-- bei aktivierter
-\Option{parttitle}-Option~-- die Schrift für die Bezeichnung des Teils
-beeinflussen. In \autoref{sec:fonts:elements} ist zu finden, wie dieses
-angepasst werden kann.
+Mit dem Schriftelement~\Font{parttitle} lässt sich~-- bei aktivierter Option
+\Option{parttitle}~-- die Schrift für die Bezeichnung des Teils beeinflussen.
+In \autoref{sec:fonts:elements} ist zu finden, wie es angepasst werden kann.
\end{Declaration}
\subsection{Die Kapitelseite}
-\begin{Declaration}{\Option{chapterpage}[\PBoolean]}%
- [false][\Option{cd}[color]:true]%
+\begin{Declaration}{\Option{chapterpage=\PBoolean}}%
+ [false][\Option{cd=color}:true]%
\printdeclarationlist%
-\label{sec:chapter}%
-\index{Kapitelseiten|?}\index{Layout!Kapitelseiten|?}%
-\index{Satzspiegel!doppelseitig}\index{Vakatseiten}%
+\tudhyperdef*{sec:chapter}%
+\index{Layout!Kapitelseiten|?}%
+\index{Layout!Überschriften}%
+\index{Satzspiegel!doppelseitig}%
+\index{Vakatseiten}%
%
Mit dieser Einstellung kann die Überschrift eines Kapitels separat auf einer
Seite ausgegeben werden. Der nachfolgende Text wird auf der nächsten
beziehungsweise bei doppelseitigem Satz und rechts öffnenden Kapiteln%
\footnote{%
- \Option{twoside} und \Option{open}[right], Standard für \Class{tudscrbook}
+ \KOMAScript-Optionen \Option{twoside=true}(\Package{typearea})'none' und
+ \Option{open=right}(\Package{koma-script})'none', Standard für
+ \Class{tudscrbook}%
}
auf der übernächsten Seite ausgegeben. Die in diesem Fall erzeugte Rückseite
wird in ihrer Ausprägung~-- wie auch Teileseiten~-- durch die Einstellung von
\Option{cleardoublespecialpage} bestimmt. Beim farbigen Layout ist diese Option
standardmäßig aktiviert. \notudscrartcl
%
-\begin{values}
+\begin{values}{\Option{chapterpage}}
\itemfalse
Es gibt keine Sonderstellung von Kapiteln, der nachfolgende Text wird direkt
- unter der Überschrift respektive nach der mit \Macro{setchapterpreamble}
- erzeugten Kapitelpräambel auf der gleichen Seite ausgegeben.
+ unter der Überschrift respektive nach der mit
+ \Macro{setchapterpreamble}(\Package{koma-script})'none' erzeugten
+ Kapitelpräambel auf der gleichen Seite ausgegeben.
\itemtrue*
Die Kapitelüberschrift und gegebenenfalls die Kapitelpräambel werden auf
- einer separaten Seite gesetzt. Der folgende Text erscheint auf der nächsten
- respektive übernächsten Seite, \seealso*{\Option{cleardoublespecialpage}}.
+ einer separaten Seite gesetzt. Der folgende Text erscheint auf der nächsten
+ respektive übernächsten Seite, \seeref*{\Option{cleardoublespecialpage}}.
\end{values}
%
-\ChangedAt{%
- v2.02!nicht mehr abhängig von \Macro{partpagestyle}!\Macro{chapterpagestyle}
-}[Implementierung]
-Mit \Macro*{renewcommand*}\PParameter{\Macro{chapterpagestyle}}%
-\Parameter{Seitenstil} lässt sich übrigens~-- unabhängig von der Option
-\Option{chapterpage}~-- der Seitenstil von Kapiteln anpassen. Bei der
-Verwendung von separaten Kapitelseiten ist außerdem das Aktivieren der
-\KOMAScript-Option \Option{chapterprefix} empfehlenswert. Damit werden die
-Kapitelüberschriften mit einer Vorsatzzeile gesetzt. Falls ein nummeriertes
-Kapitel erzeugt wird, so wird zunächst in einer Zeile \enquote{Kapitel} gefolgt
-von der aktuellen Kapitelnummer ausgegeben, in der nächsten Zeile wird
-anschließend die eigentliche Überschrift in linksbündigem Flattersatz
-ausgegeben. Genaueres hierzu ist in der \KOMAScript"=Dokumentation
-nachzulesen.
+\ChangedAt[\Macro{chapterpagestyle}(\Package{koma-script})]{%
+ v2.02:nicht mehr abhängig von \Macro{partpagestyle}(\Package{koma-script})
+}
+Mit \Macro*{renewcommand*}[%
+ \PParameter{\Macro{chapterpagestyle}(\Package{koma-script})'none'}%
+ \Parameter{Seitenstil}%
+]
+lässt sich übrigens~-- unabhängig von der Option \Option{chapterpage}~-- der
+Seitenstil von Kapiteln anpassen. Bei der Verwendung von Kapitelseiten mit
+\Option{chapterpage=true} ist außerdem das Aktivieren der \KOMAScript-Option
+\Option{chapterprefix=\PBoolean}(\Package{koma-script})'none'|declare|
+empfehlenswert. Damit werden die Kapitelüberschriften mit einer Vorsatzzeile
+gesetzt. Wird ein nummeriertes Kapitel erzeugt, so wird zunächst in einer Zeile
+\enquote{Kapitel} gefolgt von der aktuellen Kapitelnummer ausgegeben, in der
+nächsten Zeile wird anschließend die eigentliche Überschrift in linksbündigem
+Flattersatz ausgegeben. Mehr dazu ist der \scrguide[\KOMAScript-Dokumentation]
+zu entnehmen.
\end{Declaration}
-
\subsection{Vakatseiten}
-\index{Vakatseiten}%
+\index{Vakatseiten|(}%
+%
Automatisch erzeugte Vakatseiten~-- auch absichtliche Leerseiten genannt~--
-findet man in Dokumenten mit den aktivierten Optionen \Option{twoside} und
-\Option{open}[right]\footnote{Standard bei \Class{tudscrbook}} beziehungsweise
-\Option{open}[left] beim Beginn von Teilen und Kapiteln. Für diese kann der
-Seitenstil mit der \KOMAScript"=Option \Option{cleardoublepage} eingestellt
-werden.
-
-\ToDo[doc,imp,nxt]{%
- Rückseite bei Kapitelseiten (auch bei Teilen?) im zweiseitigen Satz per
- Option nicht als Vakatseite setzen. Implementierung von farbigen Seiten davor
- (\Option*{open}[right]) sowie danach (\Option*{open}[left]). Setzen von
+sind in Abhängigkeit der
+\KOMAScript-Optionen \Option{twoside=\PSet}(\Package{typearea})'none'|declare|
+und \Option{open=\PName{Methode}}(\Package{koma-script})'none'|declare| am
+Beginn von Teilen und Kapiteln in Dokumenten zu finden.%
+\footnote{%
+ Voreinstellungen
+ \Class{tudscrbook}:
+ \Option{twoside=true}(\Package{typearea})'none',
+ \Option{open=right}(\Package{koma-script})'none';
+ \Class{tudscrartcl}, \Class{tudscrreprt}:
+ \Option{open=any}(\Package{koma-script})'none',
+ \Option{twoside=false}(\Package{typearea})'none'%
+}
+Für die Vakatseiten kann der Seitenstil mit der \KOMAScript"=Option
+\Option{cleardoublepage=\PSet}(\Package{koma-script})'none'|declare|
+eingestellt werden.
+
+\ToDo[doc,imp]{%
+ Rückseite bei Kapitelseiten (auch bei Teilen?) im doppelseitigen Satz per
+ Option nicht als Vakatseite setzen. Implementierung von farbigen Seiten
+ davor (\Option*{open=right}) sowie danach (\Option*{open=left}). Setzen von
speziellen Inhalten auf diesen Seiten äquivalent zu \Macro*{setpartpreamble}
bzw. \Macro*{setchapterpreamble}; ggf. temporär umschalten bzw. Warnung bei
Konflikt.
\url{http://latex.wcms-file3.tu-dresden.de/phpBB3/viewtopic.php?f=11&t=396}
}[v2.06]
-\begin{Declaration}{\Option{cleardoublespecialpage}[\PSet]}[true]%
+\begin{Declaration}{\Option{cleardoublespecialpage=\PSet}}[true]%
\printdeclarationlist%
-\index{Teileseiten}\index{Layout!Teileseiten}%
-\index{Kapitelseiten}\index{Layout!Kapitelseiten}%
-\index{Satzspiegel!doppelseitig}\index{Layout!Rückseiten}%
+\index{Layout!Teileseiten}%
+\index{Layout!Kapitelseiten}%
+\index{Layout!Rückseiten}%
+\index{Satzspiegel!doppelseitig}%
%
Diese Option wirkt sich lediglich bei aktiviertem doppelseitigem Satz und
ausschließlich rechts eröffnenden Seiten für Teile beziehungsweise Kapitel
aus.%
-\footnote{\Option{twoside} und \Option{open}[right]}
+\footnote{%
+ \KOMAScript"=Option \Option{twoside=true}(\Package{typearea})'none' und
+ \Option{open=right}(\Package{koma-script})'none'%
+}
In diesem Fall kann der Stil der darauffolgenden, linken Seite~-- sprich der
Rückseite~-- beeinflusst werden. Das Normalverhalten sieht vor, dass nach einem
-Teil die Rückseite unabhängig von der Einstellung für \Option{cleardoublepage}
-immer als vollständig leere Seite ohne Kopf"~ oder Fußzeilen gesetzt wird.
+Teil die nachfolgende Rückseite unabhängig von der Einstellung für
+\Option{cleardoublepage}(\Package{koma-script})'none' immer als vollständig
+leere Seite ohne Kopf"~ oder Fußzeilen gesetzt wird.
Diese Einstellung erlaubt es, dieses Normalverhalten zu deaktivieren und für
die Seite nach der Teileseite~-- und abhängig von \Option{chapterpage}
auch nach einem Kapitelanfang auf einer separaten Seite~-- den Seitenstil der
-Option \Option{cleardoublepage} zu übernehmen. Des Weiteren kann auch ein
-anderer, beliebiger, bereits definierter Seitenstil gewählt werden. Außerdem
-kann im farbigen Layout die Rückseite in der gleichen Farbe wie die
-Vorderseite von Teil oder Kapitel gesetzt werden. \notudscrartcl
+Option \Option{cleardoublepage}(\Package{koma-script})'none' zu übernehmen. Des
+Weiteren kann auch ein anderer, beliebiger, bereits definierter Seitenstil
+gewählt werden. Außerdem kann im farbigen Layout die Rückseite in der gleichen
+Farbe wie die Vorderseite von Teil oder Kapitel gesetzt werden. \notudscrartcl
%
-\begin{values}
+\begin{values}{\Option{cleardoublespecialpage}}
\itemfalse
Die Rückseiten sind vollständig leere Seiten, unabhängig von Option
- \Option{cleardoublepage}.
+ \Option{cleardoublepage}(\Package{koma-script})'none'.
\itemtrue*
- Der Seitenstil der Rückseite von Teilen und gegebenenfalls Kapiteln
- entspricht der Einstellung von \Option{cleardoublepage} für Vakatseiten.
+ Der Seitenstil der Rückseite von Teilen und gegebenenfalls Kapiteln entspricht
+ der Einstellung von \Option{cleardoublepage}(\Package{koma-script})'none' für
+ Vakatseiten.
\item[current]
- Es wird der aktuell definierte Seitenstil (\Macro{pagestyle}) für die
- erzeugte Rückseite verwendet.
-\itemvalues[\PName{Seitenstil}:]
- Mit der Angabe von \Option{cleardoublespecialpage}[\PName{Seitenstil}]
+ Für die erzeugte Rückseite wird der aktuell definierte Seitenstil
+ (\Macro{pagestyle}(\Package{koma-script})'none') verwendet.
+\item[\PValueName{Seitenstil}]
+ Mit der Angabe von \Option{cleardoublespecialpage=\PName{Seitenstil}}
kann ein beliebiger, bereits definierter Seitenstil für die Rückseite nach
Teilen und Kapiteln verwendet werden.
\item[color]
Im farbigen Layout ist auch die Rückseite von Teilen und Kapiteln farbig,
- \see*{\Option{clearcolor}}.
-\ToDo[imp,nxt]{\PValue{nocolor}}[v2.06]
+ \seeref{\Option{clearcolor}}.
\end{values}
+\ToDo[imp]{\PValue{nocolor}}[v2.06]
\end{Declaration}
-\ToDo[doc,imp,nxt]{%
- \Option{clearcolor} in \Option{cleardoublespecialpage}%
+\ToDo[doc,imp]{%
+ \Option*{clearcolor} in \Option*{cleardoublespecialpage}%
}[v2.06]
-\begin{Declaration}{\Option{clearcolor}[\PBoolean]}[false]%
+\begin{Declaration}{\Option{clearcolor=\PBoolean}}[false]%
\printdeclarationlist%
-\index{Titel}\index{Layout!Titel}%
-\index{Teileseiten}\index{Layout!Teileseiten}%
-\index{Kapitelseiten}\index{Layout!Kapitelseiten}%
-\index{Satzspiegel!doppelseitig}\index{Vakatseiten}%
+\index{Titel}%
+\index{Layout!Teileseiten}%
+\index{Layout!Kapitelseiten}%
+\index{Satzspiegel!doppelseitig}%
%
-Sollten beim farbigen Layout die Optionen \Option{twoside} sowie auch
-\Option{open}[right] gesetzt sein, so werden beim Aktivieren dieser Option die
-Rückseiten von Teilen~-- und je nach Einstellung von \Option{chapterpage}
-gegebenenfalls auch von Kapiteln~-- farbig gesetzt.%
-\footnote{%
- Dies führt bei der Ausgabe zu farbigen Blättern (Vorder- und Rückseite) der
- entsprechenden Elemente des Layouts.
-}
+Sollten beim farbigen Layout die \KOMAScript-Optionen
+\Option{twoside=true}(\Package{typearea})'none' und auch
+\Option{open=right}(\Package{koma-script})'none' gesetzt sein, so werden beim
+Aktivieren dieser Option die Rückseiten von Teilen~-- und je nach Einstellung
+von \Option{chapterpage} gegebenenfalls auch von Kapiteln~-- farbig gesetzt.
Die Option wirkt sich ebenfalls auf die Rückseite des Titels aus.%
\footnote{%
- \see*{\Macro{uppertitleback} und \Macro{lowertitleback}} der
- \KOMAScript"=Dokumentation (\scrguide*)
+ \seeref{\Macro{uppertitleback}(\Package{koma-script}) und
+ \Macro{lowertitleback}(\Package{koma-script})} im \scrguide*%
}
Der Stil dieser zusätzlich eingefügten Rückseiten ist abhängig von der Option
\Option{cleardoublespecialpage}.
%
-\begin{values}
+\begin{values}{\Option{clearcolor}}
\itemfalse
Es werden weiße Rückseiten bei Titel, Teilen und gegebenenfalls Kapiteln
erzeugt.
\itemtrue*
Die rückwärtigen Seiten der genannten Elemente des Layouts sind farbig.
\end{values}
+\index{Vakatseiten|)}%
\end{Declaration}
-
-\subsection{Der Satzspiegel}
-\begin{Declaration}[v2.03]{\Option{cdgeometry}[\PSet]}[true]%
-\printdeclarationlist%
-\index{Satzspiegel|(}\index{Layout!Satzspiegel|(}%
-\index{Seitenstil}\index{Layout!Seitenstil}%
-\index{Satzspiegel!doppelseitig}%
-\index{Layout!Seitenränder}%
-%
-Diese Option ist für die Aufteilung beziehungsweise die Berechnung des
-Satzspiegels verantwortlich. Das Maß der Seitenränder ist im \CD fest
-vorgegeben und wird standardmäßig von den \TUDScript-Klassen eingehalten.
-Allerdings lassen sich die Seitenränder anpassen, um beispielsweise einen
-vernünftigen doppelseitigen Satz zu ermöglichen.%
-\footnote{Hierbei sollte der innere Rand schmaler als der äußere sein}
-Des Weiteren besteht die Möglichkeit, auf das Standardverhalten von
-\KOMAScript{} zurückzufallen und die Satzspiegelberechnung durch das Paket
-\Package{typearea} vornehmen zu lassen. Hier hat insbesondere die Klassenoption
-\Option{DIV}[\PSet] maßgeblichen Einfluss auf den Satzspiegel. Mehr dazu ist in
-der Dokumentation von \KOMAScript{} zu finden.
-%
-\begin{values}
-\itemfalse
- Die Satzspiegelberechnung erfolgt via \Package{typearea}, die Vorgaben des
- \CDs bezüglich der Seitenränder werden ignoriert.
-\itemtrue*[asymmetric/cd]
- Die Seitenränder werden im asymmetrischen Stil des \CDs fest definiert und
- auch für den doppelseitigen Satz (\Option{twoside}[true]) genutzt.%
- \footnote{links: 30\,mm, rechts: 20\,mm, oben: 25\,mm, unten: 30\,mm}
-\item[symmetric/centred/centered]
- Der Satzspiegel wird im einseitigen sowie doppelseitigen Satz auf der Seite
- zentriert.%
- \footnote{links: 25\,mm, rechts: 25\,mm, oben: 25\,mm, unten: 30\,mm}
-\item[balanced/twoside]
- Im einseitigen Layout ist diese Einstellung zu \Option{cdgeometry}[symmetric]
- identisch. Beim doppelseitigen Satz wird der Satzspiegel derart verändert,
- dass die Ränder der inneren Seiten schmaler sind als die der äußeren.%
- \footnote{innen: 20\,mm, außen: 30\,mm, oben: 25\,mm, unten: 30\,mm}
- \Attention{%
- Der so erzeugte Satzspiegel ist jedoch nicht sehr vorteilhaft. Es ist zu
- beachten, dass dabei das Logo der \TnUD sehr nah am inneren Seitenrand
- des Dokumentes gesetzt wird, folglich insbesondere auf rechten respektive
- ungeraden Seiten sehr weit an den Blattrand rückt.
- }%
-\end{values}
-%
-Für die Festlegung der Seitenränder wird das Paket \Package{geometry} genutzt.
-Ist \Option{cdgeometry}[false] gewählt, erfolgt die Berechnung des Satzspiegels
-durch \Package{typearea}. Die damit berechneten Werte werden anschließend an
-\Package{geometry} weitergereicht und durch dieses umgesetzt.
-\end{Declaration}
-
-\begin{Declaration}[v2.03]{\Option{extrabottommargin}[\PName{Höhe}]}[0pt]%
-\printdeclarationlist%
-\index{Fußzeile|?}
-%
-Mit dieser Option kann die Größe des unteren Seitenrandes angepasst werden,
-wenn der Satzspiegel des \CDs (\Option{cdgeometry}[true/symmetric/balanced])
-verwendet wird. Insbesondere für den Fall, dass im Fußbereich der Seiten im
-Stil \PageStyle{tudheadings} entweder mit \Macro{footlogo} Drittlogos verwendet
-werden und diese über das optionale Argument oder via \Length{footlogoheight}
-über die Standardhöhe hinaus vergrößert wurden oder mit \Macro{footcontent} ein
-übergroßer Inhalt angegeben wurde, kann dieser unter Umständen etwas zu klein
-sein. Mit der Option \Option{extrabottommargin} wird der Fußbereich durch
-positive Werte vergrößert, negative Werte verkleinern diesen entsprechend.
-
-Alternativ zu \Option{extrabottommargin} kann auch die Option \Option{cdfoot}
-mit einer Längenangabe verwendet werden. Dabei spielt es für beide Optionen
-keine Rolle, ob eine \hologo{LaTeX}-Länge, ein \hologo{TeX}-Abstand oder eine
-\hologo{TeX}-Ausdehnung als Länge bei der Wertzuweisung verwendet wird.
-\end{Declaration}
-
-\minisec{Kopf"~ und Fußzeile im Zusammenspiel mit dem Satzspiegel}
-\index{Kopfzeile|?}\index{Layout!Kopfzeile}%
-\index{Fußzeile|?}\index{Layout!Fußzeile}%
-Da im \CD nicht festgelegt ist, wie die Gestaltung der Kopf"~ und Fußzeilen in
-einer wissenschaftlichen Arbeit auszuführen ist, bleibt dem Nutzer dafür eine
-gewisse Freiheit. Dafür sollte idealerweise das zu \KOMAScript{} gehörige Paket
-\Package{scrlayer-scrpage} genutzt werden.
-
-In der Dokumentation zu \Package{typearea} wird auch darauf eingegangen, wann
-Kopf"~ und Fußzeile bei der Satzspiegelkonstruktion entweder dem Rand oder dem
-Textkörper zugeschlagen werden sollten. Dies sollte bei der Erstellung eigener
-Kopf"~ und Fußzeilen beachtet werden. Die Einstellung dafür erfolgt mit den
-beiden \KOMAScript"=Optionen \Option{headinclude}[\PBoolean] sowie
-\Option{footinclude}[\PBoolean]. Diese können~-- unabhängig von der gewählten
-Einstellung zur Satzspiegelgestaltung für die Option \Option{cdgeometry}~--
-verwendet werden.
-
-\minisec{Bindekorrektur}
-\index{Bindekorrektur|!}\index{Layout!Bindekorrektur}%
-%
-Zu erwähnen im Zusammenhang mit Seitenrändern und Satzspiegel ist die durch
-\Package{typearea} angebotene Option \Option{BCOR}[\PName{Länge}], mit der bei
-der Satzspiegelberechnung ein Heftrand beziehungsweise eine Bindekorrektur
-berücksichtigt wird. Die \TUDScript-Klassen reichen diesen Wert auch an
-\Package{geometry} weiter, so dass der Benutzer unabhängig von der Auswahl zur
-Satzspiegelgestaltung diese Option nutzen kann. So kann beispielsweise eine
-Bindekorrektur von \unit[5]{mm} mit der Klassenoption \Option{BCOR}[5mm]
-gesetzt werden.
-
-Eine Anpassung der Bindekorrektur hat natürlich \emph{immer} eine Änderung der
-verfügbaren Breite des Textbereichs zur Folge hat und führt somit zwingend zu
-einer Anpassung des Satzspiegels. Da die Bindekorrektur jedoch abhängig von der
-Höhe des Buchblocks gewählt werden sollte, welche letztendlich erst mit dem
-Druck des fertiggestellten Dokumentes bestimmt werden kann, muss diese zu
-Beginn abgeschätzt werden.
-%
-\begin{Example}
-Als Faustregel gilt, dass die erforderliche Bindekorrektur in etwa der halben
-Höhe des Buchblocks entsprechen sollte. Dessen Höhe wiederum ist abhängig von
-der Anzahl der Seiten sowie der Dichte des verwendeten Papiers. Wird normales
-Papier mit einer Dichte von \unit[80]{g/m²} verwendet, so entsprechen 100~Blatt
-in etwa einer Höhe von \unit[10]{mm}, bei \unit[100]{g/m²} ca. \unit[12]{mm}.
-Dementsprechend wäre eine Bindekorrektur von \Option{BCOR}[5mm] beziehungsweise
-\Option{BCOR}[6mm] bei diesem Beispiel zu wählen.
-\end{Example}
-\index{Satzspiegel|)}\index{Layout!Satzspiegel|)}%
-
-
\subsection{Verwendung von Schriftelementen}
-\label{sec:fonts:elements}%
-\index{Schriftelemente|!}
+\tudhyperdef*{sec:fonts:elements}%
+\index{Schriftelemente|!}%
+%
Von \TUDScript werden weitere Schriftelemente~-- in Ergänzung zu den bereits
durch \KOMAScript{} bereitgestellten~-- definiert. Dies sind \Font{titlepage},
\Font{thesis}, \Font{tudheadings} sowie \Font{parttitle}. Sowohl die bereits
-durch \KOMAScript{} definierten als auch alle hier genannten Schriftelemente
-und später erläuterten sollten im Bedarfsfall durch den Anwender über den
-Befehl \Macro{addtokomafont}\Parameter{Schriftelement}\Parameter{Einstellungen}
-angepasst werden. Mehr dazu ist im \KOMAScript"=Handbuch \scrguide im
-Abschnitt \emph{Textauszeichnungen} zu finden.
+durch \KOMAScript{} definierten als auch alle hier genannten und folgend
+erläuterten Schriftelemente sollten im Bedarfsfall vom Anwender über den Befehl
+\Macro{addtokomafont}[%
+ \Parameter{Schriftelement}\Parameter{Einstellungen}%
+](\Package{koma-script})'none' angepasst werden. Mehr dazu ist im \scrguide
+innerhalb des Abschnitts \emph{Textauszeichnungen} zu finden.
\subsection{Die Farben des \CDs}
-\index{Farben}%
-%
+\index{Layout!Farben}%
+%
Zur Verwendung der Farben des \CDs wird das Paket \Package{tudscrcolor}
genutzt. Falls dieses nicht in der Präambel geladen wird~-- um beispielsweise
zusätzliche Optionen aufzurufen~-- binden die \TUDScript"=Klassen dieses
automatisch ein. Detaillierte Informationen sind in der Dokumentation von
\Package{tudscrcolor}'full' zu finden.
+\index{Layout|)}%
-
-
+\ToDo[doc]{Erzwungener Seitenumbruch raus!}[v2.06]
+\clearpage
\section{Zusätzliche Optionen und Erweiterungen}
\ChangedAt*{%
- v2.03!Bugfix für \abstractname{,} \confirmationname{} und \blockingname{}
- bei Seitenstil und Kolumnentitel%
+ v2.03:Bugfix für \abstractname, \confirmationname{} und \blockingname{}
+ bei der Festlegung von Seitenstil und Kolumnentitel%
}%
-Neben den Befehlen für die Anpassung des Layouts an das \CD der \TnUD stellen
-die \TUDScript-Klassen weitere Befehle und Umgebungen zur Verfügung, um die
+Neben den Befehlen für die Anpassung des Layouts an das \TUDCD stellen die
+\TUDScript-Klassen weitere Befehle und Umgebungen zur Verfügung, um die
Anwendung insbesondere für wissenschaftliche Arbeiten zu erleichtern.
\subsection{Zusammenfassung/Kurzfassung}
+\index{Zusammenfassung|!(}%
+%
\begin{Declaration}[%
- v2.02!Wert \PValue{double} mit \PValue{multi} ersetzt,%
- v2.02!Wert \PValue{tocleveldown} neu,%
- v2.02!Wert \PValue{markboth} neu,%
- v2.04!Wert \PValue{tocmultiple} neu%
-]{\Option{abstract}[\PSet]}%
+ v2.02!\Option{abstract=multiple}:ersetzt \Option{abstract=double};%
+ v2.02!\Option{abstract=tocleveldown};%
+ v2.02!\Option{abstract=markboth};%
+ v2.04!\Option{abstract=tocmultiple}%
+]{\Option{abstract=\PSet}}%
\printdeclarationlist%
-\index{Zusammenfassung|!(}%
-\index{Zweispaltensatz}%
+\index{Satzspiegel!zweispaltig}%
%
Diese Option wird bereits durch \KOMAScript{} für die Klassen \Class{scrartcl}
und \Class{scrreprt} standardmäßig bereitgestellt. Für die Klasse
@@ -2083,7 +2518,7 @@ und \Class{scrreprt} standardmäßig bereitgestellt. Für die Klasse
%
\begin{quoting}
Bei Büchern wird in der Regel eine andere Art der Zusammenfassung verwendet.
-Dort setzt man ein entsprechendes Kapitel an den Anfang oder Ende des Werks.
+Dort wird ein entsprechendes Kapitel an den Anfang oder Ende des Werks gesetzt.
Oft wird diese Zusammenfassung entweder mit der Einleitung oder einem weiteren
Ausblick verknüpft. Daher gibt es bei \Class{scrbook} generell keine
\Environment{abstract}"=Umgebung. Bei Berichten im weiteren Sinne, etwa einer
@@ -2098,25 +2533,24 @@ die Zusammenfassung außerdem in Gestalt eines \sectionautorefname{}s oder für
\Class{tudscrreprt} und \Class{tudscrbook} in der Form eines
\chapterautorefname{}s ausgegeben werden.
%
-\begin{values}
-\itemfalse[][nur für \Class{tudscrartcl} und \Class{tudscrreprt} verfügbar]
+\begin{values}{\Option{abstract}}
+\itemfalse(nur \Class{tudscrartcl} und \Class{tudscrreprt})
Es wird keine Überschrift für die \Environment{abstract}"=Umgebung ausgegeben.
-\itemtrue*[][nur für \Class{tudscrartcl} und \Class{tudscrreprt} verfügbar]
+\itemtrue*(nur \Class{tudscrartcl} und \Class{tudscrreprt})
Wie bei den \KOMAScript"=Klassen wird eine zentrierte Überschrift mit dem
Bezeichner \Term{abstractname} vor der eigentlichen Zusammenfassung gesetzt.
\item[section/addsec]
Die Überschrift (\Term{abstractname}) verwendet den Gliederungsbefehl
- \Macro{section}.
-\item[chapter/addchap][%
- (Säumniswert für \Class{tudscrbook})
- nur für \Class{tudscrreprt} und \Class{tudscrbook} verfügbar%
- ]
- Es wird der Befehl \Macro{chapter} für das Setzen der Überschrift
- (\Term{abstractname}) genutzt.
+ \Macro{section}(\Package{koma-script})'none'.
+\item[chapter/addchap][\Class{tudscrbook}](%
+ nur \Class{tudscrreprt} und \Class{tudscrbook}%
+ )
+ Es wird der Befehl \Macro{chapter}(\Package{koma-script})'none' für das
+ Setzen der Überschrift (\Term{abstractname}) genutzt.
\item[heading]
Es wird die höchstmögliche Gliederungsebene verwendet. Für
- \Class{tudscrartcl} entspricht dies \Option{abstract}[section], bei
- \Class{tudscrreprt} und \Class{tudscrbook} \Option{abstract}[chapter].
+ \Class{tudscrartcl} entspricht dies \Option{abstract=section}, bei
+ \Class{tudscrreprt} und \Class{tudscrbook} \Option{abstract=chapter}.
\end{values}
%
Abhängig von der gewählten Gliederungsebene der Überschrift wird das Verhalten
@@ -2127,14 +2561,14 @@ Zusammenfassung für gewöhnlich im Inhaltsverzeichnis auf der obersten Ebene.
Das voreingestellte Verhalten für die Einträge ins Inhaltsverzeichnis kann
jederzeit mit folgenden Werten durch den Anwender überschrieben werden.
%
-\begin{values}
+\begin{values}{\Option{abstract}}
\item[notoc/nottotoc]
Die Zusammenfassung wird definitiv nicht ins Inhaltsverzeichnis eingetragen.
\item[toc/totoc]
Es wird ein nicht nummerierten Eintrag im Inhaltsverzeichnis auf der obersten
Gliederungsebene der verwendeten Dokumentklasse für die Zusammenfassung
gesetzt.
-\item[leveldown/tocleveldown/totocleveldown]
+\item[tocleveldown/leveldown/totocleveldown]
\ChangedAt{v2.02}
Der Inhaltsverzeichniseintrag wird eine Gliederungsebene unterhalb der
obersten erzeugt.
@@ -2146,13 +2580,16 @@ jederzeit mit folgenden Werten durch den Anwender überschrieben werden.
%
\ChangedAt{v2.02}
Außerdem kann das Verhalten für die Kolumnentitel durch den Nutzer beeinflusst
-werden. Normalerweise werden diese nur gesetzt, wenn automatische Kolumnentitel
-aktiviert sind (\Option{automark}) und sind von der Gliederungsebene der
-Überschrift abhängig. Werden manuelle Kolumnentitel genutzt, müssen diese auch
-für die Zusammenfassung manuell gesetzt werden. Mit \Option{abstract}[markboth]
-lässt sich das Setzen der Kolumnentitel jedoch forcieren.
-%
-\begin{values}
+werden. Diese werden normalerweise automatisch gesetzt, wenn diese über die
+\KOMAScript-Option \Option{automark}(\Package{scrlayer-scrpage})'none'
+aktiviert wurden und sind von der aktuellen Gliederungsebene der Überschrift
+abhängig. Werden jedoch mit Hilfe der \KOMAScript-Option
+\Option{manualmark}(\Package{scrlayer-scrpage})'none' manuelle Kolumnentitel
+genutzt, müssen diese normalerweise auch für die Zusammenfassung durch den
+Anwender gesetzt werden. Mit \Option{abstract=markboth} lässt sich allerdings
+das Setzen der Kolumnentitel unabhängig davon forcieren.
+%
+\begin{values}{\Option{abstract}}
\item[markboth]
Unabhängig von der Verwendung manueller oder automatischer Kolumnentitel
werden diese auf rechten sowie linken Seiten mit \Term{abstractname} gesetzt.
@@ -2167,16 +2604,17 @@ Inhalt gesetzt werden.
Häufig wird für Abschlussarbeiten verlangt, neben der deutschsprachigen auch
noch eine englischsprachige Zusammenfassung zu verfassen. Mit der Einstellung
-\Option{abstract}[multiple] lassen sich mehrere Zusammenfassungen auf einer
+\Option{abstract=multiple} lassen sich mehrere Zusammenfassungen auf einer
Seite ausgeben~-- sofern genügend Platz vorhanden ist. Außerdem kann die
standardmäßige vertikale Zentrierung der \Environment{abstract}"=Umgebung
auf einer Seite unterdrückt werden. Diese Einstellungen zur Positionierung der
Zusammenfassungen innerhalb der \Environment{abstract}"=Umgebung werden nur
-wirksam, wenn eine Titelseite (\Option{titlepage}[true]) und \emph{keine}
-Überschriften in Form von Kapiteln (\Option{abstract}[chapter]) verwendet
-werden.
+wirksam, wenn eine Titelseite
+(\KOMAScript-Option \Option{titlepage=true}(\Package{koma-script})'none') und
+\emph{keine} Überschriften in Form von Kapiteln (\Option{abstract=chapter})
+verwendet werden.
%
-\begin{values}
+\begin{values}{\Option{abstract}}
\item[single/one/simple]
Jede Zusammenfassung wird auf einer eigenen Seite
beziehungsweise im zweispaltigen Satz in einer neuen Spalte ausgegeben.
@@ -2184,45 +2622,47 @@ werden.
\ChangedAt{v2.02}
Zusammenfassungen, welche mit \Macro{nextabstract} getrennt wurden, werden
direkt nacheinander auf der gleichen Seite ausgegeben, wenn ausreichend Platz
- auf dieser vorhanden sein sollte. Ist die Option \Option{twocolumn} aktiviert,
- erfolgt die Ausgabe aller Zusammenfassungen ohne Spaltenumbruch.
-\item[fil/fill/vfil/vfill]
- Alle Zusammenfassungen auf einer Ausgabeseite werden vertikal zentriert. Für
- den zweispaltigen Satz mit \Option{twocolumn} steht diese Einstellung nicht
- zur Verfügung.
-\item[nofil/nofill/novfil/novfill]
+ auf dieser vorhanden sein sollte. Ist die Klassenoption
+ \Option{twocolumn}(\Package{typearea})'none' aktiviert, erfolgt die Ausgabe
+ aller Zusammenfassungen ohne Spaltenumbruch.
+\item[fill/fil/vfil/vfill]
+ Alle Zusammenfassungen werden bei der Ausgabe auf einer Seite vertikal
+ zentriert. Diese Einstellung steht für den zweispaltigen Satz
+ (Klassenoption \Option{twocolumn}(\Package{typearea})'none') nicht zur
+ Verfügung.
+\item[nofill/nofil/novfil/novfill]
Die Ausgabe erfolgt wie im normalen Fließtext auch.
\end{values}
\end{Declaration}
\begin{Declaration}[%
- v2.02!\Macro{nextabstract} zur Trennung der einzelnen Teile%
+ v2.02:Trennung einzelner Abschnitte mit \Macro{nextabstract};%
]{\Environment{abstract}[\OLParameter{Sprache}]}
-\begin{Declaration}[v2.02]{\Macro{nextabstract}\OLParameter{Sprache}}
-\begin{Declaration}{\Key{\Environment{abstract}}{language}[\PName{Sprache}]}
-\begin{Declaration}[v2.02]{%
- \Key{\Environment{abstract}}{markboth}[\PBName{Kolumnentitel}]%
-}
+\begin{Declaration}{\Macro{nextabstract}[\OLParameter{Sprache}]}
+\begin{Declaration}{\Key{\Environment{abstract}}{language=\PName{Sprache}}}
+\begin{Declaration}[v2.02]{\Key{\Environment{abstract}}{markboth=\PSet}}
\begin{Declaration}[v2.02]{%
- \Key{\Environment{abstract}}{pagestyle}[\PName{Seitenstil}]%
+ \Key{\Environment{abstract}}{pagestyle=\PName{Seitenstil}}%
}
-\begin{Declaration}{\Key{\Environment{abstract}}{columns}[\PName{Anzahl}]}
-\begin{Declaration}{\Key{\Environment{abstract}}{option}[\PSet]}{%
- \see*{\Option{abstract}'ppage'}%
+\begin{Declaration}{\Key{\Environment{abstract}}{columns=\PName{Anzahl}}}
+\begin{Declaration}{\Key{\Environment{abstract}}{option=\PSet}}{%
+ \seeref{\Option{abstract}'ppage'}%
}
\printdeclarationlist%
-\index{Zweispaltensatz}%
+\index{Satzspiegel!zweispaltig}%
%
-Die \Environment{abstract}-Umgebung dient speziell für die Ausgabe einer
+Die \Environment{abstract}"=Umgebung dient speziell für die Ausgabe einer
Zusammenfassung, entweder zu Beginn eines Dokumentes oder beispielsweise vor
-einem Teil oder Kapitel. Wird ein Titelkopf (\Option{titlepage}[false]) und
-keine Titelseite verwendet, so wird für den Fall, dass die Zusammenfassung
-\emph{nicht} mit der Überschrift einer Gliederungsebene gesetzt wird, diese wie
-bei den \KOMAScript"=Klassen in einer \Environment{quotation}"=Umgebung
-gesetzt, um diese vom restlichen Fließtext abzuheben. Diese hat jedoch den
-Nachteil, dass in besagter Umgebung die Option \Option{parskip} nicht beachtet
-wird. Um dieses Problem zu beheben, kann das Paket \Package{quoting} geladen
-werden, wodurch stattdessen die Umgebung \Environment{quoting} verwendet wird.
+einem Teil oder Kapitel. Wird ein Titelkopf und keine Titelseite verwendet
+(\KOMAScript-Option \Option{titlepage=false}(\Package{koma-script})'none'), so
+wird eine Zusammenfassung~-- identisch zu den \KOMAScript"=Klassen~-- in einer
+\Environment{quotation}(\Package{koma-script})'none'"=Umgebung ausgegeben,
+wobei die Überschrift \emph{nicht} in der Form einer Gliederungsebene gesetzt
+wird. Diese Umgebung hat jedoch den Nachteil, dass die \KOMAScript-Option
+\Option{parskip=\PName{Methode}}(\Package{koma-script})'none' nicht beachtet
+wird. Um dies zu beheben, kann das Paket \Package{quoting} geladen werden,
+wodurch stattdessen die Umgebung \Environment{quoting}(\Package{quoting})'none'
+verwendet wird.
Mit der zuvor erläuterten Option \Option{abstract} kann eingestellt werden, in
welcher Gestalt die Zusammenfassung ausgegeben werden soll. Des Weiteren lässt
@@ -2232,56 +2672,61 @@ bestimmte \Environment{abstract}"=Umgebung die globalen Einstellungen
der Option \Option{abstract} lokal ändern und gezielt anpassen.
Wird das Paket \Package{babel} durch den Anwender geladen, kann mit dem
-optionalen Parameter \Key{\Environment{abstract}}{language}[\PName{Sprache}]
-die Sprache innerhalb der \Environment{abstract}"=Umgebung geändert werden.
-Dafür muss die gewünschte Sprache bereits mit dem Laden von \Package{babel}
-entweder als Paketoption oder besser noch als Klassenoption angegeben worden
-sein. Dadurch werden innerhalb der Umgebung die Bezeichnung \Term{abstractname}
-und die Trennungsmuster sprachspezifisch angepasst. Die gewünschte Sprache kann
+optionalen Parameter \Key{\Environment{abstract}}{language=\PName{Sprache}}die
+Sprache innerhalb der \Environment{abstract}"=Umgebung geändert werden. Dafür
+muss die gewünschte Sprache bereits mit dem Laden von \Package{babel} entweder
+als Paketoption oder besser noch als Klassenoption angegeben worden sein.
+Dadurch werden innerhalb der Umgebung die Bezeichnung \Term{abstractname} und
+die Trennungsmuster sprachspezifisch angepasst. Die gewünschte Sprache kann
auch ohne die Verwendung des Parameters \Key{\Environment{abstract}}{language}
direkt als optionales Argument übergeben werden.
\ChangedAt{v2.02}
Mit \Key{\Environment{abstract}}{markboth} können die gesetzten Kolumnentitel
-beeinflusst werden. Wird \Key{\Environment{abstract}}{markboth}[false]
+beeinflusst werden. Wird \Key{\Environment{abstract}}{markboth=false}
angegeben, werden automatische respektive manuelle Kolumnentitel verwendet. Die
-Einstellung \Key{\Environment{abstract}}{markboth}[true] wiederum setzt diese
-für linke und rechte Seiten auf \Term{abstractname}. Außerdem lässt sich der
-Kolumnentitel mit \Key{\Environment{abstract}}{markboth}[\PName{Kolumnentitel}]
-auch direkt festlegen. So können die Kolumnen beispielsweise mit der Verwendung
-von \Key{\Environment{abstract}}{markboth}[\PParameter{}] auch gelöscht werden.
-Sollte \Key{\Environment{abstract}}{markboth} aktiviert werden, so wird in der
-Umgebung automatisch der Seitenstil \PageStyle{headings} genutzt~-- falls eine
-Titelseite und kein Titelkopf (\Option{titlepage}[true]) verwendet wird. Mit
-dem Parameter \Key{\Environment{abstract}}{pagestyle} kann dieser auch manuell
-angegeben werden, wobei die \PageStyle{tudheadings}"=Seitenstile ebenfalls
-unterstützt werden.
+Einstellung \Key{\Environment{abstract}}{markboth=true} wiederum setzt diese
+für linke und rechte Seiten auf \Term{abstractname}. Zusätzlich lässt sich mit
+\Key{\Environment{abstract}}{markboth=\PValueName{Kolumnentitel}} der
+Kolumnentitel direkt festlegen. So können die Kolumnen beispielsweise mit der
+Verwendung von \Key{\Environment{abstract}}{markboth=\PParameter{}} auch
+gelöscht werden. Sollte \Key{\Environment{abstract}}{markboth} aktiviert
+werden, so wird in der Umgebung automatisch der Seitenstil \PageStyle{headings}
+genutzt~-- falls eine Titelseite
+(\KOMAScript-Option \Option{titlepage=true}(\Package{koma-script})'none')
+verwendet wird. Mit dem Parameter \Key{\Environment{abstract}}{pagestyle} kann
+dieser auch manuell angegeben werden, die \PageStyle{tudheadings}"=Seitenstile
+werden dabei ebenfalls unterstützt werden.
Wurde das Paket \Package{multicol} geladen, kann mit dem Parameter
-\Key{\Environment{abstract}}{columns}[\PName{Anzahl}] die Zusammenfassung
+\Key{\Environment{abstract}}{columns=\PName{Anzahl}} die Zusammenfassung
mehrspaltig gesetzt werden. Dem Parameter \Key{\Environment{abstract}}{option}
können alle gültigen, bereits erläuterten Werte der Option \Option{abstract}
übergeben werden. Die damit gemachten Einstellungen wirken sich~-- im Gegensatz
-zur Angabe als Klassenoption oder über die Variante der späten Optionenwahl%
+zur Variante der späten Optionenwahl%
\footnote{%
- \Macro{TUDoption}\PParameter{abstract}\Parameter{Einstellung} oder
- \Macro{TUDoptions}\PParameter{abstract=\PName{Einstellung}}
-}~-- lediglich lokal auf die verwendete \Environment{abstract}"=Umgebung aus.
+ \Macro{TUDoption}[\PParameter{abstract}\Parameter{Einstellung}] oder
+ \Macro{TUDoptions}[\PParameter{abstract=\PName{Einstellung}}]%
+}
+respektive als Angabe einer Klassenoption~-- lediglich lokal auf die verwendete
+\Environment{abstract}"=Umgebung aus.
\ChangedAt{v2.02}
-Sollen mehrere Zusammenfassungen im gleichen Stil erzeugt und die Einstellungen
-der Option \Option{abstract}[simple/multiple/fill/nofill] beachtet werden, so
+Sollen mehrere Zusammenfassungen erzeugt und dabei die Einstellungen
+\Option{abstract=single} beziehungsweise \Option{abstract=multiple} sowie
+\Option{abstract=fill} respektive \Option{abstract=nofill} beachtet werden, so
ist die \Environment{abstract}"=Umgebung nur einmal zu verwenden. Innerhalb
-dieser müssen die einzelnen Zusammenfassungen mit \Macro{nextabstract}
+dieser müssen die einzelnen Zusammenfassungen jeweils mit \Macro{nextabstract}
voneinander getrennt werden. Der Befehl akzeptiert dabei im optionalen Argument
-alle Parameter, die auch von der \Environment{abstract}"=Umgebung selbst
+alle Parameter, welche auch von der \Environment{abstract}"=Umgebung selbst
unterstützt werden. Das Minimalbeispiel in \fullref{sec:exmpl:dissertation}
zeigt hierfür das notwendige Vorgehen.
Wird die \Environment{abstract}"=Umgebung innerhalb des Argumentes der Befehle
-\Macro{setpartpreamble} beziehungsweise \Macro{setchapterpreamble} verwendet,
-so wird die Überschrift~-- im Fall, dass nicht \Option{abstract}[false] gewählt
-ist~-- \emph{immer} in Textgröße und zentriert gesetzt.
+\Macro{setpartpreamble}(\Package{koma-script})'none' beziehungsweise
+\Macro{setchapterpreamble}(\Package{koma-script})'none' verwendet, so wird die
+Überschrift~-- im Fall, dass nicht \Option{abstract=false} gewählt ist~--
+\emph{immer} in Textgröße und zentriert gesetzt.
\end{Declaration}
\end{Declaration}
\end{Declaration}
@@ -2291,33 +2736,35 @@ ist~-- \emph{immer} in Textgröße und zentriert gesetzt.
\end{Declaration}
\minisec{Umbenennung der \abstractname}
-Mit dem \KOMAScript-Befehl \Macro{renewcaptionname} kann der Bezeichner~--
-sprich der Wortlaut~-- der für die \Environment{abstract}-Umgebung verwendeten
-Überschrift verändert werden. Mehr dazu ist in \autoref{sec:localization} zu
-finden.
+Mit dem \KOMAScript-Befehl \Macro{renewcaptionname}(\Package{koma-script})'none'
+kann der Bezeichner~-- sprich der Wortlaut~-- der für die
+\Environment{abstract}"=Umgebung verwendeten Überschrift verändert werden. Mehr
+dazu ist in \autoref{sec:localization} zu finden.
%
\begin{Example}
-Die Überschrift der \Environment{abstract}-Umgebung soll für die Sprache
+Die Überschrift der \Environment{abstract}"=Umgebung soll für die Sprache
\PValue{ngerman} von \enquote{\abstractname} in \enquote{Kurzfassung} umbenannt
-werden. Der Befehl \Macro{renewcaptionname} erwartet die drei obligatorischen
-Argumente \Parameter{Sprache}\Parameter{Makro}\Parameter{Inhalt}:
+werden. Das Makro \Macro{renewcaptionname}(\Package{koma-script})'none'
+erwartet die drei obligatorischen Argumente
+\Parameter{Sprache}\Parameter{Makro}\Parameter{Inhalt}:
\begin{Code}[escapechar=§]
\renewcaptionname{ngerman}{\abstractname}{Kurzfassung}
\end{Code}
-\end{Example}
-%
\index{Zusammenfassung|!)}%
+\end{Example}
\subsection{Selbstständigkeitserklärung und Sperrvermerk}
+\index{Selbstständigkeitserklärung|!(}%
+\index{Sperrvermerk|!(}%
+%
\begin{Declaration}[%
- v2.02!Wert \PValue{double} mit \PValue{multi} ersetzt,%
- v2.02!Wert \PValue{tocleveldown} neu,%
- v2.02!Wert \PValue{markboth} neu,%
- v2.04!Wert \PValue{tocmultiple} neu%
-]{\Option{declaration}[\PSet]}[true]%
+ v2.02!\Option{declaration=multiple}:ersetzt \Option{declaration=double};%
+ v2.02!\Option{declaration=tocleveldown};%
+ v2.02!\Option{declaration=markboth};%
+ v2.04!\Option{declaration=tocmultiple}%
+]{\Option{declaration=\PSet}}[true]%
\printdeclarationlist%
-\index{Selbstständigkeitserklärung|!}\index{Sperrvermerk|!}%
%
Mit \Option{declaration} kann äquivalent zur Option \Option{abstract} die
Gestaltung von Selbstständigkeitserklärung und Sperrvermerk angepasst werden.
@@ -2332,12 +2779,12 @@ geschieht dies hier in einer etwas kürzeren Ausführung. Sollte Ihnen eine
Erläuterung etwas dürftig erscheinen, so hilft mit Sicherheit ein Blick zur
Erklärung der Option \Option{abstract}'full'.
-Die möglichen Werte für die Gestaltung der Überschrift werden nachfolgend
-genannt. Im Gegensatz zur Option \Option{abstract} stehen die Einstellungen
-\Option{declaration}[true/false] auch für die Klasse \Class{tudscrbook} zur
-Verfügung.
+Die möglichen Werte für die Gestaltung der Überschrift werden folgend genannt.
+Im Gegensatz zur Option \Option{abstract} stehen die Einstellungen
+\Option{declaration=true} und \Option{declaration=false} auch für die Klasse
+\Class{tudscrbook} zur Verfügung.
%
-\begin{values}
+\begin{values}{\Option{declaration}}
\itemfalse
Es wird keine Überschrift über den Erklärungen selbst ausgegeben.
\itemtrue*
@@ -2345,33 +2792,34 @@ Verfügung.
der Selbstständigkeitserklärung beziehungsweise \Term{blockingname} vor dem
Sperrvermerk wird gesetzt.
\item[section/addsec]
- Die Überschrift verwendet den Gliederungsbefehl \Macro{section}.
-\item[chapter/addchap][%
- (Säumniswert für \Class{tudscrbook})
- nur für \Class{tudscrreprt} und \Class{tudscrbook} verfügbar%
- ]
- Es wird der Befehl \Macro{chapter} für das Setzen der Überschrift genutzt.
+ Die Überschrift verwendet den Gliederungsbefehl
+ \Macro{section}(\Package{koma-script})'none'.
+\item[chapter/addchap][\Class{tudscrbook}](%
+ nur \Class{tudscrreprt} und \Class{tudscrbook}%
+ )
+ Es wird der Befehl \Macro{chapter}(\Package{koma-script})'none' für das
+ Setzen der Überschrift genutzt.
\item[heading]
Es wird die höchstmögliche Gliederungsebene verwendet. Für
- \Class{tudscrartcl} entspricht dies \Option{declaration}[section], bei
- \Class{tudscrreprt} und \Class{tudscrbook} \Option{declaration}[chapter].
+ \Class{tudscrartcl} entspricht dies \Option{declaration=section}, bei
+ \Class{tudscrreprt} und \Class{tudscrbook} \Option{declaration=chapter}.
\end{values}
%
Abhängig von der gewählten Gliederungsebene der Überschrift wird das Verhalten
für das Setzen eines Eintrages ins Inhaltsverzeichnis festgelegt. Normalerweise
wird nur für Überschriften in Form einer Gliederungsebene ein Eintrag der
-Erklärung ins Inhaltsverzeichnis erstellt, für \Option{declaration}[true/false]
-geschieht dies standardmäßig nicht. Das voreingestellte Verhalten kann mit
-folgenden Werten überschrieben werden.
+Erklärung ins Inhaltsverzeichnis erstellt, für \Option{declaration=true} und
+\Option{declaration=false} geschieht dies standardmäßig nicht. Mit folgenden
+Werten kann das voreingestellte Verhalten überschrieben werden.
%
-\begin{values}
+\begin{values}{\Option{declaration}}
\item[notoc/nottotoc]
Die Erklärung wird definitiv nicht ins Inhaltsverzeichnis eingetragen.
\item[toc/totoc]
Unabhängig von der Wahl der Überschrift erhält jede Erklärung einen nicht
- nummerierten Eintrag im Inhaltsverzeichnis auf der obersten Gliederungsebene
+ nummerierten Eintrag im Inhaltsverzeichnis auf der obersten Gliederungsebene
der aktuell gerade verwendeten Dokumentklasse.
-\item[leveldown/tocleveldown/totocleveldown]
+\item[tocleveldown/leveldown/totocleveldown]
\ChangedAt{v2.02}
Der Inhaltsverzeichniseintrag wird eine Gliederungsebene unterhalb der
obersten erzeugt.
@@ -2383,13 +2831,14 @@ folgenden Werten überschrieben werden.
%
\ChangedAt{v2.02}
Normalerweise werden die automatischen Kolumnentitel in Abhängigkeit von der
-Gliederungsebene der Überschrift gesetzt, falls diese denn aktiviert sind
-(\Option{automark}). Werden manuelle Kolumnentitel genutzt, müssen diese auch
-für die Erklärungen manuell gesetzt werden. Mit \Option{declaration}[markboth]
-lässt sich außerdem das Setzen der Kolumnentitel auf linken und rechten Seiten
-forcieren, wobei hierfür der Titel der Überschrift genutzt wird.
-%
-\begin{values}
+Gliederungsebene der Überschrift gesetzt, falls diese denn aktiviert sind über
+die \KOMAScript-Option \Option{automark}(\Package{scrlayer-scrpage})'none'.
+Werden manuelle Kolumnentitel genutzt, müssen diese auch für die Erklärungen
+manuell gesetzt werden. Mit \Option{declaration=markboth} lässt sich unabhängig
+davon das Setzen der Kolumnentitel auf linken und rechten Seiten forcieren,
+wobei hierfür der Titel der Überschrift genutzt wird.
+%
+\begin{values}{\Option{declaration}}
\item[markboth]
Unabhängig von der Verwendung manueller oder automatischer Kolumnentitel
werden diese auf rechten sowie linken Seiten mit den Bezeichnern
@@ -2399,15 +2848,16 @@ forcieren, wobei hierfür der Titel der Überschrift genutzt wird.
\end{values}
%
Für \Macro{declaration} respektive \Macro{confirmation} und \Macro{blocking}
-sowie die \Environment{declaration}"=Umgebung lässt sich mit dem Parameter
-\Key{\Environment{declaration}}{markboth} ein beliebiger Kolumnentitel setzen.
+sowie die \Environment{declarations}"=Umgebung lässt sich mit dem Parameter
+\Key{\Environment{declarations}}{markboth} ein beliebiger Kolumnentitel setzen.
Die folgenden Einstellungen zur Positionierung der Erklärungen haben lediglich
Auswirkungen, wenn die Überschrift der Erklärung \emph{nicht} im Form eines
-Kapitels ausgegeben und eine Titelseite (\Option{titlepage}[true]) verwendet
+Kapitels ausgegeben und mit der \KOMAScript-Option
+\Option{titlepage=true}(\Package{koma-script})'none' eine Titelseite verwendet
wird.
%
-\begin{values}
+\begin{values}{\Option{declaration}}
\item[single/one/simple]
Jede Erklärung wird auf einer separaten Seite
beziehungsweise im zweispaltigen Satz in einer neuen Spalte ausgegeben.
@@ -2417,48 +2867,51 @@ wird.
Befehlen \Macro{confirmation}, \Macro{blocking} und \Macro{declaration} oder
außerhalb dieser mit \Macro{declaration} gesetzt wurden, werden direkt
nacheinander auf der gleichen Seite ausgegeben, wenn ausreichend Platz auf
- dieser vorhanden sein sollte. Ist die Option \Option{twocolumn} aktiviert,
- erfolgt die Ausgabe aller Erklärungen ohne Spaltenumbruch.
-\item[fil/fill/vfil/vfill]
+ dieser vorhanden sein sollte. Ist die Klassenoption
+ \Option{twocolumn}(\Package{typearea})'none' aktiviert, erfolgt die Ausgabe
+ aller Erklärungen ohne Spaltenumbruch.
+\item[fill/fil/vfil/vfill]
Alle Erklärungen auf einer Ausgabeseite werden vertikal zentriert. Für
- den zweispaltigen Satz mit \Option{twocolumn} steht diese Einstellung nicht
- zur Verfügung.
-\item[nofil/nofill/novfil/novfill]
+ den zweispaltigen Satz
+ (Klassenoption \Option{twocolumn}(\Package{typearea})'none') steht diese
+ Einstellung nicht zur Verfügung.
+\item[nofill/nofil/novfil/novfill]
Die Ausgabe erfolgt wie im normalen Fließtext auch.
\end{values}
\end{Declaration}
-\begin{Declaration}[v2.02]{\Environment{declarations}[\OLParameter{Sprache}]}
-\begin{Declaration}[v2.04]{%
- \Macro{nextdeclaration}%
- \OLParameter{Sprache}\Parameter{Überschrift}\Parameter{Erklärung}
-}
-\begin{Declaration}{\Key{\Environment{declarations}}{language}[\PName{Sprache}]}
-\begin{Declaration}[v2.02]{%
- \Key{\Environment{declarations}}{markboth}[\PBName{Kolumnentitel}]%
+\begin{Declaration}[%
+ v2.02;%
+ v2.04:Trennung einzelner Abschnitte mit \Macro{nextdeclaration};%
+]{\Environment{declarations}[\OLParameter{Sprache}]}
+\begin{Declaration}{%
+ \Macro{nextdeclaration}[%
+ \OLParameter{Sprache}\Parameter{Überschrift}\Parameter{Erklärung}%
+ ]%
}
-\begin{Declaration}[v2.02]{%
- \Key{\Environment{declarations}}{pagestyle}[\PName{Seitenstil}]%
+\begin{Declaration}{\Key{\Environment{declarations}}{language=\PName{Sprache}}}
+\begin{Declaration}{\Key{\Environment{declarations}}{markboth=\PSet}}
+\begin{Declaration}{%
+ \Key{\Environment{declarations}}{pagestyle=\PName{Seitenstil}}%
}
-\begin{Declaration}[v2.02]{%
- \Key{\Environment{declarations}}{columns}[\PName{Anzahl}]%
+\begin{Declaration}{%
+ \Key{\Environment{declarations}}{columns=\PName{Anzahl}}%
}
-\begin{Declaration}{\Key{\Environment{declarations}}{option}[\PSet]}
+\begin{Declaration}{\Key{\Environment{declarations}}{option=\PSet}}
\begin{Declaration}{%
- \Key{\Environment{declarations}}{supporter}[\PName{Unterstützer}]
+ \Key{\Environment{declarations}}{supporter=\PName{Unterstützer}}
}
-\begin{Declaration}{\Key{\Environment{declarations}}{place}[\PName{Ort}]}
-\begin{Declaration}{\Key{\Environment{declarations}}{closing}[\PName{Ende}]}
-\begin{Declaration}{\Key{\Environment{declarations}}{company}[\PName{Firma}]}
+\begin{Declaration}{\Key{\Environment{declarations}}{place=\PName{Ort}}}
+\begin{Declaration}{\Key{\Environment{declarations}}{closing=\PName{Ende}}}
+\begin{Declaration}{\Key{\Environment{declarations}}{company=\PName{Firma}}}
\printdeclarationlist%
-\index{Selbstständigkeitserklärung}\index{Sperrvermerk}%
%
-Für Selbstständigkeitserklärung und Sperrvermerk sollten im einfachsten Fall
-die Befehle \Macro{declaration} beziehungsweise \Macro{confirmation} und
-\Macro{blocking} verwendet werden. Sobald diese jedoch in anderer Reihenfolge,
-mehrfacher Ausführung, unterschiedlichen Sprachen oder durch zusätzliche
-Erklärungen ergänzt werden, so bietet die \Environment{declarations}-Umgebung
-die notwendigen Freiheiten.
+Für Selbstständigkeitserklärung und Sperrvermerk sollte im einfachsten Fall
+\Macro{declaration} beziehungsweise \Macro{confirmation} und \Macro{blocking}
+verwendet werden. Sobald diese jedoch in anderer Reihenfolge, mehrfacher
+Ausführung, unterschiedlichen Sprachen oder durch zusätzliche Erklärungen
+ergänzt werden, so bietet die \Environment{declarations}"=Umgebung die
+notwendigen Freiheiten.
Innerhalb dieser Umgebung können Selbstständigkeitserklärung und Sperrvermerk
mit dem Befehl \Macro{declaration} direkt nacheinander folgend beziehungsweise
@@ -2474,35 +2927,37 @@ zweiten der Inhalt respektive Text der Erklärung selbst angegeben werden muss.
Die im Folgenden beschriebenen Parameter können sowohl für die Umgebung
\Environment{declarations} selbst als auch für die zuvor genannten Befehle als
optionales Argument verwendet werden. Ähnlich wie die gleichnamigen Optionen
-sind auch die Umgebungen \Environment{abstract} und \Environment{declaration}
+sind auch die Umgebungen \Environment{abstract} und \Environment{declarations}
sehr ähnlich zueinander. Deshalb werden die Erläuterungen relativ kurz
gehalten. Ist ein Erklärung für einen Parameter etwas unverständlich, kann
diese bei der Umgebung \Environment{abstract}'full' nachgelesen werden.
Wurde das Paket \Package{babel} geladen, kann die Sprache~-- sofern diese als
Paketoption oder besser noch als Klassenoption angegeben wurde~-- mit dem
-Parameter \Key{\Environment{declarations}}{language}[\PName{Sprache}] für die
+Parameter \Key{\Environment{declarations}}{language=\PName{Sprache}} für die
\Environment{declarations}"=Umgebung geändert werden. Dadurch werden die
Bezeichner~-- unter anderem \Term{confirmationname} und \Term{blockingname}~--
sowie die Trennungsmuster innerhalb der Umgebung sprachspezifisch angepasst.
\ChangedAt{v2.02}
Die Kolumnentitel können mit \Key{\Environment{declarations}}{markboth}
-beeinflusst werden. Mit \Key{\Environment{abstract}}{markboth}[true] werden
-für diese auf linker und rechter Seite \Term{confirmationname} respektive
-\Term{blockingname} verwendet. Außerdem kann der Anwender selbige mit
-\Key{\Environment{declarations}}{markboth}[\PName{Kolumnentitel}] auch direkt
-festlegen. Sollte \Key{\Environment{declarations}}{markboth} verwendet werden,
-wird der Seitenstil automatisch auf \PageStyle{headings} gesetzt. Mit dem
-Parameter \Key{\Environment{declarations}}{pagestyle} lässt sich dieser für die
-Umgebung auch manuell angegeben. Wurde das Paket \Package{multicol} geladen,
-wird mit \Key{\Environment{declarations}}{columns}[\PName{Anzahl}] der Inhalt
-der Umgebung mehrspaltig gesetzt. Für \Key{\Environment{declarations}}{option}
-können alle gültigen Werte der Option \Option{declaration} angegeben werden.
-Die Verwendung der Parameter \Key{\Macro{confirmation}}{supporter} sowie
+beeinflusst werden. Mit \Key{\Environment{declarations}}{markboth=true} werden
+für diese auf linker und rechter Seite \Term{confirmationname} beziehungsweise
+\Term{blockingname} verwendet. Automatische respektive manuelle Kolumnentitel
+werden mit \Key{\Environment{declarations}}{markboth=false} genutzt. Mit
+\Key{\Environment{declarations}}{markboth=\PValueName{Kolumnentitel}} können
+diese direkt festgelegt werden. Wird \Key{\Environment{declarations}}{markboth}
+in irgendeiner Form genutzt, wird der Seitenstil \PageStyle{headings}
+automatisch gesetzt. Dieser lässt sich für die Umgebung mit dem Parameter
+\Key{\Environment{declarations}}{pagestyle} auch manuell angegeben. Wurde das
+Paket \Package{multicol} geladen, wird der Inhalt der Umgebung mit
+\Key{\Environment{declarations}}{columns=\PName{Anzahl}} mehrspaltig gesetzt.
+Für \Key{\Environment{declarations}}{option} können alle gültigen Werte der
+Option \Option{declaration} angegeben werden. Die Verwendung der weiteren
+Parameter \Key{\Macro{confirmation}}{supporter} sowie
\Key{\Macro{confirmation}}{place} und \Key{\Macro{confirmation}}{closing} ist
in der Dokumentation des Befehls \Macro{confirmation} zu finden, der Parameter
-\Key{\Macro{blocking}}{company} ist für \Macro{blocking} erläutert.
+\Key{\Macro{blocking}}{company} ist für \Macro{blocking} erläutert.
\end{Declaration}
\end{Declaration}
\end{Declaration}
@@ -2515,23 +2970,22 @@ in der Dokumentation des Befehls \Macro{confirmation} zu finden, der Parameter
\end{Declaration}
\end{Declaration}
-\begin{Declaration}{\Macro{confirmation}\OLParameter{Unterstützer}}
-\begin{Declaration}{\Key{\Macro{confirmation}}{supporter}[\PName{Unterstützer}]}
-\begin{Declaration}{\Key{\Macro{confirmation}}{place}[\PName{Ort}]}
-\begin{Declaration}{\Key{\Macro{confirmation}}{closing}[\PName{Ende}]}
-\begin{Declaration}{\Key{\Macro{confirmation}}{language}[\PName{Sprache}]}
+\begin{Declaration}{\Macro{confirmation}[\OLParameter{Unterstützer}]}
+\begin{Declaration}[v2.05]{\Macro{confirmation*}[\LParameter]}
+\begin{Declaration}{\Key{\Macro{confirmation}}{supporter=\PName{Unterstützer}}}
+\begin{Declaration}{\Key{\Macro{confirmation}}{place=\PName{Ort}}}
+\begin{Declaration}{\Key{\Macro{confirmation}}{closing=\PName{Ende}}}
+\begin{Declaration}{\Key{\Macro{confirmation}}{language=\PName{Sprache}}}
+\begin{Declaration}[v2.02]{\Key{\Macro{confirmation}}{markboth=\PSet}}
\begin{Declaration}[v2.02]{%
- \Key{\Macro{confirmation}}{markboth}[\PBName{Kolumnentitel}]%
+ \Key{\Macro{confirmation}}{pagestyle=\PName{Seitenstil}}%
}
\begin{Declaration}[v2.02]{%
- \Key{\Macro{confirmation}}{pagestyle}[\PName{Seitenstil}]%
+ \Key{\Macro{confirmation}}{columns=\PName{Anzahl}}%
}
-\begin{Declaration}[v2.02]{%
- \Key{\Macro{confirmation}}{columns}[\PName{Anzahl}]%
-}
-\begin{Declaration}{\Key{\Macro{confirmation}}{option}[\PSet]}
+\begin{Declaration}{\Key{\Macro{confirmation}}{option=\PSet}}
\printdeclarationlist%
-\index{Selbstständigkeitserklärung}\index{Datum}%
+\index{Datum}%
%
Mit diesem Befehl wird ein sprachspezifischer Standardtext für eine
Selbstständigkeitserklärung ausgegeben, welcher in \Term{confirmationtext}
@@ -2544,19 +2998,23 @@ Wird \Term{confirmationtext} nicht geändert, kann dieser über das optionale
Argument von \Macro{confirmation} und die deklarierten Parameter angepasst
werden. Im Standardtext der Selbstständigkeitserklärung werden sowohl der Titel
als auch der Typ der Abschlussarbeit~-- falls dieser mit \Macro{thesis},
-\Macro{subject}\Parameter{\autoref{tab:thesis}} beziehungsweise mit der Option
-\Option{subjectthesis} angegeben wurde~-- aufgeführt. Über den Parameter
+\Macro{subject}[\Parameter{\autoref{tab:thesis}}] beziehungsweise mit der
+Option \Option{subjectthesis} angegeben wurde~-- aufgeführt. Über den Parameter
\Key{\Macro{confirmation}}{supporter} oder \emph{zuvor} mit dem Befehl
\Macro{supporter} können weitere an der Arbeit beteiligte Personen angegeben
werden. Mehrere zu nennende Personen sind auch hier durch \Macro{and} zu
trennen. Das Feld der Unterstützer kann auch mit dem bloßen optionalen Argument
-ohne die Angabe eines Parameters angepasst werden.
+ohne die Angabe eines Parameters angepasst werden.
+\ChangedAt{v2.05}
+Mit der Sternversion \Macro{confirmation*} werden als Unterstützer die mit
+\Macro{supervisor}[\Parameter{Name(n)}] definierten Betreuer der Arbeit
+angegeben.
Nach dem eigentlichen Text der Selbstständigkeitserklärung wird der mit
\Key{\Macro{confirmation}}{place} beziehungsweise \Macro{place} angegebene Ort
sowie das mit \Macro{date} eingestellte Datum ausgegeben. Als Voreinstellung
ist für den Ort \enquote{Dresden} gewählt. Danach folgen~-- mit etwas
-vertikalem Freiraum für die notwendige Unterschrift~-- der Autor oder die
+vertikalem Leerraum für die notwendige Unterschrift~-- der Autor oder die
Autoren, angegeben durch den Befehl \Macro{author}. Soll anstelle dessen etwas
anderes nach dem Text der Selbstständigkeitserklärung gesetzt werden, kann dies
mit dem Parameter \Key{\Macro{confirmation}}{closing} oder zuvor mit dem
@@ -2576,18 +3034,16 @@ der \Environment{declarations}"=Umgebung.
\end{Declaration}
\end{Declaration}
\end{Declaration}
+\end{Declaration}
-\begin{Declaration}[v2.02]{\Macro{blocking}\OLParameter{Firma}}
-\begin{Declaration}{\Key{\Macro{blocking}}{company}[\PName{Firma}]}
-\begin{Declaration}{\Key{\Macro{blocking}}{language}[\PName{Sprache}]}
-\begin{Declaration}[v2.02]{%
- \Key{\Macro{blocking}}{markboth}[\PBName{Kolumnentitel}]%
-}
-\begin{Declaration}[v2.02]{\Key{\Macro{blocking}}{pagestyle}[\PName{Seitenstil}]}
-\begin{Declaration}[v2.02]{\Key{\Macro{blocking}}{columns}[\PName{Anzahl}]}
-\begin{Declaration}{\Key{\Macro{blocking}}{option}[\PSet]}
+\begin{Declaration}[v2.02]{\Macro{blocking}[\OLParameter{Firma}]}
+\begin{Declaration}{\Key{\Macro{blocking}}{company=\PName{Firma}}}
+\begin{Declaration}{\Key{\Macro{blocking}}{language=\PName{Sprache}}}
+\begin{Declaration}{\Key{\Macro{blocking}}{markboth=\PSet}}
+\begin{Declaration}{\Key{\Macro{blocking}}{pagestyle=\PName{Seitenstil}}}
+\begin{Declaration}{\Key{\Macro{blocking}}{columns=\PName{Anzahl}}}
+\begin{Declaration}{\Key{\Macro{blocking}}{option=\PSet}}
\printdeclarationlist%
-\index{Sperrvermerk}%
%
Beim Sperrvermerk verhält es sich äquivalent zur Selbstständigkeitserklärung.
Es wird der in \Term{blockingtext} hinterlegte Standardtext in der gewählten
@@ -2599,9 +3055,9 @@ außerhalb direkt im Dokument verwendet werden.
In seiner ursprünglichen Definition, kann er im optionalen Argument über die
deklarierten Parameter angepasst werden. Im Standardtext des Sperrvermerks
werden sowohl der Titel als auch der Typ der Abschlussarbeit~-- falls dieser
-mit \Macro{thesis}, \Macro{subject}\Parameter{\autoref{tab:thesis}} respektive
-mit der Option \Option{subjectthesis} angegeben wurde~-- aufgeführt. Mit
-\Key{\Macro{blocking}}{company} oder \emph{vorher} mit \Macro{company} kann
+mit \Macro{thesis}, \Macro{subject}[\Parameter{\autoref{tab:thesis}}]
+respektive mit der Option \Option{subjectthesis} angegeben wurde~-- aufgeführt.
+Mit \Key{\Macro{blocking}}{company} oder \emph{vorher} mit \Macro{company} kann
zusätzlich eine im Sperrvermerk zu nennende Firma oder ähnliches angegeben
werden. Dieses Feld kann auch direkt im optionalen Argument ohne die Verwendung
eines Parameters gesetzt werden. Die weiteren Parameter
@@ -2619,30 +3075,33 @@ der \Environment{declarations}"=Umgebung.
\end{Declaration}
\end{Declaration}
-\begin{Declaration}{\Macro{declaration}\LParameter}
-\begin{Declaration}{\Key{\Macro{declaration}}{language}[\PName{Sprache}]}
+\begin{Declaration}{\Macro{declaration}[\LParameter]}
+\begin{Declaration}[v2.05]{\Macro{declaration*}[\LParameter]}
+\begin{Declaration}{\Key{\Macro{declaration}}{language=\PName{Sprache}}}
+\begin{Declaration}[v2.02]{\Key{\Macro{declaration}}{markboth=\PSet}}
\begin{Declaration}[v2.02]{%
- \Key{\Macro{declaration}}{markboth}[\PBName{Kolumnentitel}]%
+ \Key{\Macro{declaration}}{pagestyle=\PName{Seitenstil}}%
}
-\begin{Declaration}[v2.02]{%
- \Key{\Macro{declaration}}{pagestyle}[\PName{Seitenstil}]%
-}
-\begin{Declaration}[v2.02]{\Key{\Macro{declaration}}{columns}[\PName{Anzahl}]}
-\begin{Declaration}{\Key{\Macro{declaration}}{option}[\PSet]}
-\begin{Declaration}{\Key{\Macro{declaration}}{supporter}[\PName{Unterstützer}]}
-\begin{Declaration}{\Key{\Macro{declaration}}{place}[\PName{Ort}]}
-\begin{Declaration}{\Key{\Macro{declaration}}{closing}[\PName{Ende}]}
-\begin{Declaration}{\Key{\Macro{declaration}}{company}[\PName{Firma}]}
+\begin{Declaration}[v2.02]{\Key{\Macro{declaration}}{columns=\PName{Anzahl}}}
+\begin{Declaration}{\Key{\Macro{declaration}}{option=\PSet}}
+\begin{Declaration}{\Key{\Macro{declaration}}{supporter=\PName{Unterstützer}}}
+\begin{Declaration}{\Key{\Macro{declaration}}{place=\PName{Ort}}}
+\begin{Declaration}{\Key{\Macro{declaration}}{closing=\PName{Ende}}}
+\begin{Declaration}{\Key{\Macro{declaration}}{company=\PName{Firma}}}
\printdeclarationlist%
-\index{Selbstständigkeitserklärung}\index{Sperrvermerk}%
%
Dieser Befehl gibt die Selbstständigkeitserklärung und den Sperrvermerk direkt
aufeinanderfolgend aus. Dabei werden die Einstellungen zur Positionierung der
-einzelnen Erklärungen, welche über die Wertzuweisungen an die Option
-\Option{declaration}[simple/multiple/fill/nofill] erfolgen, beachtet. Er kann
-sowohl innerhalb der \Environment{declarations}"=Umgebung als auch außerhalb
+einzelnen Erklärungen, welche über die Zuweisungen \Option{declaration=single}
+beziehungsweise \Option{declaration=multiple} sowie \Option{declaration=fill}
+respektive \Option{declaration=nofill} erfolgen, beachtet. Er kann sowohl
+innerhalb der \Environment{declarations}"=Umgebung als auch außerhalb dieser
direkt im Dokument verwendet werden und akzeptiert im optionalen Argument dabei
-alle für die \Environment{declarations}"=Umgebung beschriebenen Parameter.
+alle für die \Environment{declarations}"=Umgebung beschriebenen Parameter.
+\ChangedAt{v2.05}
+Die Sternversion erzwingt für die Selbstständigkeitserklärung eine Angabe der
+mit \Macro{supervisor}[\Parameter{Name(n)}] definierten Betreuer in dieser.
+\end{Declaration}
\end{Declaration}
\end{Declaration}
\end{Declaration}
@@ -2654,65 +3113,86 @@ alle für die \Environment{declarations}"=Umgebung beschriebenen Parameter.
\end{Declaration}
\end{Declaration}
-\begin{Declaration}{\Macro{supporter}\Parameter{Unterstützer}}
-\begin{Declaration}{\Macro{place}\Parameter{Ort}}
-\begin{Declaration}{\Macro{confirmationclosing}\Parameter{Ende}}
-\begin{Declaration}{\Macro{company}\Parameter{Firma}}
+\begin{Declaration}{\Macro{supporter}[\Parameter{Unterstützer}]}
+\begin{Declaration}{\Macro{place}[\Parameter{Ort}]}
+\begin{Declaration}{\Macro{confirmationclosing}[\Parameter{Ende}]}
+\begin{Declaration}{\Macro{company}[\Parameter{Firma}]}
\printdeclarationlist%
-\index{Selbstständigkeitserklärung}\index{Sperrvermerk}%
%
-Diese Makros ändern~-- im Gegensatz zu den Parametern der bereits vorgestellten
-Befehle \Macro{confirmation} und \Macro{blocking}~-- die entsprechenden
-Feldwerte für das gesamte Dokument. Genutzt werden kann dies beispielsweise
-wenn ein Erklärungstyp in unterschiedlichen Sprachen ausgegeben wird. Hiermit
-kann man sich die mehrfache Angabe eines Parameters sparen.
+Diese Makros ändern
+\ToDo[doc]{wieder rein}[v2.06]
+%~-- im Gegensatz zu den Parametern der bereits vorgestellten
+%Befehle \Macro{confirmation} und \Macro{blocking}~--%
+die entsprechenden Feldwerte global für das gesamte Dokument.
+Damit lässt sich die \emph{mehrfache} Angabe eines Parameters vermeiden%
+%, wenn beispielsweise ein Erklärung in unterschiedlichen Sprachen erzeugt wird
+.
+\index{Selbstständigkeitserklärung|!)}%
+\index{Sperrvermerk|!)}%
\end{Declaration}
\end{Declaration}
\end{Declaration}
\end{Declaration}
-
-\subsection{Fußnoten in Überschriften}
-\begin{Declaration}[%
- v2.02!Fußnoten in Überschriften können mit Symbolen gesetzt werden%
-]{\Option{footnotes}[\PSet]}[nosymbolheadings]%
-\begin{Declaration}[v2.02]{\Counter{symbolheadings}}%
-\printdeclarationlist%
-\index{Überschriften}\index{Überschriften!Fußnoten}\index{Fußnoten}%
-%
-Für die Überschriften wird die \KOMAScript-Option \Option{footnotes} erweitert.
-Normalerweise kann diese die Werte \PValue{multiple} und \PValue{nomultiple}
-annehmen, wobei Letzteres der Standardfall ist. Die \TUDScript-Hauptklassen
-erweitern die Option dahingehend, dass auf die Verwendung von Symbolen anstelle
-von Zahlen innerhalb der Überschriften umgeschaltet werden kann. Hierfür wird
-der Zähler \Counter{symbolheadings} definiert, der mit dem Beginn eines neuen
-Kapitels zurückgesetzt wird.
-%
-\begin{values}
-\item[nosymbolheadings/numberheadings]
- Die Fußnoten der Überschriften werden fortlaufend mit denen des Fließtextes
- gesetzt.
-\item[symbolheadings]
- Für die Überschriften werden symbolische Fußnoten mit einem eigenen Zähler
- verwendet.
-\end{values}
-\end{Declaration}
-\end{Declaration}
+\ToDo[doc]{Wieder rein, falls vernünftig implementiert}[v2.06]
+%\subsection{Fußnoten in Überschriften}
+%\index{Layout!Überschriften}%
+%\index{Fußnoten}%
+%%
+%\begin{Declaration}[%
+% v2.02:Fußnoten mit Symbolen in Überschriften möglich%
+%]{\Option{footnotes=\PSet}}[nosymbolheadings]%
+%\begin{Declaration}[v2.02]{\Counter{symbolheadings}}%
+%\printdeclarationlist%
+%%
+%\ToDo[imp]{Fehler \Macro*{addchap} beheben, Paket \Package*{footmisc}}[v2.06]
+%\ToDo[imp]{Zähler auch bei Sternversionen von Kapiteln zurücksetzen}[v2.06]
+%\ToDo[imp]{Fußnoten nicht ins Inhaltsverzeichnis und in die Kopfzeile?!}[v2.06]
+%\ToDo[imp]{Problem mit \Package*{hyperref} lösbar?}[v2.06]
+%%
+%Für die Überschriften wird die \KOMAScript-Option \Option{footnotes} erweitert.
+%Normalerweise kann diese die Werte \PValue{multiple} und \PValue{nomultiple}
+%annehmen, wobei Letzteres der Standardfall ist. Die \TUDScript-Hauptklassen
+%erweitern die Option dahingehend, dass auf die Verwendung von Symbolen anstelle
+%von Zahlen innerhalb der Überschriften umgeschaltet werden kann. Hierfür wird
+%der Zähler \Counter{symbolheadings} definiert, der mit dem Beginn eines neuen
+%Kapitels zurückgesetzt wird.
+%
+%\Attention{%
+% Die Option \Option{footnotes=symbolheadings} ist experimentell und kann unter
+% Umständen zu Fehlern respektive unerwünschten Ergebnissen führen.%
+%}
+%%
+%\begin{values}{\Option{footnotes}}
+%\item[nosymbolheadings/numberheadings]
+% Die Fußnoten der Überschriften werden fortlaufend mit denen des Fließtextes
+% gesetzt.
+%\item[symbolheadings]
+% Für die Überschriften werden symbolische Fußnoten mit einem eigenen Zähler
+% verwendet.
+%\end{values}
+%\end{Declaration}
+%\end{Declaration}
\subsection{Lesezeichen}
-\begin{Declaration}{\Option{tudbookmarks}[\PBoolean]}[true]%
-\printdeclarationlist%
\index{Lesezeichen}%
-\index{Titel}\index{Umschlagseite}\index{Inhaltsverzeichnis}%
-\index{Aufgabenstellung}\index{Gutachten}\index{Aushang}%
+%
+\begin{Declaration}{\Option{tudbookmarks=\PBoolean}}[true]%
+\printdeclarationlist%
+\index{Titel}%
+\index{Umschlagseite}%
+\index{Inhaltsverzeichnis}%
+\index{Aufgabenstellung}%
+\index{Gutachten}%
+\index{Aushang}%
%
Diese Option wird wirksam, wenn \Package{hyperref} geladen wurde. Es werden für
die Umschlag- und Titelseite, das Inhaltsverzeichnis sowie~-- bei der
Verwendung des Paketes \Package{tudscrsupervisor}~-- die Aufgabenstellung
Lesezeichen oder auch Outline"=Einträge im PDF-Dokument erzeugt.
%
-\begin{values}
+\begin{values}{\Option{tudbookmarks}}
\itemfalse
Es erfolgt kein Eintrag von ergänzenden Lesezeichen.
\itemtrue*
@@ -2721,58 +3201,69 @@ Lesezeichen oder auch Outline"=Einträge im PDF-Dokument erzeugt.
\end{Declaration}
\begin{Declaration}{%
- \Macro{tudbookmark}\OParameter{Ebene}\Parameter{Text}\Parameter{Ankername}%
+ \Macro{tudbookmark}[\OParameter{Ebene}\Parameter{Text}\Parameter{Ankername}]%
}%
\printdeclarationlist%
%
-Der Befehl \Macro{tudbookmark} arbeitet wie \Macro{pdfbookmark} aus
-\Package{hyperref} mit dem Unterschied, dass die Lesezeichen nur generiert
-werden, wenn die Option \Option{tudbookmarks} aktiviert ist.
+Der Befehl \Macro{tudbookmark} arbeitet prinzipiell in der gleichen Weise wie
+\Macro{pdfbookmark}(\Package{hyperref})'none' aus \Package{hyperref}. Die
+Lesezeichen werden jedoch lediglich bei aktivierte Option \Option{tudbookmarks}
+generiert.
\end{Declaration}
\section{Sprachabhängige Bezeichner}
-\label{sec:localization}
+\tudhyperdef*{sec:localization}%
\index{Bezeichner|!(}%
-%
-Durch \KOMAScript{} werden Befehle, mit denen sprachabhängige Bezeichner
-erzeugt oder geändert werden können, zur Verfügung gestellt. Diese werden durch
-\TUDScript genutzt, um lokalisierte Begriffe für die Sprachen Englisch und
-Deutsch bereitzustellen. Ein Großteil davon betrifft Bezeichnungen für Felder
-auf der Titelseite (\autoref{sec:title}). Hierfür wird
-\Macro{providecaptionname}\Parameter{Sprache}\Parameter{Makro}\Parameter{Inhalt}
+\index{Titel!Felder|(}%
+%
+Durch \KOMAScript{} werden Befehle, mit denen sich sprachabhängige Bezeichner
+erzeugen oder ändern lassen, zur Verfügung gestellt. Diese werden durch
+\TUDScript genutzt, um lokalisierte Begriffe für die Sprachen \emph{Englisch}
+und \emph{Deutsch} bereitzustellen. Ein Großteil davon betrifft Bezeichnungen
+für Felder auf der Titelseite (\autoref{sec:title}). Hierfür wird
+\Macro{providecaptionname}[%
+ \Parameter{Sprache}\Parameter{Makro}\Parameter{Inhalt}%
+](\Package{koma-script})'none'
verwendet, wobei \PName{Sprache} dem geladenen Sprachpaket~-- normalerweise das
Paket \Package{babel}~-- bekannt sein muss.
Sollte der Anwender die im Folgenden erläuterten oder auch andere Bezeichner,
welche von einem beliebigen (Sprach"~)Paket bereitgestellt werden, ändern
wollen, ist hierfür der Befehl
-\Macro{renewcaptionname}\Parameter{Sprache}\Parameter{Makro}\Parameter{Inhalt}
+\Macro{renewcaptionname}[%
+ \Parameter{Sprache}\Parameter{Makro}\Parameter{Inhalt}%
+](\Package{koma-script})'none'
zu verwenden. Es sollte natürlich dabei eine \PName{Sprache} angegeben werden,
welche im Dokument durch \Package{babel} oder ein anderes Sprachpaket verwendet
wird, beispielsweise \PValue{ngerman} oder \PValue{english}.
Die Makros der Bezeichner und deren Verwendung werden folgend kurz beschrieben
und tabellarisch aufgeführt. Dabei wurde versucht, alle Befehle der Bezeichner
-für bestimmte Begriffe auf \PValue{\dots{}name} und beschreibende Texte auf
-\PValue{\dots{}text} enden zu lassen.
+für bestimmte Begriffe auf \Term*{\noexpand\dots{}name} und beschreibende
+Texte auf \Term*{\noexpand\dots{}text} enden zu lassen.
-\begin{Declaration}{\Term{supervisorname}}
-\begin{Declaration}{\Term{supervisorothername}}
\begin{Declaration}[%
- v2.02!Unterscheidung von einem und mehreren Gutachtern%
+ v2.02:Unterscheidung von einem und mehreren Gutachtern%
]{\Term{refereename}}
\begin{Declaration}{\Term{refereeothername}}
-\begin{Declaration}{\Term{advisorname}}
+\begin{Declaration}[%
+ v2.05:Unterscheidung von einem und mehreren Fachreferenten%
+]{\Term{advisorname}}
\begin{Declaration}{\Term{advisorothername}}
\begin{Declaration}[%
- v2.02!Unterscheidung von einem und mehreren Professoren%
+ v2.05:Unterscheidung von einem und mehreren Betreuern%
+]{\Term{supervisorname}}
+\begin{Declaration}{\Term{supervisorothername}}
+\begin{Declaration}[%
+ v2.02:Unterscheidung von einem und mehreren Professoren%
]{\Term{professorname}}
\begin{Declaration}[v2.02]{\Term{professorothername}}
\printdeclarationlist%
-\index{Titel}%
-\index{Betreuer}\index{Gutachter}\index{Hochschullehrer}%
+\index{Betreuer}%
+\index{Gutachter}%
+\index{Hochschullehrer}%
\index{Referent}%
%
Diese sprachabhängigen Begriffe sind die Bezeichner für die Titelseitenfelder
@@ -2780,20 +3271,28 @@ von Betreuer (\Macro{supervisor}), Gutachter (\Macro{referee}) und Fachreferent
(\Macro{advisor}). Soll innerhalb eines dieser Felder mehr als eine Person
angegeben werden, so sind die Einzelpersonen jeweils mit dem Befehl \Macro{and}
voneinander zu trennen. In diesem Fall werden alle nach der erstgenannten
-folgenden Personen durch den Bezeichner \PValue{\textbackslash\dots{}othername}
+folgenden Personen durch den Bezeichner \Term*{\noexpand\dots{}othername}
ergänzt.
-\ChangedAt{v2.02}
-Bei der Bezeichnung des Gutachters wird unterschieden, ob einer oder mehrere
-angegeben wurden. Wird lediglich einer genannt, so ist eine Unterscheidung
-nicht notwendig. Werden jedoch zwei Gutachter angegeben, so werden diese auch
-mit Erst- und Zweitgutachter betitelt. Für den betreuenden Hochschullehrer
-(\Macro{professor}) wird ähnlich verfahren. Hier wird allerdings lediglich
-die Bezeichnung vom Singular in den Plural gegebenenfalls automatisch geändert.
-
-
-\renewcaptionname{ngerman}{\refereename}{Gutachter/Erstgutachter}
-\renewcaptionname{english}{\refereename}{Referee/First referee}
+\ChangedAt{v2.02,v2.05}
+Bei den Bezeichnung wird unterschieden, ob eine oder mehrere Personen angegeben
+wurden. Wird lediglich eine Person genannt, so ist eine Unterscheidung nicht
+notwendig und es wird der Singular genutzt. Werden jedoch zwei oder mehr
+Personen angegeben, so wird geprüft, ob der dazugehörige Bezeichner für die
+Zweitperson (\Term*{\noexpand\dots{}othername}) definiert ist. Falls dies so
+ist, wird die alternative Bezeichnung für die erstgenannte Person verwendet,
+andernfalls wird der Plural des Bezeichners verwendet. Dies betrifft alle
+Felder, die über \Macro{referee}, \Macro{advisor}, \Macro{supervisor} oder
+\Macro{professor} angegeben wurden.
+
+\renewcaptionname{ngerman}{\refereename}{(Erst-)Gutachter}
+\renewcaptionname{english}{\refereename}{(First) Referee(s)}
+\renewcaptionname{ngerman}{\advisorname}{(Erster) Fachreferent(en)}
+\renewcaptionname{english}{\advisorname}{(First) Advisor(s)}
+\renewcaptionname{ngerman}{\supervisorname}{(Erst-)Betreuer}
+\renewcaptionname{english}{\supervisorname}{(First) Supervisors(s)}
+\renewcaptionname{ngerman}{\professorname}{Betreuende(r) Hochschullehrer}
+\renewcaptionname{english}{\professorname}{Supervising professor(s)}
\TermTable{%
supervisorname,supervisorothername,refereename,refereeothername,%
advisorname,advisorothername,professorname,professorothername%
@@ -2811,15 +3310,18 @@ die Bezeichnung vom Singular in den Plural gegebenenfalls automatisch geändert.
\begin{Declaration}{\Term{diplomathesisname}}
\begin{Declaration}{\Term{masterthesisname}}
\begin{Declaration}{\Term{bachelorthesisname}}
+\begin{Declaration}{\Term{studentthesisname}}
\begin{Declaration}{\Term{studentresearchname}}
\begin{Declaration}{\Term{projectpapername}}
\begin{Declaration}{\Term{seminarpapername}}
+\begin{Declaration}{\Term{termpapername}}
\begin{Declaration}{\Term{researchname}}
\begin{Declaration}{\Term{logname}}
\begin{Declaration}{\Term{internshipname}}
\begin{Declaration}{\Term{reportname}}
\printdeclarationlist%
-\index{Titel}\index{Abschlussarbeit}\index{Typisierung}%
+\index{Abschlussarbeit}%
+\index{Typisierung}%
%
Diese Bezeichner dienen zur Typisierung speziell für eine Abschlussarbeit. Wie
diese genutzt werden können, ist bei der Erläuterung von \Macro{thesis} und
@@ -2840,39 +3342,49 @@ diese genutzt werden können, ist bei der Erläuterung von \Macro{thesis} und
\end{Declaration}
\end{Declaration}
\end{Declaration}
+\end{Declaration}
+\end{Declaration}
\begin{Declaration}{\Term{dateofbirthtext}}
\begin{Declaration}{\Term{placeofbirthtext}}
\begin{Declaration}{\Term{matriculationnumbername}}
\begin{Declaration}{\Term{matriculationyearname}}
-\printdeclarationlist%
-\index{Titel}\index{Autorenangaben}\index{Datum!Geburtsdatum}%
-%
-Werden für den Autor oder die Autoren das Geburtsdatum (\Macro{dateofbirth}),
-der Geburtsort (\Macro{placeofbirth}) sowie die
-Matrikelnummer (\Macro{matriculationnumber}) und/oder das Immatrikulationsjahr
-(\Macro{matriculationyear}) angegeben, werden sowohl auf der Titelseite als
-auch auf der gegebenenfalls mit \Package{tudscrsupervisor} erstellten
-Aufgabenstellung die dazugehörigen Bezeichner vorangestellt. Auf dem Titel
-werden diese dabei mit dem durch \Macro{titledelimiter} gegebenen Trennzeichen
-vom eigentlichen Feld abgegrenzt.
+\begin{Declaration}{\Term{coursename}}
+\begin{Declaration}[v2.02]{\Term{disciplinename}}
+\printdeclarationlist%
+\index{Autorenangaben}%
+\index{Datum!Geburtsdatum}%
+%
+Werden für den Autor oder die Autoren mit dem entsprechenden Befehl das
+Geburtsdatum (\Macro{dateofbirth}), der Geburtsort (\Macro{placeofbirth}), der
+Studiengang (\Macro{course}), die Studienrichtung (\Macro{discipline}) oder
+auch die Matrikelnummer (\Macro{matriculationnumber}) und/oder das
+Immatrikulationsjahr (\Macro{matriculationyear}) angegeben, werden sowohl auf
+der Titelseite als auch auf der gegebenenfalls mit \Package{tudscrsupervisor}
+erstellten Aufgabenstellung die dazugehörigen Bezeichner vorangestellt. Auf dem
+Titel werden diese dabei mit dem durch \Macro{titledelimiter} gegebenen
+Trennzeichen vom eigentlichen Feld abgegrenzt.
\TermTable{%
dateofbirthtext,placeofbirthtext,matriculationnumbername,%
- matriculationyearname%
+ matriculationyearname,coursename,disciplinename%
}
\end{Declaration}
\end{Declaration}
\end{Declaration}
\end{Declaration}
+\end{Declaration}
+\end{Declaration}
\begin{Declaration}[v2.02]{\Term{graduationtext}}
\printdeclarationlist%
-\index{Titel}\index{Abschlussarbeit}\index{Typisierung}%
+\index{Abschlussarbeit}%
+\index{Typisierung}%
%
-Wurde erkannt, dass das Dokument eine Abschlussarbeit ist,%
+Wurde erkannt, dass das aktuelle Dokument eine Abschlussarbeit ist,%
\footnote{%
Entweder wurde \Macro{thesis} oder \Macro{subject} mit einem speziellen Wert
- oder der Option \Option{subjectthesis} verwendet.
+ (\seeref{\autoref{tab:thesis}}) oder zusammen mit der Option
+ \Option{subjectthesis} genutzt.\label{fn:thesis}%
}
so kann der zu erlangende akademische Grad mit dem Befehl \Macro{graduation}
angegeben werden. Bei dessen Ausgabe auf dem Titel wird dabei der entsprechende
@@ -2883,28 +3395,24 @@ Text dazu angegeben.
\begin{Declaration}{\Term{datetext}}
\begin{Declaration}{\Term{defensedatetext}}
\printdeclarationlist%
-\index{Titel}\index{Abschlussarbeit}%
-\index{Datum}\index{Datum!Verteidigungsdatum}%
+\index{Abschlussarbeit}%
+\index{Datum}%
+\index{Datum!Abgabedatum}%
+\index{Datum!Verteidigungsdatum}%
%
-Wird mit \Macro{date} das Datum und mit \Macro{defensedate} ein Datum der
-Verteidigung für eine Abschlussarbeit angegeben, so werden auch diese Felder
-durch einen einleitenden Text beschrieben.
+Wird mit \Macro{date} das (Abgabe-)Datum und mit \Macro{defensedate} ein Datum
+der Verteidigung für eine Abschlussarbeit\footref{fn:thesis} angegeben, so
+werden auch diese Felder durch einen Text beschrieben.
\TermTable{datetext,defensedatetext}
+\index{Titel!Felder|)}%
\end{Declaration}
\end{Declaration}
-\begin{Declaration}{\Term{abstractname}}
-\printdeclarationlist%
-%
-Dieser Bezeichner wird lediglich für \Class{tudscrbook} definiert, da dieser
-von \KOMAScript{} für die Buchklasse nicht vorgesehen wird.
-\TermTable{abstractname}
-\end{Declaration}
-
\begin{Declaration}{\Term{confirmationname}}
\begin{Declaration}[v2.02]{\Term{blockingname}}
\printdeclarationlist%
-\index{Selbstständigkeitserklärung}\index{Sperrvermerk}%
+\index{Selbstständigkeitserklärung|(}%
+\index{Sperrvermerk|(}%
%
Es werden die Bezeichnungen für Selbstständigkeitserklärung und Sperrvermerk
für die dazugehörigen Überschriften definiert.
@@ -2920,21 +3428,20 @@ Die Texte der Erklärungen selbst sind derart aufgebaut, dass sie in
Abhängigkeit von den angegebenen Informationen unterschiedlich ausgeführt
werden. Innerhalb der Selbstständigkeitserklärung (\Macro{confirmation}) werden
gegebenenfalls die Felder für den Titel (\Macro{title}) und die Typisierung der
-Abschlussarbeit%
+Abschlussarbeit\footref{fn:thesis} sowie die angegebenen Unterstützer%
\footnote{%
- entweder \Macro{thesis} oder \Macro{subject}\Parameter{\autoref{tab:thesis}}
- beziehungsweise Option \Option{subjectthesis}[true]
-}
-sowie die angegebenen Unterstützer%
-\footnote{%
- \Macro{confirmation}\POParameter{\Key{\Macro{confirmation}}{supporter}=\dots}
- oder \Macro{supporter}\PParameter{\dots}%
+ \Macro{confirmation}[\POParameter{%
+ \Key{\Macro{confirmation}}{supporter=\PName{Unterstützer}}%
+ }]
+ oder \Macro{supporter}[\Parameter{Unterstützer}]%
}
beachtet. Für den Sperrvermerk (\Macro{blocking}) wird neben dem Titel
(\Macro{title}) optional außerdem noch das Feld der externen Firma%
\footnote{%
- \Macro{blocking}\POParameter{\Key{\Macro{blocking}}{company}=\dots} oder
- \Macro{company}\PParameter{\dots}%
+ \Macro{blocking}[%
+ \POParameter{\Key{\Macro{blocking}}{company=\PName{Firma}}}%
+ ]
+ oder \Macro{company}[\Parameter{Firma}]%
}
verwendet. Der Vollständigkeit halber werden im Folgenden noch die Texte für
die Selbstständigkeitserklärung und den Sperrvermerk aufgeführt~-- allerdings
@@ -2948,23 +3455,54 @@ angezeigt.
\def\@supporter{\PName{Vorname Nachname} \and \PName{Vorname Nachname}}
\def\@company{\PName{Firma}}
\makeatother
- \vskip\baselineskipglue\noindent
- \textbf{Bezeichner}\quad\Term*{confirmationtext}%
+ \vskip\medskipamount\noindent
+ \textbf{Bezeichner}\quad\Term{confirmationtext}%
\begin{quoting}
\confirmationtext
\end{quoting}
- \textbf{Bezeichner}\quad\Term*{blockingtext}%
+ \textbf{Bezeichner}\quad\Term{blockingtext}%
\begin{quoting}
\blockingtext
\end{quoting}
+
+ \makeatletter
+ \def\@@author{\PName{Vorname Nachname}}%
+ \def\@supporter{\PName{Vorname Nachname}}%
+ \makeatother
+ \newcommand*\showfield[1]{%
+ \Macro*{csuse}[\PParameter{#1}]~\textrightarrow~\csuse{#1}%
+ }%
+ \noindent
+ Soll eine der Erklärungen geändert und dabei der Inhalt eines Feldes genutzt
+ werden, lässt sich über den Befehl \Macro*{csuse}[\PParameter{\dots}] aus dem
+ Paket \Package{etoolbox} auf die Felder zugreifen. Als Argument können dabei
+ \PValue{@@title}, \PValue{@@author}, \PValue{@@thesis}, \PValue{@supporter}
+ und \PValue{@company} verwendet werden.%
+ \footnote{%
+ Titel: \showfield{@@title}, Autor: \showfield{@@author}, Art der
+ Abschlussarbeit: \showfield{@@thesis}, Unterstützer: \showfield{@supporter}
+ und Firma: \showfield{@company}%
+ }
+ Gegebenenfalls ist zusätzlich die Definition von \Macro{and} anzupassen.
\endgroup
+\index{Selbstständigkeitserklärung|)}%
+\index{Sperrvermerk|)}%
\end{Declaration}
\end{Declaration}
+\begin{Declaration}{\Term{abstractname}}
+\printdeclarationlist%
+\index{Zusammenfassung}%
+%
+Dieser Bezeichner wird für die Klasse \Class{tudscrbook} definiert, da selbiger
+von \KOMAScript{} für die Buchklasse nicht vorgesehen wird.
+\TermTable{abstractname}
+\end{Declaration}
+
\begin{Declaration}{\Term{coverpagename}}
\begin{Declaration}{\Term{titlepagename}}
\printdeclarationlist%
-\index{Lesezeichen}\index{Titel}\index{Umschlagseite}%
+\index{Lesezeichen}%
%
Diese beiden Bezeichner werden bei aktivierter \Option{tudbookmarks} für das
Eintragen von Lesezeichen in ein PDF"=Dokument genutzt.
@@ -2980,9 +3518,9 @@ Sollte ein Paket zur Einbindung von externem Quelltext~-- beispielsweise
das Paket \Package{listings}~-- verwendet werden, so werden diese Bezeichnungen
für Quelltextausschnitte und das Quelltextverzeichnis verwendet.
\TermTable{listingname,listlistingname}
+\index{Bezeichner|!)}%
\end{Declaration}
\end{Declaration}
-\index{Bezeichner|!)}
\section{Kompatibilitätseinstellungen zu früheren Versionen}
Bei der Entwicklung von \TUDScript lässt es sich nicht immer vermeiden, dass
@@ -2991,9 +3529,7 @@ Ergebnis der Ausgabe führen, insbesondere bei Umbruch und Layout. Für bereits
archivierte Dokumente, welche mit einer früheren Version erstellt wurden ist
dies jedoch bei einer erneuten Kompilierung unter Umständen eher unerwünscht.
-\begin{Declaration}[v2.03]{\Option{tudscrver}[%
- \PName{Version}\textOR\PValue{first}\textOR\PValue{last}%
-]}[last]
+\begin{Declaration}[v2.03]{\Option{tudscrver=\PName{Version}}}[last]
\printdeclarationlist%
\index{Kompatibilität|!}%
%
@@ -3005,49 +3541,57 @@ verfügbar, dass per Option die Kompatibilität zu einer älteren Version
ausgewählt wurde.
Bei der Angabe einer unbekannten Version als Wert wird eine Warnung ausgegeben
-und \Option{tudscrver}[first] angenommen. Mit \Option{tudscrver}[last] wird die
+und \Option{tudscrver=first} angenommen. Mit \Option{tudscrver=last} wird die
jeweils aktuell verfügbare Version ausgewählt und folglich auf die zukünftige
Kompatibilität des Dokumentes zu der aktuell genutzten Version verzichtet.
Dieses Verhalten entspricht der Voreinstellung. Es ist zu beachten, dass die
Nutzung von \Option{tudscrver} nur als Klassenoption möglich ist.
%
-\begin{values}
-\item[\PValue{2.02}\textOR\PValue{first}]
+\begin{values}{\Option{tudscrver}}
+\item[\PValue{first}/\PValue{2.02}]
\ChangedAt{%
- v2.03!Satzspiegel im \CD geändert{,} das \protect\DDC-Logo im Fußbereich
+ v2.03:Satzspiegel im \CD geändert, Logo von \DDC im Fußbereich
wird ohne vergrößerten Seitenrand verwendet
}
- Der Satzspiegel im Layout des \CDs (\see*{\Option{cdgeometry}}) wurde in der
- Version~v2.03 leicht geändert. Der obere Seitenrand wurde verkleinert, der
- untere im gleichen Maße vergrößert. Der verfügbare Textbereich ist folglich
- identisch. Bei der Aktivierung des \DDC-Logos im Fußbereich der Seite
- (\see*{\Option{ddcfoot}}) wird im Gegensatz zur Version~v2.02 der gleiche
- Satzspiegel genutzt. Mit \Option{tudscrver}[2.02] kann dieses Verhalten
- deaktiviert werden.
+ Der Satzspiegel im Layout des \CDs (\seeref{\Option{cdgeometry}}) wurde in
+ der Version~v2.03 leicht geändert. Der obere Seitenrand wurde verkleinert,
+ der untere im gleichen Maße vergrößert. Der verfügbare Textbereich ist
+ folglich identisch. Bei der Aktivierung des \DDC-Logos im Fußbereich der
+ Seite (\seeref{\Option{ddcfoot}}) wird im Gegensatz zur Version~v2.02 der
+ gleiche Satzspiegel genutzt. Mit \Option{tudscrver=first} kann dieses
+ Verhalten deaktiviert werden.
\item[\PValue{2.03}]
- \ChangedAt{%
- v2.04!Werte bestimmter Längen abhängig von der verwendeten Schriftgröße%
- }\index{Schriftgröße}%
+ \index{Leerraum}%
+ \index{Schriftgröße}%
+ \ChangedAt{v2.04:Vertikaler Leerraum abhängig von verwendeter Schriftgröße}
Seit der Version~v2.04 werden mehrere Längen in Abhängigkeit der gewählten
- Schriftgröße (Option \Option{fontsize}) definiert. Dies betrifft sowohl die
- dehnbaren Längen \Length{smallskipamount}, \Length{medskipamount} und
- \Length{bigskipamount}, die von den Befehlen \Macro{smallskip},
- \Macro{medskip} sowie \Macro{bigskip} für das Einfügen vertikaler Abstände
- genutzt werden, als auch die beiden Längen \Length{abovecaptionskip} und
- \Length{belowcaptionskip} für den Abstand zwischen einem Gleitobjekt und
- dessen mit \Macro{caption} gesetzten Beschreibung sowie \Length{columnsep}
- als Maß für den Abstand der einzelnen Textspalten im zwei- oder mehrspaltigen
- Layout. Mit der Wahl \Option{tudscrver}[2.03] lässt sich diese Funktionalität
- deaktivieren.
+ Schriftgröße definiert. Mit der Wahl \Option{tudscrver=2.03} lässt sich diese
+ Funktionalität deaktivieren, wobei hierfür lediglich die \TUDScript-Option
+ \Option{relspacing=false} aufgerufen wird.
\item[\PValue{2.04}]
+ \index{Satzspiegel}%
+ \ChangedAt{%
+ v2.05:Einstellungen für den Satzspiegel für die jeweilige ISO/DIN-Klasse
+ des verwendeten Papierformates identisch%
+ }
+ Mit der Version~v2.05 werden die vorgegebenen Einstellungen zum Satzspiegel
+ anhand der B-ISO/DIN-Reihe vorgenommen. Damit sind für alle Papierformate
+ einer spezifischen ISO/DIN-Klasse die Seitenränder identisch. Mit der Wahl
+ \Option{tudscrver=2.04} ist der Satzspiegel von der A-ISO/DIN-Reihe
+ abhängig, sodass die B- und C-Papierformate der gleichen Klasse größere
+ Seitenränder erhalten, als die D- und A-Formate.
+\item[\PValue{2.05}]
Dies ist Kompatibilitätseinstellung für \TUDScript~\vTUDScript{} und wird für
zukünftige Änderungen bereits vorgehalten. Soll ein mit der momentan
aktuellen Version erzeugtes Dokument auch mit einer späteren Version von
- \TUDScript nach einem \hologo{LaTeX}-Lauf das gleiche Ausgabeergebnis
- liefern, muss dies mit \Option{tudscrver}[2.04] angegeben werden.
+ \TUDScript nach einem \hologo{LaTeX}"=Lauf das gleiche Ausgabeergebnis
+ liefern, muss dies mit \Option{tudscrver=2.05} angegeben werden.
\item[\PValue{last}]
Es werden keine Kompatibilitätseinstellungen für das Dokument vorgenommen.
Mit einer späteren Version von \TUDScript kann ein anderes Umbruchverhalten
innerhalb des Dokumentes auftreten. Dies ist die Standardeinstellung.
\end{values}
\end{Declaration}
+\end{Declaration*}
+\end{Declaration*}
+\end{Declaration*} \ No newline at end of file
diff --git a/Master/texmf-dist/source/latex/tudscr/doc/tudscr-obsolete.tex b/Master/texmf-dist/source/latex/tudscr/doc/tudscr-obsolete.tex
index c88cd1a4f51..0adc4f3e180 100644
--- a/Master/texmf-dist/source/latex/tudscr/doc/tudscr-obsolete.tex
+++ b/Master/texmf-dist/source/latex/tudscr/doc/tudscr-obsolete.tex
@@ -1,5 +1,5 @@
\chapter{Obsolete sowie vollständig entfernte Optionen und Befehle}
-\label{sec:obsolete}%
+\tudhyperdef*{sec:obsolete}%
%
\section{Veraltete Optionen und Befehle in \TUDScript}
Einige Optionen und Befehle waren während der Weiterentwicklung von \TUDScript
@@ -11,482 +11,452 @@ Funktionalität ohne größere Aufwände mit \TUDScript in der aktuellen Version
darauf hingewiesen.
-\subsection{Änderungen für \TUDScript~v2.00}
-\vskip-\lastskip
-\ChangedAt*{v2.00!Änderungen gegenüber der vorhergehenden Version}%
-\begin{Declaration}[v2.00]{\Option*{cd}[alternative]}
-\begin{Declaration}[v2.00]{\Option*{cdtitle}[alternative]}
-\begin{Declaration}[v2.00]{\Length{titlecolwidth}}
-\begin{Declaration}[v2.00]{\Term{authortext}}
-\printdeclarationlist*[\emph{entfällt}]%
-\index{Titel}%
+\ChangedAt*{v2.00:Änderungen gegenüber der vorhergehenden Version}%
+\subsection{Änderungen für \TUDScript~\NoCaseChange{v}2.00}
+\begin{Obsolete}{v2.00}[\Option{cd=\PSet}]{\Option{cd=alternative}}
+\begin{Obsolete}{v2.00}[\Option{cdtitle=\PSet}]{\Option{cdtitle=alternative}}
+\begin{Obsolete}{v2.00}{\Length{titlecolwidth}}
+\begin{Obsolete}{v2.00}{\Term{authortext}}
+\printobsoletelist%
%
Die alternative Titelseite ist komplett aus dem \TUDScript-Bundle entfernt
worden. Dementsprechend entfallen auch die dazugehörigen Optionen sowie Länge
und Bezeichner.
-\end{Declaration}
-\end{Declaration}
-\end{Declaration}
-\end{Declaration}
+\end{Obsolete}
+\end{Obsolete}
+\end{Obsolete}
+\end{Obsolete}
-\Replace{v2.00}{\Option{cd}}{\Option{color}}
-\begin{Declaration}[v2.00]{\Option{color}[\PBoolean]}
-\printdeclarationlist*[\see*{\Option*{cd}'page'}]%
+\begin{Obsolete}{v2.00:\Option{cd}}{\Option{color=\PBoolean}}
+\printobsoletelist%
%
Die Einstellungen der farbigen Ausprägung des Dokumentes erfolgt über die
Option \Option*{cd}.
-\end{Declaration}
+\end{Obsolete}
-\Replace{v2.00}{\Option{cdfont}}{\Option{tudfonts}}
-\begin{Declaration}[v2.00]{\Option{tudfonts}[\PBoolean]}
-\begin{Declaration}[v2.00]{\Option*{cdfonts}[\PBoolean]}
-\printdeclarationlist*[\see*{\Option*{cdfont}'page'}]%
+\begin{Obsolete}{v2.00:\Option{cdfont}}{\Option{tudfonts=\PBoolean}}
+\printobsoletelist%
%
Die Option zur Schrifteinstellung ist wesentlich erweitert worden. Aus Gründen
der Konsistenz wurde diese umbenannt.
-\end{Declaration}
-\end{Declaration}
+\end{Obsolete}
-\Replace{v2.00}{\Option{cdfoot}}{\Option{tudfoot}}
-\begin{Declaration}[v2.00]{\Option{tudfoot}[\PBoolean]}
-\printdeclarationlist*[\see*{\Option*{cdfoot}'page'}]%
+\begin{Obsolete}{v2.00:\Option{cdfoot}}{\Option{tudfoot=\PBoolean}}
+\printobsoletelist%
%
Ebenso wurde die Option \Option*{tudfoot} umbenannt, um dem Namensschema der
restlichen Optionen von \TUDScript zu entsprechen.
-\end{Declaration}
+\end{Obsolete}
-\begin{Declaration}[v2.00]{\Option{headfoot}[\PSet]}
-\printdeclarationlist*[\emph{entfällt},
- \KOMAScript-Optionen \Option*{headinclude} und \Option*{footinclude}%
-]%
+\begin{Obsolete}{v2.00}{\Option{headfoot=\PSet}}{%
+ \seeref{\KOMAScript-Optionen \Option*{headinclude} und \Option*{footinclude}}%
+}
+\printobsoletelist%
%
Diese Option war für \TUDScript in der Version~v1.0 notwendig, um die parallele
Verwendung der beiden Pakete \Package*{typearea} und \Package*{geometry} zu
ermöglichen. Die Erstellung des Satzspiegels wurde komplett überarbeitet.
Mittlerweile werden an das Paket \Package*{geometry} die Einstellungen für die
\KOMAScript"=Optionen \Option*{headinclude} und \Option*{footinclude} direkt
-weitergereicht, so dass die Option \Option*{headfoot} nicht mehr notwendig ist
+weitergereicht, sodass die Option \Option*{headfoot} nicht mehr notwendig ist
und deshalb entfernt wurde.
-\end{Declaration}
+\end{Obsolete}
-\Replace{v2.00}{\Option{cleardoublespecialpage}}{%
- \Option{partclear},\Option{chapterclear}%
+\begin{Obsolete}{v2.00:\Option{cleardoublespecialpage}}{%
+ \Option{partclear=\PBoolean}%
+}
+\begin{Obsolete}{v2.00:\Option{cleardoublespecialpage}}{%
+ \Option{chapterclear=\PBoolean}%
}
-\begin{Declaration}[v2.00]{\Option{partclear}[\PBoolean]}
-\begin{Declaration}[v2.00]{\Option{chapterclear}[\PBoolean]}
-\printdeclarationlist*[%
- \emph{entfällt}, \see*{\Option*{cleardoublespecialpage}'page'}%
-]%
+\printobsoletelist%
+%
Beide Optionen sind in der neuen Option \Option*{cleardoublespecialpage}
aufgegangen, womit ein konsistentes Layout erreicht wird. Die ursprünglichen
Optionen entfallen.
-\end{Declaration}
-\end{Declaration}
+\end{Obsolete}
+\end{Obsolete}
-\Replace{v2.00}{\Option{abstract}}{%
- \Option{abstracttotoc},\Option{abstractdouble}%
-}
-\begin{Declaration}[v2.00]{\Option{abstracttotoc}[\PBoolean]}
-\begin{Declaration}[v2.00]{\Option{abstractdouble}[\PBoolean]}
-\printdeclarationlist*[\emph{entfällt}, \see*{\Option*{abstract}'page'}]%
+\begin{Obsolete}{v2.00:\Option{abstract}}{\Option{abstracttotoc=\PBoolean}}
+\begin{Obsolete}{v2.00:\Option{abstract}}{\Option{abstractdouble=\PBoolean}}
+\printobsoletelist%
%
Beide Optionen wurden in die Option \Option*{abstract} integriert und sind
deshalb überflüssig.
-\end{Declaration}
-\end{Declaration}
+\end{Obsolete}
+\end{Obsolete}
-\Replace{v2.00}{\Macro{headlogo}}{\Macro{logofile}}
-\begin{Declaration}[v2.00]{\Macro{logofile}\Parameter{Dateiname}}
-\printdeclarationlist*[\see*{\Macro*{headlogo}'page'}]%
+\begin{Obsolete}{v2.00:\Macro{headlogo}}{%
+ \Macro{logofile}[\Parameter{Dateiname}]%
+}
+\printobsoletelist%
%
-Der Befehl \Macro*{logofile} wurde in \Macro*{headlogo} umbenannt. wobei die
+Der Befehl \Macro*{logofile} wurde in \Macro*{headlogo} umbenannt, wobei die
Funktionalität weiterhin bestehen bleibt.
-\end{Declaration}
+\end{Obsolete}
-\Replace{v2.00}{\Option{tudbookmarks}}{\Option{bookmarks}}
-\begin{Declaration}[v2.00]{\Option{bookmarks}[\PBoolean]}
-\printdeclarationlist*[\see*{\Option*{tudbookmarks}'page'}]%
+\begin{Obsolete}{v2.00:\Option{tudbookmarks}}{\Option{bookmarks=\PBoolean}}
+\printobsoletelist%
%
-Umbenannt, um Überschneidungen mit \Package*{hyperref} zu vermeiden.
-\end{Declaration}
+Die Option wurde umbenannt, um Überschneidungen mit \Package*{hyperref} zu
+vermeiden.
+\end{Obsolete}
-\begin{Declaration}[v2.00]{\Length{signatureheight}}
-\printdeclarationlist*[\emph{entfällt}]%
+\begin{Obsolete}{v2.00}{\Length{signatureheight}}
+\printobsoletelist%
%
Die Höhe für die Zeile der Unterschriften wurde dehnbar gestaltet, eine etwaige
Anpassung durch den Anwender ist nicht vonnöten.
-\end{Declaration}
+\end{Obsolete}
-\Replace{v2.00}{\Macro{titledelimiter}}{\Term{titlecoldelim}}
-\begin{Declaration}[v2.00]{\Term{titlecoldelim}}%
-\printdeclarationlist*[\emph{entfällt}, \see*{\Macro*{titledelimiter}'page'}]%
+\begin{Obsolete}{v2.00:\Macro{titledelimiter}}{\Term{titlecoldelim}}%
+\printobsoletelist%
%
Das Trennzeichen für Bezeichnungen beziehungsweise beschreibende Texte und dem
eigentlichen Feld auf der Titelseite ist nicht mehr sprachabhängig und wurde
umbenannt.
-\end{Declaration}
+\end{Obsolete}
-\Replace{v2.00}{\Macro{declaration}}{%
- \Macro{confirmationandrestriction},\Macro{restrictionandconfirmation}%
-}
-\begin{Declaration}[v2.00]{\Macro{confirmationandrestriction}}
-\begin{Declaration}[v2.00]{\Macro{restrictionandconfirmation}}
-\printdeclarationlist*[\emph{entfällt}, \see*{\Macro*{declaration}'page'}]%
+\begin{Obsolete}{v2.00:\Macro{declaration}}{\Macro{confirmationandrestriction}}
+\begin{Obsolete}{v2.00:\Macro{declaration}}{\Macro{restrictionandconfirmation}}
+\printobsoletelist%
%
Die beiden Befehle entfallen, stattdessen sollte entweder der Befehl
\Macro*{declaration} oder die Umgebung \Environment*{declarations} zusammen mit
den Befehlen \Macro*{confirmation} und \Macro*{blocking} verwendet werden,
wobei sich diese in der Umgebung in beliebiger Reihenfolge anordnen lassen.
-\end{Declaration}
-\end{Declaration}
+\end{Obsolete}
+\end{Obsolete}
-\Replace{v2.00}{\Macro{place}}{\Macro{location}}
-\begin{Declaration}[v2.00]{\Macro{location}\Parameter{Ort}}{%
- \see*{\Macro*{place}'page'}%
-}
-\printdeclarationlist*%
-In Anlehnung an andere \hologo{LaTeX}-Pakete und "~Klassen wurde
+\begin{Obsolete}{v2.00:\Macro{place}}{\Macro{location}[\Parameter{Ort}]}
+\printobsoletelist%
+%
+In Anlehnung an andere \hologo{LaTeX}"=Pakete und "~Klassen wurde
\Macro*{location} in \Macro*{place} umbenannt.
-\end{Declaration}
+\end{Obsolete}
\minisec{\taskname}
+\begin{Bundle}{\Package{tudscrsupervisor}}
Die Umgebung für die Erstellung einer Aufgabenstellung für eine
wissenschaftliche Arbeit wurde in das Paket \Package{tudscrsupervisor}
ausgelagert. Dieses muss für die Verwendung der Umgebung \Environment*{task}
und der daraus abgeleiteten standardisierten Form zwingend geladen werden.
-\Replace{v2.00}{\Environment*{task}}{\Option{cdtask}}
-\begin{Declaration}[v2.00]{\Option{cdtask}[\PSet]}
-\begin{Declaration}[v2.00]{\Option{taskcompact}[\PBoolean]}
-\begin{Declaration}[v2.00]{\Length{taskcolwidth}}
-\printdeclarationlist*[\emph{entfällt}, \see*{\Environment*{task}'page'}]%
+\begin{Obsolete}{v2.00:\Environment{task}}{\Option{cdtask=\PSet}}
+\begin{Obsolete}{v2.00}{\Option{taskcompact=\PBoolean}}
+\begin{Obsolete}{v2.00}{\Length{taskcolwidth}}
+\printobsoletelist%
%
Die Klassenoption \Option*{cdtask} ist komplett entfernt worden, alle
-Einstellungen, welche \Environment*{task} betreffen erfolgen direkt über das
-optionale Argument der Umgebung. Die Variante eines kompakten Kopfes mit der
-Option \Option*{taskcompact} wird nicht mehr bereitgestellt. Die manuelle
-Einstellmöglichkeit der Spaltenbreite für den Kopf der Aufgabenstellung mit
+Einstellungen, erfolgen direkt über das optionale Argument der Umgebung
+\Environment*{task}. Die Variante eines kompakten Kopfes mit der Option
+\Option*{taskcompact} wird nicht mehr bereitgestellt. Die Möglichkeit zur
+manuellen Festlegung der Spaltenbreite für den Kopf der Aufgabenstellung mit
\Length*{taskcolwidth} wurde aufgrund der verbesserten automatischen Berechnung
entfernt.
-\end{Declaration}
-\end{Declaration}
-\end{Declaration}
+\end{Obsolete}
+\end{Obsolete}
+\end{Obsolete}
-\Replace{v2.00}{\Macro{taskform}}{\Macro{tasks}}
-\begin{Declaration}[v2.00]{%
- \Macro{tasks}\Parameter{Ziele}\Parameter{Schwerpunkte}%
-}{\emph{entfällt}, \see*{\Macro*{taskform}'page'}}
-\Replace{v2.00}{\Term{focusname}}{\Term{focustext}}
-\begin{Declaration}[v2.00]{\Term{focustext}}{%
- \emph{entfällt}, \see*{\Term*{focusname}'page'}%
-}
-\Replace{v2.00}{\Term{objectivesname}}{\Term{objectivestext}}
-\begin{Declaration}[v2.00]{\Term{objectivestext}}{%
- \emph{entfällt}, \see*{\Term*{objectivesname}'page'}%
+\begin{Obsolete}{v2.00:\Macro{taskform}}{%
+ \Macro{tasks}[\Parameter{Ziele}\Parameter{Schwerpunkte}]%
}
-\printdeclarationlist*%
+\begin{Obsolete}{v2.00:\Term{focusname}}{\Term{focustext}}
+\begin{Obsolete}{v2.00:\Term{objectivesname}}{\Term{objectivestext}}
+\printobsoletelist%
%
Der Befehl \Macro*{tasks} wurde in \Macro*{taskform} umbenannt und in der
Funktionalität erweitert. Die darin verendeten Bezeichner wurden ebenfalls
leicht abgewandelt.
-\end{Declaration}
-\end{Declaration}
-\end{Declaration}
+\end{Obsolete}
+\end{Obsolete}
+\end{Obsolete}
-\Replace{v2.00}{\Macro{matriculationnumber}}{\Macro{studentid}}
-\begin{Declaration}[v2.00]{\Macro{studentid}\Parameter{Matrikelnummer}}{%
- \see*{\Macro*{matriculationnumber}'page'}%
+\begin{Obsolete}{v2.00:\Macro{matriculationnumber}}{%
+ \Macro{studentid}[\Parameter{Matrikelnummer}]%
}
-\Replace{v2.00}{\Macro{matriculationyear}}{\Macro{enrolmentyear}}
-\begin{Declaration}{\Macro{enrolmentyear}\Parameter{Immatrikulationsjahr}}{%
- \see*{\Macro*{matriculationyear}'page'}%
+\begin{Obsolete}{v2.00:\Macro{matriculationyear}}{%
+ \Macro{enrolmentyear}[\Parameter{Immatrikulationsjahr}]%
}
-\Replace{v2.00}{\Macro{date}}{\Macro{submissiondate}}
-\begin{Declaration}[v2.00]{\Macro{submissiondate}\Parameter{Datum}}{%
- \see*{\Macro*{date}'page'}%
+\begin{Obsolete}{v2.00:\Macro{date}}{\Macro{submissiondate}[\Parameter{Datum}]}
+\begin{Obsolete}{v2.00:\Macro{dateofbirth}}{%
+ \Macro{birthday}[\Parameter{Geburtsdatum}]%
}
-\Replace{v2.00}{\Macro{dateofbirth}}{\Macro{birthday}}
-\begin{Declaration}[v2.00]{\Macro{birthday}\Parameter{Geburtsdatum}}{%
- \see*{\Macro*{dateofbirth}'page'}%
+\begin{Obsolete}{v2.00:\Macro{placeofbirth}}{%
+ \Macro{birthplace}[\Parameter{Geburtsort}]%
}
-\Replace{v2.00}{\Macro{placeofbirth}}{\Macro{birthplace}}
-\begin{Declaration}[v2.00]{\Macro{birthplace}\Parameter{Geburtsort}}{%
- \see*{\Macro*{placeofbirth}'page'}%
+\begin{Obsolete}{v2.00:\Macro{issuedate}}{%
+ \Macro{startdate}[\Parameter{Ausgabedatum}]%
}
-\Replace{v2.00}{\Macro{issuedate}}{\Macro{startdate}}
-\begin{Declaration}[v2.00]{\Macro{startdate}\Parameter{Ausgabedatum}}{%
- \emph{entfällt}, \see*{\Macro*{issuedate}'page'}%
-}
-\printdeclarationlist*%
+\printobsoletelist%
%
Alle Befehle wurden umbenannt und sind jetzt neben der \taskname{} auch für die
Titelseite im \CD nutzbar.
-\end{Declaration}
-\end{Declaration}
-\end{Declaration}
-\end{Declaration}
-\end{Declaration}
-\end{Declaration}
-
-\Replace{v2.00}{\Term{matriculationnumbername}}{\Term{studentidname}}
-\begin{Declaration}[v2.00]{\Term{studentidname}}{%
- \emph{entfällt}, \see*{\Term*{matriculationnumbername}'page'}%
-}
-\Replace{v2.00}{\Term{matriculationyearname}}{\Term{enrolmentname}}
-\begin{Declaration}[v2.00]{\Term{enrolmentname}}{%
- \emph{entfällt}, \see*{\Term*{matriculationyearname}'page'}%
-}
-\Replace{v2.00}{\Term{datetext}}{\Term{submissiontext}}
-\begin{Declaration}[v2.00]{\Term{submissiontext}}{%
- \emph{entfällt}, \see*{\Term*{datetext}'page'}%
-}
-\Replace{v2.00}{\Term{dateofbirthtext}}{\Term{birthdaytext}}
-\begin{Declaration}[v2.00]{\Term{birthdaytext}}{%
- \emph{entfällt}, \see*{\Term*{dateofbirthtext}'page'}%
-}
-\Replace{v2.00}{\Term{placeofbirthtext}}{\Term{birthplacetext}}
-\begin{Declaration}[v2.00]{\Term{birthplacetext}}{%
- \emph{entfällt}, \see*{\Term*{placeofbirthtext}'page'}%
-}
-\Replace{v2.00}{\Term{supervisorothername}}{\Macro{supervisorIIname}}
-\begin{Declaration}[v2.00]{\Macro{supervisorIIname}}{%
- \emph{entfällt}, \see*{\Term*{supervisorothername}'page'}%
-}
-\Replace{v2.00}{\Term{defensedatetext}}{\Term{defensetext}}
-\begin{Declaration}[v2.00]{\Term{defensetext}}{%
- \emph{entfällt}, \see*{\Term*{defensedatetext}'page'}%
-}
-\Replace{v2.00}{\Term{issuedatetext}}{\Term{starttext}}
-\begin{Declaration}[v2.00]{\Term{starttext}}{%
- \emph{entfällt}, \see*{\Term*{issuedatetext}'page'}
-}
-\Replace{v2.00}{\Term{duedatetext}}{\Term{duetext}}
-\begin{Declaration}[v2.00]{\Term{duetext}}{%
- \emph{entfällt}, \see*{\Term*{duedatetext}'page'}%
-}
-\printdeclarationlist*%
+\end{Obsolete}
+\end{Obsolete}
+\end{Obsolete}
+\end{Obsolete}
+\end{Obsolete}
+\end{Obsolete}
+
+\begin{Obsolete}{v2.00:\Term{matriculationnumbername}}{\Term{studentidname}}
+\begin{Obsolete}{v2.00:\Term{matriculationyearname}}{\Term{enrolmentname}}
+\begin{Obsolete}{v2.00:\Term{datetext}}{\Term{submissiontext}}
+\begin{Obsolete}{v2.00:\Term{dateofbirthtext}}{\Term{birthdaytext}}
+\begin{Obsolete}{v2.00:\Term{placeofbirthtext}}{\Term{birthplacetext}}
+\begin{Obsolete}{v2.00:\Term{supervisorothername}}{\Term{supervisorIIname}}
+\begin{Obsolete}{v2.00:\Term{defensedatetext}}{\Term{defensetext}}
+\begin{Obsolete}{v2.00:\Term{issuedatetext}}{\Term{starttext}}
+\begin{Obsolete}{v2.00:\Term{duedatetext}}{\Term{duetext}}
+\printobsoletelist%
%
Die Bezeichner wurden in Anlehnung an die dazugehörigen Befehlsnamen umbenannt.
-\end{Declaration}
-\end{Declaration}
-\end{Declaration}
-\end{Declaration}
-\end{Declaration}
-\end{Declaration}
-\end{Declaration}
-\end{Declaration}
-\end{Declaration}
-
-
-\subsection{Änderungen für \TUDScript~v2.02}
-\vskip-\lastskip
-\ChangedAt*{v2.02!Änderungen gegenüber der vorhergehenden Version}%
-\Replace[macros]{v2.02}{\Length{pageheadingsvskip}}{%
- \Length{chapterheadingvskip}%
-}
-\begin{Declaration}[v2.02]{\Length{chapterheadingvskip}}
-\printdeclarationlist*[%
- \emph{entfällt}, \see*{\Length*{pageheadingsvskip}'page'}%
-]%
+\end{Obsolete}
+\end{Obsolete}
+\end{Obsolete}
+\end{Obsolete}
+\end{Obsolete}
+\end{Obsolete}
+\end{Obsolete}
+\end{Obsolete}
+\end{Obsolete}
+\end{Bundle}
+
+
+\ChangedAt*{v2.02:Änderungen gegenüber der vorhergehenden Version}%
+\subsection{Änderungen für \TUDScript~\NoCaseChange{v}2.02}
+\begin{Obsolete}{v2.02:\Option{pageheadingsvskip}}{\Length{chapterheadingvskip}}
+\printobsoletelist%
+%
Die vertikale Positionierung von Überschriften wurde aufgeteilt. Zum einen kann
-diese für Titel-, Teile- und Kapitelseiten (\Option*{chapterpage}[true]) über
-die Länge \Length*{pageheadingsvskip} geändert werden. Für Kapitelüberschriften
-(\Option*{chapterpage}[false]) sowie den Titelkopf (\Option*{titlepage}[false])
-kann dies unabhängig davon mit \Length*{headingsvskip} erfolgen.
-\end{Declaration}
+diese für Titel"~, Teile- und Kapitelseiten (\Option*{chapterpage=true}) über
+die Option \Option*{pageheadingsvskip} geändert werden. Für Kapitelüberschriften
+(\Option*{chapterpage=false}) sowie den Titelkopf (\Option*{titlepage=false})
+kann dies unabhängig davon mit \Option*{headingsvskip} erfolgen.
+\end{Obsolete}
-\Replace[macros]{v2.02}{\Macro{graduation}}{\Macro{degree}}
-\begin{Declaration}[v2.02]{\Macro{degree}\OParameter{Abk.}\Parameter{Grad}}{%
- \see*{\Macro*{graduation}'page'}%
-}
-\Replace[terms]{v2.02}{\Term{graduationtext}}{\Term{degreetext}}
-\begin{Declaration}[v2.02]{\Term{degreetext}}{%
- \see*{\Term*{graduationtext}'page'}%
+\begin{Obsolete}{v2.02:\Macro{graduation}}{%
+ \Macro{degree}[\OParameter{Abk.}\Parameter{Grad}]%
}
-\printdeclarationlist*%
+\begin{Obsolete}{v2.02:\Term{graduationtext}}{\Term{degreetext}}
+\printobsoletelist%
%
Der Befehl wurde zur Erhöhung der Kompatibilität mit anderen Paketen umbenannt,
der dazugehörige Bezeichner dahingehend angepasst.
-\end{Declaration}
-\end{Declaration}
+\end{Obsolete}
+\end{Obsolete}
-\Replace[macros]{v2.02}{\Macro{blocking}}{\Macro{restriction}}
-\begin{Declaration}[v2.02]{\Macro{restriction}\OLParameter{Firma}}{%
- \see*{\Macro*{blocking}'page'}%
+\begin{Obsolete}{v2.02:\Macro{blocking}}{%
+ \Macro{restriction}[\OLParameter{Firma}]%
}
-\Replace[terms]{v2.02}{\Term{blockingname}}{\Term{restrictionname}}
-\begin{Declaration}[v2.02]{\Term{restrictionname}}{%
- \see*{\Term*{blockingname}'page'}%
-}
-\Replace[terms]{v2.02}{\Term{blockingtext}}{\Term{restrictiontext}}
-\begin{Declaration}[v2.02]{\Term{restrictiontext}}{%
- \see*{\Term*{blockingtext}'page'}%
-}
-\printdeclarationlist*%
+\begin{Obsolete}{v2.02:\Term{blockingname}}{\Term{restrictionname}}
+\begin{Obsolete}{v2.02:\Term{blockingtext}}{\Term{restrictiontext}}
+\printobsoletelist%
%
Der Befehl wurde zur Erhöhung der Kompatibilität mit anderen Paketen umbenannt,
die dazugehörigen Bezeichner dahingehend angepasst.
-\end{Declaration}
-\end{Declaration}
-\end{Declaration}
+\end{Obsolete}
+\end{Obsolete}
+\end{Obsolete}
-\minisec{Änderungen im Paket \Package*{tudscrsupervisor}}
-\vskip-\lastskip
-\Replace[macros]{v2.02}{\Macro{discipline}}{\Macro{branch}}
-\begin{Declaration}[v2.02]{\Macro{branch}\Parameter{Studienrichtung}}{%
- \emph{entfällt}, \see*{\Macro*{discipline}'page'}%
+\begin{Obsolete}{}{\Environment{tudpage}[\OLParameter{Sprache}]}
+\begin{Obsolete}{v2.02:\Key{\Environment{tudpage}}{pagestyle}}{%
+ \Key{\Environment{tudpage}}{head=\PSet}
+}
+\begin{Obsolete}{v2.02:\Key{\Environment{tudpage}}{pagestyle}}{%
+ \Key{\Environment{tudpage}}{foot=\PSet}
}
-\Replace[terms]{v2.02}{\Term{disciplinename}}{\Term{branchname}}
-\begin{Declaration}[v2.02]{\Term{branchname}}{%
- \emph{entfällt}, \see*{\Term*{disciplinename}'page'}%
+\printobsoletelist%
+%
+Diese beiden Parameter der Umgebung \Environment*{tudpage} wurden in ihrer
+Funktionalität durch den Parameter \Key*{\Environment{tudpage}}{pagestyle}
+ersetzt.
+\end{Obsolete}
+\end{Obsolete}
+\end{Obsolete}
+
+
+
+\minisec{Änderungen im Paket \Package{tudscrsupervisor}}
+Im Paket \Package{tudscrsupervisor} gab es ein paar kleinere Anpassungen.
+\begin{Bundle}{\Package{tudscrsupervisor}}
+\begin{Obsolete}{v2.02:\Macro{discipline}}{%
+ \Macro{branch}[\Parameter{Studienrichtung}]%
}
-\printdeclarationlist*%
+\begin{Obsolete}{v2.02:\Term{disciplinename}}{\Term{branchname}}
+\printobsoletelist%
%
Für die \taskname{} wurden der Befehl sowie der dazugehörige Bezeichner
umbenannt.
-\end{Declaration}
-\end{Declaration}
+\end{Obsolete}
+\end{Obsolete}
-\Replace[macros]{v2.02}{\Macro{contactperson}}{\Macro{contact}}
-\begin{Declaration}[v2.02]{\Macro{contact}\Parameter{Kontaktperson(en)}}{%
- \emph{entfällt}, \see*{\Macro*{contactperson}'page'}%
+\begin{Obsolete}{v2.02:\Macro{contactperson}}{%
+ \Macro{contact}[\Parameter{Kontaktperson(en)}]%
}
-\Replace[terms]{v2.02}{\Term{contactpersonname}}{\Term{contactname}}
-\begin{Declaration}[v2.02]{\Term{contactname}}{%
- \emph{entfällt}, \see*{\Term*{contactpersonname}'page'}%
+\begin{Obsolete}{v2.02:\Term{contactpersonname}}{\Term{contactname}}
+\begin{Obsolete}{v2.02:\Macro{telephone}}{%
+ \Macro{phone}[\Parameter{Telefonnummer}]%
}
-\Replace[macros]{v2.02}{\Macro{telephone}}{\Macro{phone}}
-\begin{Declaration}[v2.02]{\Macro{phone}\Parameter{Telefonnummer}}{%
- \emph{entfällt}, \see*{\Macro*{telephone}'page'}%
+\begin{Obsolete}{v2.02:\Macro{emailaddress}}{%
+ \Macro{email}[\Parameter{E-Mail-Adresse}]%
}
-\Replace[macros]{v2.02}{\Macro{emailaddress}}{\Macro{email}}
-\begin{Declaration}[v2.02]{\Macro{email}\Parameter{E-Mail-Adresse}}{%
- \emph{entfällt}, \see*{\Macro*{emailaddress}'page'}%
-}
-\printdeclarationlist*%
+\printobsoletelist%
%
Alle genannten Befehle und Bezeichner wurden für den \noticename{} umbenannt.
-\end{Declaration}
-\end{Declaration}
-\end{Declaration}
-\end{Declaration}
+\end{Obsolete}
+\end{Obsolete}
+\end{Obsolete}
+\end{Obsolete}
+\end{Bundle}
+
-\subsection{Änderungen für \TUDScript~v2.03}
-\vskip-\lastskip
-\ChangedAt*{v2.03!Änderungen gegenüber der vorhergehenden Version}%
-\Replace[options]{v2.03}{\Option{cdgeometry}}{\Option{geometry}}%
-\begin{Declaration}[v2.03]{\Option{geometry}[\PBoolean]}
-\printdeclarationlist*[\see*{\Option*{cdgeometry}'page'}]%
+\ChangedAt*{v2.03:Änderungen gegenüber der vorhergehenden Version}%
+\subsection{Änderungen für \TUDScript~\NoCaseChange{v}2.03}
+\begin{Obsolete}{v2.03:\Option{cdgeometry}}{\Option{geometry=\PBoolean}}
+\printobsoletelist%
%
-Die Option \Option*{geometry} wurde aus Gründen der Konsistenz und dem
-Vermeiden eines möglichen Konfliktes mit einer späteren \KOMAScript-Version
-umbenannt. An der Funktionalität wurde nichts geändert.
-\end{Declaration}
+Die Option \Option*{geometry} wurde zur Konsistenz sowie dem Vermeiden
+eines möglichen Konfliktes mit einer späteren \KOMAScript-Version umbenannt.
+Die Funktionalität bleibt bestehen.
+\end{Obsolete}
+
+\begin{Obsolete}{v2.03:\Option{cdfont}}{\Option{cdfonts=\PBoolean}}
+\begin{Obsolete}{v2.03:\Option{cdfont}}{\Option{din=\PBoolean}}
+\printobsoletelist%
+%
+Die Option \Option*{cdfont} wurde erweitert und fungiert als zentrale
+Schnittstelle zur Schrifteinstellung.
+\end{Obsolete}
+\end{Obsolete}
-\Replace[options]{v2.03}{\Option{cdmath}}{\Option{sansmath}}%
-\begin{Declaration}[v2.03]{\Option{sansmath}[\PBoolean]}
-\printdeclarationlist*[\see*{\Option*{cdmath}'page'}]%
+\begin{Obsolete}{v2.03:\Option{cdmath}}{\Option{sansmath=\PBoolean}}
+\printobsoletelist%
%
Die Option \Option*{sansmath} wurde aus Gründen der Konsistenz umbenannt.
Zusätzlich wurde die Funktionalität erweitert.
-\end{Declaration}
+\end{Obsolete}
-\Replace[options]{v2.03}{\Option{cdhead}}{\Option{barfont},\Option{widehead}}
-\begin{Declaration}[v2.03]{\Option{barfont}[\PSet]}
-\begin{Declaration}[v2.03]{\Option{widehead}[\PBoolean]}
-\printdeclarationlist*[\see*{\Option*{cdhead}'page'}]%
-%
-Die Funktionalitäten der Optionen \Option*{barfont} und \Option*{widehead}
-wurden in der Option \Option*{cdhead} zusammengefasst und erweitert.
-\end{Declaration}
-\end{Declaration}
-
-\subsection{Änderungen für \TUDScript~v2.04}
-\vskip-\lastskip
-\ChangedAt*{v2.04!Änderungen gegenüber der vorhergehenden Version}%
-\begin{Declaration}[v2.04]{\Option{fontspec}[\PBoolean]}[false]%
-\printdeclarationlist*%
-%
-Anstatt die Option zu aktivieren, kann einfach das Paket \Package{fontspec} in
-der Dokumentpräambel geladen werden. Damit lassen sich anschließend weitere
-Pakete nutzen, die auf die Verwendung von \Package{fontspec} angewiesen sind.
-Sollte die Option \Option{fontspec} dennoch genutzt werden, müssen alle auf das
-Paket \Package{fontspec} aufbauende Einstellungen durch den Anwender mit
-\Macro*{AfterPackge}\PParameter{fontspec}\PParameter{\dots} verzögert werden.
-Mehr zur Verwendung ist in \fullref{sec:fonts:fontspec} nachzulesen.
-\begin{values}
-\itemfalse*
- Die Hausschriften im Stil des \CDs der \TnUD werden im PostScript"=Format
- eingebunden. Sowohl Kerning als auch der mathematische Satz funktionieren
- problemlos.
-\itemtrue*
- Es werden die OpenType"=Varianten der Hausschriften verwendet. Dazu wird das
- Paket \Package{fontspec} geladen, welches lediglich mit \hologo{LuaLaTeX}
- oder \hologo{XeLaTeX} jedoch nicht mit \hologo{pdfLaTeX} als genutzt werden
- kann. Sowohl beim mathematischen Satz als auch beim Kerning der Schriften
- kann es zu Problemen kommen. Hierfür müssen die OpenType"=Schriften auf dem
- Betriebssystem installiert sein. Die Verwendung dieser Einstellung sollte
- nur für den Fall erfolgen, dass eine Installation der PostScript"=Schriften
- nicht möglich ist.
-\end{values}
-\end{Declaration}
-
-
-\section{Das Paket \Package*{tudscrcomp} -- Umstieg von anderen Klassen}
-\begin{Declaration*}{\Package{tudscrcomp}}
-\index{Kompatibilität!\Class{tudbook}|(}%
-%\index{Kompatibilität!\Class{tudmathposter}|(}%
-\ToDo[nxt]{Unterstützung für \Class{tudmathposter}}[v2.05]
-\ToDo[nxt]{Unterstützung für alle Klassen von Klaus Bergmann prüfen}[v2.05]
+\begin{Obsolete}{v2.03:\Option{cdhead}}{\Option{barfont=\PSet}}
+\begin{Obsolete}{v2.03:\Option{cdhead}}{\Option{widehead=\PBoolean}}
+\printobsoletelist%
%
+Die Optionen \Option*{barfont} und \Option*{widehead} wurden in der Option
+\Option*{cdhead} zusammengefasst.
+\end{Obsolete}
+\end{Obsolete}
+
+\begin{Obsolete}{}{\Environment{tudpage}[\OLParameter{Sprache}]}
+\begin{Obsolete}{v2.03}{\Key{\Environment{tudpage}}{color=\PName{Farbe}}}
+\printobsoletelist%
+%
+Der Parameter \Key*{\Environment{tudpage}}{color=\PValueName{Farbe}} der
+\Environment*{tudpage}"=Umgebung wurde ersatzlos entfernt.
+\end{Obsolete}
+\end{Obsolete}
+
+
+\ChangedAt*{v2.04:Änderungen gegenüber der vorhergehenden Version}%
+\subsection{Änderungen für \TUDScript~\NoCaseChange{v}2.04}
+\begin{Obsolete}{v2.04}{\Option{fontspec=\PBoolean}}%
+\printobsoletelist%
+%
+Anstatt die Option \Option*{fontspec} zu aktivieren, kann einfach das Paket
+\Package{fontspec} in der Dokumentpräambel geladen werden. Dadurch können
+anschließend zusätzliche Pakete genutzt werden, welche auf die Verwendung von
+\Package{fontspec} angewiesen sind. Sollte die Option \Option*{fontspec}
+dennoch genutzt werden, müssen alle auf das Paket \Package{fontspec}
+aufbauenden Einstellungen durch den Anwender mit
+\Macro*{AfterPackage}[\PParameter{fontspec}\PParameter{\dots}]
+verzögert werden. In \fullref{sec:fonts:fontspec} sind weitere Hinweise zur
+Verwendung des Paketes \Package{fontspec} zu finden.
+\end{Obsolete}
+
+
+\ChangedAt*{v2.05:Änderungen gegenüber der vorhergehenden Version}%
+\subsection{Änderungen für \TUDScript~\NoCaseChange{v}2.05}
+\begin{Obsolete}{v2.05:\Option{pageheadingsvskip}}{\Length{pageheadingsvskip}}
+\begin{Obsolete}{v2.05:\Option{headingsvskip}}{\Length{headingsvskip}}
+\printobsoletelist%
+%
+Die vertikale Positionierung von speziellen Überschriften erfolgt nicht mehr
+über die Längen \Length*{headingsvskip} und \Length*{pageheadingsvskip} sondern
+über die Optionen \Option*{headingsvskip} sowie \Option*{pageheadingsvskip}.
+\end{Obsolete}
+\end{Obsolete}
+
+
+\begin{Obsolete}{v2.05:\Option{footlogoheight}}{\Length{footlogoheight}}%
+\printobsoletelist%
+%
+Auch die Höhe der Logos im Fußbereich der \PageStyle*{tudheadings}"=Seitenstile
+wird von nun an mit der Option \Option*{footlogoheight} und nicht mehr mit der
+Länge \Length*{footlogoheight} festgelegt.
+\end{Obsolete}
+
+
+
+\section{Das Paket \Package{tudscrcomp} -- Umstieg von anderen Klassen}
+\begin{Bundle*}{\Package{tudscrcomp}}
+\index{Kompatibilität!\Class{tudbook}|(}%
+\index{Kompatibilität!\Class{tudmathposter}|(}%
+
\noindent\Attention{%
- Sollten Sie eine der Klassen \Class{tudbook}, \Class{tudbeamer},
- \Class{tudletter}, \Class{tudfax}, \Class{tudhaus} und \Class{tudform} %sowie
-% \Class{tudmathposter}
- oder \TUDScript in der Version~v1.0 nie genutzt haben,
- können Sie dieses \autorefname ohne Weiteres überspringen. Sämtliche hier
- vorgestellten Optionen und Befehle sind in der aktuellen Version von
- \TUDScript obsolet.
+ Sollten Sie \Class{tudbook}|?|, \Class{tudletter}|?|, \Class{tudfax}|?|,
+ \Class{tudhaus}|?|, \Class{tudform}|?| oder auch \Class{tudmathposter}|?|
+ beziehungsweise eine der veralteten \TUDScript-Klassen in der Version~v1.0
+ mit den Klassen \Class{tudscrbookold}|?|, \Class{tudscrreprtold}|?| und
+ \Class{tudscrartclold}|?| nie genutzt haben, können Sie dieses \autorefname
+ ohne Weiteres überspringen. Sämtliche hier vorgestellten Optionen und Befehle
+ sind in der aktuellen Version von \TUDScript obsolet.
}
\bigskip\noindent
-Zu Beginn der Entwicklung von \TUDScript bildete die Klasse \Class{tudbook}
-die Basis. Ziel war es, sämtliche Funktionalitäten dieser beizubehalten und
-zusätzlich den vollen Funktionsumfang der \KOMAScript-Klassen nutzbar zu
-machen. Bei der kompletten Neuimplementierung der \TUDScript-Klassen wurde sehr
-viel verändert und verbessert. Einige der Optionen und Befehle waren jedoch
-bereits in der \TUDScript-Version~v1.0 Relikte, um die Kompatibilität zur
-\Class{tudbook}-Klasse und ihren Derivaten zu gewährleisten. Mit \TUDScript in
-der Version~v2.00 wurden einige aus Gründen der Konsistenz lediglich umbenannt,
-andere wiederum wurden vollständig entfernt oder über neue Befehle und Optionen
-in ihrer Funktionalität ersetzt und erweitert.
-
-Das Paket \Package{tudscrcomp} dient der Überführung von alten Dokumenten, die
-entweder mit der \Class{tudbook}-Klasse, ihren Derivaten oder mit \TUDScript in
-der Version~v1.0 erstellt wurden, auf \TUDScript~\vTUDScript. Es werden einige
-Optionen und Befehle bereitgestellt, welche von den alten Klassen definiert
-wurden und das entsprechende Verhalten nachahmen. Damit soll die Kompatibilität
-bei der Änderung der Dokumentklasse sichergestellt werden. Die Intention ist,
-alte Dokumente möglichst schnell und einfach auf die \TUDScript-Klassen
-portieren zu können. Des Weiteren ist beschrieben, wie sich die Funktionalität
-ohne die Verwendung des Paketes \Package{tudscrcomp} mit den Mitteln von
-\TUDScript umsetzen lassen. Für den Satz neuer Dokumente wird empfohlen, auf
-den Einsatz dieses Paketes komplett zu verzichten und stattdessen die neuen
-Befehle zu nutzen.
-
-\begin{Declaration}{\Macro{einrichtung}\Parameter{Fakultät}}{%
- identisch zu \Macro*{faculty}
-}
-\begin{Declaration}{\Macro{fachrichtung}\Parameter{Einrichtung}}{%
- identisch zu \Macro*{department}
-}
-\begin{Declaration}{\Macro{institut}\Parameter{Institut}}{%
- identisch zu \Macro*{institute}
-}
-\begin{Declaration}{\Macro{professur}\Parameter{Lehrstuhl}}{%
- identisch zu \Macro*{chair}
-}
-\printdeclarationlist*%
+Zu Beginn der Entwicklung von \TUDScript diente die Klasse \Class{tudbook} als
+grundlegende Basis zur Orientierung. Ziel war es, sämtliche Funktionalitäten
+dieser Klasse beizubehalten und zusätzlich den vollen Funktionsumfang der
+\KOMAScript-Klassen nutzbar zu machen. Bei der kompletten Neuimplementierung
+der \TUDScript-Klassen wurde sehr viel verändert und verbessert. Ein Teil der
+implementierten Optionen und Befehle war jedoch bereits in der Version~v1.0 von
+\TUDScript unerwünschte Relikte, mit denen lediglich die Kompatibilität zur
+\Class{tudbook}"=Klasse und ihren Derivaten gewährleistet werden sollte. Mit
+der Version~v2.00 wurden einige der unnötigen Befehle und Optionen aus Gründen
+der Konsistenz nur umbenannt, andere wiederum wurden vollständig entfernt oder
+über neue Befehle und Optionen in ihrer Funktionalität ersetzt und erweitert.
+
+\ChangedAt{v2.05:Unterstützung von \Class{tudmathposter}}
+Das Paket \Package{tudscrcomp} dient der Überführung von Dokumenten, welche
+entweder mit der \Class{tudbook}"=Klasse, ihren Derivaten,
+der Klasse \Class{tudmathposter} oder mit \TUDScript in der Version~v1.0
+erstellt wurden, auf \TUDScript~\vTUDScript.
+\Attention{%
+ Falls Sie das Paket verwenden wollen, sollte es \textbf{direkt} nach der
+ Dokumentklasse geladen werden. Andernfalls kann es im Zusammenhang mit
+ anderen Paketen zu Problemen kommen.
+}
+
+Es werden einige Optionen und Befehle bereitgestellt, welche von den zuvor
+genannten Klassen definiert werden, um das entsprechende Verhalten nachzuahmen.
+Damit soll vor allem die Kompatibilität bei einer Änderung der Dokumentklasse
+sichergestellt werden. Die Intention ist, Dokumente möglichst schnell und
+einfach auf die \TUDScript-Klassen portieren zu können. Des Weiteren ist
+beschrieben, wie sich die Funktionalität ohne eine Verwendung des Paketes
+\Package{tudscrcomp} mit den Mitteln von \TUDScript umsetzen lassen. Für den
+Satz neuer Dokumente wird empfohlen, auf den Einsatz dieses Paketes komplett zu
+verzichten und stattdessen direkt die \TUDScript-Befehle zu nutzen.
+
+\begin{Declaration}{\Macro{einrichtung}[\Parameter{Fakultät}]}{%
+ identisch zu \Macro*{faculty}[\Parameter{Fakultät}]%
+}
+\begin{Declaration}{\Macro{fachrichtung}[\Parameter{Einrichtung}]}{%
+ identisch zu \Macro*{department}[\Parameter{Einrichtung}]%
+}
+\begin{Declaration}{\Macro{institut}[\Parameter{Institut}]}{%
+ identisch zu \Macro*{institute}[\Parameter{Institut}]%
+}
+\begin{Declaration}{\Macro{professur}[\Parameter{Lehrstuhl}]}{%
+ identisch zu \Macro*{chair}[\Parameter{Lehrstuhl}]%
+}
+\printdeclarationlist%
%
Dies sind die deutschsprachigen Befehle für den Kopf im \CD.
\end{Declaration}
@@ -495,107 +465,115 @@ Dies sind die deutschsprachigen Befehle für den Kopf im \CD.
\end{Declaration}
\begin{Declaration}{\Option{serifmath}}{%
- identisch zu \Option*{cdmath}[false]%
+ identisch zu \Option*{cdmath=false}%
}
-\printdeclarationlist*%
+\printdeclarationlist%
%
Die Funktionalität wird durch die Option \Option*{cdmath} bereitgestellt.
\end{Declaration}
-\begin{Declaration}{\Macro{tudfont}\Parameter{Scriftart}}{%
- identisch zu \Macro*{cdfont}%
+\begin{Declaration}{\Macro{tudfont}[\Parameter{Scriftart}]}{%
+ identisch zu \Macro*{cdfont}[\Parameter{Scriftart}]%
}
-\printdeclarationlist*%
+\printdeclarationlist%
%
Die direkte Auswahl der Schriftart sollte mit \Macro*{cdfont} erfolgen.
Zusätzlich gibt es den Befehl \Macro*{textcdfont}, mit dem die Auszeichnung
eines bestimmten Textes in einer anderen Schriftart erfolgen kann, ohne die
Dokumentschrift umzuschalten.
\end{Declaration}
-%\index{Kompatibilität!\Class{tudmathposter}|)}%
+\index{Kompatibilität!\Class{tudmathposter}|)}%
+
\subsection{Optionen und Befehle aus \Class{tudbook} \& Co.}
+%
+Die nachfolgenden Optionen, Umgebungen sowie Befehle werden~-- zumindest
+teilweise~-- von den Klassen \Class{tudbook}, \Class{tudletter},
+\Class{tudfax}, \Class{tudhaus}, \Class{tudform} sowie dem Paket
+\Package{tudthesis}'none' und \TUDScript~v1.0 mit den Klassen
+\Class{tudscrbookold}, \Class{tudscrreprtold}, \Class{tudscrartclold}
+definiert und werden durch \Package{tudscrcomp} für \TUDScript~\vTUDScript{}
+zur Verfügung gestellt.
+
\begin{Declaration}{\Option{colortitle}}{%
- identisch zu \Option*{cdtitle}[color]%
+ identisch zu \Option*{cdtitle=color}%
}
\begin{Declaration}{\Option{nocolortitle}}{%
- identisch zu \Option*{cdtitle}[true]%
+ identisch zu \Option*{cdtitle=true}%
}
-\printdeclarationlist*%
+\printdeclarationlist%
%
Die Funktionalität wird durch die Option \Option*{cdtitle} bereitgestellt.
\end{Declaration}
\end{Declaration}
-\begin{Declaration}{\Macro{moreauthor}\Parameter{Autorenzusatz}}{%
- identisch zu \Macro*{authormore}%
+\begin{Declaration}{\Macro{moreauthor}[\Parameter{Autorenzusatz}]}{%
+ identisch zu \Macro*{authormore}[\Parameter{Autorenzusatz}]%
}
-\printdeclarationlist*%
+\printdeclarationlist%
%
Ursprünglich war diese Befehl für das Unterbringen aller möglichen,
zusätzlichen Autoreninformationen gedacht. Auch der Befehl \Macro*{authormore}
-ist ein Rudiment davon. Empfohlen wird die Verwendung der Befehle
+ist ein Rudiment davon. Empfohlen wird stattdessen die Verwendung der Befehle
\Macro*{dateofbirth}, \Macro*{placeofbirth}, \Macro*{matriculationnumber} und
-\Macro*{matriculationyear} sowie für die Aufgabenstellung einer
-wissenschaftlichen Arbeit \Macro*{course} und \Macro*{discipline} aus dem Paket
-\Package*{tudscrsupervisor}.
+\Macro*{matriculationyear} sowie \Macro*{course} und \Macro*{discipline}.
\end{Declaration}
-\begin{Declaration}{\Macro{submitdate}\Parameter{Datum}}{%
- identisch zu \Macro*{date}%
+\begin{Declaration}{\Macro{submitdate}[\Parameter{Datum}]}{%
+ identisch zu \Macro*{date}[\Parameter{Datum}]%
}
-\printdeclarationlist*%
+\printdeclarationlist%
%
Die Funktionalität wird durch den erweiterten Standardbefehl \Macro*{date}
abgedeckt.
\end{Declaration}
-\begin{Declaration}{\Macro{supervisorII}\Parameter{Name}}{%
+\begin{Declaration}{\Macro{supervisorII}[\Parameter{Name}]}{%
identisch zur Verwendung von \Macro*{and} innerhalb von \Macro*{supervisor}%
}
-\printdeclarationlist*%
+\printdeclarationlist%
%
-Es ist \Macro*{supervisor}\PParameter{\PName{Name} \Macro*{and} \PName{Name}}
-statt \Macro*{supervisorII}\Parameter{Name} zu verwenden.
+Es ist \Macro*{supervisor}[\PParameter{\PName{Name} \Macro*{and} \PName{Name}}]
+statt \Macro*{supervisorII}[\Parameter{Name}] zu verwenden.
\end{Declaration}
-\begin{Declaration}{\Macro{supervisedby}\Parameter{Bezeichnung}}{%
+\begin{Declaration}{\Macro{supervisedby}[\Parameter{Bezeichnung}]}{%
siehe \Term*{supervisorname}%
}
-\begin{Declaration}{\Macro{supervisedIIby}\Parameter{Bezeichnung}}{%
+\begin{Declaration}{\Macro{supervisedIIby}[\Parameter{Bezeichnung}]}{%
siehe \Term*{supervisorothername}%
}
-\begin{Declaration}{\Macro{submittedon}\Parameter{Bezeichnung}}{%
+\begin{Declaration}{\Macro{submittedon}[\Parameter{Bezeichnung}]}{%
siehe \Term*{datetext}%
}
-\printdeclarationlist*%
+\printdeclarationlist%
%
Zur Änderung der Bezeichnung der Betreuer sollten die sprachabhängigen
Bezeichner wie in \autoref{sec:localization} beschrieben angepasst werden. Eine
-Verwendung der alten Befehle entfernt die Abhängigkeit der Bezeichner von der
-verwendeten Sprache.
+Verwendung der hier beschriebenen Befehle entfernt die Abhängigkeit der
+Bezeichner von der verwendeten Sprache.
\end{Declaration}
\end{Declaration}
\end{Declaration}
\begin{Declaration}{\Option{ddcfooter}}{%
- identisch zu \Option*{ddcfoot}[true]%
+ identisch zu \Option*{ddcfoot=true}%
}
-\printdeclarationlist*%
+\printdeclarationlist%
%
Die Funktionalität wird durch die Option \Option*{ddcfoot} bereitgestellt.
\end{Declaration}
\begin{Declaration}{\Macro{dissertation}}
-\printdeclarationlist*%
+\printdeclarationlist%
%
-Die Funktionalität kann durch die Befehle \Macro*{thesis}\PParameter{diss} und
-\Macro*{referee} sowie die Bezeichner \Term*{refereename} und
+Die Funktionalität kann durch die Befehle \Macro*{thesis}[\PParameter{diss}]
+und \Macro*{referee} sowie die Bezeichner \Term*{refereename} und
\Term*{refereeothername} dargestellt werden.
\end{Declaration}
\begin{Declaration}{\Macro{chapterpage}}
-\printdeclarationlist*%
+\printdeclarationlist%
%
Durch diesen Befehl können Kapitelseiten konträr zur eigentlichen Einstellung
aktiviert oder deaktiviert werden. Prinzipiell ist dies auch durch eine
@@ -605,25 +583,243 @@ führt.
\end{Declaration}
\begin{Declaration}{\Environment{theglossary}[\OParameter{Präambel}]}
-\begin{Declaration}{\Macro{glossitem}\Parameter{Begriff}}
-\printdeclarationlist*%
+\begin{Declaration}{\Macro{glossitem}[\Parameter{Begriff}]}
+\printdeclarationlist%
%
-Die \Class{tudbook}-Klasse stellt eine rudimentäre Umgebung für ein Glossar
+Die \Class{tudbook}"=Klasse stellt eine rudimentäre Umgebung für ein Glossar
bereit. Allerdings gibt es dafür bereits zahlreiche und besser implementierte
Pakete. Daher wird für diese Umgebung keine Portierung vorgenommen, sondern
lediglich die ursprüngliche Definition übernommen. Allerdings sein an dieser
Stelle auf wesentlich bessere Lösungen wie beispielsweise das Paket
\Package{glossaries} oder~-- mit Abstrichen~-- das nicht ganz so umfangreiche
-Paket \Package{nomencl} verwiesen.
+Paket \Package{nomencl} verwiesen.
+\end{Declaration}
+\end{Declaration}
+\index{Kompatibilität!\Class{tudbook}|)}%
+
+\subsection{Optionen und Befehle aus \Class{tudmathposter}}
+\index{Kompatibilität!\Class{tudmathposter}|(}%
+%
+Die Klasse~\Class{tudmathposter} wird~-- im Gegensatz zu den zuvor genannten
+Klassen von Klaus Bergmann~-- weiterhin gepflegt und kann bedenkenlos zum
+Setzen von Postern im A0"~Format verwendet werden. Dennoch gab es vermehrt
+Anfragen bezüglich einer Posterklasse auf Basis der \TUDScript-Klassen, um
+beispielsweise die Schriftgröße oder auch das Papierformat einfach anpassen zu
+können. Um von \Class{tudmathposter} einen möglichst einfachen Übergang auf
+\Class{tudscrposter} zu gewährleisten, kann zusätzlich letzterer Klasse das
+Paket \Package{tudscrcomp} geladen werden, welches die nachfolgend erläuterten
+Anwenderbefehle bereitstellt. Von \Package{tudscrcomp} werden außerdem einige
+Pakete geladen, welche normalerweise durch \Class{tudmathposter} eingebunden
+werden. Dies sind \Package{amsmath}, \Package{amsfonts}, \Package{calc},
+\Package{textcomp} sowie \Package{tabularx}.
+
+Es ist nicht beabsichtigt, dass bei einem Umstieg von \Class{tudmathposter} auf
+\Class{tudscrposter} in Verbindung mit \Package{tudscrcomp} das Ausgabeergebnis
+identisch ist. Vielmehr soll damit die Möglichkeit geschaffen werden, auf
+\Class{tudmathposter} basierende Dokumente auf die \Class{tudscrposter} zu
+überführen. In jedem Fall sollte bei einem Umstieg auf \TUDScript-Posterklasse
+beachtet werden, dass für diese Klasse eine explizite Wahl der Schriftgröße
+über die Option~\Option{fontsize}(\Package{koma-script})'none' notwendig ist.
+Um kongruent zur Klasse \Class{tudmathposter} zu bleiben, ist die Wahl einer
+Schriftgröße von \Option*{fontsize=\PValue{34...36pt}} sinnvoll. Für weitere
+Informationen zu diesem Thema sind in \autoref{sec:fontsize} vorhanden.
+Weiterhin sollte für ein ähnliches Ausgabeergebnis die Absatzformatierung über
+die \KOMAScript-Option \Option*{parskip=half-} eingestellt werden. Ein blaues
+\DDC-Logo im Fußbereich lässt sich über \Option*{ddcfoot=blue} aktivieren.
+
+\begin{Declaration}[v2.05]{\Option{tudmathposterfoot}}%
+\printdeclarationlist%
+%
+Durch die Klasse \Class{tudmathposter} wird der Fußbereich zweispaltig jedoch
+asymmetrisch und ohne Überschriften innerhalb der beiden Spalten gesetzt.
+Dieses Verhalten lässt sich mit der Option \Option{tudmathposterfoot}
+auswählen. Alternativ kann auch \Option*{cdfoot=tudmathposter}'none' respektive
+\Option*{cdfoot=tudscrposter}'none' zum Aktivieren beziehungsweise Deaktivieren
+verwendet werden.
+\end{Declaration}
+
+\begin{Declaration}[v2.05]{\Option{bluebg}}{%
+ identisch zu \Option*{backgroundcolor=true}(\Class{tudscrposter})%
+}
+\printdeclarationlist%
+%
+Mit der Klasse \Class{tudscrposter} lässt sich das Verhalten mit der Option
+\Option*{backgroundcolor}(\Class{tudscrposter}) umsetzen.
+\end{Declaration}
+
+\begin{Declaration}{\Macro{telefon}[\Parameter{Telefonnummer}]}{identisch zu
+ \Macro*{telephone}[\Parameter{Telefonnummer}](\Class{tudscrposter})%
+}
+\begin{Declaration}{\Macro{fax}[\Parameter{Telefaxnummer}]}{identisch zu
+ \Macro*{telefax}[\Parameter{Telefaxnummer}](\Class{tudscrposter})%
+}
+\begin{Declaration}{\Macro{email}[\Parameter{E-Mail-Adresse}]}{identisch zu
+ \Macro*{emailaddress*}[\Parameter{E-Mail-Adresse}](\Class{tudscrposter})%
+}
+\begin{Declaration}{\Macro{homepage}[\Parameter{URL}]}{identisch zu
+ \Macro*{webpage*}[\Parameter{URL}](\Class{tudscrposter})%
+}
+\printdeclarationlist%
+%
+Dies sind die von \Class{tudmathposter} definierten Befehle für die Felder im
+vordefinierten Fußbereich des Posters. Es ist dabei insbesondere zu beachten,
+dass die angegebene E"~Mail-Adresse sowie die URL nicht automatisch formatiert
+werden.
+\end{Declaration}
+\end{Declaration}
+\end{Declaration}
+\end{Declaration}
+
+\begin{Declaration}{\Macro{fusszeile}[\Parameter{Inhalt}]}{%
+ identisch zu \Macro*{footcontent}[\Parameter{Inhalt}]
+}
+\begin{Declaration}{\Macro{footcolumn0}[\Parameter{Inhalt}]}{%
+ identisch zu \Macro*{footcontent}[\Parameter{Inhalt}]
+}
+\begin{Declaration}{\Macro{footcolumn1}[\Parameter{Inhalt}]}{%
+ identisch zu \Macro*{footcontent}[\Parameter{Inhalt}\POParameter{*}]
+}
+\begin{Declaration}{\Macro{footcolumn2}[\Parameter{Inhalt}]}{%
+ identisch zu \Macro*{footcontent}[\PParameter{*}\OParameter{Inhalt}]
+}
+\printdeclarationlist%
+%
+Mit diesen Befehlen kann die Gestalt des Fußes angepasst werden, wobei entweder
+der Bereich über die gesamte Breite (\Macro{fusszeile}, \Macro{footcolumn0})
+oder lediglich die linke (\Macro{footcolumn1}) respektive die rechte Spalte
+(\Macro{footcolumn2}) angepasst wird. Für zusätzliche Hinweise zur Anpassung
+des Fußbereichs~-- insbesondere für die Schriftformatierung~-- sollte die
+Beschreibung von \Macro*{footcontent}'full' zu Rate gezogen werden.
+\end{Declaration}
+\end{Declaration}
+\end{Declaration}
+\end{Declaration}
+
+
+\begin{Declaration}{\Macro{zweitlogofile}[\Parameter{Dateiname}]}{%
+ identisch zu \Macro*{headlogo}[\Parameter{Dateiname}]
+}
+\begin{Declaration}{\Macro{institutslogofile}[\Parameter{Dateiname}]}{%
+ \seeref{\Macro*{footlogo}}%
+}
+\begin{Declaration}{\Macro{drittlogofile}[\Parameter{Dateiname}]}{%
+ \seeref{\Option*{ddc} und \Option*{ddcfoot}}%
+}
+\printdeclarationlist%
+%
+Für die Angabe von Logos für den Kopf- und Fußbereich existieren diese Befehle.
+Bei der Verwendung von \Macro{institutslogofile}[\Parameter{Dateiname}] ist zu
+beachten, dass die angegebene Datei sehr weit rechts im Fußbereich des Posters
+gesetzt wird. Dabei kommt bei der Verwendung im Hintergrund der von \TUDScript
+für das Setzen von Logos im Fußbereich tatsächlich vorgesehene Befehl in der
+Form \Macro*{footlogo}[\PParameter{{{,}{,}{,}{,}{,}{,}{,}\PName{Dateiname}{,}}}]
+zum Einsatz. Das Makro \Macro{drittlogofile} wird von \Class{tudmathposter} für
+die Angabe eines \DDC-Logos im rechten Seitenfuß bereitgestellt. Für die
+\TUDScript-Klassen gibt es hierfür die Optionen \Option*{ddc} beziehungsweise
+\Option*{ddcfoot}.
+\end{Declaration}
+\end{Declaration}
+\end{Declaration}
+
+\begin{Declaration}{\Macro{zweitlogo}[\Parameter{Definition}]}{%
+ keine Funktionalität, \seeref{\Macro*{headlogo}}
+}
+\begin{Declaration}{\Macro{institutslogo}[\Parameter{Definition}]}{%
+ keine Funktionalität, \seeref{\Macro*{footlogo}}
+}
+\begin{Declaration}{\Macro{drittlogo}[\Parameter{Definition}]}{%
+ keine Funktionalität, \seeref{\Option*{ddc} und \Option*{ddcfoot}}%
+}
+\printdeclarationlist%
+%
+Mit diesen Befehlen kann der Anwender bei \Class{tudmathposter} die Definition
+für das Einbinden diverser Logos selber vornehmen. Dies ist für \TUDScript
+nicht vorgesehen. Im Zweifel sollten die Möglichkeiten der korrelierenden
+Befehle genutzt werden. Bei der Verwendung eines dieser Makros wird lediglich
+eine Warnung ausgegeben.
+\end{Declaration}
+\end{Declaration}
+\end{Declaration}
+
+\begin{Declaration}{%
+ \Macro{topsection}[\OParameter{Kurzform}\Parameter{Überschrift}]%
+}
+\begin{Declaration}{%
+ \Macro{topsubsection}[\OParameter{Kurzform}\Parameter{Überschrift}]%
+}
+\printdeclarationlist%
+%
+Der Grund für die Existenz dieser beiden Befehle bei \Class{tudmathposter} ist
+nicht ohne Weiteres nachvollziehbar. Beide entsprechen in ihrem Verhalten den
+Standardbefehlen \Macro{section} und \Macro*{subsection}, setzen allerdings
+keinen vertikalen Abstand vor der erzeugten Überschrift. Auch wenn das aus
+typographischer Sicht wohl eher unvorteilhaft ist, werden diese beiden Befehle
+bereitgestellt.
\end{Declaration}
\end{Declaration}
-\index{Kompatibilität!\Class{tudbook}|)}
+
+\begin{Declaration}{%
+ \Macro{centersection}[\OParameter{Kurzform}\Parameter{Überschrift}]%
+}
+\begin{Declaration}{%
+ \Macro{centersubsection}[\OParameter{Kurzform}\Parameter{Überschrift}]%
+}
+\begin{Declaration}{%
+ \Macro{topcentersection}[\OParameter{Kurzform}\Parameter{Überschrift}]%
+}
+\begin{Declaration}{%
+ \Macro{topcentersubsection}[\OParameter{Kurzform}\Parameter{Überschrift}]%
+}
+\printdeclarationlist%
%
+Weiterhin werden auch noch eigene Makros zum Setzen zentrierter Überschriften
+definiert~-- ein simples Umdefinieren von \Macro*{raggedsection} ist dafür im
+Normalfall absolut ausreichend. Und um die Sache vollständig zu machen, gibt es
+die zentrierten Überschriften auch noch ohne vorgelagerten, vertikalen Abstand.
+\end{Declaration}
+\end{Declaration}
+\end{Declaration}
+\end{Declaration}
+
+\begin{Declaration}{\Environment{farbtabellen}}
+\begin{Declaration}{\Macro{blautabelle}}
+\begin{Declaration}{\Macro{grautabelle}}
+\printdeclarationlist%
+%
+Wird innerhalb der \Environment{farbtabellen}"=Umgebung eine Tabelle gesetzt,
+so werden die Zeilen alternierend farbig hervorgehoben. Standardmäßig sind
+hierfür leichte Blautönen eingestellt, was auch jederzeit mit dem Aufruf von
+\Macro{blautabelle} wiederhergestellt werden kann. Alternativ zu dieser
+Darstellung kann mit \Macro{grautabelle} auf eine Verwendung von leichten
+Grautönen umgestellt werden.
+\end{Declaration}
+\end{Declaration}
+\end{Declaration}
+
+\begin{Declaration}{\Environment{figurehere}}
+\begin{Declaration}{\Environment{tablehere}}
+\printdeclarationlist%
%
-%\subsection{Optionen und Befehle aus \Class{tudmathposter}}
-%\index{Kompatibilität!\Class{tudmathposter}|(}%
-%\ToDo[imp]{interne Schalter beim Laden von tudbook bzw. tudmathposter}
-%\ToDo[imp]{Optionen und Befehle für tudmathposter}
-%\ToDo[doc]{Dokumentation tudmathposter}
-%\index{Kompatibilität!\Class{tudmathposter}|)}%
-\end{Declaration*} \ No newline at end of file
+Diese beiden Umgebungen können genutzt werden, um nicht-gleitende Abbildungen
+oder Tabellen zu setzen.
+\end{Declaration}
+\end{Declaration}
+
+\begin{Declaration}{\Macro{schnittrand}}
+\printdeclarationlist%
+%
+Wird \Macro{schnittrand} \textbf{vor} dem Laden des Paketes \Package{tudscrcomp}
+definiert, so wird der Inhalt des Befehls als Längenwert interpretiert. Dieser
+wird verwendet, um den zuvor festgelegten Satzspiegel über die drei Parameter
+\Key*{\Macro{geometry}(\Package{geometry})}{paper=\PName{Papierformat}},
+\Key*{\Macro{geometry}(\Package{geometry})}{layout=\PName{Zielformat}} und
+\Key*{\Macro{geometry}(\Package{geometry})}{layoutoffset=\PName{Längenwert}} des
+Befehls \Macro*{geometry}(\Package{geometry})'none' aus dem Paket
+\Package*{geometry} zu setzen und das erzeugte Papierformat um den gegebenen
+Längenwert an allen Rändern zu vergrößern. Somit wird eine Beschnittzugabe
+hinzugefügt, \emph{ohne dabei die Seitenränder des Entwurfslayouts anzupassen}.
+In \fullref{sec:tips:crop} sind zusätzliche Informationen zu diesem Thema zu
+finden.
+\end{Declaration}
+\index{Kompatibilität!\Class{tudmathposter}|)}%
+\end{Bundle*}
diff --git a/Master/texmf-dist/source/latex/tudscr/doc/tudscr-packages.tex b/Master/texmf-dist/source/latex/tudscr/doc/tudscr-packages.tex
index a5e0adf9505..59fce8ae4c8 100644
--- a/Master/texmf-dist/source/latex/tudscr/doc/tudscr-packages.tex
+++ b/Master/texmf-dist/source/latex/tudscr/doc/tudscr-packages.tex
@@ -1,22 +1,24 @@
-\chapter{Unerlässliche und beachtenswerte Pakete}
-\manualhyperdef{sec:packages}
-\index{Kompatibilität!Pakete}
-\section{Von den neuen Hauptklassen benötigte Pakete}
-\label{sec:packages:needed}
+\chapter{Benötigte, unterstützte und empfehlenswerte Pakete}
+\tudhyperdef*{sec:packages}
+\index{Kompatibilität|?}%
+%
+\section{Notwendige und ergänzende Pakete}
+\tudhyperdef*{sec:packages:needed}%
+%
\subsection{Erforderliche Pakete bei der Schriftinstallation}
%
Für die Installation der Schriften sind die folgend genannten Pakete von
\emph{essentieller} Bedeutung und daher \emph{zwingend} notwendig. Das
Vorhandensein dieser wird durch die jeweiligen Schriftinstallationsskripte
-(\see*{\autoref{sec:install}}) geprüft und die Installation beim Fehlen eines
+(\seeref{\autoref{sec:install}}) geprüft und die Installation beim Fehlen eines
oder mehrerer Pakete mit einer entsprechenden Warnung abgebrochen.
%
\begin{packages}
-\item[fontinst][fontware]
+\item[fontinst](fontware)
Dieses Paket wird für die Installation der Schriften \Univers sowie \DIN
- benötigt. Weiterhin ist auch \Package{fontware} für die Schriftkonvertierung
- notwendig.
-\item[cmbright]'hfbright,cm-super'
+ benötigt. Weiterhin ist \Package{fontware} der \hologo{LaTeX}"=Distribution
+ für die Schriftkonvertierung notwendig.
+\item[cmbright,hfbright,cm-super]
Alle mathematischen Glyphen und Symbole, die nicht in den \Univers-Schriften
enthalten sind, werden diesem Paket entnommen. Außerdem werden für die
\PValue{T1}"~Schriftkodierung die beiden Pakete \Package{cm-super} und
@@ -30,22 +32,30 @@ oder mehrerer Pakete mit einer entsprechenden Warnung abgebrochen.
\subsection{Notwendige Pakete für die Verwendung der Hauptklassen}
Diese Pakete werden von den neuen Klassen zwingend benötigt und automatisch
-geladen.
+geladen, falls dies nicht durch den Anwender in der Präambel geschieht.
%
\begin{packages}
-\item[koma-script][scrlayer-scrpage,scrbase]
+\item[koma-script,typearea,scrlayer-scrpage,scrbase]
+ \begin{Declaration*}{\Class{scrbook}}
+ \begin{Declaration*}{\Class{scrreprt}}
+ \begin{Declaration*}{\Class{scrartcl}}
+ \begin{Declaration*}{\Class{scrlttr2}}
\ChangedAt{%
- v2.02!\Package{scrlayer-scrpage}: Für Verwendung von \TUDScript notwendig%
+ v2.02:Paket \Package{scrlayer-scrpage} ist für \TUDScript unabdingbar%
}%
Das \KOMAScript-Bundle ist die zentrale Grundlage für \TUDScript. Neben den
Klassen \Class{scrbook}, \Class{scrreprt} und \Class{scrartcl} wird das Paket
\Package{scrbase} benötigt. Dieses erlaubt das Definieren von Klassenoptionen
im Stil von \KOMAScript, welche auch noch nach dem Laden der Klasse mit den
Befehlen \Macro{TUDoption} und \Macro{TUDoptions} geändert werden können. Für
- die Bereitstellung der \PageStyle{tudheadings}-Seitenstile ist das Paket
+ die Bereitstellung der \PageStyle{tudheadings}"=Seitenstile ist das Paket
\Package{scrlayer-scrpage} notwendig. Wenn es nicht durch den Anwender~-- mit
beliebigen Optionen~-- geladen wird, erfolgt dies am Ende der Präambel
automatisch durch \TUDScript.
+ \end{Declaration*}
+ \end{Declaration*}
+ \end{Declaration*}
+ \end{Declaration*}
\item[kvsetkeys]
Hiermit wird das von \Package{scrbase} geladene Paket \Package{keyval}
verbessert, welches das Definieren von Klassen"~ und Paketoptionen sowie
@@ -54,31 +64,36 @@ geladen.
\item[etoolbox]
Es werden viele Funktionen zum Testen und zur Ablaufkontrolle bereitgestellt
und das einfache Manipulieren vorhandener Makros ermöglicht.
-\item[geometry]\index{Satzspiegel}
+\item[geometry]
+ \index{Satzspiegel}%
Das Paket wird zum Festlegen der Seitenränder respektive des Satzspiegels
verwendet. Ein Weiterreichen zusätzlicher Optionen an das Paket wird
dringlich nicht empfohlen.
-\item[textcase]\index{Schriftauszeichnung}
- Mit \Macro{MakeTextUppercase} wird die Großschreibung der Überschriften in
- \DIN erzwungen. Im \emph{Ausnahmefall} kann dies mit \Macro{NoCaseChange}
- unterbunden werden.
-\item[graphicx]\index{Grafiken}
+\item[textcase]
+ \index{Schriftauszeichnung}%
+ Mit dem Befehl \Macro{MakeTextUppercase}(\Package{textcase})'none' wird bei
+ Überschriften in \DIN die Großschreibung erzwungen. Im \emph{Ausnahmefall}
+ kann dies mit \Macro{NoCaseChange}(\Package{textcase}) unterbunden werden.
+\item[trimspaces]
+ Bei mehreren Eingabefeldern für den Anwender werden die Argumente mithilfe
+ dieses Paketes um eventuell angegebene, unnötige Leerzeichen befreit.
+\item[graphicx]
+ \index{Grafiken}%
Dies ist das De-facto-Standard-Paket zum Einbinden von Grafiken. Zum Setzen
- des Logos der \TnUD im Kopf wird \Macro{includegraphics} genutzt. Es kann
- auch durch den Anwender in der Präambel geladen werden.
-\item[xcolor]\index{Farben}
+ des Logos der \TnUD im Kopf sowie aller weitere Abbildungen und Logos wird
+ \Macro{includegraphics}(\Package{graphicx})'none' genutzt.
+\item[xcolor]
+ \index{Farben}%
Damit werden die Farben des \CDs zur Verwendung im Dokument definiert.
Genaueres ist bei der Beschreibung von \Package{tudscrcolor}'auto' zu finden.
Ein Laden beider Pakete in der Präambel durch den Nutzer ist problemlos
möglich.
-\item[environ]\index{Befehle!Deklaration}
+\item[environ]
+ \index{Befehlsdeklaration}%
Es wird eine verbesserte Deklaration von Umgebungen ermöglicht, bei der auch
beim Abschluss der Umgebung auf die übergebenen Parameter zugegriffen werden
kann. Dies wird die Neugestaltung der \Environment{abstract}"=Umgebung
benötigt.
-\item[trimspaces]
- Bei mehreren Eingabefeldern für den Anwender werden die Argumente mithilfe
- dieses Paketes um eventuell angegebene, unnötige Leerzeichen befreit.
\end{packages}
%
Möchten Sie eines der hier aufgezählten Pakete selber nutzen, es jedoch mit
@@ -89,65 +104,37 @@ Beschreibung nichts anderweitiges angegeben worden ist.
\begin{Example}
Das Weiterreichen von Optionen an Pakete muss folgendermaßen erfolgen:
\begin{Code}[escapechar=§]
-\PassOptionsToPackage§\Parameter{Optionenliste}\Parameter{Paket}§
+\PassOptionsToPackage§\Parameter{Paketoptionen}\Parameter{Paket}§
\documentclass§\OParameter{Klassenoptionen}\PParameter{tudscr\dots}§
\end{Code}
\end{Example}
-\section{Durch \TUDScript direkt unterstütze Pakete}
+\subsection{Durch \TUDScript unterstütze Pakete}
%
-Wird eines der genannten Pakete geladen, so wird die Funktionalität von
-\TUDScript durch dieses verbessert beziehungsweise erweitert oder es wird ein
-Bugfix bereitgestellt.
-%
-\begin{packages}
-\item[hyperref]\index{Lesezeichen}\index{Querverweise}
- Hiermit können in einem PDF-Dokument Lesezeichen, Querverweise und
- Hyperlinks erstellt werden. Wird es geladen, sind außerdem die Option
- \Option{tudbookmarks} sowie der Befehl \Macro{tudbookmark} nutzbar. Das
- Paket \Package{bookmark} erweitert die Unterstützung nochmals. Beide
- genannten Pakete sollten~-- bis auf sehr wenige Ausnahmen wie beispielsweise
- \Package{glossaries}~-- als letztes in der Präambel eingebunden werden.
-\item[isodate]\index{Datum|?}
- Dieses Paket formatiert mit \Macro{printdate}\Parameter{Datum} die Ausgabe
- eines Datums automatisch in ein spezifiziertes Format. Wird es geladen,
- werden alle Datumsfelder, welche durch die \TUDScript-Klassen definiert
- wurden,%
- \footnote{%
- \Macro{date}, \Macro{dateofbirth}, \Macro{defensedate}, \Macro{duedate},
- \Macro{issuedate}
- }
- in diesem Format ausgegeben.
-\item[multicol]\index{Zweispaltensatz|?}
- Hiermit kann jeglicher beliebiger Inhalt in zwei oder mehr Spalten ausgegeben
- werden, wobei~-- im Gegensatz zur \hologo{LaTeX}-Option \Option{twocolumn}~--
- für einen Spaltenausgleich gesorgt wird. Unterstützt wird das Paket innerhalb
- der Umgebungen \Environment{abstract} und \Environment{tudpage}.
-\item[quoting]\index{Zitate}
- \hologo{LaTeX} bietet von Haus aus \emph{zwei} verschiedene Umgebungen für
- Zitate und ähnliches. Beide sind in ihrer Ausprägung starr und ignorieren
- beispielsweise die Einstellungen von \Option{parskip}. Dies wird durch die
- Umgebung \Environment{quoting} verbessert. Wird das Paket geladen, kommt
- diese gegebenenfalls innerhalb der \Environment{abstract}"=Umgebung zum
- Einsatz.
-\item[ragged2e]\index{Worttrennung}
- Das Paket verbessert den Flattersatz, indem für diesen die Worttrennung
- aktiviert wird.
-\end{packages}
+Einige der unter \autoref{sec:packages:recommended} beschriebenen Pakete werden
+durch \TUDScript direkt unterstützt und erweitern dessen Funktionalität. Dies
+sind namentlich \Package{hyperref}, \Package{isodate}, \Package{multicol},
+\Package{quoting}, \Package{ragged2e} und \Package{crop}. Weitere Informationen
+dazu ist den nachfolgenden Beschreibung des jeweiligen Paketes zu entnehmen.
+\newcommand*\RecPack{%
+ \hyperref[sec:packages:recommended]{Paketbeschreibung}:\xspace%
+}
\section{Empfehlenswerte Pakete}
-\label{sec:packages:recommended}
+\tudhyperdef*{sec:packages:recommended}%
+%
In diesem \autorefname wird eine Vielzahl an Paketen~-- zumeist kurz~--
vorgestellt, welche sich für mich persönlich bei der Arbeit mit \hologo{LaTeX}
bewährt haben. Einige davon werden außerdem im Tutorial \Tutorial{treatise} in
ihrer Anwendung beschrieben. Für detaillierte Informationen sowie bei Fragen zu
-den einzelnen Paketen sollte die jeweilige Dokumentation zu Rate gezogen
-werden,\footnote{Kommandozeile/Terminal: \Path{texdoc\,\PName{Paketname}}}
-das Lesen der hier gegebenen Kurzbeschreibung ersetzt dies in keinem Fall.
+den einzelnen Paketen sollte die jeweilige Dokumentation%
+\footnote{Kommandozeile/Terminal: \Path{texdoc\,\PName{Paketname}}}
+zu Rate gezogen werden, das Lesen der hier gegebenen Kurzbeschreibung ersetzt
+dies in keinem Fall.
\subsection{Pakete zur Verwendung in jedem Dokument}
@@ -158,13 +145,16 @@ Englisch ist. Für deutschsprachige Dokumente ist für eine annehmbare
Worttrennung das Paket \Package{hyphsubst} unbedingt zu verwenden.
\begin{packages}
-\item[fontenc]\index{Zeichensatzkodierung}
+\item[fontenc]
+ \index{Zeichensatzkodierung}%
Das Paket erlaubt Festlegung der Zeichensatzkodierung des Ausgabefonts. Als
Voreinstellung ist die Ausgabe als 7"~bit kodierte Schrift gewählt, was unter
anderem dazu führt, dass keine echten Umlaute im erzeugten PDF-Dokument
- verwendet werden. Um auf 8"~bit"~Schriften zu schalten, sollte man
- \Macro*{usepackage}\POParameter{T1}\PParameter{fontenc} nutzen.
-\item[selinput]\index{Eingabekodierung}
+ verwendet werden. Um auf 8"~bit"~Schriften zu schalten, ist
+ \Macro*{usepackage}[\POParameter{T1}\PParameter{fontenc}] zu nutzen.
+\item[selinput,inputenc]
+ \index{Eingabekodierung}%
+ \index{Minimalbeispiel|?}%
Hiermit erfolgt die (automatische) Festlegung der Eingabekodierung. Diese ist
vom genutzten \hyperref[sec:tips:editor]{Editors (\autoref{sec:tips:editor})}
und den darin gewählten Einstellung abhängig. Mit:
@@ -172,35 +162,40 @@ Worttrennung das Paket \Package{hyphsubst} unbedingt zu verwenden.
\usepackage{selinput}
\SelectInputMappings{adieresis={ä},germandbls={ß}}
\end{Code}\vspace{-\baselineskip}%
- wird es verwendet. Dies macht den Quelltext portabel, womit beispielsweise
- einfach via Copy~\&~Paste ein \hrfn{http://www.komascript.de/minimalbeispiel}%
- {Minimalbeispiel} bei Problemstellungen in einem Forum bereitgestellt werden
- kann. Alternativ dazu lässt sich mit dem Paket \Package{inputenc} die zu
- verwendende Eingabekodierung manuell einstellen
- (\Macro*{usepackage}\OParameter{Eingabekodierung})\PParameter{inputenc}).
-\item[babel]\index{Sprachunterstützung}\index{Bezeichner}
- Mit diesem Paket erfolgt die Einstellung der im Dokument verwendeten
- Sprache(n). Bei mehreren angegebenen Sprachen ist die zuletzt geladene die
- Hauptsprache des Dokumentes. Die gewünschten Sprachen sollten als nicht als
- Paketoption sondern als Klassenoption und gesetzt werden, damit auch andere
- Pakete auf die Spracheinstellungen zugreifen können. Für deutschsprachige
- Dokumente ist die Option \Option{ngerman} für die neue oder \Option{german}
- für die alte deutsche Rechtschreibung zu verwenden.
+ wird es verwendet. Dies macht den Quelltext zum einen für unterschiedliche
+ Betriebssystem portabel und es kann beispielsweise einfach via Copy~\&~Paste
+ ein \hrfn{http://www.komascript.de/minimalbeispiel}{Minimalbeispiel} bei
+ Problemstellungen in einem Forum bereitgestellt werden. Alternativ dazu lässt
+ sich mit dem Paket \Package{inputenc}
+ (\Macro*{usepackage}[\OParameter{Eingabekodierung}\PParameter{inputenc}])
+ die Eingabekodierung manuell einstellen.
+\item[babel,polyglossia]
+ \index{Sprachunterstützung}%
+ \index{Bezeichner}%
+ Mit dem Paket \Package{babel} erfolgt die Einstellung der im Dokument
+ verwendeten Sprache(n). Bei mehreren angegebenen Sprachen ist die zuletzt
+ geladene die Hauptsprache des Dokumentes. Die gewünschten Sprachen sollten
+ nicht als Paketoption sondern als Klassenoption und gesetzt werden, damit
+ auch andere Pakete auf die Spracheinstellungen zugreifen können. Für
+ deutschsprachige Dokumente ist die Option \Option*{ngerman} für die neue oder
+ \Option*{german} für die alte deutsche Rechtschreibung zu verwenden.
Mit dem Laden von \Package{babel} und der dazugehörigen Sprachen werden
sowohl die Trennmuster als auch die sprachabhängigen Bezeichner angepasst.
Von einer Verwendung der obsoleten Pakete \Package{german} beziehungsweise
\Package{ngerman} anstelle von \Package{babel} wird abgeraten. Für
- \hologo{LuaLaTeX} und \hologo{XeLaTeX} kann das Paket \Package{polyglossia}
+ \Engine{LuaLaTeX} und \Engine{XeLaTeX} kann das Paket \Package{polyglossia}
genutzt werden.
-\item[microtype]\index{Typografie}
+\item[microtype]
+ \index{Typografie}%
Dieses Paket kümmert sich um den optischen Randausgleich%
\footnote{englisch: protrusion, margin kerning}
und das Nivellieren der Wortzwischenräume%
\footnote{englisch: font expansion}
- im Dokument. Es funktioniert nicht mit der klassischen \hologo{TeX}-Engine,
- wohl jedoch mit \hologo{pdfTeX} als auch \hologo{LuaTeX} sowie \hologo{XeTeX}.
-\item[hyphsubst]\index{Worttrennung|!}
+ im Dokument. Es funktioniert nicht mit der klassischen \Engine*{TeX}"=Engine,
+ wohl jedoch mit \Engine{pdfTeX} als auch \Engine{LuaTeX} sowie \Engine{XeTeX}.
+\item[hyphsubst,dehyph-exptl]
+ \index{Worttrennung|!}%
Die möglichen Trennstellen von Wörtern wird von \hologo{LaTeX} mithilfe
eines Algorithmus berechnet. Dieser wird für deutschsprachige Texte mit dem
Paket \Package{hyphsubst} entscheidend verbessert. Es muss bereits \emph{vor}
@@ -223,20 +218,25 @@ sich keinerlei Wertung bezüglich ihrer Nützlichkeit oder meiner persönlichen
Wertschätzung ableiten.
\subsubsection{Typografie und Layout}
-\index{Typografie}
+\index{Typografie|(}%
+%
+Neben dem zuvor beschriebenem Paket \Package{microtype}, welches verantwortlich
+für mikrotypografische Feinheiten ist, existieren weitere Pakete, die vorrangig
+die Makrotypografie adressieren.
%
\begin{packages}
-\item[setspace]\index{Zeilenabstand}
+\item[setspace]
+ \index{Zeilenabstand}%
Die Vergrößerung des Zeilenabstandes wird:
%
\begin{enumerate}[itemindent=0pt,labelwidth=*,labelsep=1em,label=\Roman*.]
- \itempackages viel zu häufig und völlig unnötig gefordert und
- \itempackages schließlich auch noch zu groß gewählt.
+ \stditem viel zu häufig und völlig unnötig gefordert und
+ \stditem schließlich auch noch zu groß gewählt.
\end{enumerate}
%
Die Forderung nach Erhöhung des Zeilenabstandes~-- in der Typografie als
- Durchschuss bezeichnet~-- kommt noch aus den Zeiten der Textverarbeitung mit
- der Schreibmaschine. Ein einzeiliger Zeilenabstand bedeutete hier, dass die
+ Durchschuss bezeichnet~-- kommt aus den Zeiten der Textverarbeitung mit der
+ Schreibmaschine. Ein einzeiliger Zeilenabstand bedeutete hier, dass die
Unterlängen der oberen Zeile genau auf der Höhe der Oberlängen der folgenden
Zeile lagen. Ein anderthalbzeiliger Zeilenabstand erzielte hier somit einen
akzeptablen Durchschuss. Eine Erhöhung des Durchschusses bei der Verwendung
@@ -246,130 +246,191 @@ Wertschätzung ableiten.
Ist die Erhöhung des Durchschusses wirklich notwendig, sollte das Paket
\Package{setspace} genutzt werden. Dieses stellt den Befehl
- \Macro{setstretch}\Parameter{Faktor} zur Verfügung, mit dem der Durchschuss
- respektive Zeilenabstand angepasst werden kann. Der Wert des Faktors ist
- standardmäßig auf~1 gestellt und sollte maximal bis~1.25 vergrößert werden.
- Der Befehl \Macro*{onehalfspacing} aus diesem Paket setzt diesen Wert auf
- eben genau~1.25. Allerdings ist hier anzumerken, dass die Vergrößerung des
- Zeilenabstandes~-- so wie ich es mir angelesen habe~-- aus der Sicht eines
- Typographen keine Spielerei ist sondern vielmehr allein der Lesbarkeit des
- Textes dient und möglichst gering ausfallen sollte.
+ \Macro{setstretch}[\Parameter{Faktor}](\Package{setspace})'none' zur
+ Verfügung, mit dem der Durchschuss respektive Zeilenabstand angepasst werden
+ kann. Der Wert des Faktors ist standardmäßig auf~1 gestellt und sollte
+ maximal bis~1.25 vergrößert werden. Der Befehl \Macro*{onehalfspacing} aus
+ diesem Paket setzt diesen Wert auf eben genau~1.25. Allerdings ist hier
+ anzumerken, dass die Vergrößerung des Zeilenabstandes~-- so wie ich es mir
+ angelesen habe~-- aus der Sicht eines Typographen keine Spielerei ist sondern
+ vielmehr allein der Lesbarkeit des Textes dient und möglichst gering
+ ausfallen sollte.
Ziel ist es, beim Lesen nach dem Beenden der aktuellen Zeile das Auffinden
der neuen Zeile zu vereinfachen. Bei Serifen ist dies durch die Betonung der
- Grundlinie sehr gut möglich. Bei serifenlosen Schriften~-- wie der im \CD der
- \TnUD verwendeten \Univers~-- ist dies schwieriger und ein erweiterter
- Abstand der Zeilen kann dabei durchaus hilfreich sein. Jedoch sollte nicht
- nach dem Motto \enquote{viel hilft viel} verfahren werden. In diesem Dokument
- wurde als Faktor für den Zeilenabstand \Macro{setstretch}\PParameter{1.1}
- gewählt. Nach einer Einstellung des Zeilenabstandes sollte der Satzspiegel
- unbedingt mit \Macro{recalctypearea} neu berechnet werden. Weitere Tipps sind
- in \autoref{sec:tips:headings} sowie \autoref{sec:tips:headline} zu finden.
-\item[csquotes]\index{Zitate}
- Das Paket stellt unter anderem den Befehl \Macro{enquote}\Parameter{Zitat}
+ Grundlinie sehr gut möglich. Bei serifenlosen Schriften~-- wie der im \TUDCD
+ verwendeten \Univers~-- ist dies schwieriger und ein erweiterter Abstand der
+ Zeilen kann dabei durchaus hilfreich sein. Jedoch sollte nicht nach dem Motto
+ \enquote{viel hilft viel} verfahren werden. Für dieses Dokument wurde
+ \Macro{setstretch}[\PParameter{1.1}](\Package{setspace})'none' für den
+ Zeilenabstand gewählt. Weitere Tipps sind in \autoref{sec:tips:headings} und
+ \autoref{sec:tips:headline} zu finden.
+\item[multicol]
+ \index{Satzspiegel!zweispaltig|?}%
+ \index{Mehrspaltensatz}%
+ \index{Satzspiegel!mehrspaltig}%
+ Hiermit kann jeglicher beliebiger Inhalt in zwei oder mehr Spalten ausgegeben
+ werden, wobei~-- im Gegensatz zum normalen zweispaltigen Satz über die
+ \KOMAScript-Option \Option{twocolumn}(\Package{typearea})'none'~-- für einen
+ Spaltenausgleich gesorgt wird. Unterstützt wird das Paket innerhalb der
+ Umgebungen \Environment{abstract} und \Environment{tudpage}.
+\item[balance]
+ \index{Satzspiegel!zweispaltig}%
+ Dieses Paket ermöglicht einen Spaltenausgleich im zweispaltigen Satz auf der
+ letzten Dokumentseite. Alternativ dazu kann auch \Package{multicol} verwendet
+ werden.
+\item[isodate]
+ \index{Datum|?}%
+ Mit \Macro{printdate}[\Parameter{Datum}](\Package{isodate})'none' formatiert
+ dieses Paket die Ausgabe eines Datums automatisch in ein spezifiziertes
+ Format. Wird es geladen, werden alle Datumsfelder, welche durch die
+ \TUDScript-Klassen definiert wurden,%
+ \footnote{%
+ \Macro{date}, \Macro{dateofbirth} und \Macro{defensedate} sowie aus
+ \Package{tudscrsupervisor} \Macro{duedate}(\Package{tudscrsupervisor}) und
+ \Macro{issuedate}(\Package{tudscrsupervisor})%
+ }
+ in diesem Format ausgegeben.
+\item[quoting]
+ \index{Zitate}%
+ \hologo{LaTeX} bietet von Haus aus \emph{zwei} verschiedene Umgebungen~--
+ \Environment{quote}(\Package{koma-script})'none' und
+ \Environment{quotation}(\Package{koma-script})'none'~-- für Zitate und
+ ähnliches an. Allerdings werden durch beide Umgebungen die \KOMAScript-Option
+ \Option{parskip=\PName{Methode}}(\Package{koma-script})'none'|declare|
+ ignoriert. Mit der Umgebung \Environment{quoting}(\Package{quoting})'none'
+ aus dem gleichnamigen Paket lässt sich dieses Problem umgehen. Wird das Paket
+ geladen, wird diese innerhalb der \Environment{abstract}"=Umgebung verwendet.
+\item[ragged2e]
+ \index{Worttrennung}%
+ Das Paket verbessert den Flattersatz, indem für diesen die Worttrennung
+ aktiviert wird.
+\item[csquotes]
+ \index{Zitate}%
+ Das Paket stellt unter anderem den Befehl
+ \Macro{enquote}[\Parameter{Zitat}](\Package{csquotes})'none'
zur Verfügung, welcher Anführungszeichen in Abhängigkeit der gewählten
Sprache setzt. Zusätzlich werden weitere Kommandos und Optionen für die
spezifischen Anforderungen des Zitierens bei wissenschaftlichen Arbeiten
angeboten. Außerdem wird es durch \Package{biblatex} unterstützt und sollte
zumindest bei dessen Verwendung geladen werden.
\item[noindentafter]
- \ChangedAt{v2.02!\Package{noindentafter}: Beschreibung hinzugefügt}
+ \ChangedAt{v2.02:\RecPack \Package{noindentafter}}
Mit diesem Paket lassen sich automatische Absatzeinzüge für selbst zu
bestimmende Befehle und Umgebungen unterdrücken.
-\item[xspace]\index{Befehle!Deklaration}
+\item[fnpct]
+ \index{Fußnoten|?}%
+ \ChangedAt{v2.05:\RecPack \Package{fnpct}}
+ Diese Paket sorgt zum einen für das Einhalten der richtigen Reihenfolge von
+ Satzzeichen und Fußnoten und zum anderen wird das typografisch korrekte
+ Setzen mehrerer, nacheinander folgender Fußnoten unterstützt.
+\item[xspace,xpunctuate]
+ \index{Befehlsdeklaration}%
Mit \Package{xspace} kann bei der Definition eigener Makros der Befehl
- \Macro{xspace} genutzt werden. Dieser setzt ein gegebenenfalls notwendiges
- Leerzeichen automatisch. In \autoref{sec:tips:xspace} ist die Definition
- eines solchen Befehls exemplarisch ausgeführt.
-\item[ellipsis]\index{Befehle!Deklaration}
+ \Macro{xspace}(\Package{xspace})'none' genutzt werden. Dieser setzt ein
+ gegebenenfalls notwendiges Leerzeichen automatisch. In
+ \autoref{sec:tips:xspace} ist die Definition eines solchen Befehls
+ exemplarisch ausgeführt. Durch das Paket \Package{xpunctuate} wird
+ \Package{xspace} um die Beachtung von Interpunktionen erweitert.
+\item[ellipsis]
+ \index{Befehlsdeklaration}%
In \hologo{LaTeX} folgen den Befehlen für Auslassungspunkte (\Macro{dots} und
\Macro{textellipsis}) \emph{immer} ein Leerzeichen. Dies kann unter Umständen
unerwünscht sein. Mit dem Paket \Package{ellipsis} wird das nachfolgende
Leerzeichen~-- im Gegensatz zum Standardverhalten~-- nur gesetzt, wenn ein
- Satzzeichen und kein Buchstabe folgt, \seealso*{\autoref{sec:tips:dots}}.
-\item[xpunctuate]\index{Befehle!Deklaration}
- Die Funktionalität von \Package{xspace} wird um die Beachtung von
- Interpunktionen erweitert.
-\itempackages[\href{http://www.ctan.org/pkg/delig}{\Application{DeLig}}]
- \index{Typografie}\index{Ligaturen}
+ Satzzeichen und kein Buchstabe folgt, \seeref*{\autoref{sec:tips:dots}}.
+\stditem[\Application{DeLig}<delig>,\Package{selnolig}]
+ \index{Ligaturen}%
Hierbei handelt es sich um ein Java-Script, welches anhand eines Wörterbuches
falsche Ligaturen innerhalb eines Dokumentes automatisiert entfernt. Wird
\Univers verwendet ist dies jedoch nicht notwendig, da diese keinerlei
Ligaturen enthält, die insbesondere in deutschen Texten für einen guten Satz
manuell aufgelöst werden müssten.%
\footnote{%
- Das sind ff, fi, fl, ffi, und ffl bei den \hologo{LaTeX}"=Standardschriften.
+ Das sind \enquote{ff}, \enquote{fi}, \enquote{fl}, \enquote{ffi}, und
+ \enquote{ffl} bei den \hologo{LaTeX}"=Standardschriften.%
}
- Mit \hologo{LuaLaTeX} als Dokumentprozessor kann alternativ dazu auch
- \Package{selnolig} verwendet werden.
-\item[balance]\index{Zweispaltensatz}
- Dieses Paket ermöglicht einen Spaltenausgleich im Zweispaltensatz auf der
- letzten Dokumentseite. Alternativ dazu kann auch \Package{multicol} verwendet
- werden.
+ Mit \Engine{LuaLaTeX} als Textsatzsystem kann auch \Package{selnolig}
+ alternativ dazu verwendet werden.
+\index{Typografie|)}%
\end{packages}
+
\subsubsection{Rechtschreibung}
+\index{Rechtschreibung|(}%
+%
Für die Rechtschreibkontrolle zeichnet im Normalfall der verwendete Editor
verantwortlich. Dennoch gibt es einige wenige Pakete, welche sich diesem Thema
-widmen. Diese sind jedoch lediglich nutzbar, wenn \hologo{LuaLaTeX} als
-Dokumentprozessor genutzt wird.
+widmen. Diese sind jedoch ausschließlich nutzbar, wenn als Textsatzsystem
+\Engine{LuaLaTeX} genutzt wird.
\begin{packages}
-\item[lua-check-hyphen]\index{Worttrennung}
- Hiermit lassen sich mit \hologo{LuaLaTeX} Trennstellen am Zeilenende zur
+\item[lua-check-hyphen]
+ \index{Worttrennung}%
+ Hiermit lassen sich mit \Engine{LuaLaTeX} Trennstellen am Zeilenende zur
Prüfung markieren. Zum Thema der \textit{korrekten Worttrennung} sei außerdem
auf \autoref{sec:tips:hyphenation} verwiesen.
-\item[spelling]\index{Rechtschreibung}
- Wird \hologo{LuaLaTeX} als Prozessor verwendet, wird mit diesem Paket der
- reine Textanteil aus dem \hologo{LaTeX}"~Dokument extrahiert~-- wobei Makros
- und aktive Zeichen entfernt werden~-- und in eine separate Textdatei
- geschrieben. Anschließend kann diese Datei mit einer externen Software zur
- Rechtschreibprüfung wie \Application{GNU Aspell} oder \Application{Hunspell}
- analysiert werden. Wird durch dieses Programm eine Liste falsch geschriebener
- Wörter ausgegeben, können diese mit \Package{spelling} im PDF"~Dokument
- hervorgehoben werden.
+\item[spelling]
+ Wird \Engine{LuaLaTeX} als Textsatzsystem verwendet, wird mit diesem Paket
+ der reine Textanteil aus dem \hologo{LaTeX}"~Dokument extrahiert~-- wobei
+ Makros und aktive Zeichen entfernt werden~-- und in eine separate Textdatei
+ geschrieben. Anschließend kann diese Datei mit einer externen Software zur
+ Rechtschreibprüfung wie \Application{GNU~Aspell}, \Application{Hunspell} oder
+ \Application{LanguageTool} analysiert und falsch geschriebene Wörter im
+ PDF"~Dokument hervorgehoben werden.
+\index{Rechtschreibung|)}%
\end{packages}
+
\subsubsection{Schriften und Sonderzeichen}
\begin{packages}
-\item[lmodern](lm)\index{Schriftart}
+\item[lmodern]<lm>
+ \index{Schriftart}%
Soll mit den klassischen \hologo{LaTeX}"=Standardschriften gearbeitet werden,
empfiehlt sich die Verwendung des Paketes \Package{lmodern}. Dieses
verbessert die Darstellung der Computer~Modern sowohl am Bildschirm als auch
beim finalen Druck.
-\item[cfr-lm]\index{Schriftart}
+\item[cfr-lm]
+ \index{Schriftart}%
Dieses experimentelle Paket liefert weitere Schriftschnitte für das Paket
\Package{lmodern}.
-\item[newtx]
+\item[newtx,newtxmath]<newtx>
+ \index{Schriftart}%
+ \index{Mathematiksatz}%
Es werden einige alternative Schriften sowohl für den Fließtext
(\textit{Times} und \textit{Helvetica}) als auch den Mathematikmodus
bereitgestellt.
-\item[libertine]\index{Schriftart}
+\item[libertine]
+ \index{Schriftart}%
Das Paket stellt die Schriften Linux~Libertine und Linux~Biolinum zur
Verfügung. Um diese Schriftart auch für den Mathematikmodus verwenden zu
- können, sollte \Package{newtxmath} aus dem \Package{newtx}-Bundle mit
- \Macro*{usepackage}\POParameter{libertine}\PParameter{newtxmath} in der
+ können, sollte \Package{newtxmath} aus dem \Package{newtx}"=Bundle mit
+ \Macro*{usepackage}[\POParameter{libertine}\PParameter{newtxmath}] in der
Präambel eingebunden werden. Das Paket \Package{libgreek} enthält griechische
Buchstaben für Linux~Libertine.
-\item[mweights]\index{Schriftstärke}
- In \hologo{LaTeXe} existieren die drei Schriftfamilien für Serifenschriften
- (\Macro{rmfamily}), serifenlose Schriften (\Macro{sffamily}) sowie die
- Schreibmaschinenschriften (\Macro{ttfamily}). Deren Schriftstärke wird für
- gewöhnlich mit den beiden Befehlen \Macro{mddefault} und \Macro{bfdefault}
+\item[mweights]
+ \index{Schriftstärke}%
+ In \hologo{LaTeXe} existieren die Schriftfamilien für Serifenschriften
+ (\Macro*{rmfamily}), serifenlose Schriften (\Macro*{sffamily}) sowie die
+ Schreibmaschinenschriften (\Macro*{ttfamily}). Deren Schriftstärke wird für
+ gewöhnlich mit den beiden Befehlen \Macro*{mddefault} und \Macro*{bfdefault}
einheitlich festgelegt. Bei der Verwendung unterschiedlicher Schriftpakete
kann es unter Umständen zu Problemen bei den Schriftstärken kommen. Das Paket
\Package{mweights} erlaubt die individuelle Definition der Schriftstärke für
jede der drei Schriftfamilien.
\item[fontspec]
- \ChangedAt{v2.02!\Package{fontspec}: Beschreibung hinzugefügt}%
- Wird als Dokumentprozessor nicht \hologo{pdfLaTeX} sondern \hologo{XeLaTeX}
- oder \hologo{LuaLaTeX} verwendet, können mit diesem Paket Systemschriften im
- OpenType-Format eingebunden werden, womit sich die Auswahl der verwendbaren
- Schriften in einem \hologo{LaTeX}"=Dokument stark erweitert. Das Paket wird
- durch \TUDScript unterstützt.
-\item[relsize]\index{Schriftgröße}
+ \index{Zeichensatzkodierung}%
+ \ChangedAt{v2.02:\RecPack \Package{fontspec}}%
+ Wird als Textsatzsystem nicht \Engine{pdfLaTeX} sondern \Engine{XeLaTeX}
+ oder \Engine{LuaLaTeX} verwendet, können mit diesem Paket Systemschriften im
+ OpenType-Format und einer beliebigen Zeichensatzkodierung eingebunden werden,
+ womit sich die Auswahl der verwendbaren Schriften stark erweitert. Das Paket
+ wird durch \TUDScript unterstützt.
+\item[relsize]
+ \index{Schriftgröße}%
Die Größe einer Textauszeichnung kann relativ zur aktuellen Schriftgröße
gesetzt werden.
-\item[textcomp]\index{Sonderzeichen}
+\item[textcomp]
+ \index{Sonderzeichen}%
Es werden zusätzliche Symbole und Sonderzeichen wie beispielsweise das
Promille- oder Eurozeichen sowie Pfeile für den Fließtext zur Verfügung
gestellt.
@@ -377,12 +438,13 @@ Dokumentprozessor genutzt wird.
%
Auch für (serifenlose) Mathematikschriften gibt es einige nützliche Pakete.
Werden die Schriften des \CDs genutzt, sei auf die Option \Option{cdmath}
-verwiesen.\index{Mathematiksatz!Schrift}\index{Schrift!Mathematiksatz}
+verwiesen.
%
\begin{packages}
-\item[sansmathfonts]
- Sollten die normalen \hologo{LaTeX}-Schriften Computer~Modern verwendet
- werden, kann man dieses Paket zum serifenlosen Setzen mathematischer
+\index{Mathematiksatz|(}%
+\item[sansmathfonts,sansmath]
+ Sollten die normalen \hologo{LaTeX}"=Schriften Computer~Modern verwendet
+ werden, lässt sich dieses Paket zum serifenlosen Setzen mathematischer
Ausdrücke nutzen. Ein alternatives Paket mit der gleichen Zielstellung ist
\Package{sansmath}
\item[sfmath]
@@ -391,21 +453,20 @@ verwiesen.\index{Mathematiksatz!Schrift}\index{Schrift!Mathematiksatz}
entsprechenden Option auch für Latin~Modern, Helvetica und
Computer~Modern~Bright verwendet werden.
\item[mathastext]
- Mit dem Paket wird das Ziel verfolgt, aus der genutzten Schrift für den
- Fließtext alle notwendigen Zeichen für den Mathematiksatz zu extrahieren.
+ Mit dem Paket wird das Ziel verfolgt, aus der genutzten Schrift für den
+ Fließtext alle notwendigen Zeichen für den Mathematiksatz zu extrahieren.
\end{packages}
\subsubsection{Mathematiksatz}
-\index{Mathematiksatz}
Dies sind Pakete, die Umgebungen und Befehle für den Mathematiksatz sowie das
Setzen von Einheiten und Zahlen im Allgemeinen anbieten.
\begin{packages}
- \item[mathtools]
+ \item[mathtools,amsmath]
Dieses Paket stellt für das De-facto-Standard-Paket \Package{amsmath} für
Mathematikumgebungen Bugfixes zur Verfügung und erweitert dieses.
\item[bm]
- Das Paket bietet mit \Macro{bm} eine Alternative zu \Macro{boldsymbol} im
+ Das Paket bietet mit \Macro*{bm} eine Alternative zu \Macro*{boldsymbol} im
\hrfn{http://tex.stackexchange.com/questions/3238}{Mathematiksatz}.
\end{packages}
%
@@ -413,7 +474,8 @@ Für das typografisch korrekte Setzen von Einheiten~-- ein halbes Leerzeichen
zwischen Zahl und \emph{aufrecht} gesetzter Einheit~-- gibt es zwei gut
nutzbare Pakete.
%
-\begin{packages}\index{Einheiten}
+\begin{packages}
+\index{Einheiten|(}%
\item[units]
Dies ist ein einfaches und sehr zweckdienliches Paket zum Setzen von
Einheiten und für die meisten Anforderungen völlig ausreichend.
@@ -423,6 +485,7 @@ nutzbare Pakete.
Die Ausgabe lässt sich in vielerlei Hinsicht an individuelle Bedürfnisse
anpassen. Für deutschsprachige Dokumenten sollte die Lokalisierung angegeben
werden. Mehr dazu in \autoref{sec:tips:siunitx}.
+\index{Einheiten|)}%
\end{packages}
%
Die korrekte Formatierung von Zahlen ist häufig ein Problem bei der Verwendung
@@ -431,7 +494,8 @@ Daten im englischsprachigen Format verwendet werden, kommt es zu Problemen.
Dafür wird im \TUDScript-Bundle das Paket \Package{mathswap} bereitgestellt.
Dennoch gibt es zu diesem auch Alternativen.
%
-\begin{packages}\index{Trennzeichen}
+\begin{packages}
+\index{Zifferngruppierung|(}%
\item[icomma]
Wird im Mathematikmodus nach dem Komma ein Leerzeichen gesetzt, wird dies
bei der Ausgabe beachtet. Der Verfasser muss sich demzufolge jederzeit
@@ -445,13 +509,16 @@ Dennoch gibt es zu diesem auch Alternativen.
Dieses Paket ist mir tatsächlich erst bei der Arbeit an \Package{mathswap}
bekannt geworden. Es bietet mehr Funktionalitäten und kann als Alternative
dazu betrachtet werden.
+\index{Zifferngruppierung|)}%
\end{packages}
%
Weitere Hinweise und Anwendungsfälle zur mathematischen Typografie werden in
\autoref{sec:exmpl:mathtype} sowie \autoref{sec:exmpl:mathswap} gegeben.
+\index{Mathematiksatz|)}%
\subsubsection{Verzeichnisse aller Art}
-\index{Verzeichnisse|?}
+\index{Verzeichnisse|?(}%
+%
Neben dem Erstellen des eigentlichen Dokumentes sind für eine wissenschaftliche
Arbeit meist auch allerhand Verzeichnisse gefordert. Fester Bestandteil ist
dabei das Literaturverzeichnis, auch ein Abkürzungs- und Formelzeichen-
@@ -462,7 +529,8 @@ und für diese auch gleich ein entsprechendes Verzeichnis generiert werden, so
sei auf das Paket \Package{listings}'full' verwiesen.
\begin{packages}
-\item[biblatex]\index{Literaturverzeichnis}
+\item[biblatex]
+ \index{Literaturverzeichnis}%
Das Paket kann als legitimer Nachfolger zu \hologo{BibTeX} gesehen werden.
Ähnlich dazu bietet \Package{biblatex} die Möglichkeit, Literaturdatenbanken
einzubinden und verschiedene Stile der Referenzierung und Darstellung des
@@ -474,41 +542,54 @@ sei auf das Paket \Package{listings}'full' verwiesen.
UTF"~8-kodierten Literaturdatenbank problemlos möglich. In Verbindung mit
\Package{biblatex} wird die zusätzliche Nutzung des Paketes
\Package{csquotes} sehr empfohlen.
-\item[acro]\index{Abkürzungsverzeichnis}
+\item[acro,acronym]
+ \index{Abkürzungsverzeichnis}%
Soll lediglich ein Abkürzungsverzeichnis erstellt werden, ist dieses Paket
die erste Wahl. Es stellt Befehle zur Definition von Abkürzungen sowie zu
deren Verwendung im Text und zur sortierten Ausgabe eines Verzeichnisses
bereit. Alternativ dazu kann das Paket \Package{acronym} verwendet werden.
Die Sortierung des Abkürzungsverzeichnisses muss hier allerdings manuell
durch den Anwender erfolgen.
-\item[glossaries]\index{Glossar}\index{Abkürzungsverzeichnis}%
- \index{Formelzeichenverzeichnis}\index{Symbolverzeichnis}%
+\item[glossaries,nomencl]
+ \index{Glossar}%
+ \index{Abkürzungsverzeichnis}%
+ \index{Formelzeichenverzeichnis}%
+ \index{Symbolverzeichnis}%
Dies ist ein sehr mächtiges Paket zum Erstellen eines Glossars sowie
Abkürzungs- und Symbolverzeichnisses. Die mannigfaltige Anzahl an Optionen
ist zu Beginn eventuell etwas abschreckend. Insbesondere wenn Verzeichnisse
- für Abkürzungen \emph{und} Formelzeichen beziehungsweise Symbole benötigt
- werden, sollte man dieses Paket in Erwägung ziehen.
+ für Abkürzungen \emph{und} Formelzeichen beziehungsweise Symbole notwendig
+ sind, sollte dieses Paket in Erwägung gezogen werden.
Alternativ dazu kann für ein Symbolverzeichnis auch lediglich eine manuell
gesetzte Tabelle genutzt werden. Das hierfür sehr häufig empfohlene Paket
\Package{nomencl} bietet meiner Meinung nach demgegenüber keinerlei Vorteile.
+\index{Verzeichnisse|?)}%
\end{packages}
+
\subsubsection{Listen}
-\index{Listen|?}
+\index{Listen|?(}%
+%
\begin{packages}
\item[enumitem]
Das Paket \Package{enumitem} erweitert die rudimentären Funktionalitäten der
- \hologo{LaTeX}"=Standardlisten \Environment{itemize}, \Environment{enumerate}
- sowie \Environment{description} und ermöglicht die individuelle Anpassung
- dieser durch die Bereitstellung vieler optionale Parameter nach dem
- Schlüssel"=Wert"=Prinzip. Eine von mir sehr häufig genutzte Funktion ist
- beispielsweise die Entfernung des zusätzlichen Abstand zwischen den einzelnen
- Einträgen einer Liste mit \Macro{setlist}\PParameter{noitemsep}.
+ \hologo{LaTeX}"=Standardlisten
+ \Environment{itemize}(\Package{koma-script},\Package{enumitem})'none',
+ \Environment{enumerate}(\Package{koma-script},\Package{enumitem})'none' sowie
+ \Environment{description}(\Package{koma-script},\Package{enumitem})'none' und
+ ermöglicht die individuelle Anpassung dieser durch die Bereitstellung vieler
+ optionale Parameter nach dem Schlüssel"=Wert"=Prinzip. Eine von mir sehr
+ häufig genutzte Funktion ist beispielsweise die Entfernung des zusätzlichen
+ Abstand zwischen den einzelnen Einträgen einer Liste mit
+ \Macro{setlist}[\PParameter{noitemsep}](\Package{enumitem})'none'.
+\index{Listen|?)}%
\end{packages}
+
\subsubsection{Tabellen}
-\index{Tabellen|?}
+\index{Tabellen|?(}%
+%
Für den Tabellensatz in \hologo{LaTeX} werden von Haus aus die Umgebungen
\Environment{tabbing} und \Environment{tabular} beziehungsweise
\Environment{tabular*} bereitgestellt, welche in ihrer Funktionalität meist
@@ -516,35 +597,39 @@ für einen qualitativ hochwertigen Tabellensatz nicht ausreichen. Es werden
deshalb Pakete vorgestellt, die zusätzlich verwendet werden können.
\begin{packages}
\item[array]
- Dieses Paket ermöglicht mit dem Befehl \Macro{newcolumntype} das Erstellen
- eigener Spaltentypen sowie die erweiterte Definition von Tabellenspalten
- (\PValue{>\{\dots\}}\PName{Spaltentyp}\PValue{<\{\dots\}}), wobei mithilfe
- sogenannter \enquote{Hooks} vor und nach Einträgen innerhalb einer Spalte
- gezielt Anweisungen gesetzt werden können. Außerdem kann die Höhe der Zeilen
- einer Tabelle mit \Macro{extrarowheight} angepasst werden.
+ Dieses Paket ermöglicht mit \Macro{newcolumntype}(\Package{array})'none' das
+ Erstellen neuer Spaltentypen und die erweiterte Definition von Tabellenspalten
+ (\PValue{>\PParameter{\dots}}\PName{Spaltentyp}\PValue{<\PParameter{\dots}}),
+ wobei mithilfe sogenannter \enquote{Hooks} vor und nach Einträgen innerhalb
+ einer Spalte gezielt Anweisungen gesetzt werden können. Außerdem kann die
+ Zeilenhöhe einer Tabelle mit \Macro{extrarowheight}(\Package{array})'none'
+ angepasst werden.
\item[multirow]
- Es wird der Befehl \Macro{multirow} definiert, der~-- ähnlich zum Makro
- \Macro{multicolumn}~-- das Zusammenfassen von mehreren Zeilen in einer
- Spalte ermöglicht.
+ Es wird der Befehl \Macro{multirow}(\Package{multirow})'none' definiert, der
+ das Zusammenfassen von mehreren Zeilen in einer Spalte ermöglicht~-- ähnlich
+ zum Makro \Macro{multicolumn} für Spalten.
\item[widetable]
Mit der Standard"=\hologo{LaTeX}"=Umgebung \Environment{tabular*} kann eine
Tabelle mit einer definierten Breite gesetzt werden. Dieses Paket stellt die
- Umgebung \Environment{widetable} zur Verfügung, die als Alternative genutzt
- werden kann und eine symmetrische Tabelle erzeugt.
+ Umgebung \Environment{widetable}(\Package{widetable})'none' zur Verfügung,
+ die als Alternative genutzt werden kann und eine symmetrische Tabelle erzeugt.
\item[booktabs]
Für einen guten Tabellensatz mit \hologo{LaTeX} gibt es bereits zahlreiche
\hrfn{http://userpage.fu-berlin.de/latex/Materialien/tabsatz.pdf}{Tipps} im
Internet zu finden. Zwei Regeln sollten dabei definitiv beachtet werden:
%
\begin{enumerate}[itemindent=0pt,labelwidth=*,labelsep=1em,label=\Roman*.]
- \itempackages keine vertikalen Linien
- \itempackages keine doppelten Linien
+ \stditem keine vertikalen Linien
+ \stditem keine doppelten Linien
\end{enumerate}
%
Das Paket \Package{booktabs} (deutsche Dokumentation \Package*{booktabs-de})
ist für den Satz von hochwertigen Tabellen eine große Hilfe und stellt die
- Befehle \Macro{toprule}, \Macro{midrule} sowie \Macro{cmidrule} und
- \Macro{bottomrule} für unterschiedliche horizontale Linien bereit.
+ Befehle \Macro{toprule}(\Package{booktabs})'none',
+ \Macro{midrule}(\Package{booktabs})'none' sowie
+ \Macro{cmidrule}(\Package{booktabs})'none' und
+ \Macro{bottomrule}(\Package{booktabs})'none'
+ für unterschiedliche horizontale Linien bereit.
\item[tabularborder]
Bei Tabellen wird zwischen Spalten automatisch ein horizontaler Abstand
(\Length{tabcolsep}) gesetzt~-- besser gesagt jeweils vor und nach einer
@@ -561,8 +646,9 @@ deshalb Pakete vorgestellt, die zusätzlich verwendet werden können.
\item[tabularx]
Auch mit diesem Paket kann die Gesamtbreite einer Tabelle spezifiziert
werden. Dafür wird der Spaltentyp \PValue{X} definiert, welcher als Argument
- der \Environment{tabularx}"=Umgebung beliebig häufig angegeben werden kann
- (\Macro*{begin}\PParameter{tabularx}\Parameter{Breite}\Parameter{Spalten}).
+ der \Environment{tabularx}(\Package{tabularx})'none'"=Umgebung beliebig
+ häufig angegeben werden kann
+ (\Macro*{begin}[\PParameter{tabularx}\Parameter{Breite}\Parameter{Spalten}]).
Die \PValue{X}"~Spalten ähneln denen vom Typ~\PValue{p}\Parameter{Breite},
wobei die Breite dieser aus der gewünschten Tabellengesamtbreite und dem
benötigten Platz der gegebenenfalls vorhandenen Standardspalten automatisch
@@ -571,63 +657,70 @@ deshalb Pakete vorgestellt, die zusätzlich verwendet werden können.
Dies ist ein weiteres Paket zur automatischen Berechnung von Spaltenbreiten.
Der zur Verfügung stehende Platz~-- gewünschte Gesamtbreite abzüglich der
notwendigen Breite für die Standardspalten~-- wird jedoch nicht wie bei der
- Umgebung \Environment{tabularx} auf alle Spalten gleichmäßig verteilt sondern
- in der \Environment{tabulary}"=Umgebung für die Spaltentypen~\PValue{LCRJ}
- anhand ihres Zellinhaltes gewichtet vergeben.
- (\Macro*{begin}\PParameter{tabulary}\Parameter{Breite}\Parameter{Spalten}).
-\item[longtable]
+ Umgebung \Environment{tabularx}(\Package{tabularx})'none' auf alle Spalten
+ gleichmäßig verteilt sondern in der
+ \Environment{tabulary}(\Package{tabulary})'none'"=Umgebung für die
+ Spaltentypen~\PValue{LCRJ} anhand ihres Zellinhaltes gewichtet vergeben.
+ (\Macro*{begin}[\PParameter{tabulary}\Parameter{Breite}\Parameter{Spalten}]).
+\item[longtable,ltablex]
Sollen mehrseitige Tabellen mit Seitenumbruch erstellt werden, ist dieses
Paket das Mittel der ersten Wahl. Für die Kombination mehrseitiger Tabellen
- mit einer \Environment{tabularx}"=Umgebung können die Pakete
- \Package{ltablex} oder besser noch \Package{ltxtable} verwendet werden.
+ mit einer \Environment{tabularx}(\Package{tabularx})'none'"=Umgebung können
+ die Pakete \Package{ltablex} oder besser noch \Package{ltxtable} verwendet
+ werden.
\item[ltxtable]
Wie bereits erwähnt sollte dieses Paket für mehrseitige Tabellen, die mit der
- Umgebung \Environment{tabularx} erstellt wurden, verwendet werden.
- Alternativ dazu kann man auch \Package{tabu} nutzen.
+ Umgebung \Environment{tabularx}(\Package{tabularx})'none' erstellt wurden,
+ verwendet werden. Alternativ dazu lässt sich auch \Package{tabu} nutzen.
\item[tabu]
- \ChangedAt{v2.02!\Package{tabu}: Verwendung nur bedingt empfehlenswert}
+ \ChangedAt{%
+ v2.02:\RecPack \Package{tabu} ist nur bedingt empfehlenswert
+ }
Dies ist ein relativ neues Paket, welches versucht, viele der zuvor genannten
Funktionalitäten zu implementieren und weitere bereitzustellen. Dafür werden
- die Umgebungen \Environment{tabu} und \Environment{longtabu} definiert. Es
+ die Umgebungen \Environment{tabu}(\Package{tabu})'none' und
+ \Environment{longtabu}(\Package{tabu})'none' definiert. Es
kann alternativ zu \Package{tabularx} verwendet werden und ist insbesondere
als Ersatz für das Paket \Package{ltxtable} empfehlenswert.
\Attention{%
- Leider wären für das Paket in der aktuellen Version~v2.8 seit geraumer Zeit
- ein paar kleinere Bugfixes notwendig. Außerdem wird sich die
+ Leider wären für das Paket in der Version~v2.8 seit geraumer Zeit ein paar
+ Bugfixes notwendig. Außerdem wird sich die
\hrfn{https://groups.google.com/d/topic/comp.text.tex/xRGJTC74uCI}{%
- Benutzerschnittstelle in einer zukünftigen Version
- } sehr stark ändern, weshalb es momentan mit Vorsicht zu genießen ist.
- Zumindest sollte sich der Anwender bewusst sein, dass er mit dieser Version
- gesetzte Dokumente gegebenenfalls später anpassen muss.
+ Benutzerschnittstelle in einer zukünftigen Version%
+ }
+ sehr stark ändern. Der Anwender sollte sich zumindest bewusst sein, dass er
+ mit der Version~v2.8 gesetzte Dokumente gegebenenfalls später anpassen muss.
}%
+\index{Tabellen|?)}%
\end{packages}
\subsubsection{Gleitobjekte}
-\index{Gleitobjekte|?}
-\index{Tabellen}\index{Grafiken}
+\index{Gleitobjekte|?(}%
+%
Es werden Pakete für die Beeinflussung von Aussehen, Beschriftung und
Positionierung von Gleitobjekten vorgestellt. Unter \autoref{sec:tips:floats}
sind außerdem Hinweise zur manuellen Manipulation der Gleitobjektplatzierung zu
finden.
\begin{packages}
-\item[placeins]\index{Gleitobjekte!Platzierung}
+\item[placeins]
Mit diesem Paket kann die Ausgabe von Gleitobjekten vor Kapiteln und wahlweise
Unterkapiteln erzwungen werden.
-\item[flafter]\index{Gleitobjekte!Platzierung}
+\item[flafter]
Dieses Paket erlaubt die frühestmögliche Platzierung von Gleitobjekten im
ausgegeben Dokument erst an der Stelle ihres Auftretens im Quelltext. Diese
werden dementsprechend nie vor ihrer Definition am Anfang der Seite
erscheinen.
-\item[caption]\index{Gleitobjekte!Beschriftung}
- Die \KOMAScript-Klassen bietet bereits einige Möglichkeiten zum Setzen der
- Beschriftungen für Gleitobjekte. Dieses Paket ist daher meist nur in gewissen
- Ausnahmefällen für spezielle Anweisungen notwendig, allerdings auch bei der
- Verwendung unbedenklich.
-\item[subcaption]\index{Gleitobjekte!Beschriftung}
+\item[caption]
+ Mit der Option \Option{captions=\PSet}(\Package{koma-script})'none'|declare|
+ bieten die \KOMAScript-Klassen bereits einige Möglichkeiten zum Formatieren
+ der Beschriftungen für Gleitobjekte. Dieses Paket ist daher meist nur in
+ gewissen Ausnahmefällen für spezielle Anweisungen notwendig, allerdings auch
+ bei der Verwendung unbedenklich.
+\item[subcaption]
Diese Paket kann zum einfachen Setzen von Unterabbildungen oder "~tabellen
mit den entsprechenden Beschriftungen genutzt werden. Das dazu alternative
Paket \Package{subfig} sollte vermieden werden, da es nicht mehr gepflegt
@@ -635,60 +728,68 @@ finden.
Problemen kommt. Sollte der Funktionsumfang von \Package{subcaption} nicht
ausreichen, kann anstelle dessen das Paket \Package{floatrow} verwendet
werden, welches ähnliche Funktionalitäten wie \Package{subfig} bereitstellt.
-\item[floatrow]\index{Gleitobjekte!Beschriftung}
+\item[floatrow]
Mit diesem Paket können global wirksame Einstellungen und Formatierungen für
- \emph{alle} Gleitobjekte eines Dokumentes vorgenommen werden. So kann unter
- anderem die verwendete Schrift (\Macro{floatsetup}\PParameter{font=\dots})
- innerhalb der Umgebungen \Environment{float} und \Environment{table}
- eingestellt werden. Das typografisch richtige Setzen der Beschriftungen von
- Abbildungen als Unterschriften
- (\Macro{floatsetup}\POParameter{figore}\PParameter{capposition=bottom})
- sowie Tabellen als Überschriften
- (\Macro{floatsetup}\POParameter{table}\PParameter{capposition=top})
+ \emph{alle} Gleitobjekte eines Dokumentes über die Paketoptionen oder mit
+ \Macro{floatsetup}[\PParameter{\dots}](\Package{floatrow})'none'
+ vorgenommen werden. So kann unter anderem die verwendete Schrift innerhalb
+ der Umgebungen \Environment{figure} und \Environment{table} eingestellt
+ werden (\Macro*{floatsetup}[\PParameter{font=\dots}]). Das typografisch
+ richtige Setzen von Abbildungs\textbf{unterschriften}
+ \Macro*{floatsetup}[\POParameter{figure}\PParameter{capposition=bottom}])
+ sowie Tabellen\textbf{überschriften}
+ (\Macro*{floatsetup}[\POParameter{table}\PParameter{capposition=top}])
kann automatisch erzwungen werden~-- unabhängig von der Position des Befehls
- zur Beschriftung \Macro{caption} innerhalb der Gleitobjektumgebung. Wird das
- Verhalten so wie empfohlen mit dem \Package{floatrow}-Paket eingestellt,
- sollte für eine richtige Platzierung der Tabellenüberschriften außerdem die
- \KOMAScript-Option \Option{captions}[tableheading] genutzt werden.
+ zur Beschriftung
+ \Macro{caption}(\Package{koma-script},\Package{caption})'none'
+ innerhalb der Gleitobjektumgebung. Wird das Verhalten so wie empfohlen mit
+ dem \Package{floatrow}"=Paket eingestellt, sollte für eine richtige
+ Platzierung der Tabellenüberschriften außerdem die \KOMAScript-Option
+ \Option{captions=tableheading}(\Package{koma-script})'none'
+ genutzt werden.
+\index{Gleitobjekte|?)}%
\end{packages}
+
\subsubsection{Grafiken und Abbildungen}
-\index{Grafiken|?}
+\index{Grafiken|?(}%
+%
Grafiken für wissenschaftliche Arbeiten sollten als Vektorgrafiken erstellt
werden, um die Skalierbarkeit und hohe Druckqualität zu gewährleisten.
Bestenfalls folgen diese auch dem Stil der dazugehörigen Arbeit.%
\footnote{%
Für qualitativ hochwertige Dokumente sollten übernommene Grafiken nicht
direkt kopiert oder gescannt sondern im gewünschten Zielformat neu erstellt
- und mit der Referenz auf die Quelle ins Dokument eingebunden werden.
+ und mit einer Referenz auf die Quelle eingebunden werden.%
}
Für das Erstellen eigener Vektorgrafiken, welche die \hologo{LaTeX}"=Schriften
und das Layout des Hauptdokumentes nutzen, gibt es zwei mögliche Ansätze.
-Entweder man \enquote{programmiert} die Grafiken ähnlich wie das Dokument
-selber oder man nutzt Zeichenprogramme, die wiederum die Ausgabe oder das
-Weiterreichen von Text an \hologo{LaTeX} unterstützen. Für das Programmieren
+Entweder die Grafiken werden ähnlich wie das Dokument \enquote{programmiert}
+oder Zeichenprogramme, welche wiederum die Ausgabe oder das Weiterreichen von
+Text an \hologo{LaTeX} unterstützen, werden genutzt. Für das Programmieren
von Grafiken sollen hier die wichtigsten Pakete vorgestellt werden. Wie diese
zu verwenden sind, ist den dazugehörigen Paketdokumentationen zu entnehmen.
Außerdem wird im Tutorial \Tutorial{treatise} für beide Pakete jeweils ein
Beispiel gegeben.
\begin{packages}
-\item[tikz](pgf)
+\item[tikz]<pgf>
Dies ist ein sehr mächtiges Paket für das Programmieren von Vektorgrafiken
und sehr häufig~-- insbesondere bei Einsteigern~-- die erste Wahl bei der
- Verwendung von \hologo{pdfLaTeX}.
+ Verwendung von \Engine{pdfLaTeX}.
\item[pstricks]
Das Paket \Package{pstricks} stellt die zweite Variante zum Programmieren
- von Grafiken dar. Mit diesem Paket hat man \emph{noch} mehr Möglichkeiten bei
- der Erstellung eigener Grafiken, da man mit \Package{pstricks} auf
- PostScript zugreifen kann und einige der bereitgestellten Befehle davon rege
+ von Grafiken dar. Mit diesem Paket existieren \emph{noch} mehr Möglichkeiten
+ bei der Erstellung eigener Grafiken, da mit \Package{pstricks} auf PostScript
+ zugegriffen werden kann und einige der bereitgestellten Befehle davon rege
Gebrauch machen. Der daraus resultierende Nachteil ist, dass mit
- \Package{pstricks} die direkte Verwendung von \hologo{pdfLaTeX} nicht
+ \Package{pstricks} die direkte Verwendung von \Engine{pdfLaTeX} nicht
möglich ist.
- Die Grafiken aus den \Environment{pspicture}"=Umgebungen müssen deshalb erst
+ Die Grafiken aus den Umgebungen
+ \Environment{pspicture}(\Package{pstricks})'none' müssen deshalb zunächst
über den Pfad \Path{latex \textrightarrow{} dvips \textrightarrow{} ps2pdf}
- in PDF"~Dateien gewandelt werden. Diese lassen sich von \hologo{pdfLaTeX}
+ in PDF"~Dateien gewandelt werden. Diese lassen sich von \Engine{pdfLaTeX}
anschließend als Abbildungen einbinden. Um dieses Vorgehen zu ermöglichen,
können folgende Pakete genutzt werden:
%
@@ -698,14 +799,14 @@ Beispiel gegeben.
PDF-Datien bereit. Die einzelnen Aufrufe zur Kompilierung von DVI über
PostScript zu PDF müssen durch den Anwender manuell beziehungsweise über
die Ausgaberoutinen des verwendeten Editors durchgeführt werden.
- \item[auto-pst-pdf]
+ \item[auto-pst-pdf,pdftricks2]
Das Paket automatisiert die Erzeugung der \Package{pstricks}"=Grafiken mit
- dem Paket \Package{pst-pdf}. Dafür muss \hologo{pdfLaTeX} per Option mit
+ dem Paket \Package{pst-pdf}. Dafür muss \Engine{pdfLaTeX} per Option mit
Schreibrechten ausgeführt werden. Dazu ist der Aufruf von \Path{pdflatex}
- mit der Option \Path{-{}-shell-escape} beziehungsweise für Nutzer von
- \Distribution{\hologo{MiKTeX}} mit \Path{-{}-enable-write18} notwendig.
- Bitte beachten Sie die Hinweise in \autoref{sec:tips:auto-pst-pdf}. Eine
- Alternative dazu ist das Paket \Package{pdftricks2}.
+ mit der Option \Path{-{}-shell-escape} respektive \Path{-{}-enable-write18}
+ notwendig. Bitte beachten Sie dazu ebenfalls die Hinweise in
+ \autoref{sec:tips:auto-pst-pdf}. Eine Alternative dazu ist das Paket
+ \Package{pdftricks2}.
\end{packages}
\end{packages}
%
@@ -718,41 +819,84 @@ Für das Zeichnen einer Grafik mit einem Bildbearbeitungsprogramm, welches die
Weiterverarbeitung durch \hologo{LaTeX} erlaubt, möchte ich auf die freien
Programme \Application{LaTeXDraw} und \Application{Inkscape} verweisen.
Insbesondere das zuletzt genannte Programm ist sehr empfehlenswert. Für die
-erstellten Grafiken kann man den Export für die Einbindung in \hologo{LaTeX}
-manuell durchführen. In \autoref{sec:tips:svg} wird vorgestellt, wie sich dies
-automatisieren lässt.
+erstellten Grafiken kann der Anwender den Export für die Einbindung in
+\hologo{LaTeX} manuell durchführen. In \autoref{sec:tips:svg} wird vorgestellt,
+wie sich dies automatisieren lässt.
+\index{Grafiken|?)}%
+
+
+\subsubsection{Querverweise und Lesezeichen}
+\index{Querverweise|?(}%
+\index{Lesezeichen|?(}%
+%
+Für das Erzeugen von Querverweisen auf bestimmte Gliederungsebenen, Tabellen,
+Abbildungen oder auch Gleichungen muss für diese besagten Elemente zunächst mit
+\Macro{label}[\Parameter{Label}] ein \emph{eindeutiges} Label erzeugt werden,
+auf welches im Dokument entweder mit \Macro{ref} oder nach dem Laden von
+\Package{hyperref} besser noch mit \Macro{autoref}(\Package{hyperref})'none'
+referenziert werden kann. In \autoref{sec:tips:references} sind diesbezüglich
+weitere Informationen zu finden.
+%
+\begin{packages}
+\item[hyperref]
+ Hiermit können in einem PDF-Dokument Lesezeichen, Querverweise und
+ Hyperlinks erstellt werden. Wird es geladen, sind außerdem die Option
+ \Option{tudbookmarks} sowie der Befehl \Macro{tudbookmark} nutzbar. Das
+ Paket \Package{bookmark} erweitert die Unterstützung nochmals. Beide
+ genannten Pakete sollten~-- bis auf sehr wenige Ausnahmen wie beispielsweise
+ \Package{glossaries}~-- als letztes in der Präambel eingebunden werden.
+\item[bookmark]
+ Dieses Paket verbessert und erweitert die von \Package{hyperref} angebotenen
+ Möglichkeiten zur Erstellung von Lesezeichen~-- auch Outline"=Einträge~-- im
+ PDF-Dokument. Beispielsweise können Schriftfarbe- und "~stil geändert werden.
+\item[varioref]
+ Mit diesem Paket lassen sich sehr gute Verweise auf bestimmte Seiten
+ erzeugen. Insbesondere, wenn der Querverweis auf die aktuelle, die
+ vorhergehende oder nachfolgende sowie im doppelseitigen Satz auf die
+ gegenüberliegende Seite erfolgt, werden passende Textbausteine für diesen
+ verwendet.
+\item[cleveref]
+ Dieses Paket vereint die Vorzüge der automatischen Benennung referenzierter
+ Objekte mit dem Befehl \Macro{autoref}(\Package{hyperref})'none' aus dem
+ Paket \Package{hyperref} und der Verwendung von \Package{varioref}.
+\index{Lesezeichen|?)}%
+\index{Querverweise|?)}%
+\end{packages}
\subsubsection{Aufteilung des Hauptdokumentes in Unterdateien}
Um während des Entwurfes eines Dokumentes die Zeitdauer für das Kompilieren zu
verkürzen, kann dieses in Unterdokumente gegliedert werden. Dadurch wird es
möglich, nur den momentan bearbeiteten Dokumentteil~-- respektive die aktuelle
-\Package{tikz}- oder \Package{pstricks}-Grafik~-- zu kompilieren. Die meiner
+\Package{tikz}"~ oder \Package{pstricks}"=Grafik~-- zu kompilieren. Die meiner
Meinung nach besten Pakete für dieses Unterfangen werden folgend vorgestellt.
%
\begin{packages}
\item[standalone]
- \ChangedAt{v2.02!\Class{standalone}: Probleme behoben}
+ \ChangedAt{%
+ v2.02:Bugfix für Verwendung der Klasse \Class{standalone} aus dem Paket
+ \Package{standalone}%
+ }
Dieses Paket ist für das Erstellen eigenständiger (Unter)"~Dokumente gedacht,
welche später in ein Hauptdokument eingebunden werden können. Jedes dieser
Teildokumente benötigt eine eigene Präambel. Optional lassen sich die
Präambeln der Unterdokumente automatisch in ein Hauptdokument einbinden.
\item[subfiles]
-\ChangedAt{v2.02!\Package{subfiles}: Beschreibung hinzugefügt}
+\ChangedAt{v2.02:\RecPack \Package{subfiles}}
Dieses Paket wählt einen etwas anderen Ansatz als \Package{standalone}. Es
ist von Anfang an dafür gedacht, ein dediziertes Hauptdokument zu verwenden.
- Die darin mit \Macro{subfiles} eingebundenen Unterdateien nutzen bei der
- autarken Kompilierung dessen Präambel.
+ Die darin mit \Macro{subfiles}(\Package{subfiles})'none' eingebundenen
+ Unterdateien nutzen bei der autarken Kompilierung dessen Präambel.
\end{packages}
%
Unabhängig davon, ob Sie eines der beiden Pakete nutzen oder alles in einem
Dokument belassen, ist es ratsam, eigens definierte Befehle, Umgebungen und
ähnliches in ein separates Paket auszulagern. Dafür müssen Sie lediglich ein
-leeres \hologo{LaTeX}-Dokument erzeugen und es unter \File*{mypreamble.sty}
+leeres \hologo{LaTeX}"=Dokument erzeugen und es unter \File*{mypreamble.sty}
oder einem anderen Namen im gleichen Ordner wie das Hauptdokument speichern.
Dann können Sie in dieser Datei ihre Deklarationen ausführen und diese mit
-\Macro*{usepackage}\PParameter{mypreamble} in das Dokument einbinden. Dies hat
-den Vorteil, dass das Hauptdokument zum einen übersichtlich bleibt und Sie zum
-anderen Ihre persönliche Präambel generisch wachsen lassen und für andere
+\Macro*{usepackage}[\PParameter{mypreamble}] in das Dokument einbinden. Dies
+hat den Vorteil, dass das Hauptdokument zum einen übersichtlich bleibt und Sie
+zum anderen Ihre persönliche Präambel generisch wachsen lassen und für andere
Dokumente wiederverwenden können.
\subsubsection{Die kleinen und großen Helfer\dots}
@@ -760,49 +904,34 @@ Hier taucht alles auf, was nicht in die vorherigen Kategorien eingeordnet
werden konnte.
%
\begin{packages}
-\item[bookmark]\index{Lesezeichen}\index{Querverweise}
- Dieses Paket verbessert und erweitert die von \Package{hyperref} angebotenen
- Möglichkeiten zur Erstellung von Lesezeichen~-- auch Outline"=Einträge~-- im
- PDF-Dokument. Beispielsweise können Schriftfarbe- und "~stil geändert werden.
-\item[calc]\index{Berechnungen}
- Normalerweise können Berechnungen nur mit Low-Level-\hologo{TeX}-Primitiven
- im Dokument durchgeführt werden. Dieses Paket stellt eine einfachere Syntax
- für Rechenoperationen der vier Grundrechenarten zur Verfügung. Zusätzlich
- werden neue Befehle zur Bestimmung der Höhe und Breite bestimmter Textauszüge
- definiert.
-\item[chngcntr]\index{Zählermanipulation}
- Das Paket erlaubt die Manipulation aller möglichen, bereits definierten
- \hologo{LaTeX}-Zähler. Es können Zähler so umdefiniert werden, dass sie bei
- der Änderung eines anderen Zählers automatisch zurückgesetzt werden oder eben
- nicht. Ein kleines Beispiel dazu ist in \autoref{sec:tips:counter} zu finden.
-\item[varioref]\index{Querverweise}
- Mit diesem Paket lassen sich sehr gute Verweise auf bestimmte Seiten
- erzeugen. Insbesondere, wenn der Querverweis auf die aktuelle, die
- vorhergehende oder nachfolgende sowie im zweiseitigen Satz auf die
- gegenüberliegende Seite erfolgt, werden passende Textbausteine für diesen
- verwendet.
-\item[cleveref]\index{Querverweise}
- Dieses Paket vereint die Vorzüge von \Package{varioref} mit der automatischen
- Benennung der referenzierten Objekte mit dem Befehl \Macro{autoref} aus dem
- Paket \Package{hyperref}.
-\item[marginnote]\index{Randnotizen}
- Randnotizen, welche mit \Macro{marginpar} erzeugt werden, sind spezielle
- Gleitobjekte in \hologo{LaTeX}. Dies kann dazu führen, dass eine Notiz am
- Blattrand nicht direkt da gesetzt wird, wo diese intendiert war. Dieses Paket
- stellt den Befehl \Macro{marginnote} für nicht"~gleitende Randnotizen zur
- Verfügung. Alternativ dazu kann man auch \Package{mparhack} verwenden.
-\item[todonotes]\index{Randnotizen}
+\item[crop]
+ \index{Beschnittzugabe}\index{Schnittmarken}%
+ Hiermit können eine Beschnittzugabe sowie Schnittmarken~-- beispielsweise für
+ Poster~-- erzeugt werden. Hierzu ist in \autoref{sec:tips:crop} ein Beispiel
+ zu finden.
+\item[marginnote]
+ \index{Randnotizen}%
+ Randnotizen, welche mit \Macro{marginpar}(\Package{koma-script})'none' erzeugt
+ werden, sind spezielle Gleitobjekte in \hologo{LaTeX}. Das kann dazu führen,
+ dass eine Notiz am Blattrand nicht direkt an der ursprünglich intendierten
+ Stelle gesetzt wird. Das Paket \Package{marginnote} stellt den Befehl
+ \Macro{marginnote}(\Package{marginnote})'none' für nicht"~gleitende
+ Randnotizen zur Verfügung. Das Paket \Package{mparhack} ist eine Alternative
+ dazu.
+\item[todonotes]
+ \index{Randnotizen}%
Mit \Package{todonotes} können noch offene Aufgaben in unterschiedlicher
Formatierung am Blattrand oder im direkt Fließtext ausgegeben werden. Aus
allen Anmerkungen lässt sich eine Liste aller offenen Punkte erzeugen.
-\item[listings]\index{Quelltextdokumentation}%
+\item[listings]
+ \index{Quelltextdokumentation}%
Dieses Paket eignet sich hervorragend zur Quelltextdokumentation in
\hologo{LaTeX}. Es bietet die Möglichkeit, externe Quelldateien einzulesen
und darzustellen sowie die Syntax in Abhängigkeit der verwendeten
Programmiersprache hervorzuheben. Zusätzlich lässt sich ein Verzeichnis mit
allen eingebundenen sowie direkt im Dokument angegebenen Quelltextauszügen
erstellen.
- \ChangedAt{v2.02!\Package{listings}: Beschreibung ergänzt}
+ \ChangedAt{v2.02:\RecPack \Package{listings}}
Wird \Package{listings} in Dokumenten mit UTF"~8-Kodierung verwendet, sollte
direkt nach dem Laden des Paketes in der Präambel Folgendes hinzugefügt
werden:
@@ -815,8 +944,54 @@ werden konnte.
{~}{{\textasciitilde}}1 {ß}{{\ss}}1
}
\end{Code}\vspace{-\baselineskip}%
-\item[xparse]\index{Befehle!Deklaration}
- Dieses mächtige Paket entstammt dem \hologo{LaTeX3}-Projekt und bietet für
+\item[afterpage]
+ Der Befehl \Macro{afterpage}[\PParameter{\dots}](\Package{afterpage})'none'
+ kann genutzt werden, um den Inhalt aus dessen Argument direkt nach der
+ Ausgabe der aktuellen Seite auszuführen.
+\item[pagecolor]
+ \index{Farben}%
+ Mit dem Paket kann die Hintergrundfarbe der Seiten im Dokument geändert
+ werden.
+\item[pdfpages]
+ Das Paket ermöglicht die Einbindung von einzelnen oder mehreren PDF"~Dateien.
+\item[filecontents]
+ \index{Minimalbeispiel|?}%
+ Dieses Paket erweitert die durch den \hologo{LaTeX}"=Kernel bereitgestellte
+ Umgebung \Environment{filecontents}(\Package{filecontents})'none' dahingehend,
+ dass bereits existierende Dateien überschrieben werden können.
+\item[mwe,blindtext]
+ \index{Minimalbeispiel|?}%
+ \ChangedAt{v2.02:\RecPack \Package{mwe}}
+ Mit dem Paket \Package{mwe} lassen sich sehr einfach Minimalbeispiele
+ erzeugen, die sowohl Blindtexte als auch Abbildungen enthalten sollen. Werden
+ keine Grafiken sondern lediglich Textabschnitte etc. benötigt, ist das Laden
+ von \Package{blindtext} ausreichend.
+\item[coseoul]
+ Mit diesem Paket kann die Struktur der Gliederung relativ erstellt werden.
+ Es wird keine absolute Gliederungsebene (\Macro*{chapter}, \Macro*{section})
+ angegeben sondern die Relation zwischen vorheriger und aktueller Ebene
+ (\Macro*{levelup}, \Macro*{levelstay}, \Macro*{leveldown}).
+\item[calc]
+ \index{Berechnungen}%
+ Normalerweise können Berechnungen nur mit Low-Level-\hologo{TeX}"=Primitiven
+ im Dokument durchgeführt werden. Dieses Paket stellt eine einfachere Syntax
+ für Rechenoperationen der vier Grundrechenarten zur Verfügung. Zusätzlich
+ werden neue Befehle zur Bestimmung der Höhe und Breite bestimmter Textauszüge
+ definiert.
+\item[chngcntr]
+ \index{Zähler}%
+ Das Paket erlaubt die Manipulation aller möglichen, bereits definierten
+ \hologo{LaTeX}"=Zähler. Es können Zähler so umdefiniert werden, dass sie bei
+ der Änderung eines anderen Zählers automatisch zurückgesetzt werden oder eben
+ nicht. Ein kleines Beispiel dazu ist in \autoref{sec:tips:counter} zu finden.
+\item[filemod]
+ Wird entweder \Engine{pdfLaTeX} oder \Engine{LuaLaTeX} als Textsatzsystem
+ eingesetzt, können mit diesem Paket das Änderungsdatum zweier Dateien
+ miteinander verglichen und in Abhängigkeit davon definierbare Aktionen
+ ausgeführt werden.
+\item[xparse]
+ \index{Befehlsdeklaration}%
+ Dieses mächtige Paket entstammt dem \hologo{LaTeX3}"=Projekt und bietet für
die Erstellung eigener Befehle und Umgebungen einen alternativen Ansatz zu
den bekannten \hologo{LaTeX}"=Deklarationsbefehlen \Macro*{newcommand} und
\Macro*{newenvironment} sowie deren Derivaten. Mit \Package{xparse} wird es
@@ -824,16 +999,18 @@ werden konnte.
innerhalb des Befehlskonstruktes zu definieren. Auch die Verwendung anderer
Zeichen als eckige Klammern für die Spezifizierung eines optionalen
Argumentes ist möglich.
-\item[xkeyval]\index{Befehle!Deklaration}
- \ChangedAt{v2.02!\Package{xkeyval}: Beschreibung hinzugefügt}
+\item[xkeyval,keyval,kvoptions,pgfkeys]
+ \index{Befehlsdeklaration}%
+ \ChangedAt{v2.02:\RecPack \Package{xkeyval}}
Das \KOMAScript"=Bundle lädt das Paket \Package{keyval}, um Optionen mit
einer Schlüssel"=Wert"=Syntax deklarieren zu können. Zusätzlich wird von
\TUDScript das Paket \Package{kvsetkeys} geladen, um auf nicht definierte
Schlüssel reagieren zu können. Die Schlüssel"=Wert"=Syntax kann auch für
eigens definierte Makros genutzt werden, um sich das exzessive Verwenden von
optionalen Argumenten zu ersparen. Damit wäre folgende Definition möglich:
- \Macro*{newcommand}\Macro*{Befehl}\OParameter{Schlüssel"=Wert"=Liste}%
- \Parameter{Argument}.
+ \Macro*{newcommand}[%
+ \Macro*{Befehl}[\OParameter{Schlüssel"=Wert"=Liste}\Parameter{Argument}]%
+ ]
Das Paket \Package{xkeyval} erweitert insbesondere die Möglichkeiten zur
Deklaration unterschiedlicher Typen von Schlüsseln. Sollten die bereits durch
@@ -843,47 +1020,33 @@ werden konnte.
unterstützen, kann das Paket \Package{scrbase} genutzt werden. Soll aus einem
Grund auf \KOMAScript{} gänzlich verzichtet werden, sind die beiden Pakete
\Package{kvoptions} oder \Package{pgfkeys} eine Alternative.
-\item[afterpage]
- Der Befehl \Macro{afterpage}\Parameter{\dots} kann genutzt werden, um den
- Inhalt aus dessen Argument direkt nach der Ausgabe der aktuellen Seite
- auszuführen.
-\item[pagecolor]\index{Farben}
- Mit dem Paket kann die Hintergrundfarbe der Seiten im Dokument geändert
- werden.
-\item[pdfpages]
- Das Paket ermöglicht die Einbindung von einzelnen oder mehreren PDF"~Dateien.
-\item[mwe]\index{Minimalbeispiel|!}
- \ChangedAt{v2.02!\Package{mwe}: Beschreibung hinzugefügt}
- Mit diesem Paket lassen sich sehr einfach Minimalbeispiele erzeugen, die
- sowohl Blindtexte respektive Abbildungen enthalten sollen.
-\item[filemod]
- Wird entweder \hologo{pdfLaTeX} oder \hologo{LuaLaTeX} als Prozessor
- eingesetzt, können mit diesem Paket das Änderungsdatum zweier Dateien
- miteinander verglichen und in Abhängigkeit davon definierbare Aktionen
- ausgeführt werden.
-\item[coseoul]
- Mit diesem Paket kann man die Struktur der Gliederung relativ angeben. Es
- wird keine absolute Gliederungsebene (\Macro*{chapter}, \Macro*{section})
- angegeben sondern die Relation zwischen vorheriger und aktueller Ebene
- (\Macro*{levelup}, \Macro*{levelstay}, \Macro*{leveldown}).
-\item[dprogress]\index{Debugging}
- Das Paket schreibt bei der Kompilierung des Dokumentes die Gliederung in die
- Logdatei. Dies kann im Fehlerfall beim Auffinden des Problems im Dokument
- helfen. Allerdings werden dafür die Gliederungsebenen so umdefiniert, dass
- diese keine optionalen Argumente mehr unterstützen,was jedoch für die
- \TUDScript-Klassen von essentieller Bedeutung ist. Zum Debuggen kann es
- trotzdem sporadisch eingesetzt werden.
+\item[scrlfile]
+ \index{Paketabhängigkeiten}
+ \ChangedAt{v2.05:\RecPack \Package{scrlfile}}
+ Dieses \KOMAScript-Paket erlaubt es, auf das Laden von Klassen oder Paketen
+ direkt davor oder danach zu reagieren, um beispielsweise Paketabhängigkeiten
+ aufzulösen oder nach dem Laden eines bestimmten Paketes gezielt Befehle
+ anzupassen. Mehr dazu ist im \scrguide zu finden.
\end{packages}
\subsubsection{Bugfixes}
\begin{packages}
-\item[scrhack](koma-script)
+\item[scrhack]<koma-script>
Das Paket behebt Kompatibilitätsprobleme der \KOMAScript-Klassen mit den
Paketen \Package{hyperref}, \Package{float}, \Package{floatrow} und
- \Package{listings}. Es ist durchaus empfehlenswert, jedoch sollte man
- unbedingt die Dokumentation beachten.
+ \Package{listings}. Es ist durchaus empfehlenswert, jedoch sollte unbedingt
+ die Dokumentation beachtet werden.
+\item[scrwfile,morewrites]
+ Falls der Fehler \texttt{No room for a new \textbackslash write} erscheint,
+ kann dieser möglicherweise mit einem dieser beiden Pakete behonben werden.
+ Mehr dazu in \autoref{sec:tips:write}.
\item[mparhack]
Zur Behebung falsch gesetzter Randnotizen wird ein Bugfix für
- \Macro{marginpar} bereitgestellt. Alternativ dazu kann man auch
- \Package{marginnote} verwenden.
+ \Macro{marginpar}(\Package{koma-script})'none' bereitgestellt. Alternativ
+ dazu lässt sich auch \Package{marginnote} verwenden.
+\item[fix-cm]
+ Sollte bei einer Schriftgrößenänderung eine oder mehrere Warnungen der Form
+ \texttt{Font shape `T1/cmr/m/n' in size <...> not available} erscheinen, so
+ sollte das Paket \Package{fix-cm} \emph{vor} der Klasse geladen werden. Siehe
+ dazu \autoref{sec:tips:fontsize}.
\end{packages}
diff --git a/Master/texmf-dist/source/latex/tudscr/doc/tudscr-poster.tex b/Master/texmf-dist/source/latex/tudscr/doc/tudscr-poster.tex
index 99f39eceaca..b2218a507f1 100644
--- a/Master/texmf-dist/source/latex/tudscr/doc/tudscr-poster.tex
+++ b/Master/texmf-dist/source/latex/tudscr/doc/tudscr-poster.tex
@@ -1,62 +1,369 @@
-%Poster:
-%x cdstyle: neu
-%x \authorname: neu
-%x \contactname: neu
-%x \studentname: neu, \authorname{} umbenannt
-%x \webpage: neu
-\chapter[Die Klasse tudscrposter]{Die Posterklasse}
-\label{sec:poster}
-\begin{Declaration*}{\Class{tudscrposter}}
-\index{Posterklasse|!}
-Ergänzend zu den Hauptklassen, welche für das Setzen von Dokumenten im \CD der
-\TnUD angeboten werden, wird die Klasse \Class{tudscrposter} bereitgestellt.
-Mit dieser wird das Erstellen von Postern mit \hologo{LaTeX} ermöglicht. Die
-Basis hierfür ist \Class{tudscrartcl} und alle durch diese Klasse angebotenen
-Befehle und Optionen können mit \Class{tudscrposter} gleichermaßen verwendet
-werden.
-\end{Declaration*}
-
-\ToDo[imp]{Klasse \Class*{tudscrposter} implementieren}[v2.05]
-\ToDo[doc]{\Class*{tudscrposter} als Ersatz für \Class{tudmathposter}}[v2.05]
-
-\begin{Declaration}[v2.05]{\Option{cdstyle}[\PSet]}[true]
-\printdeclarationlist%
-\begin{values}
+\chapter[Die Posterklasse \Class*{tudscrposter}]{Die Posterklasse}
+\tudhyperdef*{sec:poster}%
+%
+\begin{Bundle*}[v2.05]{\Class{tudscrposter}}
+\index{Posterklasse|!}%
+\printchangedatlist%
+%
+Ergänzend zu den Hauptklassen, welche für das Setzen von Dokumenten im \TUDCD
+angeboten werden, wird die Klasse \Class{tudscrposter} bereitgestellt. Mit
+dieser wird das Erstellen von Postern im gleichen Layout mit \hologo{LaTeX}
+ermöglicht. Die Basis hierfür ist \Class{tudscrartcl} und \emph{fast} alle
+durch diese Klasse angebotenen Befehle und Optionen können gleichermaßen mit
+\Class{tudscrposter} verwendet werden. Ein Minimalbeispiel zur Verwendung der
+Klasse ist in \fullref{sec:exmpl:poster} zu finden.
+
+Der größte Unterschied zu den Hauptklassen ist zum einen ein vereinfachter
+Titel. Eine Umschlagseite steht für \Class{tudscrposter} nicht zur Verfügung,
+der dazugehörige Befehl \Macro*{makecover} sowie die Option \Option*{cdcover}
+sind nicht definiert. Der Titel selbst kann mit \Macro{maketitle} lediglich als
+Titelkopf gesetzt werden, eine separate Titelseite existiert nicht. Aus diesem
+Grund sind auch nur eine reduzierte Anzahl an Befehlen für den Titel verfügbar.
+Dies sind \Macro{title}, \Macro{subtitle}, \Macro{subject} und
+\Macro{titlehead}(\Package{koma-script}), welche wie gewohnt genutzt werden
+können.
+
+Alle weiteren in \autoref{sec:title} vorgestellten Befehle und Optionen sind
+für \Class{tudscrposter} nicht definiert. Dies betrifft zum einen sowohl das
+Schriftelement \Font*{thesis} als auch die Befehle \Macro*{titledelimiter},
+\Macro*{thesis}, \Macro*{referee}, \Macro*{advisor}, \Macro*{graduation} und
+\Macro*{defensedate}. Zum anderen stehen die Makros \Macro*{matriculationyear},
+\Macro*{matriculationnumber}, \Macro*{dateofbirth} und \Macro*{placeofbirth}
+für ergänzende Autorenangaben wie auch die Option \Option*{subjectthesis} nicht
+zur Verfügung. Die durch \KOMAScript{} für eine Titelseite bereitgestellten
+Befehle \Macro*{date}, \Macro*{publishers}(\Package{koma-script}) und
+\Macro*{dedication}(\Package{koma-script}) sowie
+\Macro*{uppertitleback}(\Package{koma-script}) und
+\Macro*{lowertitleback}(\Package{koma-script}) haben bei der Klasse
+\Class{tudscrposter} keinerlei Funktionalität. Die Befehle \Macro{author} und
+\Macro{authormore} existieren weiterhin, werden allerdings nicht für den Titel
+wohl jedoch für den speziellen Fußbereich eines Posters verwendet, welcher in
+\autoref{sec:poster:foot} weiterführend beschrieben wird.
+
+Neben der signifikanten Vereinfachung des Titels entfallen für die Klasse
+\Class{tudscrposter} einige weitere Befehle und Umgebungen. Namentlich sind
+dies die Umgebung \Environment*{tudpage}, die Optionen \Option*{headingsvskip}
+und \Option*{pageheadingsvskip} sowie alle zu Selbstständigkeitserklärung und
+Sperrvermerk gehörigen Elemente, wie die Option (\Option*{declaration}), die
+Umgebung (\Environment*{declarations}) und die Befehle (\Macro*{declaration},
+\Macro*{confirmation}, \Macro*{blocking}). Die Umgebung \Environment{abstract}
+kann weiterhin genutzt werden, allerdings kann mit der Option \Option{abstract}
+lediglich noch die Gliederungsebene der Überschrift angepasst werden.
+
+\section{Layout und Formatierung eines Posters}
+%
+Die augenscheinlichsten Einstellungen für die Gestaltung eines Posters sind
+sicherlich das verwendete Papierformat sowie die farbliche Ausprägung und die
+Auswahl der Schriftart und deren Größe. Als Grundeinstellung für die Klasse
+\Class{tudscrposter} sind die Schriften des \TUDCDs aktiviert. Diese lassen
+sich wie auch bei den Hauptklassen anpassen. Weitere Informationen hierzu sind
+der Erläuterung zur Option \Option{cdfont}'full' zu entnehmen. Der Inhalt eines
+Posters lässt sich frei gestalten, es gibt hierfür keinerlei vordefinierte
+Befehle und Optionen.
+
+
+
+\subsection{Die Wahl von Papierformat und Schriftgröße}
+\tudhyperdef*{sec:fontsize}%
+\index{Papierformat|!}%
+\index{Schriftgröße|!}%
+
+Die Festlegung von \emph{Papierformat} und \emph{Schriftgröße} ist essentiell
+für das Erstellen eines Posters und sollten \emph{immer} vorgenommen werden.
+\Attention{Beide Einstellungen müssen zwingend als Klassenoption erfolgen.}
+Bei der Schriftgrößenauswahl ist darauf zu achten, ob der Satz des Posters
+ein- oder mehrspaltig erfolgen soll. Für letzteres Unterfangen ist die
+\Environment{multicols}(\Package{multicol})'none'-Umgebung aus dem Paket
+\Package{multicol} sehr empfehlenswert.
+
+Zur Festlegung des Papierformats ist die \KOMAScript-Option
+\Option{paper=\PSet}(\Package{typearea})'none'|declare| zu verwenden. Dabei
+lassen sich mit \Option{paper=\PValueName{Format}}(\Package{typearea})'none'
+unter anderem die gängigen Klassen der ISO/DIN"~Reihen A~bis~D als auch Quer-
+oder Längsformat auswählen. Ein beliebiges Format kann mit der Einstellung
+\Option{paper=\PValueName{Höhe}{:}\PValueName{Breite}}(\Package{typearea})'none'
+gewählt werden. Für zusätzliche Hinweise ist das \scrguide zu Rate zu ziehen.
+
+Passend zum ausgewählten Papierformat sowie der gewünschten Anzahl an
+Textspalten des Posters sollte unbedingt die Schriftgröße mit
+\Option{fontsize=\PName{Schriftgröße}}(\Package{koma-script})'none'|declare|
+angegeben werden. Für eine passend abgestimmte Auswahl von Papierformat und
+Schriftgröße ist \autoref{tab:font+paper} als Referenz zu nutzen. Sollten Sie
+aufgrund der Schriftgrößenänderung eine oder mehrere Warnungen vom Typ
+%
+\begin{quoting}
+\begin{Code}
+Font shape `T1/cmr/m/n' in size <...> not available
+\end{Code}
+\end{quoting}
+%
+erhalten, so beachten Sie bitte die Hinweise aus \autoref{sec:tips:fontsize}.
+
+
+\begin{table}
+ \index{Papierformat|!}%
+ \index{Schriftgröße|!}%
+ \newcommand*\mtm{\small min\dots{}max}%
+ \newcommand*\rng[2]{\small #1\dots{}#2pt}%
+ \ttabbox[\linewidth]{%
+ \setlength\tabcolsep{5pt}%
+ \centering%
+ \begin{subfloatrow}%
+ \ttabbox{%
+\begin{tabular}{r*{7}c}
+ \toprule
+ &\multicolumn{7}{c}{Klasse} \tabularnewline\midrule
+ & 6 & 5 & 4 & 3 & 2 & 1 & 0 \tabularnewline\midrule
+Reihe & \mtm & \mtm & \mtm & \mtm & \mtm & \mtm & \mtm \tabularnewline\midrule
+ D &\rng{05}{07} &\rng{06}{09} &\rng{10}{14} &\rng{14}{20}%
+ &\rng{20}{29} &\rng{28}{40} &\rng{40}{60} \tabularnewline\midrule
+ A &\rng{06}{08} &\rng{07}{10} &\rng{11}{16} &\rng{16}{23}%
+ &\rng{23}{33} &\rng{32}{46} &\rng{45}{66} \tabularnewline\midrule
+ C &\rng{07}{09} &\rng{08}{11} &\rng{12}{18} &\rng{18}{26}%
+ &\rng{26}{37} &\rng{36}{52} &\rng{50}{72} \tabularnewline\midrule
+ B &\rng{08}{10} &\rng{09}{12} &\rng{13}{20} &\rng{20}{29}%
+ &\rng{29}{41} &\rng{40}{58} &\rng{55}{78} \tabularnewline\bottomrule
+\end{tabular}
+ }{\caption{Einspaltiges Layout}}%
+ \end{subfloatrow}%
+ \par\medskip
+ \begin{subfloatrow}%
+ \ttabbox{%
+\begin{tabular}{r*{4}c}
+ \toprule
+ &\multicolumn{4}{c}{Klasse} \tabularnewline\midrule
+ & 3 & 2 & 1 & 0 \tabularnewline\midrule
+ Reihe & \mtm & \mtm & \mtm & \mtm \tabularnewline\midrule
+D&\rng{07}{10}&\rng{10}{14}&\rng{14}{19}&\rng{19}{28}\tabularnewline\midrule
+A&\rng{08}{11}&\rng{11}{16}&\rng{16}{22}&\rng{22}{32}\tabularnewline\midrule
+C&\rng{09}{12}&\rng{12}{18}&\rng{18}{25}&\rng{25}{36}\tabularnewline\midrule
+B&\rng{10}{13}&\rng{13}{20}&\rng{20}{28}&\rng{28}{40}\tabularnewline\bottomrule
+\end{tabular}
+ }{\caption{Zweispaltiges Layout}}%
+ \ttabbox{%
+\begin{tabular}{r*{2}c}
+ \toprule
+ &\multicolumn{2}{c}{Klasse} \tabularnewline\midrule
+ & 1 & 0 \tabularnewline\midrule
+ Reihe & \mtm & \mtm \tabularnewline\midrule
+ D &\rng{07}{10} &\rng{10}{14} \tabularnewline\midrule
+ A &\rng{08}{11} &\rng{11}{16} \tabularnewline\midrule
+ C &\rng{09}{12} &\rng{12}{18} \tabularnewline\midrule
+ B &\rng{10}{13} &\rng{13}{20} \tabularnewline\bottomrule
+\end{tabular}
+ }{\caption{Dreispaltiges Layout}}%
+ \end{subfloatrow}%
+ }{%
+ \caption{%
+ Empfohlene Kombinationen für die Wahl von Papierformat
+ (\Option{paper}(\Package{typearea})'none') und Schriftgröße
+ (\Option{fontsize}(\Package{koma-script})'none')%
+ }%
+ \label{tab:font+paper}%
+ }%
+\end{table}
+
+
+
+\subsection{Die Gestalt eines Posters}
+
+Die Festlegung der Farbausprägung eines Posters erfolgt mit der Option
+\Option{cd}, welche nachfolgend beschrieben wird. Dabei kann aus einigen
+Varianten zur Farbgestaltung gewählt werden. Sollte keiner dieser
+vordefinierten Werte das gewünschte Layout zur Verfügung stellen, lässt sich
+dieses mit den Optionen \Option{cdhead} und \Option{cdfoot} sowie
+\Option{cdtitle}, \Option{cdpart} und \Option{cdsection} nachträglich
+noch genauer anpassen.
+
+
+\begin{Declaration}{\Option{cd=\PSet}}[bicolor]
+\printdeclarationlist%
+%
+Äquivalent zu den \TUDScript-Hauptklassen wird mit dieser Option die Verwendung
+des \TUDCDs für das Poster festgelegt. Sie hat Einfluss auf die Farbgestaltung
+der Gliederungsüberschriften sowie des Seitenstils, welcher standardmäßig auf
+\PageStyle{empty.tudheadings} gesetzt wird.
+%
+\begin{values}{\Option{cd}}
\itemfalse
+ Hiermit wird das \CD komplett deaktiviert und es werden keine spezifischen
+ Einstellungen für ein Poster vorgenommen. Lediglich der Seitenstil wird auf
+ \PageStyle{empty} festgelegt.
\itemtrue*[nocolor/monochrome]
+ Es wird schwarze Schrift für Überschriften und den Seitenkopf verwendet. Der
+ Fußbereich wird nicht farbig akzentuiert.
\item[lightcolor/pale]
+ Die Einstellung entspricht weitestgehend der Option \Option{cd=true},
+ allerdings wird die primäre Hausfarbe \Color{HKS41} für Kopf sowie Fuß und
+ die Überschriften genutzt.
\item[barcolor]
-\item[bicolor/bichrome]
-\item[color]
-\item[full/fullcolor]
+ Zusätzlich zur vorherigen Einstellung wird außerdem der Querbalken farbig
+ abgesetzt.
+\item[bicolor/color/fullcolor]
+ Der Kopf wird mit einem farbigen Hintergrund in der primären Hausfarbe
+ \Color{HKS41} gesetzt, der Querbalken wird farbig abgesetzt. Ebenso wird für
+ alle Überschriften die Hausfarbe verwendet, der Fußbereich erhält ebenfalls
+ einen farbigen Hintergrund.
\end{values}
\end{Declaration}
+\begin{Declaration}{\Option{backgroundcolor=\PSet}}[true]
+\printdeclarationlist%
+%
+Mit dieser Option kann die Hintergrundfarbe eines Posters definiert werden.
+%
+\begin{values}{\Option{backgroundcolor}}
+\itemfalse*[nocolor]
+ Es wird keine Farbe festgelegt, der Hintergrund erscheint weiß.
+\itemtrue*[color]
+ Der Seitenhintergrund wird in der primären Hausfarbe \Color{HKS41} gewählt.
+\item[\PValueName{Farbe}]
+ Die angegebene \PName{Farbe} wird als Hintergrund für das Poster genutzt.
+\end{values}
+\end{Declaration}
+
+\begin{Declaration}{\Option{bleedmargin=\PName{Längenwert}}}[0.2in]
+\printdeclarationlist%
+\index{Beschnittzugabe|?}%
+\index{Schnittmarken|?}%
+%
+Soll das Poster in einem Papierformat gedruckt werden, welches anschließend
+noch auf das Zielformat zugeschnitten wird, weil beispielsweise ein randloses
+Drucken nicht möglich ist, kann diese Option genutzt werden, um die farbigen
+Elemente des Layouts in den Bereich der Beschnittzugabe respektive Überfüllung
+zu vergrößern. Damit ist ein \enquote{Zuschneiden in die Farbe} sehr einfach
+und ohne große Probleme realisierbar.
+
+Die von der Einstellung \Option{bleedmargin=\PName{Längenwert}} abhängigen
+Elemente sind zum einen Kopf- und Fußbereich, beeinflusst durch die Optionen
+\Option{cdhead} und \Option{cdfoot}. Werden diese farbig gesetzt, so werden
+diese um den angegebenen \PName{Längenwert} über das gewünschte Zielformat
+hinaus vergrößert. Zum anderen wird auch der mit \Option{backgroundcolor}
+gegebenenfalls eingestellte, farbige Seitenhintergrund erweitert. Wie sich der
+Entwurf eines Posters in einem bestimmten Zielformat auf einem übergroßem
+Papierbogen tatsächlich realisieren lässt, wird in \fullref{sec:tips:crop}
+exemplarisch dargestellt.
+\end{Declaration}
+
-% \begin{macro}{\faculty}
-% \begin{macro}{\department}
-% \begin{macro}{\institute}
-% \begin{macro}{\chair}
-% \begin{macro}{\professor}
-% \begin{macro}{\contactperson}
-% \begin{macro}{\office}
-% \begin{macro}{\telephone}
-% \begin{macro}{\emailaddress}
-% \begin{macro}{\webpage}
-\begin{Declaration}[v2.05]{\Macro{webpage}\Parameter{Webseite}}
+\section{Felder für den Fußbereich}
+\tudhyperdef*{sec:poster:foot}%
+%
+Der Fußbereich eines Posters kann mit \Macro{footcontent} eigens und frei
+definiert werden. Geschieht dies nicht, wird standardmäßig ein vordefinierte
+Fuß gesetzt, welcher Angaben von bestimmten Feldern ausgibt, die insbesondere
+als Kontaktinformationen gedacht sind. Welche das im Einzelnen sind, wird
+nachfolgend erläutert.
+
+\begin{Declaration}{%
+ \Macro{faculty}[\OParameter{Fußzeile}\Parameter{Fakultät}]%
+}
+\begin{Declaration}{%
+ \Macro{department}[\OParameter{Fußzeile}\Parameter{Einrichtung}]%
+}
+\begin{Declaration}{%
+ \Macro{institute}[\OParameter{Fußzeile}\Parameter{Institut}]%
+}
+\begin{Declaration}{%
+ \Macro{chair}[\OParameter{Fußzeile}\Parameter{Lehrstuhl}]%
+}
\printdeclarationlist%
+%
+Die mit diesen Befehlen gemachten Angaben werden nicht nur im Kopf sondern
+zusätzlich auch im linken Teil des Fußbereichs ausgegeben. Sollen diese für den
+Fußbereich angepasst werden, lässt das optionale Argument hierfür verwenden,
+wobei die Angabe eines leeren optionalen Argumentes das Feld für den Fuß
+komplett unterdrückt. Vor allen Angaben wird der Bezeichner \Term{contactname}
+in fetter Schrift ausgegeben.
+\end{Declaration}
+\end{Declaration}
+\end{Declaration}
\end{Declaration}
-\begin{Declaration}[v2.05]{\Term{authorname}}
-\begin{Declaration}[v2.05]{\Term{contactname}}
-\begin{Declaration}{\Term{contactpersonname}}
+
+\begin{Declaration}{\Macro{professor}[\Parameter{Name}]}
+\printdeclarationlist%
+%
+Zusätzlich zu den Angaben der Einrichtung kann mit \Macro{professor} der
+aktuelle Inhaber der genannten Professur im linken Fußbereich angegeben werden.
+\end{Declaration}
+
+\ToDo[imp]{Symbole für Telefon, Fax und E-Mail? Woher?}[v2.06]
+\ToDo[imp]{marvosym?}[v2.06]%\Email\fax\Faxmachine\FAX\Letter\Mobilefone\Telefon
+\begin{Declaration}{\Macro{author}[\Parameter{Autor(en)}]}
+\begin{Declaration}{\Macro{contactperson}[\Parameter{Name(n)}]}
+\begin{Declaration}{\Macro{authormore}[\Parameter{Autorenzusatz}]}
+\begin{Declaration}{\Macro{course}[\Parameter{Studiengang}]}
+\begin{Declaration}{\Macro{discipline}[\Parameter{Studienrichtung}]}
+\begin{Declaration}{\Macro{office}[\Parameter{Adresse/Gebäude}]}
+\begin{Declaration}{\Macro{telephone}[\Parameter{Telefonnummer}]}
+\begin{Declaration}{\Macro{telefax}[\Parameter{Telefaxnummer}]}
+\begin{Declaration}{%
+ \Macro{emailaddress}[\OParameter{Einstellungen}\Parameter{E-Mail-Adresse}]%
+}
+\begin{Declaration}{\Macro{emailaddress*}[\Parameter{E-Mail-Adresse}]}
\printdeclarationlist%
-\ToDo[imp]{Konflikt auflösen}[v2.05]
%
-\TermTable{authorname,contactname,contactpersonname}
+Der oder die mit \Macro{author} angegebenen Autoren werden im rechten Teil des
+Fußbereichs (nacheinander) ausgegeben, mehrere Autoren sind mit \Macro{and}
+voneinander zu trennen. Die Befehle \Macro{authormore}, \Macro{course} und
+\Macro{discipline} sowie \Macro{office}, \Macro{telephone}, \Macro{telefax} und
+\Macro{emailaddress} können für zusätzliche Angaben zu jedem Autor innerhalb
+des Argumentes von \Macro{author} verwendet werden. Vor der Ausgabe aller
+Autoreninformationen wird der Bezeichner \Term{authorname} in fetter Schrift
+gesetzt. Wurde \Macro{author} nicht angegeben, so erfolgt keine Ausgabe.
+
+Danach folgen alle mit \Macro{contactperson} gemachten Angaben. Auch hier ist
+\Macro{and} für eine Trennung mehrerer Personen zu nutzen, wobei auch hier
+lediglich die Befehle \Macro{office}, \Macro{telephone}, \Macro{telefax} und
+\Macro{emailaddress} nicht jedoch \Macro{authormore} sowie \Macro{course} und
+\Macro{discipline} für zusätzliche Angaben zu verwenden sind. Bevor die
+Ansprechpartner ausgegeben werden, wird der Bezeichner \Term{contactpersonname}
+in fetter Schrift gesetzt. Es ist natürlich auch möglich nur Autor(en) oder
+Ansprechpartner anzugeben.
+
+Die mit \Macro{emailaddress} angegebene E"~Mail"=Adresse wird als Hyperlink
+definiert, falls das Paket \Package{hyperref} geladen wurde. Das optionale
+Argument wird an \Macro{hypersetup}(\Package{hyperref})'none' aus besagtem
+Paket übergeben. Mit der Sternversion \Macro{emailaddress*} kann die
+Formatierung des Eintrags im Argument~-- gegebenenfalls lokal in einer
+Gruppe~-- manuell vorgenommen werden.
+\end{Declaration}
+\end{Declaration}
+\end{Declaration}
+\end{Declaration}
+\end{Declaration}
+\end{Declaration}
+\end{Declaration}
\end{Declaration}
\end{Declaration}
\end{Declaration}
-\ToDo[doc]{Beispiel für \Class*{tudscrposter}}[v2.05]
+\begin{Declaration}{\Macro{webpage}[\OParameter{Einstellungen}\Parameter{URL}]}
+\begin{Declaration}{\Macro{webpage*}[\Parameter{URL}]}
+\printdeclarationlist%
+%
+Ganz zum Schluss kann für die rechte Spalte des Fußbereichs eine Homepage
+angegeben werden. Wurde das Paket \Package{hyperref} geladen, wird diese in
+einen Hyperlink gewandelt. Über das optionale Argument können beliebige
+Einstellungen an \Macro{hypersetup}(\Package{hyperref})'none' aus besagtem
+Paket übergeben werden. Soll die Formatierung des Eintrags manuell erfolgen, so
+kann die Sternversion \Macro{webpage*} verwendet werden, wobei alle gewünschten
+Einstellungen innerhalb des Argumentes~-- gegebenenfalls in einer Gruppe~--
+vorgenommen werden müssen.
+\end{Declaration}
+\end{Declaration}
+
+\begin{Declaration}{\Term{contactname}}
+\begin{Declaration}{\Term{authorname}}
+\begin{Declaration}{\Term{contactpersonname}}
+\printdeclarationlist%
+%
+Wie bereits zuvor erläutert, werden diese Bezeichner in der linken respektive
+rechten Spalte im Fuß vor der Ausgabe der eigentlichen Felder gesetzt.
+\TermTable{contactname,authorname,contactpersonname}
+\end{Declaration}
+\end{Declaration}
+\end{Declaration}
+\end{Bundle*}
diff --git a/Master/texmf-dist/source/latex/tudscr/doc/tudscr-preface.tex b/Master/texmf-dist/source/latex/tudscr/doc/tudscr-preface.tex
index 5beea23d78b..9f7c044c17d 100644
--- a/Master/texmf-dist/source/latex/tudscr/doc/tudscr-preface.tex
+++ b/Master/texmf-dist/source/latex/tudscr/doc/tudscr-preface.tex
@@ -1,9 +1,9 @@
-\addchap{\prefacename}
+\addchap*{\prefacename}
Die im Folgenden beschriebenen Klassen und Pakete wurden für das Erstellen von
-\hologo{LaTeX}"=Dokumenten im \CD der \TnUD entwickelt.%
+\hologo{LaTeX}"=Dokumenten im \TUDCD entwickelt.%
\footnote{%
- \url{http://tu-dresden.de/cd}\hfill
- \url{http://tu-dresden.de/service/publizieren/cd/6_handbuch/index.html}%
+ \url{https://tu-dresden.de/cd}\hfill
+ \url{https://tu-dresden.de/cd/6_handbuch}%
}
Diese basieren auf den gerade im deutschsprachigen Raum häufig verwendeten
\KOMAScript"=Klassen, welche eine Vielzahl von Einstellmöglichkeiten bieten,
@@ -11,8 +11,8 @@ die weit über die Möglichkeiten der \hologo{LaTeX}"=Standardklassen
hinausgehen. Zusätzlich bietet das hier dokumentierten \TUDScript-Bundle
weitere, insbesondere das Dokumentlayout betreffende Auswahlmöglichkeiten.
-Es sei angemerkt, dass die hier beschriebenen Klassen eine Abweichung vom \CD
-der \TnUD zulassen, da dieses gerade unter typografischen Gesichtspunkten
+Es sei angemerkt, dass die hier beschriebenen Klassen eine Abweichung vom
+\TUDCD zulassen, da dieses gerade unter typografischen Gesichtspunkten
durchaus als diskussionswürdig zu erachten ist. Prinzipiell ist es mit den
entsprechenden Einstellungen möglich, auf das standardmäßige Layout der
\KOMAScript"=Klassen zurückzuschalten. Ohne die gezielte Verwendung dieser
@@ -23,14 +23,14 @@ In diesem Handbuch werden dem Anwender Hinweise für eine einfache Installation
der benötigten Schriften des \CDs sowie eine Beschreibung der zusätzlich zu den
\KOMAScript"=Klassen nutzbaren Optionen und Befehle gegeben. Dabei werden
Grundkenntnisse in der Verwendung von \hologo{LaTeXe} vorausgesetzt. Sollten
-diese nicht vorhanden sein, wird das Lesen der \hologo{LaTeXe}-Kurzbeschreibung
+diese nicht vorhanden sein, wird das Lesen der \hologo{LaTeXe}"=Kurzbeschreibung
\hrfn{http://mirrors.ctan.org/info/lshort/german/l2kurz.pdf}{\File{l2kurz.pdf}}
dringend empfohlen. Für den stärker vertieften Einstieg in \hologo{LaTeX} gibt
es eine \hrfn{http://www.fadi-semmo.de/latex/workshop/}{Workshop-Reihe} von
Fadi~Semmo. Außerdem stellt Nicola~L.~C.~Talbot sehr ausführliche Tutorials für
-\hrfn{http://www.dickimaw-books.com/latex/novices/}{\hologo{LaTeX}-Novizen} und
-\hrfn{http://www.dickimaw-books.com/latex/thesis/}{Dissertationen} zur freien
-Verfügung. Außerdem werden in \autoref{part:additional} dieses Handbuchs
+\hrfn{http://www.dickimaw-books.com/latex/novices/}{\hologo{LaTeX}"=Novizen}
+und \hrfn{http://www.dickimaw-books.com/latex/thesis/}{Dissertationen} zur
+freien Verfügung. Außerdem werden in \autoref{part:additional} dieses Handbuchs
Minimalbeispiele sowie etwas ausführlichere Tutorials angeboten.
Des Weiteren sollte \emph{jeder} Anwender das \hologo{LaTeXe}"=Sündenregister
@@ -38,7 +38,7 @@ Des Weiteren sollte \emph{jeder} Anwender das \hologo{LaTeXe}"=Sündenregister
kennen, um typische Fehler zu vermeiden. Antworten auf häufig gestellte Fragen
liefert \hrfn{http://projekte.dante.de/DanteFAQ/WebHome}{DANTE"~FAQ}. Falls der
Nutzer unerfahren bei der Verwendung von \KOMAScript{} sein sollte, so ist ein
-Blick in das dazugehörige Handbuch \scrguide sehr zu empfehlen, wenn nicht
+Blick in das \scrguide[dazugehörige Handbuch] sehr zu empfehlen, wenn nicht
sogar unumgänglich.
Der aktuelle Stand der Klassen und Pakete aus dem \TUDScript-Bundle in der
@@ -47,7 +47,7 @@ getestet. Dennoch kann nicht für das Ausbleiben von Fehlern garantiert werden.
Beim Auftreten eines Problems sollte dieses genauso wie Inkompatibilitäten mit
anderen Paketen im Forum unter
\begin{quoting}
-\Forum*%
+\Forum'%
\end{quoting}
gemeldet werden. Für eine schnelle und erfolgreiche Fehlersuche sollte bitte
ein \hrfn{http://www.komascript.de/minimalbeispiel}{\textbf{Minimalbeispiel}}
diff --git a/Master/texmf-dist/source/latex/tudscr/doc/tudscr-supervisor.tex b/Master/texmf-dist/source/latex/tudscr/doc/tudscr-supervisor.tex
new file mode 100644
index 00000000000..95051c53995
--- /dev/null
+++ b/Master/texmf-dist/source/latex/tudscr/doc/tudscr-supervisor.tex
@@ -0,0 +1,421 @@
+\chapter[Das Paket \Package*{tudscrsupervisor} -- Studentische Betreuung]{%
+ Ergänzungen für studentische Arbeiten
+}
+\begin{Bundle*}{\Package{tudscrsupervisor}}
+%
+Dieses Paket stellt für das Erstellen von Aufgabenstellungen und Gutachten
+wissenschaftlicher Arbeiten sowie offiziellen Aushängen im \CD passende
+Umgebungen und Befehle für den Anwender bereit. Deshalb richtet es sich
+vornehmlich an Mitarbeiter an der \TnUD, kann jedoch natürlich auch von
+Studenten genutzt werden.
+
+
+\section{Aufgabenstellung für eine wissenschaftliche Arbeit}
+\index{Aufgabenstellung|!(}%
+%
+\begin{Declaration}{\Environment{task}[\OLParameter{Überschrift}]}{%
+ \Environment{tudpage}'auto'%
+}
+\begin{Declaration}{\Key{\Environment{task}}{headline=\PName{Überschrift}}}
+\begin{Declaration}[v2.05]{\Key{\Environment{task}}{style=\PName{Stil}}}
+\printdeclarationlist%
+%
+Mit der \Environment{task}"=Umgebung kann ein Aufgabenstellung für eine
+wissenschaftliche Arbeit ausgegeben werden. Diese basiert auf der Umgebung
+\Environment{tudpage} und akzeptiert deshalb im optionalen Argument alle
+Parameter, welche bei der Beschreibung von \Environment{tudpage}'full'
+erläutert wurden.
+
+Für die Aufgabenstellung wird normalerweise eine Überschrift gesetzt, welche
+sich aus \Term{taskname} und~-- falls der Typ der Abschlussarbeit angegeben
+wurde~-- noch aus \Term{tasktext} und \Macro{thesis} zusammensetzt. Der
+Parameter \Key{\Environment{task}}{headline} kann genutzt werden, um diese
+automatisch generierte Überschrift anzupassen.
+
+Zu Beginn der Aufgabenstellung erscheint eine Tabelle mit den angegebenen
+Informationen zum Autor respektive zu den Autoren der Abschlussarbeit. Zwingend
+anzugeben sind dafür lediglich der Name des oder der Verfasser (\Macro{author})
+sowie der Titel der Arbeit (\Macro{title}), welcher am Ende der Tabelle in
+fetter Schrift aufgeführt wird. Optional werden noch die Felder für den
+Studiengang (\Macro{course}), die Fachrichtung (\Macro{discipline}) sowie die
+Matrikelnummer (\Macro{matriculationnumber}) und das Immatrikulationsjahr
+(\Macro{matriculationyear}) ausgegeben, wobei nicht angegebene Felder bei der
+Ausgabe ignoriert werden. Der eigentliche Inhalt der Umgebung~-- sprich die
+Aufgabenstellung selbst~-- wird nach dem generierten Kopf ausgegeben
+
+Nach dem Inhalt der Aufgabenstellung werden der oder die definierten Gutachter
+beziehungsweise Prüfer (\Macro{referee}) sowie der oder die Betreuer
+(\Macro{supervisor}) zeilenweise aufgelistet. Dabei wird vor dem jeweiligen
+Namen der dazugehörige Bezeichner (\Term{refereename}, \Term{refereeothername}
+respektive \Term{supervisorname}, \Term{supervisorothername}) gesetzt.
+\ChangedAt{v2.05}
+Dies ist das voreingestellte Verhalten und kann über die Wahl des Parameters
+\Key{\Environment{task}}{style=\PValue{table}} aktiviert werden. Wird hingegen
+der Parameter \Key{\Environment{task}}{style=\PValue{inline}} gesetzt, so
+erfolgt die Ausgabe von mehreren Prüfern und Betreuern in einer Zeile. Die
+Bezeichner sind problemlos anpassbar, siehe dazu \autoref{sec:localization}.
+Danach erscheinen das Ausgabedatum (\Macro{issuedate}) sowie der verpflichtende
+Abgabetermin (\Macro{duedate}). Zum Schluss wird die Unterschriftzeile für den
+Prüfungsausschussvorsitzenden (\Macro{chairman}) und den betreuenden
+Hochschullehrer (\Macro{professor}) gesetzt. Für genannte Personen werden unter
+dem Namen selbst die Bezeichner ausgegeben (\Term{chairmanname} und
+\Term{professorname}).
+\end{Declaration}
+\end{Declaration}
+\end{Declaration}
+
+\begin{Declaration}{%
+ \Macro{taskform}[\LParameter\Parameter{Ziele}\Parameter{Schwerpunkte}]%
+}
+\printdeclarationlist%
+%
+Zusätzlich zur der frei gestaltbaren Umgebung \Environment{task} zur Erstellung
+einer Aufgabenstellung wird ein separater Befehl für eine standardisierte
+Ausgabe zur Verfügung gestellt. Dieser strukturiert die Aufgabenstellung in die
+zwei Bereiche \emph{Ziele} und \emph{Schwerpunkte} der Arbeit mit dazugehörigen
+Überschriften (\Term{objectivesname}, \Term{focusname}).
+
+Im optionalen Argument können alle Parameter der Umgebung \Environment{task}
+verwendet werden. Im ersten obligatorischen Argument sollte ein Text mit einer
+kurzen thematischen Einordnung und dem eigentlichen Ziel der Arbeit erscheinen,
+im zweiten Argument sollen die thematischen Schwerpunkte in Stichpunkten
+benannt werden. Der Inhalt des zweiten notwendigen Argumentes wird in einer
+\Environment{itemize}(\Package{koma-script},\Package{enumitem})'none'"=Umgebung
+gesetzt. Deshalb \emph{muss} jedem Stichpunkt
+\Macro{item}(\Package{koma-script},\Package{enumitem})'none' vorangestellt
+werden.
+\end{Declaration}
+%
+\begin{Example}
+Die empfohlene Verwendung des Befehls \Macro{taskform} ist wie folgt:
+\begin{Code}[escapechar=§]
+\taskform{%
+ Motivation der Arbeit im ersten Absatz§\dots§
+
+ Ziele der Arbeit im zweiten Absatz§\dots§
+}{%
+ \item Schwerpunkt 1
+ \item Schwerpunkt 2
+}
+\end{Code}
+Hierzu sei auch auf das Minimalbeispiel in \autoref{sec:exmpl:task} verwiesen.
+\index{Aufgabenstellung|!)}%
+\end{Example}
+
+\begin{Declaration}{\Macro{chairman}[\Parameter{Prüfungsausschussvorsitzender}]}
+\printdeclarationlist%
+%
+Wird dieses Feld genutzt, wird neben dem betreuenden Hochschullehrer
+(\Macro{professor}) auch der Vorsitzende des Prüfungsausschusses am Ende der
+Aufgabenstellung aufgeführt. Dies wird zumeist für Abschlussarbeiten wie
+beispielsweise \masterthesisname{} oder \diplomathesisname{} benötigt.
+\end{Declaration}
+
+\begin{Declaration}{\Macro{issuedate}[\Parameter{Ausgabedatum}]}
+\begin{Declaration}{\Macro{duedate}[\Parameter{Abgabetermin}]}
+\printdeclarationlist%
+%
+Mit diesen beiden Befehlen sollte das Datum der Ausgabe der Aufgabenstellung
+sowie der spätest mögliche Abgabetermin angegeben werden. Ist das Paket
+\Package{isodate} geladen, wird die damit eingestellte Formatierung des Datums
+durch den Befehl \Macro{printdate}(\Package{isodate})'none' aus diesem Paket
+für \Macro{issuedate} und \Macro{duedate} verwendet.
+\end{Declaration}
+\end{Declaration}
+
+
+\section{Gutachten für wissenschaftliche Arbeiten}
+\index{Gutachten|!(}%
+%
+\begin{Declaration}{\Environment{evaluation}[\OLParameter{Überschrift}]}{%
+ \Environment{tudpage}'auto'%
+}
+\begin{Declaration}{%
+ \Key{\Environment{evaluation}}{headline=\PName{Überschrift}}%
+}
+\begin{Declaration}{\Key{\Environment{evaluation}}{grade=\PName{Note}}}
+\printdeclarationlist%
+%
+Diese Umgebung wird für das Erstellen eines Gutachtens einer wissenschaftlichen
+Arbeit bereitgestellt. Auch diese unterstützt alle Parameter, welche für die
+Umgebung \Environment{tudpage}'full' beschrieben wurden.
+
+Für ein Gutachten wird gewöhnlich eine Überschrift aus \Term{evaluationname}
+und~-- falls der Abschlussarbeitstyp angegeben wurde~-- \Term{evaluationtext}
+sowie \Macro{thesis} generiert. Diese automatisch generierte Überschrift kann
+mit dem Parameter \Key{\Environment{evaluation}}{headline} ersetzt werden. Am
+Ende des Gutachtens wird die mit \Key{\Environment{evaluation}}{grade}
+gegebene Note in fetter Schrift ausgezeichnet.
+
+Am Anfang der \Environment{evaluation}"=Umgebung wird die gleiche Tabelle mit
+Autorenangaben ausgegeben, wie dies bei der \Environment{task}"=Umgebung der
+Fall ist. Nach dem Tabellenkopf folgt auch hier der eigentliche Inhalt, sprich
+das Gutachten der Abschlussarbeit. Abgeschlossen wird die Umgebung mit der
+gegebenen Note~-- welche innerhalb von \Term{gradetext} ausgegeben wird~--
+sowie der Orts- und Datumsangabe (\Macro{place}, \Macro{date}) und der
+darauffolgenden Unterschriftzeile für den oder die Gutachter (\Macro{referee}),
+welche wiederum mit den entsprechenden sprachabhängigen Bezeichner
+(\Term{refereename}, \Term{refereeothername}) ergänzt werden.
+\end{Declaration}
+\end{Declaration}
+\end{Declaration}
+
+\begin{Declaration}{%
+ \Macro{evaluationform}[%
+ \LParameter\Parameter{Aufgabe}\Parameter{Inhalt}%
+ \Parameter{Bewertung}\Parameter{Note}%
+ ]%
+}
+\printdeclarationlist%
+%
+Neben der individuell nutzbaren Umgebung \Environment{evaluation} wird ein
+separater Befehl zur Erstellung eines standardisierten Gutachtens
+bereitgestellt. Dieser strukturiert die Ausgabe in die vier Bereiche
+\emph{Aufgabe}, \emph{Inhalt}, \emph{Bewertung} und \emph{Note} und versieht
+diese jeweils mit der dazugehörigen Überschrift beziehungsweise Textausgabe
+(\Term{taskname}, \Term{contentname}, \Term{assessmentname} und
+\Term{gradetext}). Das optionale Argument unterstützt alle Parameter der
+\Environment{evaluation}"=Umgebung.
+\end{Declaration}
+%
+\begin{Example}
+Die empfohlene Verwendung des Befehls \Macro{evaluationform} ist wie folgt:
+\begin{Code}[escapechar=§]
+\evaluationform{%
+ Kurzbeschreibung der Aufgabenstellung§\dots§
+}{%
+ Zusammenfassung von Inhalt und Struktur§\dots§
+}{%
+ Bewertung der schriftlichen Abschlussarbeit§\dots§
+}{%
+ Zahl (Note)
+}
+\end{Code}
+Hierzu sei auch auf das Minimalbeispiel in \autoref{sec:exmpl:evaluation}
+verwiesen.
+\index{Gutachten|!)}%
+\end{Example}
+
+\begin{Declaration}{\Macro{grade}[\Parameter{Note}]}
+\printdeclarationlist%
+%
+Neben der Angabe der Note für ein Gutachten über den Parameter
+\Key{\Environment{evaluation}}{grade} der Umgebung \Environment{evaluation}
+kann dafür auch dieser global wirkende Befehl verwendet werden.
+\end{Declaration}
+
+
+\section{Aushang}
+\index{Aushang|!(}%
+%
+\begin{Declaration}{\Environment{notice}[\OLParameter{Überschrift}]}{%
+ \Environment{tudpage}'auto'%
+}
+\begin{Declaration}{\Key{\Environment{notice}}{headline=\PName{Überschrift}}}
+\printdeclarationlist%
+%
+Für das Anfertigen eines Aushangs kann diese Umgebung verwendet werden. Diese
+basiert abermals auf der Umgebung \Environment{tudpage} und unterstützt alle
+deren Parameter.
+
+Wurde ein Datum angegeben, wird dieses standardmäßig rechtsbündig oberhalb des
+Textbereiches angezeigt (\seeref{\Key{\Environment{tudpage}}{cdhead}}). Danach
+erfolgt die Ausgabe der Überschrift, welche für gewöhnlich dem Inhalt von
+\Term{noticename} entspricht und mit \Key{\Environment{notice}}{headline}
+geändert werden kann. Nach der Überschrift folgt der Inhalt der Umgebung. Wurde
+mit \Macro{contactperson} ein oder mehrere Ansprechpartner angegeben, werden
+diese Informationen am Ende der Umgebung gesetzt.
+\end{Declaration}
+\end{Declaration}
+
+\begin{Declaration}{%
+ \Macro{noticeform}[\LParameter\Parameter{Inhalt}\Parameter{Schwerpunkte}]%
+}
+\printdeclarationlist%
+%
+Auch für diese Umgebung gibt es einen Befehl für eine normierte Form. Diese
+soll vor allem Verwendung für den Aushang studentischer Arbeitsthemen finden.
+Für das optionale Argument können sämtliche Parameter verwendet werden, die
+auch die \Environment{notice}"=Umgebung unterstützt.
+
+Das erste obligatorische Argument wird für eine kurze Inhaltsbeschreibung
+verwendet. Neben dem Text sollte hier wenn möglich eine thematisch passende
+Abbildung eingefügt werden (\Macro{includegraphics}(\Package{graphicx})'none').
+Das zweite Argument wird~-- wie schon bei \Macro{taskform}~-- dazu verwendet,
+einige Schwerpunkte aufzuzählen. Auch hier kommt nach der gliedernden
+Überschrift (\Term{focusname}) eine
+\Environment{itemize}(\Package{koma-script},\Package{enumitem})'none'"=Umgebung
+zum Einsatz, allen Schwerpunkten muss ein
+\Macro{item}(\Package{koma-script},\Package{enumitem})'none' vorangestellt
+werden.
+\end{Declaration}
+%
+\begin{Example}
+Die empfohlene Verwendung des Befehls \Macro{noticeform} ist wie folgt:
+\begin{Code}[escapechar=§]
+\noticeform{%
+ Kurzbeschreibung des Inhaltes der studentischen Arbeit§\dots§
+
+ Bild (optional), einzubinden mit:
+ \includegraphics[§\PName{Einstellungen}§]{§\PName{Datei}§}
+}{%
+ \item Schwerpunkt 1
+ \item Schwerpunkt 2
+}
+\end{Code}
+Hierzu sei auch auf das Minimalbeispiel in \autoref{sec:exmpl:notice} verwiesen.
+\index{Aushang|!)}%
+\end{Example}
+
+\begin{Declaration}[v2.02]{\Macro{contactperson}[\Parameter{Kontaktperson(en)}]}
+\begin{Declaration}{\Macro{office}[\Parameter{Dienstsitz}]}
+\begin{Declaration}[v2.02]{\Macro{telephone}[\Parameter{Telefonnummer}]}
+\begin{Declaration}[v2.05]{\Macro{telefax}[\Parameter{Telefaxnummer}]}
+\begin{Declaration}[%
+ v2.02;%
+ v2.05:optionales Argument zur Formatierung mit \Macro*{hypersetup}%
+]{%
+ \Macro{emailaddress}[\OParameter{Einstellungen}\Parameter{E-Mail-Adresse}]%
+}
+\begin{Declaration}[v2.05]{\Macro{emailaddress*}[\Parameter{E-Mail-Adresse}]}
+
+\printdeclarationlist%
+%
+Am Ende eines Aushangs können mit \Macro{contactperson} Kontaktinformationen
+für eine oder mehrere Ansprechpartner angegeben werden. Soll mehr als eine
+Kontaktperson genannt werden, so müssen diese innerhalb des Befehls
+\Macro{contactperson} mit dem Befehl \Macro{and} getrennt werden. Für jede
+Person kann innerhalb des Argumentes von \Macro{contactperson} der Dienstsitz
+(\Macro{office}), die dienstliche Telefon- (\Macro{telephone}) sowie "~faxnummer
+(\Macro{telefax}) und die geschäftliche E"~Mail"=Adresse (\Macro{emailaddress})
+angegeben werden. Sollte das Paket \Package{hyperref} geladen werden, wird die
+gegebene E"~Mail"=Adresse direkt in einen entsprechenden Link gewandelt.
+Alternativ dazu kann mit der Sternversion \Macro{emailaddress*} die Formatierung
+des Eintrags im Argument~-- gegebenenfalls in einer Gruppe~-- manuell erfolgen.
+\end{Declaration}
+\end{Declaration}
+\end{Declaration}
+\end{Declaration}
+\end{Declaration}
+\end{Declaration}
+
+
+\section{Zusätzliche sprachabhängige Bezeichner}
+\index{Bezeichner|!(}%
+%
+Für das Paket \Package{tudscrsupervisor} werden für die zusätzlichen Befehle
+und Umgebungen weitere Bezeichner definiert. Für eine etwaige Anpassung dieser
+sei auf \autoref{sec:localization} verwiesen.
+
+\begin{Declaration}{\Term{taskname}}
+\begin{Declaration}{\Term{tasktext}}
+\printdeclarationlist%
+%
+Die Bezeichnung der Aufgabenstellung selbst ist in \Term{taskname} enthalten.
+Für die Generierung einer Überschrift wird dieser verwendet. Wurde außerdem mit
+\Macro{thesis} oder \Macro{subject} der Typ der Abschlussarbeit%
+\footnote{%
+ \Option{subjectthesis} oder spezieller Wert aus \autoref{tab:thesis}%
+}
+angegeben, wird die Überschrift zusammen mit dem Bezeichner \Term{tasktext}
+um die Typisierung erweitert. Falls gewünscht, kann die automatisch generierte
+Überschrift mit dem Parameter \Key{\Environment{task}}{headline} der Umgebung
+\Environment{task} überschrieben werden.
+\TermTable{taskname,tasktext}
+\end{Declaration}
+\end{Declaration}
+
+\begin{Declaration}[v2.04]{\Term{namesname}}
+\begin{Declaration}{\Term{titlename}}
+\printdeclarationlist%
+%
+Diese beiden Bezeichner werden in der Tabelle mit den Autoreninformationen zu
+Beginn der Aufgabenstellung verwendet.
+\TermTable{namesname,titlename}
+\end{Declaration}
+\end{Declaration}
+
+\begin{Declaration}{\Term{issuedatetext}}
+\begin{Declaration}{\Term{duedatetext}}
+\printdeclarationlist%
+%
+Am Ende der Aufgabenstellung wird nach dem oder der Betreuer das Ausgabedatum
+und der Abgabetermin (\Macro{issuedate}, \Macro{duedate}) der Abschlussarbeit
+mit folgenden Bezeichner erläutert.
+\TermTable{issuedatetext,duedatetext}
+\end{Declaration}
+\end{Declaration}
+
+\begin{Declaration}{\Term{chairmanname}}
+\printdeclarationlist%
+%
+Wurde der Prüfungsausschussvorsitzende (\Macro{chairman}) angegeben, erfolgt
+unter dem Namen selbst die Ausgabe des Bezeichners.
+\TermTable{chairmanname}
+\end{Declaration}
+
+\begin{Declaration}{\Term{focusname}}
+\begin{Declaration}{\Term{objectivesname}}
+\printdeclarationlist%
+%
+Die Standardformen für Aufgabenstellung (\Macro{taskform}) respektive Aushang
+(\Macro{noticeform}) nutzen für die gesetzten Überschriften diese Bezeichner.
+\TermTable{focusname,objectivesname}
+\end{Declaration}
+\end{Declaration}
+
+\begin{Declaration}{\Term{evaluationname}}
+\begin{Declaration}{\Term{evaluationtext}}
+\printdeclarationlist%
+%
+Die Bezeichnung des Gutachten selbst ist in \Term{evaluationname} enthalten.
+Für die Generierung der Überschrift wird der Bezeichner \Term{evaluationtext}
+sowie der mit \Macro{thesis} oder gegebenenfalls mit \Macro{subject} gegebenen
+Typ der Abschlussarbeit verwendet. Diese automatisch generierte Überschrift
+kann mit dem Parameter \Key{\Environment{evaluation}}{headline} der
+Umgebung \Environment{evaluation} durch den Anwender überschrieben werden.
+\TermTable{evaluationname,evaluationtext}
+\end{Declaration}
+\end{Declaration}
+
+\begin{Declaration}{\Term{contentname}}
+\begin{Declaration}{\Term{assessmentname}}
+\printdeclarationlist%
+%
+Bei der standardisierten Form des Gutachten (\Macro{evaluationform}) werden die
+darin~-- zur strukturierter Gliederung~-- erzeugten Überschriften mit den
+Bezeichnern \Term{taskname}, \Term{contentname} und \Term{assessmentname}
+gesetzt.
+\TermTable{taskname,contentname,assessmentname}
+\end{Declaration}
+\end{Declaration}
+
+\begin{Declaration}{\Term{gradetext}}
+\printdeclarationlist%
+%
+Wird für das Gutachten einer wissenschaftlichen Arbeit die erzielte Note
+entweder mit dem Befehl \Macro{grade}[\Parameter{Note}] oder alternativ dazu
+mit dem Parameter \Key{\Environment{evaluation}}{grade=\PName{Note}} der
+Umgebung \Environment{evaluation} angegeben, so wird diese innerhalb von
+\Term{gradetext} verwendet.
+\grade{\PName{Note}}
+\TermTable*{gradetext}{.7\textwidth}
+\end{Declaration}
+
+\begin{Declaration}{\Term{noticename}}
+\begin{Declaration}[v2.02]{\Term{contactpersonname}}
+\printdeclarationlist%
+%
+Die Bezeichnung des Aushangs selbst ist in \Term{noticename} enthalten. Für
+die Generierung einer Überschrift wird dieser verwendet. Falls gewünscht, kann
+diese mit dem Parameter \Key{\Environment{notice}}{headline} der Umgebung
+\Environment{notice} überschrieben werden. Wurde eine Kontaktperson mit dem
+Befehl \Macro{contactperson} angegeben, wird als Überschrift der Kontaktdaten
+der Bezeichner \Term{contactpersonname} verwendet.
+
+\TermTable{noticename,contactpersonname}
+\end{Declaration}
+\end{Declaration}
+\index{Bezeichner|!)}%
+\end{Bundle*}
+
diff --git a/Master/texmf-dist/source/latex/tudscr/doc/tudscr.tex b/Master/texmf-dist/source/latex/tudscr/doc/tudscr.tex
index 5a35e47a8f8..bf3e424daf7 100644
--- a/Master/texmf-dist/source/latex/tudscr/doc/tudscr.tex
+++ b/Master/texmf-dist/source/latex/tudscr/doc/tudscr.tex
@@ -1,5 +1,5 @@
\RequirePackage[ngerman=ngerman-x-latest]{hyphsubst}
-\documentclass[english,ngerman]{tudscrman}
+\documentclass[english,ngerman]{tudscrmanual}
\usepackage{selinput}\SelectInputMappings{adieresis={ä},germandbls={ß}}
\usepackage[T1]{fontenc}
\lstset{%
@@ -9,18 +9,25 @@
{Ä}{{\"A}}1 {Ö}{{\"O}}1 {Ü}{{\"U}}1
{~}{{\textasciitilde}}1 {ß}{{\ss}}1
}
+\usepackage{bookmark}
+
+\TUDoption{ToDo}{notnxt}
+
+%\tracinglabels[all]
+%\tracingmarkup
+%\tracingbundle
\begin{document}
\newcommand*\cdurl{%
\begingroup%
\hypersetup{hidelinks}%
- \href{http://tu-dresden.de/cd}{http://tu-dresden.de/cd}%
+ \href{https://tu-dresden.de/cd}{https://tu-dresden.de/cd}%
\endgroup%
}
\faculty{\protect\cdurl}
-\date{17.06.2016}
+\date{26.07.2016}
\author{Falk Hanisch\thanks{\noexpand\Email{\tudscrmail}}}
-\subject{\TUDScript{} \vTUDScript{} basierend auf \KOMAScript{}}
+\subject{\TUDScript \vTUDScript{} basierend auf \KOMAScript}
\title{%
Ein \NoCaseChange{\hologo{LaTeXe}}-Bundle für Dokumente im~neuen \CD der \TnUD
}
@@ -30,6 +37,8 @@
}{%
\subtitle{Benutzerhandbuch\thanks{\href{tudscr_print}{Druckversion}}}%
}
+
+
\makeatletter
\begingroup%
\def\and{, }%
@@ -42,14 +51,19 @@
pdfkeywords = {LaTeX, \TUDScript, Benutzerhandbuch},%
}%
\endgroup%
-\renewcommand*\@pnumwidth{1.7em}
+\renewcommand*\@pnumwidth{1.9em}
+\renewcommand*\@tocrmarg{2.9em}
\makeatother
+
\ChangedAt*{%
- v2.00!Generalüberholung und komplette Neuimplementierung von \TUDScript%
+ v2.00:Generalüberholung und komplette Neuimplementierung von \TUDScript%
}%
\maketitle
+
+
+
\include{tudscr-preface}
\tableofcontents
\include{tudscr-introduction}
@@ -64,10 +78,11 @@
die Funktionalität von \KOMAScript{} hinausgehen.
\end{abstract}
}%
-\part{Das \TUDScript-Bundle}\label{part:main}
+\part{Das \TUDScript-Bundle}
+\label{part:main}
\include{tudscr-mainclasses}
-\ToDo[imp,nxt]{Implementierung und Doku für \Class{tudscrposter}}[v2.05]
-%\include{tudscr-poster}
+\include{tudscr-poster}
+\include{tudscr-supervisor}
\include{tudscr-bundle}
@@ -91,7 +106,8 @@
jederzeit empfänglich.
\end{abstract}
}
-\part{Ergänzungen und Hinweise}\label{part:additional}
+\part{Ergänzungen und Hinweise}
+\label{part:additional}
\include{tudscr-examples}
\include{tudscr-packages}
\include{tudscr-hints}
@@ -103,20 +119,31 @@
\include{tudscr-installation}
\include{tudscr-obsolete}
\include{tudscr-additional}
+\ToDo[doc]{Benutzerdefinierte Anpassungen von \TUDScript}[v2.06]
\include{tudscr-index}
-\ListOfToDo
-\ToDo[imp,nxt]{\Macro*{DeclareSectionCommand}}[v3.18]
-\ToDo[imp,nxt]{Unterstützung für algorithm2e o.ä. (Überschriften?!)}[v3.18]
+\clearpage
+
+\ToDo[imp]{Paket für \Package*{glossaries}-Stile}[v2.06]
+
+\ToDo[imp]{\Macro*{DeclareSectionCommand}}[v2.06]
+\ToDo[imp]{Unterstützung für algorithm2e o.ä. (Überschriften?!)}[v2.06]
-\ToDo[rls,nxt]{KOMA-Script-Version anpassen (LoadClass)}[v3.18]
-\ToDo[rls,nxt]{TeXstudio: tudscrposter.cwl erstellen}[v2.05]
+\ToDo[rls]{KOMA-Script-Version anpassen (LoadClass) v3.18}
+\ToDo[imp]{TeXstudio: alle cwl über docstrip separate .ins-Datei}[v2.06]
+\ToDo[imp]{TeXstudio: tudscrposter.cwl erstellen}[v2.06]
+\ToDo[imp]{TeXstudio: tudscrmanual.cwl/tudscrtutorial.cwl erneuern}[v2.06]
+
+\ToDo[rls]{TeXstudio: alle *.cwl erneuern, automatisch über *.dtx}
\ToDo[rls]{\emph{alle} dtx-Dateien der vorherigen Version mit WinMerge sichten}
-\ToDo[rls]{Layout und Umbrüche kontrollieren, insbesondere im Index}
+\ToDo[rls]{Layout und Umbrüche kontrollieren}
\ToDo[rls]{Datum in tudscr-version.dtx, Handbuch und README aktualisieren}
-\ToDo[rls]{TeXstudio: tudscr.cwl erneuern}
-\ToDo[rls]{neuer GitHub-Release}
+\ToDo[rls]{%
+ Release auf GitHub und CTAN, Tag für Homepage und im Forum ändern\\
+ \url{http://latex.wcms-file3.tu-dresden.de/phpBB3/viewtopic.php?t=303}%
+}
+\ListOfToDo
\end{document}
diff --git a/Master/texmf-dist/source/latex/tudscr/doc/tutorials/mathswap.tex b/Master/texmf-dist/source/latex/tudscr/doc/tutorials/mathswap.tex
index 685cc3cf1dc..9067e4e0d8e 100644
--- a/Master/texmf-dist/source/latex/tudscr/doc/tutorials/mathswap.tex
+++ b/Master/texmf-dist/source/latex/tudscr/doc/tutorials/mathswap.tex
@@ -1,8 +1,8 @@
\RequirePackage[ngerman=ngerman-x-latest]{hyphsubst}
\documentclass[english,ngerman]{tudscrartcl}
+\usepackage{tudscrtutorial}
\usepackage{selinput}\SelectInputMappings{adieresis={ä},germandbls={ß}}
\usepackage[T1]{fontenc}
-\usepackage{tudscrman}
\lstset{%
inputencoding=utf8,extendedchars=true,
literate=%
@@ -12,9 +12,11 @@
}
\usepackage{mathswap}
+\usepackage{bookmark}
\begin{document}
-\date{17.12.2014}
+\begin{Bundle}{\Package{mathswap}}
+\date{20.11.2015}
\author{Falk Hanisch\thanks{\noexpand\scriptsize\noexpand\Email{\tudscrmail}}}
\title{Änderung der Trennzeichen im Mathematikmodus}
\makeatletter
@@ -43,8 +45,9 @@
\end{Preamble}
%
-Zusätzlich wird das Paket \Package{mathswap} geladen, welches die Änderung der
-Gruppierungs- und Dezimaltrennzeichen von Zahlen im Mathematikmodus ermöglicht.
+Zusätzlich wird das Paket \Package{mathswap}'manual' aus dem \TUDScript-Bundle
+geladen, welches die Änderung der Gruppierungs- und Dezimaltrennzeichen von
+Zahlen im Mathematikmodus ermöglicht.
%
\begin{Preamble}
\usepackage{mathswap}
@@ -56,15 +59,16 @@ importierten Daten nicht dem Zahlenformat entsprechen, welches für die
verwendete Dokumentsprache normalerweise notwendig wäre. Um sich die manuelle
Konvertierung der Daten zu ersparen, kann alternativ dazu die Möglichkeit
genutzt werden, dies mit Hilfe von \hologo{LaTeXe} selbst zu erledigen. In
-diesem Tutorial wird hierfür das Paket \Package*{mathswap} genutzt. Alternativ
-dazu kann auch das Paket \Package{ionumbers} verwendet werden.
+diesem Tutorial wird hierfür das Paket \Package{mathswap}'manual' genutzt.
+Alternativ dazu kann auch das Paket \Package{ionumbers}()'manual' verwendet
+werden.
Ohne die Verwendung eines speziellen Paketes zur Zahlenformatierung wird eine
Zahl im mathematischen Modus durch \hologo{LaTeXe} normalerweise so
ausgegeben:
%
\CodePreamble{%
- Ausgabe mit deutscher Zifferngruppierung ohne \Package*{mathswap}%
+ Ausgabe mit deutscher Zifferngruppierung ohne \Package{mathswap}'manual'%
}
\begin{Trunk*}
\mathswapoff
@@ -73,10 +77,11 @@ ausgegeben:
\end{Trunk*}
%
-Da in der Präambel dieses Dokumentes das Paket \Package*{mathswap} bereits
-geladen wurde, musste mit \Macro*{mathswapoff} auf das Standardverhalten von
-\hologo{LaTeXe} geschaltet werden. Der Befehl \Macro*{mathswapon} aktiviert
-wiederum die Funktionalität von \Package*{mathswap}.
+Da in der Präambel dieses Dokumentes das Paket \Package{mathswap}'manual'
+bereits geladen wurde, musste mit \Macro{mathswapoff}'manual' auf das
+Standardverhalten von \hologo{LaTeXe} geschaltet werden. Der Befehl
+\Macro{mathswapon}'manual' aktiviert wiederum die Funktionalität von
+\Package{mathswap}'manual'.
Für diese Tutorial wird angenommen, dass die wissenschaftlichen Abhandlung in
deutscher Sprache verfasst wird. Ist nun eine Zahl im deutschen Zahlenformat
@@ -102,9 +107,9 @@ dies nicht mehr:
\end{Trunk*}
%
-Mit der Verwendung der Befehle \Macro*{commaswap}\PParameter{\textbackslash,}
-sowie \Macro*{dotswap}\PParameter{,} können die Substitutionen für Komma und
-Punkt im Mathematikmodus geändert:
+Mit der Nutzung der Befehle \Macro{commaswap}[\PParameter{\Macro*{,}}]'manual'
+sowie \Macro{dotswap}[\PParameter{,}]'manual' können die Substitutionen für
+Komma und Punkt im Mathematikmodus geändert:
%
\CodePreamble{%
Ausgabe mit englischer Zifferngruppierung und geänderten Trennzeichen%
@@ -118,30 +123,32 @@ Punkt im Mathematikmodus geändert:
\end{Trunk*}
%
-Die Verwendung von \Macro{begingroup} und \Macro{endgroup} führt hierbei
+Die Verwendung von \Macro*{begingroup} und \Macro*{endgroup} führt hierbei
dazu, dass die Änderungen der beiden Trennzeichen nur lokal innerhalb dieser
Gruppe erfolgt.
-Wird das Paket \Package*{mathswap} zusammen mit einer \TUDScript-Klasse
+Wird das Paket \Package{mathswap}'manual' zusammen mit einer \TUDScript-Klasse
verwendet, werden die Dezimaltrennzeichen im Mathematikmodus sprachabhängig
definiert. Wird die Dokumentsprache auf \PValue{english} gesetzt, so werden die
Dezimaltrennzeichen standardmäßig für die englischsprachige Zifferngruppierung
definiert. In diesem Fall müssen Zahlen, welche im deutschsprachigen Format
gruppiert sind, angepasst werden:
%
-\CodePreamble{
+\CodePreamble{%
Ausgabe bei \PValue{english} als gewählter Sprache%
}
\begin{Trunk*}
-\begingroup%
+\begingroup
\selectlanguage{english}%
- \(4,523.58\)\par
- \(4.523,58\)\par
+ \(4,523.58\)\\
+ \(4.523,58\)\\
\commaswap{.}
\dotswap{\,}
- \(4.523,58\)%
+ \(4.523,58\)
\endgroup
\end{Trunk*}
%
\FinishTutorial
+\ListOfToDo
+\end{Bundle}
\end{document}
diff --git a/Master/texmf-dist/source/latex/tudscr/doc/tutorials/mathtype.tex b/Master/texmf-dist/source/latex/tudscr/doc/tutorials/mathtype.tex
index 9221a1f0e40..5de6f3a2604 100644
--- a/Master/texmf-dist/source/latex/tudscr/doc/tutorials/mathtype.tex
+++ b/Master/texmf-dist/source/latex/tudscr/doc/tutorials/mathtype.tex
@@ -1,8 +1,8 @@
\RequirePackage[ngerman=ngerman-x-latest]{hyphsubst}
\documentclass[english,ngerman]{tudscrartcl}
+\usepackage{tudscrtutorial}
\usepackage{selinput}\SelectInputMappings{adieresis={ä},germandbls={ß}}
\usepackage[T1]{fontenc}
-\usepackage{tudscrman}
\lstset{%
inputencoding=utf8,extendedchars=true,
literate=%
@@ -12,9 +12,10 @@
}
\usepackage{mathtools}
+\usepackage{bookmark}
\begin{document}
-\date{17.12.2014}
+\date{20.11.2015}
\author{Falk Hanisch\thanks{\noexpand\scriptsize\noexpand\Email{\tudscrmail}}}
\title{Ein Beitrag zum mathematischen Satz in \NoCaseChange{\hologo{LaTeXe}}}
\makeatletter
@@ -56,8 +57,8 @@ mikrotypografisch alles richtig gemacht werden soll, gibt es einiges zu
beachten. Generell gilt, dass Variablen kursiv, Bezeichnungen und Konstanten
aufrecht gesetzt werden. Um beschreibende Indizes bei Formelzeichen richtig zu
setzen, ist ohne weitere Maßnahmen die exzessive Nutzung der beiden Befehle
-\Macro{mathrm}\PParameter{\dots} und \Macro{mathit}\PParameter{\dots} wohl oder
-übel notwendig. Somit wird aus:
+\Macro{mathrm}[\PParameter{\dots}] und \Macro{mathit}[\PParameter{\dots}] wohl
+oder übel notwendig. Somit wird aus:
%
\begin{Trunk*}
\begin{equation*}
@@ -89,13 +90,13 @@ M_\mathrm{EM_{min}}\leq M_\mathrm{EM}\leq M_\mathrm{EM_{max}}
\end{Trunk*}
%
-Wie man sieht, ist dabei eine ganze Menge Handarbeit vonnöten. Allerdings lässt
-sich das relativ gut vereinfachen lassen. Zu diesem Zwecke wird ein Befehl
-\Macro{ind}\PParameter{\dots} für das Setzen von Indizes bei Formelzeichen
-definiert. Danach kann man sich~-- wenn man das für nötig und sinnvoll
-erachtet~-- noch zusätzliche Befehle für häufig verwendete Ausdrücke schnitzen.
-Als Beispiel wird das schon eben genutzte Drehmoment \ensuremath{M} verwendet.
-Hierfür könnte man Folgendes definieren:
+Augenscheinlich ist dabei eine sehr viel Handarbeit notwendig. Allerdings
+lässt sich dies relativ gut vereinfachen. Zu diesem Zwecke wird ein Befehl
+\Macro{ind}[\PParameter{\dots}] für das Setzen von Indizes bei Formelzeichen
+definiert. Danach können~-- wenn dies für nötig und sinnvoll erachtet wird~--
+noch zusätzliche Befehle für häufig verwendete Ausdrücke definiert werden. Als
+Beispiel wird das schon eben genutzte Drehmoment \ensuremath{M} verwendet.
+Hierfür wäre folgende Definition möglich:
%
\CodeHook{\let\newcommand\renewcommand}
\begin{Trunk*}
@@ -120,19 +121,19 @@ und damit diese Ausgabe erzeugen:
\end{Trunk*}
%
-Netter Nebeneffekt ist, dass man den Befehl aufgrund der Verwendung von
-\Macro{ensuremath}\PParameter{\dots} nun auch im Fließtext verwenden kann,
-beispielsweise wie hier \M{VM_{ind}} (\Macro{M}\PParameter{VM\_\{ind\}}) für
-das induzierte Moment einer Verbrennungskraftmaschine.
+Netter Nebeneffekt ist, dass dieser Befehl aufgrund der Verwendung von
+\Macro{ensuremath}[\PParameter{\dots}] nun auch im Fließtext verwenden werden
+kann, beispielsweise für das induzierte Moment einer Verbrennungskraftmaschine
+\M{VM_{ind}} (\Macro{M}[\PParameter{VM\_\PParameter{ind}}]).
-Möchte man es sich noch bequemer machen, strikt man sich noch eine Lösung, in
-der man~-- im Gegensatz zum \hologo{LaTeX}"=Standardfall~-- \textbf{nach} dem
-obligatorischen Argument noch ein optionales für einen weiteren Index angeben
-kann, um damit der natürlichen Schreibweise zu entsprechen. Es wird der Befehl
-\Macro{M} so definiert, das dieser entweder mit \Macro{M}\Parameter{Index}
-oder in der Variante \Macro{M}\Parameter{Index}\OParameter{Indexindex}
-genutzt
-werden kann.
+Für noch mehr Bequemlichkeit bei der Nutzung kann eine Lösung gefunden werden,
+mit welcher~-- im Gegensatz zur Standardbefehlsdefinition in \hologo{LaTeXe}~--
+\textbf{nach} dem obligatorischen Argument noch ein optionales für einen
+weiteren Index angegeben werden kann, um damit der natürlichen Schreibweise zu
+entsprechen. Es wird der Befehl \Macro{M} so definiert, das dieser entweder mit
+\Macro{M}[\Parameter{Index}] oder in der Variante mit nachgelagertem optionalen
+Argument \Macro{M}[\Parameter{Index}\OParameter{Indexindex}] genutzt werden
+kann.
%
\CodeHook{\let\newcommand\renewcommand}
\begin{Trunk*}
@@ -162,7 +163,7 @@ Somit vereinfacht sich das zu Beginn vorgestellte Beispiel recht deutlich:
\end{equation*}
\end{Trunk*}
%
-Das Definieren von \Macro{M}\Parameter{Index}\OParameter{Indexindex} mit
+Das Definieren von \Macro{M}[\Parameter{Index}\OParameter{Indexindex}] mit
angehängtem optionalen Argument ist ehrlich gesagt nur ein wenig Spielerei und
soll zeigen, wie dies prinzipiell mit \hologo{LaTeXe}"=Mitteln funktioniert.
Das Paket \Package{xparse} könnte alternativ zum hier vorgestellten Vorgehen
@@ -173,12 +174,12 @@ folgendermaßen lauten:
\NewDocumentCommand \M { m o } {%
\ensuremath{%
M\ind{%
- #1
- \IfNoValueTF{#2}{}{_{#2}}
+ #1\IfValueT{#2}{_{#2}}%
}%
}%
}
\end{Hint}
%
\FinishTutorial
+\ListOfToDo
\end{document}
diff --git a/Master/texmf-dist/source/latex/tudscr/doc/tutorials/treatise.tex b/Master/texmf-dist/source/latex/tudscr/doc/tutorials/treatise.tex
index d0f259d7087..6173d85d300 100644
--- a/Master/texmf-dist/source/latex/tudscr/doc/tutorials/treatise.tex
+++ b/Master/texmf-dist/source/latex/tudscr/doc/tutorials/treatise.tex
@@ -3,13 +3,9 @@
english,ngerman,%
cdgeometry=no,DIV=12,automark,%
]{tudscrartcl}
+\usepackage{tudscrtutorial}
\usepackage{selinput}\SelectInputMappings{adieresis={ä},germandbls={ß}}
\usepackage[T1]{fontenc}
-\usepackage{lmodern}
-\usepackage{etex}
-\reserveinserts{28}
-
-\usepackage{tudscrman}
\lstset{%
inputencoding=utf8,extendedchars=true,
literate=%
@@ -18,7 +14,9 @@
{~}{{\textasciitilde}}1 {ß}{{\ss}}1
}
\lstset{escapechar=§}
+
\TUDoptions{cdfont=false}
+\usepackage{lmodern}
\KOMAoptions{headings=normal}
\usepackage{tudscrsupervisor}
@@ -45,8 +43,8 @@
nomain,%
translate=babel,%
nogroupskip,%
+ nostyles,%
]{glossaries}
- \setStyleFile{\jobname-temp}
\renewcommand*{\glsglossarymark}[1]{}
\newignoredglossary{abbreviation}
\newcommand*\newabbreviation[4][]{%
@@ -67,12 +65,10 @@
\usepackage{floatrow}
\renewcommand{\floatpagefraction}{0.7}
-\ifpdf
- \usepackage{tikz}
- \usetikzlibrary{chains}
- \usetikzlibrary{decorations.markings}
- \tikzset{on grid}
-\fi
+\usepackage{tikz}
+\usetikzlibrary{chains}
+\usetikzlibrary{decorations.markings}
+\tikzset{on grid}
\usepackage{pstricks,pst-node}
@@ -80,8 +76,7 @@
\newcommand*\pcolumnfuzz[1]{\pretocmd{\@endpbox}{\hfuzz=#1}{}{}}
\makeatother
-\usepackage[open,openlevel=0]{bookmark}[2011/12/02]
-
+\usepackage{bookmark}
\ActivateWarningFilters[Tutorial]%
\begin{filecontents}{\jobname.bib}
@@ -120,7 +115,7 @@
@article{neubauer1996,
author = {Marion Neubauer},
title = {Feinheiten bei wissenschaftlichen Publikationen~--
- Mikrotypographie"=Regeln, Teil~I},
+ Mikrotypographie"=Regeln, Teil~I},
journaltitle = {Die \TeX{}nische Komödie},
year = {1997},
month = {2},
@@ -132,7 +127,7 @@
@article{neubauer1997,
author = {Marion Neubauer},
title = {Feinheiten bei wissenschaftlichen Publikationen~--
- Mikrotypographie"=Regeln, Teil~II},
+ Mikrotypographie"=Regeln, Teil~II},
journaltitle = {Die \TeX{}nische Komödie},
year = {1997},
month = {5},
@@ -160,7 +155,7 @@
\begin{document}
-\date{17.12.2014}
+\date{25.07.2016}
\author{Falk Hanisch\thanks{\noexpand\scriptsize\noexpand\Email{\tudscrmail}}}
\title{%
Ein Anwenderleitfaden für das Erstellen einer wissenschaftlichen Abhandlung%
@@ -189,13 +184,13 @@
versucht werden, einen Großteil der für gewöhnlich auftretenden Erfordernisse
zu bearbeiten.
- Dieses Tutorial hat \emph{nicht} die Intention, \hologo{LaTeX}-Einsteigern
+ Dieses Tutorial hat \emph{nicht} die Intention, \hologo{LaTeX}"=Einsteigern
sämtliche Grundlagen zu erläutern. Vielmehr wird davon ausgegangen, dass Sie
bereits erste Erfahrungen mit \hologo{LaTeXe} gesammelt haben. Dennoch wird
versucht, alle Schritte möglichst leicht nachvollziehbar zu gestalten. Sollte
Ihnen beim Lesen und Durcharbeiten des Tutorials etwas auf- oder missfallen,
- so dürfen Sie mich gerne per E-Mail kontaktieren. Auch Anregungen und Wünsche
- dürfen sie mir gegenüber gerne kommunizieren.
+ so dürfen Sie mich gerne per E"~Mail kontaktieren. Auch Anregungen und
+ Wünsche dürfen sie mir gegenüber gerne kommunizieren.
Für absolute Neueinsteiger gibt es einige freie Tutorials, welche die ersten
Schritte mit \hologo{LaTeXe} stark erleichtern. Sehr empfehlenswert ist die
@@ -210,15 +205,16 @@
wissenschaftliche Arbeit eine \TUDScript"=Dokumentklasse verwenden wollen.
Das vorgestellte Vorgehen kann jedoch~-- natürlich mit gewissen Abstrichen~--
auch mit anderen Klassen, insbesondere denen aus dem \KOMAScript"=Bundle,
- umgesetzt werden. Viele der hier verwendeten Optionen und Befehle aus dem
- \TUDScript-Bundle werden nur sporadisch in ihrer Grundfunktion erläutert.
- Eine detaillierte Erläuterung lässt sich jedoch jederzeit sehr einfach über
- die türkisfarbigen Hyperlinks im \manualhyperref{}{\TUDScript-Handbuch}
- öffnen. Des Weiteren wird in auf eine Vielzahl von Paketen verwiesen, deren
- Dokumentation sich entweder über den magentafarbigen Hyperlink auf das
- \href{http://www.ctan.org/}{Comprehensive TeX Archive Network (CTAN)} oder
- alternativ über die Kommandozeile respektive das Terminal mit dem Aufruf
- \PValue{texdoc }\PName{Paket} direkt lokal öffnen lässt.
+ umgesetzt werden. Viele der hier im Folgenden verwendeten Optionen und
+ Befehle aus dem \TUDScript-Bundle werden lediglich sporadisch in ihrer
+ Grundfunktion erläutert. Allerdings lassen sich detaillierte Erläuterung über
+ die türkisfarbigen Hyperlinks zum \tudhyperref{}{\TUDScript-Handbuch}
+ jederzeit sehr einfach öffnen. Des Weiteren wird auf eine Vielzahl von
+ Paketen verwiesen, deren Dokumentation über die magentafarbigen Links im
+ \CTAN* geöffnet werden kann. Alternativ kann dies auch über das Terminal
+ respektive die Kommandozeile mit dem Aufruf \Path{texdoc~\PName{Paket}}
+ direkt lokal erfolgen. Ein Großteil dieser Pakete wird zusätzlich kurz im
+ \TUDScript-Handbuch beschrieben.
Der Anwenderleitfaden muss nicht zwingend vollständig nachvollzogen werden.
Dieser ist in einzelne Abschnitte untergliedert, damit Sie sich bestimmte
@@ -234,7 +230,8 @@
\section{Einleitung}
-\label{sec:introduction}
+\label{sec:introduction}%
+%
Zu Beginn werden einige Pakete geladen, die quasi in jedem neu erstellten
Dokument verwendet werden sollten. Alle weiteren in diesem Tutorial genutzten
und/oder empfohlenen Pakete werden in den relevanten Abschnitten des Tutorials
@@ -243,14 +240,14 @@ genauer erläutert.
Den Anfang macht das Paket \Package{hyphsubst}. Dieses wird für eine wesentlich
verbesserte Worttrennung für die deutsche Sprache benötigt und muss bereits
\emph{vor} der Klasse geladen werden, damit es problemlos funktioniert. In
-\autoref{sec:hyphenation} können Sie außerdem weitere Informationen zum Thema
-\emph{Worttrennung} finden.
+\autoref{sec:hyphenation} können Sie weitere Informationen zur Verwendung von
+\Package{hyphsubst} sowie zum Thema \emph{Worttrennung} finden.
%
\begin{Preamble}
\RequirePackage[ngerman=ngerman-x-latest]{hyphsubst}
\end{Preamble}
%
-Beim Laden der Klasse mit \Macro{documentclass} können Sie globale Optionen
+Beim Laden der Klasse mit \Macro*{documentclass} können Sie globale Optionen
angeben. Diese werden sowohl an die Klasse selbst weitergereicht als auch allen
in der Präambel geladenen Pakete zur Verfügung gestellt. Falls das Paket
\Package{babel} für die Sprachauswahl im Dokument verwendet wird, sollten auf
@@ -264,17 +261,16 @@ diese nicht nur an das Paket \Package{babel} sondern auch an andere Pakete
\usepackage{babel}
\end{Preamble}
%
-Bei der Verwendung von \hologo{LaTeXe} sollte zum einen die Eingabekodierung
+Bei der Verwendung von \Engine{pdfLaTeX} sollte zum einen die Eingabekodierung
des erstellten Datei spezifiziert werden. Das Paket \Package{selinput} erkennt
automatisch, welche Kodierung der genutzte Editor verwendet. Zum anderen werden
die Schriften in der Ausgabe ebenfalls kodiert. Mit dem Paket \Package{fontenc}
lässt sich die verwendete Schriftkodierung für das Dokument spezifizieren,
-wobei im Normalfall die europäischen Zeichen mit der Option~\Option{T1}
-aktiviert werden sollten.
+wobei im Normalfall mit der Option~\Option{T1}(\Package{fontenc}) die
+europäischen Zeichen aktiviert werden sollten.
%
\begin{Preamble}
-\usepackage{selinput}
-\SelectInputMappings{adieresis={ä},germandbls={ß}}
+\usepackage{selinput}\SelectInputMappings{adieresis={ä},germandbls={ß}}
\usepackage[T1]{fontenc}
\end{Preamble}
%
@@ -301,30 +297,32 @@ machen, um bei der Finalisierung des Dokumentes keine böse Überraschung bei
Seitenumbrüchen oder der Position von Gleitobjekten zu erleben.
Zuallererst gilt zu entscheiden, ob das Dokument einseitig oder beidseitig
-gesetzt werden soll. Ist Letzteres der Fall, so sollte \Option{twoside} als
-Klassenoption angegeben werden. Im nächsten Schritt ist der zu verwendende
-Satzspiegel festzulegen. Hierfür kann die Option \Option*{geometry} verwendet
-werden, welche im \TUDScript-Handbuch beschrieben wird. Normalerweise wird das
-Dokument im asymmetrischen Layout des \CDs gesetzt.
-
-Dieses Verhalten kann mit \Option*{geometry}[false] deaktiviert werden und der
-Satzspiegel wird durch das Paket \Package{typearea} nach typografischen
-Gesichtspunkten konstruiert. Dabei ist die \KOMAScript"=Option \Option{DIV}
-maßgeblich für die Aufteilung des Satzspiegels verantwortlich. Des Weiteren
-spielt die \KOMAScript"=Option \Option{BCOR} für die Bindekorrektur eine Rolle.
-Diese wird in \autoref{sec:bcor} erläutert.
+gesetzt werden soll. Ist Letzteres der Fall, so sollte die \KOMAScript-Option
+\Option{twoside}(\Package{typearea}) als Klassenoption angegeben werden. Im
+nächsten Schritt ist der zu verwendende Satzspiegel festzulegen. Hierfür kann
+die \TUDScript-Option \Option{cdgeometry}'manual' verwendet werden, welche im
+\TUDScript-Handbuch beschrieben wird. Normalerweise wird das Dokument im
+asymmetrischen Layout des \CDs gesetzt.
+
+Dieses Verhalten kann mit \Option*{cdgeometry=false}'manual' deaktiviert werden
+und der Satzspiegel wird durch das Paket \Package{typearea} nach typografischen
+Gesichtspunkten konstruiert. Dabei ist für die Aufteilung des Satzspiegels
+maßgeblich die \KOMAScript-Option \Option{DIV}(\Package{typearea})
+verantwortlich. Mit der \KOMAScript"=Option \Option{BCOR}(\Package{typearea})
+wird die Bindekorrektur angegeben. Diese wird in \autoref{sec:bcor} erläutert.
\subsection{Änderung des Zeilenabstandes (Durchschuss)}
Auf die Änderung des standardmäßigen Zeilenabstandes sollte aus typografischer
Sicht bei der Verwendung einer Standardschrift im Normalfall verzichtet werden.
Die Gründe hierfür werden im Handbuch von \TUDScript bei der Vorstellung des
-Paketes \Package*{setspace} erläutert, welches im Zweifelsfall für dieses
-Anliegen den Befehl \Macro{setstretch} bereitstellt. Wird ein Dokument in der
-\Univers-Hausschrift der \TnUD gesetzt, sollte der Wert von \Macro{setstretch}
-im Bereich 1.05--1.1 liegen.
+Paketes \Package{setspace} erklärt, welches im Zweifelsfall für dieses Anliegen
+den Befehl \Macro{setstretch}(\Package{setspace}) bereitstellt. Wird ein
+Dokument in der \Univers-Hausschrift der \TnUD gesetzt, sollte der Wert von
+\Macro{setstretch}(\Package{setspace}) im Bereich 1.05--1.1 liegen.
\subsection{Bindekorrektur}
-\label{sec:bcor}
+\label{sec:bcor}%
+%
Falls die Arbeit nach der Fertigstellung gebunden werden soll, so ist auf den
notwendigen Binderand zu achten, quasi der Teil einer Seite, welcher durch die
Bindung \enquote{verschwindet} und nicht mehr als sichtbarer Teil der Seite
@@ -335,17 +333,14 @@ ist abhängig von der Anzahl der Seiten sowie der Papierdichte.
Wird qualitativ höherwertiges Papier mit einer Dichte von \SI{100}{g/m^2}
verwendet, so entsprechen 100~Blatt einer Buchblockhöhe von zirka~\SI{12}{mm}.
Dementsprechend wäre in diesem Beispiel eine Bindekorrektur von~\SI{6}{mm}
-notwendig, welche sich mit der Klassenoption \Option*{BCOR}[6mm] einstellen
-ließe. Sollte die erwartete Seitenzahl davon abweichen, kann die einzustellende
+notwendig, die sich mit der Klassenoption \Option*{BCOR=6mm} einstellen ließe.
+Sollte die erwartete Seitenzahl davon abweichen, kann die einzustellende
Bindekorrektur linear skaliert werden. Für differierende Papierdichten sollte
die Buchblockhöhe für die geschätzte Gesamtseitenanzahl in Erfahrung gebracht
werden.
-
-
-
\section{Umschlagseite und Titel}
Die Umschlagseite und der Titel sind sich in ihrer Gestalt sehr ähnlich.
Allerdings gibt es ein paar kleine Unterschiede. Einerseits werden auf dem
@@ -353,17 +348,17 @@ Cover weniger Informationen als auf der Titelseite ausgegeben. Andererseits
wird der Titel immer im Satzspiegel des restlichen Dokumentes ausgegeben,
wohingegen die Umschlagseite~-- ohne weitere Optionen~-- im asymmetrischen
Layout des \CDs der \TnUD erscheint. Wie dieses Verhalten geändert werden kann,
-ist im Handbuch für \Macro*{makecover} erläutert. Die resultierende Ausgabe des
-nachfolgenden Quelltextauszugs ist in \autoref{fig:title} zu sehen und stellt
-eine mögliche Ausprägung von Umschlagseite und Titel dar.
+ist im Handbuch für \Macro{makecover}'manual' erläutert. Die resultierende
+Ausgabe des nachfolgenden Quelltextauszugs ist in \autoref{fig:title} zu sehen
+und stellt eine mögliche Ausprägung von Umschlagseite und Titel dar.
%
\begin{figure}
-\IncludeStandalone{Title}[1,2]
+\IncludeStandalone{title}[1,2]
\caption{Umschlagseite und Titel}
\label{fig:title}
\end{figure}
-\begin{Trunk!}{Title}
+\begin{Trunk!}{title}
\faculty{Juristische Fakultät}
\department{Fachrichtung Strafrecht}
\institute{Institut für Kriminologie}
@@ -375,25 +370,24 @@ eine mögliche Ausprägung von Umschlagseite und Titel dar.
\thesis{master}
\graduation[M.Sc.]{Master of Science}
\author{%
- Mickey Mouse
- \matriculationnumber{12345678}
- \dateofbirth{2.1.1990}
- \placeofbirth{Dresden}
- \course{Klinische Prognostik}
- \discipline{Individualprognose}
+ Mickey Mouse%
+ \matriculationnumber{12345678}%
+ \dateofbirth{2.1.1990}%
+ \placeofbirth{Dresden}%
+ \course{Klinische Prognostik}%
+ \discipline{Individualprognose}%
\and%
- Donald Duck
- \matriculationnumber{87654321}
- \dateofbirth{1.2.1990}
- \placeofbirth{Berlin}
- \course{Statistische Prognostik}
- \discipline{Makrosoziologische Prognosen}
+ Donald Duck%
+ \matriculationnumber{87654321}%
+ \dateofbirth{1.2.1990}%
+ \placeofbirth{Berlin}%
+ \course{Statistische Prognostik}%
+ \discipline{Makrosoziologische Prognosen}%
}
\matriculationyear{2010}
\supervisor{Dagobert Duck \and Mac Moneysac}
\professor{Prof. Dr. Kater Karlo}
\date{10.09.2014}
-
\makecover
\maketitle
@@ -403,48 +397,52 @@ eine mögliche Ausprägung von Umschlagseite und Titel dar.
\section{Vor- und Nachspann}
In den folgenden Unterabschnitten werden Elemente vorgestellt, welche häufig
-als Bestandteil einer wissenschaftlichen (Abschluss"~)Arbeit gefordert werden,
-wobei meistens nur eine Teilmenge verlangt wird. Die Platzierung oder Position
-der vorgestellten Elemente innerhalb der Arbeit ist nicht eindeutig durch eine
-Norm oder dergleichen festgelegt. Vielmehr gibt es meist eine Richtlinie vom
-verantwortlichen Prüfungsamt oder eine konkrete Vorgabe des wissenschaftlichen
-Mitarbeiters respektive betreuenden Hochschullehrers.
+als Bestandteil einer wissenschaftlichen (Abschluss"~)Arbeit gefordert werden.
+Die Platzierung oder Position der vorgestellten Elemente innerhalb der Arbeit
+ist nicht eindeutig durch eine Norm oder dergleichen festgelegt. Vielmehr gibt
+es meist eine Richtlinie vom verantwortlichen Prüfungsamt oder eine konkrete
+Vorgabe des betreuenden wissenschaftlichen Mitarbeiters oder Hochschullehrers.
Verwenden Sie für ihre Arbeit eine Buchklasse, so können die entsprechenden
-Abschnitte mit \Macro{frontmatter} (Vorspann), \Macro{mainmatter} (Hauptteil)
-und \Macro{backmatter} (Nachspann) gekennzeichnet werden. Einen Anhang starten
-Sie mit \Macro{appendix}, womit unter anderem die Kapitelnummerierung auf
-Großbuchstaben umgeschaltet wird (siehe \scrguide*).
+Abschnitte mit \Macro{frontmatter}(\Package{koma-script}) (Vorspann),
+\Macro{mainmatter}(\Package{koma-script}) (Hauptteil) und
+\Macro{backmatter}(\Package{koma-script}) (Nachspann) gekennzeichnet werden.
+Einen Anhang starten Sie mit \Macro{appendix}(\Package{koma-script}), womit
+unter anderem die Kapitelnummerierung auf Großbuchstaben umgeschaltet wird.
+Weitere Hinweise zu den genannten Befehlen sind im \scrguide nachzulesen.
\subsection{Aufgabenstellung}
-\label{sec:task}
+\label{sec:task}%
+%
Das Erstellen der Aufgabenstellung einer Abschlussarbeit im \CD der \TnUD muss
-das Paket \Package*{tudscrsupervisor} geladen werden.
+das Paket \Package{tudscrsupervisor}'manual' geladen werden.
%
\begin{Preamble}
\usepackage{tudscrsupervisor}
\end{Preamble}
%
-Dieses Paket stellt die Umgebung \Environment*{task} sowie den Befehl
-\Macro*{taskform} bereit. Bei beiden Varianten wird zu Beginn eine Tabelle mit
-Informationen zum Autor erzeugt. Am Ende werden der oder die Betreuer der
-Arbeit sowie Professor und gegebenenfalls der Prüfungsausschussvorsitzende
-ausgegeben. Mit der \Environment*{task}-Umgebung kann zwischen dem Kopf und dem
-Fuß ein beliebiger Inhalt gesetzt werden. Der Befehl \Macro*{taskform} hingegen
-erzeugt eine standardisierte Ausgabe, wobei das zweite obligatorische Argument
-in der \Environment{itemize}-Umgebung verwendet wird und somit \Macro{item} zu
-nutzen ist. Das Resultat des folgenden Quelltextes ist in \autoref{fig:task} zu
-sehen.
+Dieses Paket stellt die Umgebung \Environment{task}'manual' sowie den Befehl
+\Macro{taskform}'manual' bereit. Bei beiden Varianten wird zu Beginn eine
+Tabelle mit Autoreninformationen erzeugt. Am Ende werden der oder die Betreuer
+der Arbeit sowie Professor und gegebenenfalls der Prüfungsausschussvorsitzende
+ausgegeben. Mit der Umgebung \Environment{task}'manual' kann zwischen Kopf und
+Fuß ein beliebiger Inhalt gesetzt werden. Der Befehl \Macro{taskform}'manual'
+hingegen erzeugt eine standardisierte Ausgabe, wobei der Inhalt des zweiten
+obligatorischen Arguments in einer
+\Environment{itemize}(\Package{koma-script},\Package{enumitem})-Umgebung
+verwendet wird und somit \Macro{item}(\Package{koma-script},\Package{enumitem})
+zu nutzen ist. Das Resultat des folgenden Quelltextes ist in \autoref{fig:task}
+zu sehen.
%
\begin{figure}
-\IncludeStandalone{Task}[1,2]
+\IncludeStandalone{task}[1,2]
\caption{Aufgabenstellung in freier und standardisierter Form}
\label{fig:task}
\end{figure}
-\begin{Hint!}{Task}
+\begin{Hint!}{task}
\faculty{Juristische Fakultät}
\department{Fachrichtung Strafrecht}
\institute{Institut für Kriminologie}
@@ -455,15 +453,15 @@ sehen.
}
\thesis{master}
\author{%
- Mickey Mouse
- \matriculationnumber{12345678}
- \course{Klinische Prognostik}
- \discipline{Individualprognose}
+ Mickey Mouse%
+ \matriculationnumber{12345678}%
+ \course{Klinische Prognostik}%
+ \discipline{Individualprognose}%
\and%
- Donald Duck
- \matriculationnumber{87654321}
- \course{Statistische Prognostik}
- \discipline{Makrosoziologische Prognosen}
+ Donald Duck%
+ \matriculationnumber{87654321}%
+ \course{Statistische Prognostik}%
+ \discipline{Makrosoziologische Prognosen}%
}
\matriculationyear{2010}
\issuedate{1.2.2015}
@@ -472,17 +470,17 @@ sehen.
\chairman{Prof. Dr. Primus von Quack}
\professor{Prof. Dr. Kater Karlo}
-\newcommand\taskcontent{%
+\newcommand{\taskcontent}{%
Momentan ist das besagte Thema in aller Munde. Insbesondere wird es
gerade in vielen~-- wenn nicht sogar in allen~-- Medien diskutiert.
- Es ist momentan noch nicht abzusehen, ob und wann sich diese Situation
+ Es ist momentan noch nicht abzusehen, ob und wann sich diese Situation
ändert. Eine kurzfristige Verlagerung aus dem Fokus der Öffentlichkeit
wird nicht erwartet.
Als Ziel dieser Arbeit soll identifiziert werden, warum das Thema
- gerade so omnipräsent ist und wie man diesen Effekt abschwächen
- könnte. Zusätzlich sollen Methoden entwickelt werden, wie sich ein
- ähnlicher Vorgang zukünftig vermeiden ließe.
+ gerade so omnipräsent ist und wie dieser Effekt abgeschwächt werden
+ könnte. Zusätzlich sind Methoden zu entwickeln, mit denen sich ein
+ ähnlicher Vorgang zukünftig vermeiden lässt.
}
\begin{task}
@@ -501,17 +499,17 @@ sehen.
\end{Hint!}
\begin{Trunk+}
-\newcommand\taskcontent{%
+\newcommand{\taskcontent}{%
Momentan ist das besagte Thema in aller Munde. Insbesondere wird es
gerade in vielen~-- wenn nicht sogar in allen~-- Medien diskutiert.
- Es ist momentan noch nicht abzusehen, ob und wann sich diese Situation
+ Es ist momentan noch nicht abzusehen, ob und wann sich diese Situation
ändert. Eine kurzfristige Verlagerung aus dem Fokus der Öffentlichkeit
wird nicht erwartet.
Als Ziel dieser Arbeit soll identifiziert werden, warum das Thema
- gerade so omnipräsent ist und wie man diesen Effekt abschwächen
- könnte. Zusätzlich sollen Methoden entwickelt werden, wie sich ein
- ähnlicher Vorgang zukünftig vermeiden ließe.
+ gerade so omnipräsent ist und wie dieser Effekt abgeschwächt werden
+ könnte. Zusätzlich sind Methoden zu entwickeln, mit denen sich ein
+ ähnlicher Vorgang zukünftig vermeiden lässt.
}
\taskform[pagestyle=empty]{\taskcontent}{%
\item Recherche
@@ -529,20 +527,20 @@ Häufig wird zu Beginn einer wissenschaftliche Arbeit die Motivation und der
Inhalt dieser zusammengefasst, um den Leser die Thematik der Abhandlung
vorzustellen. in den meisten Fällen wird diese dabei in deutscher und
englischer Sprache verfasst. Hierfür stellt \KOMAScript{} bereits die Umgebung
-\Environment*{abstract} bereit. Vielfach wird der Wunsch geäußert, sowohl die
-deutsche als auch die englische Zusammenfassung auf derselben Seite zu setzen.
-Diese Variante kann mithilfe der \TUDScript-Klassen sehr einfach umgesetzt
-werden, wie der nachfolgende Quelltextauszug zeigt. Die resultierende Ausgabe
-ist in \autoref{fig:abstr} zu sehen.
+\Environment{abstract}'manual' bereit. Vielfach wird der Wunsch geäußert,
+sowohl die deutsche als auch die englische Zusammenfassung auf derselben Seite
+zu setzen. Diese Variante kann mithilfe der \TUDScript-Klassen sehr einfach
+umgesetzt werden, wie der nachfolgende Quelltextauszug zeigt. Die resultierende
+Ausgabe ist in \autoref{fig:abstr} zu sehen.
%
\begin{figure}
\centering
-\IncludeStandalone[width=.5\textwidth]{Abstract}
+\IncludeStandalone[width=.5\textwidth]{abstract}
\caption{Zusammenfassung in deutscher und englischer Sprache}
\label{fig:abstr}
\end{figure}
-\begin{Trunk!}{Abstract}
+\begin{Trunk!}{abstract}
\TUDoption{abstract}{multiple,section}
\begin{abstract}
Dies ist der deutschsprachige Teil der Zusammenfassung, in dem die
@@ -560,23 +558,23 @@ ist in \autoref{fig:abstr} zu sehen.
\subsection{Selbstständigkeitserklärung und Sperrvermerk}
Für die meisten Abschlussarbeiten an der \TnUD wird vom Verfasser eine
Selbstständigkeitserklärung verlangt. Für diese wird ein Standardtext
-bereitgestellt. Dieser kann mit dem Befehl \Macro*{confirmation} ausgegeben
-werden. Wurde das Thema in Kooperation mit einem Unternehmen bearbeitet, so
-wird zumeist auch ein Sperrvermerk gefordert, welcher mit \Macro*{blocking}
-erzeugt werden kann. Mit \Macro*{declaration} werden beide Erklärungen direkt
-nacheinander erzeugt. Die verwendete Überschrift und ein möglicher Eintrag in
-das Inhaltsverzeichnis können über die Option \Option*{declaration} reguliert
-werden. Eine mögliche Ausprägung der Erklärungen ist in \autoref{fig:decl}
-abgebildet.
+bereitgestellt. Dieser kann mit dem Befehl \Macro{confirmation}'manual'
+ausgegeben werden. Wurde das Thema in Kooperation mit einem Unternehmen
+bearbeitet, so wird zumeist auch ein Sperrvermerk gefordert, welcher mit
+\Macro{blocking}'manual' erzeugt werden kann. Mit \Macro{declaration}'manual'
+lassen sich beide Erklärungen direkt nacheinander erzeugen. Die verwendete
+Überschrift und ein möglicher Eintrag in das Inhaltsverzeichnis können über die
+Option \Option{declaration}'manual' reguliert werden. Eine mögliche Ausprägung
+der Erklärungen ist in \autoref{fig:decl} abgebildet.
%
\begin{figure}
\centering
-\IncludeStandalone[width=.5\textwidth]{Declaration}
+\IncludeStandalone[width=.5\textwidth]{declaration}
\caption{Selbstständigkeitserklärung und Sperrvermerk}
\label{fig:decl}
\end{figure}
-\begin{Hint!}{Declaration}
+\begin{Hint!}{declaration}
\title{%
Entwicklung eines optimalen Verfahrens zur Eroberung des
Geldspeichers in Entenhausen
@@ -590,26 +588,44 @@ abgebildet.
\end{Trunk+}
\subsection{Inhalts-, Abbildungs-, und Tabellenverzeichnis}
-Das Inhaltsverzeichnis wird mit dem \hologo{LaTeX}"=Standardbefehl
-\Macro{tableofcontents} erzeugt und führt die Gliederung des erstellten
-Dokumentes entsprechend der verwendeten Befehle (\Macro{part}, \Macro{addpart},
-\Macro{chapter}, \Macro{addchap}, \Macro{section}, \Macro{addsec} etc.) auf.
-Wurde das Paket \Package{hyperref} geladen, so werden im Inhaltsverzeichnis
-PDF-Hyperlinks auf die einzelnen Abschnitte erzeugt.
+Das Inhaltsverzeichnis wird mit \Macro{tableofcontents}(\Package{koma-script})
+erzeugt und führt die Gliederung des erstellten Dokumentes entsprechend der
+verwendeten Befehle%
+\footnote{%
+ \Macro{part}(\Package{koma-script}),
+ \Macro{addpart}(\Package{koma-script}),
+ \Macro{chapter}(\Package{koma-script}),
+ \Macro{addchap}(\Package{koma-script}),
+ \Macro{section}(\Package{koma-script}),
+ \Macro{addsec}(\Package{koma-script}) etc.%
+}
+auf. Wurde das Paket \Package{hyperref} geladen, so werden im
+Inhaltsverzeichnis PDF-Hyperlinks auf die einzelnen Abschnitte erzeugt.
Sowohl Abbildungen als auch Tabellen werden in \hologo{LaTeX} normalerweise
mit speziellen Umgebungen~-- \Environment{figure} und \Environment{table}~--
eingebunden. Innerhalb dieser sogenannten Gleitumgebungen kann der Befehl
-\Macro{caption}\OParameter{Verzeichniseintrag}\Parameter{Bezeichnung} genutzt
-werden, um diesen eine Bezeichnung hinzuzufügen. Mit \Macro{listoffigures}
-beziehungsweise \Macro{listoftables} lassen sich Verzeichnisse erstellen, in
-denen alle Gleitobjekte des jeweiligen Typs ausgegeben werden, falls diese denn
-eine Bezeichnung hinzugefügt wurde. Sollen Abbildungen oder Tabellen außerhalb
-ihrer angestammten Gleitumgebung genutzt und benannt werden, kann dies mit dem
-Befehl \Macro{captionof}\Parameter{Typ}\OParameter{Verzeichniseintrag}
-\Parameter{Bezeichnung} erfolgen. Weitere Informationen diesbezüglich sind der
-\KOMAScript"=Anleitung \scrguide zu entnehmen. In \autoref{sec:floats} wird
-außerdem genauer auf die Verwendung von Gleitumgebungen eingegangen.
+\Macro{caption}[%
+ \OParameter{Verzeichniseintrag}\Parameter{Bezeichnung}%
+](\Package{koma-script},\Package{caption}) genutzt werden, um diesen eine
+Bezeichnung hinzuzufügen. Mit \Macro{listoffigures}(\Package{koma-script})
+beziehungsweise \Macro{listoftables}(\Package{koma-script}) lassen sich
+Verzeichnisse erstellen, in denen alle Gleitobjekte des jeweiligen Typs
+ausgegeben werden, falls diese denn eine Bezeichnung hinzugefügt wurde.
+
+Sollen Abbildungen oder Tabellen außerhalb ihrer angestammten Gleitumgebung
+\Environment{figure} beziehungsweise \Environment{table} genutzt und benannt
+werden, kann dies entweder mit dem Befehl
+\Macro{captionof}[%
+ \Parameter{Typ}\OParameter{Verzeichniseintrag}\Parameter{Bezeichnung}%
+](\Package{koma-script}) oder~-- falls die beiden Pakete \Package{caption} und
+\Package{hyperref} genutzt werden~-- auch wie gewohnt mit
+\Macro{caption}(\Package{koma-script},\Package{caption}) allerdings zusätzlich
+ergänzt mit einem zuvor aufgerufenem
+\Macro{captionsetup}[\PParameter{type=figure/table}](\Package{caption})
+erfolgen. Weitere Informationen diesbezüglich sind dem \scrguide respektive der
+Anleitung zu \Package{caption} zu entnehmen. In \autoref{sec:floats} wird
+genauer auf Gleitumgebungen eingegangen.
%
\begin{Trunk}
\tableofcontents
@@ -622,7 +638,7 @@ außerdem genauer auf die Verwendung von Gleitumgebungen eingegangen.
\printsymbols[style=symblongtabu]
\setchapterpreamble{%
- \renewcommand*\dictumwidth{.4\textwidth}%
+ \renewcommand*{\dictumwidth}{.4\textwidth}%
\dictum[Johann Wolfgang von Goethe]{%
Es irrt der Mensch, solang er strebt.%
}%
@@ -639,7 +655,8 @@ der weiteren Umgebungen und Befehle demonstriert, welche im Tutorial
\subsection{Abkürzungs- und Symbolverzeichnis}
-\label{sec:glossaries}
+\label{sec:glossaries}%
+%
Für die Auszeichnung von Abkürzungen gibt es zwei sehr gute Pakete, die dieses
Unterfangen stark vereinfachen. Die einfachere~-- jedoch nicht so mächtige~--
der beiden Varianten ist die Nutzung des Paketes \Package{acro}. Sollen nur
@@ -666,11 +683,17 @@ offen lässt.
Das Paket \Package{glossaries} sollte immer \emph{nach} \Package{hyperref}
geladen werden. Entweder Sie achten explizit darauf oder Sie verwenden den
-Befehl \Macro{AfterPackage*} aus dem \KOMAScript-Bundle. Mit diesem können Sie
-die Ausführung von Quelltext bis zum Laden eines Paketes verzögern. Allerdings
-ist darauf zu achten, dass der Quelltext nur ausgeführt wird, wenn auch das
-avisierte Zielpaket geladen wird. Die für \Package{glossaries} verwendeten
-Optionen werden kurz erläutert.
+Befehl \Macro{AfterPackage*}(\Package{scrbase}) aus dem \KOMAScript-Bundle. Mit
+diesem können Sie die Quelltext nach dem Laden eines Paketes ausführen.
+\Attention{%
+ Es ist allerdings darauf zu achten, dass der Quelltext nur ausgeführt wird,
+ wenn das avisierte Zielpaket auch tatsächlich geladen wird.
+}
+Falls Sie demnach auf \Package{hyperref} jedoch nicht auf \Package{glossaries}
+verzichten möchten, sollte der nachfolgende Quelltext am Ende der Präambel
+eingefügt werden.
+
+Die für \Package{glossaries} verwendeten Optionen werden kurz erläutert.
%
\begin{Preamble+}
\AfterPackage*{hyperref}{%
@@ -679,91 +702,143 @@ Optionen werden kurz erläutert.
\usepackage[%
\end{Preamble}
%
-Das Programm \Application{makeindex} wird im Normalfall durch die genutzte
-\hologo{LaTeX}"=Distribution bereitgestellt und für das alphabetische Sortieren
-der erstellten Listen verwendet. Mit der Paketoption \Option{automake} erfolgt
-der automatische Aufruf von \Application{makeindex} mit den passenden
-Einstellungen für alle Verzeichnisse.
-
-Alternativ dazu kann die Option \Option{xindy} aktiviert werden, welche
-\Application{xindy} anstelle von \Application{makeindex} für das Sortieren
-verwendet. Dieses Programm bietet unter anderem eine Unterstützung von Unicode
-sowie die Möglichkeit, nach sprachabhängigen Regeln zu sortieren. Allein für
-die deutsche Sprache gibt es beispielsweise zwei verschiedene Varianten~-- nach
-DIN und nach Duden~-- zum alphabetischen Sortieren. Ich persönlich würde~--
-aufgrund der genannten Vorteile~-- der Verwendung von \Application{xindy} immer
-den Vorzug geben.
+Die zwei Paketoptionen \Option{acronym}(\Package{glossaries}) sowie
+\Option{symbols}(\Package{glossaries}) erzeugen die beiden Verzeichnisse für
+Abkürzungen und Symbole. Die Option \Option{nomain}(\Package{glossaries}) wird
+immer dann verwendet, wenn im Dokument kein zusätzliches allgemeines oder
+technisches Glossar erzeugt werden soll.
%
\begin{Preamble}
- automake,%
+ acronym,% Abkürzungen
+ symbols,% Formelzeichen
+ nomain,% kein Glossar
\end{Preamble}
%
-Leider wird das Programm \Application{xindy} lediglich mit den Distributionen
-\Distribution{\hologo{TeX}~Live} und \Distribution{Mac\hologo{TeX}} jedoch
-nicht mit \Distribution{\hologo{MiKTeX}} geliefert. Soll \Application{xindy}
-mit der letztgenannten Distribution genutzt werden, muss diese Anwendung
-manuell installiert werden. Mit \Option{xindy}[\{language=german-din\}] kann
-für \Application{xindy} du zu verwendende Spracheinstellung für die Sortierung
-angegeben werden.
+Durch \Option{nogroupskip}(\Package{glossaries}) wird der automatische Abstand
+zwischen den Einträgen zur Gruppierung innerhalb eines Glossars entfernt, die
+Option \Option{toc}(\Package{glossaries}) fügt alle erzeugten Verzeichnisse
+dem Inhaltsverzeichnis hinzu, \Option{section}(\Package{glossaries}) bestimmt
+die Gliederungsebene der Überschrift.
%
\begin{Preamble}
-% mit Tex Live einfach verwendbar
-% xindy,
+ nogroupskip,%
+ toc,%
+ section=chapter,%
\end{Preamble}
%
-Für das Erstellen der Glossare mit \Application{xindy} sollte das Perl"=Skript
-\Application{makeglossaries} verwendet werden, welches alle notwendigen
-Optionen an die Anwendung weiterleitet. Treten Probleme bei der Erzeugung der
-einzelnen Glossare auf, sollte die Dokumentation von \Package{glossaries}
-weiterhelfen können.
-%
-Die Optionen \Option{acronym} und \Option{symbols} erzeugen die Glossare
-beziehungsweise die Verzeichnisse für Abkürzungen und Symbole. Die Option
-\Option{nomain} wird verwendet, weil in diesem Tutorial kein zusätzliches
-technisches Glossar erzeugt werden soll.
+Mit der Option \Option{nostyles}(\Package{glossaries}) kann man gegebenenfalls
+das Laden der von \Package{glossaries} vordefinierten Stilen verhindern. Dies
+ist insbesondere sinnvoll, wenn für die einzelnen Glossare und Verzeichnisse
+ohnehin eigene Stile erstellt werden, wie dies nachfolgend geschieht.
%
\begin{Preamble}
- acronym,% Abkürzungen
- symbols,% Formelzeichen
- nomain,% kein Glossar
+ nostyles,%
\end{Preamble}
%
-Mit der Option \Option{translate}[babel] werden die Überschriften der Glossare
-in der Dokumentsprache gesetzt, mit \Option{nogroupskip} kann der automatische
-Abstand zwischen den Einträgen zur Gruppierung innerhalb eines Glossars
-entfernt werden. Die Option \Option{toc} fügt die Verzeichnisse dem
-Inhaltsverzeichnis hinzu, \Option{section} bestimmt die Gliederungsebene der
-Überschrift.
+Mit der Option \Option{translate}(\Package{glossaries}) werden die Überschriften
+aller Glossare in der Dokumentsprache gesetzt, wobei \Option*{translate=babel}
+die Nutzung des Paketes \Package{babel} erzwingt.
%
\begin{Preamble}
translate=babel,%
- nogroupskip,%
- toc,%
- section=chapter,%
\end{Preamble}
%
+Das Paket \Package{glossaries} erstellt bei der Kompilierung des Dokumentes
+Hilfsdateien, anhand derer die Indexe erzeugt und sortiert werden können. Da
+\Engine{pdfLaTeX} diese Funktionalität nicht bereitstellt, ist hierfür der
+Aufruf einer passenden Anwendung notwendig. Die meisten Distributionen stellen
+dafür \Application{makeindex} bereit. Dieses Programm kann prinzipiell zwar
+Einträge alphabetisch sortieren, bietet allerdings weder die Nutzung von
+Unicode-Symbolen noch eine Sprachunterstützung. Aufgrund der genannten
+Nachteile ist \Application{xindy} zum Sortieren der Einträge zu empfehlen, da
+dieses Programm sowohl eine Unterstützung von Unicode als auch die Möglichkeit,
+nach sprachabhängigen Regeln zu sortieren, bietet. Allein für die deutsche
+Sprache gibt es beispielsweise zwei Varianten der Sortierung~-- nach DIN und
+nach Duden.
+
+Ohne weiteres Zutun des Anwenders wird vom Paket \Package{glossaries} in der
+Grundeinstellung \Application{makeindex} genutzt. Soll stattdessen für die
+Sortierung der Glossar- und Verzeichniseinträge \Application{xindy} zum Einsatz
+kommen, muss die Option \Option{xindy}(\Package{glossaries}) aktiviert werden.
+Dieser kann zusätzlich sowohl die zu nutzende Spracheinstellung zur Sortierung
+als auch die gewünschte Eingabekodierung an \Application{xindy} übergeben
+werden. Beispielsweise wird mit \Option*{xindy=\PParameter{language=german-din}}
+die deutsche Sortierung nach~DIN aktiviert.
+%
+%
+\begin{Hint}
+% mit Tex Live einfach verwendbar
+ xindy=§\{§language=german-din§\}§,
+\end{Hint}
+\begin{Preamble+}
+% mit Tex Live einfach verwendbar
+ xindy={language=german-din},
+\end{Preamble+}
+%
+Das Erstellen aller Glossare~-- unabhängig davon, ob \Application{xindy} oder
+\Application{makeindex} für die Sortierung zum Einsatz kommt~-- sollte das
+Perl"~Skript \File{makeglossaries}(\Package{glossaries}) verwendet werden,
+welches alle notwendigen Optionen an die jeweilige Anwendung weiterleitet.
+
+\Attention{%
+ Für den Aufruf von \Application{xindy} selbst als auch für die Ausführung des
+ Skriptes \File{makeglossaries}(\Package{glossaries}) ist ein Perl"=Interpreter
+ notwendig. Dieser wird lediglich von \Distribution{\hologo{TeX}~Live} nicht
+ jedoch von \Distribution{\hologo{MiKTeX}} direkt bereitgestellt. Wird die
+ letztgenannte Distribution verwendet, muss der Anwender gegebenenfalls diesen
+ zusätzlich installieren.
+}
+
+Kann das Skript \File{makeglossaries}(\Package{glossaries}) nicht genutzt
+werden, kann alternativ dazu die Option \Option{automake}(\Package{glossaries})
+aktiviert werden. Diese sorgt dafür, dass am Ende eines \Engine{pdfLaTeX}-Laufs
+der Aufruf von \Application{xindy} oder \Application{makeindex} direkt erfolgt.
+Soll \Application{xindy} verwendet werden, sind dafür allerdings erweiterte
+Schreibrechte notwendig, weshalb für diese Variante \Engine{pdfLaTeX} mit der
+Option \Option{-{}-shell-escape}(\Engine{pdfLaTeX}) respektive
+\Option{-{}-enable-write18}(\Engine{pdfLaTeX}) aufgerufen werden muss. Für
+\Application{xindy} ist außerdem die Angabe der Sprache über die Option
+\Option*{xindy=\PParameter{language=\dots}} zwingend notwendig.
+
+Ist weder die Nutzung des Skriptes \File{makeglossaries}(\Package{glossaries})
+noch der~-- im Zweifel sicherheitskritische~-- Aufruf von \Engine{pdfLaTeX} mit
+erweiterten Schreibrechten möglich, so muss die gewünschte Anwendung für die
+Sortierung explizit durch den Anwender aufgerufen werden, wobei auf die Angabe
+der richtigen Parameter zu achten ist. Genaueres hierzu sowie Lösungen für
+Probleme beim Erstellen der Glossare und Verzeichnisse sind in der Dokumentation
+von \Package{glossaries} zu finden.
+%
+\begin{Hint}
+ automake,%
+\end{Hint}
+%
Damit sind alle verwendeten Optionen erläutert. Schließlich sorgt der Befehl
-\Macro{makeglossaries} für das Erstellen der optionsabhängigen Stildateien für
-\Application{makeindex} respektive \Application{xindy} sowie das Erzeugen der
-benötigten Hilfsdateien.
+\Macro{makeglossaries}(\Package{glossaries}) für das Erstellen der
+optionsabhängigen Stildateien für \Application{makeindex} respektive
+\Application{xindy} sowie das Erzeugen der benötigten Hilfsdateien.
%
\begin{Preamble}
]{glossaries}
\makeglossaries
-
\end{Preamble}
+\begin{Preamble+}
+}% Ende von AfterPackage
+
+\AfterPackage*{glossaries}{%
+\end{Preamble+}
%
Damit wäre der erste Teil zur Initialisierung überstanden und wir können zum
-eigentlichen Problem kommen. Wie erstellt man nun ein Abkürzungs- und/oder
-Symbolverzeichnis?
+eigentlichen Problem kommen. Wie wird nun ein Abkürzungs- und/oder
+Symbolverzeichnis erstellt?
\subsubsection{Abkürzungsverzeichnis}
Das Paket \Package{glossaries} stellt für die Definition von Abkürzungen einen
-speziellen Befehl bereit. Mit\Macro{newacronym}\LParameter\Parameter{Label}%
-\Parameter{Abkürzung}\Parameter{Wortgruppe} wird eine Abkürzung definiert und
-kann später über \Parameter{Label} genutzt werden. Die möglichen optionalen
-Parameter können in der Dokumentation zu \Package{glossaries} nachgeschlagen
-werden. Für ein kleines Beispiel werden drei Abkürzungen erstellt\dots
+speziellen Befehl bereit. Mit \Macro{newacronym}[%
+ \LParameter\Parameter{Label}\Parameter{Abkürzung}\Parameter{Wortgruppe}%
+](\Package{glossaries}) wird eine Abkürzung definiert und kann später über
+\Parameter{Label} genutzt werden. Die möglichen optionalen Parameter können in
+der Dokumentation zu \Package{glossaries} nachgeschlagen werden. Für ein
+kleines Beispiel werden drei Abkürzungen erstellt\dots
%
\begin{Trunk+}
\section{Die Verwendung von Akronymen und Symbolen}
@@ -775,8 +850,8 @@ werden. Für ein kleines Beispiel werden drei Abkürzungen erstellt\dots
\end{Trunk*}
%
-\dots und diese in einer kurzen Textpassage mit \Macro{gls}\Parameter{Label}
-verwendet.
+\dots und diese in einer kurzen Textpassage mit dem \Package{glossaries}"=Befehl
+\Macro{gls}[\Parameter{Label}](\Package{glossaries}) verwendet.
%
\begin{Trunk*}
In der Graphentheorie wird häufig die Lösung des Problems des kürzesten
@@ -788,20 +863,29 @@ oder \gls{apsp} kommen unterschiedliche Algorithmen zum Einsatz.
\end{Trunk*}
%
Gut zu sehen ist, dass sich die Ausgabe der Abkürzung bei der ersten Verwendung
-mit \Macro{gls} von der zweiten~-- und jeder weiteren~-- unterscheidet. Das
-Verhalten lässt sich über verschiedene Stile mit \Macro{setacronymstyle}
-anpassen. Die Ausgabe einer Liste aller Abkürzungen erfolgt mit:
+mit \Macro{gls}(\Package{glossaries}) von der zweiten~-- und jeder weiteren~--
+unterscheidet. Das Verhalten lässt sich über verschiedene Stile mit
+\Macro{setacronymstyle}(\Package{glossaries}) anpassen. Die Ausgabe einer Liste
+aller Abkürzungen erfolgt mit:
%
\begin{Hint}
\printacronyms
\end{Hint}
+\newglossarystyle{simple}{%
+ \renewenvironment{theglossary}{}{\par}%
+ \renewcommand*{\glossentry}[2]{%
+ \noindent%
+ \textsbn{\glsentryitem{##1}\glstarget{##1}\glossentryname{##1}}\quad
+ \glossentrydesc{##1}\glspostdescription\space ##2%
+ \par%
+ }%
+}
\begin{quoting}[rightmargin=0pt]
-\vspace*{-\baselineskipglue}
\glsdisablehyper
-\InputCode
+\printacronyms[style=simple]
\end{quoting}
%
-Dabei werden die Akronyme in einer \Environment{description}"=Umgebung gesetzt,
+Dabei werden die Akronyme in einer \Environment*{description}"=Umgebung gesetzt,
was absolut ausreichend ist. Mir persönlich ist allerdings die Darstellung in
einer quasi-tabellarischen Form lieber. Dabei soll der Stil mit fettgedruckten
Abkürzungen beibehalten werden. Das \Package{glossaries}"=Paket stellt zwar
@@ -809,34 +893,37 @@ auch eine Vielzahl an Stilen in Tabellenform bereit, allerdings nicht in dem
gewünschten. Deshalb wird nachfolgend gezeigt, wie sich ein eigener Stil in
Tabellenform kreieren lässt.
-Es bieten sich die Umgebungen \Environment{tabularx} oder \Environment{tabu}
-an, bei denen die Spaltenbreite teilweise automatisch berechnet wird, um sich
-manuelle Formatierungsarbeiten zu sparen. Folgend werden beide Varianten
-vorgestellt. Falls Sie noch keine Erfahrungen mit dem Tabellensatz in
-\hologo{LaTeXe} haben, lohnt sich vorher ein Blick in \autoref{sec:tables}, um
-die verwendeten Befehle und Umgebungen zu verstehen. Wie Sie Stile definieren,
-die auch Seitenumbrüche in der Tabelle zulassen, können Sie etwas später bei
-Symbolverzeichnissen in diesem \autorefname[sec:glossaries] erfahren.
-
-\minisec{Eigener Stil mit \Environment{tabularx}}
-Für das Definieren eines eigenen Glossarstils wird \Macro{newglossarystyle}
-verwendet, wobei für den neuen Stils die Umgebung \Environment{theglossary}
-umdefiniert wird. Als erstes kommt die Tabellenumgebung \Environment{tabularx}
-aus dem gleichnamigen Paket, welches in \autoref{sec:tabularx} vorgestellt
-wird, zum Einsatz.
+Es bieten sich die Umgebungen \Environment{tabularx}(\Package{tabularx}) oder
+\Environment{tabu}(\Package{tabu}) an, bei denen die Spaltenbreite teilweise
+automatisch berechnet wird, um sich manuelle Formatierungsarbeiten zu sparen.
+Folgend werden beide Varianten vorgestellt. Falls Sie noch keine Erfahrungen
+mit dem Tabellensatz in \hologo{LaTeXe} haben, lohnt sich vorher ein Blick in
+\autoref{sec:tables}, um die verwendeten Befehle und Umgebungen zu verstehen.
+Wie Sie Stile definieren, die Seitenumbrüche in einer Tabelle zulassen, können
+Sie in diesem \autorefname[sec:glossaries] bei der Symbolverzeichniserstellung
+erfahren.
+
+\minisec{Eigener Stil mit \Environment*{tabularx}}
+Ein eigener Glossarstil kann mit \Macro{newglossarystyle}(\Package{glossaries})
+definiert werden, wobei für den neu definierten Stil die Umgebung
+\Environment{theglossary}(\Package{glossaries}) umdefiniert wird. Als erstes
+kommt die Tabellenumgebung \Environment{tabularx}(\Package{tabularx}) aus dem
+gleichnamigen Paket, welches in \autoref{sec:tabularx} vorgestellt wird, zum
+Einsatz.
Es werden in der Tabelle drei Spalten definiert. Die erste und letzte Spalte
sind schlicht linksbündige Standardspalten~(\PValue{l}). In diesen werden die
Abkürzungen selbst sowie die Seitenzahlen eingetragen. Die Verwendung
-von~\PValue{@\{\}} führt dazu, dass der normalerweise vor der ersten und nach
-der letzten Spalte eingefügte Abstand von \Length{tabcolsep} entfällt. Die
-Breite der Spalte vom Typ~\PValue{X} wird automatisch berechnet.
+von~\PValue{@\PParameter{}} führt dazu, dass der normalerweise vor der ersten
+und nach der letzten Spalte eingefügte Abstand von \Length{tabcolsep} entfällt.
+Die Breite der Spalte vom Typ~\PValue{X} wird automatisch berechnet.
-Aufgrund der Implementierung von \Environment{tabularx} lässt sich diese nicht
-als verschachtelte Umgebung verwenden. Allerdings kann man stattdessen die mit
-\Macro{tabularx} und \Macro{endtabularx} die Low"~Level"~Variante nutzen. Die
-Definition des neuen Stils \PValue{acrotabularx} wird nachfolgend ausgegeben,
-die weitergehende Erläuterung schließt sich daran an.
+Aufgrund der Implementierung von \Environment{tabularx}(\Package{tabularx})
+lässt sich diese nicht als verschachtelte Umgebung verwenden. Allerdings kann
+stattdessen die mit \Macro*{tabularx} sowie \Macro*{endtabularx} die
+Low"~Level"~Variante genutzt werden. Die Definition des neuen Stils
+\PValue{acrotabularx} wird nachfolgend ausgegeben, die weitergehende
+Erläuterung schließt sich daran an.
%
\CodeHook{\let\newglossarystyle\renewglossarystyle}
\begin{Hint*}
@@ -860,31 +947,32 @@ die weitergehende Erläuterung schließt sich daran an.
\end{Hint*}
%
Der Rest des Stils ist schnell erläutert. Zunächst wird auf Tabellenköpfe
-(\Macro{glossaryheader}) sowie Überschriften und Abstände bei Gruppierungen
-(\Macro{glsgroupheading} und \Macro{glsgroupskip}) verzichtet. Der Befehl
-\Macro{glossentry} ist verantwortlich für die Formatierung der Einträge
-im Abkürzungsverzeichnis. Dieser wird intern durch \Package{glossaries} mit
-zwei obligatorischen Argumenten aufgerufen.Das erste enthält das entsprechende
-Label, das zweite ein kommaseparierte Liste der Seitenzahlen. Dabei stehen
-verschiedene Makros zur Auswahl, um anhand des gegebenen Labels die gewünschten
-Informationen zu extrahieren.%
+(\Macro{glossaryheader}(\Package{glossaries})) sowie Überschriften und Abstände
+bei Gruppierungen (\Macro{glsgroupheading}(\Package{glossaries}) sowie
+\Macro{glsgroupskip}(\Package{glossaries})) verzichtet. Der Befehl
+\Macro{glossentry}(\Package{glossaries}) ist verantwortlich für die
+Formatierung der Einträge im Abkürzungsverzeichnis. Dieser wird intern durch
+\Package{glossaries} mit zwei obligatorischen Argumenten aufgerufen. Das erste
+enthält das entsprechende Label, das zweite ein kommaseparierte Liste der
+Seitenzahlen. Dabei stehen verschiedene Makros zur Auswahl, um anhand des
+gegebenen Labels die gewünschten Informationen zu extrahieren.%
\footnote{%
- bspw. mit \Macro{glossentryname} die Bezeichnung oder mit
- \Macro{glsentrydesc} die dazugehörige Beschreibung%
+ bspw. mit \Macro{glossentryname}(\Package{glossaries}) die Bezeichnung oder
+ mit \Macro{glsentrydesc}(\Package{glossaries}) die dazugehörige Beschreibung%
}
-Der Befehl \Macro{glossentry} wurde so definiert, dass für jeden Eintrag eine
-separate Zeile in der Tabelle erzeugt wird, wo in der ersten Spalte die
-Abkürzung selbst, in der zweiten die Langform und in der dritten Spalte
-schließlich die Liste der Seiten, auf welchen die jeweilige Abkürzung mit
-\Macro{gls}\Parameter{Label} verwendet wurde, ausgegeben wird. Zum Abschluss
-die resultierende Ausgabe des Abkürzungsverzeichnisses im neuen Stil.
+Der Befehl \Macro{glossentry}(\Package{glossaries}) wurde so definiert, dass
+für jeden Eintrag eine separate Zeile in der Tabelle erzeugt wird, wo in der
+ersten Spalte die Abkürzung selbst, in der zweiten die Langform und in der
+dritten Spalte schließlich die Liste der Seiten, auf welchen die jeweilige
+Abkürzung mit \Macro{gls}[\Parameter{Label}](\Package{glossaries}) verwendet
+wurde, ausgegeben wird. Zum Abschluss die resultierende Ausgabe des
+Abkürzungsverzeichnisses im neuen Stil.
%
\begin{Hint}
\printacronyms[style=acrotabularx]
\end{Hint}
\begin{quoting}[rightmargin=0pt]
-\vspace*{-\baselineskipglue}
\InputCode
\end{quoting}
%
@@ -893,31 +981,32 @@ Spalte mehr als ausreichend sein und kein Zeilenumbruch benötigt werden, kann
auch einfach eine \Environment{tabular}"=Umgebung mit einer \PValue{l}"~Spalte
anstelle von \PValue{X} verwendet werden.
-\minisec{Eigener Stil mit \Environment{tabu}}
-Die sehr komfortabel zu nutzende Umgebung \Environment{tabu} wird durch das
-Paket \Package{tabu} bereitgestellt. Es wird in \autoref{sec:tabu} vorgestellt,
-wobei die dortigen Anmerkungen \emph{unbedingt} zu beachten sind. Ähnlich zu
-\Environment{tabularx} bietet auch die \Environment{tabu}-Umgebung einen
-\PValue{X}"~Spaltentyp. Allerdings gibt es hier eine Besonderheit. Für
-\Environment{tabularx}"=Tabellen muss generell eine feste Tabellenbreite
-angegeben werden. Die Breite der \PValue{X}"~Spalten wird anhand der
-angegebenen, gewünschten Gesamtbreite und dem bereits für andere Spalten vom
+\minisec{Eigener Stil mit \Environment*{tabu}}
+Die sehr komfortabel zu nutzende Umgebung \Environment{tabu}(\Package{tabu})
+wird durch das Paket \Package{tabu} bereitgestellt. Es wird später in
+\autoref{sec:tabu} vorgestellt, wobei die dortigen Anmerkungen \emph{unbedingt}
+zu beachten sind. Für die bereits verwendeten
+\Environment{tabularx}(\Package{tabularx})"=Tabellen muss generell eine feste
+Tabellenbreite angegeben werden. Die Breite der \PValue{X}"~Spalten wird anhand
+der angegebenen Gesamtbreite und dem für andere Spalten vom
Typ~\PValue{l},~\PValue{r}~und~\PValue{c} benötigten Platz berechnet.
-Für \Environment{tabu}"=Tabellen kann anstelle einer fest vorgegebenen Breite
-auch \PValue{spread~0pt} angegeben werden. Dadurch werden \PValue{X}"~Spalten
-anfänglich in ihrer natürlichen Breite gesetzt. Sobald jedoch die Gesamtbreite
-der Tabelle den zur Verfügung stehenden Platz bis zum Zeilenende überschreiten
-würde, werden die \PValue{X}"~Spalten automatisch umbrochen.
+Wie \Environment{tabularx}(\Package{tabularx}) bietet auch die Umgebung
+\Environment{tabu}(\Package{tabu}) einen \PValue{X}"~Spaltentyp. Für diese kann
+jedoch anstelle einer fest vorgegebenen Breite auch \PValue{spread~0pt}
+angegeben werden. Dadurch werden \PValue{X}"~Spalten anfänglich in ihrer
+natürlichen Breite gesetzt. Sobald jedoch die Gesamtbreite der Tabelle den zur
+Verfügung stehenden Platz bis zum Zeilenende überschreiten würde, werden die
+\PValue{X}"~Spalten automatisch umbrochen.
In umbrochenen Spalten gibt es beim Paket \Package{tabu} jedoch ein kleineres
-Problem. In diesen setzt \Package{tabu} zu wenig vertikalen Freiraum am unteren
+Problem. In diesen setzt \Package{tabu} zu wenig vertikalen Leerraum am unteren
Ende. Um dieses Manko zu beheben, wird am Schluss jeder \PValue{X}"~Spalte mit
-\PValue{X<\{\Macro{strut}\}} einfach der Befehl \Macro{strut} angehängt, der
-vertikalen Freiraum ober- und unterhalb der aktuellen Grundlinie einfügt. In
-\autoref{sec:tables} wird ein Ansatz aufgezeigt, wie man dies automatisiert
-über einen neuen Spaltenstil ausmerzen kann. Der Rest des Stils ist identisch
-zu \PValue{acrotabularx}.
+\PValue{X<\PParameter{\Macro{strut}}} einfach der Befehl \Macro{strut}
+angehängt, der vertikalen Leerraum ober- und unterhalb der aktuellen Grundlinie
+einfügt. In \autoref{sec:tables} wird ein Ansatz aufgezeigt, wie dies
+automatisiert über einen neuen Spaltenstil ausmerzt werden kann. Der Rest des
+Stils ist identisch zu \PValue{acrotabularx}.
%
\CodeHook{\let\newglossarystyle\renewglossarystyle}
\begin{Preamble*}
@@ -944,7 +1033,6 @@ zu \PValue{acrotabularx}.
\end{Hint}
\begin{quoting}[rightmargin=0pt]
\glsdisablehyper
-\vspace*{-\baselineskipglue}
\InputCode
\end{quoting}
%
@@ -959,21 +1047,23 @@ Seitenumbruch zulässt, sollte Sie den nächsten Abschnitt lesen.
Für das Erzeugen eines Symbolverzeichnisses kann ebenfalls \Package{glossaries}
verwendet werden. Allerdings muss dazu ein wenig mehr Aufwand getrieben werden,
da das Paket hierfür keine dedizierte Schnittstelle bereitstellt. Wurde die
-Paketoption \Option{symbols} angegeben wird jedoch zumindest das notwendige
-Glossar erstellt.
+Paketoption \Option{symbols}(\Package{glossaries}) angegeben wird jedoch
+zumindest das notwendige Glossar erstellt.
Als erstes sollte ein gut nutzbarer Befehl zum Definieren eines neuen Symbols
-erstellt werden. In Anlehnung an den Befehl für Abkürzungen wird dieser
-\Macro{newsymbol} genannt. Dieser hat ein optionales und vier obligatorische
-Argumente, wobei das optionale Argument prinzipiell alle Schlüssel-Wert-Paare
-enthalten kann, die durch \Package{glossaries} akzeptiert werden. Welche davon
-letztlich auch Auswirkungen haben, hängt allerdings von der Gestaltung des
-Stils durch den Anwender ab. Der nachfolgend definierte Befehl hat folgende
-Gestalt:
+erstellt werden. In Anlehnung an den Befehl für Abkürzungen \Macro*{newacronym}
+wird er \Macro{newsymbol}|?| genannt. Dieser hat genau ein optionales und vier
+obligatorische Argumente, wobei das optionale Argument prinzipiell alle
+Schlüssel-Wert-Paare enthalten kann, die durch \Package{glossaries} akzeptiert
+werden. Welche davon letztlich auch Auswirkungen haben, hängt allerdings von
+der Gestaltung des Stils durch den Anwender ab. Der nachfolgend definierte
+Befehl hat folgende Gestalt:
%
\begin{quoting}[leftmargin=\parindent]
-\Macro{newsymbol}\LParameter\Parameter{Label}\Parameter{Bezeichnung}%
-\Parameter{Symbol}\Parameter{Einheit}
+\Macro{newsymbol}[%
+ \LParameter\Parameter{Label}\Parameter{Bezeichnung}%
+ \Parameter{Symbol}\Parameter{Einheit}%
+]|?|%
\end{quoting}
%
Mit \PName{Label} erfolgt die eindeutige Kennzeichnung des Symbols. Außerdem
@@ -989,8 +1079,8 @@ physikalische \PName{Einheit}.
\newcommand*{\newsymbol}[5][]{%
\newglossaryentry{#2}{%
type=symbols,%
- description={},%
name={#3},%
+ description={\nopostdesc},%
symbol={\ensuremath{#4}},%
user1={\ensuremath{\mathrm{#5}}},%
sort={#2},%
@@ -1004,11 +1094,11 @@ Da es sich zumeist um mathematische Symbole handelt, wird für das Symbol und
die Einheit mit \Macro{ensuremath} Sorge getragen, dass diese auch im
Textmodus ohne Probleme verwendet werden können. Für das aufrechte Setzen der
Einheit wird für diese außerdem \Macro{mathrm} verwendet. Als Alternative dazu
-könnte man auch den Befehl \Macro{si} aus dem Paket \Package{siunitx} benutzen.
-Für ein kleines Beispiel werden folgend fünf Formelzeichen definiert. Damit die
-Darstellung der mathematischen Brüche auch für den Fließtext gut genutzt werden
-kann, wird für diese der Befehl \Macro{sfrac} aus dem Paket \Package{xfrac}
-genutzt.
+könnte der Befehl \Macro{si}(\Package{siunitx}) aus dem Paket \Package{siunitx}
+genutzt werden. Für ein kleines Beispiel werden folgend fünf Formelzeichen
+definiert. Damit die Darstellung der mathematischen Brüche auch für den
+Fließtext gut genutzt werden kann und ansehnlich ist, wird für diese der Befehl
+\Macro{sfrac}(\Package{xfrac}) aus dem Paket \Package{xfrac} genutzt.
%
\begin{Trunk*}
\newsymbol{l}{Länge}{l}{m}
@@ -1021,7 +1111,8 @@ genutzt.
\end{Trunk*}
%
Die soeben definierten Symbole werden für ein kleines Beispiel mit dem Befehl
-\Macro{gls}\Parameter{Label} in einer kurzen Textpassage verwendet.
+\Macro{gls}[\Parameter{Label}](\Package{glossaries}) in einer kurzen
+Textpassage verwendet.
%
\begin{Hint*}
Die Einheiten für die \gls{f} sowie die \gls{F} werden aus den
@@ -1034,9 +1125,9 @@ Punktmasse lautet:
%
Das Ergebnis ist nur bedingt befriedigend. Sowohl im Fließtext als auch im
Mathematikmodus werden lediglich die Bezeichnungen jedoch nicht die Symbole
-selbst verwendet. Damit man die Formelzeichen auch für den mathematischen
-Satz sinnvoll nutzen kann, sollte das Erscheinungsbild der Einträge mit
-\Macro{defglsentryfmt} angepasst werden.
+selbst verwendet. Damit die Formelzeichen auch für den mathematischen Satz
+sinnvoll nutzbar sind, sollte das Erscheinungsbild der Einträge mit
+\Macro{defglsentryfmt}(\Package{glossaries}) angepasst werden.
%
\begin{Preamble*}
\defglsentryfmt[symbols]{%
@@ -1048,10 +1139,10 @@ Satz sinnvoll nutzen kann, sollte das Erscheinungsbild der Einträge mit
}
\end{Preamble*}
%
-Diese Definition führt bei der Verwendung von \Macro{gls}\Parameter{Label}
-dazu, dass im Mathematikmodus allein das Symbol verwendet wird. Im Fließtext
-wird diesem zusätzlich die Bezeichnung vorangestellt. Das nachfolgende Beispiel
-macht dies deutlich.
+Bei der Verwendung von \Macro{gls}[\Parameter{Label}](\Package{glossaries})
+führt diese Definition dazu, dass im Mathematikmodus allein das Symbol
+verwendet wird. Im Fließtext wird diesem zusätzlich die Bezeichnung
+vorangestellt. Das nachfolgende Beispiel macht dies deutlich.
%
\begin{Trunk*}
Die Einheiten für die \gls{f} sowie die \gls{F} werden aus den
@@ -1064,15 +1155,15 @@ Punktmasse lautet:
\end{Trunk*}
%
Als nächstes kümmern wir uns um die Ausgabe des Symbolverzeichnisses. Momentan
-erzeugt der Befehl \Macro{printsymbols} jedenfalls kein sinnvolles Verzeichnis:
+erzeugt der Befehl \Macro{printsymbols}(\Package{glossaries}) jedenfalls kein
+sinnvolles Verzeichnis:
%
\begin{Hint}
\printsymbols
\end{Hint}
\begin{quoting}[rightmargin=0pt]
-\vspace*{-\baselineskipglue}
\glsdisablehyper
-\InputCode
+\printsymbols[style=simple]
\end{quoting}
%
Für dieses muss erst ein Stil definiert werden, was nachfolgend ähnlich zum
@@ -1080,29 +1171,34 @@ Stil \PValue{acrotabularx} respektive \PValue{acrotabu} geschieht. Allerdings
wird hier eine Variante gezeigt, mit der die Tabelle einen Seitenumbruch
zulässt.
-\minisec{Eigener Stil mit \Environment{tabularx} und \Environment{longtable}}
+\minisec{Eigener Stil mit \Environment*{tabularx} und \Environment*{longtable}}
Soweit mir bekannt ist, lassen sich umbruchfähige Tabellen nicht direkt mit
-\Environment{tabularx} setzen. Vielmehr ist das Paket \Package{ltxtable}
-notwendig. Dieses wiederum verlangt, dass die zu setzende Tabelle in einer
-separaten Datei abgelegt wird. Möchte man diese dennoch im Hauptdokument
-belassen, kann man die \Environment{filecontents}"=Umgebung nutzen.
+\Environment{tabularx}(\Package{tabularx}) setzen. Vielmehr ist für die
+Verwendung der Umgebung \Environment{longtable}(\Package{longtable}) das Paket
+\Package{ltxtable} notwendig. Dieses wiederum verlangt, dass die zu setzende
+Tabelle in einer separaten Datei abgelegt wird. Soll diese dennoch innerhalb
+des Hauptdokumentes erstellt werden, kann für dieses Unterfangen die Umgebung
+\Environment{filecontents}(\Package{filecontents}) aus dem gleichnamigen Paket
+genutzt werden, womit \emph{bereits existierende Dateien} überschrieben werden.
Leider habe ich keine Möglichkeit gefunden, diesen Prozess ohne wahnsinnig
großen Aufwand für das Erstellen eines Glossars zu portieren. Für umbruchfähige
Tabellen mit automatisch berechneten Spaltenbreiten kommt meines Wissens nach
-momentan nur die Umgebung \Environment{longtabu} aus dem Paket \Package{tabu}
-infrage.
-
-\minisec{Eigener Stil mit \Environment{tabu}}
-Das Paket \Package{tabu} definiert die \Environment{longtabu}"=Umgebung, die
-wiederum auf \Environment{longtable} basiert und nachfolgend verwendet wird.
-Damit diese linksbündig gesetzt wird, muss vor dem obligatorischen Argument mit
-den Spaltendefinitionen noch das optionale Argument \OParameter{l} angegeben
-werden. Die im Stil verwendeten Befehle \Macro{toprule}, \Macro{midrule} sowie
-\Macro{cmidrule} und \Macro{bottomrule} für unterschiedliche horizontale Linien
-stammen allesamt aus dem Paket \Package{booktabs}, welches für den Satz von
-hochwertigen Tabellen eine große Hilfe ist.
-
+momentan nur die Umgebung \Environment{longtabu}(\Package{tabu}) aus dem Paket
+\Package{tabu} infrage.
+
+\minisec{Eigener Stil mit \Environment*{longtabu}}
+Das Paket \Package{tabu} definiert für umbruchfähige Tabellen die Umgebung
+\Environment{longtabu}(\Package{tabu}), welche wiederum auf der Umgebung
+\Environment{longtable}(\Package{longtable}) basiert und nachfolgend verwendet
+wird. Damit diese linksbündig gesetzt wird, muss vor dem obligatorischen
+Argument mit den Spaltendefinitionen noch das optionale Argument \OParameter{l}
+angegeben werden. Die im nachfolgend definierten Stil verwendeten Befehle
+\Macro{toprule}(\Package{booktabs}), \Macro{midrule}(\Package{booktabs}) sowie
+\Macro{cmidrule}(\Package{booktabs}) und \Macro{bottomrule}(\Package{booktabs})
+für unterschiedliche horizontale Linien stammen allesamt aus dem Paket
+\Package{booktabs}, welches für den Satz von hochwertigen Tabellen eine große
+Hilfe ist.
%
\CodeHook{\let\newglossarystyle\renewglossarystyle}
\begin{Preamble*}
@@ -1112,15 +1208,15 @@ hochwertigen Tabellen eine große Hilfe ist.
}{%
\end{longtabu}%
}%
+ \renewcommand*{\glsgroupheading}[1]{}%
+ \renewcommand*{\glsgroupskip}{}%
\renewcommand*{\glossaryheader}{%
\toprule
- \bfseries Symbol & \bfseries Einheit &
- \bfseries Name & \bfseries Seite(n)
+ \bfseries Formelzeichen & \bfseries Einheit &
+ \bfseries Bezeichnung & \bfseries Seite(n)
\tabularnewline\midrule\endhead%
\bottomrule\endfoot%
}%
- \renewcommand*{\glsgroupheading}[1]{}%
- \renewcommand*{\glsgroupskip}{}%
\renewcommand*{\glossentry}[2]{%
\glsentryitem{##1}% Entry number if required
\glstarget{##1}{\glossentrysymbol{##1}} &
@@ -1131,14 +1227,16 @@ hochwertigen Tabellen eine große Hilfe ist.
}
\end{Preamble*}
%
-Innerhalb von \Macro{newglossarystyle} wird \Macro{glossaryheader} für einen
-Tabellenkopf definiert, wie er auch für eine \Environment{longtable}"=Umgebung
-erscheinen würde. In hier vorgestellten Fall werden Kopf beziehungsweise Fuß
-mit \Macro{endhead} respektive \Macro{endfoot} terminiert. Diese werden beim
+Innerhalb von \Macro{newglossarystyle}(\Package{glossaries}) wird der Befehl
+\Macro{glossaryheader}(\Package{glossaries}) für einen Tabellenkopf definiert,
+wie er auch für eine \Environment{longtable}(\Package{longtable})"=Umgebung
+erscheinen würde. In hier vorgestellten Fall werden der Kopf mit dem Makro
+\Macro{endhead}(\Package{longtable}) beziehungsweise der Fuß durch
+\Macro{endfoot}(\Package{longtable}) terminiert. Diese werden beim
einem möglichen Seitenumbruch zu Beginn und am Ende auf jeder Seite gesetzt.
%
\begin{Preamble+}
-}% Ende von AfterPackage*
+}% Ende von AfterPackage
\end{Preamble+}
%
@@ -1157,33 +1255,276 @@ Das Symbolverzeichnis kann sich nun durchaus sehen lassen.
}%
\renewcommand*{\glossaryheader}{%
\toprule
- \bfseries Symbol & \bfseries Einheit &
- \bfseries Name & \bfseries Seite(n)
+ \bfseries Formelzeichen & \bfseries Einheit &
+ \bfseries Bezeichnung & \bfseries Seite(n)
\tabularnewline\midrule%
}%
}
\printsymbols[style=symbtabu]
\end{quoting}
+\minisec{Unterteilung nach griechischen und lateinischen Symbolen}
+Oftmals wird es für Abschlussarbeiten verlangt, das Symbolverzeichnis nach
+griechischen und lateinischen Formelzeichen zu untergliedern. Für die Umsetzung
+dieser Anforderung ist die zuvor beschriebene Lösung prinzipiell nutzbar,
+allerdings muss diese etwas erweitert werden.
+
+Realisiert wird das Ganze, indem die zwei Kategorien respektive Elterneinträge
+\PValue{greekletters} sowie \PValue{romanletters} definiert und sämtliche
+Formelzeichen einem der beiden als Untereintrag zugeordnet werden.
+%
+\begin{Hint*}
+\providecommand*\greeklettersname{Greek letters}
+\providecommand*\romanlettersname{Roman letters}
+\newglossaryentry{greekletters}{%
+ type=symbols,%
+ name={\greeklettersname},%
+ description={\nopostdesc},%
+ sort={a}%
+}
+\newglossaryentry{romanletters}{%
+ type=symbols,%
+ name={\romanlettersname},%
+ description={\nopostdesc},%
+ sort={b}%
+}
+\end{Hint*}
+%
+Die Bezeichnungen der beiden Kategorien könnten auch als Parameter von
+\Macro*{newglossaryentry} mit \PValue{name=\PName{Bezeichung}} direkt
+eingetragen werden. Um bei der Definition jedoch eine gewisse Flexibilität zu
+gewährleisten, wird dies über die zwei Befehle \Macro*{greeklettersname} sowie
+\Macro*{romanlettersname} realisiert. Diese werden mit \KOMAScript-Mitteln
+als sprachabhängige Bezeichner definiert.
+%
+\begin{Hint*}
+\providecaptionname{%
+ american,australian,british,canadian,english,newzealand%
+}{\greeklettersname}{Greek letters}
+\providecaptionname{%
+ german,ngerman,austrian,naustrian,swissgerman,nswissgerman%
+}{\greeklettersname}{Griechische Symbole}
+\providecaptionname{%
+ american,australian,british,canadian,english,newzealand%
+}{\romanlettersname}{Roman letters}
+\providecaptionname{%
+ german,ngerman,austrian,naustrian,swissgerman,nswissgerman%
+}{\romanlettersname}{Lateinische Symbole}
+\end{Hint*}
+%
+Für die Ausgabe wird der Glossarstil \PValue{symbsplitlongtabu} in ähnlicher
+Manier wie die Stile zuvor definiert. Dieser wird darauf ausgelegt, dass alle
+aufzulistenden Formelzeichen als Untereintrag von einem der beiden zuvor
+erstellten Elterneinträge angegeben werden. Allerdings ist bei diesem Stil
+aufgrund der Verwendung von \Environment{longtabu}(\Package{tabu}) etwas
+Aufwand zu betreiben, um die gewünschte Ausgabe zu erhalten. Das grundlegende
+Problem ist das Setzen von Überschriften und dem folgenden Tabellenkopf
+innerhalb der Tabelle. Die Erläuterung des Quelltextauszugs erfolgt nach dessen
+Ausgabe.
+%
+\CodeHook{\let\newglossarystyle\renewglossarystyle}
+\begin{Hint*}
+\newglossarystyle{symbsplitlongtabu}{%
+ \newcommand*\symbollevel{-1}%
+ \renewenvironment{theglossary}{%
+ \begin{longtabu}spread 0pt[l]{ccX<{\strut}l}%
+ }{%
+ \end{longtabu}%
+ }%
+ \renewcommand*{\glsgroupheading}[1]{}%
+ \renewcommand*{\glsgroupskip}{}%
+ \newcommand*\symbolhead{%
+ \toprule
+ \bfseries Formelzeichen & \bfseries Einheit &
+ \bfseries Bezeichnung & \bfseries Seite(n)
+ \tabularnewline\midrule
+ }%
+ \renewcommand*{\glossaryheader}{%
+ \endfirsthead%
+ \symbolhead\endhead%
+ \bottomrule\endfoot%
+ \gdef\symbollevel{-1}%
+ }%
+ \renewcommand*{\glossentry}[2]{%
+ \ifglshaschildren{##1}{%
+ \ifnum\symbollevel>0\relax%
+ \tabularnewline\bottomrule\tabularnewline[\smallskipamount]%
+ \fi
+ \gdef\symbollevel{0}%
+ \tabularnewline[%
+ \arraystretch\dimexpr-\ht\strutbox-\dp\strutbox\relax%
+ ]%
+ \multicolumn{4}{@{}l@{}}{\minisec{\glsentryname{##1}}}%
+ }{%
+ \GlossariesWarning{%
+ There are no childrens for entry ##1.\MessageBreak
+ Nothing will be printed. Maybe you should\MessageBreak
+ specify ##1 as a child entry.
+ }%
+ }%
+ }%
+ \renewcommand*{\subglossentry}[3]{%
+ \ifnum\symbollevel=0\relax%
+ \tabularnewline[\medskipamount]\symbolhead%
+ \else%
+ \tabularnewline
+ \fi%
+ \gdef\symbollevel{##1}%
+ \glsentryitem{##2}% Entry number if required
+ \glstarget{##2}{\glossentrysymbol{##2}} &
+ \glsentryuseri{##2} &
+ \glossentryname{##2} &
+ ##3%
+ }%
+}
+\end{Hint*}
+%
+Der neu definierte Befehl \Macro*{symbollevel} wird benötigt, um bei der
+Ausgabe zu überprüfen, um es sich beim zuletzt gesetzten Eintrag um einen
+Elterneintrag (\Macro*{glossentry}) oder Untereintrag (\Macro*{subglossentry})
+gehandelt hat. Im Makro \Macro*{symbolhead} wird die Definition für den zu
+setzenden Tabellenkopf gespeichert. Der Inhalt von \Macro*{glossaryheader} wird
+direkt zu Beginn der Umgebung \Environment{theglossary}(\Package{glossaries})
+ausgeführt. Dieser wird so umdefiniert, dass die Tabelle keinen Kopf vor der
+ersten Überschrift erhält, jedoch nach einem Seitenumbruch sehr wohl der
+Tabellenkopf gesetzt wird. Abgeschlossen wird die Tabelle mit einer Fußlinie.
+
+Danach erfolgt die Formatierung der Einträge. Der Befehl \Macro*{glossentry}
+setzt \enquote{\greeklettersname} und \enquote{\romanlettersname} sowie
+gegebenenfalls weitere Elterneinträge als Überschriften. Bevor dies passieren
+kann wird eine vorher begonnene Tabelle mit einer Fußlinie beendet. Um die
+Überschrift innerhalb von \Environment{longtabu}(\Package{tabu}) linksbündig zu
+setzen, wird mit \Macro*{multicolumn} gearbeitet. Dieser Befehl muss in der
+ersten Zelle zwingend als aller erstes genutzt werden. Um dies sicherzustellen,
+wird zuvor eine neue Tabellenspalte eingefügt. Damit jedoch kein zusätzlicher
+Leerraum entsteht, wird diese über das optionale Argument nach oben verschoben.
+Die Einträge für Formelzeichen selber erfolgen mit \Macro*{subglossentry}. Im
+Gegensatz zum vorher beschriebenen Stil \PValue{symblongtabu} wird zusätzlich
+der notwendige Tabellenkopf nach der Überschrift gesetzt, falls es sich um den
+\emph{ersten} Untereintrags handelt.
+
+Jetzt könnte man den Glossarstil \PValue{symbsplitlongtabu} bereits verwenden
+und jedem Formelzeichen bei der Definition mit
+\begin{quoting}[leftmargin=\parindent]
+\Macro{newsymbol}[%
+ \POParameter{parent={greekletters/romanletters}}%
+ \PParameter{\dots}\PParameter{\dots}\PParameter{\dots}\PParameter{\dots}%
+]|?|%
+\end{quoting}
+eine der beiden Elterneinträge zuweisen. Für wenige Formelzeichen mag dies
+ausreichen. Komfortabler wäre es natürlich, wenn die Zuweisung zu einer der
+beiden Kategorien automatisch erfolgen würde. Ein Ansatz für dieses Unterfangen
+wird folgend vorgestellt.
+
+\Attention{%
+ Es kann nicht garantiert werden, dass dieser Ansatz in jedem Fall und für
+ sämtliche Anwendungsszenarien funktioniert. Tatsächlich ist die Idee auf eine
+ \hrfn{http://latex.wcms-file3.tu-dresden.de/phpBB3/viewtopic.php?f=11&t=427}{%
+ Frage aus dem \Forum*%
+ }
+ heraus entstanden. Für auftretende Probleme bei der Verwendung ist dort der
+ beste Anlaufpunkt.
+}
+
+Die Grundidee ist, das zu definierende Formelzeichen mit einer Liste der Makros
+für griechische Buchstaben abzugleichen und so zu entscheiden, in welche der
+beiden Kategorien das Symbol einzuordnen ist. Hierfür werden nachfolgend eine
+Liste \Macro*{greeksymbollist} aller griechischen Buchstaben sowie der Befehl
+\Macro*{ifisgreeksymbol}[\Parameter{Symbol}\Parameter{Dann}\Parameter{Sonst}]
+zur Fallunterscheidung definiert. Problematisch bei der Umsetzung ist, dass ein
+als Argument übergebenes Formelzeichen auch mit diakritischen Zeichen und
+Indizes verwendet werden kann~-- beispielsweise $\dot{\varphi}_{\mathrm{max}}$
+(%
+ \Macro*{dot}[\PParameter{\Macro*{varphi}}]\PValue{\textunderscore}%
+ \PParameter{\Macro*{mathrm}[\PParameter{max}]}%
+). Deshalb werden bei der Ausführung von \Macro*{ifisgreeksymbol} temporär alle
+diakritische Zeichen für den Mathematikmodus \enquote{unschädlich} gemacht und
+das Argument \Parameter{Symbol} expandiert. Anschließend werden alle Anteile
+für Hoch- sowie Tiefstellung abgeschnitten und das Resultat mit der Liste
+\Macro*{greeksymbollist} abgeglichen.
+%
+\CodeHook{\let\newcommand\renewcommand}
+\begin{Hint*}
+\makeatletter
+\newcommand*\greeksymbollist{}
+\def\@tempa#1{\ifdefvoid{#1}{}{\listadd\greeksymbollist{#1}}}
+\forcsvlist{\@tempa}{%
+ \alpha,\beta,\varbeta,\gamma,\delta,\epsilon,\varepsilon,\zeta,%
+ \eta,\theta,\vartheta,\iota,\kappa,\varkappa,\lambda,\mu,\nu,%
+ \xi,\omicron,\pi,\varpi,\rho,\varrho,\sigma,\varsigma,\tau,%
+ \upsilon,\phi,\varphi,\chi,\psi,\omega,%
+ \Alpha,\Beta,\Gamma,\Delta,\Epsilon,\Zeta,\Eta,\Theta,\Iota,%
+ \Kappa,\Lambda,\Mu,\Nu,\Xi,\Omicron,\Pi,\Rho,\Sigma,\Tau,\Upsilon,%
+ \Phi,\Chi,\Psi,\Omega%
+}
+\newcommand*\ifisgreeksymbol[1]{%
+ \begingroup%
+ \def\@tempa##1{\let##1\@firstofone}%
+ \forcsvlist{\@tempa}{%
+ \acute,\bar,\breve,\check,\dot,\ddot,\dddot,\ddddot,%
+ \hat,\widehat,\grave,\tilde,\widetilde,\vec,%
+ \Acute,\Bar,\Breve,\Check,\Dot,\Ddot,\Hat,\Grave,\Tilde,\Vec%
+ }%
+ \protected@edef\@tempa{#1}%
+ \def\@tempb##1_##2\relax{\def\@tempa{##1}}%
+ \expandafter\@tempb\@tempa_\relax\relax%
+ \def\@tempb##1^##2\relax{\def\@tempa{##1}}%
+ \expandafter\@tempb\@tempa^\relax\relax%
+ \expandafter\ifinlist\expandafter{\@tempa}{\greeksymbollist}{%
+ \aftergroup\@firstoftwo%
+ }{%
+ \aftergroup\@secondoftwo%
+ }%
+ \endgroup%
+}
+\makeatother
+\end{Hint*}
+%
+Mit \Macro*{ifisgreeksymbol} kann jetzt auf die Art des Symbols getestet. Dies
+wird innerhalb von \Macro{newsymbol}|?| genutzt, um den passenden Elterneintrag
+auszuwählen. Über das optionale Argument kann jederzeit mit
+\POParameter{parent={greekletters/romanletters}} der automatische ermittelte
+Elterneintrag überschrieben werden.
+%
+\begin{Hint}
+\newcommand*\symbollettergroup{}
+\newcommand*{\newsymbol}[5][]{%
+ \ifisgreeksymbol{#4}{%
+ \renewcommand*{\symbollettergroup}{greekletters}%
+ }{%
+ \renewcommand*{\symbollettergroup}{romanletters}%
+ }%
+ \newglossaryentry{#2}{%
+ type=symbols,%
+ name={#3},%
+ description={\nopostdesc},%
+ symbol={\ensuremath{#4}},%
+ user1={\ensuremath{\mathrm{#5}}},%
+ sort={#2},%
+ parent={\symbollettergroup},%
+ #1%
+ }%
+}
+\end{Hint}
+
\subsection{Literaturverzeichnis}
-\label{sec:biblatex}
+\label{sec:biblatex}%
+%
Für das Erstellen eines Literaturverzeichnisses wurde in der Vergangenheit fast
-ausschließlich \hologo{BibTeX} verwendet. Lieder wird auch heute immer noch
+ausschließlich \hologo{BibTeX} verwendet. Leider wird auch heute immer noch
darauf verwiesen, obwohl es seit einigen Jahren das Paket \Package{biblatex}
-gibt, welches insbesondere für neue Dokumente definitiv den Vorzug erhalten
-sollte. Auch die Umstellung älterer \hologo{BibTeX}"=Datenbanken ist mit
-wenigen Handgriffen realisierbar. Für \Package{biblatex} existieren eine Menge
-unterschiedlicher, vordefinierter Zitierstile, welche sich im Vergleich zu
-\hologo{BibTeX} auch wesentlich leichter an die individuellen Bedürfnisse
-anpassen lassen.
+gibt, welches insbesondere für neue Dokumente den Vorzug erhalten sollte. Auch
+die Umstellung älterer \hologo{BibTeX}"=Datenbanken ist mit wenigen Handgriffen
+realisierbar. Für \Package{biblatex} existieren eine Menge unterschiedlicher,
+vordefinierter Zitierstile, welche sich im Vergleich zu \hologo{BibTeX} auch
+wesentlich leichter an die individuellen Bedürfnisse anpassen lassen.
Ein weiterer Vorteil ist die Unterstützung von Datenbanken, welche eine
UTF"~8"~Kodierung nutzen, wenn \Application{biber} zur Sortierung der Einträge
-verwendet wird. Welcher Stil und welches Backend zur Sortierung genutzt werden
-soll, lässt sich durch das optionale Argument beim Laden des Paketes festlegen.
-Damit die Zitierstile das optimale Ergebnis erzielen wird das vorherige Laden
-von \Package{csquotes} sehr empfohlen.
+verwendet wird. Zitierstil und Backend zur Sortierung lassen sich durch das
+optionale Argument beim Laden des Paketes festlegen. Damit die Zitierstile das
+optimale Ergebnis erzielen wird das Laden von \Package{csquotes} sehr empfohlen.
%
\begin{Preamble}
\usepackage{csquotes}
@@ -1196,30 +1537,31 @@ einer externen Anwendung erfolgen. Für die letztgenannte Variante sind die
Programme \Application{Citavi} respektive \Application{JabRef} empfehlenswert.
Auf eine Einführung in diese Anwendungen wird jedoch verzichtet.
-Die \Environment{filecontents}"=Umgebung kann verwendet werden, um innerhalb
-eines \hologo{LaTeX}"=Dokumentes externe Dateien direkt beim Kompilieren zu
-erstellen. Damit wird nachfolgend für dieses Tutorial eine Literaturdatenbank
-\File{\jobname-temp.bib} mit drei Einträgen manuell erzeugt. Die Umgebung
-gehört zu den Bordmitteln von \hologo{LaTeXe}. Das Paket \Package{filecontents}
-erweitert die Umgebung dahingehend, dass \emph{bereits existierende Dateien}
-überschrieben werden. Hier ist folglich Vorsicht geboten. Der große Vorteil ist
-jedoch, dass die erweiterte \Environment{filecontents}"=Umgebung~-- im
-Gegensatz zur Standardversion~-- die Dateien in der gleichen Eingabekodierung
-erzeugt, wie das verwendete Dokument. Diese Funktionalität wird für dieses
-Tutorial benötigt, weshalb auf das Laden des Paketes \Package{filecontents}
-nicht verzichtet werden kann.
+Die \Environment{filecontents}(\Package{filecontents})"=Umgebung kann verwendet
+werden, um innerhalb eines \hologo{LaTeX}"=Dokumentes externe Dateien direkt
+beim Kompilieren zu erstellen. Damit wird nachfolgend für dieses Tutorial eine
+Literaturdatenbank \File{\jobname-temp.bib} mit drei Einträgen manuell erzeugt.
+Die Umgebung gehört standardmäßig zu den Bordmitteln von \hologo{LaTeXe}. Das
+Paket \Package{filecontents} erweitert die Umgebung dahingehend, dass
+\emph{bereits existierende Dateien} überschrieben werden. Hier ist folglich
+Vorsicht geboten. Der große Vorteil ist jedoch, dass die erweiterte
+\Environment{filecontents}(\Package{filecontents})"=Umgebung~-- im Gegensatz
+zur Standardversion~-- die Dateien in der gleichen Eingabekodierung erzeugt,
+wie das verwendete Dokument. Diese Funktionalität wird für dieses Tutorial
+benötigt, weshalb auf das Laden des Paketes \Package{filecontents} nicht
+verzichtet werden kann.
%
\begin{Preamble}
\usepackage{filecontents}
\end{Preamble}
%
-Es werden folgend drei Einträge für die Literaturdatenbank definiert. Jeder
-Eintrag einer \File{.bib}-Datei beginnt mit \PValue{@}\PName{Eintragstyp}.
-Direkt danach ist für jeden Eintrag ein \emph{eindeutiges} \PParameter{Label}
-festzulegen. Anschließend können für unterschiedliche Felder die dazugehörige
-Werte eingetragen werden. Die verwendbaren Eintragstypen und die für diesen
-benötigten und zusätzlich nutzbaren Felder sind in der Dokumentation von
-\Package{biblatex} zu finden.
+Folgend wird eine Literaturdatenbank mit drei Einträge definiert. Jeder Eintrag
+einer \File*{.bib}"~Datei beginnt mit \PValue{@}\PName{Eintragstyp}. Direkt
+danach ist für jeden Eintrag ein \emph{eindeutiges} \PParameter{Label}
+festzulegen. Anschließend können für unterschiedliche Felder die dazugehörigen
+Werte eingetragen werden. Die verwendbaren Eintragstypen sowie die für den
+jeweiligen Typ obligatorischen und optionalen Felder sind in der Dokumentation
+von \Package{biblatex} zu finden.
%
\begin{Preamble*}
\begin{filecontents}{\jobname-temp.bib}
@@ -1244,9 +1586,8 @@ benötigten und zusätzlich nutzbaren Felder sind in der Dokumentation von
}
@manual{hanisch14,
author = {Hanisch, Falk},
- title = {Ein \LaTeX"=Bundle für Dokumente
- im neuen Corporate Design
- der Technischen Universität Dresden},
+ title = {Ein \LaTeX"=Bundle für Dokumente im neuen Corporate
+ Design der Technischen Universität Dresden},
date = {2014},
subtitle = {Benutzerhandbuch},
location = {Dresden},
@@ -1256,21 +1597,21 @@ benötigten und zusätzlich nutzbaren Felder sind in der Dokumentation von
\end{Preamble*}
%
Nachdem die Literaturdatenbank erstellt wurde, muss diese auch noch eingebunden
-werden. Dies geschieht mit:
+werden:
%
\begin{Preamble}
\addbibresource{\jobname-temp.bib}
\end{Preamble}
%
-Im einfachsten Fall werden die Einträge mit \Macro{cite}\Parameter{macro} im
-Dokument referenziert. Für die Referenzierung werden durch \Package{biblatex}
-weitere Befehle angeboten.
+Im einfachsten Fall werden die gewünschten Einträge der Literaturdatenbank im
+Dokument mit \Macro{cite}[\Parameter{macro}](\Package{biblatex}) referenziert,
+von \Package{biblatex} werden zusätzliche Möglichkeiten angeboten.
%
\begin{refsection}[\jobname-temp.bib]
\begin{Trunk+}
\section{Referenzen und das Literaturverzeichnis}
-Das Literaturverzeichnis wir auf Basis der nachfolgend verwendeten
+Das Literaturverzeichnis wird auf Basis der nachfolgend verwendeten
Zitate erstellt und ist auf Seite~\pageref{sec:bibliography} zu finden.
\end{Trunk+}
\begin{Trunk*}
@@ -1280,10 +1621,10 @@ In diesem Textabschnitt werden die zwei bekannten \LaTeX-Bücher
\end{Trunk*}
%
-Das Literaturverzeichnis wird mit \Macro{printbibliography} ausgegeben, wobei
-nicht alle Einträge der Literaturdatenbank sondern lediglich die tatsächlich
-referenzierten verwendet werden. Der Parameter \PValue{heading=bibintoc} führt
-zu einem Eintrag in das Inhaltsverzeichnis.
+Das Literaturverzeichnis wird mit \Macro{printbibliography}(\Package{biblatex})
+ausgegeben, wobei nicht alle Einträge der Literaturdatenbank sondern lediglich
+die tatsächlich referenzierten verwendet werden. Der Parameter
+\PValue{heading=bibintoc} führt zu einem Eintrag in das Inhaltsverzeichnis.
%
\begin{Hint}
\printbibliography[heading=bibintoc]
@@ -1293,7 +1634,6 @@ zu einem Eintrag in das Inhaltsverzeichnis.
\let\markboth\@gobbletwo
\let\markright\@gobble
\makeatother
-\vspace*{-\baselineskipglue}
\printbibliography
\end{quoting}
\end{refsection}
@@ -1306,14 +1646,16 @@ zu einem Eintrag in das Inhaltsverzeichnis.
\bigskip\noindent
Oftmals möchte der Autor einer wissenschaftlichen Arbeit für das erste oder
auch jedes Kapitel ein Zitat oder ähnliches voranstellen. Dies kann mit dem
-Befehl \Macro{dictum}\OParameter{Autor}\Parameter{Text} erfolgen. Damit wird
-der im obligatorischen Argument angegeben Ausspruch in einer \Macro{parbox}
-ausgegeben. Das optionale Argument kann für die Angabe des Autors verwendet
-werden. Soll das Ganze für einen Teil oder ein Kapitel erfolgen, sollte der
-Befehl \Macro{dictum} innerhalb von \Macro{setpartpreamble} beziehungsweise
-\Macro{setchapterpreamble} verwendet werden. Genaueres hierzu und zu den
-Möglichkeiten, die Gestalt des Zitats zu beeinflussen, ist in der Anleitung von
-\KOMAScript{} \scrguide zu finden. Es folgt ein Beispiel zur Verwendung.
+Befehl \Macro{dictum}[\OParameter{Autor}\Parameter{Text}](\Package{koma-script})
+erfolgen. Damit wird der im obligatorischen Argument angegeben Ausspruch in
+einer \Macro{parbox} ausgegeben. Das optionale Argument kann für die Angabe des
+Autors verwendet werden. Soll das Ganze für einen Teil oder ein Kapitel
+erfolgen, sollte der Befehl \Macro{dictum}(\Package{koma-script}) innerhalb von
+\Macro{setpartpreamble}(\Package{koma-script}) beziehungsweise
+\Macro{setchapterpreamble}(\Package{koma-script}) verwendet werden. Genaueres
+hierzu und zu den weiteren Möglichkeiten, die Gestalt eines Zitats zu
+beeinflussen, ist in der \scrguide[Anleitung von \KOMAScript] zu finden. Es
+folgt ein Beispiel zur Verwendung.
%
\begin{Hint}
\setchapterpreamble{%
@@ -1329,23 +1671,25 @@ Möglichkeiten, die Gestalt des Zitats zu beeinflussen, ist in der Anleitung von
\section{Gleitumgebungen für Abbildungen und Tabellen}
-\label{sec:floats}
+\label{sec:floats}%
+%
Die Positionierung von Abbildungen mit \hologo{LaTeX} kann zu Beginn für viele
Anfänger durchaus frustrierend sein. Das liegt häufig am Missverständnis der
beiden Standard"=Gleitobjektumgebungen für Tabellen (\Environment{table}) und
Abbildungen (\Environment{figure}). Diese sind in erster Linie zur Ergänzung
des Fließtextes gedacht und sollten für das prinzipielle Verständnis des
-Geschrieben nicht notwendig sein. Das oft geforderte Verhalten, ein Gleitobjekt
-an einer ganz bestimmten und explizit festgelegten Position im Text zu setzen,
-ist nicht erforderlich, insbesondere weil dadurch der Lesefluss unnötig
-unterbrochen wird.
+Geschriebenen nicht notwendig sein. Das oft geforderte Verhalten, ein
+Gleitobjekt an einer ganz bestimmten und explizit festgelegten Position im Text
+zu setzen, ist nicht erforderlich, insbesondere weil dadurch der Lesefluss
+unnötig unterbrochen wird.
Vielmehr ist es sinnvoll, Gleitobjekte entweder am Anfang oder Ende einer Seite
zu platzieren, wo sie den Lesefluss deutlich weniger stören. Allerdings sollte
auf jedes Gleitobjekt im Fließtext über eine Referenz~-- beispielsweise mit dem
-Befehl \Macro{autoref} aus dem Paket \Package{hyperref}~-- Bezug genommen und
-gegebenenfalls eine kurze Erläuterung gegeben werden. Weitere Erläuterungen zum
-Thema \emph{Querverweise} ist in \autoref{sec:references} nachlesen.
+Befehl \Macro{autoref}(\Package{hyperref}) aus dem Paket \Package{hyperref}~--
+Bezug genommen und gegebenenfalls eine kurze Erläuterung gegeben werden.
+Zusätzliche Erläuterungen zum Thema \emph{Querverweise} sind unter
+\autoref{sec:references} zu finden.
Ein weitere Grund, \hologo{LaTeX} die Platzierung von Tabellen und Abbildungen
vollständig zu überlassen, ist die Ungewissheit über den vorhandenen Platz auf
@@ -1354,8 +1698,9 @@ das einzufügende Objekt zu groß für die aktuelle Seite ist, was einen wahrlic
schlechten Seitenumbruch mit einer schlecht gefüllten Seite zur Folge hätte.
Die Verwendung einer Gleitumgebung für eine Abbildung wird im nachfolgenden
Quelltextauszug exemplarisch gezeigt, das Ergebnis ist in \autoref{fig:example}
-zu sehen. Worauf man bei Gleitobjekten in jedem Fall achten sollte, dass die
-Verwendung von \Macro{label} immer erst \emph{nach} \Macro{caption} erfolgt, da
+zu sehen. Bei Gleitobjekten sollte in jedem Fall darauf geachtet werden, dass
+der Befehl \Macro{label} immer erst \emph{nach}
+\Macro{caption}(\Package{koma-script},\Package{caption}) verwendet wird, da
der erzeugte Anker sich sonst nicht auf das Objekt bezieht.
%
\begin{Trunk+}
@@ -1365,7 +1710,7 @@ Grafiken als auch Tabellen verwendet werden sollten. Im vorliegenden
Beispiel kann unter Umständen der Eindruck entstehen, dass diese Seite
etwas zu überladen mit Gleitobjekten ist. Dies liegt nicht an der
Verwendung der Gleitobjekte sondern vielmehr am zu geringen Textvolumen
-und den eingeschränkten Möglichkeiten von \LaTeX{}, diese an geigneten
+und den eingeschränkten Möglichkeiten von \LaTeX{}, diese an geeigneten
Stellen zu platzieren.
\subsection{Abbildungen als Gleitobjekte und das Einbinden von Grafiken}
@@ -1373,11 +1718,11 @@ In \autoref{fig:example} wird dargestellt, wie eine Grafik im PDF-Format
in ein Dokument eingebunden und auf diese verwiesen werden kann. Ein
Querverweis auf ein Gleitobjekt sollte im Fließtext am besten mit Befehl
\texttt{\textbackslash autoref\{\emph{<Label>}\}} erstellt werden.
-Hierfür ist ein entsprechender Anker am zu referenziereden Objekt nötig,
+Hierfür ist ein entsprechender Anker am zu referenzierenden Objekt nötig,
welcher mit dem Makro \texttt{\textbackslash label} erzeugt wird. Dabei
ist entscheidend, dass dieser Anker erst \emph{nach} der Beschriftung des
-Objektes, welche mit \texttt{\textbackslash caption} erstellt wird,
-gesetzt wird.
+Objektes, welche mit \texttt{\textbackslash caption} zu erstellen ist,
+definiert werden sollte.
\end{Trunk+}
\begin{Trunk}
@@ -1401,82 +1746,18 @@ gewiss ein Lied darüber singen.
-\subsection{Beeinflussung des Gleitprozesses}
-Sobald das Dokument inhaltlich den finalen Zustand erreicht hat, haben Sie sich
-zu diesem Zeitpunkt schon mit Sicherheit an das standardmäßige Vorgehen von
-\hologo{LaTeX} gewöhnt und müssen respektive wollen gegebenenfalls nur noch bei
-wenigen Gleitobjekten~-- über das optionale Argument der Gleitumgebungen zur
-individuellen Empfehlung für die Platzierung~-- nachjustieren. Mögliche Werte
-sind:
-%
-\begin{description}[labelindent=\parindent,leftmargin=*,style=nextline]
-\item[\POParameter{h} (here)]
- An der Stelle, wo es im Quelltext angegeben wurde~-- falls genügend Platz
- vorhanden ist
-\item[\POParameter{t} (top)]
- Am oberen Ende der aktuellen oder der folgenden Seite
-\item[\POParameter{b} (bottom)]
- Am unteren Ende der aktuellen Seite
-\item[\POParameter{p} (page)]
- Auf einer separaten Seite für mindestens ein Gleitobjekt
-\end{description}
-%
-Sie können eine, mehrere oder alle Optionen angeben, wobei die Reihenfolge
-keine Rolle spielt. Der Algorithmus arbeitet alle ihm zur Verfügung gestellten
-Optionen immer in der zuvor aufgezählten Reihenfolge ab, wobei diese nur als
-Empfehlung und nicht als Verpflichtung angesehen werden. Es gibt folglich keine
-Garantie, dass Ihr Vorschlag akzeptiert wird. Fügen sie dem optionalen Argument
-ein~\PValue{!} an, so verhindern Sie, dass \hologo{LaTeX} weitere Optionen
-evaluiert. Das Gleitobjekt wird anhand der optionalen Parameter positioniert,
-selbst wenn dabei ein unschönes Seitenlayout entsteht. Kann das Gleitobjekt
-technisch unmöglich auf die angegebene Weise positioniert werden, wird dieses
-sowie alle folgenden aufgeschoben und am Ende des Abschnitts oder Kapitels
-angehängt. Dies ist ein Effekt, den man in den seltensten Fällen will.
-
-Außerdem können die Pakete \Package{flafter} sowie \Package{placeins} genutzt
-werden. Das erstgenannte verhindert das Auftreten von Gleitobjekten im Dokument
-vor ihrer Definition im Quelltext. In der Konsequent bedeutet dies, dass die
-Option \POParameter{t} Gleitobjekte nur am oberen Ende der nächsten Seite
-jedoch nicht auf der aktuellen zulässt. Mit dem zweiten Paket können Barrieren
-definiert werden, an welchen die Ausgabe aller noch in der Warteschlange
-befindlichen Gleitobjekte forciert wird~-- beispielsweise vor bestimmten
-Gliederungsüberschriften. Im Handbuch zu \TUDScript findet sich außerdem zum
-Thema \enquote{\manualhyperref{sec:tips:floats}{Platzierung von Gleitobjekten}}
-ein eigener Abschnitt mit weiterführenden Informationen.
-
-
-\subsection{Abstellen des Gleitprozesses}
-Oftmals wird verlangt, den Gleitprozess vollständig abzustellen. Dies bringt in
-den meisten Fällen einige Probleme mit sich. Die Folge sind sehr ein unruhiges
-Erscheinungsbild das Satzspiegels aufgrund schlecht gefüllter Seiten, außerdem
-viel Handarbeit mit hart kodierten Seitenumbrüchen sowie ein gegenüber von
-Umbruchänderungen äußerst anfälliges Dokument. Sollte es in \emph{Einzelfällen}
-dennoch erforderlich sein, dass eine Abbildung oder eine Tabelle nicht gleitet,
-ist die einzig logische Konsequenz, auf die Verwendung einer Gleitumgebung
-gänzlich zu verzichten.
-
-Hierfür eignen sich Umgebungen wie \Environment{center}, um etwas Abstand vor
-und nach dem Objekt zu erzeugen und \Environment{minipage}, um Grafik oder
-Tabelle und Beschriftung zusammenzuhalten. Die \KOMAScript-Klassen stellen für
-diese Anwendung das Makro \Macro{captionof} zur Verfügung. Damit lassen sich
-Bildunter- sowie Tabellenüberschriften auch ohne die gleitenden Umgebungen
-\Environment{figure} beziehungsweise \Environment{table} erzeugen. Alternativ
-kann das Paket \Package{float} verwendet werden, welches für Gleitumgebungen
-den Platzierungsparameter \POParameter{H} zur Verfügung stellt. Allerdings ist
-dies meiner Meinung nach alles andere als konsequent und sinnvoll.
-
-
\subsection{Gleitobjektlayout}
-\label{sec:floatlayout}
+\label{sec:floatlayout}%
%
Es wurde bis jetzt das prinzipielle Vorgehen bei der Nutzung von Gleitobjekten
beschrieben. Allerdings gibt es auch noch einige typografische Aspekte, welche
zu beachten sind. Zum einen sollte beachtet werden, dass die Beschriftung einer
Abbildung immer unterhalb dieser erfolgen sollte, bei Tabellen hingegen eine
Überschrift gesetzt wird. Hierfür muss der Anwender ohne die Verwendung eines
-zusätzlichen Paketes selber Sorge tragen, indem er den Befehl \Macro{caption}
-entweder vor oder nach dem eigentlichen Objekt in der Gleitumgebung verwendet.
-Der zweite Punkt ist die verwendete Schrift innerhalb der Gleitumgebungen.
+zusätzlichen Paketes selber Sorge tragen, indem er den Befehl
+\Macro{caption}(\Package{koma-script},\Package{caption}) entweder vor oder
+nach dem eigentlichen Objekt in der Gleitumgebung verwendet. Der zweite Punkt
+ist die verwendete Schrift innerhalb der Gleitumgebungen.
Damit sich der Inhalt dieser besser vom restlichen Fließtext abhebt und vom
Leser direkt als nicht dazugehörig erkannt werden kann ist es ratsam, diesen in
@@ -1491,13 +1772,11 @@ ein Blick in \autoref{sec:tables} sehr sinnvoll.
\begin{tabularx}{.75\textwidth}{@{}XXX@{}}
\toprule
\textbf{Erste Spalte} & \textbf{Zweite Spalte} &
- \textbf{Dritte Spalte} \tabularnewline
- \midrule
+ \textbf{Dritte Spalte} \tabularnewline\midrule
Etwas Blindtext für die erste Spalte &
Etwas Blindtext für die zweite Spalte &
Etwas Blindtext für die dritte Spalte
- \tabularnewline
- \bottomrule
+ \tabularnewline\bottomrule
\end{tabularx}
#1%
}
@@ -1519,9 +1798,9 @@ mithilfe des Paketes \Package{caption} angepasst werden.
\usepackage{caption}
\end{Preamble}
%
-Diese stellt den Befehl \Macro{captionsetup} bereit. Mit diesem werden die
-Beschriftungen in Serifenlosen und das Label zur besseren Unterscheidung im
-fetter Schriftstärke gesetzt.
+Diese stellt den Befehl \Macro{captionsetup}(\Package{caption}) bereit. Mit
+diesem werden die Beschriftungen in Serifenlosen und das Label zur besseren
+Unterscheidung im fetter Schriftstärke gesetzt.
%
\begin{Preamble*}
\captionsetup{font=sf,labelfont=bf,labelsep=space}
@@ -1536,7 +1815,7 @@ einer Gleitumgebung formatieren zu können, wird \Package{floatrow} geladen.
Der Inhalt von Gleitobjekten wird~-- entgegen des normalen Verhaltens~-- durch
\Package{floatrow} automatisch zentriert gesetzt. Zusätzlich soll der Inhalt
noch die serifenlose Schriftfamilie verwenden. Dies lässt sich mit der Nutzung
-des Befehls \Macro{floatsetup} realisieren.
+des Befehls \Macro{floatsetup}(\Package{floatrow}) realisieren.
%
\begin{Preamble*}
\floatsetup{font=sf}
@@ -1555,19 +1834,21 @@ angepasst.
\tableexample[%
\caption{%
Eine Tabelle in einer Gleitumgebung mit einer angepassten Formatierung%
- }\label{tab:tabularnew}%
+ }%
+ \label{tab:tabularnew}%
]
\end{table}%
%
Damit wären alle Einstellungen soweit erfolgt, in \autoref{tab:tabularnew} ist
das Ergebnis zu sehen. Zumeist soll die Beschriftung für Gleitobjekte nicht
zentriert sondern linksbündig gesetzt werden. Dies lässt sich ebenfalls mit den
-Mitteln des Paketes \Package{caption} mit der Option \Option{justification}
-erreichen. Damit dies auch für einzeilige Beschriftungen angewendet wird, muss
-zusätzlich die Einstellung \Option{singlelinecheck} deaktiviert werden. Mit der
-Option \Option{hang} kann außerdem beeinflusst werden, ob eine mehrzeilige
-Beschriftung nach einem Zeilenumbruch direkt unter dem Label oder mit Einzug
-fortgesetzt werden soll.
+Mitteln des Paketes \Package{caption} und der passenden Paketoption
+\Option{justification}(\Package{caption}) erreichen. Damit dies auch für
+einzeilige Beschriftungen angewendet wird, muss zusätzlich die Einstellung
+\Option{singlelinecheck}(\Package{caption}) deaktiviert werden. Mit der
+Paketoption \Option{format}(\Package{caption}) kann außerdem beeinflusst
+werden, ob eine mehrzeilige Beschriftung nach einem Zeilenumbruch direkt unter
+dem Label oder mit Einzug fortgesetzt werden soll.
%
\begin{Preamble*}
\captionsetup{singlelinecheck=off,format=hang,justification=raggedright}
@@ -1577,14 +1858,14 @@ In \autoref{tab:tabularnew} fällt die Beschriftung auf, welche die Breite der
Tabelle überragt. Falls linksbündige Gleitumgebungsbezeichnungen verwendet
werden, wie dies gerade eingestellt wurde, besteht das Problem quasi bei jeder
Beschriftung, da diese immer am linken Seitenrand beginnen. Auch hierfür stellt
-das Paket \Package{floatrow} die Befehle \Macro{ttabbox} für Tabellen sowie
-\Macro{ffigbox} für Abbildungen bereit.
+das Paket \Package{floatrow} die Befehle \Macro{ttabbox}(\Package{floatrow})
+für Tabellen sowie \Macro{ffigbox}(\Package{floatrow}) für Abbildungen bereit.
Beide Makros erwarten im ersten obligatorischen Argument den Befehl
-\Macro{caption} für die Beschriftung gegebenenfalls gefolgt von einem mit
-\Macro{label} gesetzten Textanker. Im zweiten Argument wird das Objekt
-selbst~-- sprich Tabelle oder Abbildung~-- angegeben. Zu verwenden sind diese
-folgendermaßen:
+\Macro{caption}(\Package{koma-script},\Package{caption}) für die Beschriftung
+gegebenenfalls gefolgt von einem mit \Macro{label} gesetzten Textanker. Im
+zweiten Argument wird das Objekt selbst~-- sprich Tabelle oder Abbildung~--
+angegeben. Zu verwenden sind diese folgendermaßen:
%
\begin{Hint}
\begin{table}
@@ -1603,37 +1884,45 @@ Diese beiden Befehle sorgen dafür, dass die Beschriftungen in der jeweiligen
Breite des Objektes gesetzt werden. Entspricht das zu setzende Objekt in seiner
Breite dem Wert \Length{textwidth}~-- es ist genauso Breit wie die Laufweite
des Fließtextes~--, so ist deren Gebrauch nicht notwendig. Das Ergebnis der
-Verwendung von \Macro{ttabbox} ist in \autoref{tab:tabularbox} zu sehen.
+Verwendung von des Befehls \Macro{ttabbox}(\Package{floatrow}) ist in
+\autoref{tab:tabularbox} zu sehen.
Bei der Nutzung der beiden Befehle sollte darauf geachtet werden, dass zwischen
dem Ende des Objektes und der schließender Klammer des zweiten Argumentes kein
-ungewolltes Leerzeichen gesetzt wird. Dies lässt sich am einfachsten vermeiden,
-indem direkt nach dem Ende des Objektes mit \Macro{end}\PParameter{tabularx},
-\Macro{end}\PParameter{tabu}, \Macro{end}\PParameter{tikz} etc. die schließende
-Klammer des zweiten Argumentes oder das Kommentarzeichen \PValue{\%} folgt.
+ungewolltes Leerzeichen gesetzt wird. Dies lässt sich leicht vermeiden, indem
+direkt nach dem Ende des Objektes mit \Macro*{end}[\PParameter{tabularx}],
+\Macro*{end}[\PParameter{tabu}], \Macro*{end}[\PParameter{tikz}] etc. die
+schließende Klammer des zweiten Argumentes oder das Zeichen für einen Kommentar
+\PValue{\%} folgt.
\begin{table}
\ttabbox{\tableexample}{%
- \caption[Eine mit \Macro{ttabbox} gesetzte Tabelle in einer Gleitumgebung]{%
+ \caption[%
+ Eine mit \Macro{ttabbox}(\Package{floatrow}) gesetzte Tabelle in einer
+ Gleitumgebung%
+ ]{%
Eine in einer Gleitumgebung gesetzte Tabelle in Verbindung mit dem Befehl
- \Macro{ttabbox}, der durch das Paket \texttt{floatrow} für Beschriftungen
- in Objektbreite zur Verfügung gestellt wird%
- }\label{tab:tabularbox}%
+ \Macro{ttabbox}(\Package{floatrow}), der durch das Paket \Package{floatrow}
+ für Beschriftungen in Objektbreite zur Verfügung gestellt wird%
+ }%
+ \label{tab:tabularbox}%
}
\end{table}
\subsection{Untergleitobjekte}
-\label{sec:subfloats}
+\label{sec:subfloats}%
+%
Das Paket \Package{floatrow} stellt allerhand Möglichkeiten zur Erstellung von
nebeneinanderliegenden Gleitobjekten sowie \enquote{Untergleitobjekten} bereit
und ist insbesondere in Verbindung mit den Fähigkeiten von \Package{caption}
respektive \Package{subcaption} sehr gut für dieses Unterfangen nutzbar. Dafür
-werden die Umgebungen \Environment{floatrow} und \Environment{subfloatrow}
-angeboten, wobei die letztere für ein Beispiel verwendet wird. Als erstes muss
-der Typ der zu erzeugenden Labels für Abbildungen und Tabellen definiert
-werden. Dies geschieht mit dem Befehl \Macro{DeclareCaptionSubType} aus dem
-Paket \Package{subcaption}.
+werden die Umgebungen \Environment{floatrow}(\Package{floatrow}) sowie
+\Environment{subfloatrow}(\Package{floatrow}) angeboten, wobei die letztere für
+ein Beispiel verwendet wird. Als erstes muss der Typ der zu erzeugenden Labels
+für Abbildungen und Tabellen definiert werden. Dies geschieht mit dem Befehl
+\Macro{DeclareCaptionSubType}(\Package{subcaption}) aus dem Paket
+\Package{subcaption}.
%
\begin{Preamble}
\DeclareCaptionSubType[alph]{figure}
@@ -1682,9 +1971,126 @@ sowohl auf \autoref{fig:logos} als auch auf \autoref{fig:tud} sowie
\InputCode
+\subsection{Beeinflussung des Gleitprozesses}
+Sobald das Dokument inhaltlich den finalen Zustand erreicht hat, haben Sie sich
+zu diesem Zeitpunkt schon mit Sicherheit an das standardmäßige Vorgehen von
+\hologo{LaTeX} gewöhnt und müssen respektive wollen gegebenenfalls nur noch bei
+wenigen Gleitobjekten~-- über das optionale Argument der Gleitumgebungen zur
+individuellen Empfehlung für die Platzierung~-- nachjustieren. Mögliche Werte
+sind:
+%
+\begin{description}[labelindent=\parindent,leftmargin=*,style=nextline]
+\item[\POParameter{h} (here)]
+ An der Stelle, wo es im Quelltext angegeben wurde~-- falls genügend Platz
+ vorhanden ist
+\item[\POParameter{t} (top)]
+ Am oberen Ende der aktuellen oder der folgenden Seite
+\item[\POParameter{b} (bottom)]
+ Am unteren Ende der aktuellen Seite
+\item[\POParameter{p} (page)]
+ Auf einer separaten Seite für mindestens ein Gleitobjekt
+\end{description}
+%
+Sie können eine, mehrere oder alle Optionen angeben, wobei die Reihenfolge
+keine Rolle spielt. Der Algorithmus arbeitet alle ihm zur Verfügung gestellten
+Optionen immer in der zuvor aufgezählten Reihenfolge ab, wobei diese nur als
+Empfehlung und nicht als Verpflichtung angesehen werden. Es gibt folglich keine
+Garantie, dass Ihr Vorschlag akzeptiert wird. Fügen sie dem optionalen Argument
+ein~\PValue{!} an, so verhindern Sie, dass \hologo{LaTeX} weitere Optionen
+evaluiert. Das Gleitobjekt wird anhand der optionalen Parameter positioniert,
+selbst wenn dabei ein unschönes Seitenlayout entsteht. Kann das Gleitobjekt
+technisch unmöglich auf die angegebene Weise positioniert werden, wird dieses
+sowie alle folgenden aufgeschoben und am Ende des Abschnitts oder Kapitels
+angehängt. Dieser Effekt ist wohl in den seltensten Fällen gewollt.
+
+Außerdem können die Pakete \Package{flafter} sowie \Package{placeins} genutzt
+werden. Das erstgenannte verhindert das Auftreten von Gleitobjekten im Dokument
+vor ihrer Definition im Quelltext. In der Konsequent bedeutet dies, dass die
+Option \POParameter{t} Gleitobjekte nur am oberen Ende der nächsten Seite
+jedoch nicht auf der aktuellen zulässt. Mit dem zweiten Paket können Barrieren
+definiert werden, an welchen die Ausgabe aller noch in der Warteschlange
+befindlichen Gleitobjekte forciert wird~-- beispielsweise vor bestimmten
+Gliederungsüberschriften. Im Handbuch zu \TUDScript findet sich außerdem zum
+Thema \enquote{\tudhyperref{sec:tips:floats}{Platzierung von Gleitobjekten}}
+ein eigener Abschnitt mit weiterführenden Informationen.
+
+
+\subsection{Abstellen des Gleitprozesses}
+Trotz der zuvor genannten Vorteile von Gleitobjekten wird oftmals verlangt, den
+Gleitprozess vollständig abzustellen. Dies bringt jedoch in den meisten Fällen
+einige Probleme mit sich. Die Folge sind ein sehr unruhiges Erscheinungsbild
+des Satzspiegels aufgrund schlecht gefüllter Seiten, außerdem im Zweifelsfall
+viel Handarbeit mit hart kodierten Seitenumbrüchen sowie daraus resultierend
+ein gegenüber von Umbruchänderungen äußerst anfälliges Dokument. Sollte es in
+\emph{Einzelfällen} dennoch erforderlich sein, dass eine Abbildung oder Tabelle
+nicht gleitet, ist die einzig logische Konsequenz, auf die Verwendung einer
+Gleitumgebung gänzlich zu verzichten.
+
+Hierfür eignet sich beispielsweise die Umgebung \Environment{center}, welche
+zum einen etwas Abstand vor und nach dem Objekt zum umgebenden Text erzeugt
+sowie zum anderen die Grafik beziehungsweise Tabelle und die dazugehörige
+Bezeichnung zusammenhält. \KOMAScript stellt für diesen Anwendungsfall das
+Makro \Macro{captionof}(\Package{koma-script}) für die Beschriftung zur
+Verfügung. Werden die Pakete \Package{caption} und \Package{hyperref} geladen,
+sollte weiterhin \Macro{caption}(\Package{koma-script},\Package{caption})
+ergänzt um ein zuvor aufgerufenes
+\Macro{captionsetup}[\PParameter{type=figure/table}](\Package{caption})
+genutzt werden. Damit lassen sich Bildunter- sowie Tabellenüberschriften auch
+ohne die bekannten Gleitumgebungen \Environment{figure} respektive
+\Environment{table} erzeugen. Das Vorgehen wird folgend demonstriert, in
+\autoref{fig:nonfloating-A} ist das Ergebnis zu sehen.
+%
+\begin{Hint}
+\begin{center}
+\captionsetup{type=figure}
+\includegraphics{TUD-black}
+\caption{Eine nichtgleitende Grafik in einer \texttt{center}"=Umgebung}
+\label{fig:nonfloating-A}
+\end{center}
+
+\end{Hint}
+\InputCode\noindent
+%
+Alternativ zu diesem Ansatz kann das Paket \Package{float} zum Einsatz kommen,
+welches für Gleitumgebungen den Platzierungsparameter \POParameter{H}
+bereitstellt. Das Resultat ist identisch zu \autoref{fig:nonfloating-A}.
+%
+\begin{Hint}
+\begin{figure}[H]
+\includegraphics{TUD-black}
+\caption{Eine nichtgleitende Grafik in einer \texttt{figure}"=Umgebung}
+\label{fig:...}
+\end{figure}
+
+\end{Hint}
+%
+Mit den Mitteln des Paketes \Package{floatrow} lässt sich eine etwas bessere
+Variante entwickeln, wobei für eine mehrmalige Anwendung ein eigenes Makro mit
+den passenden Argumenten definiert werden sollte. Zum besseren Verständnis des
+Quelltextauszuges ist die Dokumentation von \Package{floatrow} zu beachten.
+%
+\begin{Hint}
+\floatbox[\captionsetup{type=figure}]{figure}[\FBwidth][%
+ \dimexpr\FBheight+\abovedisplayskip\relax%
+][b]{\includegraphics{TUD-black}}{%
+ \caption{%
+ Eine nichtgleitende Grafik mit \texttt{\textbackslash floatbox}%
+ }%
+ \label{fig:nonfloating-B}%
+}
+\end{Hint}
+\InputCode\noindent
+%
+Es wird hier trotz der vorhergehenden Ausführungen abermals ausdrücklich
+empfohlen, Tabellen und Abbildungen in Gleitumgebungen zu setzen und die
+korrekte Platzierung dem \hologo{LaTeX}"=Algorithmus zu überlassen.
+
+
+
\section{Tabellensatz}
-\label{sec:tables}
+\label{sec:tables}%
+%
Zum Thema \enquote{Tabellensatz mit \hologo{LaTeX}} sind bereits zahlreiche
\hrfn{http://userpage.fu-berlin.de/latex/Materialien/tabsatz.pdf}{Leitfäden}
\cite{reichert2012} im Internet zu finden. Deshalb werde ich meine Ausführungen
@@ -1697,18 +2103,21 @@ in jedem Fall beachtet werden:
\end{enumerate}
%
Das Paket \Package{booktabs} ist für den Satz von hochwertigen Tabellen eine
-große Hilfe und stellt die Befehle \Macro{toprule}, \Macro{midrule} sowie
-\Macro{cmidrule} und \Macro{bottomrule} für unterschiedliche horizontale Linien
-bereit.
+große Hilfe und stellt die Befehle \Macro{toprule}(\Package{booktabs}),
+\Macro{midrule}(\Package{booktabs}) sowie \Macro{cmidrule}(\Package{booktabs})
+und \Macro{bottomrule}(\Package{booktabs}) für unterschiedliche horizontale
+Linien bereit.
%
\begin{Preamble}
\usepackage{booktabs}
\end{Preamble}
%
Außerdem existiert das Paket \Package{array}, welches mit dem Befehl
-\Macro{newcolumntype} die Definition eigener Spaltentypen sowie die Verwendung
-sogenannter \enquote{Hooks} vor und nach Einträgen innerhalb einer Spalte
-(\PValue{>\{\dots\}}\PName{Spaltentyp}\PValue{<\{\dots\}}) ermöglicht.
+\Macro{newcolumntype}(\Package{array}) die Definition eigener Spaltentypen
+sowie die Verwendung von \enquote{Hooks} vor (\PValue{>\PParameter{\dots}}) und
+nach (\PValue{<\PParameter{\dots}}) Einträgen innerhalb einer Spalte
+(\PValue{>\PParameter{\dots}}\PName{Spaltentyp}\PValue{<\PParameter{\dots}})
+ermöglicht.
%
\begin{Preamble}
\usepackage{array}
@@ -1718,32 +2127,33 @@ Für alle im Folgenden vorgestellten Umgebungen zum Setzen von Tabellen gilt,
dass die Inhalte zeilenweise angegeben werden, wobei die Einträge für die
einzelnen Spalten mit~\PValue{\&} voneinander zu trennen sind. Das Beenden
einer Tabellenzeile und der Wechsel zur nächsten erfolgt normalerweise mit
-\PValue{\textbackslash\textbackslash}. Da jedoch einige \hologo{LaTeX}-Pakete
+\PValue{\textbackslash\textbackslash}. Da jedoch einige \hologo{LaTeX}"=Pakete
diesen Befehl innerhalb von Tabellen lokal ändern ist es zur Vermeidung
unnötiger Fehler wesentlich sicherer, das Zeilenende ausschließlich mit
\Macro{tabularnewline} zu setzen.
Im Folgenden wird in einigen Tabellen bei der Definition der Spalten vor der
-ersten und nach der letzten das Konstrukt~\PValue{@\{\}} verwendet, was das
-\manualhyperref{sec:tips:table}{Einrücken dieser Tabellenspalten verhindert}
+ersten und nach der letzten das Konstrukt~\PValue{@\PParameter{}} verwendet,
+was das \tudhyperref{sec:tips:table}{Einrücken der Tabellenspalten verhindert}
und im Handbuch genauer erläutert wird.
-\subsection{Die Standardumgebung \Environment{tabular}}
-Normalerweise gibt es vier unterschiedliche Spaltentypen. Dabei stehen die drei
-Spaltentypen~\PValue{l},~\PValue{c}~und~\PValue{r} für linksbündige, zentrierte
-und rechtsbündige Spalten, welche allerdings keinen Zeilenumbruch erlauben. Der
-Inhalt wird quasi wie in einer \Macro{mbox} gesetzt, wodurch die Spalten sehr
-breit werden und über den Seitenrand hinausragen können.
+\subsection{Die Standardumgebung \Environment*{tabular}}
+Normalerweise gibt es für \Environment{tabular} vier unterschiedliche
+Spaltentypen. Die drei Spaltentypen~\PValue{l},~\PValue{c}~und~\PValue{r}
+stehen für linksbündige, zentrierte und rechtsbündige Spalten zu Verfügung,
+welche allerdings keinen Zeilenumbruch erlauben. Der Inhalt wird quasi wie in
+einer \Macro{mbox} gesetzt, wodurch die Spalten sehr breit werden und über den
+Seitenrand hinausragen können.
Der Spaltentyp~\PValue{p}\Parameter{Breite} hingegen legt die Spaltenbreite
-fest und setzt den Inhalt in jeder Zeile in eine \Macro{parbox}, wobei diese
-wird mit ihrer obersten Zeile an der Grundlinie ausgerichtet wird. Das Paket
-\Package{array} stellt außerdem die Spaltentypen~\PValue{m}\Parameter{Breite}
+fest und setzt die Zellinhalte in einer \Macro{parbox}, wobei diese mit ihrer
+obersten Zeile an der Grundlinie ausgerichtet wird. Das Paket \Package{array}
+stellt außerdem die Spaltentypen~\PValue{m}\Parameter{Breite}
und~\PValue{b}\Parameter{Breite} bereit, welche ebenfalls mit \Macro{parbox}
gesetzt werden, die Ausrichtung an der Grundlinie jedoch zentriert respektive
-an der unteren Zeile der Box erfolgt. Es folgt ein Beispiel zur Verwendung der
-\Environment{tabular}-Umgebung.
+an der unteren Zeile erfolgt. Es folgt ein Beispiel zur Nutzung der
+\Environment{tabular}"=Umgebung.
%
\begingroup
\pcolumnfuzz{70pt}
@@ -1751,8 +2161,7 @@ an der unteren Zeile der Box erfolgt. Es folgt ein Beispiel zur Verwendung der
\begin{tabular}{lcrp{33mm}}
\toprule
\textbf{Linksbündig} & \textbf{Zentriert} &
-\textbf{Rechtsbündig} & \textbf{Blocksatz} \tabularnewline
-\midrule
+\textbf{Rechtsbündig} & \textbf{Blocksatz} \tabularnewline\midrule
a & b & c & Dieser Text wird im Blocksatz gesetzt\tabularnewline
aa & bb & cc & Auch Zeilenumbrüche sind vorhanden\tabularnewline
aaa & bbb & ccc & Worttrennungsmusterkontrolle\tabularnewline
@@ -1764,10 +2173,10 @@ aaa & bbb & ccc & Worttrennungsmusterkontrolle\tabularnewline
Die Tabellenbreite ergibt sich aus der Breite der einzelnen Spalten. Bei dieser
Umgebung liegt es allein beim Anwender, auf die korrekte Breite der Tabelle zu
achten, damit diese nicht über die Seitenränder hinausragt. Das kann auf Dauer
-recht aufwändig werden. Das Festlegen der Gesamtbreite einer Tabelle durch den
-Anwender und das automatische Berechnen einiger oder aller Spaltenbreiten ist
-sicher die angenehmere Variante. Wie sich dies sehr komfortabel bewerkstelligen
-lässt wird~-- ebenso wie die Lösung des Problems des nicht umbrochenen Eintrags
+recht aufwändig werden. Das Festlegen der Gesamtbreite einer Tabelle und das
+automatische Berechnen einiger oder aller Spaltenbreiten ist sicher die
+angenehmere Variante. Wie sich dies sehr komfortabel bewerkstelligen lässt,
+wird~-- ebenso wie die Lösung des Problems eines nicht umbrochenen Eintrags wie
in der letzten Spalte der dritten Zeile der obigen Tabelle~-- im nachfolgenden
Abschnitt demonstriert.
@@ -1776,7 +2185,7 @@ Abschnitt demonstriert.
Die Pakete \Package{tabularx}, \Package{tabulary} oder auch \Package{tabu}
stehen für das Setzen von Tabellen mit dynamisch berechneter Spaltenbreite bei
fest vorgegebener Gesamtbreite zur Verfügung, welche nun kurz vorgestellt
-werden sollen. Die beiden erstgenannte Pakete \Package{tabularx} sowie
+werden sollen. Die beiden erstgenannte Pakete \Package{tabularx} sowie
\Package{tabulary} stammen vom gleichen Paketautor und haben sich als sehr
stabil erwiesen. Das Paket \Package{tabu} ist relativ neu und versucht, viele
Funktionalitäten ganz unterschiedlicher Pakete für den Tabellensatz in sich zu
@@ -1786,6 +2195,7 @@ vereinen und glänzt insbesondere durch seine Vielseitigkeit.
\usepackage{tabularx}
\usepackage{tabulary}
\usepackage{tabu}
+\usepackage{longtable}
\end{Preamble}
%
@@ -1796,17 +2206,19 @@ angeboten, was bedeutet, dass auch in den neuen Tabellenumgebungen weiterhin
die gewohnten Spaltentypen~\PValue{l},~\PValue{c},~\PValue{r}~und~\PValue{p}
verfügbar sind.
-\subsubsection{Die Tabellenumgebung \Environment{tabularx}}
-\label{sec:tabularx}
+\subsubsection{Die Tabellenumgebung \Environment*{tabularx}}
+\label{sec:tabularx}%
+%
Das Paket \Package{tabularx} stellt den Spaltentyp~\PValue{X} bereit, welcher
prinzipiell dem Spaltentyp~\PValue{p} entspricht. Auch für diesen wird eine
\Macro{parbox} verwendet, allerdings wird deren Breite \emph{automatisch}
-berechnet. Die Umgebung \Environment{tabularx} erwartet vor der Angabe der
-Spaltentypen als obligatorisches Argument die gewünschte Breite der Tabelle. Zu
-beachten ist, dass Spalten vom Typ~\PValue{l},~\PValue{c}~und~\PValue{r}
-weiterhin ohne Zeilenumbruch gesetzt werden. Nur für Spalten vom Typ~\PValue{X}
-und deren Derivate wird aus dem verbliebenen Platz die Breite berechnet. Für
-die \Environment{tabularx}-Umgebung wird das vorherige Beispiel wiederholt.
+berechnet. Die Umgebung \Environment{tabularx}(\Package{tabularx}) erwartet vor
+der Spaltentypenangabe als obligatorisches Argument die gewünschte Breite der
+Tabelle. Spalten vom Typ~\PValue{l},~\PValue{c}~und~\PValue{r} werden jedoch
+weiterhin \emph{ohne} Zeilenumbruch gesetzt werden. Nur für Spalten vom
+Typ~\PValue{X} und deren Derivate wird aus dem verbliebenen Platz die Breite
+berechnet. Für die \Environment{tabularx}(\Package{tabularx})-Umgebung wird das
+vorherige Beispiel wiederholt.
%
\begingroup
\pcolumnfuzz{70pt}
@@ -1814,14 +2226,12 @@ die \Environment{tabularx}-Umgebung wird das vorherige Beispiel wiederholt.
\begin{tabularx}{11.7cm}{lcrX}
\toprule
\textbf{Linksbündig} & \textbf{Zentriert} &
-\textbf{Rechtsbündig} & \textbf{Blocksatz} \tabularnewline
-\midrule
+\textbf{Rechtsbündig} & \textbf{Blocksatz} \tabularnewline\midrule
a & b & c & Dieser Text wird im Blocksatz gesetzt\tabularnewline
aa & bb & cc & Auch Zeilenumbrüche sind vorhanden\tabularnewline
aaa & bbb & ccc & Worttrennungsmusterkontrolle\tabularnewline
aaaa & bbbb & cccc & \hspace{0pt}Worttrennungsmusterkontrolle
-\tabularnewline
-\bottomrule
+\tabularnewline\bottomrule
\end{tabularx}
\end{Hint*}
\endgroup
@@ -1830,24 +2240,24 @@ Die Breite der letzten Spalte wurde dabei aus der Angabe der Gesamtbreite mit
\PValue{11.7cm} berechnet. Des Weiteren ist zu sehen, wie das Problem des
Zeilenumbruchs behandelt werden kann. Normalerweise wird das erste Wort in
einem Absatz von \hologo{LaTeX} \emph{nie} umbrochen. Dies kann durch das
-Einfügen eines breitenlosen Leerzeichens mit \Macro{hspace}\PParameter{0pt}
+Einfügen eines breitenlosen Leerzeichens mit \Macro{hspace}[\PParameter{0pt}]
umgangen werden. Die gefundene Lösung ist allerdings alles andere als elegant.
Mit den Möglichkeiten des Paketes \Package{array} ist das Problem relativ
-schnell gelöst. Es wird mit \Macro{newcolumntype} ein neuer Spaltentyp
-definiert. Das erste Argument von \Macro{newcolumntype} legt den Namen des
-Spaltentyps fest. Mit \PValue{>\Parameter{Definitionen}}\Parameter{Typ} wird im
-zweiten Argument das Ausführen von \PName{Definitionen} vor dem Setzen des
-eigentlichen Inhaltes in einer \Parameter{Typ}"~Spalte definiert. Es wird ein
-neuer, auf der \PValue{X}"~Spalte basierender Typ~\PValue{Y} definiert, welcher
-zu Beginn der Spalte den Phantomabstand automatisch einfügt. Darauf basierend
-werden drei Spaltentypen für den links- und rechtsbündigen sowie zentrierten
-Textsatz mit einem möglichen Zeilenumbruch erstellt.
+schnell gelöst. Es wird mit \Macro{newcolumntype}(\Package{array}) ein neuer
+Spaltentyp definiert. Das erste Argument legt den Namen des Spaltentyps fest.
+Mit \PValue{>\Parameter{Definitionen}}\Parameter{Typ} wird im zweiten Argument
+das Ausführen von \PName{Definitionen} vor dem Setzen des eigentlichen Inhaltes
+in einer \Parameter{Typ}"~Spalte definiert. Es wird ein neuer, auf der
+\PValue{X}"~Spalte basierender Typ~\PValue{Y} definiert, welcher zu Beginn der
+Spalte den Phantomabstand automatisch einfügt. Darauf basierend werden drei
+Spaltentypen für den links- und rechtsbündigen sowie zentrierten Textsatz mit
+einem möglichen Zeilenumbruch erstellt.
%
\begin{Trunk+}
\subsection{Tabellen als Gleitobjekte}
Tabellen sollten in der \texttt{table}"=Gleitumgebung gesetzt werden.
-Welche Umgebung für die Tabelle selbst dabie genutzt wird ist dabei
+Welche Umgebung für die Tabelle selbst dabei genutzt wird ist dabei
nicht relevant. Es können sowohl die normale \texttt{tabular}"=Umgebung
als auch die Umgebungen \texttt{tabularx}, \texttt{tabulary} sowie
\texttt{tabu} für variable Spaltenbreiten bei einer fest vorgegebenen
@@ -1855,7 +2265,7 @@ Tabellenbreite oder jede andere Tabellenumgebung genutzt werden.
Nachfolgend wird dies an mehreren Beispielen demonstriert.
\subsubsection{Eine gleitende tabularx-Tabelle}
-Es wird eine Tabelle mithilfe der \texttt{tabularx}-Umgebung erstellt.
+Es wird eine Tabelle mithilfe der \texttt{tabularx}"=Umgebung erstellt.
Zu sehen ist diese in \autoref{tab:tabularx}. Für diese werden zuvor
neue Spaltentypen definiert.
@@ -1885,7 +2295,7 @@ Ein längerer Blindtext im Blocksatz zur besseren Demonstration
einer Y"~Spalte\tabularnewline
\bottomrule
\end{tabularx}
-\caption{Eine \texttt{tabularx}-Tabelle}\label{tab:tabularx}
+\caption{Eine \texttt{tabularx}"=Tabelle}\label{tab:tabularx}
\end{table}
\end{Trunk}
@@ -1896,8 +2306,9 @@ identisch. Ein Gewichten der Spaltenbreiten untereinander ist prinzipiell
möglich, allerdings mit einigen Einschränkungen verbunden. Genaueres hierzu ist
der Dokumentation des Paketes \Package{tabularx} zu entnehmen.
-\subsubsection{Die Tabellenumgebung \Environment{tabulary}}
-\label{sec:tabulary}
+\subsubsection{Die Tabellenumgebung \Environment*{tabulary}}
+\label{sec:tabulary}%
+%
Das Paket \Package{tabulary} verfolgt im Vergleich zum zuvor beschrieben Paket
\Package{tabularx} einen etwas anderen Ansatz. Anstatt die verfügbare Breite
über alle Spalten gleichmäßig zu verteilen, werden die Spaltenbreite anhand des
@@ -1906,27 +2317,31 @@ Spaltentypen~\PValue{L},~\PValue{C},~\PValue{R}~sowie~\PValue{J} zur Verfügung
gestellt. Diese entsprechen prinzipiell dem Spaltentyp~\PValue{p}, allerdings
wird deren Breite \emph{automatisch} berechnet, wobei Spalten mit mehr Inhalt
breiter gesetzt werden. Für die automatische Berechnung der Spaltenbreiten muss
-verständlicherweise die gewünschte Gesamtbreite angegeben werden, was bei der
-\Environment{tabulary}-Umgebung mit dem ersten obligatorischen Argument vor der
-Angabe der Spaltendefinition erfolgt. Werden für die Tabelle eine oder mehrere
-Spalten vom Typ~\PValue{l},~\PValue{c}~und~\PValue{r} angegeben, so werden
-diese weiterhin in ihrer natürlichen Breite und ohne Zeilenumbruch gesetzt.
+verständlicherweise die gewünschte Gesamtbreite der Tabelle angegeben werden,
+was bei der \Environment{tabulary}(\Package{tabulary})-Umgebung mit dem ersten
+obligatorischen Argument vor der Angabe der Spaltendefinition erfolgt. Werden
+eine oder mehrere Spalten vom Typ~\PValue{l},~\PValue{c}~und~\PValue{r}
+angegeben, so werden diese weiterhin in ihrer natürlichen Breite und ohne
+Zeilenumbruch gesetzt.
Die Gewichtung der Spalten vom Typ~\PValue{LCRJ} und deren Derivate wird aus
dem verbliebenen Platz die Breite berechnet. Die Berechnung der Spaltenbreite
kann durch den Anwender außerdem über zwei Längen beeinflusst werden. Mit
-\Length{tymin} wird die Mindestgröße für Spalten festgelegt. Sollten Sie
-wissen, dass eine Spalte sehr schmal wird, können Sie allerdings auch einfach
-eine der Standardspalten~\PValue{lcrp} nutzen. Mit der Länge \Length{tymax}
-kann die maximale Ausdehnung einer der Spalten vom Typ~\PValue{LCRJ} festgelegt
-werden. Für die \Environment{tabulary}-Umgebung wird das vorherige Beispiel
-wiederholt. Zu beachten ist, dass die Spaltentypen~\PValue{LCRJ} mit dem Makro
-\Macro{tyformat} bereits ein breitenloses Leerzeichen einsetzen, womit sich das
-manuelle Einfügen von selbigem durch den Anwender erübrigt.
+\Length{tymin}(\Package{tabulary}) wird die Mindestgröße für Spalten
+festgelegt. Sollten Sie wissen, dass eine Spalte sehr schmal wird, können Sie
+allerdings auch einfach eine der Standardspalten~\PValue{lcrp} nutzen. Mit der
+Länge \Length{tymax}(\Package{tabulary}) kann die maximale Ausdehnung einer der
+Spalten vom Typ~\PValue{LCRJ} festgelegt werden.
+
+Für die \Environment{tabulary}(\Package{tabulary})-Umgebung wird das vorherige
+Beispiel wiederholt. Zu beachten ist, dass die Spaltentypen~\PValue{LCRJ} mit
+dem Makro \Macro{tyformat}(\Package{tabulary}) bereits ein breitenloses
+Leerzeichen einsetzen, womit sich das manuelle Einfügen von selbigem durch den
+Anwender erübrigt.
%
\begin{Trunk+}
\subsubsection{Eine gleitende tabulary-Tabelle}
-Es wird eine Tabelle mithilfe der \texttt{tabulary}-Umgebung erstellt.
+Es wird eine Tabelle mithilfe der \texttt{tabulary}"=Umgebung erstellt.
Zu sehen ist diese in \autoref{tab:tabulary}.
\end{Trunk+}
@@ -1935,25 +2350,24 @@ Zu sehen ist diese in \autoref{tab:tabulary}.
\begin{tabulary}{\textwidth}{@{}LCRJ@{}}
\toprule
\textbf{Linksbündig} & \textbf{Zentriert} &
-\textbf{Rechtsbündig} & \textbf{Blocksatz} \tabularnewline
-\midrule
+\textbf{Rechtsbündig} & \textbf{Blocksatz} \tabularnewline\midrule
Ein linksbündiger Blindtext zur Demonstration einer L"~Spalte &
Ein zentrierter Blindtext zur Demonstration einer C"~Spalte &
Ein rechtsbündiger Blindtext zur Demonstration einer R"~Spalte &
Ein wesentlich längerer und absolut inhaltsleerer Blindtext im
Blocksatz für eine um einiges bessere Demonstration einer J"~Spalte
-\tabularnewline
-\bottomrule
+\tabularnewline\bottomrule
\end{tabulary}
-\caption{Eine \texttt{tabulary}-Tabelle}\label{tab:tabulary}
+\caption{Eine \texttt{tabulary}"=Tabelle}\label{tab:tabulary}
\end{table}
\end{Trunk}
\InputCode
-\subsubsection{Die Tabellenumgebung \Environment{tabu}}
-\label{sec:tabu}
+\subsubsection{Die Tabellenumgebung \Environment*{tabu}}
+\label{sec:tabu}%
+%
Das Paket \Package{tabu} bietet eine mächtige und komfortable Alternative zu
\Package{tabularx}. Es kam in diesem Tutorial bereits für die Verzeichnisse von
Abkürzungen und Symbolen in \autoref{sec:glossaries} zum Einsatz. Leider ist
@@ -1961,19 +2375,21 @@ das Paket in er aktuellen Version~v2.8 mit Vorsicht zu genießen. Zum einen
wären für das Paket in der aktuellen Version seit geraumer Zeit ein paar
kleinere Bugfixes notwendig, mehr dazu sehen Sie später. Außerdem wird sich die
\hrfn{https://groups.google.com/d/topic/comp.text.tex/xRGJTC74uCI}{%
- Benutzerschnittstelle in einer zukünftigen Version
-} sehr stark ändern. Sie sollten sich bewusst sein, dass mit der Version~v2.8
+ Benutzerschnittstelle in einer zukünftigen Version%
+}
+sehr stark ändern. Sie sollten sich bewusst sein, dass mit der Version~v2.8
gesetzte Dokumente gegebenenfalls später angepasst werden müssen.
-Nichtsdestotrotz soll hier die Verwendung der \Environment{tabu}-Umgebung
-gezeigt werden, insbesondere weil es für das Setzen umbruchfähiger Tabellen mit
-automatisch berechneten Spaltenbreiten momentan (fast) keine Alternative zu der
-Umgebung \Environment{longtabu} gibt.
+Nichtsdestotrotz soll hier folgend die individuelle Verwendung einer
+\Environment{tabu}(\Package{tabu})-Umgebung gezeigt werden, insbesondere weil
+für das Setzen umbruchfähiger Tabellen mit automatisch berechneten
+Spaltenbreiten momentan (fast) keine Alternative zu der Umgebung
+\Environment{longtabu}(\Package{tabu}) existiert.
Dieses Paket definiert ebenso einen Spaltentyp~\PValue{X}, welchem allerdings
-zusätzlich ein optionales Argument angehängt werden kann. Mit diesem lässt sich
-sowohl die Gewichtung der automatisch berechneten Spalten untereinander als
-auch die Positionierung zur Grundlinie sowie die Ausrichtung des Inhaltes
+zusätzlich ein optionales Argument angehangen werden kann. Mit diesem lässt
+sich sowohl die Gewichtung der automatisch berechneten Spalten untereinander
+als auch die Positionierung zur Grundlinie sowie die Ausrichtung des Inhaltes
ändern.
%
\begingroup
@@ -1982,26 +2398,26 @@ auch die Positionierung zur Grundlinie sowie die Ausrichtung des Inhaltes
\begin{tabu} to 11.7cm {lcrX}
\toprule
\textbf{Linksbündig} & \textbf{Zentriert} &
-\textbf{Rechtsbündig} & \textbf{Blocksatz} \tabularnewline
-\midrule
+\textbf{Rechtsbündig} & \textbf{Blocksatz} \tabularnewline\midrule
a & b & c & Dieser Text wird im Blocksatz gesetzt\tabularnewline
aa & bb & cc & Auch Zeilenumbrüche sind vorhanden\tabularnewline
aaaa & bbbb & cccc & Worttrennungsmus\-terkontrolle\tabularnewline
-aaa & bbb & ccc & Worttrennungsmusterkontrolle\tabularnewline
-\bottomrule
+aaa & bbb & ccc & Worttrennungsmusterkontrolle
+\tabularnewline\bottomrule
\end{tabu}
\end{Hint*}
\endgroup
%
Das Beispiel zeigt auch gleich das momentan meiner Meinung nach größte Problem
des Paketes: Bei mehrzeiligen Zellen fehlt vertikale Zwischenraum zur nächsten
-Tabellenzeile. Nun hat man entweder die Möglichkeit, bei jeder Angabe einer
+Tabellenzeile. Nun besteht entweder die Möglichkeit, bei jeder Angabe einer
Spalte im Tabellenkopf, welche eine \Macro{parbox} verwendet, mit dem Ausdruck
-\PValue{>\{\Macro{strut}\}} die fehlenden Unterlänge auszugleichen oder man
-definiert sich abermals einen entsprechenden Spaltentyp. Das ist für die
-\PValue{X}"~Spalten der Umgebung \Environment{tabu} etwas schwieriger, da
-\Macro{newcolumntype} normalerweise die Definition eines optionalen Argumentes
-nicht vorgesehen ist. Mit ein wenig Trickserei ist das dennoch möglich:
+\PValue{>\PParameter{\Macro{strut}}} die fehlenden Unterlänge auszugleichen
+oder es wird abermals ein entsprechender Spaltentyp definiert. Das ist für
+die \PValue{X}"~Spalten der Umgebung \Environment{tabu}(\Package{tabu}) etwas
+schwieriger, da \Macro{newcolumntype}(\Package{array}) normalerweise die
+Definition eines optionalen Argumentes nicht vorgesehen ist. Mit ein wenig
+Trickserei ist das dennoch möglich:
%
\begin{Trunk+}
\subsubsection{Eine gleitende tabu-Tabelle}
@@ -2017,7 +2433,7 @@ die Beschriftung auf die Breite der Tabelle begrenzt.
\begin{Trunk*}
\makeatletter
\newcolumntype{Z}{}
-\renewcommand*\NC@rewrite@Z[1][]{%
+\renewcommand*{\NC@rewrite@Z}[1][]{%
\NC@find>{\hspace{0pt}}X[#1]<{\@finalstrut\@arstrutbox}%
}
\makeatother
@@ -2027,33 +2443,32 @@ die Beschriftung auf die Breite der Tabelle begrenzt.
Anschließend kann der \PValue{Z}"~Spaltentyp äquivalent zu \PValue{X} genutzt
werden. Zu beachten ist dabei insbesondere die Möglichkeit, die Spalten in
ihrer resultierenden Breite sehr einfach zueinander gewichten zu können~-- im
-Gegensatz zur Umgebung \Environment{tabularx}, wo dieses Unterfangen etwas
+Gegensatz zur Umgebung \Environment*{tabularx}, wo dieses Unterfangen etwas
schwieriger ist. Das Ergebnis ist in \autoref{tab:tabu} zu sehen. Zu beachten
-ist dabei die Verwendung von \Macro{ttabbox} aus dem Paket \Package{floatrow},
-um die Beschriftung an die Breite der Tabelle anzupassen. Genaueres dazu in
-\autoref{sec:floatlayout}.
+ist die Verwendung von \Macro{ttabbox}(\Package{floatrow}) aus dem Paket
+\Package{floatrow}, um die Beschriftung an die Breite der Tabelle anzupassen.
+Genaueres dazu in \autoref{sec:floatlayout}.
%
\begin{Trunk}
\begin{table}
\ttabbox{%
-\begin{tabu} to .8\textwidth {@{}Z[3,l]Z[3,c]Z[3,r]Z[2,j]@{}}
- \toprule
- \textbf{Linksbündig} & \textbf{Zentriert} &
- \textbf{Rechtsbündig} & \textbf{Blocksatz} \tabularnewline
- \midrule
- Ein linksbündiger Blindtext zur Demonstration einer Z[l]"~Spalte &
- Ein zentrierter Blindtext zur Demonstration einer Z[c]"~Spalte &
- Ein rechtsbündiger Blindtext zur Demonstration einer Z[r]"~Spalte &
- Ein Blindtext im Blocksatz innerhalb einer Z"~Spalte
- \tabularnewline
- \bottomrule
+ \begin{tabu} to .8\textwidth {@{}Z[3,l]Z[3,c]Z[3,r]Z[2,j]@{}}
+ \toprule
+ \textbf{Linksbündig} & \textbf{Zentriert} &
+ \textbf{Rechtsbündig} & \textbf{Blocksatz} \tabularnewline\midrule
+ Ein linksbündiger Blindtext zur Demonstration einer Z[l]"~Spalte &
+ Ein zentrierter Blindtext zur Demonstration einer Z[c]"~Spalte &
+ Ein rechtsbündiger Blindtext zur Demonstration einer Z[r]"~Spalte &
+ Ein Blindtext im Blocksatz innerhalb einer Z"~Spalte
+ \tabularnewline\bottomrule
\end{tabu}%
}{%
- \caption[Eine \texttt{tabu}-Tabelle]{%
- Eine \texttt{tabu}-Tabelle in Verbindung mit dem Befehl
+ \caption[Eine \texttt{tabu}"=Tabelle]{%
+ Eine \texttt{tabu}"=Tabelle in Verbindung mit dem Befehl
\texttt{\textbackslash ttabbox}, welcher vom Paket \texttt{floatrow}
für Beschriftungen in Objektbreite bereitgestellt wird%
- }\label{tab:tabu}%
+ }%
+ \label{tab:tabu}%
}
\end{table}
@@ -2063,17 +2478,18 @@ um die Beschriftung an die Breite der Tabelle anzupassen. Genaueres dazu in
\section{Querverweise}
-\label{sec:references}
+\label{sec:references}%
%
Damit alle möglichen Querverweise in einem PDF-Dokument automatisch verlinkt
werden, sollte das Paket \Package{hyperref} geladen werden. Um die erzeugten
-Links verträglich aussehen zu lassen, werden die Optionen \Option{colorlinks}
-sowie \Option{linkcolor}[blue] verwendet. Da \Package{hyperref} allerhand
-Veränderungen an vielen Standardbefehlen vornimmt, sollte dieses als letztes in
-der Präambel eingebunden werden. Nur Pakete, bei denen in der Dokumentation
-explizit darauf hingewiesen wird, dass diese nach \Package{hyperref} zu laden
-sind, sollten auch danach folgen. Eines dieser wenigen Pakete ist das in diesem
-Tutorial verwendete \Package{glossaries}.
+Links verträglich aussehen zu lassen, werden die beiden Paketoptionen
+\Option{colorlinks}(\Package{hyperref}) sowie \Option*{linkcolor=blue}
+verwendet. Da \Package{hyperref} allerhand Veränderungen an vielen
+Standardbefehlen vornimmt, sollte dieses als letztes in der Präambel
+eingebunden werden. Nur Pakete, bei denen in der Dokumentation explizit darauf
+hingewiesen wird, dass diese nach \Package{hyperref} zu laden sind, sollten
+auch danach folgen. Eines dieser wenigen Pakete ist das in diesem Tutorial
+verwendete \Package{glossaries}.
%
\begin{Hint}
\usepackage[colorlinks,linkcolor=blue]{hyperref}
@@ -2082,32 +2498,41 @@ Tutorial verwendete \Package{glossaries}.
%
Um auf ein bestimmtes Objekt wie beispielsweise eine Tabelle, eine Abbildung
oder einen bestimmten Anschnitt im Dokument referenzieren zu können, muss mit
-\Macro{label}\Parameter{label} ein Anker für selbiges an der entsprechenden
+\Macro{label}[\Parameter{label}] ein Anker für selbiges an der entsprechenden
Stelle gesetzt werden. Bei Überschriften sollte dies direkt nach der Nutzung
-des Gliederungsbefehls\footnote{\Macro{chapter}, \Macro{section} etc.}
+des Gliederungsbefehls%
+\footnote{%
+ \Macro{chapter}(\Package{koma-script}),
+ \Macro{section}(\Package{koma-script}) etc.%
+}
erfolgen. Für Abbildungen, Tabellen oder andere Objekte in Gleitumgebungen muss
-der Anker unmittelbar nach der Verwendung von \Macro{caption} respektive
-\Macro{captionof} erstellt werden. Um nun auf diesen Anker zu referenzieren,
-sollte nicht \Macro{ref} sondern \Macro{autoref} im Fließtext genutzt werden.
-Letztgenannter Befehl erzeugt nicht nur einen Link mit der dazugehörigen
-Nummerierung sondern stellt dieser die Bezeichnung des referenzierten Objektes%
-\footnote{\enquote{Abbildung}, \enquote{Tabelle}, \dots} voran.
+der Anker unmittelbar nach der Verwendung von
+\Macro{caption}(\Package{koma-script},\Package{caption}) respektive
+\Macro{captionof}(\Package{koma-script}) erstellt werden. Um nun auf diesen
+Anker zu referenzieren, sollte nicht \Macro{ref} sondern
+\Macro{autoref}(\Package{hyperref}) im Fließtext genutzt werden. Letztgenannter
+Befehl erzeugt nicht nur einen Link mit der dazugehörigen Nummerierung sondern
+stellt dieser die Bezeichnung des referenzierten Objektes%
+\footnote{\enquote{Abbildung}, \enquote{Tabelle}, \dots}
+voran.
Mit dem Befehl \Macro{pageref} lässt sich auf die Seite eines Ankers verweisen.
Das Paket \Package{varioref} kann dabei unterscheiden, ob der Anker sich auf
der aktuellen Seite, auf einer Seite direkt davor beziehungsweise danach oder
auf einer entfernteren Seite befindet und dementsprechend einen Hinweis darauf
-ausgeben. Hierfür werden die Befehle \Macro{vref} sowie \Macro{vpageref} zur
-Verfügung gestellt. Das Paket \Package{cleveref} vereint die Vorzüge von
-\Macro{autoref} in Verbindung mit \Macro{vref} durch den Befehl \Macro{cref}.
+ausgeben. Hierfür werden die Befehle \Macro{vref}(\Package{varioref}) sowie
+\Macro{vpageref}(\Package{varioref}) zur Verfügung gestellt. Das Paket
+\Package{cleveref} vereint die Vorzüge von \Macro{autoref}(\Package{hyperref})
+in Verbindung mit \Macro{vref}(\Package{varioref}) durch den Befehl
+\Macro{cref}(\Package{cleverref}).
\section{Zitate}
Für das wörtliche Zitieren kann das Paket \Package{csquotes} verwendet werden.
-Dieses stellt den Befehl \Macro{enquote} bereit, der die kennzeichnenden
-Anführungszeichen automatisch in Abhängigkeit der verwendeten Dokumentsprache
-setzt.
+Dieses stellt den Befehl \Macro{enquote}(\Package{csquotes}) bereit, der die
+kennzeichnenden Anführungszeichen automatisch in Abhängigkeit der verwendeten
+Dokumentsprache setzt.
%
\begin{Hint}
\usepackage{csquotes}
@@ -2132,17 +2557,19 @@ gekennzeichnet werden.
\end{Trunk*}
\begin{Trunk+}
Für eine möglichst gut nachvollziehbare Referenz sollte nicht nur
-das Werk selber sondern zumindest die Seitenzahl und gegebenfalls
+das Werk selber sondern zumindest die Seitenzahl und gegebenenfalls
der Absatz der originalen Textstelle angegeben werden.
\end{Trunk+}
%
Längere Zitate sollten abgesetzt vom Fließtext ausgegeben werden. Hierfür
bieten sowohl die Standard"~ als auch die \KOMAScript-Klassen standardmäßig
-die Umgebungen \Environment{quote} und \Environment{quotation} an. Allerdings
-verwenden beide fest eingestellte Absatzauszeichnungen. Sollen jedoch die
-mit der Option \Option{parskip} vorgegebenen Absatzeinstellungen beachtet
-werden, so bietet sich das Paket \Package{quoting} an, welches die gleichnamige
-Umgebung definiert und die Absätze wie im restlichen Dokument auszeichnet.
+die Umgebungen \Environment{quote}(\Package{koma-script}) und
+\Environment{quotation}(\Package{koma-script}) an. Allerdings verwenden beide
+fest eingestellte Absatzauszeichnungen. Sollen jedoch die mit der Option
+\Option{parskip}(\Package{koma-script}) vorgegebenen Einstellungen für Absätze
+beachtet werden, so bietet sich das Paket \Package{quoting} an, welches die
+gleichnamige Umgebung \Environment{quoting}(\Package{quoting}) definiert und
+die Absätze wie im restlichen Dokument auszeichnet.
%
\begin{Preamble}
\usepackage{quoting}
@@ -2156,17 +2583,17 @@ Umgebung definiert und die Absätze wie im restlichen Dokument auszeichnet.
Wirkung der Umgebung \texttt{quoting} bei der Absatzauszeichnung
deutlich.
- Wie man sieht, ist der zweite Absatz~-- wie jeder weitere~-- aufgrund
- der Einstellung \texttt{parskip=false} eingezogen.
+ Wie zu sehen ist, wird der zweite Absatz~-- wie jeder weitere~--
+ aufgrund der Option \texttt{parskip=false} eingezogen.
}
\cite[sinngemäß nach][\pno{} 12, zweiter Absatz]{hanisch14}
\end{quoting}
\end{Trunk*}
\begin{Trunk+}
Ebenfalls sollten sinngemäße Zitate mit einer möglichst genauen Referenz
-angegeben werden. Dies kann im Laufe der Arbeit acuh für einen selbst von
-Vorteil sein, wenn man beispielsweise die originale Textpassage noch
-einmal analysieren möchte.
+angegeben werden. Dies kann im Laufe der Arbeit auch für einen selbst von
+Vorteil sein, wenn beispielsweise die originale Textpassage noch einmal
+analysiert werden soll.
\end{Trunk+}
\begin{quoting}[rightmargin=0pt]
@@ -2174,7 +2601,6 @@ einmal analysieren möchte.
\let\markboth\@gobbletwo
\let\markright\@gobble
\makeatother
-\vspace*{-\baselineskipglue}
\printbibliography
\end{quoting}
\end{refsection}
@@ -2182,7 +2608,8 @@ einmal analysieren möchte.
\section{Worttrennungen}
-\label{sec:hyphenation}
+\label{sec:hyphenation}%
+%
Bei der Verwendung von \hologo{LaTeXe} gibt es ab und an das Problem, dass
bestimmte Wörter am Zeilenende falsch getrennt werden. Dies hat historische
Gründe. Als \hologo{TeX} in den 1980er-Jahren entwickelt wurde, war es aufgrund
@@ -2212,39 +2639,42 @@ Dokumentpräambel könnte folgendermaßen aussehen:
§\dots§
\end{Hint}
%
-Die Option \Option{ngerman} lädt dabei die Trennmuster für die neue deutsche
-Rechtschreibung, wobei der Wert \PValue{ngerman-x-latest} die neuesten aller
-verfügbaren Trennmuster lädt. Für die alte Orthografie ist stattdessen
-\Option{german}[german-x-lastest] zu verwenden.
+Die Option \Option{ngerman}(\Package{hyphsubst}) lädt dabei die Trennmuster für
+die neue deutsche Rechtschreibung, wobei der Wert \PValue{ngerman-x-latest} die
+neuesten aller verfügbaren Trennmuster lädt. Für die alte Orthografie ist
+stattdessen die Option \Option{german}(\Package{hyphsubst}) mit dem Wert
+\PValue{german-x-lastest} zu verwenden.
\subsection{Einmalige und globale Worttrennungskorrektur}
Sollte es dennoch passieren, dass ein Wort nicht richtig getrennt wird, kann
dies manuell korrigiert werden. Dafür stellt das Paket \Package{babel} mehrere
-Kurzbefehle zur Verfügung. Außerdem lassen sich mit \Macro{hyphenation} für ein
-bestimmtes Wort alle potentiellen Trennstellen angeben. Im \TUDScript-Handbuch
-ist im Kapitel Tipps~\&~Tricks zum Thema \manualhyperref{sec:tips:hyphenation}{%
-Worttrennungen in deutschsprachigen Texten} mehr zu finden. Dort wird auch
-erläutert, wie das Problem der alleinigen Trennung von Wörtern mit Bindestrich
-an selbigem umgangen werden kann.
+Kurzbefehle zur Verfügung. Mit dem Makro \Macro{hyphenation} lassen sich für
+ein bestimmtes Wort außerdem alle potentiellen Trennstellen angeben. Zum Thema
+\tudhyperref{sec:tips:hyphenation}{Worttrennungen in deutschsprachigen Texten}
+ist im \TUDScript-Handbuch unter dem Kapitel Tipps~\&~Tricks mehr zu finden.
+Dort wird auch erläutert, wie das Problem der alleinigen Trennung von Wörtern
+mit Bindestrich an selbigem umgangen werden kann.
\subsection{Worttrennung im Flattersatz}
-Normalerweise ist bei \hologo{LaTeXe} die Worttrennung im Flattersatz%
-\footnote{\Macro{raggedright}, \Macro{raggedleft}, \Macro{center}} deaktiviert.
-Mit dem Paket \Package{ragged2e} kann diese hierfür aktiviert werden. Wird es
-geladen, stehen dem Anwender die Befehle \Macro{Centering}, \Macro{RaggedLeft}
-sowie \Macro{RaggedRight} zur Verfügung, um Worttrennungen im Flattersatz zu
-verwenden. Mit der Paketoption \Option{newcommands} können die originalen
-Befehle \Macro{centering}, \Macro{raggedleft} und \Macro{raggedright} mit der
-Definition der neuen überschrieben werden. Genaueres dazu ist der Dokumentation
-des Paketes zu entnehmen.
+Normalerweise ist bei \hologo{LaTeXe} die Worttrennung für den Flattersatz%
+\footnote{\Macro{raggedright}, \Macro{raggedleft}, \Macro{centering}}
+deaktiviert. Mit dem Paket \Package{ragged2e} kann diese aktiviert werden. Nach
+dem Laden stehen die Befehle \Macro{Centering}(\Package{ragged2e}),
+\Macro{RaggedLeft}(\Package{ragged2e}) sowie
+\Macro{RaggedRight}(\Package{ragged2e}) für den Anwender zur Verfügung, um
+Worttrennungen im Flattersatz zu verwenden. Die Option
+\Option{newcommands}(\Package{ragged2e}) überschreibt die originalen Befehle
+\Macro{centering}, \Macro{raggedleft} und \Macro{raggedright} mit den
+korrelierten Befehlen aus dem Paket. Genaueres dazu ist der Dokumentation des
+Paketes zu entnehmen.
\section{Mikrotypografische Feinheiten}
-Unter Mikrotypografie oder Detailtypografie versteht man die Gestaltung
-folgender Feinheiten des Schriftsatzes:
+Unter Mikrotypografie oder Detailtypografie wird die Gestaltung folgender
+Feinheiten des Schriftsatzes verstanden:
\begin{itemize}[noitemsep]
\item korrekte Anwendung der Satzzeichen
\item Schriftart, Kapitälchen und Ligaturen
@@ -2254,24 +2684,24 @@ folgender Feinheiten des Schriftsatzes:
\noindent Die letzten beiden Punkte werden sensationell gut durch das Paket
\Package{microtype} bearbeitet. Dieses muss lediglich in der Präambel geladen
-werden, wobei es nicht mit der klassischen \hologo{TeX}-Engine, wohl jedoch mit
-\hologo{pdfTeX} als auch \hologo{LuaTeX} sowie \hologo{XeTeX} funktioniert.
+werden, wobei es nicht mit der klassischen \hologo{TeX}"~Engine, wohl jedoch
+mit \Engine{pdfTeX} als auch \Engine{LuaTeX} sowie \Engine{XeTeX} funktioniert.
%
\begin{Preamble}
\usepackage[babel]{microtype}
\end{Preamble}
%
-Die Option \Option{babel} ist nur notwendig, wenn einzelne Textpassagen oder
-das gesamte Dokument in Englisch oder Französisch verfasst werden und hierfür
-die genutzte Sprache mit den entsprechenden Möglichkeiten von \Package{babel}
-eingestellt wird.
+Die Option \Option{babel}(\Package{microtype}) ist nur notwendig, wenn einzelne
+Textpassagen oder das gesamte Dokument in Englisch oder Französisch verfasst
+werden und hierfür die genutzte Sprache mit den entsprechenden Möglichkeiten
+von \Package{babel} eingestellt wird.
Das korrekte Anwenden von Satzzeichen wird für deutschsprachige Texte bereits
in mehreren Artikeln \cite{neubauer1996,neubauer1997,struckmann2007,bier2009}
sehr gut erläutert, weshalb ein Hinweis auf diese Arbeiten für weitergehende
Informationen zu dieser Thematik absolut ausreichend ist. Nachfolgend werden
-Tipps gegeben sowie einige \hologo{LaTeXe}-Pakete vorgestellt, die bei der
+Tipps gegeben sowie einige \hologo{LaTeXe}"=Pakete vorgestellt, die bei der
Umsetzung der in den genannten Artikeln erläuterten Empfehlungen helfen.
@@ -2279,7 +2709,7 @@ Umsetzung der in den genannten Artikeln erläuterten Empfehlungen helfen.
In \cite{struckmann2007} wird gleich zu Beginn darauf hingewiesen, wie häufig
verwendete Abkürzungen sehr einfach im Dokument verwendet werden können und
dabei typografisch richtig gesetzt werden. Beispielsweise gelingt dies für die
-Abkürzung \enquote{zum~Beispiel~(z.\,B.)} mit der nachfolgenden Definition:
+Abkürzung \enquote{zum~Beispiel~(z.\,B.)} mit dieser Definition:
%
\begin{Hint}
\newcommand{\zB}{\mbox{z.\,B.}\xspace}
@@ -2287,18 +2717,19 @@ Abkürzung \enquote{zum~Beispiel~(z.\,B.)} mit der nachfolgenden Definition:
%
Wenn ohnehin das Paket \Package{glossaries} für Akronyme verwendet wird, kann
alternativ dazu auch dessen Funktionalität genutzt werden. Nach dem Einbinden
-braucht man in der Präambel lediglich Folgendes einfügen:
+muss in der Präambel lediglich Folgendes eingefügt werden:
%
\begin{Hint}
\newignoredglossary{abbreviation}
- \newcommand*\newabbreviation[4][]{%
+ \newcommand*{\newabbreviation}[4][]{%
\newacronym[type=abbreviation,#1]{#2}{\mbox{#3\xspace}}{#4}%
}%
\end{Hint}
%
-Mit \Macro{newignoredglossary} wird dabei ein Glossar erstellt, welche bei der
-Ausgabe aller Glossare mit \Macro{printglossaries} ignoriert wird. Im Dokument
-kann die gewünschte Abkürzung mit
+Mit \Macro{newignoredglossary}(\Package{glossaries}) wird dabei ein Glossar
+erstellt, welche bei der Ausgabe aller Glossare mit
+\Macro{printglossaries}(\Package{glossaries}) ignoriert wird. Im Dokument kann
+die gewünschte Abkürzung mit
%
\begin{Hint*}
\newabbreviation{zB}{z.\,B.}{zum Beispiel}
@@ -2308,10 +2739,10 @@ definiert und über die gewohnten Befehlen aus \Package{glossaries} verwendet
werden.
%
\begin{Hint*}
-Die Ausgabe der eben definierten Abkürzung erfolgt \acrshort{zB} mit dem
-Befehl \texttt{\textbackslash acrshort}. Wurde \texttt{glossaries} mit
-der Option \texttt{shortcut} geladen, kann alternativ auch das kürzere
-Makro \texttt{\textbackslash acs} genutzt werden.
+Die Ausgabe der soeben definierten Abkürzung \enquote{\acrshort{zB}}
+erfolgt mit dem Befehl \texttt{\textbackslash acrshort}. Wurde das
+Paket \texttt{glossaries} mit der Option \texttt{shortcut} geladen,
+kann auch das Makro \texttt{\textbackslash acs} genutzt werden.
\end{Hint*}
@@ -2327,27 +2758,28 @@ stehen mit \Tutorial{mathtype} und \Tutorial{mathswap} zwei weitere Tutorials
zur Verfügung, die sich explizit mit der Thematik eines guten mathematischen
Satz beschäftigen.
-Das Paket \Package{amsmath} stellt den De-facto-Standard für den mathematischen
-Satz mit \hologo{LaTeXe} dar. Allerdings wird es~-- insbesondere aus diesem
-Grund~-- nur sehr \enquote{vorsichtig} weiterentwickelt. Für das Setzen neuer
-Dokumente sollte deswegen das Paket \Package{mathtools} verwendet werden,
-welches zwar auf \Package{amsmath} basiert, dieses jedoch um zusätzliche
-Funktionalitäten ergänzt und Bugfixes bereithält.
+Das Paket \Package{amsmath} stellt für \hologo{LaTeXe} den De-facto-Standard
+für den mathematischen Satz dar. Allerdings wird es~-- insbesondere aus diesem
+Grund~-- sehr \enquote{vorsichtig} weiterentwickelt. Für das Setzen neuer
+Dokumente sollte deshalb das Paket \Package{mathtools} verwendet werden, das
+auf \Package{amsmath} basiert und dieses um zusätzliche Funktionalitäten
+ergänzt sowie Bugfixes bereithält.
\subsection{Einheiten}
Mit dem Paket \Package{siunitx} lassen sich sowohl physikalische Einheiten als
auch Zahlen typografisch korrekt setzen. Sollen die Funktionalitäten in einem
deutschsprachigen Dokument problemlos nutzbar sein, so sind die Hinweise zum
-\manualhyperref{sec:tips:siunitx}{Setzen von Einheiten mit \Package{siunitx}}
-im \TUDScript-Handbuch zu beachten. Das Paket \Package{units} ist nicht ganz so
+\tudhyperref{sec:tips:siunitx}{Setzen von Einheiten mit \Package{siunitx}} im
+\TUDScript-Handbuch zu beachten. Das Paket \Package{units} ist nicht ganz so
mächtig wie \Package{siunitx}, kann allerdings als pragmatische Alternative
gesehen und genutzt werden.
\subsection{Darstellung von mathematischen Brüchen}
Für ansehnliche und insbesondere im Fließtext gut lesbare mathematische Brüche
-stellt das Paket \Package{xfrac} den Befehl \Macro{sfrac} zur Verfügung.
+stellt das Paket \Package{xfrac} den Befehl \Macro{sfrac}(\Package{xfrac}) zur
+Verfügung.
%
\begin{Preamble}
\usepackage{xfrac}
@@ -2356,26 +2788,29 @@ stellt das Paket \Package{xfrac} den Befehl \Macro{sfrac} zur Verfügung.
\subsection{Ligaturen}
-Die meisten \hologo{LaTeX}-Schriftfamilien enthalten Ligaturen, die für einen
+Die meisten \hologo{LaTeX}"=Schriftfamilien enthalten Ligaturen, die für einen
typografisch sauberen Satz bei zusammengesetzten Wörtern, wie sie gerade im
Deutschen relativ häufig vorkommen, aufgetrennt werden müssten. Mit der
-Anwendung \href{http://www.ctan.org/pkg/delig}{\Application{DeLig}} kann dies
-automatisiert geschehen. Wird \hologo{LuaLaTeX} als Dokumentprozessor genutzt,
-kann alternativ für dieses Unterfangen das Paket \Package{selnolig} verwendet
-werden.
+Anwendung \Application{DeLig}<delig> kann dies automatisiert geschehen. Wird
+\Engine{LuaLaTeX} als Textsatzsystem genutzt, kann alternativ für dieses
+Unterfangen das Paket \Package{selnolig} verwendet werden.
\subsection{Listen}
-\label{sec:lists}
+\label{sec:lists}%
+%
Für Auflistungen aller Art bietet \hologo{LaTeX} die drei Standardumgebungen
-\Environment{iteimze}, \Environment{enumerate} und \Environment{description}.
-Das häufigste Anliegen bei der Verwendung dieser Umgebungen ist das Reduzieren
-der Abstände zwischen den einzelnen, mit \Macro{item} gesetzten Punkten, welche
-sehr häufig als zu groß empfunden werden. Eine Aufzählung erscheint ohne
-weitere Anpassungen normalerweise so:
+\Environment{itemize}(\Package{koma-script},\Package{enumitem}),
+\Environment{enumerate}(\Package{koma-script},\Package{enumitem}) und
+\Environment{description}(\Package{koma-script},\Package{enumitem}). Das
+häufigste Anliegen bei der Verwendung dieser Umgebungen ist das Reduzieren
+der Abstände zwischen den einzelnen, mit
+\Macro{item}(\Package{koma-script},\Package{enumitem}) gesetzten Punkten,
+welche sehr häufig als zu groß empfunden werden. Eine Aufzählung erscheint ohne
+weitere Anpassungen wie folgt:
%
\CodePreamble{%
- Aufzählung mit einer \Environment{itemize}-Umgebung und Standardabständen:%
+ Aufzählung mit einer \Environment*{itemize}"=Umgebung und Standardabständen:%
}
\begin{Hint*}
\begin{itemize}
@@ -2385,18 +2820,19 @@ weitere Anpassungen normalerweise so:
\end{itemize}
\end{Hint*}
%
-Dabei wirken die Abstände zwischen den einzelnen Punkten tatsächlich etwas
-überdimensioniert. Mit dem Paket \Package{enumitem} können die Umgebungen für
-Auflistungen einfach an die individuellen Bedürfnisse angepasst werden.
+Dabei wirken die Abstände zwischen den Punkten tatsächlich etwas
+überdimensioniert. Mit \Package{enumitem} können alle Listenumgebungen an die
+individuellen Bedürfnisse angepasst werden.
%
\begin{Preamble}
\usepackage{enumitem}
\end{Preamble}
+%
Um diese ungewollten Abstände zwischen den Listenpunkten zu entfernen, kann der
-Schlüssel \Option{noitemsep} verwendet werden. Mit dem Befehl \Macro{setlist}
-werden~-- ohne zusätzliche Angaben im optionalen Argument~-- alle Umgebungen
-für Aufzählungen global geändert. Hier soll dies lediglich für die Umgebung
-\Environment{itemize} geschehen:
+Schlüssel \Option{noitemsep}(\Package{enumitem}) verwendet werden. Mit dem
+Befehl \Macro{setlist}(\Package{enumitem}) werden~-- ohne zusätzliche Angaben
+im optionalen Argument~-- alle Umgebungen für Aufzählungen global geändert.
+Hier soll dies lediglich für die Umgebung \Environment*{itemize} geschehen:
\begin{Preamble*}
\setlist[itemize]{noitemsep}
@@ -2405,7 +2841,8 @@ für Aufzählungen global geändert. Hier soll dies lediglich für die Umgebung
Das Ergebnis stellt sich folgendermaßen dar:
%
\CodePreamble{%
- Aufzählung mit einer \Environment{itemize}-Umgebung ohne vertikale Abstände:%
+ Aufzählung mit einer \Environment*{itemize}"=Umgebung ohne vertikale
+ Abstände:%
}
\begin{Hint*}
\begin{itemize}
@@ -2421,17 +2858,20 @@ kann der Schlüssel \PValue{noitemsep} auch nur gezielt an einzelne Umgebung
über das optionale Argument weitergereicht werden.
Natürlich erlaubt das Paket noch weitergehende Einstellungen für die Umgebungen
-\Environment{itemize}, \Environment{enumerate} und \Environment{description}.
+\Environment{itemize}(\Package{koma-script},\Package{enumitem}),
+\Environment{enumerate}(\Package{koma-script},\Package{enumitem}) und
+\Environment{description}(\Package{koma-script},\Package{enumitem}).
Zusätzlich können diese für eigene Aufzählungsumgebungen geklont und den
eigenen Bedürfnissen angepasst werden. Genaueres hierzu ist der Dokumentation
des Paketes \Package{enumitem} entnehmen.
\subsection{Datumsformatierung}
-Das Paket \Package{isodate} stellt den Befehl \Macro{printdate} bereit, welcher
-für die Formatierung von Datumsangaben verwendet werden kann. Wird das Paket
-mit einer der \TUDScript-Dokumentklassen geladen, wird der genannte Befehl
-automatisch für alle bereitgestellten Datumsfelder verwendet.
+Das Paket \Package{isodate} stellt \Macro{printdate}(\Package{isodate}) bereit.
+Dieser Befehl kann für die Formatierung von Datumsangaben verwendet werden.
+Wird das Paket mit einer der Dokumentklassen aus dem \TUDScript-Bundle geladen,
+wird der genannte Befehl automatisch für alle bereitgestellten Datumsfelder
+verwendet.
%
\begin{Preamble}
\usepackage{isodate}
@@ -2441,8 +2881,8 @@ automatisch für alle bereitgestellten Datumsfelder verwendet.
\subsection{Auslassungspunkte}
Das typografisch richtige Setzen von Auslassungspunkten mit den Befehlen
-\Macro{dots} repsektive \Macro{textellipsis} wird im Handbuch unter
-\manualhyperref{sec:tips:dots}{Das Setzen von Auslassungspunkten} genauer
+\Macro{dots} respektive \Macro{textellipsis} wird im Handbuch unter
+\tudhyperref{sec:tips:dots}{Das Setzen von Auslassungspunkten} genauer
beschrieben, weshalb hier nur kurz darauf eingegangen wird. Es wird das Paket
\Package{ellipsis} benötigt.
%
@@ -2462,25 +2902,27 @@ ausgeführt werden.
\section{Erstellen von Abbildungen}
-\label{sec:figures}
+\label{sec:figures}%
+%
Die einfachste Möglichkeit, in einer wissenschaftlichen Abhandlung Grafiken zu
verwenden, ist sicherlich das Einbinden von externen Abbildungen mit dem Befehl
-\Macro{includegraphics}. Allerdings ist für eine wissenschaftliche Arbeit in
-höchster Qualität meiner Meinung nach das bloße Einfügen einer gescannten oder
-heruntergeladenen Grafik unzureichend. Vielmehr sollte diese zum einen als
-skalierbare Vektorgrafik vorliegen, um sowohl die höchste Druckqualität als
-auch die Wiederverwendbarkeit sicherzustellen, und zum anderen in ihrer
-Gestaltung dem verwendeten Layout des verfassten Dokumentes entsprechen. Dies
-betrifft sowohl die eingesetzten Farben und Schriften als auch die Stärke der
-verwendeten Linien.
+\Macro{includegraphics}(\Package{graphicx}) aus dem Paket \Package{graphicx}.
+Allerdings ist für eine wissenschaftliche Arbeit in höchster Qualität meiner
+Meinung nach das bloße Einfügen einer gescannten oder heruntergeladenen Grafik
+unzureichend. Vielmehr sollte diese zum einen als skalierbare Vektorgrafik
+vorliegen, um sowohl die höchste Druckqualität als auch die
+Wiederverwendbarkeit sicherzustellen, und zum anderen in ihrer Gestaltung dem
+verwendeten Layout des verfassten Dokumentes entsprechen. Dies betrifft sowohl
+die eingesetzten Farben und Schriften als auch die Stärke der verwendeten
+Linien.
Zum Zeichnen von Grafiken sind die freien Programme \Application{LaTeXDraw} und
besonders \Application{Inkscape} empfehlenswert, da diese die Verwendung der
Dokumentschriften innerhalb der erstellten Grafiken ermöglichen. Im Handbuch zu
-\TUDScript wird dies für \manualhyperref{sec:tips:svg}{\Application{Inkscape}}
+\TUDScript wird dies für \tudhyperref{sec:tips:svg}{\Application{Inkscape}}
genauer erläutert. Eine andere Variante ist das \enquote{Programmieren} von
-Grafiken. Die zwei bekanntesten \hologo{LaTeX}-Pakete sind \Package{tikz}(pgf)
-und \Package{pstricks}(pstricks-base). Für diese beiden wird im Folgenden eine
+Grafiken. Die zwei bekanntesten \hologo{LaTeX}"=Pakete sind \Package{tikz}<pgf>
+und \Package{pstricks}<pstricks-base>. Für diese beiden wird im Folgenden eine
Abbildung exemplarisch erstellt, ohne dabei tiefer ins Detail gehen zu wollen.
Ebenfalls wird darauf verzichtet, diese im Kopierbeispiel einzubinden. Für
beide Pakete gibt es neben der umfangreichen Dokumentation zahlreiche Beispiele
@@ -2488,9 +2930,9 @@ und Erläuterungen im Internet.
\subsection{Das Paket \Package{tikz}}
-Zur Verwendung von \Package{tikz}(pgf) ist nicht viel zu sagen. Einfach in der
+Zur Verwendung von \Package{tikz}<pgf> ist nicht viel zu sagen. Einfach in der
Dokumentpräambel einbinden und es kann losgehen. Für das nachfolgende Beispiel
-sind außerdem noch zwei weitere Programmbibliotheken für \Package{tikz}(pgf)
+sind außerdem noch zwei weitere Programmbibliotheken für \Package{tikz}<pgf>
notwendig.
%
\begin{Hint}
@@ -2501,7 +2943,7 @@ notwendig.
\end{Hint}
%
Ein kurze Anmerkungen zur Skalierung der Grafiken möchte ich mir erlauben.
-Normalerweise verwendet \Package{tikz}(pgf) Koordinaten im Zentimeter"=Raster.
+Normalerweise verwendet \Package{tikz}<pgf> Koordinaten im Zentimeter"=Raster.
Ich persönlich bevorzuge der relativierte Skalierung auf die Textbreite des
Dokumentes, wobei eine Einheit genau \SI{1}{\percent} dieser entspricht. Das
kann mit folgendem Quelltext erreicht werden:
@@ -2546,7 +2988,7 @@ erstellt. Das Ergebnis ist in \autoref{fig:tikz} zu sehen.
postaction={decorate},
shorten >=0.7pt
]
- \newcommand\tikzparbox[2][9]{%
+ \newcommand{\tikzparbox}[2][9]{%
\parbox{#1\tikzunit}{\centering\hspace{0pt}#2}%
}
\begin{scope}[start chain]
@@ -2607,27 +3049,27 @@ erstellt. Das Ergebnis ist in \autoref{fig:tikz} zu sehen.
\caption{Eine mit TikZ erstellte Grafik}\label{fig:tikz}
\end{figure}
\end{Hint?}
-%\InputCode
+
\subsection{Das Paket \Package{pstricks}}
-Die zuvor mit \Package{tikz}(pgf) erstellte Grafik wird nachfolgend mit dem
+Die zuvor mit \Package{tikz}<pgf> erstellte Grafik wird nachfolgend mit dem
Paket \Package{pstricks} erstellt. Mit diesem lassen sich PostScript"=Grafiken
-erstellen. Ähnlich wie bei \Package{tikz}(pgf) gibt es ein Kernpaket und
+erstellen. Ähnlich wie bei \Package{tikz}<pgf> gibt es ein Kernpaket und
zusätzliche Ergänzungen. Diese werden jedoch nicht als Programmbibliotheken
sondern ganz normal als \hologo{LaTeX}"=Pakete eingebunden.
%
\begin{Hint}
-\usepackage{pstricks}
-\usepackage{pst-node}
+\usepackage{pstricks,pst-node}
\end{Hint}
%
Die Verwendung von PostScript hat zahlreiche Vorteile, macht die direkte
-Nutzung von \hologo{pdfLaTeX} etwas schwierig. Das Paket \Package{auto-pst-pdf}
-schafft hier jedoch Abhilfe. Wird \hologo{pdfLaTeX} über die zusätzliche Option
-\Option{--shell-escape} respektive \Option{--enable-write18} mit erweiterten
-Schreibrechten aufgerufen, so werden die Abbildungen automatisch im PDF-Format
-erzeugt und eingebunden.
+Nutzung von \Engine{pdfLaTeX} etwas schwierig. Das Paket \Package{auto-pst-pdf}
+schafft hier jedoch Abhilfe. Wird das Textsatzsystem \Engine{pdfLaTeX} über die
+zusätzliche Option \Option{-{}-shell-escape}(\Engine{pdfLaTeX}) beziehungsweise
+\Option{-{}-enable-write18}(\Engine{pdfLaTeX}) mit erweiterten Schreibrechten
+aufgerufen, so werden die Abbildungen automatisch im PDF-Format erzeugt und
+eingebunden.
%
\begin{Hint}
\usepackage{auto-pst-pdf}
@@ -2635,13 +3077,14 @@ erzeugt und eingebunden.
%
Bei einigen Pakete kommt es in der Kombination mit \Package{auto-pst-pdf} zu
kleineren Problemen, die sich jedoch meist relativ leicht beheben lassen. Im
-Handbuch wird die \manualhyperref{sec:tips:floatrow}{gleichzeitige Verwendung}
-von \Package{auto-pst-pdf} in Kombination mit den Paketen \Package{tikz}(pgf),
+Handbuch wird die \tudhyperref{sec:tips:auto-pst-pdf}{gleichzeitige Verwendung}
+von \Package{auto-pst-pdf} in Kombination mit den Paketen \Package{tikz}<pgf>,
\Package{todonotes} sowie \Package{floatrow}~-- bei der Nutzung des Befehls
-\Macro{ffigbox}~-- erklärt. Diese Hinweise sollten Sie gegebenenfalls beachten.
+\Macro{ffigbox}(\Package{floatrow})~-- erklärt. Diese Hinweise sollten Sie
+gegebenenfalls beachten.
-Ähnlich wie zuvor bei der \Package{tikz}(pgf)-Grafik wird die nachfolgende
-\Package{pstricks}-Abbildung auf die Textbreite des Dokumentes skaliert, wobei
+Ähnlich wie zuvor bei der \Package{tikz}<pgf>-Grafik wird die nachfolgende
+\Package{pstricks}"=Abbildung auf die Textbreite des Dokumentes skaliert, wobei
eine Einheit genau \SI{1}{\percent} dieser entspricht. Außerdem werden noch ein
paar weitere Einstellungen gemacht. Dies geschieht mit:
%
@@ -2655,18 +3098,18 @@ paar weitere Einstellungen gemacht. Dies geschieht mit:
}
\end{Hint*}
%
-Die innerhalb einer Gleitumgebung erzeugte \Package{pstricks}-Grafik ist in
+Die innerhalb einer Gleitumgebung erzeugte \Package{pstricks}"=Grafik ist in
\autoref{fig:pstricks} dargestellt.
%
\begin{Hint?}
\begin{figure}
\begin{pspicture}(0,-2)(100,64)
-\newcommand\fnodetext{}
+\newcommand{\fnodetext}{}
\def\fnodetext(#1)#2#3{%
\fnode[framesize=18 8](#1){#2}%
\rput(#1){\parbox{17\psunit}{\centering\hspace{0pt}#3}}%
}
-\newcommand\scriptbox[2][24]{%
+\newcommand{\scriptbox}[2][24]{%
\parbox{#1\psunit}{\scriptsize\centering\hspace{0pt}#2}%
}
\rput(15,10){%
@@ -2725,9 +3168,8 @@ Die innerhalb einer Gleitumgebung erzeugte \Package{pstricks}-Grafik ist in
Damit \enquote{programmierte} Grafiken zum einen das Dokument respektive dessen
Struktur nicht unnötig unübersichtlich machen und zum anderen nur nach einer
Änderung abermals kompiliert werden, um die Kompilierungsdauer möglichst gering
-zu halten, ist es ratsam, diese in separate Dateien auszulagern. Hierfür bieten
-sich die beiden Pakete \Package*{subfiles} und \Package*{standalone} an, welche
-im Handbuch erläutert werden.
+zu halten, können diese in separate Dateien ausgelagert werden. Hierfür bieten
+sich die Pakete \Package{subfiles}'manual' und \Package{standalone}'manual' an.
@@ -2759,8 +3201,9 @@ Paket in der Präambel mitgeteilt werden:
%
Nachdem nun die Grundeinstellungen erfolgt sind, kann ein eigener Stil für eine
gewünschte Programmiersprache definiert werden. Im folgenden Beispiel wird dies
-für ein MATLAB"~Skript demonstriert. Als erstes wird \Macro{lstdefinestyle} ein
-eigener \Package{listings}"~Stil erstellt:
+für ein MATLAB"~Skript demonstriert. Als erstes wird mit dem Befehl
+\Macro{lstdefinestyle}(\Package{listings}) ein eigener \Package{listings}"~Stil
+erstellt:
%
\begin{Hint*}
\lstdefinestyle{matlab}{%
@@ -2783,15 +3226,23 @@ Stil lässt sich anschließend folgendermaßen verwenden.
\end{lstlisting}
\end{Hint}
%
-Soll innerhalb eines Quelltextauszuges ein Teil als \hologo{LaTeX}"~Code
-interpretiert werden, lässt sich mit \PValue{escapechar} ein Escape-Zeichen
-definieren. Mit \Macro{lstnewenvironment} ist es außerdem möglich, eine eigene
-\Package{listings}-Umgebung zu definieren. Das Einbinden externer Quelldateien
-in das Dokument ist über
-\Macro{lstinputlisting}\OParameter{Schlüssel-Wert-Liste}\Parameter{Dateiname}
+Soll innerhalb eines Quelltextauszuges ein Abschnitt nicht ausgegeben sondern
+als \hologo{LaTeX}"~Code interpretiert und ausgeführt werden, lässt sich mit
+\Macro{lstset}[%
+ \PParameter{\PValue{escapechar=\PName{Zeichen}}}%
+](\Package{listings}) ein spezielles Escape-Zeichen definieren. Alle innerhalb
+einer \Package{listings}"=Umgebung zwischen zwei Escape-Zeichen eingefügten
+Angaben in der Form \PName{Zeichen}\PValue{\dots}\PName{Zeichen} werden als
+\hologo{LaTeX}"~Code gelesen und ausgeführt. Außerdem ist es mit dem Befehl
+\Macro{lstnewenvironment}(\Package{listings}) möglich, eine individuelle
+\Package{listings}"=Umgebung zu definieren.
+
+Das Einbinden und Darstellen von externen Quelldateien in ein Dokument ist über
+den Befehl
+\Macro{lstinputlisting}[\LParameter\Parameter{Dateiname}](\Package{listings})
möglich, wobei dabei im optionalen Argument ebenfalls der definierte Stil
angegeben werden sollte. Es folgt die Ausgabe eines kurzen Beispiels mit dem
-zuvor definierten Stil \PValue{matlab}.
+zuvor definierten Stil~\PValue{matlab}.
%
\begin{lstlisting}[style=matlab]
function perfect = isperfect(test_value)
@@ -2814,7 +3265,7 @@ function perfect = isperfect(test_value)
tempsum = 0;
% we check all possible divisors
- for (divisor = 1 : test_value - 1)
+ for (divisor = 1 : test_value - 1)
div_result = test_value / divisor;
if (div_result == floor(div_result))
@@ -2838,12 +3289,12 @@ end
\section{Und ganz zum Schluss \dots}
Mit Sicherheit werden Sie im Laufe der Zeit auf die eine oder andere Frage zu
\hologo{LaTeXe} stoßen, die in diesem Tutorial nicht behandelt wurde. Sollten
-Sie an diesen Punkt gelangen, so empfehle ich als erstes einen Blick in die
-Kapitel \manualhyperref{sec:packages}{Unerlässliche und beachtenswerte Pakete}
-sowie \manualhyperref{sec:tips}{Praktische Tipps \& Tricks} im Handbuch zu
+Sie an diesen Punkt gelangen, so empfehle zunächst einen Blick in die Kapitel
+\tudhyperref{sec:packages}{Benötigte, unterstützte und empfehlenswerte Pakete}
+sowie \tudhyperref{sec:tips}{Praktische Tipps \& Tricks} im Handbuch zu
\TUDScript. Sollte Ihre Frage trotzdem unbeantwortet bleiben, so wäre der
-Besuch eines \hologo{LaTeX}-Forums der nächste Schritt. Für allgemeine Anfragen
-kann ich unter anderem folgende Foren empfehlen:
+Besuch eines \hologo{LaTeX}"=Forums der nächste Schritt. Für allgemeine
+Anfragen kann ich unter anderem folgende Foren empfehlen:
%
\begin{itemize}
\item \hrfn{http://mrunix.de/forums/forumdisplay.php?38-LaTeX-Forum}{mrunix}
@@ -2856,7 +3307,7 @@ Insbesondere alle \TUDScript betreffende Fragen sollten natürlich direkt im
dazugehörigen \Forum gestellt werden.
\begin{Trunk+}
-\printbibliography[heading=bibintoc]\label{sec:bibliography}
+\printbibliography[heading=bibintoc]\label{sec:bibliography}%
\end{Trunk+}
\printbibliography[heading=bibintoc]
@@ -2867,25 +3318,27 @@ dazugehörigen \Forum gestellt werden.
\addsec{Index}
Da das Tutorial etwas umfangreicher ist, wird für alle erläuterten Optionen,
-Umgebungen und Befehle ein Index erstellt.
+Umgebungen und Befehle ein Index erstellt. Bei Elementen, die weder \TUDScript
+noch \KOMAScript zuzuordnen sind, wird das dazugehörige Paket mit angeführt.
\PrintIndex
\FinishTutorial[%
Um das im kopierten Beispiel erstellte Literaturverzeichnis in das Dokument
einbinden zu können, bedarf es dem einmaligen Aufruf von \Application{biber}
- nach dem ersten Durchlauf von \hologo{pdfLaTeX}. Dies erfolgt mit dem Aufruf
- \PValue{biber}~\PName{Dateiname}. Danach ist ein weiteres mal die Verwendung
- von \PValue{pdflatex}~\PName{Dateiname} notwendig.
-
- Für das Erstellen von Abkürzungs- und Symbolverzeichnis sollte das mehrmalige
- Ausführen von \PValue{pdflatex}~\PName{Dateiname} vollkommen ausreichen. In
- diesem Fall werden die Einträge mit \Application{makeindex} sortiert. Soll
- stattdessen \Application{xindy} die Sortierung durchführen, muss beim Laden
- von \Package{glossaries} die entsprechende Paketoption aktiviert werden. Für
- diesen Fall sollte nach der Verwendung von \hologo{pdfLaTeX} der Aufruf des
- Perl"=Skriptes \PValue{makeglossaries}~\PName{Dateiname} erfolgen, was
- allerdings nur mit \Distribution{\hologo{TeX}~Live} ohne weiteres Zutun
- möglich ist. Nutzer von \Distribution{\hologo{MiKTeX}} müssen das Sortieren
- mit \Application{xindy} händisch anstoßen.
+ frühestens nach dem ersten Durchlauf von \Engine{pdfLaTeX}. Dies erfolgt mit
+ dem Aufruf \Path{biber }\PName{Dateiname}. Für das Erzeugen von Abkürzungs-
+ und Symbolverzeichnis ist das Ausführen des Perl"=Skriptes
+ \Path{makeglossaries }\PName{Dateiname} ausreichend. Danach ist ein weiteres
+ mal die Verwendung von \Path{pdflatex }\PName{Dateiname} notwendig, um die
+ Verzeichnisse in das Dokument einzubinden. Gegebenenfalls ist für korrekte
+ Seitenangaben in Abkürzungs- und Symbolverzeichnis ein abermaliges Ausführen
+ des Skriptes notwendig.
+ \Attention{%
+ Nutzer von \Distribution{\hologo{MiKTeX}} müssen für die Verwendung des
+ Perl-Skriptes \File{makeglossaries}(\Package{glossaries}) unter Umständen
+ einen separaten Perl"=Interpreter installieren. In \autoref{sec:glossaries}
+ ist dazu mehr zu finden.%
+ }%
]
+\ListOfToDo
\end{document}