\chapter{Einleitung} % Zur fehlerfreien Verwendung der \TUDScript-Klassen der Version~\vTUDScript{} werden sowohl die \KOMAScript"=Klassen~\vKOMAScript{} oder später als auch die beiden Hausschriften des \CDs \Univers und \DIN zwingend benötigt. Außerdem müssen weitere Pakete durch die genutzte \hologo{LaTeX}"=Distribution bereitgestellt werden. Bei den aktuellen Distributionen \index{Distribution}% \Distribution{\hologo{TeX}~Live}[2016]|?|, \Distribution{Mac\hologo{TeX}}[2016]|?| und \Distribution{\hologo{MiKTeX}}[2.9]|?| ist das mit großer Sicherheit kein Problem. Nutzen Sie jedoch eine frühere Distribution, könnte dies zu Problemen führen. Dann sollte bestenfalls eine der aktuellen Distributionen installiert werden. Ist dies nicht möglich, müssen die unter \autoref{sec:packages:needed} aufgeführten Pakete sowie \TUDScript (\autoref{sec:local:install}) in der jeweils benötigten Version lokal installiert werden. Das Vorlagenpaket von Klaus Bergmann ist für die Verwendung nicht notwendig. Allerdings beinhaltet dieses weitere Klassen zum Erstellen von Folien und Briefen.% \footnote{% \Class{tudbook}, \Class{tudbeamer}, \Class{tudletter}, \Class{tudfax}, \Class{tudhaus}, \Class{tudform}% } Das \TUDScript"=Bundle ist hauptsächlich für das Erstellen wissenschaftlicher Texte und Arbeiten gedacht und soll die ursprünglichen Vorlagen \emph{momentan} nicht ersetzen sondern vielmehr ergänzen. Eine Umsetzung des \CDs für die \Class{beamer}"=Klasse sowie für Briefe und Geschäftsschreiben auf Basis der \KOMAScript"=Brief"=Klasse \Class{scrlttr2} ist bis jetzt leider noch nicht entstanden, soll jedoch langfristig bereitgestellt werden. Allerdings existieren bereits im Bundle \Class{tudmathposter} für die \Class{beamer}"=Klasse mehrere Stile. Das Bundle ist sowohl bei \hrfn{https://github.com/tud-cd/tud-cd}{GitHub} als auf der \hrfn{https://tu-dresden.de/cd/4_latex}{\hologo{LaTeX}-Seite der \TnUD} zu finden. \section{Zur Verwendung dieses Handbuchs} Sämtliche neu definierten Optionen, Umgebungen und Befehle der \TUDScript-Klassen und \TUDScript-Pakete werden im Handbuch aufgeführt und beschrieben. Am Ende des Dokumentes befinden sich mehrere Indexe, die das Nachschlagen oder Auffinden von bisher unbekannten Befehlen oder Optionen erleichtern sollen. Die im Folgenden beschriebenen Optionen können~-- wie ein Großteil aller Einstellungen für \KOMAScript~-- in der Syntax des \Package{keyval}"=Paketes als Schlüssel"=Wert"=Paare bei der Wahl der Dokumentklasse angegeben werden: \Macro*{documentclass}[% \POParameter{\PName{Schlüssel}\PValue{=}\PName{Wert}}\Parameter{Klasse}% ] Des Weiteren eröffnen die \KOMAScript"=Klassen die Möglichkeit der späten Optionenwahl. Damit können Optionen nicht nur direkt beim Laden als sogenannte Klassenoptionen angegeben werden, sondern lassen sich auch noch innerhalb des Dokumentes nach dem Laden der Klasse ändern. Die \KOMAScript"=Klassen sehen hierfür zwei Befehle vor. Mit \Macro{KOMAoptions}[\Parameter{Optionenliste}](\Package{koma-script})'none' lassen sich beliebig viele Schlüsseln jeweils genau einen Wert zuweisen, \Macro{KOMAoption}[% \Parameter{Option}\Parameter{Werteliste}% ](\Package{koma-script})'none' erlaubt das gleichzeitige Setzen mehrere Werte für genau einen Schlüssel. Äquivalent dazu werden für die von \TUDScript \emph{zusätzlich} zur Verfügung gestellten Optionen die Befehle \Macro{TUDoptions}[\Parameter{Optionenliste}] und \Macro{TUDoption}[\Parameter{Option}\Parameter{Werteliste}] definiert. Damit kann das Verhalten von Optionen im Dokument~-- innerhalb einer Gruppe auch lokal~-- geändert werden. Die Voreinstellung jeder Option wird mit \enquote{Standardwert:\,\PName{Wert}} bei deren Beschreibung angeführt. Einige dieser Voreinstellungen sind nicht immer gleich sondern werden in Abhängigkeit der genutzten Benutzereinstellungen und Optionen gesetzt. Diese bedingten Voreinstellungen werden durch \enquote{% Standardwert:\,\PName{Wert}% \PValue{\,|\,}Bedingung:\,\PName{bedingter~Wert}% } angegeben. Wird ein Schlüssel durch den Benutzer \emph{ohne} eine Wertzuweisung genutzt, so wird~-- falls vorhanden~-- ein vordefinierter Säumniswert gesetzt, welcher in der Beschreibung aller Optionen durch die~\PValue{\emph{kursive}} Schreibweise innerhalb der Werteliste gekennzeichnet ist. In den meisten Fällen ist der Säumniswert eines Schlüssels \PValue{true}, er entspricht folglich der Angabe \PName{Schlüssel}\PValue{=true}. Mit der expliziten Wertzuweisung eines Schlüssels durch den Benutzer werden immer sowohl normale als auch bedingte Voreinstellungen überschrieben. Die neben den Optionen neu eingeführten Befehle und Umgebungen der Klassen werden im gleichen Stil erläutert. \section{Installation des \TUDScript-Bundles} \tudhyperdef*{sec:install}% \index{Installation|!(}% \index{Update}% % \ChangedAt{% v2.01:\TUDScript-Bundle auf CTAN veröffentlicht;% v2.02:Installationsroutine der PostScript-Schriften angepasst;% v2.04:Installationsskripte verbessert und robuster gestaltet sowie für die beiden portablen Distributionen \Distribution*{\hologo{TeX}~Live~Portable} und \Distribution*{\hologo{MiKTeX}~Portable} erweitert } % Das \TUDScript-Bundle ist seit der Version~v2.01~-- aufgrund lizenzrechtlicher Bedingungen \emph{ohne} die geschützten Schriften \Univers und \DIN~-- im \CTAN zu finden und kann dadurch die aktuellen \hologo{LaTeX}"=Distributionen wie \Distribution{\hologo{TeX}~Live}[2016]|?|, \Distribution{Mac\hologo{TeX}}[2016]|?| oder auch \Distribution{\hologo{MiKTeX}}[2.9]|?| genutzt werden. Es besteht momentan aus den drei Hauptklassen \Class{tudscrbook}, \Class{tudscrreprt} sowie \Class{tudscrartcl}~-- dokumentiert in \autoref{sec:mainclasses}~-- und sowohl mit den \TUDScript-Klassen assoziierten als auch eigenständigen Paketen, welche in \autoref{sec:bundle} beschrieben sind. Zur problemlosen Verwendung des \TUDScript-Bundles ist~-- neben \KOMAScript{} mindestens in der Version~\vKOMAScript{} sowie den in \autoref{sec:packages:needed} aufgeführten \hologo{LaTeX}"=Paketen~-- lediglich eine Installation der PostScript"=Schriften des \TUDCDs notwendig. Diese müssen über das Universitätsmarketing auf \hrfn{https://tu-dresden.de/cd/1_basiselemente/03_hausschrift/}{Anfrage} mit dem Hinweis auf die Verwendung von \hologo{LaTeX} bestellt werden. Sobald Sie die notwendigen Archive \File{Univers\_PS.zip} und \File{DIN\_Bd\_PS.zip} erhalten haben, können die Schriften für Windows (\autoref{sec:install:win}) beziehungsweise unixoide Betriebssysteme (\autoref{sec:install:unix}) installiert werden. Die benötigten Skripte werden als \hrfn{https://github.com/tud-cd/tudscr/releases/tag/fonts}{Release} im \GitHubRepo* bereitgestellt.% \footnote{% Die Verwendung von installierten Systemschriften im Open-Type-Format mit dem Paket \Package{fontspec} für \Engine{LuaLaTeX} oder \Engine{XeLaTeX} wird mittlerweile unterstützt, mehr dazu in \autoref{sec:fonts:fontspec}.% } \Attention{% Die Skripte erzeugen für die Schriftinstallation \textbf{temporär} einige Verzeichnisse und Dateien, weshalb diese nur fehlerfrei auf einem Laufwerk ausgeführt werden können, auf dem der Anwender selbst Schreibrechte besitzt. } \minisec{Anmerkung zu Windows} Sollte Windows genutzt werden und noch keine \hologo{LaTeX}"=Distribution auf ihrem System installiert sein, so rate ich persönlich zur Verwendung von \Distribution{\hologo{TeX}~Live}|?| statt \Distribution{\hologo{MiKTeX}}|?|. Der Vorteil dieser Distribution liegt zum einen in der Wartung durch mehrere Autoren sowie der früheren Verfügbarkeit aller Updates über CTAN. Zum anderen liefert \Distribution{\hologo{TeX}~Live}|?| zusätzlich zu \hologo{LaTeXe} einen \textsc{Perl}"=Interpreter sowie \textsc{Ghostscript}, wodurch die Ad"=hoc"=Verwendung einiger Pakete wie beispielsweise \Package{glossaries} vereinfacht beziehungsweise verbessert wird. \minisec{Anmerkung zu Linux und OS~X} Die Installation von \Distribution{\hologo{TeX}~Live}|?| beziehungsweise \Distribution{Mac\hologo{TeX}}|?| sollte direkt über die im Internet angebotenen Installationspakete (\url{https://tug.org/texlive/} respektive \url{https://tug.org/mactex/}) und nicht über \Path{apt-get install} erfolgen. % Die Installation der Schriften des \CDs \emph{muss zwingend} über das Terminal ausgeführt werden. Nach dem Entpacken eines Release-Archivs sollte im passenden Pfad (beispielsweise \Path{cd~"\$HOME/Downloads/\PName{Unterordner}"}) das Skript aus dem Terminal mit \Path{bash \PName{Skript}.sh} direkt ausgeführt werden. Mehr dazu ist in \autoref{sec:install:unix} zu finden. \minisec{Anmerkung zu \NoCaseChange{\hologo{MiKTeX}}} Vor der Installation der Schriften für \TUDScript sollte unbedingt ein Update von \Distribution{\hologo{MiKTeX}}|?| durchgeführt werden. Andernfalls wird es mit großer Sicherheit zu Problemen kommen. Außerdem ist es sehr ratsam, die Installation von \Distribution{\hologo{MiKTeX}}|?| in der Mehrbenutzervariante mit Administratorrechten durchzuführen, da die Einzelbenutzervariante relativ unregelmäßig und nicht immer nachvollziehbar zu Problemen führen kann. Möglicherweise sind einige der für den Schriftinstallationsprozess notwendigen Pakete \Package{fontinst}, \Package{fontware} sowie \Package{cmbright}, \Package{hfbright}, \Package{cm-super}, \Package{lmodern} und \Package{iwona} noch nicht installiert. Ist die automatische Nachinstallation fehlender Pakete aktiviert, so reicht es im Normalfall das Installationsskript zu starten. Andernfalls müssen diese Pakete manuell durch den Benutzer über den \Distribution{\hologo{MiKTeX}}"=Paketmanager hinzugefügt werden. Das Installationsskript scheitert außerdem bei einigen Anwendern~-- aufgrund eingeschränkter Nutzerzugriffsrechte~-- beim Eintragen der Schriften in die Map"~Datei. Dies muss gegebenenfalls durch den Anwender über die Kommandozeile \Path{initexmf -{}-edit-config-file updmap} erfolgen. In der sich öffnenden Datei sollte sich der Eintrag \Path{Map tudscr.map} befinden. Ist dies nicht der Fall, muss diese Zeile manuell eingetragen und die Datei anschließend gespeichert werden. Danach muss der Nutzer in der Kommandozeile noch \Path{initexmf -{}-mkmaps} ausführen. \minisec{Anmerkung zu \NoCaseChange{\hologo{TeX}}~Live und Mac\NoCaseChange{\hologo{TeX}}% } Für den Schriftinstallationsprozess werden die Pakete \Package{fontinst}, \Package{fontware} sowie \Package{cmbright}, \Package{hfbright}, \Package{cm-super}, \Package{lmodern} und \Package{iwona} benötigt. Sollte keine Vollinstallation von \Distribution{\hologo{TeX}~Live} durchgeführt worden sein, müssen diese Pakete sehr wahrscheinlich manuell durch den Benutzer über den \Distribution{\hologo{TeX}~Live}"=Paketmanager hinzugefügt werden. Sind nach einem fehlerfreien Durchlauf des Installationsskriptes die Schriften dennoch nicht verfügbar, so lässt sich mit \Path{updmap-sys -{}-syncwithtrees} die Synchronisierung aller Schriftdateien anstoßen. Daran anschließend muss mit \Path{updmap-sys -{}-enable Map=tudscr.map} die Map"~Datei und die dazugehörigen Schriftdateien mit \Path{updmap-sys -{}-force} registriert werden. Sind die Schriften danach immer noch nicht verfügbar, so wurden bestimmt schon weitere Schriften auf dem System \emph{lokal} installiert. In diesem Fall sollte der Vorgang nochmals für eine lokale Schriftinstallation mit \Path{updmap -{}-syncwithtrees}, \Path{updmap -{}-enable Map=tudscr.map} und \Path{updmap -{}-force} ausgeführt werden. Dieses Vorgehen macht allerdings den Befehl \Path{updmap-sys} von nun an wirkungslos. Nach einer systemweiten Installation neuer Schriften~-- beispielsweise bei der Aktualisierung der Distribution~-- müssen diese über den manuellen Aufruf von \Path{updmap} zukünftig durch den Anwender lokal bei \Distribution{\hologo{TeX}~Live}|?| respektive \Distribution{Mac\hologo{TeX}}|?| registriert werden. \Attention{% Für die Schriftinstallation werden die Skripte \Path{tftopl}, \Path{pltotf} und \Path{vptovf} benötigt, welche bei \Distribution{\hologo{TeX}~Live}|?| beziehungsweise \Distribution{Mac\hologo{TeX}}|?| über das Paket \Package*{fontware} aus \Package*{collection-fontutils}<> bereitgestellt werden und zwingend installiert sein müssen. } \minisec{Weiterführende Installationshinweise} In \autoref{sec:install:ext} sind zusätzliche Varianten der Installation von \TUDScript zu finden. Soll eine ältere lokale Nutzerinstallation entfernt werden, um zukünftig alle Aktualisierungen direkt über die jeweils verwendete Distribution durchzuführen, werden entsprechende Skripte zu Deinstallation in \autoref{sec:local:uninstall} zur Verfügung gestellt. Will der Anwender \emph{bewusst} eine lokale Nutzerinstallation anlegen, werden hierfür in \autoref{sec:local:install} entsprechende Skripte bereitgestellt. Soll eine bereits vorhandene, lokale Nutzerinstallation aktualisiert werden, finden Sie die entsprechenden Skripte in \autoref{sec:local:update}. Für die portablen Varianten von \Distribution{\hologo{TeX}~Live~Portable} respektive \Distribution{\hologo{MiKTeX}~Portable} sind zusätzliche Installationshinweise in \autoref{sec:install:portable} zu finden. \subsection{Installation der PostScript-Schriften unter Windows} \tudhyperdef*{sec:install:win}% % Zur Installation der Schriften des \CDs für das \TUDScript-Bundle ist das Archiv \hrfn{https://github.com/tud-cd/tudscr/releases/download/fonts/TUD-KOMA-Script_fonts_Windows.zip}{\File*{TUD-KOMA-Script\_fonts\_Windows.zip}} vorgesehen. Dieses ist sowohl für \Distribution{\hologo{TeX}~Live}|?| als auch \Distribution{\hologo{MiKTeX}}|?| nutzbar und enthält~-- bis auf die jeweiligen Schriftarchive selbst~-- alle benötigten Dateien. Diese sollten nach dem Entpacken des Archivs in das gleiche Verzeichnis kopiert werden. Vor der Verwendung des Skripts \File{tudscr\_fonts\_install.bat} sollte sichergestellt werden, dass sich \emph{alle} der folgenden Dateien im selben Verzeichnis befinden: % \settowidth\tempdim{\File{tudscr\_fonts\_install.zip}~}% \begin{description}[labelwidth=\tempdim,labelsep=1em] \item[\File{tudscr\_fonts\_install.bat}]Installationsskript \item[\File{Univers\_PS.zip}]Archiv mit Schriftdateien für \Univers \item[\File{DIN\_Bd\_PS.zip}]Archiv mit Schriftdateien für \DIN \item[\File{tudscr\_fonts\_install.zip}]Archiv mit Metriken für die Schriftinstallation via \Package{fontinst} \end{description} % Beim Ausführen des Installationsskripts werden alle Schriften standardmäßig in ein lokales Nutzerverzeichnis installiert. Wird das Skript über das Kontextmenü mit Administratorrechten ausgeführt, erfolgt die Installation in einem Pfad, der \emph{für alle Nutzer} gültig und lesbar ist. \subsection{Installation der PostScript-Schriften unter Linux und OS~X} \tudhyperdef*{sec:install:unix}% % Für die Erstellung des Installationsskripts für Linux und OS~X geht mein Dank an Jons-Tobias Wamhoff, der sich für die erstmalige Portierung des Skripts von Windows zu unixartigen Systemen freiwillig zur Verfügung stellte. Zur Installation der Schriften des \CDs für das \TUDScript-Bundle ist das Archiv \hrfn{https://github.com/tud-cd/tudscr/releases/download/fonts/TUD-KOMA-Script_fonts_Unix.zip}{\File*{TUD-KOMA-Script\_fonts\_Unix.zip}} vorgesehen. Dieses ist sowohl für \Distribution{\hologo{TeX}~Live}|?| als auch \Distribution{Mac\hologo{TeX}}|?| nutzbar und enthält~-- bis auf die jeweiligen Schriftdateien selbst~-- alle benötigten Dateien. Diese sollten nach dem Entpacken des Archivs in das gleiche Verzeichnis kopiert werden. Vor der Verwendung des Skripts \File{tudscr\_fonts\_install.sh} sollte sichergestellt werden, dass sich \emph{alle} der folgenden Dateien im selben Verzeichnis befinden: % \begin{description}[labelwidth=\tempdim,labelsep=1em] \item[\File{tudscr\_fonts\_install.sh}]Installationsskript (Terminal: \Path{bash tudscr\_fonts\_install.sh}) \item[\File{Univers\_PS.zip}]Archiv mit Schriftdateien für \Univers \item[\File{DIN\_Bd\_PS.zip}]Archiv mit Schriftdateien für \DIN \item[\File{tudscr\_fonts\_install.zip}]Archiv mit Metriken für die Schriftinstallation via \Package{fontinst} \end{description} % \Attention{% Das Installationsskript \textbf{muss} mit \Path{bash \PName{Skript}.sh} im Terminal im Pfad mit den benötigten Dateien aufgerufen werden. } Dabei werden alle Schriften standardmäßig in das lokale Nutzerverzeichnis (\Path{\$TEXMFHOME}) installiert. Wird das Skript mit \Path{sudo} verwendet, erfolgt die Installation \emph{für alle Nutzer} in den lokalen Systempfad (\Path{\$TEXMFLOCAL}). Es ist unbedingt darauf zu Achten, das beim Ausführen des Skriptes das Terminal im richtigen Verzeichnis aktiv ist. Bei den meisten unixoiden Betriebssystemen ist es problemlos möglich, das Terminal aus der Benutzeroberfläche heraus über das Kontextmenü im gewünschten Pfad zu öffnen. Geht dies nicht, so muss nach dem Öffnen des Terminals mit dem Befehl \Path{cd} erst zum entsprechenden Pfad~-- exemplarisch \Path{cd~"\$HOME/Downloads/\PName{Unterordner}"}~-- navigiert werden. Ein beispielhafter Aufruf im Terminal könnte also lauten: % \begin{quoting} \Path{% cd~"\$HOME/Downloads/TUD-KOMA-Script\_fonts\_Unix"{}\,\POParameter{ENTER} }\newline \Path{bash tudscr\_fonts\_install.sh\,\POParameter{ENTER}} \end{quoting} \subsection{Probleme bei der Installation der PostScript-Schriften} % Wird Windows verwendet, kann es unter Umständen vorkommen, dass notwendige Befehlsaufrufe für das Installationsskript nicht ausgeführt werden können. In diesem Fall ist der Pfad zu den benötigten Dateien, welche normalerweise unter \Path{\%SystemRoot\%\textbackslash System32} zu finden sind, nicht in der Umgebungsvariable \Path{PATH} enthalten. Einen Hinweis zur Problemlösung ist \hrfn{http://latex.wcms-file3.tu-dresden.de/phpBB3/viewtopic.php?t=359}{% in diesem Beitrag im Forum% } zu finden. Treten bei der Installation wider Erwarten Probleme auf, so ist zur Lösung eine Logdatei zu erstellen. Hierfür sollte unter \textbf{Windows} das Skript, welches Probleme verursacht, \emph{nicht} aus der Kommandozeile oder dem Explorer heraus sondern über \emph{Windows PowerShell} ausgeführt werden. Hierfür ist die Eingabe von \enquote{PowerShell} im Startmenü von Windows mit einem nachfolgenden Öffnen mittels \POParameter{ENTER}"~Taste ausreichend. Danach muss mit \Path{cd} zum Ordner des Skriptes navigiert und dieses mit \Path{.\textbackslash\PName{Skript}.bat|Tee-Object -file \PName{Skript}.log} ausgeführt werden. Ein Aufruf aus der PowerShell"~Konsole könnte lauten: % \begin{quoting}[rightmargin=0pt] \Path{% cd~"\$env:USERPROFILE\textbackslash{}Downloads\textbackslash{}% TUD-KOMA-Script\_fonts\_Windows"{}\,\POParameter{ENTER}% }\newline% \Path{% .\textbackslash{}tudscr\_fonts\_install.bat% |Tee-Object\,-file\,tudscr\_fonts\_install.log\,\POParameter{ENTER}% } \end{quoting} % Für \textbf{unixartige Systeme} ist der Aufruf \Path{bash \PName{Skript}.sh > \PName{Skript}.log} aus dem Terminal heraus zu verwenden. Ein exemplarischer Aufruf im könnte lauten: % \begin{quoting} \Path{% cd~"\$HOME/Downloads/TUD-KOMA-Script\_fonts\_Unix"{}\,\POParameter{ENTER} }\newline \Path{bash tudscr\_fonts\_install.sh\,\POParameter{ENTER}} \end{quoting} % Die erstellte Logdatei sollte \emph{mit einer kurzen Fehlerbeschreibung} direkt an \Email{\tudscrmail} gesendet werden. \index{Installation|!)}% \section{Schnelleinstieg} Das Handbuch gliedert sich in drei Teile. In \autoref{part:main} ist die Dokumentation von \TUDScript zu finden. Hier werden alle neuen Optionen, Umgebungen und Befehle, die über die Funktionalität von \KOMAScript{} hinausgehen, erläutert. \autoref{part:additional} enthält zum einen einfache Minimalbeispiele, um den prinzipiellen Umgang und die Funktionalitäten von \TUDScript zu demonstrieren. Zum anderen werden hier auch ausführliche und dokumentierte Tutorials vor allem für \hologo{LaTeX}"=Neulinge angeboten. Insbesondere das Tutorial \Tutorial{treatise} ist mehr als einen Blick wert, wenn eine wissenschaftliche Arbeit mit \hologo{LaTeXe} verfasst werden soll. Abschließend werden verschiedenste Pakete vorgestellt, die nicht speziell für das \TUDScript-Bundle selber sondern auch für andere \hologo{LaTeX}"=Klassen verwendet werden können und demzufolge für alle \hologo{LaTeX}"=Anwender interessant sein könnten. Außerdem werden hier einige Tipps \& Tricks beim Umgang mit \hologo{LaTeX} beschrieben, um kleinere oder größere Probleme zu lösen. Die Klassen \Class{tudscrbook}, \Class{tudscrreprt} und \Class{tudscrartcl} sind Wrapper"=Klassen der bekannten \KOMAScript-Klassen \Class{scrbook}, \Class{scrreprt} sowie \Class{scrartcl} und können einfach anstelle deren verwendet werden. Auf diesen basierende Dokumente können durch das Umstellen der Dokumentklasse einfach in das \TUDCD überführt werden. Bei Fragestellungen bezüglich Layout, Schriften oder ähnlichem ist in jedem Fall ein weiterer Blick in das hier vorliegende Handbuch empfehlenswert.