Debian Codegraph @

texmf-dist/source/latex/tudscr/doc/tutorials/treatise.tex

raw
1 \RequirePackage{fix-cm}
2 \documentclass[%
3 english,ngerman,%
4 cdgeometry=no,DIV=12,%
5 automark,%
6 listof=toc,%
7 ]{tudscrartcl}
8 \iftutex
9 \usepackage{fontspec}
10 \else
11 \usepackage[T1]{fontenc}
12 \usepackage[ngerman=ngerman-x-latest]{hyphsubst}
13 \fi
14 \usepackage{babel}
15 \usepackage[babel]{microtype}
16
17 \usepackage{tudscrmanual}
18 \lstset{%
19 inputencoding=utf8,extendedchars=true,
20 literate=%
21 {ä}{{\"a}}1 {ö}{{\"o}}1 {ü}{{\"u}}1
22 {Ä}{{\"A}}1 {Ö}{{\"O}}1 {Ü}{{\"U}}1
23 {ß}{{\ss}}1 {~}{{\textasciitilde}}1
24 {»}{{\guillemetright}}1 {«}{{\guillemetleft}}1
25 }
26 \lstset{escapechar=§}
27
28 \usepackage{lmodern}
29 \TUDoptions{cd=false,cdfont=false,cdtitle=true}
30 \KOMAoptions{headings=normal}
31
32 \usepackage{tudscrsupervisor}
33 \usepackage{array}
34 \usepackage{tabu}
35 \usepackage{tabularx}
36 \usepackage{tabulary}
37 \usepackage{booktabs}
38 \usepackage{siunitx}
39 \sisetup{%
40 locale = DE,%
41 input-decimal-markers={,},%
42 input-ignore={.},%
43 group-separator={\,},%
44 group-minimum-digits=3%
45 }
46 \usepackage{xfrac}
47 \AfterPackage*{hyperref}{%
48 \usepackage[%
49 automake,%
50 xindy={language=german-din},%
51 acronym,%
52 symbols,%
53 nomain,%
54 translate=babel,%
55 nogroupskip,%
56 nostyles,%
57 ]{glossaries}
58 \renewcommand*{\glsglossarymark}[1]{}
59 \newignoredglossary{abbreviation}
60 \newcommand*\newabbreviation[4][]{%
61 \newacronym[type=abbreviation,#1]{#2}{#3}{#4}%
62 }%
63 \makeglossaries
64 }
65 \usepackage{csquotes}
66 \usepackage[backend=biber,style=alphabetic]{biblatex}
67 \DefineBibliographyStrings{ngerman}{urlseen = {Am:}}
68 \addbibresource{\jobname.bib}
69
70 \begin{filecontents}{\jobname.bib}
71 @book{talbot2012,
72 author = {Nicola L. C. Talbot},
73 title = {{\LaTeX} for Complete Novices},
74 publisher = {Dickimaw Books},
75 series = {Dickimaw {\LaTeX} Series},
76 volume = {1},
77 isbn = {978-1-909440-00-5},
78 address = {Norfolk, UK},
79 year = {2012},
80 url = {http://www.dickimaw-books.com/latex/novices/},
81 urldate = {2014-12-01},
82 }
83 @book{talbot2013,
84 author = {Nicola L. C. Talbot},
85 title = {Using {\LaTeX} to Write a PhD Thesis},
86 publisher = {Dickimaw Books},
87 series = {Dickimaw {\LaTeX} Series},
88 volume = {2},
89 isbn = {978-1-909440-02-9},
90 address = {Norfolk, UK},
91 year = {2013},
92 url = {http://www.dickimaw-books.com/latex/thesis/},
93 urldate = {2014-12-01},
94 }
95 @online{reichert2012,
96 author = {Reichert, Axel and Voß, Herbert},
97 title = {\LaTeX~-- Satz von Tabellen},
98 organization = {Freie Universität Berlin},
99 date = {2012-01-12},
100 url = {http://userpage.fu-berlin.de/latex/Materialien/tabsatz.pdf},
101 urldate = {2014-12-01}
102 }
103 @article{neubauer1996,
104 author = {Marion Neubauer},
105 title = {Feinheiten bei wissenschaftlichen Publikationen~--
106 Mikrotypographie"=Regeln, Teil~I},
107 journaltitle = {Die \TeX{}nische Komödie},
108 year = {1996},
109 month = {2},
110 volume = {4},
111 pages = {23-40},
112 url = {http://www.dante.de/tex/Dokumente/dtk-neubauer.pdf},
113 urldate = {2014-12-01},
114 }
115 @article{neubauer1997,
116 author = {Marion Neubauer},
117 title = {Feinheiten bei wissenschaftlichen Publikationen~--
118 Mikrotypographie"=Regeln, Teil~II},
119 journaltitle = {Die \TeX{}nische Komödie},
120 year = {1997},
121 month = {5},
122 volume = {1},
123 pages = {25--44},
124 url = {http://www.dante.de/tex/Dokumente/dtk-neubauer.pdf},
125 urldate = {2014-12-01},
126 }
127 @online{struckmann2007,
128 author = {Struckmann, Werner},
129 title = {Einige typographische Grundregeln und ihre Umsetzung in \LaTeX},
130 date = {2007-09-03},
131 url = {http://www2.informatik.hu-berlin.de/sv/lehre/typographie.pdf},
132 urldate = {2014-12-01}
133 }
134 @online{bier2009,
135 author = {Bier, Christoph},
136 title = {typokurz~-- Einige wichtige typografische Regeln},
137 date = {2009-05-21},
138 url = {http://zvisionwelt.wordpress.com/downloads/#typokurz},
139 urldate = {2014-12-01}
140 }
141 \end{filecontents}
142
143 \usepackage{enumitem}
144
145 \usepackage{caption}
146 \DeclareCaptionSubType[alph]{figure}
147 \DeclareCaptionSubType[alph]{table}
148 \usepackage{floatrow}
149 \renewcommand{\floatpagefraction}{0.7}
150
151 \usepackage{tikz}
152 \usetikzlibrary{chains}
153 \usetikzlibrary{decorations.markings}
154 \tikzset{on grid}
155
156 % TODO pst-pdf funktioniert momentan nicht mit hyperref
157 % github.com/rolfn/pst-pdf/issues/6
158 % --> luapstricks ?
159 \usepackage{pstricks,pst-node}
160
161 \makeatletter
162 \newcommand*\pcolumnfuzz[1]{\pretocmd\@endpbox{\hfuzz=#1}{}{}}
163 \makeatother
164
165 \usepackage{bookmark}
166
167 \begin{document}
168 \subject{Tutorial für \hologo{LaTeX}}
169 \title{%
170 Ein Anwenderleitfaden für das Erstellen einer wissenschaftlichen Abhandlung%
171 }
172 \author{Falk Hanisch\TUDScriptContactTitle}
173 \date{2017-03-29}
174
175 \makeatletter
176 \begingroup%
177 \def\and{, }%
178 \let\thanks\@gobble%
179 \let\footnote\@gobble%
180 \let\emailaddress\@gobble%
181 \hypersetup{%
182 pdfauthor = {\@author},%
183 pdftitle = {\@title},%
184 pdfsubject = {Tutorial für LaTeX},%
185 pdfkeywords = {LaTeX, \TUDScript, Tutorial, Anwenderleitfaden},%
186 }%
187 \endgroup%
188 \makeatother
189
190 \StartTutorial[%
191 Der Versuch, ein allumfassendes Tutorial für eine wissenschaftliche Arbeit
192 zur Verfügung zu stellen gleicht der beschwerlichen Suche nach einer
193 eierlegenden Wollmilchsau. Es ist quasi nicht möglich, alle potenziellen
194 Anforderungen an eine wissenschaftliche Arbeit in einem Dokument abzudecken,
195 insbesondere weil es für diese fast von jedem Lehrstuhl mehr oder weniger
196 unterschiedliche Vorgaben zu Formatierung und Layout gibt. Dennoch soll hier
197 versucht werden, einen Großteil der für gewöhnlich auftretenden Erfordernisse
198 zu bearbeiten.
199
200 Dieses Tutorial hat \emph{nicht} die Intention, \hologo{LaTeX}"=Einsteigern
201 sämtliche Grundlagen zu erläutern. Vielmehr wird davon ausgegangen, dass Sie
202 bereits erste Erfahrungen mit \hologo{LaTeXe} gesammelt haben. Dennoch wird
203 versucht, alle Schritte möglichst leicht nachvollziehbar zu gestalten. Sollte
204 Ihnen beim Lesen und Durcharbeiten des Tutorials etwas auf- oder missfallen,
205 so dürfen Sie mich gerne per E"~Mail kontaktieren. Auch Anregungen und
206 Wünsche dürfen sie mir gegenüber gerne kommunizieren.
207
208 Für absolute Neueinsteiger gibt es einige freie Tutorials, welche die ersten
209 Schritte mit \hologo{LaTeXe} stark erleichtern. Nicola~L.~C.~Talbot stellt
210 sehr gute Tutorials für
211 \hrfn{http://www.dickimaw-books.com/latex/novices/}{\hologo{LaTeX}-Novizen}
212 \cite{talbot2012} sowie
213 \hrfn{http://www.dickimaw-books.com/latex/thesis/}{Dissertationen}
214 \cite{talbot2013} zur freien Verfügung.
215
216 In erster Linie ist dieser Leitfaden für Anwender gedacht, die für ihre
217 wissenschaftliche Arbeit eine \TUDScript"=Dokumentklasse verwenden wollen.
218 Das vorgestellte Vorgehen kann jedoch~-- natürlich mit gewissen Abstrichen~--
219 auch mit anderen Klassen, insbesondere denen aus dem \KOMAScript"=Bundle,
220 umgesetzt werden. Viele der hier im Folgenden verwendeten Optionen und
221 Befehle aus dem \TUDScript-Bundle werden lediglich sporadisch in ihrer
222 Grundfunktion erläutert. Allerdings lassen sich detaillierte Erläuterung über
223 die türkisfarbigen Hyperlinks zum \tudhyperref{}{\TUDScript-Handbuch}
224 jederzeit sehr einfach öffnen. Des Weiteren wird auf eine Vielzahl von
225 Paketen verwiesen, deren Dokumentation über die magentafarbigen Links im
226 \CTAN* geöffnet werden kann. Alternativ kann dies auch über das Terminal
227 respektive die Kommandozeile mit dem Aufruf \Path{texdoc~\PName{Paket}}
228 direkt lokal erfolgen. Ein Großteil dieser Pakete wird zusätzlich kurz im
229 \TUDScript-Handbuch beschrieben.
230
231 Der Anwenderleitfaden muss nicht zwingend vollständig nachvollzogen werden.
232 Dieser ist in einzelne Abschnitte untergliedert, damit Sie sich bestimmte
233 Aspekte erarbeiten können. Sollten Querbezüge zu den einzelnen Abschnitten
234 bestehen, werden diese auch genannt. Zu guter Letzt findet sich am Ende
235 dieses Dokumentes das komplette Tutorial als ausführbarer Quelltext.
236 ]
237 \tableofcontents
238 \listoffigures
239 \listoftables
240
241
242
243 \section{Einleitung}
244 \label{sec:introduction}%
245 %
246 Zu Beginn werden einige Pakete geladen, die quasi in jedem neu erstellten
247 Dokument verwendet werden sollten. Alle weiteren in diesem Tutorial genutzten
248 und/oder empfohlenen Pakete werden in den relevanten Abschnitten des Tutorials
249 genauer erläutert.
250
251 Beim Laden der Klasse mit \Macro*{documentclass} können Sie globale Optionen
252 angeben. Diese werden sowohl an die Klasse selbst weitergereicht als auch allen
253 in der Präambel geladenen Pakete zur Verfügung gestellt. Falls das Paket
254 \Package{babel} für die Sprachauswahl im Dokument verwendet wird, sollten auf
255 alle Fälle die verwendeten Sprachen als Klassenoption angegeben werden, wobei
256 die zuletzt angegebene als aktuelle Sprache aktiviert wird. Dadurch werden
257 diese nicht nur an das Paket \Package{babel} sondern auch an andere Pakete
258 übergeben, welche sprachspezifische Einstellungen vornehmen.
259 %
260 \begin{Preamble}
261 \documentclass[english,ngerman]{tudscrreprt}
262 \usepackage{babel}
263 \end{Preamble}
264 %
265 Mit dem Paket \Package{fontenc} lässt sich die Kodierung der für die Ausgabe
266 der verwendeten Schriften im Dokument spezifizieren, wobei die europäische
267 Zeichenkodierung mit der Option~\Option{T1}(\Package{fontenc}) aktiviert wird.
268 Kommt mit \Engine{LuaLaTeX} oder \Engine{XeLaTeX} ein Unicode"=Textsatzsystem
269 zum Einsatz, sollte besser das Paket \Package{fontspec} geladen werden.
270
271 Weiterhin kann die Eingabekodierung der kompilierten Datei eingestellt werden.
272 Diese ist standardmäßig \PValue{utf8}. Bei der Verwendung von \Engine{pdfLaTeX}
273 sind auch andere Kodierungen möglich.%
274 \footnote{%
275 Sollte die Datei in einer anderen Kodierung gespeichert sein, so kann das
276 Paket \Package{selinput} genutzt werden, um die Kodierung automatisch zu
277 erkennen. Alternativ lässt sich die Eingabekodierung auch mit dem Paket
278 \Package{inputenc} auch manuell festgelegen. In beiden Fällen sollte das
279 Paket \Package{fontenc} \emph{vorher} geladen worden sein.
280 }
281
282 Wurde ein Sprachpaket für die deutsche Sprache geladen (\Package{babel} oder
283 \Package{polyglossia}), so werden für \Engine{LuaLaTeX} und \Engine{XeLaTeX}
284 erweiterte Trennmuster verwendet. Für \Engine{pdfLaTeX} lässt sich eine
285 wesentlich verbesserte Worttrennung für die deutsche Sprache mit dem Paket
286 \Package{hyphsubst} aktivieren. In \autoref{sec:hyphenation} können Sie weitere
287 Informationen zur Verwendung von \Package{hyphsubst} sowie zum Thema
288 \emph{Worttrennung} finden.
289 %
290 \begin{Preamble}
291 \usepackage{iftex}
292 \iftutex
293 \usepackage{fontspec}
294 \else
295 \usepackage[T1]{fontenc}
296 \usepackage[ngerman=ngerman-x-latest]{hyphsubst}
297 \fi
298 \end{Preamble}
299 %
300 Für die \KOMAScript-Klassen wird außerdem das Paket \Package{scrhack}
301 bereitgestellt. Dieses behebt einige Probleme bei der Kompatibilität mit
302 anderen Paketen bezüglich des Erstellens von Verzeichnissen. Deshalb sollte
303 dieses bei Bedarf frühzeitig in der Präambel geladen werden.
304 %
305 \begin{Preamble}
306 \usepackage{scrhack}
307 \end{Preamble}
308 %
309 Damit sind die allgemein notwendigen Pakete eingebunden. Es werden zwar weitere
310 benötigt, diese werden allerdings in den einzelnen Abschnitten dieses Tutorials
311 aufgeführt.
312
313
314
315 \section{Makrotypografie}
316 \subsection{Satzspiegel}
317 Gleich zu Beginn und bevor das eigentliche Verfassen der Arbeit beginnt, sollte
318 sich der Verfasser Gedanken über das zu nutzenden Layout und den Satzspiegel
319 machen, um bei der Finalisierung des Dokumentes keine böse Überraschung bei
320 Seitenumbrüchen oder der Position von Gleitobjekten zu erleben.
321
322 Zuerst gilt es zu entscheiden, ob das Dokument einseitig oder beidseitig
323 gesetzt werden soll. Ist Letzteres der Fall, so sollte die \KOMAScript-Option
324 \Option{twoside}(\Package{typearea}) als Klassenoption angegeben werden. Im
325 nächsten Schritt ist der zu verwendende Satzspiegel festzulegen. Hierfür kann
326 die \TUDScript-Option \Option{cdgeometry}'manual' verwendet werden, welche im
327 \TUDScript-Handbuch beschrieben ist. Normalerweise wird das Dokument im
328 asymmetrischen Layout des \CDs gesetzt.
329 %
330 Dieses Verhalten wird mit \Option*{cdgeometry=false}'manual' deaktiviert und
331 der Satzspiegel durch das Paket \Package{typearea} nach typografischen
332 Gesichtspunkten konstruiert. Dabei ist für dessen Aufteilung maßgeblich die
333 \KOMAScript-Option \Option{DIV}(\Package{typearea}) verantwortlich, mit der
334 \KOMAScript"=Option \Option{BCOR}(\Package{typearea}) wird die Bindekorrektur
335 angegeben. Diese wird in \autoref{sec:bcor} erläutert.
336
337 \subsection{Änderung des Zeilenabstandes (Durchschuss)}
338 Auf eine Änderung des Zeilenabstandes sollte aus typografischer Sicht bei der
339 Verwendung einer Standardschrift im Normalfall verzichtet werden. Die Gründe
340 hierfür werden im Handbuch von \TUDScript bei der Vorstellung des Paketes
341 \Package{setspace} erklärt, welches für dieses Anliegen den Befehl
342 \Macro{setstretch}[\Parameter{Faktor}](\Package{setspace}) bereitstellt. Wird
343 die \OpenSans-Hausschrift der \TnUD verwendet, sollte der Faktor im Bereich
344 \PValue{1.05}--\PValue{1.1} liegen.
345
346 \subsection{Bindekorrektur}
347 \label{sec:bcor}%
348 %
349 Falls die Arbeit nach der Fertigstellung gebunden werden soll, so ist auf den
350 notwendigen Binderand zu achten, quasi der Teil einer Seite, welcher durch die
351 Bindung \enquote{verschwindet} und nicht mehr als sichtbarer Teil der Seite
352 vorhanden ist. Als Faustregel gilt, dass die erforderliche Bindekorrektur in
353 etwa der halben Höhe des Buchblocks entsprechen sollte. Dessen Höhe wiederum
354 ist abhängig von der Anzahl der Seiten sowie der Papierdichte.
355
356 Wird qualitativ höherwertiges Papier mit einer Dichte von \SI{100}{g/m^2}
357 verwendet, so entsprechen 100~Blatt einer Buchblockhöhe von zirka~\SI{12}{mm}.
358 Dementsprechend wäre in diesem Beispiel eine Bindekorrektur von~\SI{6}{mm}
359 notwendig, die sich mit der Klassenoption \Option*{BCOR=6mm} einstellen ließe.
360 Sollte die erwartete Seitenzahl davon abweichen, kann die einzustellende
361 Bindekorrektur linear skaliert werden. Für differierende Papierdichten sollte
362 die Buchblockhöhe für die geschätzte Gesamtseitenanzahl in Erfahrung gebracht
363 werden.
364
365
366
367 \section{Umschlagseite und Titel}
368 Die Umschlagseite und der Titel sind sich in ihrer Gestalt sehr ähnlich.
369 Allerdings gibt es ein paar kleine Unterschiede. Einerseits werden auf dem
370 Cover weniger Informationen als auf der Titelseite ausgegeben. Andererseits
371 wird der Titel immer im Satzspiegel des restlichen Dokumentes ausgegeben,
372 wohingegen die Umschlagseite~-- ohne weitere Optionen~-- im asymmetrischen
373 Layout des \CDs der \TnUD erscheint. Wie dieses Verhalten geändert werden kann,
374 ist im Handbuch für \Macro{makecover}'manual' erläutert. Die resultierende
375 Ausgabe des nachfolgenden Quelltextauszugs ist in \autoref{fig:title} zu sehen
376 und stellt eine mögliche Ausprägung von Umschlagseite und Titel dar.
377 %
378 \begin{figure}
379 \IncludeStandalone{title}[1,2]
380 \caption{Umschlagseite und Titel}
381 \label{fig:title}
382 \end{figure}
383
384 \begin{Trunk!}{title}
385 \faculty{Juristische Fakultät}
386 \department{Fachrichtung Strafrecht}
387 \institute{Institut für Kriminologie}
388 \chair{Lehrstuhl für Kriminalprognose}
389 \title{%
390 Entwicklung eines optimalen Verfahrens zur Eroberung des
391 Geldspeichers in Entenhausen
392 }
393 \thesis{master}
394 \graduation[M.Sc.]{Master of Science}
395 \author{%
396 Mickey Mouse%
397 \matriculationnumber{12345678}%
398 \dateofbirth{2.1.1990}%
399 \placeofbirth{Dresden}%
400 \course{Klinische Prognostik}%
401 \discipline{Individualprognose}%
402 \and%
403 Donald Duck%
404 \matriculationnumber{87654321}%
405 \dateofbirth{1.2.1990}%
406 \placeofbirth{Berlin}%
407 \course{Statistische Prognostik}%
408 \discipline{Makrosoziologische Prognosen}%
409 }
410 \matriculationyear{2010}
411 \supervisor{Dagobert Duck \and Mac Moneysac}
412 \professor{Prof. Dr. Kater Karlo}
413 \date{10.09.2014}
414 \makecover
415 \maketitle
416
417 \end{Trunk!}
418
419
420
421 \section{Vor- und Nachspann}
422 In den folgenden Unterabschnitten werden Elemente vorgestellt, welche häufig
423 als Bestandteil einer wissenschaftlichen (Abschluss"~)Arbeit gefordert werden.
424 Die Platzierung oder Position der vorgestellten Elemente innerhalb der Arbeit
425 ist nicht eindeutig durch eine Norm oder dergleichen festgelegt. Vielmehr gibt
426 es meist eine Richtlinie vom verantwortlichen Prüfungsamt oder eine konkrete
427 Vorgabe des betreuenden wissenschaftlichen Mitarbeiters oder Hochschullehrers.
428
429 Verwenden Sie für ihre Arbeit eine Buchklasse, so können die entsprechenden
430 Abschnitte mit \Macro{frontmatter}(\Package{koma-script}) (Vorspann),
431 \Macro{mainmatter}(\Package{koma-script}) (Hauptteil) und
432 \Macro{backmatter}(\Package{koma-script}) (Nachspann) gekennzeichnet werden.
433 Einen Anhang starten Sie mit \Macro{appendix}(\Package{koma-script}), womit
434 unter anderem die Kapitelnummerierung auf Großbuchstaben umgeschaltet wird.
435 Weitere Hinweise zu den genannten Befehlen sind im \scrguide nachzulesen.
436
437
438 \subsection{Aufgabenstellung}
439 \label{sec:task}%
440 %
441 Das Erstellen der Aufgabenstellung einer Abschlussarbeit im \CD der \TnUD muss
442 das Paket \Package{tudscrsupervisor}'manual' geladen werden.
443 %
444 \begin{Preamble}
445 \usepackage{tudscrsupervisor}
446
447 \end{Preamble}
448 %
449 Dieses Paket stellt die Umgebung \Environment{task}'manual' sowie den Befehl
450 \Macro{taskform}'manual' bereit. Bei beiden Varianten wird zu Beginn eine
451 Tabelle mit Autoreninformationen erzeugt. Am Ende werden der oder die Betreuer
452 der Arbeit sowie Professor und gegebenenfalls der Prüfungsausschussvorsitzende
453 ausgegeben. Mit der Umgebung \Environment{task}'manual' kann zwischen Kopf und
454 Fuß ein beliebiger Inhalt gesetzt werden. Der Befehl \Macro{taskform}'manual'
455 hingegen erzeugt eine standardisierte Ausgabe, wobei der Inhalt des zweiten
456 obligatorischen Arguments in einer
457 \Environment{itemize}(\Package{koma-script},\Package{enumitem})-Umgebung
458 verwendet wird und somit \Macro{item}(\Package{koma-script},\Package{enumitem})
459 zu nutzen ist. Das Resultat des folgenden Quelltextes ist in \autoref{fig:task}
460 zu sehen.
461 %
462 \begin{figure}
463 \IncludeStandalone{task}[1,2]
464 \caption{Aufgabenstellung in freier und standardisierter Form}
465 \label{fig:task}
466 \end{figure}
467
468 \begin{Hint!}{task}
469 \faculty{Juristische Fakultät}
470 \department{Fachrichtung Strafrecht}
471 \institute{Institut für Kriminologie}
472 \chair{Lehrstuhl für Kriminalprognose}
473 \title{%
474 Entwicklung eines optimalen Verfahrens zur Eroberung des
475 Geldspeichers in Entenhausen
476 }
477 \thesis{master}
478 \author{%
479 Mickey Mouse%
480 \matriculationnumber{12345678}%
481 \course{Klinische Prognostik}%
482 \discipline{Individualprognose}%
483 \and%
484 Donald Duck%
485 \matriculationnumber{87654321}%
486 \course{Statistische Prognostik}%
487 \discipline{Makrosoziologische Prognosen}%
488 }
489 \matriculationyear{2010}
490 \issuedate{1.2.2015}
491 \duedate{1.8.2015}
492 \supervisor{Dagobert Duck \and Mac Moneysac}
493 \chairman{Prof. Dr. Primus von Quack}
494 \professor{Prof. Dr. Kater Karlo}
495
496 \newcommand{\taskcontent}{%
497 Momentan ist das besagte Thema in aller Munde. Insbesondere wird es
498 gerade in vielen~-- wenn nicht sogar in allen~-- Medien diskutiert.
499 Es ist momentan noch nicht abzusehen, ob und wann sich diese Situation
500 ändert. Eine kurzfristige Verlagerung aus dem Fokus der Öffentlichkeit
501 wird nicht erwartet.
502
503 Als Ziel dieser Arbeit soll identifiziert werden, warum das Thema
504 gerade so omnipräsent ist und wie dieser Effekt abgeschwächt werden
505 könnte. Zusätzlich sind Methoden zu entwickeln, mit denen sich ein
506 ähnlicher Vorgang zukünftig vermeiden lässt.
507 }
508
509 \begin{task}
510 \smallskip
511 \par\noindent
512 \taskcontent
513 \end{task}
514
515 \taskform[pagestyle=empty]{\taskcontent}{%
516 \item Recherche
517 \item Analyse
518 \item Entwicklung eines Konzeptes
519 \item Anwendung der entwickelten Methodik
520 \item Dokumentation und grafische Aufbereitung der Ergebnisse
521 }
522
523 \end{Hint!}
524 \begin{Trunk+}
525 \newcommand{\taskcontent}{%
526 Momentan ist das besagte Thema in aller Munde. Insbesondere wird es
527 gerade in vielen~-- wenn nicht sogar in allen~-- Medien diskutiert.
528 Es ist momentan noch nicht abzusehen, ob und wann sich diese Situation
529 ändert. Eine kurzfristige Verlagerung aus dem Fokus der Öffentlichkeit
530 wird nicht erwartet.
531
532 Als Ziel dieser Arbeit soll identifiziert werden, warum das Thema
533 gerade so omnipräsent ist und wie dieser Effekt abgeschwächt werden
534 könnte. Zusätzlich sind Methoden zu entwickeln, mit denen sich ein
535 ähnlicher Vorgang zukünftig vermeiden lässt.
536 }
537 \taskform[pagestyle=empty]{\taskcontent}{%
538 \item Recherche
539 \item Analyse
540 \item Entwicklung eines Konzeptes
541 \item Anwendung der entwickelten Methodik
542 \item Dokumentation und grafische Aufbereitung der Ergebnisse
543 }
544
545 \end{Trunk+}
546
547
548 \subsection{Zusammenfassung}
549 Häufig wird zu Beginn einer wissenschaftliche Arbeit die Motivation und der
550 Inhalt dieser zusammengefasst, um den Leser die Thematik der Abhandlung
551 vorzustellen. in den meisten Fällen wird diese dabei in deutscher und
552 englischer Sprache verfasst. Hierfür stellt \KOMAScript{} bereits die Umgebung
553 \Environment{abstract}'manual' bereit. Vielfach wird der Wunsch geäußert,
554 sowohl die deutsche als auch die englische Zusammenfassung auf derselben Seite
555 zu setzen. Diese Variante kann mithilfe der \TUDScript-Klassen sehr einfach
556 umgesetzt werden, wie der nachfolgende Quelltextauszug zeigt. Die resultierende
557 Ausgabe ist in \autoref{fig:abstr} zu sehen.
558 %
559 \begin{figure}
560 \centering
561 \IncludeStandalone[width=.5\textwidth]{abstract}
562 \caption{Zusammenfassung in deutscher und englischer Sprache}
563 \label{fig:abstr}
564 \end{figure}
565
566 \begin{Trunk!}{abstract}
567 \TUDoption{abstract}{multiple,section}
568 \begin{abstract}
569 Dies ist der deutschsprachige Teil der Zusammenfassung, in dem die
570 Motivation sowie der Inhalt der nachfolgenden wissenschaftlichen
571 Abhandlung kurz dargestellt werden.
572 \nextabstract[english]
573 This is the english part of the summary, in which the motivation and
574 the content of the following academic treatise are briefly presented.
575 \end{abstract}
576
577 \end{Trunk!}
578
579
580
581 \subsection{Selbstständigkeitserklärung und Sperrvermerk}
582 Für die meisten Abschlussarbeiten an der \TnUD wird vom Verfasser eine
583 Selbstständigkeitserklärung verlangt. Für diese wird ein Standardtext
584 bereitgestellt. Dieser kann mit dem Befehl \Macro{confirmation}'manual'
585 ausgegeben werden. Wurde das Thema in Kooperation mit einem Unternehmen
586 bearbeitet, so wird zumeist auch ein Sperrvermerk gefordert, welcher mit
587 \Macro{blocking}'manual' erzeugt werden kann. Mit \Macro{declaration}'manual'
588 lassen sich beide Erklärungen direkt nacheinander erzeugen. Die verwendete
589 Überschrift und ein möglicher Eintrag in das Inhaltsverzeichnis können über die
590 Option \Option{declaration}'manual' reguliert werden. Eine mögliche Ausprägung
591 der Erklärungen ist in \autoref{fig:decl} abgebildet.
592 %
593 \begin{figure}
594 \centering
595 \IncludeStandalone[width=.5\textwidth]{declaration}
596 \caption{Selbstständigkeitserklärung und Sperrvermerk}
597 \label{fig:decl}
598 \end{figure}
599
600 \begin{Hint!}{declaration}
601 \title{%
602 Entwicklung eines optimalen Verfahrens zur Eroberung des
603 Geldspeichers in Entenhausen
604 }
605 \author{Mickey Mouse\and Donald Duck}
606 \declaration[company=FIRMA]
607 \end{Hint!}
608 \begin{Trunk+}
609 \declaration[company=FIRMA]
610
611 \end{Trunk+}
612
613 \subsection{Inhalts-, Abbildungs-, und Tabellenverzeichnis}
614 Das Inhaltsverzeichnis wird mit \Macro{tableofcontents}(\Package{koma-script})
615 erzeugt und führt die Gliederung des erstellten Dokumentes entsprechend der
616 verwendeten Befehle%
617 \footnote{%
618 \Macro{part}(\Package{koma-script}),
619 \Macro{addpart}(\Package{koma-script}),
620 \Macro{chapter}(\Package{koma-script}),
621 \Macro{addchap}(\Package{koma-script}),
622 \Macro{section}(\Package{koma-script}),
623 \Macro{addsec}(\Package{koma-script}) etc.%
624 }
625 auf. Wurde das Paket \Package{hyperref} geladen, so werden im
626 Inhaltsverzeichnis PDF"~Hyperlinks auf die einzelnen Abschnitte erzeugt.
627
628 Sowohl Abbildungen als auch Tabellen werden in \hologo{LaTeX} normalerweise
629 mit speziellen Umgebungen~-- \Environment{figure} und \Environment{table}~--
630 eingebunden. Innerhalb dieser sogenannten Gleitumgebungen kann der Befehl
631 \Macro{caption}[%
632 \OParameter{Verzeichniseintrag}\Parameter{Bezeichnung}%
633 ](\Package{koma-script},\Package{caption}) genutzt werden, um diesen eine
634 Bezeichnung hinzuzufügen. Mit \Macro{listoffigures}(\Package{koma-script})
635 beziehungsweise \Macro{listoftables}(\Package{koma-script}) lassen sich
636 Verzeichnisse erstellen, in denen alle Gleitobjekte des jeweiligen Typs
637 ausgegeben werden, falls diese denn eine Bezeichnung hinzugefügt wurde.
638
639 Sollen Abbildungen oder Tabellen außerhalb ihrer angestammten Gleitumgebung
640 \Environment{figure} beziehungsweise \Environment{table} genutzt und benannt
641 werden, kann dies entweder mit dem Befehl
642 \Macro{captionof}[%
643 \Parameter{Typ}\OParameter{Verzeichniseintrag}\Parameter{Bezeichnung}%
644 ](\Package{koma-script}) oder~-- falls die beiden Pakete \Package{caption} und
645 \Package{hyperref} genutzt werden~-- auch wie gewohnt mit
646 \Macro{caption}(\Package{koma-script},\Package{caption}) allerdings zusätzlich
647 ergänzt mit einem zuvor aufgerufenem
648 \Macro{captionsetup}[\PParameter{type=figure/table}](\Package{caption})
649 erfolgen. Weitere Informationen diesbezüglich sind dem \scrguide respektive der
650 Anleitung zu \Package{caption} zu entnehmen. In \autoref{sec:floats} wird
651 genauer auf Gleitumgebungen eingegangen.
652 %
653 \begin{Trunk}
654 \tableofcontents
655 \listoffigures
656 \listoftables
657
658 \end{Trunk}
659 \begin{Trunk+}
660 \printacronyms[style=acrotabu]
661 \printsymbols[style=symblongtabu]
662
663 \setchapterpreamble{%
664 \renewcommand*{\dictumwidth}{.4\textwidth}%
665 \dictum[Johann Wolfgang von Goethe]{%
666 Es irrt der Mensch, solang er strebt.%
667 }%
668 \bigskip
669 }
670 \chapter{Einleitung}
671 Nachdem nun der Vorspann und~-- bis auf das Literaturverzeichnis am
672 Ende des Dokumentes auf Seite~\pageref{sec:bibliography}~-- alle
673 Verzeichnisse erfolgreich ausgegeben wurden, wird nun die Verwendung
674 der weiteren Umgebungen und Befehle demonstriert, welche im Tutorial
675 \texturn{treatise.pdf} vorgestellt wurden.
676
677 \end{Trunk+}
678
679
680 \subsection{Abkürzungs- und Symbolverzeichnis}
681 \label{sec:glossaries}%
682 %
683 Für die Auszeichnung von Abkürzungen gibt es zwei sehr gute Pakete, die dieses
684 Unterfangen stark vereinfachen. Die einfachere~-- jedoch nicht so mächtige~--
685 der beiden Varianten ist die Nutzung des Paketes \Package{acro}. Sollen nur
686 Abkürzungen und gegebenenfalls eine sortierte Liste dieser gesetzt werden, ist
687 dieses allerdings absolut ausreichend. Für ein Symbolverzeichnis lässt sich in
688 dieser Variante das Paket \Package{nomencl} nutzen. Dieses bietet meiner
689 Meinung nach jedoch keine großen Vorteile, stattdessen kann auch einfach eine
690 Tabelle händisch erzeugt werden. Das Paket \Package{acro} ist sehr gut und
691 ausführlich dokumentiert. Deshalb wird hier auf eine exemplarische Erläuterung
692 verzichtet und stattdessen auf dessen Dokumentationen verwiesen. Alternativ
693 kann auch das Paket \Package{acronym} verwendet werden, wobei die alphabetische
694 Sortierung der Abkürzungen durch den Anwender erfolgen muss, weshalb ich von
695 diesem eher abrate.
696
697 Die andere Möglichkeit ist die Nutzung des Paketes \Package{glossaries}, das
698 eine große Zahl an Einstellmöglichkeiten und Optionen besitzt, allerdings auch
699 etwas Zeit für die Einarbeitung und Studium der Dokumentation benötigt. Der
700 ursprüngliche Einsatzzweck dieses Paketes ist das Setzen eines fachsprachlichen
701 oder technischen Glossars. Es bietet zusätzlich die Mittel zum Erzeugen eines
702 Abkürzungs- sowie Symbolverzeichnis. Es soll folgend hier kurz erläutert
703 werden, wie das Paket zu verwenden ist. Für weiterführende Beispiele sollte
704 die Dokumentationen zu Rate gezogen werden, welche dahingehend keine Wünsche
705 offen lässt.
706
707 Das Paket \Package{glossaries} sollte immer \emph{nach} \Package{hyperref}
708 geladen werden. Entweder Sie achten explizit darauf oder Sie verwenden den
709 Befehl \Macro{AfterPackage*}(\Package{scrbase}) aus dem \KOMAScript-Bundle. Mit
710 diesem können Sie die Quelltext nach dem Laden eines Paketes ausführen.
711 \Attention{%
712 Es ist allerdings darauf zu achten, dass der Quelltext nur ausgeführt wird,
713 wenn das avisierte Zielpaket auch tatsächlich geladen wird.
714 }
715 Falls Sie demnach auf \Package{hyperref} jedoch nicht auf \Package{glossaries}
716 verzichten möchten, sollte der nachfolgende Quelltext am Ende der Präambel
717 eingefügt werden.
718
719 Die für \Package{glossaries} verwendeten Optionen werden kurz erläutert.
720 %
721 \begin{Preamble+}
722 \AfterPackage*{hyperref}{%
723 \end{Preamble+}
724 \begin{Preamble}
725 \usepackage[%
726 \end{Preamble}
727 %
728 Die zwei Paketoptionen \Option{acronym}(\Package{glossaries}) sowie
729 \Option{symbols}(\Package{glossaries}) erzeugen die beiden Verzeichnisse für
730 Abkürzungen und Symbole. Die Option \Option{nomain}(\Package{glossaries}) wird
731 immer dann verwendet, wenn im Dokument kein zusätzliches allgemeines oder
732 technisches Glossar erzeugt werden soll.
733 %
734 \begin{Preamble}
735 acronym,% Abkürzungen
736 symbols,% Formelzeichen
737 nomain,% kein Glossar
738 \end{Preamble}
739 %
740 Durch \Option{nogroupskip}(\Package{glossaries}) wird der automatische Abstand
741 zwischen den Einträgen zur Gruppierung innerhalb eines Glossars entfernt, die
742 Option \Option{toc}(\Package{glossaries}) fügt alle erzeugten Verzeichnisse
743 dem Inhaltsverzeichnis hinzu, \Option{section}(\Package{glossaries}) bestimmt
744 die Gliederungsebene der Überschrift.
745 %
746 \begin{Preamble}
747 nogroupskip,%
748 toc,%
749 section=chapter,%
750 \end{Preamble}
751 %
752 Mit der Option \Option{nostyles}(\Package{glossaries}) kann man gegebenenfalls
753 das Laden der von \Package{glossaries} vordefinierten Stilen verhindern. Dies
754 ist insbesondere sinnvoll, wenn für die einzelnen Glossare und Verzeichnisse
755 ohnehin eigene Stile erstellt werden, wie dies nachfolgend geschieht.
756 %
757 \begin{Preamble}
758 nostyles,%
759 \end{Preamble}
760 %
761 Mit der Option \Option{translate}(\Package{glossaries}) werden die Überschriften
762 aller Glossare in der Dokumentsprache gesetzt, wobei \Option*{translate=babel}
763 die Nutzung des Paketes \Package{babel} erzwingt.
764 %
765 \begin{Preamble}
766 translate=babel,%
767 \end{Preamble}
768 %
769 Das Paket \Package{glossaries} erstellt bei der Kompilierung des Dokumentes
770 Hilfsdateien, anhand derer die Indexe erzeugt und sortiert werden können. Da
771 \Engine{pdfLaTeX} diese Funktionalität nicht bereitstellt, ist hierfür der
772 Aufruf einer passenden Anwendung notwendig. Die meisten Distributionen stellen
773 dafür \Application{makeindex} bereit. Dieses Programm kann prinzipiell zwar
774 Einträge alphabetisch sortieren, bietet allerdings weder die Nutzung von
775 Unicode-Symbolen noch eine Sprachunterstützung. Aufgrund der genannten
776 Nachteile ist \Application{xindy} zum Sortieren der Einträge zu empfehlen, da
777 dieses Programm sowohl eine Unterstützung von Unicode als auch die Möglichkeit,
778 nach sprachabhängigen Regeln zu sortieren, bietet. Allein für die deutsche
779 Sprache gibt es beispielsweise zwei Varianten der Sortierung~-- nach DIN und
780 nach Duden.
781
782 Ohne weiteres Zutun des Anwenders wird vom Paket \Package{glossaries} in der
783 Grundeinstellung \Application{makeindex} genutzt. Soll stattdessen für die
784 Sortierung der Glossar- und Verzeichniseinträge \Application{xindy} zum Einsatz
785 kommen, muss die Option \Option{xindy}(\Package{glossaries}) aktiviert werden.
786 Dieser kann zusätzlich sowohl die zu nutzende Spracheinstellung zur Sortierung
787 als auch die gewünschte Eingabekodierung an \Application{xindy} übergeben
788 werden. Beispielsweise wird mit \Option*{xindy=\PParameter{language=german-din}}
789 die deutsche Sortierung nach~DIN aktiviert.
790 %
791 %
792 \begin{Hint}
793 % mit Tex Live einfach verwendbar
794 xindy=§\{§language=german-din§\}§,
795 \end{Hint}
796 \begin{Preamble+}
797 % mit Tex Live einfach verwendbar
798 xindy={language=german-din},
799 \end{Preamble+}
800 %
801 Das Erstellen aller Glossare~-- unabhängig davon, ob \Application{xindy} oder
802 \Application{makeindex} für die Sortierung zum Einsatz kommt~-- sollte das
803 Perl"~Skript \File{makeglossaries}(\Package{glossaries}) verwendet werden,
804 welches alle notwendigen Optionen an die jeweilige Anwendung weiterleitet.
805
806 \Attention{%
807 Für den Aufruf von \Application{xindy} selbst als auch für die Ausführung des
808 Skriptes \File{makeglossaries}(\Package{glossaries}) ist ein Perl"=Interpreter
809 notwendig. Dieser wird lediglich von \Distribution{\hologo{TeX}~Live} nicht
810 jedoch von \Distribution{\hologo{MiKTeX}} direkt bereitgestellt. Wird die
811 letztgenannte Distribution verwendet, muss der Anwender gegebenenfalls diesen
812 zusätzlich installieren.
813 }
814
815 Kann das Skript \File{makeglossaries}(\Package{glossaries}) nicht genutzt
816 werden, kann alternativ dazu die Option \Option{automake}(\Package{glossaries})
817 aktiviert werden. Diese sorgt dafür, dass am Ende des \Engine{pdfLaTeX}"~Laufs
818 der Aufruf von \Application{xindy} oder \Application{makeindex} direkt erfolgt.
819 Soll \Application{xindy} verwendet werden, sind dafür allerdings erweiterte
820 Schreibrechte notwendig, weshalb für diese Variante \Engine{pdfLaTeX} mit der
821 Option \Option{-{}-shell-escape}(\Engine{pdfLaTeX}) respektive
822 \Option{-{}-enable-write18}(\Engine{pdfLaTeX}) aufgerufen werden muss. Für
823 \Application{xindy} ist außerdem die Angabe der Sprache über die Option
824 \Option*{xindy=\PParameter{language=\dots}} zwingend notwendig.
825
826 Ist weder die Nutzung des Skriptes \File{makeglossaries}(\Package{glossaries})
827 noch der~-- im Zweifel sicherheitskritische~-- Aufruf von \Engine{pdfLaTeX} mit
828 erweiterten Schreibrechten möglich, so muss die gewünschte Anwendung für die
829 Sortierung explizit durch den Anwender aufgerufen werden, wobei auf die Angabe
830 der richtigen Parameter zu achten ist. Genaueres hierzu sowie Lösungen für
831 Probleme beim Erstellen der Glossare und Verzeichnisse sind in der Dokumentation
832 von \Package{glossaries} zu finden.
833 %
834 \begin{Hint}
835 automake,%
836 \end{Hint}
837 %
838 Damit sind alle verwendeten Optionen erläutert. Schließlich sorgt der Befehl
839 \Macro{makeglossaries}(\Package{glossaries}) für das Erstellen der
840 optionsabhängigen Stildateien für \Application{makeindex} respektive
841 \Application{xindy} sowie das Erzeugen der benötigten Hilfsdateien.
842 %
843 \begin{Preamble}
844 ]{glossaries}
845 \makeglossaries
846 \end{Preamble}
847 \begin{Preamble+}
848 }% Ende von AfterPackage
849
850 \AfterPackage*{glossaries}{%
851 \end{Preamble+}
852 %
853 Damit wäre der erste Teil zur Initialisierung überstanden und wir können zum
854 eigentlichen Problem kommen. Wie wird nun ein Abkürzungs- und/oder
855 Symbolverzeichnis erstellt?
856
857 \subsubsection{Abkürzungsverzeichnis}
858 Das Paket \Package{glossaries} stellt für die Definition von Abkürzungen einen
859 speziellen Befehl bereit. Mit \Macro{newacronym}[%
860 \LParameter\Parameter{Label}\Parameter{Abkürzung}\Parameter{Wortgruppe}%
861 ](\Package{glossaries}) wird eine Abkürzung definiert und kann später über
862 \Parameter{Label} genutzt werden. Die möglichen optionalen Parameter können in
863 der Dokumentation zu \Package{glossaries} nachgeschlagen werden. Für ein
864 kleines Beispiel werden drei Abkürzungen erstellt\dots
865 %
866 \begin{Trunk+}
867 \section{Die Verwendung von Akronymen und Symbolen}
868 \end{Trunk+}
869 \begin{Trunk*}
870 \newacronym{apsp}{APSP}{All-Pairs Shortest Path}
871 \newacronym{spsp}{SPSP}{Single-Pair Shortest Path}
872 \newacronym{sssp}{SSSP}{Single-Source Shortest Path}
873
874 \end{Trunk*}
875 %
876 \dots und diese in einer kurzen Textpassage mit dem \Package{glossaries}"=Befehl
877 \Macro{gls}[\Parameter{Label}](\Package{glossaries}) verwendet.
878 %
879 \begin{Trunk*}
880 In der Graphentheorie wird häufig die Lösung des Problems des kürzesten
881 Pfades zwischen zwei Knoten gesucht. Dieses Problem wird häufig auch
882 mit \gls{spsp} bezeichnet. Es lässt sich auf die Variationen \gls{sssp}
883 und \gls{apsp} erweitern. Für die Lösung von \gls{spsp}, \gls{sssp}
884 oder \gls{apsp} kommen unterschiedliche Algorithmen zum Einsatz.
885
886 \end{Trunk*}
887 %
888 Gut zu sehen ist, dass sich die Ausgabe der Abkürzung bei der ersten Verwendung
889 mit \Macro{gls}(\Package{glossaries}) von der zweiten~-- und jeder weiteren~--
890 unterscheidet. Das Verhalten lässt sich über verschiedene Stile mit
891 \Macro{setacronymstyle}(\Package{glossaries}) anpassen. Die Ausgabe einer Liste
892 aller Abkürzungen erfolgt mit:
893 %
894 \begin{Hint}
895 \printacronyms
896 \end{Hint}
897 \newglossarystyle{simple}{%
898 \renewenvironment{theglossary}{}{\par}%
899 \renewcommand*{\glossentry}[2]{%
900 \noindent%
901 \textsbn{\glsentryitem{##1}\glstarget{##1}\glossentryname{##1}}\quad
902 \glossentrydesc{##1}\glspostdescription\space ##2%
903 \par%
904 }%
905 }
906 \begin{quoting}[rightmargin=0pt]
907 \glsdisablehyper
908 \printacronyms[style=simple]
909 \end{quoting}
910 %
911 Dabei werden die Akronyme in einer \Environment*{description}"=Umgebung gesetzt,
912 was absolut ausreichend ist. Mir persönlich ist allerdings die Darstellung in
913 einer quasi"~tabellarischen Form lieber. Dabei soll der Stil mit fettgedruckten
914 Abkürzungen beibehalten werden. Das \Package{glossaries}"=Paket stellt zwar
915 auch eine Vielzahl an Stilen in Tabellenform bereit, allerdings nicht in dem
916 gewünschten. Deshalb wird nachfolgend gezeigt, wie sich ein eigener Stil in
917 Tabellenform kreieren lässt.
918
919 Es bieten sich die Umgebungen \Environment{tabularx}(\Package{tabularx}) oder
920 \Environment{tabu}(\Package{tabu}) an, bei denen die Spaltenbreite teilweise
921 automatisch berechnet wird, um sich manuelle Formatierungsarbeiten zu sparen.
922 Folgend werden beide Varianten vorgestellt. Falls Sie noch keine Erfahrungen
923 mit dem Tabellensatz in \hologo{LaTeXe} haben, lohnt sich vorher ein Blick in
924 \autoref{sec:tables}, um die verwendeten Befehle und Umgebungen zu verstehen.
925 Wie Sie Stile definieren, die Seitenumbrüche in einer Tabelle zulassen, können
926 Sie in diesem \autorefname[sec:glossaries] bei der Symbolverzeichniserstellung
927 erfahren.
928
929 \minisec{Eigener Stil mit \Environment*{tabularx}}
930 Ein eigener Glossarstil kann mit \Macro{newglossarystyle}(\Package{glossaries})
931 definiert werden, wobei für den neu definierten Stil die Umgebung
932 \Environment{theglossary}(\Package{glossaries}) umdefiniert wird. Als erstes
933 kommt die Tabellenumgebung \Environment{tabularx}(\Package{tabularx}) aus dem
934 gleichnamigen Paket, welches in \autoref{sec:tabularx} vorgestellt wird, zum
935 Einsatz.
936
937 Es werden in der Tabelle drei Spalten definiert. Die erste und letzte Spalte
938 sind schlicht linksbündige Standardspalten~(\PValue{l}). In diesen werden die
939 Abkürzungen selbst sowie die Seitenzahlen eingetragen. Die Verwendung
940 von~\PValue{@\PParameter{}} führt dazu, dass der normalerweise vor der ersten
941 und nach der letzten Spalte eingefügte Abstand von \Length{tabcolsep} entfällt.
942 Die Breite der Spalte vom Typ~\PValue{X} wird automatisch berechnet.
943
944 Aufgrund der Implementierung von \Environment{tabularx}(\Package{tabularx})
945 lässt sich diese nicht als verschachtelte Umgebung verwenden. Allerdings kann
946 stattdessen die mit \Macro*{tabularx} sowie \Macro*{endtabularx} die
947 Low"~Level"~Variante genutzt werden. Die Definition des neuen Stils
948 \PValue{acrotabularx} wird nachfolgend ausgegeben, die weitergehende
949 Erläuterung schließt sich daran an.
950 %
951 \CodeHook{\let\newglossarystyle\renewglossarystyle}
952 \begin{Hint*}
953 \newglossarystyle{acrotabularx}{%
954 \renewenvironment{theglossary}{%
955 \tabularx{\linewidth}{@{}lXl@{}}%
956 }{%
957 \endtabularx\par\bigskip%
958 }%
959 \renewcommand*{\glossaryheader}{}%
960 \renewcommand*{\glsgroupheading}[1]{}%
961 \renewcommand*{\glsgroupskip}{}%
962 \renewcommand*{\glossentry}[2]{%
963 \glsentryitem{##1}% Entry number if required
964 \glstarget{##1}{\sffamily\bfseries\glossentryname{##1}} &
965 \glsentrydesc{##1} &
966 ##2\tabularnewline
967 }
968 }
969
970 \end{Hint*}
971 %
972 Der Rest des Stils ist schnell erläutert. Zunächst wird auf Tabellenköpfe
973 (\Macro{glossaryheader}(\Package{glossaries})) sowie Überschriften und Abstände
974 bei Gruppierungen (\Macro{glsgroupheading}(\Package{glossaries}) sowie
975 \Macro{glsgroupskip}(\Package{glossaries})) verzichtet. Der Befehl
976 \Macro{glossentry}(\Package{glossaries}) ist verantwortlich für die
977 Formatierung der Einträge im Abkürzungsverzeichnis. Dieser wird intern durch
978 \Package{glossaries} mit zwei obligatorischen Argumenten aufgerufen. Das erste
979 enthält das entsprechende Label, das zweite ein kommaseparierte Liste der
980 Seitenzahlen. Dabei stehen verschiedene Makros zur Auswahl, um anhand des
981 gegebenen Labels die gewünschten Informationen zu extrahieren.%
982 \footnote{%
983 bspw. mit \Macro{glossentryname}(\Package{glossaries}) die Bezeichnung oder
984 mit \Macro{glsentrydesc}(\Package{glossaries}) die dazugehörige Beschreibung%
985 }
986
987 Der Befehl \Macro{glossentry}(\Package{glossaries}) wurde so definiert, dass
988 für jeden Eintrag eine separate Zeile in der Tabelle erzeugt wird, wo in der
989 ersten Spalte die Abkürzung selbst, in der zweiten die Langform und in der
990 dritten Spalte schließlich die Liste der Seiten, auf welchen die jeweilige
991 Abkürzung mit \Macro{gls}[\Parameter{Label}](\Package{glossaries}) verwendet
992 wurde, ausgegeben wird. Zum Abschluss die resultierende Ausgabe des
993 Abkürzungsverzeichnisses im neuen Stil.
994 %
995 \begin{Hint}
996 \printacronyms[style=acrotabularx]
997 \end{Hint}
998 \begin{quoting}[rightmargin=0pt]
999 \InputCode
1000 \end{quoting}
1001 %
1002 Sollte der Platz für die Erläuterungen wie in diesem Beispiel in der mittleren
1003 Spalte mehr als ausreichend sein und kein Zeilenumbruch benötigt werden, kann
1004 auch einfach eine \Environment{tabular}"=Umgebung mit einer \PValue{l}"~Spalte
1005 anstelle von \PValue{X} verwendet werden.
1006
1007 \minisec{Eigener Stil mit \Environment*{tabu}}
1008 Die sehr komfortabel zu nutzende Umgebung \Environment{tabu}(\Package{tabu})
1009 wird durch das Paket \Package{tabu} bereitgestellt. Es wird später in
1010 \autoref{sec:tabu} vorgestellt, wobei die dortigen Anmerkungen \emph{unbedingt}
1011 zu beachten sind. Für die bereits verwendeten
1012 \Environment{tabularx}(\Package{tabularx})"=Tabellen muss generell eine feste
1013 Tabellenbreite angegeben werden. Die Breite der \PValue{X}"~Spalten wird anhand
1014 der angegebenen Gesamtbreite und dem für andere Spalten vom
1015 Typ~\PValue{l},~\PValue{r}~und~\PValue{c} benötigten Platz berechnet.
1016
1017 Wie \Environment{tabularx}(\Package{tabularx}) bietet auch die Umgebung
1018 \Environment{tabu}(\Package{tabu}) einen \PValue{X}"~Spaltentyp. Für diese kann
1019 jedoch anstelle einer fest vorgegebenen Breite auch \PValue{spread~0pt}
1020 angegeben werden. Dadurch werden \PValue{X}"~Spalten anfänglich in ihrer
1021 natürlichen Breite gesetzt. Sobald jedoch die Gesamtbreite der Tabelle den zur
1022 Verfügung stehenden Platz bis zum Zeilenende überschreiten würde, werden die
1023 \PValue{X}"~Spalten automatisch umbrochen.
1024
1025 In umbrochenen Spalten gibt es beim Paket \Package{tabu} jedoch ein kleineres
1026 Problem. In diesen setzt \Package{tabu} zu wenig vertikalen Leerraum am unteren
1027 Ende. Um dieses Manko zu beheben, wird am Schluss jeder \PValue{X}"~Spalte mit
1028 \PValue{X<\PParameter{\Macro{strut}}} einfach der Befehl \Macro{strut}
1029 angehängt, der vertikalen Leerraum ober- und unterhalb der aktuellen Grundlinie
1030 einfügt. In \autoref{sec:tables} wird ein Ansatz aufgezeigt, wie dies
1031 automatisiert über einen neuen Spaltenstil ausgemerzt werden kann. Der Rest des
1032 Stils ist identisch zu \PValue{acrotabularx}.
1033 %
1034 \CodeHook{\let\newglossarystyle\renewglossarystyle}
1035 \begin{Preamble*}
1036 \newglossarystyle{acrotabu}{%
1037 \renewenvironment{theglossary}{%
1038 \begin{tabu}{@{}lX<{\strut}l@{}}% 'spread 0pt' defekt in v2.9
1039 }{%
1040 \end{tabu}\par\bigskip%
1041 }%
1042 \renewcommand*{\glossaryheader}{}%
1043 \renewcommand*{\glsgroupheading}[1]{}%
1044 \renewcommand*{\glsgroupskip}{}%
1045 \renewcommand*{\glossentry}[2]{%
1046 \glsentryitem{##1}% Entry number if required
1047 \glstarget{##1}{\sffamily\bfseries\glossentryname{##1}} &
1048 \glsentrydesc{##1} &
1049 ##2\tabularnewline
1050 }
1051 }
1052
1053 \end{Preamble*}
1054 \begin{Hint}
1055 \printacronyms[style=acrotabu]
1056 \end{Hint}
1057 \begin{quoting}[rightmargin=0pt]
1058 \glsdisablehyper
1059 \InputCode
1060 \end{quoting}
1061 %
1062 Welche Variante gewählt wird, ist letztendlich eine Frage, was für spezifische
1063 Anforderungen an die Formatierung des Abkürzungsverzeichnis gestellt werden.
1064 Natürlich ist auch die Definition eines eigenen Stils möglich. Wenn Sie wissen
1065 wollen, wie Sie einen Stil in Tabellenform erstellen können, welcher einen
1066 Seitenumbruch zulässt, sollte Sie den nächsten Abschnitt lesen.
1067
1068
1069 \subsubsection{Symbolverzeichnis}
1070 Für das Erzeugen eines Symbolverzeichnisses kann ebenfalls \Package{glossaries}
1071 verwendet werden. Allerdings muss dazu ein wenig mehr Aufwand getrieben werden,
1072 da das Paket hierfür keine dedizierte Schnittstelle bereitstellt. Wurde die
1073 Paketoption \Option{symbols}(\Package{glossaries}) angegeben wird jedoch
1074 zumindest das notwendige Glossar erstellt.
1075
1076 Als erstes sollte ein gut nutzbarer Befehl zum Definieren eines neuen Symbols
1077 erstellt werden. In Anlehnung an den Befehl für Abkürzungen \Macro*{newacronym}
1078 wird er \Macro{newformulasymbol}|?| genannt. Dieser hat ein optionales und vier
1079 obligatorische Argumente, wobei das optionale Argument prinzipiell alle
1080 Schlüssel"~Wert"~Paare enthalten kann, die durch das Paket \Package{glossaries}
1081 akzeptiert werden. Welche davon letztlich auch Auswirkungen haben, hängt
1082 allerdings von der Gestaltung des Stils durch den Anwender ab. Der Befehl hat
1083 folgende Definition:
1084 %
1085 \begin{quoting}[leftmargin=\parindent]
1086 \Macro{newformulasymbol}[%
1087 \LParameter\Parameter{Label}\Parameter{Name}%
1088 \Parameter{Symbol}\Parameter{Einheit}%
1089 ]|?|%
1090 \end{quoting}
1091 %
1092 Mit \PName{Label} erfolgt die eindeutige Kennzeichnung des Symbols. Außerdem
1093 wird dies standardmäßig für die Sortierung verwendet, was unter Umständen etwas
1094 problematisch sein könnte. In diesem Fall ist eine manuelle Festlegung für den
1095 dazugehörigen Schlüssel durch den Anwender über das optionale Argument mit
1096 \PValue{sort=}\PName{Sortierung} eventuell sinnvoll. Nach dem \PName{Label}
1097 schließt der \PName{Name} für das Formelzeichen an, gefolgt vom \PName{Symbol}
1098 sowie der dazugehörige physikalische \PName{Einheit}.
1099 %
1100 \CodeHook{\let\newcommand\renewcommand}
1101 \begin{Preamble*}
1102 \newcommand*{\newformulasymbol}[5][]{%
1103 \newglossaryentry{#2}{%
1104 type=symbols,%
1105 name={#3},%
1106 description={\nopostdesc},%
1107 symbol={\ensuremath{#4}},%
1108 user1={\ensuremath{\mathrm{#5}}},%
1109 sort={#2},%
1110 #1%
1111 }%
1112 }
1113
1114 \end{Preamble*}
1115 %
1116 Da es sich zumeist um mathematische Symbole handelt, wird für das Symbol und
1117 die Einheit mit \Macro{ensuremath} Sorge getragen, dass diese auch im
1118 Textmodus ohne Probleme verwendet werden können. Für das aufrechte Setzen der
1119 Einheit wird für diese außerdem \Macro{mathrm} verwendet. Als Alternative dazu
1120 könnte der Befehl \Macro{si}(\Package{siunitx}) aus dem Paket \Package{siunitx}
1121 genutzt werden. Für ein kleines Beispiel werden folgend fünf Formelzeichen
1122 definiert. Damit die Darstellung der mathematischen Brüche auch für den
1123 Fließtext gut genutzt werden kann und ansehnlich ist, wird für diese der Befehl
1124 \Macro{sfrac}(\Package{xfrac}) aus dem Paket \Package{xfrac} genutzt.
1125 %
1126 \begin{Trunk*}
1127 \newformulasymbol{l}{Länge}{l}{m}
1128 \newformulasymbol{m}{Masse}{m}{kg}
1129 \newformulasymbol{a}{Beschleunigung}{a}{\sfrac{m}{s^2}}
1130 \newformulasymbol{t}{Zeit}{t}{s}
1131 \newformulasymbol{f}{Frequenz}{f}{s^{-1}}
1132 \newformulasymbol{F}{Kraft}{F}{m \cdot kg \cdot s^{-2} = \sfrac{J}{m}}
1133
1134 \end{Trunk*}
1135 %
1136 Die soeben definierten Symbole werden für ein kleines Beispiel mit dem Befehl
1137 \Macro{gls}[\Parameter{Label}](\Package{glossaries}) in einer kurzen
1138 Textpassage verwendet.
1139 %
1140 \begin{Hint*}
1141 Die Einheiten für die \gls{f} sowie die \gls{F} werden aus den
1142 SI"=Einheiten der Basisgrößen \gls{l}, \gls{m} und \gls{t} abgeleitet.
1143 Und dann gibt es noch die Grundgleichung der Mechanik, welche für den
1144 Fall einer konstanten Kraftwirkung in die Bewegungsrichtung einer
1145 Punktmasse lautet:
1146 \[\gls{F} = \gls{m} \cdot \gls{a}\]
1147 \end{Hint*}
1148 %
1149 Das Ergebnis ist nur bedingt befriedigend. Sowohl im Fließtext als auch im
1150 Mathematikmodus werden lediglich die Bezeichnungen jedoch nicht die Symbole
1151 selbst verwendet. Damit die Formelzeichen auch für den mathematischen Satz
1152 sinnvoll nutzbar sind, sollte das Erscheinungsbild der Einträge mit
1153 \Macro{defglsentryfmt}(\Package{glossaries}) angepasst werden.
1154 %
1155 \begin{Preamble*}
1156 \defglsentryfmt[symbols]{%
1157 \ifmmode%
1158 \glssymbol{\glslabel}%
1159 \else%
1160 \glsgenentryfmt~\glsentrysymbol{\glslabel}%
1161 \fi%
1162 }
1163 \end{Preamble*}
1164 %
1165 Bei der Verwendung von \Macro{gls}[\Parameter{Label}](\Package{glossaries})
1166 führt diese Definition dazu, dass im Mathematikmodus allein das Symbol
1167 verwendet wird. Im Fließtext wird diesem zusätzlich die Bezeichnung
1168 vorangestellt. Das nachfolgende Beispiel macht dies deutlich.
1169 %
1170 \begin{Trunk*}
1171 Die Einheiten für die \gls{f} sowie die \gls{F} werden aus den
1172 SI"=Einheiten der Basisgrößen \gls{l}, \gls{m} und \gls{t} abgeleitet.
1173 Und dann gibt es noch die Grundgleichung der Mechanik, welche für den
1174 Fall einer konstanten Kraftwirkung in die Bewegungsrichtung einer
1175 Punktmasse lautet:
1176 \[\gls{F} = \gls{m} \cdot \gls{a}\]
1177
1178 \end{Trunk*}
1179 %
1180 Als nächstes kümmern wir uns um die Ausgabe des Symbolverzeichnisses. Momentan
1181 erzeugt der Befehl \Macro{printsymbols}(\Package{glossaries}) jedenfalls kein
1182 sinnvolles Verzeichnis:
1183 %
1184 \begin{Hint}
1185 \printsymbols
1186 \end{Hint}
1187 \begin{quoting}[rightmargin=0pt]
1188 \glsdisablehyper
1189 \printsymbols[style=simple]
1190 \end{quoting}
1191 %
1192 Für dieses muss erst ein Stil definiert werden, was nachfolgend ähnlich zum
1193 Stil \PValue{acrotabularx} respektive \PValue{acrotabu} geschieht. Allerdings
1194 wird hier eine Variante gezeigt, mit der die Tabelle einen Seitenumbruch
1195 zulässt.
1196
1197 \minisec{Eigener Stil mit \Environment*{tabularx} und \Environment*{longtable}}
1198 Soweit mir bekannt ist, lassen sich umbruchfähige Tabellen nicht direkt mit
1199 \Environment{tabularx}(\Package{tabularx}) setzen. Vielmehr ist für die
1200 Verwendung der Umgebung \Environment{longtable}(\Package{longtable}) das Paket
1201 \Package{ltxtable} notwendig. Dieses wiederum verlangt, dass die zu setzende
1202 Tabelle in einer separaten Datei abgelegt wird. Soll diese dennoch innerhalb
1203 des Hauptdokumentes erstellt werden, kann für dieses Unterfangen die Umgebung
1204 \Environment{filecontents}(\Package{filecontents}) aus dem gleichnamigen Paket
1205 genutzt werden, womit \emph{bereits existierende Dateien} überschrieben werden.
1206
1207 Leider habe ich keine Möglichkeit gefunden, diesen Prozess ohne wahnsinnig
1208 großen Aufwand für das Erstellen eines Glossars zu portieren. Für umbruchfähige
1209 Tabellen mit automatisch berechneten Spaltenbreiten kommt meines Wissens nach
1210 momentan nur die Umgebung \Environment{longtabu}(\Package{tabu}) aus dem Paket
1211 \Package{tabu} infrage.
1212
1213 \minisec{Eigener Stil mit \Environment*{longtabu}}
1214 Das Paket \Package{tabu} definiert für umbruchfähige Tabellen die Umgebung
1215 \Environment{longtabu}(\Package{tabu}), welche wiederum auf der Umgebung
1216 \Environment{longtable}(\Package{longtable}) basiert und nachfolgend verwendet
1217 wird. Damit diese linksbündig gesetzt wird, muss vor dem obligatorischen
1218 Argument mit den Spaltendefinitionen noch das optionale Argument \OParameter{l}
1219 angegeben werden. Die im nachfolgend definierten Stil verwendeten Befehle
1220 \Macro{toprule}(\Package{booktabs}), \Macro{midrule}(\Package{booktabs}) sowie
1221 \Macro{cmidrule}(\Package{booktabs}) und \Macro{bottomrule}(\Package{booktabs})
1222 für unterschiedliche horizontale Linien stammen allesamt aus dem Paket
1223 \Package{booktabs}, welches für den Satz von hochwertigen Tabellen eine große
1224 Hilfe ist.
1225 %
1226 \CodeHook{\let\newglossarystyle\renewglossarystyle}
1227 \begin{Preamble*}
1228 \newglossarystyle{symblongtabu}{%
1229 \renewenvironment{theglossary}{%
1230 \begin{longtabu}[l]{ccX<{\strut}l}% 'spread 0pt' defekt in v2.9
1231 }{%
1232 \end{longtabu}%
1233 }%
1234 \renewcommand*{\glsgroupheading}[1]{}%
1235 \renewcommand*{\glsgroupskip}{}%
1236 \renewcommand*{\glossaryheader}{%
1237 \toprule
1238 \bfseries Symbol & \bfseries Einheit &
1239 \bfseries Bezeichnung & \bfseries Seite(n)
1240 \tabularnewline\midrule\endhead%
1241 \bottomrule\endfoot%
1242 }%
1243 \renewcommand*{\glossentry}[2]{%
1244 \glsentryitem{##1}% Entry number if required
1245 \glstarget{##1}{\glossentrysymbol{##1}} &
1246 \glsentryuseri{##1} &
1247 \glossentryname{##1} &
1248 ##2\tabularnewline%
1249 }%
1250 }
1251 \end{Preamble*}
1252 %
1253 Innerhalb von \Macro{newglossarystyle}(\Package{glossaries}) wird der Befehl
1254 \Macro{glossaryheader}(\Package{glossaries}) für einen Tabellenkopf definiert,
1255 wie er auch für eine \Environment{longtable}(\Package{longtable})"=Umgebung
1256 erscheinen würde. In hier vorgestellten Fall werden der Kopf mit dem Makro
1257 \Macro{endhead}(\Package{longtable}) beziehungsweise der Fuß durch
1258 \Macro{endfoot}(\Package{longtable}) terminiert. Diese werden beim
1259 einem möglichen Seitenumbruch zu Beginn und am Ende auf jeder Seite gesetzt.
1260 %
1261 \begin{Preamble+}
1262 }% Ende von AfterPackage
1263
1264 \end{Preamble+}
1265 %
1266 Das Symbolverzeichnis kann sich nun durchaus sehen lassen.
1267 %
1268 \begin{Hint}
1269 \printsymbols[style=symblongtabu]
1270 \end{Hint}
1271 \begin{quoting}[rightmargin=0pt]
1272 \newglossarystyle{symbtabu}{%
1273 \setglossarystyle{symblongtabu}%
1274 \renewenvironment{theglossary}{%
1275 \begin{tabu}{ccX<{\strut}l}% 'spread 0pt' defekt in v2.9
1276 }{%
1277 \bottomrule\end{tabu}%
1278 }%
1279 \renewcommand*{\glossaryheader}{%
1280 \toprule
1281 \bfseries Symbol & \bfseries Einheit &
1282 \bfseries Bezeichnung & \bfseries Seite(n)
1283 \tabularnewline\midrule%
1284 }%
1285 }
1286 \printsymbols[style=symbtabu]
1287 \end{quoting}
1288
1289 \minisec{Unterteilung nach griechischen und lateinischen Symbolen}
1290 Oftmals wird es für Abschlussarbeiten verlangt, das Symbolverzeichnis nach
1291 griechischen und lateinischen Formelzeichen zu untergliedern. Für die Umsetzung
1292 dieser Anforderung ist die zuvor beschriebene Lösung prinzipiell nutzbar,
1293 allerdings muss diese etwas erweitert werden.
1294
1295 Realisiert wird das Ganze, indem die zwei Kategorien respektive Elterneinträge
1296 \PValue{greekletters} sowie \PValue{romanletters} definiert und sämtliche
1297 Formelzeichen einem der beiden als Untereintrag zugeordnet werden.
1298 %
1299 \begin{Hint*}
1300 \providecommand*\greeklettersname{Greek letters}
1301 \providecommand*\romanlettersname{Roman letters}
1302 \newglossaryentry{greekletters}{%
1303 type=symbols,%
1304 name={\greeklettersname},%
1305 description={\nopostdesc},%
1306 sort={a}%
1307 }
1308 \newglossaryentry{romanletters}{%
1309 type=symbols,%
1310 name={\romanlettersname},%
1311 description={\nopostdesc},%
1312 sort={b}%
1313 }
1314 \end{Hint*}
1315 %
1316 Die Bezeichnungen der beiden Kategorien könnten auch als Parameter von
1317 \Macro*{newglossaryentry} mit \PValue{name=\PName{Bezeichung}} direkt
1318 eingetragen werden. Um bei der Definition jedoch eine gewisse Flexibilität zu
1319 gewährleisten, wird dies über die zwei Befehle \Macro*{greeklettersname} sowie
1320 \Macro*{romanlettersname} realisiert. Diese werden mit \KOMAScript-Mitteln
1321 als sprachabhängige Bezeichner definiert.
1322 %
1323 \begin{Hint*}
1324 \providecaptionname{%
1325 american,australian,british,canadian,english,newzealand%
1326 }{\greeklettersname}{Greek letters}
1327 \providecaptionname{%
1328 german,ngerman,austrian,naustrian,swissgerman,nswissgerman%
1329 }{\greeklettersname}{Griechische Symbole}
1330 \providecaptionname{%
1331 american,australian,british,canadian,english,newzealand%
1332 }{\romanlettersname}{Roman letters}
1333 \providecaptionname{%
1334 german,ngerman,austrian,naustrian,swissgerman,nswissgerman%
1335 }{\romanlettersname}{Lateinische Symbole}
1336 \end{Hint*}
1337 %
1338 Für die Ausgabe wird der Glossarstil \PValue{symbsplitlongtabu} in ähnlicher
1339 Manier wie die Stile zuvor definiert. Dieser wird darauf ausgelegt, dass alle
1340 aufzulistenden Formelzeichen als Untereintrag von einem der beiden zuvor
1341 erstellten Elterneinträge angegeben werden. Allerdings ist bei diesem Stil
1342 aufgrund der Verwendung von \Environment{longtabu}(\Package{tabu}) etwas
1343 Aufwand zu betreiben, um die gewünschte Ausgabe zu erhalten. Das grundlegende
1344 Problem ist das Setzen von Überschriften und dem folgenden Tabellenkopf
1345 innerhalb der Tabelle. Die Erläuterung des Quelltextauszugs erfolgt nach dessen
1346 Ausgabe.
1347 %
1348 \CodeHook{\let\newglossarystyle\renewglossarystyle}
1349 \begin{Hint*}
1350 \newglossarystyle{symbsplitlongtabu}{%
1351 \newcommand*\symbollevel{-1}%
1352 \renewenvironment{theglossary}{%
1353 \begin{longtabu}[l]{ccX<{\strut}l}% 'spread 0pt' defekt in v2.9
1354 }{%
1355 \end{longtabu}%
1356 }%
1357 \renewcommand*{\glsgroupheading}[1]{}%
1358 \renewcommand*{\glsgroupskip}{}%
1359 \newcommand*\symbolhead{%
1360 \toprule
1361 \bfseries Symbol & \bfseries Einheit &
1362 \bfseries Bezeichnung & \bfseries Seite(n)
1363 \tabularnewline\midrule
1364 }%
1365 \renewcommand*{\glossaryheader}{%
1366 \endfirsthead%
1367 \symbolhead\endhead%
1368 \bottomrule\endfoot%
1369 \gdef\symbollevel{-1}%
1370 }%
1371 \renewcommand*{\glossentry}[2]{%
1372 \ifglshaschildren{##1}{%
1373 \ifnum\symbollevel>0\relax%
1374 \tabularnewline\bottomrule\tabularnewline[\smallskipamount]%
1375 \fi
1376 \gdef\symbollevel{0}%
1377 \tabularnewline[%
1378 \arraystretch\dimexpr-\ht\strutbox-\dp\strutbox\relax%
1379 ]%
1380 \multicolumn{4}{@{}l@{}}{\minisec{\glsentryname{##1}}}%
1381 }{%
1382 \GlossariesWarning{%
1383 There are no childrens for entry ##1.\MessageBreak
1384 Nothing will be printed. Maybe you should\MessageBreak
1385 specify ##1 as a child entry.
1386 }%
1387 }%
1388 }%
1389 \renewcommand*{\subglossentry}[3]{%
1390 \ifnum\symbollevel=0\relax%
1391 \tabularnewline[\medskipamount]\symbolhead%
1392 \else%
1393 \tabularnewline
1394 \fi%
1395 \gdef\symbollevel{##1}%
1396 \glsentryitem{##2}% Entry number if required
1397 \glstarget{##2}{\glossentrysymbol{##2}} &
1398 \glsentryuseri{##2} &
1399 \glossentryname{##2} &
1400 ##3%
1401 }%
1402 }
1403 \end{Hint*}
1404 %
1405 Der neu definierte Befehl \Macro*{symbollevel} wird benötigt, um bei der
1406 Ausgabe zu überprüfen, um es sich beim zuletzt gesetzten Eintrag um einen
1407 Elterneintrag (\Macro*{glossentry}) oder Untereintrag (\Macro*{subglossentry})
1408 gehandelt hat. Im Makro \Macro*{symbolhead} wird die Definition für den zu
1409 setzenden Tabellenkopf gespeichert. Der Inhalt von \Macro*{glossaryheader} wird
1410 direkt zu Beginn der Umgebung \Environment{theglossary}(\Package{glossaries})
1411 ausgeführt. Dieser wird so umdefiniert, dass die Tabelle keinen Kopf vor der
1412 ersten Überschrift erhält, jedoch nach einem Seitenumbruch sehr wohl der
1413 Tabellenkopf gesetzt wird. Abgeschlossen wird die Tabelle mit einer Fußlinie.
1414
1415 Danach erfolgt die Formatierung der Einträge. Der Befehl \Macro*{glossentry}
1416 setzt \enquote{\greeklettersname} und \enquote{\romanlettersname} sowie
1417 gegebenenfalls weitere Elterneinträge als Überschriften. Bevor dies passieren
1418 kann wird eine vorher begonnene Tabelle mit einer Fußlinie beendet. Um die
1419 Überschrift innerhalb von \Environment{longtabu}(\Package{tabu}) linksbündig zu
1420 setzen, wird mit \Macro*{multicolumn} gearbeitet. Dieser Befehl muss in der
1421 ersten Zelle zwingend als aller erstes genutzt werden. Um dies sicherzustellen,
1422 wird zuvor eine neue Tabellenspalte eingefügt. Damit jedoch kein zusätzlicher
1423 Leerraum entsteht, wird diese über das optionale Argument nach oben verschoben.
1424 Die Einträge für Formelzeichen selber erfolgen mit \Macro*{subglossentry}. Im
1425 Gegensatz zum vorher beschriebenen Stil \PValue{symblongtabu} wird zusätzlich
1426 der notwendige Tabellenkopf nach der Überschrift gesetzt, falls es sich um den
1427 \emph{ersten} Untereintrags handelt.
1428
1429 Jetzt könnte man den Glossarstil \PValue{symbsplitlongtabu} bereits verwenden
1430 und jedem Formelzeichen bei der Definition mit
1431 \begin{quoting}[leftmargin=\parindent]
1432 \Macro{newformulasymbol}[%
1433 \POParameter{parent={greekletters/romanletters}}%
1434 \PParameter{\dots}\PParameter{\dots}\PParameter{\dots}\PParameter{\dots}%
1435 ]|?|%
1436 \end{quoting}
1437 eine der beiden Elterneinträge zuweisen. Für wenige Formelzeichen mag dies
1438 ausreichen. Komfortabler wäre es natürlich, wenn die Zuweisung zu einer der
1439 beiden Kategorien automatisch erfolgen würde. Ein Ansatz für dieses Unterfangen
1440 wird folgend vorgestellt.
1441
1442 \Attention{%
1443 Es kann nicht garantiert werden, dass dieser Ansatz in jedem Fall und für
1444 sämtliche Anwendungsszenarien funktioniert. Tatsächlich ist die Idee auf eine
1445 \hrfn{http://latex.wcms-file3.tu-dresden.de/phpBB3/viewtopic.php?f=11&t=427}{%
1446 Frage aus dem \Forum*%
1447 }
1448 heraus entstanden. Für auftretende Probleme bei der Verwendung ist dort der
1449 beste Anlaufpunkt.
1450 }
1451
1452 Die Grundidee ist, das zu definierende Formelzeichen mit einer Liste der Makros
1453 für griechische Buchstaben abzugleichen und so zu entscheiden, in welche der
1454 beiden Kategorien das Symbol einzuordnen ist. Hierfür werden nachfolgend eine
1455 Liste \Macro*{greeksymbollist} aller griechischen Buchstaben sowie der Befehl
1456 \Macro*{ifisgreeksymbol}[\Parameter{Symbol}\Parameter{Dann}\Parameter{Sonst}]
1457 zur Fallunterscheidung definiert. Problematisch bei der Umsetzung ist, dass ein
1458 als Argument übergebenes Formelzeichen auch mit diakritischen Zeichen und
1459 Indizes verwendet werden kann~-- beispielsweise $\dot{\varphi}_{\mathrm{max}}$
1460 (%
1461 \Macro*{dot}[\PParameter{\Macro*{varphi}}]\PValue{\textunderscore}%
1462 \PParameter{\Macro*{mathrm}[\PParameter{max}]}%
1463 ). Deshalb werden bei der Ausführung von \Macro*{ifisgreeksymbol} temporär alle
1464 diakritische Zeichen sowie \Macro*{boldsymbol} für den Mathematikmodus
1465 \enquote{unschädlich} gemacht und das Argument \Parameter{Symbol} expandiert.
1466 Anschließend werden alle Anteile für Hoch- sowie Tiefstellung abgeschnitten und
1467 das Resultat mit der Liste \Macro*{greeksymbollist} abgeglichen.
1468 %
1469 \CodeHook{\let\newcommand\renewcommand}
1470 \begin{Hint*}
1471 \makeatletter
1472 \newcommand*\greeksymbollist{}
1473 \def\@tempa#1{\ifdefvoid{#1}{}{\listadd\greeksymbollist{#1}}}
1474 \forcsvlist{\@tempa}{%
1475 \alpha,\beta,\varbeta,\gamma,\delta,\epsilon,\varepsilon,\zeta,%
1476 \eta,\theta,\vartheta,\iota,\kappa,\varkappa,\lambda,\mu,\nu,%
1477 \xi,\omicron,\pi,\varpi,\rho,\varrho,\sigma,\varsigma,\tau,%
1478 \upsilon,\phi,\varphi,\chi,\psi,\omega,%
1479 \Alpha,\Beta,\Gamma,\Delta,\Epsilon,\Zeta,\Eta,\Theta,\Iota,%
1480 \Kappa,\Lambda,\Mu,\Nu,\Xi,\Omicron,\Pi,\Rho,\Sigma,\Tau,\Upsilon,%
1481 \Phi,\Chi,\Psi,\Omega%
1482 }
1483 \newcommand*\ifisgreeksymbol[1]{%
1484 \begingroup%
1485 \def\@tempa##1{\let##1\@firstofone}%
1486 \forcsvlist{\@tempa}{%
1487 \acute,\bar,\breve,\check,\dot,\ddot,\dddot,\ddddot,%
1488 \hat,\widehat,\grave,\tilde,\widetilde,\vec,%
1489 \Acute,\Bar,\Breve,\Check,\Dot,\Ddot,\Hat,\Grave,\Tilde,\Vec%
1490 }%
1491 \def\boldsymbol{}%
1492 \protected@edef\@tempa{#1}%
1493 \def\@tempb##1_##2\relax{\def\@tempa{##1}}%
1494 \expandafter\@tempb\@tempa_\relax\relax%
1495 \def\@tempb##1^##2\relax{\def\@tempa{##1}}%
1496 \expandafter\@tempb\@tempa^\relax\relax%
1497 \expandafter\ifinlist\expandafter{\@tempa}{\greeksymbollist}{%
1498 \aftergroup\@firstoftwo%
1499 }{%
1500 \aftergroup\@secondoftwo%
1501 }%
1502 \endgroup%
1503 }
1504 \makeatother
1505 \end{Hint*}
1506 %
1507 Mit \Macro*{ifisgreeksymbol} kann jetzt auf die Art des Symbols getestet. Dies
1508 wird innerhalb von \Macro{newformulasymbol}|?| genutzt, um den passenden
1509 Elterneintrag auszuwählen. Über das optionale Argument kann jederzeit mit
1510 \POParameter{parent={greekletters/romanletters}} der automatische ermittelte
1511 Elterneintrag überschrieben werden.
1512 %
1513 \begin{Hint}
1514 \newcommand*\symbollettergroup{}
1515 \newcommand*{\newformulasymbol}[5][]{%
1516 \ifisgreeksymbol{#4}{%
1517 \renewcommand*{\symbollettergroup}{greekletters}%
1518 }{%
1519 \renewcommand*{\symbollettergroup}{romanletters}%
1520 }%
1521 \newglossaryentry{#2}{%
1522 type=symbols,%
1523 name={#3},%
1524 description={\nopostdesc},%
1525 symbol={\ensuremath{#4}},%
1526 user1={\ensuremath{\mathrm{#5}}},%
1527 sort={#2},%
1528 parent={\symbollettergroup},%
1529 #1%
1530 }%
1531 }
1532 \end{Hint}
1533
1534
1535 \subsection{Literaturverzeichnis}
1536 \label{sec:biblatex}%
1537 %
1538 Für das Erstellen eines Literaturverzeichnisses wurde in der Vergangenheit fast
1539 ausschließlich \hologo{BibTeX} verwendet. Leider wird auch heute immer noch
1540 darauf verwiesen, obwohl es seit einigen Jahren das Paket \Package{biblatex}
1541 gibt, welches insbesondere für neue Dokumente den Vorzug erhalten sollte. Auch
1542 die Umstellung älterer \hologo{BibTeX}"=Datenbanken ist mit wenigen Handgriffen
1543 realisierbar. Für \Package{biblatex} existieren eine Menge unterschiedlicher,
1544 vordefinierter Zitierstile, welche sich im Vergleich zu \hologo{BibTeX} auch
1545 wesentlich leichter an die individuellen Bedürfnisse anpassen lassen.
1546
1547 Ein weiterer Vorteil ist die Unterstützung von Datenbanken, welche eine
1548 UTF"~8"~Kodierung nutzen, wenn \Application{biber} zur Sortierung der Einträge
1549 verwendet wird. Zitierstil und Backend zur Sortierung lassen sich durch das
1550 optionale Argument beim Laden des Paketes festlegen. Damit die Zitierstile das
1551 optimale Ergebnis erzielen wird das Laden von \Package{csquotes} sehr empfohlen.
1552 %
1553 \begin{Preamble}
1554 \usepackage{csquotes}
1555 \usepackage[backend=biber,style=alphabetic]{biblatex}
1556
1557 \end{Preamble}
1558 %
1559 Die Erstellung einer Literaturdatenbank kann entweder von Hand oder mithilfe
1560 einer externen Anwendung erfolgen. Für die letztgenannte Variante sind die
1561 Programme \Application{Citavi} respektive \Application{JabRef} empfehlenswert.
1562 Auf eine Einführung in diese Anwendungen wird jedoch verzichtet.
1563
1564 Die \Environment{filecontents}(\Package{filecontents})"=Umgebung kann verwendet
1565 werden, um innerhalb eines \hologo{LaTeX}"=Dokumentes externe Dateien direkt
1566 beim Kompilieren zu erstellen. Damit wird nachfolgend für dieses Tutorial eine
1567 Literaturdatenbank \File{\jobname-temp.bib} mit drei Einträgen manuell erzeugt.
1568 Die Umgebung gehört standardmäßig zu den Bordmitteln von \hologo{LaTeXe}. Das
1569 Paket \Package{filecontents} erweitert die Umgebung dahingehend, dass
1570 \emph{bereits existierende Dateien} überschrieben werden. Hier ist folglich
1571 Vorsicht geboten. Der große Vorteil ist jedoch, dass die erweiterte
1572 \Environment{filecontents}(\Package{filecontents})"=Umgebung~-- im Gegensatz
1573 zur Standardversion~-- die Dateien in der gleichen Eingabekodierung erzeugt,
1574 wie das verwendete Dokument. Diese Funktionalität wird für dieses Tutorial
1575 benötigt, weshalb auf das Laden des Paketes \Package{filecontents} nicht
1576 verzichtet werden kann.
1577 %
1578 \begin{Preamble}
1579 \usepackage{filecontents}
1580 \end{Preamble}
1581 %
1582 Folgend wird eine Literaturdatenbank mit drei Einträge definiert. Jeder Eintrag
1583 einer \File*{.bib}"~Datei beginnt mit \PValue{@}\PName{Eintragstyp}. Direkt
1584 danach ist für jeden Eintrag ein \emph{eindeutiges} \PParameter{Label}
1585 festzulegen. Anschließend können für unterschiedliche Felder die dazugehörigen
1586 Werte eingetragen werden. Die verwendbaren Eintragstypen sowie die für den
1587 jeweiligen Typ obligatorischen und optionalen Felder sind in der Dokumentation
1588 von \Package{biblatex} zu finden.
1589 %
1590 \begin{Preamble*}
1591 \begin{filecontents}{\jobname-temp.bib}
1592 @book{goossens94,
1593 author = {Goossens, Michel and Mittelbach, Frank
1594 and Samarin, Alexander},
1595 title = {The LaTeX Companion},
1596 date = {1994},
1597 publisher = {Addison-Wesley},
1598 location = {Reading, Massachusetts},
1599 language = {english},
1600 }
1601 @book{knuth84,
1602 author = {Knuth, Donald E.},
1603 title = {The \TeX book},
1604 date = {1984},
1605 maintitle = {Computers \& Typesetting},
1606 publisher = {Addison-Wesley},
1607 location = {Reading, Massachusetts},
1608 language = {english},
1609 }
1610 @manual{hanisch14,
1611 author = {Hanisch, Falk},
1612 title = {Ein \LaTeX"=Bundle für Dokumente im neuen Corporate
1613 Design der Technischen Universität Dresden},
1614 date = {2014},
1615 subtitle = {Benutzerhandbuch},
1616 location = {Dresden},
1617 language = {german},
1618 }
1619 \end{filecontents}
1620 \end{Preamble*}
1621 %
1622 Nachdem die Literaturdatenbank erstellt wurde, muss diese auch noch eingebunden
1623 werden:
1624 %
1625 \begin{Preamble}
1626 \addbibresource{\jobname-temp.bib}
1627
1628 \end{Preamble}
1629 %
1630 Im einfachsten Fall werden die gewünschten Einträge der Literaturdatenbank im
1631 Dokument mit \Macro{cite}[\Parameter{macro}](\Package{biblatex}) referenziert,
1632 von \Package{biblatex} werden zusätzliche Möglichkeiten angeboten.
1633 %
1634 \begin{refsection}[\jobname-temp.bib]
1635 \begin{Trunk+}
1636 \section{Referenzen und das Literaturverzeichnis}
1637 Das Literaturverzeichnis wird auf Basis der nachfolgend verwendeten
1638 Zitate erstellt und ist auf Seite~\pageref{sec:bibliography} zu finden.
1639 \end{Trunk+}
1640 \begin{Trunk*}
1641 In diesem Textabschnitt werden die zwei bekannten \LaTeX-Bücher
1642 \cite{knuth84} und \cite{goossens94} sowie das Anwenderhandbuch
1643 \cite{hanisch14} zitiert.
1644
1645 \end{Trunk*}
1646 %
1647 Das Literaturverzeichnis wird mit \Macro{printbibliography}(\Package{biblatex})
1648 ausgegeben, wobei nicht alle Einträge der Literaturdatenbank sondern lediglich
1649 die tatsächlich referenzierten verwendet werden. Der Parameter
1650 \PValue{heading=bibintoc} führt zu einem Eintrag in das Inhaltsverzeichnis.
1651 %
1652 \begin{Hint}
1653 \printbibliography[heading=bibintoc]
1654 \end{Hint}
1655 \begin{quoting}[rightmargin=0pt]
1656 \makeatletter
1657 \let\markboth\@gobbletwo
1658 \let\markright\@gobble
1659 \makeatother
1660 \printbibliography
1661 \end{quoting}
1662 \end{refsection}
1663
1664
1665
1666 \section{Anfangszitat oder Schlauer Spruch}
1667 \renewcommand*\dictumwidth{.4\textwidth}%
1668 \dictum[Johann Wolfgang von Goethe]{Es irrt der Mensch, solang er strebt.}%
1669 \bigskip\noindent
1670 Oftmals möchte der Autor einer wissenschaftlichen Arbeit für das erste oder
1671 auch jedes Kapitel ein Zitat oder ähnliches voranstellen. Dies kann mit dem
1672 Befehl \Macro{dictum}[\OParameter{Autor}\Parameter{Text}](\Package{koma-script})
1673 erfolgen. Damit wird der im obligatorischen Argument angegeben Ausspruch in
1674 einer \Macro{parbox} ausgegeben. Das optionale Argument kann für die Angabe des
1675 Autors verwendet werden. Soll das Ganze für einen Teil oder ein Kapitel
1676 erfolgen, sollte der Befehl \Macro{dictum}(\Package{koma-script}) innerhalb von
1677 \Macro{setpartpreamble}(\Package{koma-script}) beziehungsweise
1678 \Macro{setchapterpreamble}(\Package{koma-script}) verwendet werden. Genaueres
1679 hierzu und zu den weiteren Möglichkeiten, die Gestalt eines Zitats zu
1680 beeinflussen, ist in der \scrguide[Anleitung von \KOMAScript] zu finden. Es
1681 folgt ein Beispiel zur Verwendung.
1682 %
1683 \begin{Hint}
1684 \setchapterpreamble{%
1685 \dictum[Johann Wolfgang von Goethe]{%
1686 Es irrt der Mensch, solang er strebt.%
1687 }%
1688 \bigskip
1689 }
1690 \chapter{Einleitung}
1691
1692 \end{Hint}
1693
1694
1695
1696 \section{Gleitumgebungen für Abbildungen und Tabellen}
1697 \label{sec:floats}%
1698 %
1699 Die Positionierung von Abbildungen mit \hologo{LaTeX} kann zu Beginn für viele
1700 Anfänger durchaus frustrierend sein. Das liegt häufig am Missverständnis der
1701 beiden Standard"=Gleitobjektumgebungen für Tabellen (\Environment{table}) und
1702 Abbildungen (\Environment{figure}). Diese sind in erster Linie zur Ergänzung
1703 des Fließtextes gedacht und sollten für das prinzipielle Verständnis des
1704 Geschriebenen nicht notwendig sein. Das oft geforderte Verhalten, ein
1705 Gleitobjekt an einer ganz bestimmten und explizit festgelegten Position im Text
1706 zu setzen, ist nicht erforderlich, insbesondere weil dadurch der Lesefluss
1707 unnötig unterbrochen wird.
1708
1709 Vielmehr ist es sinnvoll, Gleitobjekte entweder am Anfang oder Ende einer Seite
1710 zu platzieren, wo sie den Lesefluss deutlich weniger stören. Allerdings sollte
1711 auf jedes Gleitobjekt im Fließtext über eine Referenz~-- beispielsweise mit dem
1712 Befehl \Macro{autoref}(\Package{hyperref}) aus dem Paket \Package{hyperref}~--
1713 Bezug genommen und gegebenenfalls eine kurze Erläuterung gegeben werden.
1714 Zusätzliche Erläuterungen zum Thema \emph{Querverweise} sind unter
1715 \autoref{sec:references} zu finden.
1716
1717 Ein weitere Grund, \hologo{LaTeX} die Platzierung von Tabellen und Abbildungen
1718 vollständig zu überlassen, ist die Ungewissheit über den vorhandenen Platz auf
1719 der momentan erzeugten Seite. In nicht wenigen Fällen kann es passieren, dass
1720 das einzufügende Objekt zu groß für die aktuelle Seite ist, was einen wahrlich
1721 schlechten Seitenumbruch mit einer schlecht gefüllten Seite zur Folge hätte.
1722 Die Verwendung einer Gleitumgebung für eine Abbildung wird im nachfolgenden
1723 Quelltextauszug exemplarisch gezeigt, das Ergebnis ist in \autoref{fig:example}
1724 zu sehen. Bei Gleitobjekten sollte in jedem Fall darauf geachtet werden, dass
1725 der Befehl \Macro{label} immer erst \emph{nach}
1726 \Macro{caption}(\Package{koma-script},\Package{caption}) verwendet wird, da
1727 der erzeugte Anker sich sonst nicht auf das Objekt bezieht.
1728 %
1729 \begin{Trunk+}
1730 \section{Grafiken und Tabellen in Gleitumgebungen}
1731 Es folgt die Demonstration von Gleitumgebungen, welche sowohl für
1732 Grafiken als auch Tabellen verwendet werden sollten. Im vorliegenden
1733 Beispiel kann unter Umständen der Eindruck entstehen, dass diese Seite
1734 etwas zu überladen mit Gleitobjekten ist. Dies liegt nicht an der
1735 Verwendung der Gleitobjekte sondern vielmehr am zu geringen Textvolumen
1736 und den eingeschränkten Möglichkeiten von \LaTeX{}, diese an geeigneten
1737 Stellen zu platzieren.
1738
1739 \subsection{Abbildungen als Gleitobjekte und das Einbinden von Grafiken}
1740 In \autoref{fig:example} wird dargestellt, wie eine Grafik im PDF"~Format
1741 in ein Dokument eingebunden und auf diese verwiesen werden kann. Ein
1742 Querverweis auf ein Gleitobjekt sollte im Fließtext am besten mit Befehl
1743 \texttt{\textbackslash autoref\{\emph{<Label>}\}} erstellt werden.
1744 Hierfür ist ein entsprechender Anker am zu referenzierenden Objekt nötig,
1745 welcher mit dem Makro \texttt{\textbackslash label} erzeugt wird. Dabei
1746 ist entscheidend, dass dieser Anker erst \emph{nach} der Beschriftung des
1747 Objektes, welche mit \texttt{\textbackslash caption} zu erstellen ist,
1748 definiert werden sollte.
1749
1750 \end{Trunk+}
1751 \begin{Trunk}
1752 \begin{figure}
1753 \centering
1754 \includegraphics{TUD-black}
1755 \caption{Beispielgrafik}\label{fig:example}
1756 \end{figure}
1757
1758 \end{Trunk}
1759 \InputCode\noindent
1760 %
1761 In der Konsequenz ist dies hier ein Plädoyer, bei der Platzierung von Tabellen
1762 und Abbildungen vollständig auf \hologo{LaTeX} zu vertrauen. Anfangs kann der
1763 Anwender dies als Kontrollverlust empfinden. Sobald Sie jedoch Änderungen am
1764 Dokument vornehmen und eventuell in einem Kapitel einen Absatz ergänzen oder
1765 gar einen ganzen Abschnitt hinzufügen werden sie dankbar sein, sich in der
1766 Folge nicht mit der Neupositionierung sämtlicher Objekte herumschlagen zu
1767 müssen. Leidgeprüfte Anwender einschlägiger Textverarbeitungsprogramme können
1768 gewiss ein Lied darüber singen.
1769
1770
1771
1772 \subsection{Gleitobjektlayout}
1773 \label{sec:floatlayout}%
1774 %
1775 Es wurde bis jetzt das prinzipielle Vorgehen bei der Nutzung von Gleitobjekten
1776 beschrieben. Allerdings gibt es auch noch einige typografische Aspekte, welche
1777 zu beachten sind. Zum einen sollte beachtet werden, dass die Beschriftung einer
1778 Abbildung immer unterhalb dieser erfolgen sollte, bei Tabellen hingegen eine
1779 Überschrift gesetzt wird. Hierfür muss der Anwender ohne die Verwendung eines
1780 zusätzlichen Paketes selber Sorge tragen, indem er den Befehl
1781 \Macro{caption}(\Package{koma-script},\Package{caption}) entweder vor oder
1782 nach dem eigentlichen Objekt in der Gleitumgebung verwendet. Der zweite Punkt
1783 ist die verwendete Schrift innerhalb der Gleitumgebungen.
1784
1785 Damit sich der Inhalt dieser besser vom restlichen Fließtext abhebt und vom
1786 Leser direkt als nicht dazugehörig erkannt werden kann ist es ratsam, diesen in
1787 serifenloser Schrift zu setzen~-- die Verwendung einer Serifenschrift für den
1788 Fließtext vorausgesetzt. Das Paket \Package{floatrow} bietet die Möglichkeiten,
1789 diese beiden Punkte automatisiert umzusetzen. Außerdem wird zur Formatierung
1790 der Beschriftungen das Paket \Package{caption} benötigt. Sollten Sie noch keine
1791 Erfahrung mit dem Setzen von Tabellen mit \hologo{LaTeX} haben, so wäre zuvor
1792 ein Blick in \autoref{sec:tables} sehr sinnvoll.
1793
1794 \newcommand*\tableexample[1][]{%
1795 \begin{tabularx}{.75\textwidth}{@{}XXX@{}}
1796 \toprule
1797 \textbf{Erste Spalte} & \textbf{Zweite Spalte} &
1798 \textbf{Dritte Spalte} \tabularnewline\midrule
1799 Etwas Blindtext für die erste Spalte &
1800 Etwas Blindtext für die zweite Spalte &
1801 Etwas Blindtext für die dritte Spalte
1802 \tabularnewline\bottomrule
1803 \end{tabularx}
1804 #1%
1805 }
1806 \begin{table}
1807 \tableexample[%
1808 \caption{Eine Tabelle in einer Gleitumgebung}\label{tab:tabular}%
1809 ]
1810 \end{table}
1811
1812 Normalerweise wird eine Tabelle sowie deren Beschriftung innerhalb einer
1813 \Environment{table}"=Gleitumgebung in der selben Schrift wie der Fließtext
1814 gesetzt, die korrekte Platzierung der Bezeichnungen bleibt dem Anwender
1815 überlassen. Zu sehen ist dies in \autoref{tab:tabular}. Im Folgenden wird
1816 gezeigt, wie sich dies automatisiert für alle Gleitobjekte im Dokument ändern
1817 lässt. Die \emph{Formatierung} der Bezeichnungen von Gleitobjekten kann
1818 mithilfe des Paketes \Package{caption} angepasst werden.
1819 %
1820 \begin{Preamble}
1821 \usepackage{caption}
1822 \end{Preamble}
1823 %
1824 Diese stellt den Befehl \Macro{captionsetup}(\Package{caption}) bereit. Mit
1825 diesem werden die Beschriftungen in Serifenlosen und das Label zur besseren
1826 Unterscheidung im fetter Schriftstärke gesetzt.
1827 %
1828 \begin{Preamble*}
1829 \captionsetup{font=sf,labelfont=bf,labelsep=space}
1830 \end{Preamble*}
1831 %
1832 Um die \emph{Platzierung} der Beschriftungen beeinflussen sowie den Inhalt
1833 einer Gleitumgebung formatieren zu können, wird \Package{floatrow} geladen.
1834 \begin{Preamble}
1835 \usepackage{floatrow}
1836 \end{Preamble}
1837 %
1838 Der Inhalt von Gleitobjekten wird~-- entgegen des normalen Verhaltens~-- durch
1839 \Package{floatrow} automatisch zentriert gesetzt. Zusätzlich soll der Inhalt
1840 noch die serifenlose Schriftfamilie verwenden. Dies lässt sich mit der Nutzung
1841 des Befehls \Macro{floatsetup}(\Package{floatrow}) realisieren.
1842 %
1843 \begin{Preamble*}
1844 \floatsetup{font=sf}
1845 \end{Preamble*}
1846 %
1847 Ohne weitere Maßnahmen werden durch \Package{floatrow} alle Beschriftungen
1848 unterhalb der Gleitobjekte ausgegeben. Da das Ziel jedoch die Verwendung von
1849 Tabellenüberschriften und Abbildungsunterschriften ist, wird dies für Tabellen
1850 angepasst.
1851 %
1852 \begin{Preamble*}
1853 \floatsetup[table]{style=plaintop}
1854 \end{Preamble*}
1855 %
1856 \begin{table}
1857 \tableexample[%
1858 \caption{%
1859 Eine Tabelle in einer Gleitumgebung mit einer angepassten Formatierung%
1860 }%
1861 \label{tab:tabularnew}%
1862 ]
1863 \end{table}%
1864 %
1865 Damit wären alle Einstellungen soweit erfolgt, in \autoref{tab:tabularnew} ist
1866 das Ergebnis zu sehen. Zumeist soll die Beschriftung für Gleitobjekte nicht
1867 zentriert sondern linksbündig gesetzt werden. Dies lässt sich ebenfalls mit den
1868 Mitteln des Paketes \Package{caption} und der passenden Paketoption
1869 \Option{justification}(\Package{caption}) erreichen. Damit dies auch für
1870 einzeilige Beschriftungen angewendet wird, muss zusätzlich die Einstellung
1871 \Option{singlelinecheck}(\Package{caption}) deaktiviert werden. Mit der
1872 Paketoption \Option{format}(\Package{caption}) kann außerdem beeinflusst
1873 werden, ob eine mehrzeilige Beschriftung nach einem Zeilenumbruch direkt unter
1874 dem Label oder mit Einzug fortgesetzt werden soll.
1875 %
1876 \begin{Preamble*}
1877 \captionsetup{singlelinecheck=off,format=hang,justification=raggedright}
1878 \end{Preamble*}
1879 %
1880 In \autoref{tab:tabularnew} fällt die Beschriftung auf, welche die Breite der
1881 Tabelle überragt. Falls linksbündige Gleitumgebungsbezeichnungen verwendet
1882 werden, wie dies gerade eingestellt wurde, besteht das Problem quasi bei jeder
1883 Beschriftung, da diese immer am linken Seitenrand beginnen. Auch hierfür stellt
1884 das Paket \Package{floatrow} die Befehle \Macro{ttabbox}(\Package{floatrow})
1885 für Tabellen sowie \Macro{ffigbox}(\Package{floatrow}) für Abbildungen bereit.
1886
1887 Beide Makros erwarten im ersten obligatorischen Argument den Befehl
1888 \Macro{caption}(\Package{koma-script},\Package{caption}) für die Beschriftung
1889 gegebenenfalls gefolgt von einem mit \Macro{label} gesetzten Textanker. Im
1890 zweiten Argument wird das Objekt selbst~-- sprich Tabelle oder Abbildung~--
1891 angegeben. Zu verwenden sind diese folgendermaßen:
1892 %
1893 \begin{Hint}
1894 \begin{table}
1895 \ttabbox
1896 §\Parameter{Tabellendefinition}§
1897 {\caption§\Parameter{Beschriftung}§\label§\Parameter{Label}§}
1898 \end{table}
1899 \begin{figure}
1900 \ffigbox
1901 §\Parameter{Abbildungsdefinition}§
1902 {\caption§\Parameter{Beschriftung}§\label§\Parameter{Label}§}
1903 \end{figure}
1904 \end{Hint}
1905 %
1906 Diese beiden Befehle sorgen dafür, dass die Beschriftungen in der jeweiligen
1907 Breite des Objektes gesetzt werden. Entspricht das zu setzende Objekt in seiner
1908 Breite dem Wert \Length{textwidth}~-- es ist genauso Breit wie die Laufweite
1909 des Fließtextes~--, so ist deren Gebrauch nicht notwendig. Das Ergebnis der
1910 Verwendung von des Befehls \Macro{ttabbox}(\Package{floatrow}) ist in
1911 \autoref{tab:tabularbox} zu sehen.
1912
1913 Bei der Nutzung der beiden Befehle sollte darauf geachtet werden, dass zwischen
1914 dem Ende des Objektes und der schließender Klammer des zweiten Argumentes kein
1915 ungewolltes Leerzeichen gesetzt wird. Dies lässt sich leicht vermeiden, indem
1916 direkt nach dem Ende des Objektes mit \Macro*{end}[\PParameter{tabularx}],
1917 \Macro*{end}[\PParameter{tabu}], \Macro*{end}[\PParameter{tikz}] etc. die
1918 schließende Klammer des zweiten Argumentes oder das Zeichen für einen Kommentar
1919 \PValue{\%} folgt.
1920
1921 \begin{table}
1922 \ttabbox{\tableexample}{%
1923 \caption[%
1924 Eine mit \Macro{ttabbox}(\Package{floatrow}) gesetzte Tabelle in einer
1925 Gleitumgebung%
1926 ]{%
1927 Eine in einer Gleitumgebung gesetzte Tabelle in Verbindung mit dem Befehl
1928 \Macro{ttabbox}(\Package{floatrow}), der durch das Paket \Package{floatrow}
1929 für Beschriftungen in Objektbreite zur Verfügung gestellt wird%
1930 }%
1931 \label{tab:tabularbox}%
1932 }
1933 \end{table}
1934
1935
1936 \subsection{Untergleitobjekte}
1937 \label{sec:subfloats}%
1938 %
1939 Das Paket \Package{floatrow} stellt allerhand Möglichkeiten zur Erstellung von
1940 nebeneinanderliegenden Gleitobjekten sowie \enquote{Untergleitobjekten} bereit
1941 und ist insbesondere in Verbindung mit den Fähigkeiten von \Package{caption}
1942 respektive \Package{subcaption} sehr gut für dieses Unterfangen nutzbar. Dafür
1943 werden die Umgebungen \Environment{floatrow}(\Package{floatrow}) sowie
1944 \Environment{subfloatrow}(\Package{floatrow}) angeboten, wobei die letztere für
1945 ein Beispiel verwendet wird. Als erstes muss der Typ der zu erzeugenden Labels
1946 für Abbildungen und Tabellen definiert werden. Dies geschieht mit dem Befehl
1947 \Macro{DeclareCaptionSubType}(\Package{subcaption}) aus dem Paket
1948 \Package{subcaption}.
1949 %
1950 \begin{Preamble}
1951 \DeclareCaptionSubType[alph]{figure}
1952 \DeclareCaptionSubType[alph]{table}
1953 \end{Preamble}
1954 %
1955 Anschließend werden die Untergleitobjekte formatiert. Dabei wird zum einen nach
1956 dem alphanumerischen Label eine schließende Klammer gesetzt. Zum andern wird
1957 ein Eintragen der Untergleitobjekte in das Abbildungsverzeichnis unterdrückt.
1958 Lediglich die Bildunterschrift der Hauptabbildung wird in dieses eingetragen.
1959 %
1960 \begin{Preamble*}
1961 \captionsetup[subfloat]{labelformat=brace,list=off}
1962
1963 \end{Preamble*}
1964 %
1965 Mit diesen Einstellungen wird eine gleitende Abbildung erstellt, welche in
1966 \autoref{fig:logos} zu sehen ist. Wurde der entsprechende Anker gesetzt, kann
1967 zusätzlich auf die untergeordnete \autoref{fig:tud} sowie \autoref{fig:ddc}
1968 verwiesen werden.
1969 %
1970 \begin{Trunk+}
1971 \subsection{Untergleitobjekte}
1972 Nachdem nun schon eine gleitende Abbildung und zwei gleitende Tabellen
1973 erstellt wurden, folgt jetzt noch eine gleitende Abbildung mit zwei
1974 Unterabbildungen. Durch die drei gesetzten Anker kann im Fließtext
1975 sowohl auf \autoref{fig:logos} als auch auf \autoref{fig:tud} sowie
1976 \autoref{fig:ddc} verwiesen werden.
1977
1978 \end{Trunk+}
1979 \begin{Trunk}
1980 \begin{figure}
1981 \ffigbox[\FBwidth]%
1982 {\begin{subfloatrow}%
1983 \ffigbox[\FBwidth]%
1984 {\fbox{\includegraphics[height=2cm]{TUD-black}}}%
1985 {\caption{Eine Abbildung}\label{fig:tud}}%
1986 \ffigbox[\FBwidth]%
1987 {\fbox{\includegraphics[height=2cm]{DDC-21}}}%
1988 {\caption{Eine weitere Abbildung}\label{fig:ddc}}%
1989 \end{subfloatrow}}%
1990 {\caption{Eine Gleitumgebung mit zwei Abbildungen}\label{fig:logos}}%
1991 \end{figure}
1992
1993 \end{Trunk}
1994 \InputCode
1995
1996
1997 \subsection{Beeinflussung des Gleitprozesses}
1998 Sobald das Dokument inhaltlich den finalen Zustand erreicht hat, haben Sie sich
1999 zu diesem Zeitpunkt schon mit Sicherheit an das standardmäßige Vorgehen von
2000 \hologo{LaTeX} gewöhnt und müssen respektive wollen gegebenenfalls nur noch bei
2001 wenigen Gleitobjekten~-- über das optionale Argument der Gleitumgebungen zur
2002 individuellen Empfehlung für die Platzierung~-- nachjustieren. Mögliche Werte
2003 sind:
2004 %
2005 \begin{description}[labelindent=\parindent,leftmargin=*,style=nextline]
2006 \item[\POParameter{h} (here)]
2007 An der Stelle, wo es im Quelltext angegeben wurde~-- falls genügend Platz
2008 vorhanden ist
2009 \item[\POParameter{t} (top)]
2010 Am oberen Ende der aktuellen oder der folgenden Seite
2011 \item[\POParameter{b} (bottom)]
2012 Am unteren Ende der aktuellen Seite
2013 \item[\POParameter{p} (page)]
2014 Auf einer separaten Seite für mindestens ein Gleitobjekt
2015 \end{description}
2016 %
2017 Sie können eine, mehrere oder alle Optionen angeben, wobei die Reihenfolge
2018 keine Rolle spielt. Der Algorithmus arbeitet alle ihm zur Verfügung gestellten
2019 Optionen immer in der zuvor aufgezählten Reihenfolge ab, wobei diese nur als
2020 Empfehlung und nicht als Verpflichtung angesehen werden. Es gibt folglich keine
2021 Garantie, dass Ihr Vorschlag akzeptiert wird. Fügen sie dem optionalen Argument
2022 ein~\PValue{!} an, so verhindern Sie, dass \hologo{LaTeX} weitere Optionen
2023 evaluiert. Das Gleitobjekt wird anhand der optionalen Parameter positioniert,
2024 selbst wenn dabei ein unschönes Seitenlayout entsteht. Kann das Gleitobjekt
2025 technisch unmöglich auf die angegebene Weise positioniert werden, wird dieses
2026 sowie alle folgenden aufgeschoben und am Ende des Abschnitts oder Kapitels
2027 angehängt. Dieser Effekt ist wohl in den seltensten Fällen gewollt.
2028
2029 Außerdem können die Pakete \Package{flafter} sowie \Package{placeins} genutzt
2030 werden. Das erstgenannte verhindert das Auftreten von Gleitobjekten im Dokument
2031 vor ihrer Definition im Quelltext. In der Konsequent bedeutet dies, dass die
2032 Option \POParameter{t} Gleitobjekte nur am oberen Ende der nächsten Seite
2033 jedoch nicht auf der aktuellen zulässt. Mit dem zweiten Paket können Barrieren
2034 definiert werden, an welchen die Ausgabe aller noch in der Warteschlange
2035 befindlichen Gleitobjekte forciert wird~-- beispielsweise vor bestimmten
2036 Gliederungsüberschriften. Im Handbuch zu \TUDScript findet sich außerdem zum
2037 Thema \enquote{\tudhyperref{sec:tips:floats}{Platzierung von Gleitobjekten}}
2038 ein eigener Abschnitt mit weiterführenden Informationen.
2039
2040
2041 \subsection{Abstellen des Gleitprozesses}
2042 Trotz der zuvor genannten Vorteile von Gleitobjekten wird oftmals verlangt, den
2043 Gleitprozess vollständig abzustellen. Dies bringt jedoch in den meisten Fällen
2044 einige Probleme mit sich. Die Folge sind ein sehr unruhiges Erscheinungsbild
2045 des Satzspiegels aufgrund schlecht gefüllter Seiten, außerdem im Zweifelsfall
2046 viel Handarbeit mit hart kodierten Seitenumbrüchen sowie daraus resultierend
2047 ein gegenüber von Umbruchänderungen äußerst anfälliges Dokument. Sollte es in
2048 \emph{Einzelfällen} dennoch erforderlich sein, dass eine Abbildung oder Tabelle
2049 nicht gleitet, ist die einzig logische Konsequenz, auf die Verwendung einer
2050 Gleitumgebung gänzlich zu verzichten.
2051
2052 Hierfür eignet sich beispielsweise die Umgebung \Environment{center}, welche
2053 zum einen etwas Abstand vor und nach dem Objekt zum umgebenden Text erzeugt
2054 und zum anderen die Grafik respektive Tabelle und die dazugehörige Bezeichnung
2055 zusammenhält. \KOMAScript{} stellt für diesen Anwendungsfall das Makro
2056 \Macro{captionof}(\Package{koma-script}) für die Beschriftung zur Verfügung.
2057 Werden die Pakete \Package{caption} und \Package{hyperref} geladen, sollte
2058 weiterhin \Macro{caption}(\Package{koma-script},\Package{caption}) ergänzt um
2059 ein zuvor aufgerufenes
2060 \Macro{captionsetup}[\PParameter{type=figure/table}](\Package{caption})
2061 genutzt werden. Damit lassen sich Bildunter- sowie Tabellenüberschriften auch
2062 ohne die bekannten Gleitumgebungen \Environment{figure} respektive
2063 \Environment{table} erzeugen. Das Vorgehen wird folgend demonstriert, in
2064 \autoref{fig:nonfloating-A} ist das Ergebnis zu sehen.
2065 %
2066 \begin{Hint}
2067 \begin{center}
2068 \captionsetup{type=figure}
2069 \includegraphics{TUD-black}
2070 \caption{Eine nichtgleitende Grafik in einer \texttt{center}"=Umgebung}
2071 \label{fig:nonfloating-A}
2072 \end{center}
2073
2074 \end{Hint}
2075 \InputCode\noindent
2076 %
2077 Alternativ zu diesem Ansatz kann das Paket \Package{float} zum Einsatz kommen,
2078 welches für Gleitumgebungen den Platzierungsparameter \POParameter{H}
2079 bereitstellt. Das Resultat ist identisch zu \autoref{fig:nonfloating-A}.
2080 %
2081 \begin{Hint}
2082 \begin{figure}[H]
2083 \includegraphics{TUD-black}
2084 \caption{Eine nichtgleitende Grafik in einer \texttt{figure}"=Umgebung}
2085 \label{fig:nonfloating-B}
2086 \end{figure}
2087
2088 \end{Hint}
2089 %
2090 Mit den Mitteln des Paketes \Package{floatrow} lässt sich eine etwas bessere
2091 Variante entwickeln, wobei für eine mehrmalige Anwendung ein eigenes Makro mit
2092 den passenden Argumenten definiert werden sollte. Zum besseren Verständnis des
2093 Quelltextauszuges ist die Dokumentation von \Package{floatrow} zu beachten.
2094 %
2095 \begin{Hint}
2096 \floatbox[\captionsetup{type=figure}]{figure}[\FBwidth][%
2097 \dimexpr\FBheight+\abovedisplayskip\relax%
2098 ][b]{\includegraphics{TUD-black}}{%
2099 \caption{%
2100 Eine nichtgleitende Grafik mit \texttt{\textbackslash floatbox}%
2101 }%
2102 \label{fig:nonfloating-C}%
2103 }
2104 \end{Hint}
2105 \InputCode\noindent
2106 %
2107 Es wird hier trotz der vorhergehenden Ausführungen abermals ausdrücklich
2108 empfohlen, Tabellen und Abbildungen in Gleitumgebungen zu setzen und die
2109 korrekte Platzierung dem \hologo{LaTeX}"=Algorithmus zu überlassen.
2110
2111
2112
2113
2114 \section{Tabellensatz}
2115 \label{sec:tables}%
2116 %
2117 Zum Thema \enquote{Tabellensatz mit \hologo{LaTeX}} sind bereits zahlreiche
2118 \hrfn{http://userpage.fu-berlin.de/latex/Materialien/tabsatz.pdf}{Leitfäden}
2119 \cite{reichert2012} im Internet zu finden. Deshalb werde ich meine Ausführungen
2120 zu diesem Punkt relativ kurz halten. Zwei Regeln sollten beim Satz von Tabellen
2121 in jedem Fall beachtet werden:
2122 %
2123 \begin{enumerate}[%
2124 itemindent=0pt,noitemsep,%
2125 labelwidth=*,labelsep=1em,label=\Roman*.%
2126 ]
2127 \item keine vertikalen Linien
2128 \item keine doppelten Linien
2129 \end{enumerate}
2130 %
2131 Das Paket \Package{booktabs} ist für den Satz von hochwertigen Tabellen eine
2132 große Hilfe und stellt die Befehle \Macro{toprule}(\Package{booktabs}),
2133 \Macro{midrule}(\Package{booktabs}) sowie \Macro{cmidrule}(\Package{booktabs})
2134 und \Macro{bottomrule}(\Package{booktabs}) für unterschiedliche horizontale
2135 Linien bereit.
2136 %
2137 \begin{Preamble}
2138 \usepackage{booktabs}
2139 \end{Preamble}
2140 %
2141 Außerdem existiert das Paket \Package{array}, welches mit dem Befehl
2142 \Macro{newcolumntype}(\Package{array}) die Definition eigener Spaltentypen
2143 sowie die Verwendung von \enquote{Hooks} vor (\PValue{>\PParameter{\dots}}) und
2144 nach (\PValue{<\PParameter{\dots}}) Einträgen innerhalb einer Spalte
2145 (\PValue{>\PParameter{\dots}}\PName{Spaltentyp}\PValue{<\PParameter{\dots}})
2146 ermöglicht.
2147 %
2148 \begin{Preamble}
2149 \usepackage{array}
2150 \end{Preamble}
2151 %
2152 Für alle im Folgenden vorgestellten Umgebungen zum Setzen von Tabellen gilt,
2153 dass die Inhalte zeilenweise angegeben werden, wobei die Einträge für die
2154 einzelnen Spalten mit~\PValue{\&} voneinander zu trennen sind. Das Beenden
2155 einer Tabellenzeile und der Wechsel zur nächsten erfolgt normalerweise mit
2156 \PValue{\textbackslash\textbackslash}. Da jedoch einige \hologo{LaTeX}"=Pakete
2157 diesen Befehl innerhalb von Tabellen lokal ändern ist es zur Vermeidung
2158 unnötiger Fehler wesentlich sicherer, das Zeilenende ausschließlich mit
2159 \Macro{tabularnewline} zu setzen.
2160
2161 Im Folgenden wird in einigen Tabellen bei der Definition der Spalten vor der
2162 ersten und nach der letzten das Konstrukt~\PValue{@\PParameter{}} verwendet,
2163 was das \tudhyperref{sec:tips:table}{Einrücken der Tabellenspalten verhindert}
2164 und im Handbuch genauer erläutert wird.
2165
2166
2167 \subsection{Die Standardumgebung \Environment*{tabular}}
2168 Normalerweise gibt es für \Environment{tabular} vier unterschiedliche
2169 Spaltentypen. Die drei Spaltentypen~\PValue{l},~\PValue{c}~und~\PValue{r}
2170 stehen für linksbündige, zentrierte und rechtsbündige Spalten zu Verfügung,
2171 welche allerdings keinen Zeilenumbruch erlauben. Der Inhalt wird quasi wie in
2172 einer \Macro{mbox} gesetzt, wodurch die Spalten sehr breit werden und über den
2173 Seitenrand hinausragen können.
2174
2175 Der Spaltentyp~\PValue{p}\Parameter{Breite} hingegen legt die Spaltenbreite
2176 fest und setzt die Zellinhalte in einer \Macro{parbox}, wobei diese mit ihrer
2177 obersten Zeile an der Grundlinie ausgerichtet wird. Das Paket \Package{array}
2178 stellt außerdem die Spaltentypen~\PValue{m}\Parameter{Breite}
2179 und~\PValue{b}\Parameter{Breite} bereit, welche ebenfalls mit \Macro{parbox}
2180 gesetzt werden, die Ausrichtung an der Grundlinie jedoch zentriert respektive
2181 an der unteren Zeile erfolgt. Es folgt ein Beispiel zur Nutzung der
2182 \Environment{tabular}"=Umgebung.
2183 %
2184 \begingroup
2185 \pcolumnfuzz{70pt}
2186 \begin{Hint*}
2187 \begin{tabular}{lcrp{33mm}}
2188 \toprule
2189 \textbf{Linksbündig} & \textbf{Zentriert} &
2190 \textbf{Rechtsbündig} & \textbf{Blocksatz} \tabularnewline\midrule
2191 a & b & c & Dieser Text wird im Blocksatz gesetzt\tabularnewline
2192 aa & bb & cc & Auch Zeilenumbrüche sind vorhanden\tabularnewline
2193 aaa & bbb & ccc & Worttrennungsmusterkontrolle\tabularnewline
2194 \bottomrule
2195 \end{tabular}
2196 \end{Hint*}
2197 \endgroup
2198 %
2199 Die Tabellenbreite ergibt sich aus der Breite der einzelnen Spalten. Bei dieser
2200 Umgebung liegt es allein beim Anwender, auf die korrekte Breite der Tabelle zu
2201 achten, damit diese nicht über die Seitenränder hinausragt. Das kann auf Dauer
2202 recht aufwändig werden. Das Festlegen der Gesamtbreite einer Tabelle und das
2203 automatische Berechnen einiger oder aller Spaltenbreiten ist sicher die
2204 angenehmere Variante. Wie sich dies sehr komfortabel bewerkstelligen lässt,
2205 wird~-- ebenso wie die Lösung des Problems eines nicht umbrochenen Eintrags wie
2206 in der letzten Spalte der dritten Zeile der obigen Tabelle~-- im nachfolgenden
2207 Abschnitt demonstriert.
2208
2209
2210 \subsection{Tabellen mit variabler Spaltenbreite}
2211 Die Pakete \Package{tabularx}, \Package{tabulary} oder auch \Package{tabu}
2212 stehen für das Setzen von Tabellen mit dynamisch berechneter Spaltenbreite bei
2213 fest vorgegebener Gesamtbreite zur Verfügung, welche nun kurz vorgestellt
2214 werden sollen. Die beiden erstgenannte Pakete \Package{tabularx} sowie
2215 \Package{tabulary} stammen vom gleichen Paketautor und haben sich als sehr
2216 stabil erwiesen. Das Paket \Package{tabu} ist relativ neu und versucht, viele
2217 Funktionalitäten ganz unterschiedlicher Pakete für den Tabellensatz in sich zu
2218 vereinen und glänzt insbesondere durch seine Vielseitigkeit.
2219 %
2220 \begin{Preamble}
2221 \usepackage{tabularx}
2222 \usepackage{tabulary}
2223 \usepackage{tabu}
2224 \usepackage{longtable}
2225
2226 \end{Preamble}
2227 %
2228 Jedes der Pakete stellt einen oder mehrere neue Spaltentypen zur Verfügung.
2229 Dies bedeutet jedoch nicht, dass in den dazugehörigen Tabellenumgebungen
2230 lediglich diese genutzt werden können. Vielmehr werden diese zusätzlich
2231 angeboten, was bedeutet, dass auch in den neuen Tabellenumgebungen weiterhin
2232 die gewohnten Spaltentypen~\PValue{l},~\PValue{c},~\PValue{r}~und~\PValue{p}
2233 verfügbar sind.
2234
2235 \subsubsection{Die Tabellenumgebung \Environment*{tabularx}}
2236 \label{sec:tabularx}%
2237 %
2238 Das Paket \Package{tabularx} stellt den Spaltentyp~\PValue{X} bereit, welcher
2239 prinzipiell dem Spaltentyp~\PValue{p} entspricht. Auch für diesen wird eine
2240 \Macro{parbox} verwendet, allerdings wird deren Breite \emph{automatisch}
2241 berechnet. Die Umgebung \Environment{tabularx}(\Package{tabularx}) erwartet vor
2242 der Spaltentypenangabe als obligatorisches Argument die gewünschte Breite der
2243 Tabelle. Spalten vom Typ~\PValue{l},~\PValue{c}~und~\PValue{r} werden jedoch
2244 weiterhin \emph{ohne} Zeilenumbruch gesetzt werden. Nur für Spalten vom
2245 Typ~\PValue{X} und deren Derivate wird aus dem verbliebenen Platz die Breite
2246 berechnet. Für die \Environment{tabularx}(\Package{tabularx})"~Umgebung wird
2247 das vorherige Beispiel wiederholt.
2248 %
2249 \begingroup
2250 \pcolumnfuzz{70pt}
2251 \begin{Hint*}
2252 \begin{tabularx}{11.7cm}{lcrX}
2253 \toprule
2254 \textbf{Linksbündig} & \textbf{Zentriert} &
2255 \textbf{Rechtsbündig} & \textbf{Blocksatz} \tabularnewline\midrule
2256 a & b & c & Dieser Text wird im Blocksatz gesetzt\tabularnewline
2257 aa & bb & cc & Auch Zeilenumbrüche sind vorhanden\tabularnewline
2258 aaa & bbb & ccc & Worttrennungsmusterkontrolle\tabularnewline
2259 aaaa & bbbb & cccc & \hspace{0pt}Worttrennungsmusterkontrolle
2260 \tabularnewline\bottomrule
2261 \end{tabularx}
2262 \end{Hint*}
2263 \endgroup
2264 %
2265 Die Breite der letzten Spalte wurde dabei aus der Angabe der Gesamtbreite mit
2266 \PValue{11.7cm} berechnet. Des Weiteren ist zu sehen, wie das Problem des
2267 Zeilenumbruchs behandelt werden kann. Normalerweise wird das erste Wort in
2268 einem Absatz von \hologo{LaTeX} \emph{nie} umbrochen. Dies kann durch das
2269 Einfügen eines breitenlosen Leerzeichens mit \Macro{hspace}[\PParameter{0pt}]
2270 umgangen werden. Die gefundene Lösung ist allerdings alles andere als elegant.
2271
2272 Mit den Möglichkeiten des Paketes \Package{array} ist das Problem relativ
2273 schnell gelöst. Es wird mit \Macro{newcolumntype}(\Package{array}) ein neuer
2274 Spaltentyp definiert. Das erste Argument legt den Namen des Spaltentyps fest.
2275 Mit \PValue{>\Parameter{Definitionen}}\Parameter{Typ} wird im zweiten Argument
2276 das Ausführen von \PName{Definitionen} vor dem Setzen des eigentlichen Inhaltes
2277 in einer \Parameter{Typ}"~Spalte definiert. Es wird ein neuer, auf der
2278 \PValue{X}"~Spalte basierender Typ~\PValue{Y} definiert, welcher zu Beginn der
2279 Spalte den Phantomabstand automatisch einfügt. Darauf basierend werden drei
2280 Spaltentypen für den links- und rechtsbündigen sowie zentrierten Textsatz mit
2281 einem möglichen Zeilenumbruch erstellt.
2282 %
2283 \begin{Trunk+}
2284 \subsection{Tabellen als Gleitobjekte}
2285 Tabellen sollten in der \texttt{table}"=Gleitumgebung gesetzt werden.
2286 Welche Umgebung für die Tabelle selbst dabei genutzt wird ist dabei
2287 nicht relevant. Es können sowohl die normale \texttt{tabular}"=Umgebung
2288 als auch die Umgebungen \texttt{tabularx}, \texttt{tabulary} sowie
2289 \texttt{tabu} für variable Spaltenbreiten bei einer fest vorgegebenen
2290 Tabellenbreite oder jede andere Tabellenumgebung genutzt werden.
2291 Nachfolgend wird dies an mehreren Beispielen demonstriert.
2292
2293 \subsubsection{Eine gleitende tabularx-Tabelle}
2294 Es wird eine Tabelle mithilfe der \texttt{tabularx}"=Umgebung erstellt.
2295 Zu sehen ist diese in \autoref{tab:tabularx}. Für diese werden zuvor
2296 neue Spaltentypen definiert.
2297
2298 \end{Trunk+}
2299 \CodeHook{\renewcommand*{\newcolumntype}[2]{}}
2300 \begin{Trunk*}
2301 \newcolumntype{Y}{>{\hspace{0pt}}X}
2302 \newcolumntype{D}{>{\raggedright}Y}
2303 \newcolumntype{E}{>{\centering}Y}
2304 \newcolumntype{F}{>{\raggedleft}Y}
2305
2306 \end{Trunk*}
2307 %
2308 Nachfolgend wird die Tabelle gesetzt mit den neuen Spaltentypen gesetzt.
2309 %
2310 \begin{Trunk}
2311 \begin{table}
2312 \begin{tabularx}{\textwidth}{@{}DEFY@{}}
2313 \toprule
2314 \textbf{Linksbündig} & \textbf{Zentriert} &
2315 \textbf{Rechtsbündig} & \textbf{Blocksatz} \tabularnewline
2316 \midrule
2317 Ein linksbündiger Blindtext zur Demonstration einer S"~Spalte &
2318 Ein zentrierter Blindtext zur Demonstration einer T"~Spalte &
2319 Ein rechtsbündiger Blindtext zur Demonstration einer U"~Spalte &
2320 Ein längerer Blindtext im Blocksatz zur besseren Demonstration
2321 einer Y"~Spalte\tabularnewline
2322 \bottomrule
2323 \end{tabularx}
2324 \caption{Eine \texttt{tabularx}"=Tabelle}\label{tab:tabularx}
2325 \end{table}
2326
2327 \end{Trunk}
2328 \InputCode\noindent
2329 %
2330 Die Breite der einzelnen \PValue{X}"~Spalten und deren Derivaten ist dabei
2331 identisch. Ein Gewichten der Spaltenbreiten untereinander ist prinzipiell
2332 möglich, allerdings mit einigen Einschränkungen verbunden. Genaueres hierzu ist
2333 der Dokumentation des Paketes \Package{tabularx} zu entnehmen.
2334
2335 \subsubsection{Die Tabellenumgebung \Environment*{tabulary}}
2336 \label{sec:tabulary}%
2337 %
2338 Das Paket \Package{tabulary} verfolgt im Vergleich zum zuvor beschrieben Paket
2339 \Package{tabularx} einen etwas anderen Ansatz. Anstatt die verfügbare Breite
2340 über alle Spalten gleichmäßig zu verteilen, werden die Spaltenbreite anhand des
2341 jeweils darin befindlichen Inhaltes zueinander gewichtet. Dafür werden die vier
2342 Spaltentypen~\PValue{L},~\PValue{C},~\PValue{R}~sowie~\PValue{J} zur Verfügung
2343 gestellt. Diese entsprechen prinzipiell dem Spaltentyp~\PValue{p}, allerdings
2344 wird deren Breite \emph{automatisch} berechnet, wobei Spalten mit mehr Inhalt
2345 breiter gesetzt werden. Für die automatische Berechnung der Spaltenbreiten muss
2346 verständlicherweise die gewünschte Gesamtbreite der Tabelle angegeben werden,
2347 was bei der \Environment{tabulary}(\Package{tabulary})"~Umgebung mit dem ersten
2348 obligatorischen Argument vor der Angabe der Spaltendefinition erfolgt. Werden
2349 eine oder mehrere Spalten vom Typ~\PValue{l},~\PValue{c}~und~\PValue{r}
2350 angegeben, so werden diese weiterhin in ihrer natürlichen Breite und ohne
2351 Zeilenumbruch gesetzt.
2352
2353 Die Gewichtung der Spalten vom Typ~\PValue{LCRJ} und deren Derivate wird aus
2354 dem verbliebenen Platz die Breite berechnet. Die Berechnung der Spaltenbreite
2355 kann durch den Anwender außerdem über zwei Längen beeinflusst werden. Mit
2356 \Length{tymin}(\Package{tabulary}) wird die Mindestgröße für Spalten
2357 festgelegt. Sollten Sie wissen, dass eine Spalte sehr schmal wird, können Sie
2358 allerdings auch einfach eine der Standardspalten~\PValue{lcrp} nutzen. Mit der
2359 Länge \Length{tymax}(\Package{tabulary}) kann die maximale Ausdehnung einer der
2360 Spalten vom Typ~\PValue{LCRJ} festgelegt werden.
2361
2362 Für die \Environment{tabulary}(\Package{tabulary})"~Umgebung wird das vorherige
2363 Beispiel wiederholt. Zu beachten ist, dass die Spaltentypen~\PValue{LCRJ} mit
2364 dem Makro \Macro{tyformat}(\Package{tabulary}) bereits ein breitenloses
2365 Leerzeichen einsetzen, womit sich das manuelle Einfügen von selbigem durch den
2366 Anwender erübrigt.
2367 %
2368 \begin{Trunk+}
2369 \subsubsection{Eine gleitende tabulary-Tabelle}
2370 Es wird eine Tabelle mithilfe der \texttt{tabulary}"=Umgebung erstellt.
2371 Zu sehen ist diese in \autoref{tab:tabulary}.
2372
2373 \end{Trunk+}
2374 \begin{Trunk}
2375 \begin{table}
2376 \begin{tabulary}{\textwidth}{@{}LCRJ@{}}
2377 \toprule
2378 \textbf{Linksbündig} & \textbf{Zentriert} &
2379 \textbf{Rechtsbündig} & \textbf{Blocksatz} \tabularnewline\midrule
2380 Ein linksbündiger Blindtext zur Demonstration einer L"~Spalte &
2381 Ein zentrierter Blindtext zur Demonstration einer C"~Spalte &
2382 Ein rechtsbündiger Blindtext zur Demonstration einer R"~Spalte &
2383 Ein wesentlich längerer und absolut inhaltsleerer Blindtext im
2384 Blocksatz für eine um einiges bessere Demonstration einer J"~Spalte
2385 \tabularnewline\bottomrule
2386 \end{tabulary}
2387 \caption{Eine \texttt{tabulary}"=Tabelle}\label{tab:tabulary}
2388 \end{table}
2389
2390 \end{Trunk}
2391 \InputCode
2392
2393
2394 \subsubsection{Die Tabellenumgebung \Environment*{tabu}}
2395 \label{sec:tabu}%
2396 %
2397 Das Paket \Package{tabu} bietet eine mächtige und komfortable Alternative zu
2398 \Package{tabularx}. Es kam in diesem Tutorial bereits für die Verzeichnisse von
2399 Abkürzungen und Symbolen in \autoref{sec:glossaries} zum Einsatz. Leider ist
2400 das Paket in er aktuellen Version~v2.8 mit Vorsicht zu genießen. Zum einen
2401 wären für das Paket in der aktuellen Version seit geraumer Zeit ein paar
2402 kleinere Bugfixes notwendig, mehr dazu sehen Sie später. Außerdem wird sich die
2403 \hrfn{https://groups.google.com/d/topic/comp.text.tex/xRGJTC74uCI}{%
2404 Benutzerschnittstelle in einer zukünftigen Version%
2405 }
2406 sehr stark ändern. Sie sollten sich bewusst sein, dass mit der Version~v2.8
2407 gesetzte Dokumente gegebenenfalls später angepasst werden müssen.
2408
2409 Nichtsdestotrotz soll hier folgend die individuelle Verwendung einer
2410 \Environment{tabu}(\Package{tabu})"~Umgebung gezeigt werden, insbesondere weil
2411 für das Setzen umbruchfähiger Tabellen mit automatisch berechneten
2412 Spaltenbreiten momentan (fast) keine Alternative zu der Umgebung
2413 \Environment{longtabu}(\Package{tabu}) existiert.
2414
2415 Dieses Paket definiert ebenso einen Spaltentyp~\PValue{X}, welchem allerdings
2416 zusätzlich ein optionales Argument angehangen werden kann. Mit diesem lässt
2417 sich sowohl die Gewichtung der automatisch berechneten Spalten untereinander
2418 als auch die Positionierung zur Grundlinie sowie die Ausrichtung des Inhaltes
2419 ändern.
2420 %
2421 \begingroup
2422 \pcolumnfuzz{70pt}
2423 \begin{Hint*}
2424 \begin{tabu} to 11.7cm {lcrX}
2425 \toprule
2426 \textbf{Linksbündig} & \textbf{Zentriert} &
2427 \textbf{Rechtsbündig} & \textbf{Blocksatz} \tabularnewline\midrule
2428 a & b & c & Dieser Text wird im Blocksatz gesetzt\tabularnewline
2429 aa & bb & cc & Auch Zeilenumbrüche sind vorhanden\tabularnewline
2430 aaaa & bbbb & cccc & Worttrennungsmus\-terkontrolle\tabularnewline
2431 aaa & bbb & ccc & Worttrennungsmusterkontrolle
2432 \tabularnewline\bottomrule
2433 \end{tabu}
2434 \end{Hint*}
2435 \endgroup
2436 %
2437 Das Beispiel zeigt auch gleich das momentan meiner Meinung nach größte Problem
2438 des Paketes: Bei mehrzeiligen Zellen fehlt vertikale Zwischenraum zur nächsten
2439 Tabellenzeile. Nun besteht entweder die Möglichkeit, bei jeder Angabe einer
2440 Spalte im Tabellenkopf, welche eine \Macro{parbox} verwendet, mit dem Ausdruck
2441 \PValue{>\PParameter{\Macro{strut}}} die fehlenden Unterlänge auszugleichen
2442 oder es wird abermals ein entsprechender Spaltentyp definiert. Das ist für
2443 die \PValue{X}"~Spalten der Umgebung \Environment{tabu}(\Package{tabu}) etwas
2444 schwieriger, da \Macro{newcolumntype}(\Package{array}) normalerweise die
2445 Definition eines optionalen Argumentes nicht vorgesehen ist. Mit ein wenig
2446 Trickserei ist das dennoch möglich:
2447 %
2448 \begin{Trunk+}
2449 \subsubsection{Eine gleitende tabu-Tabelle}
2450 In \autoref{tab:tabu} ist eine weitere Tabelle mit variabler Breite der
2451 Spalten und festgelegter Gesamtbreite zu sehen, welche in der Umgebung
2452 \texttt{tabu} gesetzt wurde. Auch für diese wird zuerst ein neuer
2453 Spaltentyp definiert, der die Unzulänglichkeiten der Umgebung reduziert.
2454 Mit \texttt{\textbackslash ttabbox} aus dem Paket \texttt{floatrow} wird
2455 die Beschriftung auf die Breite der Tabelle begrenzt.
2456
2457 \end{Trunk+}
2458 \CodeHook{\renewcommand*{\newcolumntype}[2]{}}
2459 \begin{Trunk*}
2460 \makeatletter
2461 \newcolumntype{Z}{}
2462 \renewcommand*{\NC@rewrite@Z}[1][]{%
2463 \NC@find>{\hspace{0pt}}X[#1]<{\@finalstrut\@arstrutbox}%
2464 }
2465 \makeatother
2466
2467 \end{Trunk*}
2468 %
2469 Anschließend kann der \PValue{Z}"~Spaltentyp äquivalent zu \PValue{X} genutzt
2470 werden. Zu beachten ist dabei insbesondere die Möglichkeit, die Spalten in
2471 ihrer resultierenden Breite sehr einfach zueinander gewichten zu können~-- im
2472 Gegensatz zur Umgebung \Environment*{tabularx}, wo dieses Unterfangen etwas
2473 schwieriger ist. Das Ergebnis ist in \autoref{tab:tabu} zu sehen. Zu beachten
2474 ist die Verwendung von \Macro{ttabbox}(\Package{floatrow}) aus dem Paket
2475 \Package{floatrow}, um die Beschriftung an die Breite der Tabelle anzupassen.
2476 Genaueres dazu in \autoref{sec:floatlayout}.
2477 %
2478 \begin{Trunk}
2479 \begin{table}
2480 \ttabbox{%
2481 \begin{tabu} to .8\textwidth {@{}Z[3,l]Z[3,c]Z[3,r]Z[2,j]@{}}
2482 \toprule
2483 \textbf{Linksbündig} & \textbf{Zentriert} &
2484 \textbf{Rechtsbündig} & \textbf{Blocksatz} \tabularnewline\midrule
2485 Ein linksbündiger Blindtext zur Demonstration einer Z[l]"~Spalte &
2486 Ein zentrierter Blindtext zur Demonstration einer Z[c]"~Spalte &
2487 Ein rechtsbündiger Blindtext zur Demonstration einer Z[r]"~Spalte &
2488 Ein Blindtext im Blocksatz innerhalb einer Z"~Spalte
2489 \tabularnewline\bottomrule
2490 \end{tabu}%
2491 }{%
2492 \caption[Eine \texttt{tabu}"=Tabelle]{%
2493 Eine \texttt{tabu}"=Tabelle in Verbindung mit dem Befehl
2494 \texttt{\textbackslash ttabbox}, welcher vom Paket \texttt{floatrow}
2495 für Beschriftungen in Objektbreite bereitgestellt wird%
2496 }%
2497 \label{tab:tabu}%
2498 }
2499 \end{table}
2500
2501 \end{Trunk}
2502 \InputCode
2503
2504
2505
2506 \section{Querverweise}
2507 \label{sec:references}%
2508 %
2509 Damit alle möglichen Querverweise in einem PDF"~Dokument automatisch verlinkt
2510 werden, sollte das Paket \Package{hyperref} geladen werden. Um die erzeugten
2511 Links verträglich aussehen zu lassen, werden die beiden Paketoptionen
2512 \Option{colorlinks}(\Package{hyperref}) sowie \Option*{linkcolor=blue}
2513 verwendet. Da \Package{hyperref} allerhand Veränderungen an vielen
2514 Standardbefehlen vornimmt, sollte dieses als letztes in der Präambel
2515 eingebunden werden. Nur Pakete, bei denen in der Dokumentation explizit darauf
2516 hingewiesen wird, dass diese nach \Package{hyperref} zu laden sind, sollten
2517 auch danach folgen. Eines dieser wenigen Pakete ist das in diesem Tutorial
2518 verwendete \Package{glossaries}.
2519 %
2520 \begin{Hint}
2521 \usepackage[colorlinks,linkcolor=blue]{hyperref}
2522
2523 \end{Hint}
2524 %
2525 Um auf ein bestimmtes Objekt wie beispielsweise eine Tabelle, eine Abbildung
2526 oder einen bestimmten Anschnitt im Dokument referenzieren zu können, muss mit
2527 \Macro{label}[\Parameter{label}] ein Anker für selbiges an der entsprechenden
2528 Stelle gesetzt werden. Bei Überschriften sollte dies direkt nach der Nutzung
2529 des Gliederungsbefehls%
2530 \footnote{%
2531 \Macro{chapter}(\Package{koma-script}),
2532 \Macro{section}(\Package{koma-script}) etc.%
2533 }
2534 erfolgen. Für Abbildungen, Tabellen oder andere Objekte in Gleitumgebungen muss
2535 der Anker unmittelbar nach der Verwendung von
2536 \Macro{caption}(\Package{koma-script},\Package{caption}) respektive
2537 \Macro{captionof}(\Package{koma-script}) erstellt werden. Um nun auf diesen
2538 Anker zu referenzieren, sollte nicht \Macro{ref} sondern
2539 \Macro{autoref}(\Package{hyperref}) im Fließtext genutzt werden. Letztgenannter
2540 Befehl erzeugt nicht nur einen Link mit der dazugehörigen Nummerierung sondern
2541 stellt dieser die Bezeichnung des referenzierten Objektes%
2542 \footnote{\enquote{Abbildung}, \enquote{Tabelle}, \dots}
2543 voran.
2544
2545 Mit dem Befehl \Macro{pageref} lässt sich auf die Seite eines Ankers verweisen.
2546 Das Paket \Package{varioref} kann dabei unterscheiden, ob der Anker sich auf
2547 der aktuellen Seite, auf einer Seite direkt davor beziehungsweise danach oder
2548 auf einer entfernteren Seite befindet und dementsprechend einen Hinweis darauf
2549 ausgeben. Hierfür werden die Befehle \Macro{vref}(\Package{varioref}) sowie
2550 \Macro{vpageref}(\Package{varioref}) zur Verfügung gestellt. Das Paket
2551 \Package{cleveref} vereint die Vorzüge von \Macro{autoref}(\Package{hyperref})
2552 in Verbindung mit \Macro{vref}(\Package{varioref}) durch den Befehl
2553 \Macro{cref}(\Package{cleverref}).
2554
2555
2556
2557 \section{Zitate}
2558 Für das wörtliche Zitieren kann das Paket \Package{csquotes} verwendet werden.
2559 Dieses stellt den Befehl \Macro{enquote}(\Package{csquotes}) bereit, der die
2560 kennzeichnenden Anführungszeichen automatisch in Abhängigkeit der verwendeten
2561 Dokumentsprache setzt.
2562 %
2563 \begin{Hint}
2564 \usepackage{csquotes}
2565 \end{Hint}
2566 %
2567 Da für die unterschiedlichen Fachdisziplinen teils sehr unterschiedliche
2568 Zitierrichtlinien existieren, kann hier keine allgemeingültige Empfehlung zu
2569 Stilfragen gegeben werden. Zu beachten ist auf jeden Fall, dass zu wörtlichen
2570 Zitaten eine Quellenangabe erfolgen \emph{muss}. Dabei sollte darauf geachtet
2571 werden, dass nicht nur die Quelle selbst sondern zumindest auch die Seitenzahl
2572 des Zitats angegeben wird.
2573 %
2574 \begin{refsection}[\jobname-temp.bib]
2575 \begin{Trunk+}
2576 \section{Zitate}
2577 Bei der Verwendung von wörtlichen Zitaten sollten diese als solche
2578 gekennzeichnet werden.
2579 \end{Trunk+}
2580 \begin{Trunk*}
2581 \enquote{Dies ist ein zugegebenermaßen nicht sehr sinnvolles Zitat.}
2582 \cite[58]{hanisch14}
2583 \end{Trunk*}
2584 \begin{Trunk+}
2585 Für eine möglichst gut nachvollziehbare Referenz sollte nicht nur
2586 das Werk selber sondern zumindest die Seitenzahl und gegebenenfalls
2587 der Absatz der originalen Textstelle angegeben werden.
2588 \end{Trunk+}
2589 %
2590 Längere Zitate sollten abgesetzt vom Fließtext ausgegeben werden. Hierfür
2591 bieten sowohl die Standard"~ als auch die \KOMAScript-Klassen standardmäßig
2592 die Umgebungen \Environment{quote}(\Package{koma-script}) und
2593 \Environment{quotation}(\Package{koma-script}) an. Allerdings verwenden beide
2594 fest eingestellte Absatzauszeichnungen. Sollen jedoch die mit der Option
2595 \Option{parskip}(\Package{koma-script}) vorgegebenen Einstellungen für Absätze
2596 beachtet werden, so bietet sich das Paket \Package{quoting} an, welches die
2597 gleichnamige Umgebung \Environment{quoting}(\Package{quoting}) definiert und
2598 die Absätze wie im restlichen Dokument auszeichnet.
2599 %
2600 \begin{Preamble}
2601 \usepackage{quoting}
2602
2603 \end{Preamble}
2604 %
2605 \begin{Trunk*}
2606 \begin{quoting}
2607 \enquote{%
2608 Dies ist ein noch sinnloseres Zitat. Allerdings wird zumindest die
2609 Wirkung der Umgebung \texttt{quoting} bei der Absatzauszeichnung
2610 deutlich.
2611
2612 Wie zu sehen ist, wird der zweite Absatz~-- wie jeder weitere~--
2613 aufgrund der Option \texttt{parskip=false} eingezogen.
2614 }
2615 \cite[sinngemäß nach][\pno{} 12, zweiter Absatz]{hanisch14}
2616 \end{quoting}
2617 \end{Trunk*}
2618 \begin{Trunk+}
2619 Ebenfalls sollten sinngemäße Zitate mit einer möglichst genauen Referenz
2620 angegeben werden. Dies kann im Laufe der Arbeit auch für einen selbst von
2621 Vorteil sein, wenn beispielsweise die originale Textpassage noch einmal
2622 analysiert werden soll.
2623
2624 \end{Trunk+}
2625 \begin{quoting}[rightmargin=0pt]
2626 \makeatletter
2627 \let\markboth\@gobbletwo
2628 \let\markright\@gobble
2629 \makeatother
2630 \printbibliography
2631 \end{quoting}
2632 \end{refsection}
2633
2634
2635
2636 \section{Worttrennungen}
2637 \label{sec:hyphenation}%
2638 %
2639 Bei der Verwendung von \hologo{LaTeXe} gibt es ab und an das Problem, dass
2640 bestimmte Wörter am Zeilenende falsch getrennt werden. Dies hat historische
2641 Gründe. Als \hologo{TeX} in den 1980er"~Jahren entwickelt wurde, war es
2642 aufgrund der zu dieser Zeit zur Verfügung stehenden Speichergrößen schier
2643 unmöglich, die Worttrennungen mit einem Wörterbuchansatz umzusetzen.
2644 Stattdessen wurde~-- um den benötigten Speicherbedarf möglichst gering zu
2645 halten~-- ein Algorithmus entworfen, der mögliche Trennstellen in einem Wort
2646 mit einer Mustererkennung ermittelt. Die verwendeten Muster basieren jedoch
2647 auf der englischen Sprache, weshalb in nicht"~englischsprachigen Texten auch
2648 heute noch teilweise falsche Trennstellen gefunden werden.
2649
2650 In \autoref{sec:introduction} wurde bereits auf das Paket
2651 \Package{hyphsubst} hingewiesen, welches dieses Manko~-- aufgrund der nicht
2652 mehr so stark gegebenen Restriktionen bezüglich des Speicherbedarfes~-- mit
2653 einem Wörterbuch behebt. Dieses Paket muss für \Engine{pdfLaTeX} vom Anwender
2654 eingebunden werden, \Engine{LuaLaTeX} und \Engine{XeLaTeX} verwenden die
2655 Trennmuster~-- ein geladenes Sprachpaket wie \Package{polyglossia} oder
2656 \Package{babel} vorausgesetzt~-- automatisch. Damit auch Wörter mit Umlauten
2657 richtig getrennt werden, ist zudem das Paket \Package{fontenc} mit der
2658 \PValue{T1}"~Schriftkodierung respektive \Package{fontspec} notwendig. Der
2659 Beginn einer Dokumentpräambel könnte folgendermaßen aussehen:
2660 %
2661 \begin{Hint}
2662 \documentclass[ngerman,§\PName{Klassenoptionen}§]§\Parameter{Dokumentklasse}§
2663 \usepackage{iftex}
2664 \iftutex
2665 \usepackage{fontspec}
2666 \else
2667 \usepackage[T1]{fontenc}
2668 \usepackage[ngerman=ngerman-x-latest]{hyphsubst}
2669 \fi
2670 \usepackage{babel}
2671 \end{Hint}
2672 %
2673 Die Option \Option{ngerman}(\Package{hyphsubst}) lädt dabei die Trennmuster für
2674 die neue deutsche Rechtschreibung, wobei der Wert \PValue{ngerman-x-latest} die
2675 neuesten aller verfügbaren Trennmuster lädt. Für die alte Orthografie ist
2676 stattdessen die Option \Option{german}(\Package{hyphsubst}) mit dem Wert
2677 \PValue{german-x-lastest} zu verwenden.
2678
2679
2680 \subsection{Einmalige und globale Worttrennungskorrektur}
2681 Sollte es dennoch passieren, dass ein Wort nicht korrekt getrennt wird, lässt
2682 sich dies manuell korrigieren. Dafür stellt das Paket \Package{babel} mehrere
2683 Kurzbefehle zur Verfügung. Mit dem Makro \Macro{hyphenation} lassen sich für
2684 ein bestimmtes Wort außerdem alle potenziellen Trennstellen angeben. Zum Thema
2685 \tudhyperref{sec:tips:hyphenation}{Worttrennungen in deutschsprachigen Texten}
2686 ist im \TUDScript-Handbuch unter dem Kapitel Tipps~\&~Tricks mehr zu finden.
2687 Dort wird auch erläutert, wie das Problem der alleinigen Trennung von Wörtern
2688 mit Bindestrich an selbigem umgangen werden kann.
2689
2690
2691 \subsection{Worttrennung im Flattersatz}
2692 Normalerweise ist bei \hologo{LaTeXe} die Worttrennung für den Flattersatz%
2693 \footnote{\Macro{raggedright}, \Macro{raggedleft}, \Macro{centering}}
2694 deaktiviert. Mit dem Paket \Package{ragged2e} kann diese aktiviert werden. Nach
2695 dem Laden stehen die Befehle \Macro{Centering}(\Package{ragged2e}),
2696 \Macro{RaggedLeft}(\Package{ragged2e}) sowie
2697 \Macro{RaggedRight}(\Package{ragged2e}) für den Anwender zur Verfügung, um
2698 Worttrennungen im Flattersatz zu verwenden. Die Option
2699 \Option{newcommands}(\Package{ragged2e}) überschreibt die originalen Befehle
2700 \Macro{centering}, \Macro{raggedleft} und \Macro{raggedright} mit den
2701 korrelierten Befehlen aus dem Paket. Genaueres dazu ist der Dokumentation des
2702 Paketes zu entnehmen.
2703
2704
2705
2706 \section{Mikrotypografische Feinheiten}
2707 Unter Mikrotypografie oder Detailtypografie wird die Gestaltung folgender
2708 Feinheiten des Schriftsatzes verstanden:
2709 \begin{itemize}[noitemsep]
2710 \item korrekte Anwendung der Satzzeichen
2711 \item Schriftart, Kapitälchen und Ligaturen
2712 \item Wortabstände sowie Laufweite (Buchstaben- und Zeichenabstände)
2713 \item optischer Randausgleich
2714 \end{itemize}
2715
2716 \noindent Die letzten beiden Punkte werden sensationell gut durch das Paket
2717 \Package{microtype} bearbeitet. Dieses muss lediglich in der Präambel geladen
2718 werden, wobei es nicht mit der klassischen \hologo{TeX}"~Engine, wohl jedoch
2719 mit \Engine{pdfTeX} als auch \Engine{LuaTeX} sowie \Engine{XeTeX} funktioniert.
2720 %
2721 \begin{Preamble}
2722 \usepackage[babel]{microtype}
2723
2724 \end{Preamble}
2725 %
2726 Die Option \Option{babel}(\Package{microtype}) ist nur notwendig, wenn einzelne
2727 Textpassagen oder das gesamte Dokument in Englisch oder Französisch verfasst
2728 werden und hierfür die genutzte Sprache mit den entsprechenden Möglichkeiten
2729 von \Package{babel} eingestellt wird.
2730
2731 Das korrekte Anwenden von Satzzeichen wird für deutschsprachige Texte bereits
2732 in mehreren Artikeln \cite{neubauer1996,neubauer1997,struckmann2007,bier2009}
2733 sehr gut erläutert, weshalb ein Hinweis auf diese Arbeiten für weitergehende
2734 Informationen zu dieser Thematik absolut ausreichend ist. Nachfolgend werden
2735 Tipps gegeben sowie einige \hologo{LaTeXe}"=Pakete vorgestellt, die bei der
2736 Umsetzung der in den genannten Artikeln erläuterten Empfehlungen helfen.
2737
2738
2739 \subsection{Abkürzungen}
2740 In \cite{struckmann2007} wird gleich zu Beginn darauf hingewiesen, wie häufig
2741 verwendete Abkürzungen sehr einfach im Dokument verwendet werden können und
2742 dabei typografisch richtig gesetzt werden. Beispielsweise gelingt dies für die
2743 Abkürzung \enquote{zum~Beispiel~(z.\,B.)} mit dieser Definition:
2744 %
2745 \begin{Hint}
2746 \newcommand{\zB}{\mbox{z.\,B.}\xspace}
2747 \end{Hint}
2748 %
2749 Wenn ohnehin das Paket \Package{glossaries} für Akronyme verwendet wird, kann
2750 alternativ dazu auch dessen Funktionalität genutzt werden. Nach dem Einbinden
2751 muss in der Präambel lediglich Folgendes eingefügt werden:
2752 %
2753 \begin{Hint}
2754 \newignoredglossary{abbreviation}
2755 \newcommand*{\newabbreviation}[4][]{%
2756 \newacronym[type=abbreviation,#1]{#2}{\mbox{#3\xspace}}{#4}%
2757 }%
2758 \end{Hint}
2759 %
2760 Mit \Macro{newignoredglossary}(\Package{glossaries}) wird dabei ein Glossar
2761 erstellt, welche bei der Ausgabe aller Glossare mit
2762 \Macro{printglossaries}(\Package{glossaries}) ignoriert wird. Im Dokument kann
2763 die gewünschte Abkürzung mit
2764 %
2765 \begin{Hint*}
2766 \newabbreviation{zB}{z.\,B.}{zum Beispiel}
2767 \end{Hint*}
2768 %
2769 definiert und über die gewohnten Befehlen aus \Package{glossaries} verwendet
2770 werden.
2771 %
2772 \begin{Hint*}
2773 Die Ausgabe der soeben definierten Abkürzung \enquote{\acrshort{zB}}
2774 erfolgt mit dem Befehl \texttt{\textbackslash acrshort}. Wurde das
2775 Paket \texttt{glossaries} mit der Option \texttt{shortcut} geladen,
2776 kann auch das Makro \texttt{\textbackslash acs} genutzt werden.
2777 \end{Hint*}
2778
2779
2780 \subsection{Listen}
2781 \label{sec:lists}%
2782 %
2783 Für Auflistungen aller Art bietet \hologo{LaTeX} die drei Standardumgebungen
2784 \Environment{itemize}(\Package{koma-script},\Package{enumitem}),
2785 \Environment{enumerate}(\Package{koma-script},\Package{enumitem}) und
2786 \Environment{description}(\Package{koma-script},\Package{enumitem}). Das
2787 häufigste Anliegen bei der Verwendung dieser Umgebungen ist das Reduzieren
2788 der Abstände zwischen den einzelnen, mit
2789 \Macro{item}(\Package{koma-script},\Package{enumitem}) gesetzten Punkten,
2790 welche sehr häufig als zu groß empfunden werden. Eine Aufzählung erscheint ohne
2791 Anpassungen wie folgt:
2792 %
2793 \CodePreamble{Aufzählung mit vertikalen Standardabständen}
2794 \begin{Hint*}
2795 \begin{itemize}
2796 \item erster Punkt
2797 \item zweiter Punkt
2798 \item dritter Punkt
2799 \end{itemize}
2800 \end{Hint*}
2801 %
2802 Dabei wirken die Abstände zwischen den Punkten tatsächlich etwas
2803 überdimensioniert. Mit \Package{enumitem} können alle Listenumgebungen an die
2804 individuellen Bedürfnisse angepasst werden.
2805 %
2806 \begin{Preamble}
2807 \usepackage{enumitem}
2808 \end{Preamble}
2809 %
2810 Um diese ungewollten Abstände zwischen den Listenpunkten zu entfernen, kann der
2811 Schlüssel \Option{noitemsep}(\Package{enumitem}) verwendet werden. Mit dem
2812 Befehl \Macro{setlist}(\Package{enumitem}) werden~-- ohne zusätzliche Angaben
2813 im optionalen Argument~-- alle Umgebungen für Aufzählungen global geändert.
2814 Hier soll dies lediglich für die Umgebung \Environment*{itemize} geschehen:
2815 \begin{Preamble*}
2816 \setlist[itemize]{noitemsep}
2817
2818 \end{Preamble*}
2819 \CodePreamble{Aufzählung ohne vertikale Abstände}
2820 \begin{Hint*}
2821 \begin{itemize}
2822 \item erster Punkt
2823 \item zweiter Punkt
2824 \item dritter Punkt
2825 \end{itemize}
2826
2827 \end{Hint*}
2828 %
2829 Alternativ zur globalen Änderung einer speziellen oder aller Aufzählungslisten
2830 kann der Schlüssel \PValue{noitemsep} auch nur gezielt an einzelne Umgebung
2831 über das optionale Argument weitergereicht werden
2832 (\Macro*{begin}[\PParameter{itemize}\POParameter{noitemsep}]).
2833
2834 Natürlich erlaubt das Paket noch weitergehende Einstellungen für die Umgebungen
2835 \Environment{itemize}(\Package{koma-script},\Package{enumitem}),
2836 \Environment{enumerate}(\Package{koma-script},\Package{enumitem}) und
2837 \Environment{description}(\Package{koma-script},\Package{enumitem}).
2838 Zusätzlich können diese für eigene Aufzählungsumgebungen geklont und den
2839 eigenen Bedürfnissen angepasst werden. Genaueres hierzu ist der Dokumentation
2840 des Paketes \Package{enumitem} entnehmen.
2841
2842
2843 \subsection{Ligaturen}
2844 Die meisten \hologo{LaTeX}"=Schriftfamilien enthalten Ligaturen, die für einen
2845 typografisch sauberen Satz bei zusammengesetzten Wörtern, wie sie gerade im
2846 Deutschen häufig vorkommen, aufgetrennt werden müssten. Mit der Anwendung
2847 \Application{DeLig}<delig> kann dies automatisiert geschehen. Wird
2848 \Engine{LuaLaTeX} als Textsatzsystem genutzt, kann alternativ das Paket
2849 \Package{selnolig} verwendet werden.
2850
2851
2852 \subsection{Auslassungspunkte}
2853 Das typografisch richtige Setzen von Auslassungspunkten mit den Befehlen
2854 \Macro{dots} respektive \Macro{textellipsis} wird im Handbuch unter
2855 \tudhyperref{sec:tips:dots}{Das Setzen von Auslassungspunkten} genauer
2856 beschrieben, weshalb hier nur kurz darauf eingegangen wird. Es wird das Paket
2857 \Package{ellipsis} benötigt.
2858 %
2859 \begin{Preamble}
2860 \usepackage{ellipsis}
2861 \end{Preamble}
2862 %
2863 Für deutschsprachige Texte sollten außerdem noch folgendes ausgeführt werden:
2864 %
2865 \begin{Preamble}
2866 \let\ellipsispunctuation\relax
2867
2868 \end{Preamble}
2869
2870
2871 \subsection{Mathematiksatz}
2872 Von \hologo{LaTeXe} werden einige Umgebungen für das Setzen mathematischer
2873 Formeln und Ausdrücke bereitgestellt, welche meist jedoch nicht \emph{alle}
2874 Anforderungen eines Nutzers an den Mathematiksatz erfüllen können. Das Paket
2875 \Package{amsmath} bietet deshalb eine Reihe weiterführender Umgebungen für das
2876 Setzen von einzeiligen und mehrzeiligen sowie ausgerichteter Formeln zur
2877 Verfügung. Auf eine Einführung in das Paket wird~-- aufgrund der bereits in
2878 großer Zahl vorhandenen Einführungen~-- in diesem Tutorial verzichtet. Außerdem
2879 stehen mit \Tutorial{mathtype} und \Tutorial{mathswap} zwei weitere Tutorials
2880 zur Verfügung, die sich explizit mit der Thematik eines guten mathematischen
2881 Satz beschäftigen.
2882
2883 Das Paket \Package{amsmath} stellt für \hologo{LaTeXe} den De"~facto"~Standard
2884 für den mathematischen Satz dar. Allerdings wird es~-- insbesondere aus diesem
2885 Grund~-- sehr \enquote{vorsichtig} weiterentwickelt. Für das Setzen neuer
2886 Dokumente sollte deshalb das Paket \Package{mathtools} verwendet werden, das
2887 auf \Package{amsmath} basiert und dieses um zusätzliche Funktionalitäten
2888 ergänzt sowie Bugfixes bereithält.
2889
2890
2891 \subsection{Darstellung von mathematischen Brüchen}
2892 Für ansehnliche und insbesondere im Fließtext gut lesbare mathematische Brüche
2893 stellt das Paket \Package{xfrac} den Befehl \Macro{sfrac}(\Package{xfrac}) zur
2894 Verfügung.
2895 %
2896 \begin{Preamble}
2897 \usepackage{xfrac}
2898
2899 \end{Preamble}
2900
2901
2902 \subsection{Einheiten}
2903 Mit dem Paket \Package{siunitx} lassen sich sowohl physikalische Einheiten als
2904 auch Zahlen typografisch korrekt setzen. Sollen die Funktionalitäten in einem
2905 deutschsprachigen Dokument problemlos nutzbar sein, so sind die Hinweise zum
2906 \tudhyperref{sec:tips:siunitx}{Setzen von Einheiten mit \Package{siunitx}} im
2907 \TUDScript-Handbuch zu beachten. Das Paket \Package{units} ist nicht ganz so
2908 mächtig wie \Package{siunitx}, kann allerdings als pragmatische Alternative
2909 gesehen und genutzt werden.
2910
2911
2912 \subsection{Datumsformatierung}
2913 Das Paket \Package{isodate} stellt \Macro{printdate}(\Package{isodate}) bereit.
2914 Dieser Befehl kann für die Formatierung von Datumsangaben verwendet werden.
2915 Wird das Paket mit einer der Dokumentklassen aus dem \TUDScript-Bundle geladen,
2916 wird der genannte Befehl automatisch für alle bereitgestellten Datumsfelder
2917 verwendet. Alternativ dazu kann das Paket \Package{datetime2} genutzt werden,
2918 dessen Befehl \Macro{DTMDate}(\Package{datetime2}) wird ebenfalls unterstützt.
2919 %
2920 \begin{Preamble}
2921 \usepackage{isodate}
2922
2923 \end{Preamble}
2924
2925
2926
2927 \section{Erstellen von Abbildungen}
2928 \label{sec:figures}%
2929 %
2930 Die einfachste Möglichkeit, in einer wissenschaftlichen Abhandlung Grafiken zu
2931 verwenden, ist sicherlich das Einbinden von externen Abbildungen mit dem Befehl
2932 \Macro{includegraphics}(\Package{graphicx}) aus dem Paket \Package{graphicx}.
2933 Allerdings ist für eine wissenschaftliche Arbeit in höchster Qualität meiner
2934 Meinung nach das bloße Einfügen einer gescannten oder heruntergeladenen Grafik
2935 unzureichend. Vielmehr sollte diese zum einen als skalierbare Vektorgrafik
2936 vorliegen, um sowohl die höchste Druckqualität als auch die
2937 Wiederverwendbarkeit sicherzustellen, und zum anderen in ihrer Gestaltung dem
2938 verwendeten Layout des verfassten Dokumentes entsprechen. Dies betrifft sowohl
2939 die eingesetzten Farben und Schriften als auch die Stärke der verwendeten
2940 Linien.
2941
2942 Zum Zeichnen von Grafiken sind die freien Programme \Application{LaTeXDraw} und
2943 besonders \Application{Inkscape} empfehlenswert, da diese die Verwendung der
2944 Dokumentschriften innerhalb der erstellten Grafiken ermöglichen. Im Handbuch zu
2945 \TUDScript wird dies für \tudhyperref{sec:tips:svg}{\Application{Inkscape}}
2946 genauer erläutert. Eine andere Variante ist das \enquote{Programmieren} von
2947 Grafiken. Die zwei bekanntesten \hologo{LaTeX}"=Pakete sind \Package{tikz}<pgf>
2948 und \Package{pstricks}<pstricks-base>. Mit beiden wird folgend eine Abbildung
2949 exemplarisch erstellt, ohne dabei ins Detail zu gehen, da es~-- neben den
2950 umfangreichen Dokumentationen~-- zahlreiche Beispiele und Erläuterungen im
2951 Internet gibt.
2952
2953
2954
2955 \subsection{Das Paket \Package{tikz}}
2956 Zur Verwendung von \Package{tikz}<pgf> ist nicht viel zu sagen. Einfach in der
2957 Dokumentpräambel einbinden und es kann losgehen. Für das nachfolgende Beispiel
2958 sind außerdem noch zwei weitere Programmbibliotheken für \Package{tikz}<pgf>
2959 notwendig.
2960 %
2961 \begin{Hint}
2962 \usepackage{tikz}
2963 \usetikzlibrary{chains}
2964 \usetikzlibrary{decorations.markings}
2965 \tikzset{on grid}
2966 \end{Hint}
2967 %
2968 Ein kurze Anmerkungen zur Skalierung der Grafiken möchte ich mir erlauben.
2969 Normalerweise verwendet \Package{tikz}<pgf> Koordinaten im Zentimeter"=Raster.
2970 Ich persönlich bevorzuge der relativierte Skalierung auf die Textbreite des
2971 Dokumentes, wobei eine Einheit genau \SI{1}{\percent} dieser entspricht. Das
2972 kann mit folgendem Quelltext erreicht werden:
2973 %
2974 \CodeHook{\renewcommand\newlength[1]{}}
2975 \begin{Hint*}
2976 \newlength{\tikzunit}
2977 \setlength{\tikzunit}{.01\textwidth}
2978 \tikzset{x=\tikzunit,y=\tikzunit}
2979 \end{Hint*}
2980 %
2981 Nachfolgend wird eine Grafik innerhalb einer Gleitumgebung exemplarisch
2982 erstellt. Das Ergebnis ist in \autoref{fig:tikz} zu sehen.
2983
2984 \begin{Hint?}
2985 \begin{figure}
2986 \begin{tikzpicture}
2987 \tikzstyle{inner box}=[%
2988 text width=17\tikzunit,
2989 align=center,
2990 rectangle,
2991 inner sep=.5\tikzunit,
2992 minimum height=8\tikzunit,
2993 font=\hspace{0pt},
2994 draw
2995 ]
2996 \tikzstyle{inner label}=[align=center, font=\scriptsize]
2997 \tikzstyle{inner box chain}=[every node/.style={on chain}]
2998 \tikzstyle{inner box chain below}=[%
2999 inner box chain, node distance=8\tikzunit,continue chain=going below
3000 ]
3001 \tikzstyle{inner box chain right}=[%
3002 inner box chain,node distance=35\tikzunit,continue chain=going right
3003 ]
3004 \tikzstyle{inner box chain above}=[%
3005 inner box chain,node distance=16\tikzunit,continue chain=going above
3006 ]
3007 \tikzstyle{pstarrow->}=[%
3008 decoration={markings,
3009 mark=at position 1 with {\arrow[xscale=1.5]{stealth}};
3010 },
3011 postaction={decorate},
3012 shorten >=0.7pt
3013 ]
3014 \newcommand{\tikzparbox}[2][9]{%
3015 \parbox{#1\tikzunit}{\centering\hspace{0pt}#2}%
3016 }
3017 \begin{scope}[start chain]
3018 \begin{scope}[inner box chain below]
3019 \node(NE)[inner box]{Navigations\-ebene};
3020 \node(NB)[inner label]{gewählte Fahrtroute\\ zeitlicher Ablauf};
3021 \node(BE)[inner box]{{Bahnführungs\-ebene}};
3022 \node(BS)[inner label]{%
3023 gewählte Führungsgrößen:\\ Sollspur, Sollgeschwindigkeit%
3024 };
3025 \node(SE)[inner box]{Stabilisierungs\-ebene};
3026 \end{scope}
3027 \begin{scope}[inner box chain right]
3028 \node(LQ)[inner box]{Längs- und Querdynamik};
3029 \node(FO)[inner box]{Fahrbahn\-oberfläche};
3030 \end{scope}
3031 \begin{scope}[inner box chain above]
3032 \node(FR)[inner box]{Fahrraum\\ \smallskip{\scriptsize Straße
3033 und\\ \vspace{-1.5ex}Verkehrssituation}};
3034 \node(SN)[inner box]{Straßennetz};
3035 \end{scope}
3036 \end{scope}
3037 \begin{scope}[inner label,minimum size=0pt]
3038 \draw [pstarrow->] (FO) -| ++(13.5,-12) to
3039 node [above]{Istspur, Istgeschwindigkeit} ++(-97,0) |- (SE);
3040 \draw [pstarrow->] (FR) -| ++(14 ,-32) to
3041 node [above]{Bereich sicherer Führungsgrößen} ++(-98,0) |- (BE);
3042 \draw [pstarrow->] (SN) -| ++(14.5 ,-52) to
3043 node [above]{mögliche Fahrtroute} ++(-99,0) |- (NE);
3044 \end{scope}
3045 \begin{scope}[inner label]
3046 \draw (NE) to (NB);
3047 \draw [pstarrow->] (NB) to (BE);
3048 \draw (BE) to (BS);
3049 \draw [pstarrow->] (BS) to (SE);
3050 \draw [pstarrow->] (SE) to
3051 node[above] {\tikzparbox{Stell\-größen}}
3052 node[below] {\tikzparbox{Lenken Gasgeben Bremsen}}
3053 (LQ);
3054 \draw [pstarrow->] (LQ) to
3055 node[above]{\tikzparbox{Regel\-größen}}
3056 node[below]{\tikzparbox{Fahrzeugbewegung}}
3057 (FO);
3058 \draw [pstarrow->] (LQ)+(24,0) |- (FR);
3059 \draw [pstarrow->] (LQ)+(24,0) |- (SN);
3060 \end{scope}
3061 \begin{scope}[very thick,rounded corners=5\tikzunit]
3062 \draw (-12.5,-40) rectangle (12.5,14);
3063 \draw ( 22.5,-40) rectangle (47.5,-18);
3064 \draw ( 57.5,-40) rectangle (82.5,14);
3065 \end{scope}
3066 \begin{scope}[font=\bfseries]
3067 \node at (0,9) {Fahrer};
3068 \node at (35,-23) {Fahrzeug};
3069 \node at (70,9) {Umwelt};
3070 \end{scope}
3071 \end{tikzpicture}
3072 \caption{Eine mit TikZ erstellte Grafik}\label{fig:tikz}
3073 \end{figure}
3074 \end{Hint?}
3075
3076
3077
3078 \subsection{Das Paket \Package{pstricks}}
3079 Die zuvor mit \Package{tikz}<pgf> erstellte Grafik wird nachfolgend mit dem
3080 Paket \Package{pstricks} erstellt. Mit diesem lassen sich PostScript"=Grafiken
3081 erstellen. Ähnlich wie bei \Package{tikz}<pgf> gibt es ein Kernpaket und
3082 zusätzliche Ergänzungen. Diese werden jedoch nicht als Programmbibliotheken
3083 sondern ganz normal als \hologo{LaTeX}"=Pakete eingebunden.
3084 %
3085 \begin{Hint}
3086 \usepackage{pstricks,pst-node}
3087 \end{Hint}
3088 %
3089 Die Verwendung von PostScript hat zahlreiche Vorteile, macht die direkte
3090 Nutzung von \Engine{pdfLaTeX} etwas schwierig. Das Paket \Package{auto-pst-pdf}
3091 schafft hier jedoch Abhilfe. Wird das Textsatzsystem \Engine{pdfLaTeX} über die
3092 zusätzliche Option \Option{-{}-shell-escape}(\Engine{pdfLaTeX}) beziehungsweise
3093 \Option{-{}-enable-write18}(\Engine{pdfLaTeX}) mit erweiterten Schreibrechten
3094 aufgerufen, so werden die Abbildungen automatisch im PDF"~Format erzeugt und
3095 eingebunden.
3096 %
3097 \begin{Hint}
3098 \usepackage{auto-pst-pdf}
3099 \end{Hint}
3100 %
3101 Bei einigen Pakete kommt es in der Kombination mit \Package{auto-pst-pdf} zu
3102 kleineren Problemen, die sich jedoch meist relativ leicht beheben lassen. Im
3103 Handbuch wird die \tudhyperref{sec:tips:auto-pst-pdf}{gleichzeitige Verwendung}
3104 von \Package{auto-pst-pdf} in Kombination mit den Paketen \Package{tikz}<pgf>,
3105 \Package{todonotes} sowie \Package{floatrow}~-- bei der Nutzung des Befehls
3106 \Macro{ffigbox}(\Package{floatrow})~-- erklärt. Diese Hinweise sollten Sie
3107 gegebenenfalls beachten.
3108
3109 Ähnlich wie zuvor bei der \Package{tikz}<pgf>"~Grafik wird die nachfolgende
3110 \Package{pstricks}"=Abbildung auf die Textbreite des Dokumentes skaliert, wobei
3111 eine Einheit genau \SI{1}{\percent} dieser entspricht. Außerdem werden noch ein
3112 paar weitere Einstellungen gemacht. Dies geschieht mit:
3113 %
3114 \begin{Hint*}
3115 \psset{%
3116 unit=.01\textwidth,%
3117 cornersize=absolute,%
3118 labelsep=.8ex,%
3119 linewidth=.4pt,%
3120 arrowscale=1.5,%
3121 }
3122 \end{Hint*}
3123 %
3124 Die innerhalb einer Gleitumgebung erzeugte \Package{pstricks}"=Grafik ist in
3125 \autoref{fig:pstricks} dargestellt.
3126 \begin{Hint?}
3127 \begin{figure}
3128 \begin{pspicture}(0,-2)(100,64)
3129 \newcommand{\fnodetext}{}
3130 \def\fnodetext(#1)#2#3{%
3131 \fnode[framesize=18 8](#1){#2}%
3132 \rput(#1){\parbox{17\psunit}{\centering\hspace{0pt}#3}}%
3133 }
3134 \newcommand{\scriptbox}[2][24]{%
3135 \parbox{#1\psunit}{\scriptsize\centering\hspace{0pt}#2}%
3136 }
3137 \rput(15,10){%
3138 \rput(0,49){\textbf{Fahrer}}
3139 \fnodetext(0,40){NE}{Navigations\-ebene}
3140 \fnodetext(0,24){BE}{Bahnführungs\-ebene}
3141 \fnodetext(0,08){SE}{Stabilisierungs\-ebene}
3142 \ncline{->}{NE}{BE}
3143 \ncput*{\scriptbox{gewählte Fahrtroute\\ zeitlicher Ablauf}}
3144 \ncline{->}{BE}{SE}
3145 \ncput*{%
3146 \scriptbox{gewählte Führungsgrößen:\\ Sollspur,~Sollgeschwindigkeit}%
3147 }
3148 \psframe[dimen=middle,linewidth=1.2pt,linearc=5](-12.5,0)(12.5,54)
3149 }
3150 \rput(50,10){%
3151 \rput(0,17){\textbf{Fahrzeug}}
3152 \fnodetext(0,8){FZ}{Längs- und\\ Querdynamik}
3153 \psframe[dimen=middle,linewidth=1.2pt,linearc=5](-12.5,0)(12.5,22)
3154 }
3155 \rput(85,10){%
3156 \rput(0,49){\textbf{Umwelt}}
3157 \fnodetext(0,40){SN}{Straßennetz}
3158 \fnodetext(0,24){FR}{%
3159 Fahrraum\\ \smallskip\scriptsize{Straße und Verkehrssituation}%
3160 }
3161 \fnodetext(0,08){FO}{Fahrbahn\-oberfläche}
3162 \psframe[dimen=middle,linewidth=1.2pt,linearc=5](-12.5,0)(12.5,54)
3163 }
3164
3165 \ncline{->}{SE}{FZ}
3166 \naput{\scriptbox[9]{Stell\-größen}}
3167 \nbput{\scriptbox[9]{Lenken Gasgeben Bremsen}}
3168 \ncline{->}{FZ}{FO}
3169 \naput{\scriptbox[9]{Regel\-größen}}
3170 \nbput{\scriptbox[9]{Fahrzeugbewegung}}
3171
3172 \psset{armA=15,armB=0,angleA=0,angleB=180}
3173 \ncangles{->}{FZ}{FR}
3174 \ncangles{->}{FZ}{SN}
3175
3176 \psset{angleA=180,angleB=0}
3177 \ncloop[loopsize=12,arm=4.5]{<-}{SE}{FO}
3178 \naput{\scriptbox{Istspur, Istgeschwindigkeit}}
3179 \ncloop[loopsize=32,arm=5]{<-}{BE}{FR}
3180 \naput{\scriptbox[30]{Bereich sicherer Führungsgrößen}}
3181 \ncloop[loopsize=52,arm=5.5]{<-}{NE}{SN}
3182 \naput{\scriptbox{mögliche Fahrtroute}}
3183 \end{pspicture}
3184 \caption{Eine mit pstricks erstellte Grafik}\label{fig:pstricks}
3185 \end{figure}
3186 \end{Hint?}
3187
3188
3189 \subsection{Auslagern von Grafiken in separate Dateien}
3190 Damit \enquote{programmierte} Grafiken zum einen das Dokument respektive dessen
3191 Struktur nicht unnötig unübersichtlich machen und zum anderen nur nach einer
3192 Änderung abermals kompiliert werden, um die Kompilierungsdauer möglichst gering
3193 zu halten, können diese in separate Dateien ausgelagert werden. Hierfür bieten
3194 sich die Pakete \Package{subfiles}'manual' und \Package{standalone}'manual' an.
3195
3196
3197
3198 \section{Dokumentation von Quelltexten}
3199 Sollen in einer Dokument Quelltextauszüge beschrieben werden oder ganze
3200 Quelltextdateien eingebunden werden, so empfiehlt sich für dieses Vorhaben das
3201 Paket \Package{listings}. Neben der bloßen Einbindung der Quelltexte bietet es
3202 zusätzlich die Möglichkeit, die Syntax in Abhängigkeit der verwendeten
3203 Programmiersprache hervorzuheben. Zusätzlich lässt sich ein Verzeichnis mit
3204 allen eingebundenen sowie direkt im Dokument angegebenen Quelltextauszügen
3205 erstellen.
3206 %
3207 \begin{Hint}
3208 \usepackage{listings}
3209 \end{Hint}
3210 %
3211 Wird das Paket in einem Dokument mit UTF"~8"~Kodierung verwendet, muss dies dem
3212 Paket in der Präambel mitgeteilt werden:
3213 %
3214 \begin{Hint}
3215 \lstset{%
3216 inputencoding=utf8,extendedchars=true,
3217 literate=%
3218 {ä}{{\"a}}1 {ö}{{\"o}}1 {ü}{{\"u}}1
3219 {Ä}{{\"A}}1 {Ö}{{\"O}}1 {Ü}{{\"U}}1
3220 {~}{{\textasciitilde}}1 {ß}{{\ss}}1
3221 }
3222 \end{Hint}
3223 %
3224 Nachdem nun die Grundeinstellungen erfolgt sind, kann ein eigener Stil für eine
3225 gewünschte Programmiersprache definiert werden. Im folgenden Beispiel wird dies
3226 für ein MATLAB"~Skript demonstriert. Als erstes wird mit dem Befehl
3227 \Macro{lstdefinestyle}(\Package{listings}) ein eigener \Package{listings}"~Stil
3228 erstellt:
3229 %
3230 \begin{Hint*}
3231 \lstdefinestyle{matlab}{%
3232 language=Matlab,%
3233 basicstyle=\ttfamily,%
3234 commentstyle={\color{green!50!black}},
3235 keywordstyle={\color{blue!75!black}},%
3236 columns=flexible,keepspaces,%
3237 }
3238 \end{Hint*}
3239 %
3240 Dabei wird die verwendete Programmiersprache definiert sowie die Formatierung
3241 für die Quelltextauszüge festgelegt. Für weitere Einstellungsmöglichkeiten
3242 sollte die Dokumentation zum Paket zu Rate gezogen werden. Der so definierte
3243 Stil lässt sich anschließend folgendermaßen verwenden.
3244 %
3245 \begin{Hint}
3246 \begin{lstlisting}[style=matlab]
3247 §\dots§
3248 \end{lstlisting}
3249 \end{Hint}
3250 %
3251 Soll innerhalb eines Quelltextauszuges ein Abschnitt nicht ausgegeben sondern
3252 als \hologo{LaTeX}"~Code interpretiert und ausgeführt werden, lässt sich mit
3253 \Macro{lstset}[%
3254 \PParameter{\PValue{escapechar=\PName{Zeichen}}}%
3255 ](\Package{listings}) ein spezielles Escape-Zeichen definieren. Alle innerhalb
3256 einer \Package{listings}"=Umgebung zwischen zwei Escape-Zeichen eingefügten
3257 Angaben in der Form \PName{Zeichen}\PValue{\dots}\PName{Zeichen} werden als
3258 \hologo{LaTeX}"~Code gelesen und ausgeführt. Außerdem ist es mit dem Befehl
3259 \Macro{lstnewenvironment}(\Package{listings}) möglich, eine individuelle
3260 \Package{listings}"=Umgebung zu definieren.
3261
3262 Das Einbinden und Darstellen von externen Quelldateien in ein Dokument ist über
3263 den Befehl
3264 \Macro{lstinputlisting}[\LParameter\Parameter{Dateiname}](\Package{listings})
3265 möglich, wobei dabei im optionalen Argument ebenfalls der definierte Stil
3266 angegeben werden sollte. Es folgt die Ausgabe eines kurzen Beispiels mit dem
3267 zuvor definierten Stil~\PValue{matlab}.
3268 %
3269 \begin{lstlisting}[style=matlab]
3270 function perfect = isperfect(test_value)
3271 % This function checks to see if the given number is "perfect";
3272 % a "perfect" number is an integer whose factors
3273 % (excluding itself) add up to it.
3274 %
3275 % Example: 6 is a perfect number: 1 + 2 + 3 = 6 == 6
3276 % 8 is not: 1 + 2 + 4 = 7 ~= 8
3277 % 28 is a perfect number: 1 + 2 + 4 + 7 + 14 = 28 == 28
3278 %
3279 % Arguments:
3280 % test_value (input) check to see if this value
3281 % is perfect or not
3282 % perfect (output) if yes, set this to 1
3283 % if no, set this to 0
3284 %
3285 % this will keep track of the sum of all integer divisors
3286 tempsum = 0;
3287 % we check all possible divisors
3288 for (divisor = 1 : test_value - 1)
3289 div_result = test_value / divisor;
3290 if (div_result == floor(div_result))
3291 % this is an integer divisor, so add it to the sum
3292 tempsum = tempsum + divisor;
3293 end
3294 end
3295 % now, does the sum equal the test_value?
3296 if (tempsum == test_value)
3297 perfect = 1;
3298 else
3299 perfect = 0;
3300 end
3301 end
3302 \end{lstlisting}
3303
3304
3305
3306
3307 \section{Und ganz zum Schluss \dots}
3308 Mit Sicherheit werden Sie im Laufe der Zeit auf die eine oder andere Frage zu
3309 \hologo{LaTeXe} stoßen, die in diesem Tutorial nicht behandelt wurde. Sollten
3310 Sie an diesen Punkt gelangen, so empfehle zunächst einen Blick in die Kapitel
3311 \tudhyperref{sec:packages}{Benötigte, unterstützte und empfehlenswerte Pakete}
3312 sowie \tudhyperref{sec:tips}{Praktische Tipps \& Tricks} im Handbuch zu
3313 \TUDScript. Sollte Ihre Frage trotzdem unbeantwortet bleiben, so wäre der
3314 Besuch eines \hologo{LaTeX}"=Forums der nächste Schritt. Für allgemeine
3315 Anfragen kann ich unter anderem folgende Foren empfehlen:
3316 %
3317 \begin{itemize}
3318 \item \hrfn{http://mrunix.de/forums/forumdisplay.php?38-LaTeX-Forum}{mrunix}
3319 \item \hrfn{http://golatex.de/}{golatex}
3320 \item \hrfn{http://tex.stackexchange.com/}{\hologo{LaTeX} Stack Exchange}
3321 \item \hrfn{http://www.latex-community.org/forum/}{\hologo{LaTeX} Community}
3322 \end{itemize}
3323 %
3324 Insbesondere alle \TUDScript betreffende Fragen sollten natürlich direkt im
3325 dazugehörigen \Forum gestellt werden.
3326
3327 \begin{Trunk+}
3328 \printbibliography[heading=bibintoc]\label{sec:bibliography}%
3329 \end{Trunk+}
3330 \printbibliography[heading=bibintoc]
3331
3332 \begin{Preamble+}
3333 \usepackage[colorlinks,linkcolor=blue]{hyperref}
3334
3335 \end{Preamble+}
3336
3337 \addsec{Index}
3338 Da das Tutorial etwas umfangreicher ist, wird für alle erläuterten Optionen,
3339 Umgebungen und Befehle ein Index erstellt. Bei Elementen, die weder \TUDScript
3340 noch \KOMAScript{} zuzuordnen sind, wird das dazugehörige Paket mit angeführt.
3341 \PrintIndex
3342
3343 \FinishTutorial[%
3344 Um das im kopierten Beispiel erstellte Literaturverzeichnis in das Dokument
3345 einbinden zu können, bedarf es dem einmaligen Aufruf von \Application{biber}
3346 frühestens nach dem ersten Durchlauf von \Engine{pdfLaTeX}. Dies erfolgt mit
3347 dem Aufruf \Path{biber }\PName{Dateiname}. Für das Erzeugen von Abkürzungs-
3348 und Symbolverzeichnis ist das Ausführen des Perl"=Skriptes
3349 \Path{makeglossaries }\PName{Dateiname} ausreichend. Danach ist ein weiteres
3350 mal die Verwendung von \Path{pdflatex }\PName{Dateiname} notwendig, um die
3351 Verzeichnisse in das Dokument einzubinden. Gegebenenfalls ist für korrekte
3352 Seitenangaben in Abkürzungs- und Symbolverzeichnis ein abermaliges Ausführen
3353 des Skriptes notwendig.
3354 \Attention{%
3355 Nutzer von \Distribution{\hologo{MiKTeX}} müssen für die Verwendung des
3356 Perl"~Skriptes \File{makeglossaries}(\Package{glossaries}) unter Umständen
3357 einen separaten Perl"=Interpreter installieren. In \autoref{sec:glossaries}
3358 ist dazu mehr zu finden.%
3359 }%
3360 ]
3361 \ListOfToDo
3362 \end{document}