Debian Codegraph @

texmf-dist/source/latex/tudscr/doc/tudscr-introduction.tex

raw
1 \chapter{Einleitung}
2 %
3 Zur Verwendung von \TUDScript~\vTUDScript{} wird sowohl
4 \KOMAScript~\vKOMAScript{} oder später als auch die Hausschrift des
5 \CDs \OpenSans aus dem Paket \Package{opensans} zwingend benötigt. Außerdem
6 müssen durch die genutzte \hologo{LaTeX}"=Distribution weitere Pakete
7 bereitgestellt werden, die unter \autoref{sec:packages:needed} aufgeführt sind.
8 Beim Einsatz einer der Distributionen\index{Distribution}
9 \Distribution{\hologo{TeX}~Live}|?|,
10 \Distribution{Mac\hologo{TeX}}|?| und
11 \Distribution{\hologo{MiKTeX}}|?|
12 in der jeweils aktuellen Versionen sollte dies kein Problem darstellen. Wird
13 jedoch eine Distribution verwendet, die \TUDScript in der Version~\vTUDScript{}
14 nicht zur Verfügung stellt und eine Aktualisierung dieser nicht möglich sein,
15 so sollte \autoref{sec:install:ext} konsultiert werden.
16
17 Das \TUDScript"=Bundle ist hauptsächlich für das Erstellen wissenschaftlicher
18 Texte sowie Arbeiten gedacht und soll \emph{momentan} die ursprünglichen
19 Klassen\footnote{%
20 \Class{tudbook}, \Class{tudbeamer}, \Class{tudletter}, \Class{tudfax},
21 \Class{tudhaus}, \Class{tudform}%
22 } aus dem Vorlagenpaket von Klaus Bergmann nicht ersetzen sondern vielmehr
23 ergänzen.
24 %
25 Eine Umsetzung des \CDs für die \Class{beamer}"=Klasse sowie für Briefe und
26 Geschäftsschreiben auf Basis des \KOMAScript"=Brief"=Klasse \Class{scrlttr2}
27 ist bis jetzt leider noch nicht mit \TUDScript realisiert worden, soll jedoch
28 langfristig erfolgen. Im Bundle \Class{tudmathposter} existieren für die
29 \Class{beamer}"=Klasse allerdings bereits mehrere Stile. Dieses ist im
30 \hrfn{https://github.com/tud-cd/tud-cd/}{%
31 GitHub-Repository~\Distribution*{tud-cd}%
32 } zu finden. Für das Erstellen von Briefen mit den \TUDScript"=Klassen ließe
33 sich das Paket \Package{scrletter} nutzen.
34
35
36
37 \section{Bestandteile und Nutzung des \TUDScript-Bundles}
38 %
39 \ChangedAt{%
40 v2.01:\TUDScript-Bundle auf CTAN veröffentlicht;%
41 v2.02:Installationsroutine der Type1-Schriften angepasst;%
42 v2.04:Installationsskripte verbessert und robuster gestaltet sowie für die
43 beiden portablen Distributionen \Distribution*{\hologo{TeX}~Live~Portable}
44 und \Distribution*{\hologo{MiKTeX}~Portable} erweitert;%
45 v2.06:Schriften im Paket \Package{opensans}, manuelle Installation unnötig;%
46 }
47 %
48 Das \TUDScript-Bundle wird über das \CTAN bereitgestellt und kann durch
49 \hologo{LaTeX}"=Distributionen wie \Distribution{\hologo{TeX}~Live}|?|,
50 \Distribution{Mac\hologo{TeX}}|?| oder auch \Distribution{\hologo{MiKTeX}}|?|
51 genutzt werden. Es stellt zum einen die drei Hauptklassen \Class{tudscrbook},
52 \Class{tudscrreprt} sowie \Class{tudscrartcl} und zum anderen die Klasse
53 \Class{tudscrposter} zur Verfügung, welche in \autoref{sec:mainclasses}
54 beziehungsweise \autoref{sec:poster} vorgestellt werden. Das Paket
55 \Package{tudscrsupervisor}~-- dokumentiert in \autoref{sec:supervisor}~-- kann
56 zusammen mit den \TUDScript"=Klassen genutzt werden, um Aufgabenstellungen,
57 Aushänge oder Gutachten für studentische Arbeiten zu erstellen. Weiterhin
58 existieren auch eigenständige Pakete, welche in \autoref{sec:bundle}
59 beschrieben sind. Für die Verwendung des \TUDScript-Bundles ist~-- neben
60 \KOMAScript{} mindestens in der Version~\vKOMAScript{} sowie den in
61 \autoref{sec:packages:needed} aufgeführten \hologo{LaTeX}"=Paketen~-- seit der
62 Version~v2.06 lediglich die Schrift \OpenSans vonnöten, welche durch das Paket
63 \Package{opensans} zur Verfügung gestellt wird. Eine lokale Nutzerinstallation
64 der Schriften~-- wie in vorherigen Versionen~-- ist nicht notwendig. Lediglich
65 für den Fall, dass gezielt die alten Schriften \Univers und \DIN eingesetzt
66 werden sollen, müssen diese auch installiert sein. Weitere Hinweise dazu sind
67 in \autoref{sec:install:fonts} zu finden. Um diese zu aktivieren, sei auf
68 \Option{tudscrver=2.05} und \Option{cdoldfont} verwiesen.
69
70 \minisec{Anmerkung zu Windows}
71 Für Windows können zwei unterschiedliche \hologo{LaTeX}"=Distributionen genutzt
72 werden. Die Vorteile von \Distribution{\hologo{TeX}~Live}|?| im Vergleich zu
73 \Distribution{\hologo{MiKTeX}}|?| liegen zum einen in der Wartung durch mehrere
74 Autoren sowie der früheren Verfügbarkeit aller Updates über CTAN. Zum anderen
75 werden zusätzlich zu \hologo{LaTeXe} ein \emph{Perl"~Interpreter} sowie
76 \emph{Ghostscript} mitgeliefert, wodurch die Ad"=hoc"=Verwendung einiger
77 Pakete wie beispielsweise \Package{glossaries} vereinfacht beziehungsweise
78 verbessert wird. Für \Distribution{\hologo{MiKTeX}}|?| müssen diese Programme
79 gegebenenfalls manuell installiert werden. Demgegenüber entfällt für
80 \Distribution{\hologo{MiKTeX}}|?| die alljährliche Neuinstallation, welche bei
81 \Distribution{\hologo{TeX}~Live}|?| notwendig ist.
82
83 \minisec{Anmerkung zu Linux und OS~X}
84 Die Installation einer der \hologo{LaTeX}"=Distributionen
85 \Distribution{\hologo{TeX}~Live}|?| oder \Distribution{Mac\hologo{TeX}}|?|
86 sollte direkt über die angebotenen Pakete
87 (\url{https://tug.org/texlive/} oder \url{https://tug.org/mactex/}) und nicht
88 über \Path{apt-get install} erfolgen. Damit wird sichergestellt, dass die
89 aktuelle Variante der jeweiligen Distribution genutzt wird.
90
91
92
93 \section{Zur Verwendung dieses Handbuchs}
94 Sämtliche neu definierten Optionen, Umgebungen und Befehle der Klassen und
95 Pakete des \TUDScript-Bundles werden im Handbuch aufgeführt und beschrieben. Am
96 Ende des Dokumentes befinden sich mehrere Indexe, die das Nachschlagen oder
97 Auffinden von bisher unbekannten Befehlen oder Optionen erleichtern sollen.
98
99 Die im Folgenden beschriebenen Optionen können~-- wie ein Großteil aller
100 Einstellungen für \KOMAScript~-- in der Syntax des \Package{keyval}"=Paketes
101 als Schlüssel"=Wert"=Paare bei der Wahl der Dokumentklasse angegeben werden:
102 \Macro*{documentclass}[%
103 \POParameter{\PName{Schlüssel}\PValue{=}\PName{Wert}}\Parameter{Klasse}%
104 ]
105
106 Des Weiteren eröffnen die \KOMAScript"=Klassen die Möglichkeit der späten
107 Optionenwahl. Damit können Optionen nicht nur direkt beim Laden als sogenannte
108 Klassenoptionen angegeben werden, sondern lassen sich auch noch innerhalb des
109 Dokumentes nach dem Laden der Klasse ändern. Die \KOMAScript"=Klassen sehen
110 hierfür zwei Befehle vor. Mit
111 \Macro{KOMAoptions}[\Parameter{Optionenliste}](\Package{koma-script})'none'
112 lassen sich beliebig viele Schlüsseln jeweils genau einen Wert zuweisen,
113 \Macro{KOMAoption}[%
114 \Parameter{Option}\Parameter{Werteliste}%
115 ](\Package{koma-script})'none'
116 erlaubt das gleichzeitige Setzen mehrere Werte für genau einen Schlüssel.
117 Für die von \TUDScript \emph{zusätzlich} zur Verfügung gestellten Optionen
118 werden äquivalent dazu die Befehle \Macro{TUDoptions}[\Parameter{Optionenliste}]
119 und \Macro{TUDoption}[\Parameter{Option}\Parameter{Werteliste}] definiert.
120 Damit kann das Verhalten von Optionen im Dokument~-- innerhalb einer Gruppe
121 auch lokal~-- geändert werden.
122
123 Die Voreinstellung jeder Option wird mit \enquote{Standardwert:\,\PName{Wert}}
124 bei deren Beschreibung angeführt. Einige dieser Voreinstellungen sind nicht
125 immer gleich sondern werden in Abhängigkeit der genutzten Benutzereinstellungen
126 und Optionen gesetzt. Diese bedingten Voreinstellungen werden durch
127 \enquote{%
128 Standardwert:\,\PName{Wert}%
129 \PValue{\,|\,}Bedingung:\,\PName{bedingter~Wert}%
130 }
131 angegeben. Wird ein Schlüssel durch den Benutzer \emph{ohne} eine Wertzuweisung
132 genutzt, so wird~-- falls vorhanden~-- ein vordefinierter Säumniswert gesetzt,
133 welcher in der Beschreibung aller Optionen durch die~\PValue{\emph{kursive}}
134 Schreibweise innerhalb der Werteliste gekennzeichnet ist. In den meisten Fällen
135 ist der Säumniswert eines Schlüssels \PValue{true}, er entspricht folglich der
136 Angabe \PName{Schlüssel}\PValue{=true}. Mit der expliziten Wertzuweisung eines
137 Schlüssels durch den Benutzer werden sowohl einfache als auch bedingte
138 Voreinstellungen immer überschrieben. Die neben den Optionen neu eingeführten
139 Befehle und Umgebungen der Klassen werden im gleichen Stil erläutert.
140
141
142
143 \section{Schnelleinstieg}
144 Das Handbuch gliedert sich in drei Teile. In \autoref{part:main} ist die
145 Dokumentation von \TUDScript zu finden. Hier werden alle neuen Optionen,
146 Umgebungen und Befehle, die über die Funktionalität von \KOMAScript{}
147 hinausgehen, erläutert. \autoref{part:additional} enthält zum einen einfache
148 Minimalbeispiele, um den prinzipiellen Umgang und die Funktionalitäten von
149 \TUDScript zu demonstrieren. Zum anderen werden hier auch ausführliche und
150 dokumentierte Tutorials vor allem für \hologo{LaTeX}"=Neulinge angeboten.
151 Insbesondere das Tutorial \Tutorial{treatise} ist mehr als einen Blick wert,
152 wenn eine wissenschaftliche Arbeit mit \hologo{LaTeXe} verfasst werden soll.
153 Abschließend werden verschiedenste Pakete vorgestellt, die nicht speziell für
154 das \TUDScript-Bundle selber sondern auch für andere \hologo{LaTeXe}"=Klassen
155 verwendet werden können und demzufolge für jeden Anwender interessant sein
156 könnten. Außerdem werden hier einige Tipps \& Tricks beim Umgang mit
157 \hologo{LaTeX} beschrieben, um kleinere oder größere Probleme zu lösen.
158
159 Die Klassen \Class{tudscrbook}, \Class{tudscrreprt} und \Class{tudscrartcl}
160 sind Wrapper"=Klassen der bekannten \KOMAScript-Klassen \Class{scrbook},
161 \Class{scrreprt} sowie \Class{scrartcl} und können einfach anstelle deren
162 verwendet werden. Auf diesen basierende Dokumente können durch das Umstellen
163 der Dokumentklasse einfach in das \TUDCD überführt werden. Bei Fragestellungen
164 bezüglich Layout, Schriften oder ähnlichem ist in jedem Fall ein weiterer Blick
165 in das hier vorliegende Handbuch empfehlenswert.