Debian Codegraph @

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

raw
1 \setchapterpreamble{%
2 \tudhyperdef'{sec:bundle}%
3 \begin{abstract}
4 Zusätzlich zu den bisher im Anwenderhandbuch vorgestellten Klassen und
5 Paketen werden im \TUDScript-Bundle weitere Paket bereitgestellt. Diese
6 sind nicht zwingend an die Verwendung einer der \TUDScript-Klassen
7 angewiesen sondern können prinzipiell mit jeder \hologo{LaTeXe}"=Klasse
8 genutzt werden.%
9 \end{abstract}
10 }
11 \chapter{Zusätzliche Pakete im \TUDScript-Bundle}
12 %
13 \section{Das Paket \Package{tudscrcolor} -- Farben im \CD}%
14 \index{Farben|(}%
15 \index{Layout!Farben|?(}%
16 %
17 \begin{Bundle*}{\Package{tudscrcolor}}
18 Zur Verwendung der Farben des \CDs wird das Paket \Package{tudscrcolor}
19 genutzt. Falls dieses nicht in der Präambel geladen wird~-- um beispielsweise
20 zusätzliche Optionen aufzurufen~-- binden die \TUDScript"=Klassen dieses
21 automatisch ein.
22
23 Für das \CD sind mehrere Farben vorgesehen. Die prägnanteste aller ist die
24 Hausfarbe \Color{HKS41}, danach folgen die Farben für Auszeichnungen der ersten
25 (\Color{HKS44}) und der zweiten Kategorie (\Color{HKS36}, \Color{HKS33},
26 \Color{HKS57}, \Color{HKS65}) sowie eine Ausnahmefarbe (\Color{HKS07}).
27 Diese Farben dürfen sowohl in ihrer Grundform als auch in helleren Tönen mit
28 einer Abstufung in 10\,\%"~Schritten verwendet werden. Das ohnehin verwendete
29 Paket \Package{xcolor} stellt genau diese Funktionalität zur Verfügung. Jede
30 der Farben kann sowohl mit \Color*{HKS\PName{Zahl}}() als auch über ein
31 Pseudonym \Color*{cd\PName{Farbe}}() genutzt werden.
32 %
33 \begin{Example*}
34 Die Grundfarbe \Color{HKS44} soll in der auf 20\% reduzierten, helleren
35 Abstufung genutzt werden. Innerhalb eines Befehls, der als Argument eine
36 gültige Farbe erwartet, muss lediglich \PValue{HKS44!20} angegeben werden.
37 Dies wird hier exemplarisch mit der folgenden \colorbox{HKS44!20}{%
38 Box \Macro{colorbox}[%
39 \PParameter{HKS44!20}\PParameter{Box}%
40 ](\Package{xcolor})'none'%
41 }
42 demonstriert.
43 \end{Example*}
44 %
45 Bei der farbigen Gestaltung des \CDs (\Option{cd=color}) ist der Hintergrund
46 von Umschlagseite, Titel sowie Teilen in \Color{HKS41} und die Schrift auf
47 selbigen in \Color{HKS41}[!30] gehalten. Der Hintergrund von Kapitelseiten
48 erscheint in \Color{HKS41}[!10], die Schrift in \Color{HKS41}. Bei geringerem
49 Farbeinsatz werden lediglich die Schriften der Gliederungsseiten auf
50 \Color{HKS41} gesetzt.
51
52 Sollen bestimmte Optionen an das Paket \Package{xcolor} weitergereicht werden,
53 gibt es dafür zwei Möglichkeiten. Diese kann entweder vor dem Laden der Klasse
54 direkt an \Package{xcolor} übergeben werden%
55 \footnote{%
56 \Macro{PassOptionsToPackage}[\Parameter{Paketoptionen}\PParameter{xcolor}]
57 vor dem Laden der genutzten Dokumentklasse mit
58 \Macro*{documentclass}[\OParameter{Klassenoptionen}\Parameter{Klasse}]%
59 }
60 oder es wird \Package{tudscrcolor} mit der entsprechenden Option geladen.%
61 \footnote{%
62 \Macro*{usepackage}[\OParameter{Paketoptionen}\PParameter{tudscrcolor}];
63 \Package{tudscrcolor} reicht \PName{Paketoptionen} an \Package{xcolor} weiter%
64 }
65 \newcommand*\cdcolorcalc{}
66 \newcommand*\cdcolorname{}
67 \newcommand*\cdcolorvalue{}
68 \newcommand*\cdcolortext{}
69 \newcommand*\cdcolor[2][0]{%
70 \noindent%
71 \begin{tikzpicture}[%
72 every node/.style={%
73 rectangle, minimum height=.1\linewidth, minimum width=7em%
74 }%
75 ]%
76 \def\cdcolorcalc##1##2{%
77 \pgfmathparse{100-##1*10}%
78 \xdef\cdcolorname{HKS##2!\pgfmathresult}%
79 \xdef\cdcolorvalue{\pgfmathresult}%
80 \pgfmathparse{10+##1*10}%
81 }%
82 \foreach \x in {0,1,...,9}{%
83 \cdcolorcalc{\x}{#2}%
84 \ifnum\x<#1%
85 \def\cdcolortext{white}%
86 \else%
87 \def\cdcolortext{black}%
88 \fi%
89 \node [fill=\cdcolorname,rotate=90] at (.\x\linewidth,0)%
90 {\textcolor{\cdcolortext}{HKS#2!\pgfmathprintnumber\cdcolorvalue}};%
91 }%
92 \end{tikzpicture}%
93 }
94
95 \subsection{Generelle Farbdefinitionen}
96 \minisec{Primäre Hausfarbe}
97 \begin{Declaration}{\Color{HKS41}[cddarkblue]}
98 \printdeclarationlist%
99 \cdcolor[6]{41}
100 \end{Declaration}
101
102 \minisec{Sekundäre Hausfarbe (Geschäftsausstattung)}
103 \begin{Declaration}{\Color{HKS92}[cdgray]}
104 \printdeclarationlist%
105 \cdcolor[4]{92}
106 \end{Declaration}
107
108 \minisec{Auszeichnungsfarbe 1.\,Kategorie}
109 \begin{Declaration}{\Color{HKS44}[cdblue]}
110 \printdeclarationlist%
111 \cdcolor[4]{44}
112 \end{Declaration}
113
114 \minisec{Auszeichnungsfarbe 2.\,Kategorie}
115 \begin{Declaration}{\Color{HKS36}[cdindigo]}
116 \begin{Declaration}{\Color{HKS33}[cdpurple]}
117 \begin{Declaration}{\Color{HKS57}[cddarkgreen]}
118 \begin{Declaration}{\Color{HKS65}[cdgreen]}
119 \printdeclarationlist%
120 \cdcolor[4]{36}\vskip\medskipamount
121 \cdcolor[4]{33}\vskip\medskipamount
122 \cdcolor[2]{57}\vskip\medskipamount
123 \cdcolor{65}
124 \end{Declaration}
125 \end{Declaration}
126 \end{Declaration}
127 \end{Declaration}
128
129 \minisec{Ausnahmefarbe}
130 \begin{Declaration}{\Color{HKS07}[cdorange]}
131 \printdeclarationlist%
132 \cdcolor{07}
133 \end{Declaration}
134
135
136 \subsection{Zusätzliche Farbdefinitionen}
137 Das Paket \Package{tudscrcolor} definiert im Normalfall lediglich die zuvor
138 beschriebenen Grundfarben \Color{HKS41}, \Color{HKS92}, \Color{HKS44},
139 \Color{HKS36}, \Color{HKS33}, \Color{HKS57}, \Color{HKS65} sowie \Color{HKS07}.
140 Alle anderen farblichen Abstufungen können mit den beschrieben Möglichkeiten
141 des Paketes \Package{xcolor} generiert werden.
142
143 \begin{Declaration}{\Option{oldcolors}}
144 \printdeclarationlist%
145 %
146 In den letzten Jahren sind viele verschiedene Klassen und Pakete für das \TUDCD
147 entstanden. Innerhalb dieser existieren abweichende Farbdefinitionen. Um eine
148 Migration von den benannten Klassen und Paketen auf \TUDScript zu ermöglichen,
149 existiert die Paketoption \Option{oldcolors}. Wird diese genutzt, so werden
150 zusätzliche Farben nach dem Schema \Color*{HKS41K\PName{Zahl}}() und
151 \Color*{HKS41-\PName{Zahl}}() definiert, wobei der hinten angestellte
152 Zahlenwert aus der 10er"~Reihe kommen muss.
153 \end{Declaration}
154
155
156
157 \subsection{Umstellung des Farbmodells}
158 \index{Farben!Farbmodell}%
159 %
160 Normalerweise verwendet \Package{tudscrcolor} das CMYK"=Farbmodell. Außerdem
161 wird weiterhin noch der RGB"=Farbraum unterstützt. Eine Umschaltung des
162 Farbmodells ist beispielsweise für gewisse Funktionen des Paketes
163 \Package{tikz} notwendig.
164
165 \begin{Declaration}{\Option{RGB}}
166 \printdeclarationlist%
167 %
168 Mit dieser Option werden bereits beim Laden des Paketes \Package{tudscrcolor}
169 die Farben nicht nach dem CMYK"=Farbmodell sondern im RGB"=Farbraum global
170 definiert.
171 \end{Declaration}
172
173 \begin{Declaration}{\Macro{setcdcolors}[\Parameter{Farbmodell}]}
174 \printdeclarationlist%
175 %
176 Mit diesem Befehl kann innerhalb des Dokumentes das verwendete Farbmodell
177 angepasst werden. Damit ist es möglich, lokal innerhalb einer Umgebung den
178 Farbmodus zu ändern und so nur in bestimmten Situationen beispielsweise aus dem
179 CMYK"=Farbmodell in den RGB"=Farbraum zu wechseln. Unterstützte Werte für
180 \PName{Farbmodell} sind \PValue{CMYK} und \PValue{RGB} beziehungsweise
181 \PValue{rgb}.
182 \end{Declaration}
183
184 \smallskip\noindent
185 \Attention{%
186 Die Darstellung der Farben kann im jeweiligen Farbmodus
187 (\PValue{CMYK} oder \PValue{RGB}) je nach verwendeter Bildschirm-, Drucker-
188 und Softwarekonfiguration verschieden ausfallen. Die Farbwerte entstammen dem
189 Handbuch zum \CD und sind lediglich Näherungswerte. Abweichungen vom
190 gedruckten HKS"~Farbregister und selbst ermittelten Werten sind technisch
191 nicht zu vermeiden.
192 }%
193 \index{Farben|)}%
194 \index{Layout!Farben|?)}%
195 \end{Bundle*}
196
197
198
199 \section{Das Paket \Package{tudscrfonts} -- Schriften im \CD}
200 \begin{Bundle*}[v2.02]{\Package{tudscrfonts}}
201 \printchangedatlist%
202 %
203 Dieses Paket stellt die Schriften des \CDs für \hologo{LaTeXe}"=Klassen bereit,
204 welche \emph{nicht} zum \TUDScript-Bundle gehören. Das Paket unterstützt einen
205 Großteil der normalerweise für die \TUDScript-Klassen bereitgestellten Optionen
206 und Befehle für die Schriftauswahl. Um Dopplungen in der Dokumentation zu
207 vermeiden, wird an dieser Stelle auf eine abermalige Erläuterung der im Paket
208 \Package{tudscrfonts} verfügbaren Optionen und Befehle verzichtet. Diese werden
209 im Folgenden lediglich noch einmal genannt, die dazugehörigen Erläuterungen
210 sind in \fullref{sec:fonts} zu finden.
211
212 Die nutzbaren Paketoptionen sind für den Fließtext \Option{cdfont}~-- ohne die
213 Einstellungsmöglichkeiten für den Querbalken des \CDs (\Option{cdhead})~-- und
214 für die mathematischen Schriften \Option{cdmath} sowie \Option{slantedgreek}.
215 Für die Auswahl der Schreibmaschinenschriften ist \Option{ttfont} verfügbar.
216 Weiterhin wird die Option \Option{relspacing} bereitgestellt. Alle genannten
217 Optionen können entweder direkt als Klassenoption oder als Paketoptionen im
218 optionalen Argument von
219 \Macro*{usepackage}[\OParameter{Paketoptionen}\PParameter{tudscrfonts}]
220 angegeben werden. Zusätzlich ist nach dem Laden des Paketes die Optionenwahl
221 mit \Macro{TUDoption} respektive \Macro{TUDoptions} möglich.
222
223 Die in \autoref{sec:fonts} beschriebenen Textschalter und "~kommandos zur
224 expliziten Auswahl einzelner Schnitte der Hausschrift des \CDs sowie die
225 Befehle für griechische Buchstaben werden ebenso bereitgestellt.
226 \ChangedAt{v2.06:\OpenSans als neue Hausschrift standardmäßig aktiviert}
227 Soll nicht \OpenSans sondern die alten Schriftfamilien \Univers und \DIN
228 genutzt werden, ist eine Installation dieser notwendig. Hinweise hierzu sind
229 unter \autoref{sec:install:fonts} zu finden. Um diese zu aktivieren, sei auf
230 \Option{tudscrver=2.05} und \Option{cdoldfont} verwiesen.
231
232 \ChangedAt{%
233 v2.04:Unterstützung der Klassen \Class{tudposter} und \Class{tudmathposter};%
234 v2.05:Neues Schriftpaket \Package{fix-tudscrfonts} für Dokumentklassen
235 im \CD der \TnUD, welche nicht zu \TUDScript gehören%
236 }
237 Ursprünglich war das Paket \Package{tudscrfonts} für die Verwendung zusammen
238 mit einer der Klassen \Class{tudbook}, \Class{tudbeamer}, \Class{tudletter},
239 \Class{tudfax}, \Class{tudhaus}, \Class{tudform} und seit der Version~v2.04
240 auch \Class{tudmathposter} sowie \Class{tudposter} vorgesehen. Allerdings
241 traten bei der Verwendung des Paketes mit einer dieser Klassen einige kleinere
242 Unzulänglichkeiten auf. Deshalb wird seit der Version~v2.05 empfohlen, für
243 diese Klassen das Paket \Package{fix-tudscrfonts} zu verwenden.
244 \end{Bundle*}
245
246
247
248 \section{Das Paket \Package{fix-tudscrfonts} -- Schriftkompatibilität}
249 \begin{Bundle*}[v2.05]{\Package{fix-tudscrfonts}}
250 \printchangedatlist%
251 %
252 Dieses Paket ist für die alleinige Verwendung mit einer der folgenden Klassen
253 vorgesehen:
254 \begin{itemize}
255 \item \Class{tudbook}
256 \item \Class{tudbeamer}
257 \item \Class{tudletter}
258 \item \Class{tudfax}
259 \item \Class{tudhaus}
260 \item \Class{tudform}
261 \item \Class{tudmathposter}
262 \item \Class{tudposter}
263 \end{itemize}
264 %
265 \ChangedAt{v2.06:\OpenSans als neue Hausschrift standardmäßig aktiviert}
266 Für das \TUDCD wird vom \TUDScript-Bundle standardmäßig \OpenSans als
267 Schriftfamilie verwendet. Diese unterscheidet sich stark von den ursprünglich
268 durch die gerade genannten Klassen genutzten Schriftfamilien. Wird nun das
269 Paket \Package{fix-tudscrfonts} zusammen mit einer dieser Klassen verwendet,
270 hat dies den Vorteil, dass auch bei diesen die aktuelle Hausschrift verwendet
271 wird und der stark verbesserte Mathematiksatz zum Tragen kommen.
272 \Attention{%
273 In diesem Fall kann sich das Ausgabeergebnis im Vergleich zu der Varianten
274 mit den alten Schriften ändern. Zum Setzen von Dokumenten mit den alten
275 Schriftfamilien \Univers und \DIN müssen diese installiert werden. Hinweise
276 hierzu sind unter \autoref{sec:install:fonts} zu finden. Um diese zu
277 aktivieren, sei auf \Option{tudscrver=2.05} und \Option{cdoldfont} verwiesen.
278 }%
279
280 Um alle notwendigen Einstellung korrekt und ohne unnötige Warnungen vornehmen
281 zu können, muss das Paket \Package{fix-tudscrfonts} bereits \emph{vor} der
282 Dokumentklasse geladen werden, wobei die gleichen Paketoptionen wie für das
283 Paket \Package{tudscrfonts} verwendet werden können:
284 %
285 \begin{Code}[escapechar=§]
286 \RequirePackage§\OParameter{Paketoptionen}§{fix-tudscrfonts}
287 \documentclass§\OParameter{Klassenoptionen}\Parameter{Dokumentklasse}§
288 §\dots§
289 \begin{document}
290 §\dots§
291 \end{document}
292 \end{Code}
293 %
294 Dabei wird spätestens zum Ende der Präambel das Paket \Package{tudscrfonts}
295 geladen. Alternativ kann dies auch durch den Benutzer in der Dokumentpräambel
296 erfolgen.
297 \end{Bundle*}
298
299
300 \section{Das Paket \Package{mathswap}}
301 \index{Mathematiksatz|(}%
302 \index{Zifferngruppierung|(}%
303 %
304 \begin{Bundle*}{\Package{mathswap}}
305 Die Verwendung von Dezimal- und Tausendertrennzeichen im mathematischen Satz
306 sind regional sehr unterschiedlich. In den meisten englischsprachigen Ländern
307 wird der Punkt als Dezimaltrennzeichen und das Komma zur Zifferngruppierung
308 verwendet, im restlichen Europa wird dies genau entgegengesetzt praktiziert.
309 Dieses Paket soll dazu dienen, beliebige formatierte Zahlen in ihrer Ausgabe
310 anzupassen. Dafür werden die Zeichen Punkt (\ .\ ) und Komma (\ ,\ ) als
311 aktive Zeichen im Mathematikmodus definiert.
312
313 Ähnliche Funktionalitäten werden bereits durch die Pakete \Package{icomma} und
314 \Package{ziffer} bereitgestellt. Bei \Package{icomma} muss jedoch beim
315 Verfassen des Dokumentes durch den Autor beachtet werden, ob das verwendete
316 Komma einem Dezimaltrennzeichen entspricht ($t=1,\!2$) oder einem normalen
317 Komma im Mathematiksatz ($z=f(x,y)$), wo ein gewisser Abstand nach dem Komma
318 durchaus gewünscht ist. Das Paket \Package{ziffer} liefert dafür die gewünschte
319 Funktionalität,%
320 \footnote{kein Leerraum nach Komma, wenn direkt danach eine Ziffer folgt}
321 ist allerdings etwas unflexibel, was den Umgang mit den Trennzeichen anbelangt.
322 Als Alternative zu diesem Paket kann außerdem \Package{ionumbers} verwendet
323 werden.
324
325 Das Paket \Package{mathswap} sorgt dafür, dass Trennzeichen direkt vor einer
326 Ziffer erkannt und nach bestimmten Vorgaben ersetzt werden. Sollte sich jedoch
327 zwischen Trennzeichen und Ziffer Leerraum befinden, wird dieser als solcher
328 auch gesetzt. Für ein Beispiel zur Verwendung des Paketes sei auf das Tutorial
329 \Tutorial{mathswap} in \autoref{sec:tut} hingewiesen.
330
331 \begin{Declaration}{\Macro{commaswap}[\Parameter{Trennzeichen}]}
332 \begin{Declaration}{\Macro{dotswap}[\Parameter{Trennzeichen}]}
333 \printdeclarationlist%
334 %
335 Die beiden Befehle \Macro{commaswap} und \Macro{dotswap} sind die zentrale
336 Benutzerschnittstelle des Paketes. Das Makro \Macro{commaswap} definiert das
337 Trennzeichen oder den Inhalt, wodurch ein Komma ersetzt werden soll, auf
338 welches direkt danach eine Ziffer folgt. Normalerweise setzt \hologo{LaTeX}
339 nach einem Komma im mathematischen Satz zusätzlich einen horizontalen Abstand.
340 Bei der Ersetzung durch \Macro{commaswap} entfällt dieser. Die Voreinstellung
341 für \Macro{commaswap} ist deshalb auf ein Komma (,) gesetzt. Mit dem Makro
342 \Macro{dotswap} kann definiert werden, wodurch der Punkt im mathematischen
343 Satz ersetzt werden soll, wenn auf diesen direkt anschließend eine Ziffer
344 folgt. Da der Punkt im deutschsprachigem Raum zur Gruppierung von Ziffern
345 genutzt wird, ist hierfür standardmäßig ein halbes geschütztes Leerzeichen
346 definiert (\Macro*{,}).
347 \end{Declaration}
348 \end{Declaration}
349
350 \begin{Declaration}[v2.02]{\Macro{mathswapon}}
351 \begin{Declaration}[v2.02]{\Macro{mathswapoff}}
352 \printdeclarationlist%
353 %
354 \ChangedAt*{v2.02:Funktionalität im Dokument umschaltbar}%
355 Die Funktionalität von \Package{mathswap} kann innerhalb des Dokumentes mit
356 diesen beiden Befehlen an- und abgeschaltet werden. Beim Laden des Paketes ist
357 es standardmäßig aktiviert.
358 \end{Declaration}
359 \end{Declaration}
360 \index{Mathematiksatz|)}%
361 \index{Zifferngruppierung|)}%
362 \end{Bundle*}
363
364
365
366 \section{Das Paket \Package{twocolfix}}
367 \begin{Bundle*}{\Package{twocolfix}}
368 \index{Satzspiegel!zweispaltig|?}%
369 %
370 Der \hologo{LaTeXe}"=Kernel enthält einen Fehler, der Kapitelüberschriften im
371 zweispaltigen Layout höher setzt, als im einspaltigen. Der
372 \hrfn{http://www.latex-project.org/cgi-bin/ltxbugs2html?pr=latex/3126}{Fehler}
373 ist zwar schon länger bekannt, allerdings bisher noch nicht in den
374 \hologo{LaTeXe}"=Kernel übernommen worden. Das Paket \Package{twocolfix} behebt
375 das Problem. Eine Integration dieses Bugfixes in \KOMAScript{} wurde bereits
376 bei Markus Kohm angefragt, jedoch von ihm bis jetzt
377 \hrfn{http://www.komascript.de/node/1681}{nicht weiter verfolgt}.
378 \end{Bundle*}
379
380
381 \addsec*{Zukünftige Arbeiten}
382 Diese Dinge sollen langfristig in das \TUDScript-Bundle eingearbeitet werden:
383
384 %\chapter{Das Paket \Package{tudscrletter} -- Briefe im \CD}
385 %\begin{Bundle*}{\Package{tudscrletter}}
386 \ToDo[imp]{%
387 Paket \Package*{tudscrletter} für Briefe im \CD,
388 \url{https://komascript.de/node/2200}%
389 }[v2.07]
390 Es soll das Paket \Package*{tudscrletter}<tudscr> für Briefe im \TUDCD
391 entstehen. Auch Klassen für Fax und Hausmitteilungen sollen dabei abfallen.
392 %\end{Bundle*}
393
394 %\chapter{Das Paket \Package{tudscrbeamer} -- Präsentationen im \CD}
395 %\begin{Bundle*}{\Package{tudscrbeamer}}
396 \ToDo[imp]{Paket \Package*{tudscrbeamer} für Präsentationen im \CD}[v2.08]
397 Mit \Package*{tudscrbeamer}<tudscr> soll ein Paket entstehen, mit dem sich
398 \hologo{LaTeX}"=Beamer"=Präsentationen im Stil des \TUDCDs mit den
399 Einstellungsmöglichkeiten von \TUDScript erstellen lassen. Aktuell können
400 hierfür die Pakete aus dem \hrfn{https://github.com/tud-cd/tud-cd/}{%
401 GitHub-Repository~\Distribution*{tud-cd}%
402 } genutzt werden.
403 %\end{Bundle*}
404
405 %\chapter{Das Paket \Package{tudscrlayout} -- Seitenstil und Satzspiegel im \CD}
406 %\begin{Bundle*}{\Package{tudscrlayout}}
407 \ToDo[imp]{%
408 Paket \Package*{tudscrlayout} \url{https://github.com/tud-cd/tud-cd/issues/6}
409 für Satzspiegel, evtl. auch für die Klasse über \Option*{cdgeometry=forced}
410 }[v2.09]
411 Außerdem ist ein Paket \Package*{tudscrlayout}<tudscr> vorstellbar, welches
412 den durch das \CD vorgegebene Satzspiegel aktiviert ohne den Seitenstil selbst
413 zu verwenden, um beispielsweise bereits mit dem Kopf der \TnUD bedrucktes
414 Papier nutzen zu können. Ebenfalls wäre es denkbar, für andere Klassen die
415 \PageStyle{tudheadings}"=Seitenstile verfügbar zu machen ohne dabei den
416 Satzspiegel des \CDs umzusetzen. Dies hat jedoch nur geringe Priorität.
417 %\end{Bundle*}