diff --git a/.gitignore b/.gitignore index 72f1341d..c1aaac50 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,6 @@ ## binaries folder development/ -release/ +release*/ temp/ ## auxiliary files *-temp.* @@ -40,3 +40,7 @@ temp/ *.tut *.wrt *.xdy +!poster/*.cls +!poster/*.sty +!poster/*.pdf +!poster/CD/* diff --git a/LICENSE.md b/LICENSE.md index 227e6145..2b19659f 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,7 +1,7 @@ ============================================================================ TUD-KOMA-Script - Copyright (c) Falk Hanisch , 2012-2014 + Copyright (c) Falk Hanisch , 2012-2015 ============================================================================ @@ -15,12 +15,12 @@ ---------------------------------------------------------------------------- - Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz, - Version 1.3c, verteilt und/oder verändert werden. Die neuste Version - dieser Lizenz ist http://www.latex-project.org/lppl.txt und Version 1.3c - ist Teil aller Verteilungen von LaTeX 2005/12/01 oder später und dieses - Werks. Dieses Werk hat den LPPL-Verwaltungs-Status "author-maintained", - wird somit allein durch den Autor verwaltet. Der aktuelle Verwalter und - Autor dieses Werkes ist Falk Hanisch. + Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz + in der Version 1.3c, verteilt und/oder veraendert werden. Die aktuelle + Version dieser Lizenz ist http://www.latex-project.org/lppl.txt und + Version 1.3c oder spaeter ist Teil aller Verteilungen von LaTeX 2005/12/01 + oder spaeter und dieses Werks. Dieses Werk hat den LPPL-Verwaltungs-Status + "author-maintained", wird somit allein durch den Autor verwaltet. Der + aktuelle Verwalter und Autor dieses Werkes ist Falk Hanisch. ============================================================================ diff --git a/README.md b/README.md index 3a863e59..295470d8 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,11 @@ TUD-KOMA-Script =============== -TUD-KOMA-Script 2014/12/17 v2.02 -Copyright (c) Falk Hanisch , 2012-2014 +TUD-KOMA-Script 2015/02/15 v2.03 +Copyright (c) Falk Hanisch , 2012-2015 -This material is subject to the LaTeX Project Public License. -See http://www.latex-project.org/lppl.txt for the details of that license. +This material is subject to the LaTeX Project Public License version 1.3c or +later. See http://www.latex-project.org/lppl.txt for details of that license. English text below @@ -18,11 +18,14 @@ Zusammenfassung Das TUD-KOMA-Script-Bundle stellt sowohl Klassen als auch Pakete bereit, um LaTeX-Dokumente im Corporate Design der Technischen Universität Dresden zu erstellen. Es basiert auf dem KOMA-Script-Bundle, welches zwingend vorhanden -sein muss. Außerdem sind die PostScript-Schriftfamilien Univers und DIN-Bold -erforderlich. Mitarbeiter und Studenten der Technischen Universität Dresden -können diese unter https://tu-dresden.de/service/publizieren/cd/4_latex vom -Universitätsmarketing mit dem Hinweis auf die Verwendung von LaTeX anfordern. +sein muss. Außerdem sollten die beiden PostScript-Schriftfamilien Univers und +DIN-Bold installiert werden. Geschieht dies nicht, können die Dokumentklassen +zwar genutzt werden, die ausgegebenen Dokumente entsprechen in diesem Fall +jedoch nicht dem ursprünglich erhofftem Stil. +Mitarbeiter und Studenten der Technischen Universität Dresden können die +Schriftdateien unter https://tu-dresden.de/service/publizieren/cd/4_latex vom +Universitätsmarketing mit dem Hinweis auf die Verwendung von LaTeX anfordern. Für die Installation der PostScript-Schriften sei auf den entsprechenden Release unter https://github.com/tud-cd/tudscr/releases/tag/fonts und das LaTeX-Forum der Technischen Universität Dresden verwiesen: @@ -51,6 +54,15 @@ Versionen --------- +**v2.03** (2015/02/15) + ++ Anpassungen an KOMA-Script v3.15 ++ Verbesserung des Satzspiegels für das Corporate Design ++ Kopf und Fuß können farbig dargestellt werden ++ Logos in der Fußzeile für Titel und dergleichen möglich ++ kleinere Fehlerkorrekturen + + **v2.02** (2014/12/17) + Paket `tudscrfonts` @@ -99,6 +111,7 @@ Versionen + erste Version des TUD-KOMA-Script-Bundles + ------------------------------------------------------------------------------- Summary @@ -107,14 +120,16 @@ Summary The TUD-KOMA-Script bundle provides both classes and packages in order to create LaTeX documents in the corporate design of the Technische Universität Dresden. It bases on the KOMA-Script bundle, which must necessarily be present. -In addition, the PostScript font families Univers and DIN-Bold are required. +In addition, the PostScript font families Univers and DIN-Bold should be +installed. Otherwise, the document classes can admittedly be used, but in this +case, the created documents do not correspond to the originally thought style. + Employees and students of the Technische Universität Dresden can request these fonts via https://tu-dresden.de/service/publizieren/cd/4_latex from the -university marketing university marketing with regard to the use of LaTeX. - -To install the PostScript fonts, please refer to the corresponding release -under https://github.com/tud-cd/tudscr/releases/tag/fonts and the LaTeX forum -of the Technische Universität Dresden: +university marketing university marketing with regard to the use of LaTeX. To +install the PostScript fonts, please refer to the corresponding release under +https://github.com/tud-cd/tudscr/releases/tag/fonts and the LaTeX forum of the +Technische Universität Dresden: http://latex.wcms-file3.tu-dresden.de/phpBB3/index.php Classes and Packages @@ -139,6 +154,15 @@ Versions -------- +**v2.03** (2015/02/15) + ++ adjustments to KOMA-Script v3.15 ++ improvement of the corporate design type area ++ colored head and foot possible ++ including logos in the foot for the title etc. ++ a few little bux fixes + + **v2.02** (2014/12/17) + package `tudscrfonts` @@ -159,17 +183,17 @@ Versions **v2.01b** (2014/06/04) -+ Fixed bug when using task (tudscrsupervisor) ++ fixed bug when using task (tudscrsupervisor) **v2.01a** (2014/06/03) -+ Fixed bug when using the subtitle. ++ fixed bug when using the subtitle **v2.01** (2014/04/24) -+ Fixes the kerning of the digits and the font weight at the title page. ++ fixes the kerning of the digits and the font weight at the title page **v2.00** (2014/04/22) diff --git a/addon/tudscr4texstudio/tudscr.cwl b/addon/tudscr4texstudio/tudscr.cwl index b6236285..4f4549d5 100644 --- a/addon/tudscr4texstudio/tudscr.cwl +++ b/addon/tudscr4texstudio/tudscr.cwl @@ -40,8 +40,8 @@ \upPhi \upPsi \upOmega -\pageheadingvskip{length} -\headingvskip{length} +\pageheadingvskip +\headingvskip \faculty{text} \department{text} \institute{text} @@ -49,6 +49,10 @@ \extraheadline{textadline} \headlogo{file} \headlogo[parameters]{file} +\footlogo{file(s)} +\footlogo[parameters]{file(s)} +\footlogosep +\footlogoheight \begin{tudpage} \begin{tudpage}[parameter] \end{tudpage} @@ -56,18 +60,12 @@ \maketitle[pagenumber] \maketitleonecolumn{text} \maketitleonecolumn[pagenumber]{text} -\extratitle{text} -\titlehead{text} -\title{text} -\subtitle{text} -\publishers{text} -\thanks{text} -\uppertitleback{text} -\lowertitleback{text} -\dedication{text} -\author{} +\makecover +\makecover[parameters] +\titledelimiter{delimiter} +\author{text} \authormore{text} -\dateofbirth{text} +\dateofbirth{date} \placeofbirth{text} \matriculationnumber{text} \matriculationyear{text} @@ -83,9 +81,15 @@ \date{date} \date[addon]{date} \defensedate{date} -\titledelimiter{delimiter} -\makecover -\makecover[parameters] +\extratitle{text} +\titlehead{text} +\title{text} +\subtitle{text} +\publishers{text} +\thanks{text} +\uppertitleback{text} +\lowertitleback{text} +\dedication{text} \begin{abstract} \begin{abstract}[parameter] \end{abstract} @@ -106,6 +110,14 @@ \company{text} \tudbookmark{text}{anchor} \tudbookmark[level]{text}{anchor} +\supervisorname#S +\supervisorothername#S +\refereename#S +\refereeothername#S +\advisorname#S +\advisorothername#S +\professorname#S +\professorothername#S \dissertationname#S \diplomathesisname#S \masterthesisname#S @@ -117,28 +129,20 @@ \logname#S \internshipname#S \reportname#S -\supervisorname#S -\supervisorothername#S -\refereename#S -\refereeothername#S -\advisorname#S -\advisorothername#S -\professorname#S -\professorothername#S -\datetext#S -\defensedatetext#S \dateofbirthtext#S \placeofbirthtext#S \matriculationnumbername#S \matriculationyearname#S \graduationtext#S -\coverpagename#S -\titlepagename#S +\datetext#S +\defensedatetext#S \abstractname#S \confirmationname#S \blockingname#S \confirmationtext#S \blockingtext#S +\coverpagename#S +\titlepagename#S \listingname#S \listlistingname#S \setcdcolors{colormodel} diff --git a/release.bat b/release.bat index 07f547cf..57feca94 100644 --- a/release.bat +++ b/release.bat @@ -10,7 +10,7 @@ for /f "tokens=1,2,3 delims= " %%a in ( set /p append=%version% set version=%version%%append% if exist temp rmdir temp /s /q > nul -if exist release rmdir release /s /q > nul +if exist release-%version% rmdir release-%version% /s /q > nul echo ========================================================================= echo Erzeugen der Klassen und der inline-Dokumentation fuer %version% echo ========================================================================= @@ -30,6 +30,7 @@ pdflatex "\def\tudfinalflag{}\input{tudscrsource.tex}" makeindex -s gglo.ist -o tudscrsource.gls tudscrsource.glo makeindex -s gind.ist -o tudscrsource.ind tudscrsource.idx pdflatex "\def\tudfinalflag{}\input{tudscrsource.tex}" +pdflatex "\def\tudfinalflag{}\input{tudscrsource.tex}" move *.dtx source\latex\tudscr\ move tudscr.ins source\latex\tudscr\ move tudscrsource.tex source\latex\tudscr\ @@ -48,6 +49,7 @@ pdflatex "\def\tudfinalflag{}\input{tudscr.tex}" pdflatex "\def\tudfinalflag{}\input{tudscr.tex}" pdflatex "\def\tudfinalflag{}\input{tudscr.tex}" pdflatex -shell-escape "\def\tudfinalflag{}\input{tudscr.tex}" +pdflatex "\def\tudfinalflag{}\input{tudscr.tex}" pdflatex "\def\tudfinalflag{}\def\tudprintflag{}\input{tudscr.tex}" copy tudscr.pdf tudscr_print.pdf pdflatex "\def\tudfinalflag{}\input{tudscr.tex}" @@ -86,17 +88,17 @@ echo ========================================================================= echo Release fuer GitHub echo ========================================================================= cd %~dp0 -mkdir release\temp -mkdir release\GitHub -copy *.md release\temp\ -xcopy addon release\temp\ /s -copy development\fonts\*.* release\temp\ -copy development\tools\*.* release\temp\ -copy temp\doc\latex\tudscr\tudscr.pdf release\temp\ -copy temp\doc\latex\tudscr\tudscr_print.pdf release\temp\ -move temp\install\*.* release\temp\ +mkdir release-%version%\temp +mkdir release-%version%\GitHub +copy *.md release-%version%\temp\ +xcopy addon release-%version%\temp\ /s +copy development\fonts\*.* release-%version%\temp\ +copy development\tools\*.* release-%version%\temp\ +copy temp\doc\latex\tudscr\tudscr.pdf release-%version%\temp\ +copy temp\doc\latex\tudscr\tudscr_print.pdf release-%version%\temp\ +move temp\install\*.* release-%version%\temp\ rmdir temp\install /s /q > nul -cd release\temp +cd release-%version%\temp for /f %%f in ('dir /b *.bat') do unix2dos %%f 7za a -tzip tudscr_%version%_full.zip .\..\..\temp\* 7za a -tzip tudscr_%version%_update.zip .\..\..\temp\* -xr!logo @@ -104,12 +106,12 @@ for /f %%f in ('dir /b *.bat') do unix2dos %%f for /f %%f in ('dir /b *.md') do unix2dos -n %%f %%~nf.txt 7za a -tzip .\..\TUD-KOMA-Script_%version%_Windows_all.zip -x!*.sh @7za_files_full.txt @7za_files_postscript.txt 7za a -tzip .\..\TUD-KOMA-Script_%version%_Windows_full.zip -x!*.sh @7za_files_full.txt -rem 7za a -tzip .\..\TUD-KOMA-Script_%version%_Windows_update.zip -x!*.sh @7za_files_update.txt +7za a -tzip .\..\TUD-KOMA-Script_%version%_Windows_update.zip -x!*.sh @7za_files_update.txt 7za a -tzip .\..\TUD-KOMA-Script_fonts_Windows.zip -x!*.sh @7za_files_fonts.txt for /f %%f in ('dir /b *.md') do copy %%f %%~nf.txt 7za a -tzip .\..\TUD-KOMA-Script_%version%_Unix_all.zip -x!*.bat -x!7za.exe @7za_files_full.txt @7za_files_postscript.txt 7za a -tzip .\..\TUD-KOMA-Script_%version%_Unix_full.zip -x!*.bat -x!7za.exe @7za_files_full.txt -rem 7za a -tzip .\..\TUD-KOMA-Script_%version%_Unix_update.zip -x!*.bat -x!7za.exe @7za_files_update.txt +7za a -tzip .\..\TUD-KOMA-Script_%version%_Unix_update.zip -x!*.bat -x!7za.exe @7za_files_update.txt 7za a -tzip .\..\TUD-KOMA-Script_fonts_Unix.zip -x!*.bat -x!7za.exe @7za_files_fonts.txt 7za a -tzip .\..\tudscr4lyx.zip .\tudscr4lyx\* 7za a -tzip .\..\tudscr4texstudio.zip .\tudscr4texstudio\* @@ -147,4 +149,4 @@ del winzip.vbs /q > nul if exist CTAN rmdir CTAN /s /q > nul cd %~dp0 if exist temp rmdir temp /s /q > nul -if exist release\temp rmdir release\temp /s /q > nul +if exist release-%version%\temp rmdir release-%version%\temp /s /q > nul diff --git a/source/clear.bat b/source/clear.bat index 2fa0d7a4..01c16d9f 100644 --- a/source/clear.bat +++ b/source/clear.bat @@ -4,6 +4,7 @@ attrib +h "*.dtx" /s attrib +h "*.ins" /s attrib +h "*.tex" /s attrib -h "*-temp.*" /s> nul +attrib -h "install\*.tex" /s> nul attrib +h "logo\*.*" attrib +h "test\*.cls"> nul attrib +h "test\*.sty"> nul diff --git a/source/doc/test.tex b/source/doc/test.tex index 3652c51c..1ed265bd 100644 --- a/source/doc/test.tex +++ b/source/doc/test.tex @@ -1,123 +1,14 @@ -\RequirePackage[ngerman=ngerman-x-latest]{hyphsubst} -\documentclass[english,ngerman,final]{tudscrman} -\usepackage{selinput}\SelectInputMappings{adieresis={ä},germandbls={ß}} -\usepackage[T1]{fontenc} -\lstset{% - inputencoding=utf8,extendedchars=true, - literate=% - {ä}{{\"a}}1 {ö}{{\"o}}1 {ü}{{\"u}}1 - {Ä}{{\"A}}1 {Ö}{{\"O}}1 {Ü}{{\"U}}1 - {~}{{\textasciitilde}}1 {ß}{{\ss}}1 +\PassOptionsToClass{ToDo=false}{tudscrman} +\includeonly{% +% tudscr-preface, +% tudscr-introduction, +% tudscr-mainclasses, +% tudscr-bundle, +% tudscr-examples, +% tudscr-packages, + tudscr-hints, +% tudscr-installation, +% tudscr-obsolete, +% tudscr-index, } - -\usepackage[open,openlevel=0]{bookmark}[2011/12/02] - -\begin{document} -\addtokomafont{subtitle}{\univbn} -\subject{\TUDScript{} \vTUDScript{} basierend auf \KOMAScript{} \vKOMAScript} -\title{% - Ein \NoCaseChange{\hologo{LaTeXe}}-Bundle für Dokumente im~neuen \CD der \TnUD -} -\ifdef{\tudprintflag}{% - \subtitle{Benutzerhandbuch\thanks{\href{tudscr}{Online-Version}}}% -}{% - \subtitle{Benutzerhandbuch\thanks{\href{tudscr_print}{Druckversion}}}% -} -\author{Falk Hanisch\thanks{\noexpand\href{mailto:\tudscrmail}{\tudscrmail}}} -\faculty{http://tu-dresden.de/cd} -\date{05.11.2014} -\makeatletter -\begingroup% - \def\and{, }% - \let\thanks\@gobble% - \let\footnote\@gobble% - \hypersetup{% - pdfauthor = {\@author},% - pdftitle = {\@title},% - pdfsubject = {Benutzerhandbuch für \TUDScript},% - pdfkeywords = {LaTeX, \TUDScript, Benutzerhandbuch},% - }% -\endgroup% -\makeatother -%\maketitle -% -%\include{tudscr-preface} -% -%\makeatletter -%\renewcommand*\@pnumwidth{1.7em} -%\makeatother -%\tableofcontents -% -%\include{tudscr-introduction} -% -%\setpartpreamble{% -% \begin{abstract} -% \hypersetup{linkcolor=red} -% \noindent Dies ist der Hauptteil des \TUDScript-Bundles. Hier findet der -% Anwender alle verfügbaren Optionen, Umgebungen und Befehle, die über -% die Funktionalität von \KOMAScript{} hinausgehen. -% \end{abstract} -% \ChangedAt*{% -% v2.00!Generalüberholung und komplette Neuimplementierung von \TUDScript,% -% v2.00!Schriften~-- insbesondere für den mathematischen Satz~-- verbessert,% -% v2.00!Robustheit vieler Befehle und Optionen erhöht,% -% v2.01!Unterschneidung (Kerning) der Ziffern für \Univers verbessert,% -% v2.01b!Bugfix für falsche Berechnungen verschiedener Längen,% -% v2.02!Befehle zur besseren Kompatibilität mit anderen Paketen umbenannt{,} -% siehe dazu \manualhyperref{v2.02:Umbenennungen}{\enquote{Umbenennungen}} -% in der Änderungsliste zur Version~v2.02,% -% }% -%}% -%\part{Das \TUDScript-Bundle} -%\label{part:main} -% -%\include{tudscr-mainclasses} -% -%\include{tudscr-bundle} -% -%\setpartpreamble{% -% \begin{abstract} -% \hypersetup{linkcolor=red} -% \noindent Für die Verwendung des \TUDScript-Bundles ist es nicht notwendig, -% diesen Teil zu lesen. In \autoref{sec:exmpl} sind insbesondere für -% \hologo{LaTeX}"=Neulinge sowie neue Anwender des \TUDScript-Bundles -% mehrere einfache Beispiele sowie umfangreichere Tutorials für dessen -% Verwendung zu sehen. In \autoref{sec:packages} werden Einsteigern~-- und -% auch dem bereits versierten \hologo{LaTeX}-Nutzer~-- meiner Meinung nach -% empfehlenswerte Pakete kurz vorgestellt. -% -% Anwendungshinweise sowie der eine oder andere allgemeine Hinweis bei der -% Verwendung von \hologo{LaTeXe} wird in \autoref{sec:tips} gegeben. Dabei -% sind diese durchaus für die Verwendung sowohl des \TUDScript-Bundles als -% auch anderer \hologo{LaTeX}-Klassen interessant. Für Anregungen, Hinweise, -% Ratschläge oder Empfehlungen zu weiteren Pakete sowie Tipps bin ich -% jederzeit empfänglich. -% \end{abstract} -%} -%\part{Ergänzungen und Hinweise} -%\label{part:additional} -% -%\include{tudscr-examples} -% -%\include{tudscr-packages} -% -\include{tudscr-hints} -% -%\part{Anhang} -%\appendix -% -%\include{tudscr-installation} -% -%\include{tudscr-obsolete} -% -%\include{tudscr-index} -% -%\ListOfToDo -%\ToDo[doc]{% -% \Option*{abstract} und \Option*{declaration}: Schlüssel \PValue{leveldown} -% sowie Schlüssel und Parameter \PValue{markboth} dokumentieren -%}[v2.02] -%\ToDo[man]{Layout und Umbrüche kontrollieren} -%\ToDo[man]{Datum in tudscr-version.dtx, Handbuch und README aktualisieren} -%\ToDo[man]{Hinweis auf falschen Link auf CTAN} -\end{document} +\input{tudscr} diff --git a/source/doc/tudscr-bundle.tex b/source/doc/tudscr-bundle.tex index 2fc21272..a50c3f32 100644 --- a/source/doc/tudscr-bundle.tex +++ b/source/doc/tudscr-bundle.tex @@ -5,6 +5,7 @@ \end{abstract} } \chapter{Zusätzliche Pakete im \TUDScript-Bundle} +\label{sec:bundle} \section{Das Paket \Package{tudscrsupervisor} -- Studentische Betreuung} \begin{Declaration*}{\Package{tudscrsupervisor}} Dieses Paket stellt für das Erstellen von Aufgabenstellungen und Gutachten @@ -93,9 +94,8 @@ \subsection{Aufgabenstellung für eine wissenschaftliche Arbeit} Hierzu sei auch auf das Minimalbeispiel in \autoref{sec:exmpl:task} verwiesen. \end{Example} -\Rename[macros]{v2.02}{\Macro{branch}}{\Macro{discipline}} \begin{Declaration}{\Macro{course}\Parameter{Studiengang}} -\begin{Declaration}{\Macro{discipline}\Parameter{Studienrichtung}} +\begin{Declaration}[v2.02]{\Macro{discipline}\Parameter{Studienrichtung}} \printdeclarationlist% \index{Kollaboratives Schreiben}% % @@ -264,13 +264,10 @@ \subsection{Aushang} Hierzu sei auch auf das Minimalbeispiel in \autoref{sec:exmpl:notice} verwiesen. \end{Example} -\Rename[macros]{v2.02}{\Macro{contact}}{\Macro{contactperson}} -\Rename[macros]{v2.02}{\Macro{phone}}{\Macro{telephone}} -\Rename[macros]{v2.02}{\Macro{email}}{\Macro{emailaddress}} -\begin{Declaration}{\Macro{contactperson}\Parameter{Kontaktperson(en)}} +\begin{Declaration}[v2.02]{\Macro{contactperson}\Parameter{Kontaktperson(en)}} \begin{Declaration}{\Macro{office}\Parameter{Dienstsitz}} -\begin{Declaration}{\Macro{telephone}\Parameter{Telefonnummer}} -\begin{Declaration}{\Macro{emailaddress}\Parameter{E-Mail-Adresse}} +\begin{Declaration}[v2.02]{\Macro{telephone}\Parameter{Telefonnummer}} +\begin{Declaration}[v2.02]{\Macro{emailaddress}\Parameter{E-Mail-Adresse}} \printdeclarationlist% % Am Ende eines Aushangs können mit \Macro{contactperson} Kontaktinformationen @@ -312,11 +309,10 @@ \subsection{Zusätzliche sprachabhängige Bezeichner} \end{Declaration} \end{Declaration} -\Rename[terms]{v2.02}{\Term{branchname}}{\Term{disciplinename}} \begin{Declaration}{\Term{authorname}} \begin{Declaration}{\Term{titlename}} \begin{Declaration}{\Term{coursename}} -\begin{Declaration}{\Term{disciplinename}} +\begin{Declaration}[v2.02]{\Term{disciplinename}} \printdeclarationlist% % Diese Bezeichner werden in der Tabelle mit den Autoreninformationen zu Beginn @@ -395,9 +391,8 @@ \subsection{Zusätzliche sprachabhängige Bezeichner} \TermTable*{gradetext}{.7\textwidth} \end{Declaration} -\Rename[terms]{v2.02}{\Term{contactname}}{\Term{contactpersonname}} \begin{Declaration}{\Term{noticename}} -\begin{Declaration}{\Term{contactpersonname}} +\begin{Declaration}[v2.02]{\Term{contactpersonname}} \printdeclarationlist% % Die Bezeichnung des Aushangs selbst ist in \Term{noticename} enthalten. Für @@ -541,16 +536,16 @@ \subsection{Zusätzliche Farbdefinitionen} \Color*{HKS07}. Alle anderen farblichen Abstufungen können mit den beschrieben Möglichkeiten des Paketes \Package{xcolor} generiert werden. -\begin{Declaration}{\Option{full}} +\begin{Declaration}{\Option{oldcolors}} \printdeclarationlist% % In den letzten Jahren sind viele verschiedene Klassen und Pakete für das \CD der \TnUD entstanden. Innerhalb dieser existieren abweichende Farbdefinitionen. -Um eine Migration von anderen Klassen und Paketen auf \TUDScript zu -ermöglichen, existiert die Paketoption \Option{full}. Wird diese aktiviert, so -werden zusätzlich weitere Farben nach dem Schema \Color*{HKS41K}\PName{Zahl} -und \Color*{HKS41-}\PName{Zahl} bereitgestellt, wobei der hinten angestellte -Zahlenwert aus der 10er-Reihe kommen muss. +Um eine Migration von den benannten Klassen und Paketen auf \TUDScript zu +ermöglichen, existiert die Paketoption \Option{oldcolors}. Wird diese genutzt, +so werden zusätzliche Farben nach dem Schema \Color*{HKS41K}\PName{Zahl} und +\Color*{HKS41-}\PName{Zahl} definiert, wobei der hinten angestellte Zahlenwert +aus der 10er-Reihe kommen muss. \end{Declaration} @@ -602,8 +597,8 @@ \section{Das Paket \Package{tudscrfonts} -- Schriften im \CD} welche \emph{nicht} zum \TUDScript-Bundle gehören. Das Paket unterstützt einen Großteil der in \fullref{sec:fonts} beschriebenen Optionen und Befehle. Die nutzbaren Paketoptionen sind für den Fließtext \Option{cdfont}~-- ohne die -Einstellungsmöglichkeiten für den Querbalken des \CDs (\Option{barfont})~-- und -für die mathematischen Schriften \Option{sansmath} sowie \Option{slantedgreek}. +Einstellungsmöglichkeiten für den Querbalken des \CDs (\Option{cdhead})~-- und +für die mathematischen Schriften \Option{cdmath} sowie \Option{slantedgreek}. Da von \Package{tudscrfonts} intern das Paket \Package{tudscrbase} geladen wird, können diese entweder als Paketoptionen im optionalen Argument von \Macro*{usepackage}\OParameter{Paketoption}\PParameter{\Package{tudscrfonts}} @@ -666,179 +661,6 @@ \section{Das Paket \Package{tudscrfonts} -- Schriften im \CD} -\section{Das Paket \Package{tudscrcomp} -- Kompatibilität alter Klassen} -\begin{Declaration*}{\Package{tudscrcomp}} -\index{Version!v1.0|(}% -\index{Kompatibilität!Version v1.0|(}% -\index{Kompatibilität!\Class{tudbook}|(}% -% -\noindent\Attention{% - Sollten Sie die \Class{tudbook}-Klasse oder \TUDScript in der Version~v1.0 - nie genutzt haben, können Sie dieses \autorefname ohne Weiteres überspringen. - Sämtliche hier vorgestellten Optionen und Befehle sind in der aktuellen - Version von \TUDScript obsolet. -} - -\bigskip\noindent -Zu Beginn der Entwicklung von \TUDScript bildete die Klasse \Class{tudbook} -die Basis. Ziel war es, sämtliche Funktionalitäten dieser beizubehalten und -zusätzlich den vollen Funktionsumfang der \KOMAScript-Klassen nutzbar zu -machen. Bei der kompletten Neuimplementierung der \TUDScript-Klassen wurde sehr -viel verändert und verbessert. Einige der Optionen und Befehle waren jedoch -bereits in der \TUDScript-Version~v1.0 Relikte, um die Kompatibilität zur -\Class{tudbook}-Klasse zu gewährleisten. Mit der Version~v2.00 wurden einige -aus Gründen der Konsistenz lediglich umbenannt, andere wiederum wurden -vollständig entfernt oder über neue Befehle und Optionen in ihrer -Funktionalität ersetzt und erweitert. - -Das Paket \Package{tudscrcomp} dient der Überführung von alten Dokumenten, die -entweder mit der \Class{tudbook}-Klasse oder mit der Version~v1.0 erstellt -wurden, auf \TUDScript~\vTUDScript. Es werden einige Optionen und Befehle -bereitgestellt, welche von den alten Klassen definiert wurden und das -entsprechende Verhalten nachahmen. Damit soll die Kompatibilität bei der -Änderung der Dokumentklasse sichergestellt werden. Die Intention ist, alte -Dokumente möglichst schnell und einfach auf die \TUDScript-Klassen portieren zu -können. Des Weiteren ist beschrieben, wie sich die Funktionalität ohne die -Verwendung des Paketes mit den Mitteln von \TUDScript umsetzen lassen. Für den -Satz neuer Dokumente wird empfohlen, auf den Einsatz dieses Paketes komplett zu -verzichten und stattdessen die neuen Befehle zu nutzen. - -\begin{Declaration}{\Option{serifmath}}{% - identisch zu \Option{sansmath}[false]% -} -\printdeclarationlist% -% -Die Funktionalität wird durch die Option \Option{sansmath} bereitgestellt. -\end{Declaration} - -\begin{Declaration}{\Option{colortitle}}{% - identisch zu \Option{cdtitle}[color]% -} -\begin{Declaration}{\Option{nocolortitle}}{% - identisch zu \Option{cdtitle}[true]% -} -\printdeclarationlist% -% -Die Funktionalität wird durch die Option \Option{cdtitle} bereitgestellt. -\end{Declaration} -\end{Declaration} - -\begin{Declaration}{\Macro{einrichtung}\Parameter{Fakultät}}{% - identisch zu \Macro{faculty} -} -\begin{Declaration}{\Macro{fachrichtung}\Parameter{Einrichtung}}{% - identisch zu \Macro{department} -} -\begin{Declaration}{\Macro{institut}\Parameter{Institut}}{% - identisch zu \Macro{institute} -} -\begin{Declaration}{\Macro{professur}\Parameter{Lehrstuhl}}{% - identisch zu \Macro{chair} -} -\printdeclarationlist% -% -Dies sind die deutschsprachigen Befehle für den Kopf im \CD. -\end{Declaration} -\end{Declaration} -\end{Declaration} -\end{Declaration} - -\begin{Declaration}{\Macro{moreauthor}\Parameter{Autorenzusatz}}{% - identisch zu \Macro{authormore}% -} -\printdeclarationlist% -% -Ursprünglich war diese Befehl für das Unterbringen aller möglichen, -zusätzlichen Autoreninformationen gedacht. Auch der Befehl \Macro{authormore} -ist ein Rudiment davon. Empfohlen wird die Verwendung der Befehle -\Macro{dateofbirth}, \Macro{placeofbirth}, \Macro{matriculationnumber} und -\Macro{matriculationyear} sowie für die Aufgabenstellung einer -wissenschaftlichen Arbeit \Macro{course} und \Macro{discipline} aus dem Paket -\Package{tudscrsupervisor}. -\end{Declaration} - -\begin{Declaration}{\Macro{submitdate}\Parameter{Datum}}{% - identisch zu \Macro{date}% -} -\printdeclarationlist% -% -Die Funktionalität wird durch den erweiterten Standardbefehl \Macro{date} -abgedeckt. -\end{Declaration} - -\begin{Declaration}{\Macro{supervisorII}\Parameter{Name}}{% - identisch zur Verwendung von \Macro{and} innerhalb von \Macro{supervisor}% -} -\printdeclarationlist% -% -Es ist \Macro{supervisor}\PParameter{\PName{Name} \Macro{and} \PName{Name}} -statt \Macro{supervisorII}\Parameter{Name} zu verwenden. -\end{Declaration} - -\begin{Declaration}{\Macro{supervisedby}\Parameter{Bezeichnung}}{% - siehe \Term{supervisorname}% -} -\begin{Declaration}{\Macro{supervisedIIby}\Parameter{Bezeichnung}}{% - siehe \Term{supervisorothername}% -} -\begin{Declaration}{\Macro{submittedon}\Parameter{Bezeichnung}}{% - siehe \Term{datetext}% -} -\printdeclarationlist% -% -Zur Änderung der Bezeichnung der Betreuer sollten die sprachabhängigen -Bezeichner wie in \autoref{sec:localization} beschrieben angepasst werden. Eine -Verwendung der alten Befehle entfernt die Abhängigkeit der Bezeichner von der -verwendeten Sprache. -\end{Declaration} -\end{Declaration} -\end{Declaration} - -\begin{Declaration}{\Macro{dissertation}} -\printdeclarationlist% -% -Die Funktionalität kann durch die Befehle \Macro{thesis}\PParameter{diss} und -\Macro{referee} sowie die Bezeichner \Term{refereename} und -\Term{refereeothername} dargestellt werden. -\end{Declaration} - -\begin{Declaration}{\Option{ddcfooter}}{% - identisch zu \Option{ddcfoot}[true]% -} -\printdeclarationlist% -% -Die Funktionalität wird durch die Option \Option{ddcfoot} bereitgestellt. -\end{Declaration} - -\begin{Declaration}{\Macro{chapterpage}} -\printdeclarationlist% -% -Durch diesen Befehl können Kapitelseiten konträr zur eigentlichen Einstellung -aktiviert oder deaktiviert werden. Prinzipiell ist dies auch durch Änderung der -Option \Option{chapterpage} möglich. Allerdings wird davon abgeraten, da dies -zu einem inkonsistenten Layout innerhalb des Dokumentes führt. -\end{Declaration} - -\begin{Declaration}{\Environment{theglossary}[\OParameter{Präambel}]} -\begin{Declaration}{\Macro{glossitem}\Parameter{Begriff}} -\printdeclarationlist% -% -Die \Class{tudbook}-Klasse stellt eine rudimentäre Umgebung für ein Glossar -bereit. Allerdings gibt es dafür bereits zahlreiche und besser implementierte -Pakete. Daher wird für diese Umgebung keine Portierung vorgenommen, sondern -lediglich die ursprüngliche Definition übernommen. Allerdings sein an dieser -Stelle auf wesentlich bessere Lösungen wie beispielsweise das Paket -\Package{glossaries} oder~-- mit Abstrichen~-- das nicht ganz so umfangreiche -Paket \Package{nomencl} verwiesen. -\end{Declaration} -\end{Declaration} -\index{Version!v1.0|)} -\index{Kompatibilität!Version v1.0|)} -\index{Kompatibilität!\Class{tudbook}|)} -\end{Declaration*} - - - \section{Das Paket \Package{mathswap}} \begin{Declaration*}{\Package{mathswap}} \index{Trennzeichen}\index{Mathematiksatz}% @@ -925,26 +747,16 @@ \section{Das Paket \Package{twocolfix}} %\chapter[Die Briefklasse \Class*{tudscrlttr}]{Die Briefklasse} %\begin{Declaration*}{\Class{tudscrlttr}} -\subsection*{\Class*{tudscrlttr} auf Basis von \Class*{scrlttr2}} \ToDo[imp,nxt]{Klasse \Class*{tudscrlttr}}[v2.x] -Es soll die Klasse -% -\begin{description} - \item \Class*{tudscrlttr} -\end{description} -% -für Briefe im \CD der \TnUD entstehen. Auch Vorlagen für Fax und -Hausmitteilungen sollen dabei abfallen. +Es soll die Klasse \Class*{tudscrlttr} für Briefe im \CD der \TnUD entstehen. +Auch Vorlagen für Fax und Hausmitteilungen sollen dabei abfallen. %\end{Declaration*} - - %\section{Das Paket \Package{tudscrposter} -- Poster im \CD}% %\begin{Declaration*}{\Package{tudscrposter}} -\subsection*{Das Paket \Package*{tudscrposter}} \ToDo[imp,nxt]{% Paket \Package*{tudscrposter} als Ersatz für \Class{tudmathposter}% -}[v2.x] +}[v2.04] Die Funktionalität der Klasse \Class{tudmathposter} soll in ein eigenständiges Paket mit dem Namen \Package*{tudscrposter}(tudscr) o.\,ä. überführt werden. %\end{Declaration*} diff --git a/source/doc/tudscr-examples.tex b/source/doc/tudscr-examples.tex index 4407168e..3d627e2c 100644 --- a/source/doc/tudscr-examples.tex +++ b/source/doc/tudscr-examples.tex @@ -85,7 +85,7 @@ \section{Vorlage für eine wissenschaftlichen Arbeit} wissenschaftlichen Arbeit oder ähnlichem machen. Während der Einstiegsphase in \hologo{LaTeXe} kann ein Anfänger sehr schnell aufgrund der großen Anzahl an empfohlenen Pakete sowie der teilweise diametral zueinander stehenden Hinweise -überfordert sein. Mit dem Tutorial \Tutorial{treatise} soll versucht werden, +überfordert sein. Mit dem Tutorial \Tutorial{treatise}|!| soll versucht werden, ein wenig Licht ins Dunkel zu bringen. Es erhebt jedoch keinerlei Anspruch, vollständig oder perfekt zu sein. Einige der darin vorgestellten Möglichkeiten lassen sich mit Sicherheit auch anders, einfacher und/oder besser lösen. @@ -96,7 +96,7 @@ \section{Vorlage für eine wissenschaftlichen Arbeit} \section{Ein Beitrag zum mathematischen Satz in \NoCaseChange{\hologo{LaTeXe}}} \label{sec:exmpl:mathtype} \index{Tutorial!Mathematiksatz} -Das Tutorial \Tutorial{mathtype} richtet sich an alle Anwender, die in ihrem +Das Tutorial \Tutorial{mathtype}|!| richtet sich an alle Anwender, die in ihrem \hologo{LaTeX}"=Dokument mathematische Formeln setzen wollen. In diesem wird ausführlich darauf eingegangen, wie mit wenigen Handgriffen ein typographisch sauberer Mathematiksatz zu bewerkstelligen ist. @@ -113,5 +113,5 @@ \section{Änderung der Trennzeichen im Mathematikmodus} normalerweise allesamt angepasst und das ursprüngliche Dezimaltrennzeichen durch ein Komma ersetzt werden. Dieser Schritt wird mit dem \TUDScript-Paket \Package{mathswap} automatisiert. Wie dies genau funktioniert, wird im Tutorial -\Tutorial{mathswap} erläutert. +\Tutorial{mathswap}|!| erläutert. \index{Tutorial|)} diff --git a/source/doc/tudscr-hints.tex b/source/doc/tudscr-hints.tex index 1a8d3cac..8115c272 100644 --- a/source/doc/tudscr-hints.tex +++ b/source/doc/tudscr-hints.tex @@ -30,7 +30,7 @@ \section{\NoCaseChange{\hologo{LaTeX}}-Editoren} unter unixoiden Betriebssystemen in \Path{.config/texstudio} eingefügt werden. Möchten Sie das grafische \hologo{LaTeX}-Frontend~\Application{\hologo{LyX}} -für das Erstellen eines Dokumentes mit \TUDScript verwenden, so werden dafür +für das Erstellen eines Dokumentes mit \TUDScript nutzen, so werden dafür spezielle Layout-Dateien benötigt, um die Klassendateien verwenden zu können. Diese sind zusammen mit einem exemplarischen \hologo{LyX}-Dokument als Archiv \hrfn{https://github.com/tud-cd/tudscr/releases/download/LyX/tudscr4lyx.zip}% @@ -39,6 +39,8 @@ \section{\NoCaseChange{\hologo{LaTeX}}-Editoren} Unterordner kopiert werden. Dieser ist bei Windows \Path{\%PROGRAMFILES(X86)\%\textbackslash{}LyX~2.0\textbackslash{}Resources\textbackslash{}layouts} beziehungsweise bei unixoiden Betriebssystemen \Path{/usr/share/lyx/layouts}. +Anschließend muss LyX über den Menüpunkt \emph{Werkzeuge} neu konfiguriert +werden. @@ -175,7 +177,7 @@ \section{Lokale Änderungen von Befehlen und Einstellungen} -\section{Bezeichnungen der Gliederungsebenen durch \Package{hyperref}} +\section{Bezeichnung der Gliederungsebenen durch \Package{hyperref}} \index{Querverweise} % \ChangedAt{v2.02!\TaT: Bezeichnungen der Gliederungsebenen} @@ -475,83 +477,6 @@ \section{Finden von unbekannten \NoCaseChange{\hologo{LaTeX}}-Symbolen} -\section{Warnung bei der Verwendung von \Package{multicol}} -% -\ChangedAt{v2.02!\TaT: Warnung bei der Verwendung von \Package{multicol}} -% -Das einzig momentan bekannte Problem der \TUDScript"=Klasse tritt in Verbindung -mit dem Paket \Package{multicol}|?| auf. Dieses greift~-- ähnlich zu dem für -die Seitenstile verwendeten Paket \Package{scrlayer-scrpage}~-- sehr stark in -die Ausgaberoutine von \hologo{LaTeXe} ein. Bei Spaltenumbrüchen innerhalb der -\Environment{multicols}"=Umgebung kommt es sehr häufig zu folgender Warnung: -% -\begin{quoting} -\begin{Code} -Underfull \hbox (badness 10000) has occurred while \output is active -\end{Code} -\end{quoting} -% -Wird \Package{scrlayer-scrpage} nicht verwendet, unterbleibt die Warnung. Beide -Pakete haben in der Kombination miteinander augenscheinlich ein Problem. Die -Autoren der beiden Pakete wurden über dieses Problem informiert, signalisierten -jedoch verständlicherweise wenig Bereitschaft, der Ursache auf den Grund zu -gehen. Leider kann für die \TUDScript-Klassen auf \Package{scrlayer-scrpage} -nicht verzichtet werden, es ist von essentieller Bedeutung für die Seitenstile -im \CD der \TnUD. Am Ausgabeergebnis ändert sich nichts. Im Zweifelsfall werden -jedoch eine Menge bedeutungsloser Warnungen generiert. - -Es gibt allerdings eine Möglichkeit, diese zu unterdrücken. Hierfür wird auf -die Funktionalitäten von \Package{etoolbox} zurückgegriffen, was ohnehin von -den \TUDScript-Klassen geladen wird. In der Präambel kann folgender Quelltext -verwendet werden: -% -\begin{quoting} -\begin{Code} -\makeatletter -\apptocmd{\prepare@multicols}{\hbadness10000}{}{} -\makeatother -\end{Code} -\end{quoting} -% -Dadurch werden die durch \hologo{LaTeXe} generierten Warnungen innerhalb der -\Environment{multicols}"=Umgebung deaktiviert. Es muss dabei beachtet werden, -dass dies für alle Boxen~-- und nicht nur jene beim Spaltenumbruch~-- gilt. - - - -\section{Fehlermeldung: ! No room for a new \textbackslash write} -% -\ChangedAt{v2.02!\TaT: Fehler beim Schreiben von Hilfsdateien} -% -Für das Erstellen und Schreiben externer Hilfsdateien steht \hologo{LaTeXe} nur -eine begrenzte Anzahl sogenannter Ausgabe-Streams zur Verfügung. Allein für -jedes zu erstellende Verzeichnis reserviert \hologo{LaTeX} selbst jeweils einen -neuen Stream. Auch einige bereits zuvor in diesem Handbuch vorgestellte, sehr -hilfreiche Pakete~-- wie beispielsweise \Package{hyperref}, \Package{biblatex}, -\Package{glossaries}, \Package{todonotes} oder auch \Package{filecontents}~-- -benötigen eigene Hilfsdateien und öffnen für das Erstellen dieser einen -Ausgabe-Stream oder mehr. - -Lädt der Anwender mehrere, in eine Hilfsdatei schreibende Pakete, kann es zur -der Fehlermeldung -% -\begin{quoting} -\begin{Code} -! No room for a new \write . -\end{Code} -\end{quoting} -% -kommen. Abhilfe schafft hier das Paket \Package{scrwfile}(koma-script), welches -einige Änderungen am \hologo{LaTeX}-Kern vornimmt, um die Anzahl der benötigten -Hilfsdateien für das Schreiben aller Verzeichnisse zu reduzieren. Es muss -einfach in der Präambel eingebunden werden. Sollten mit diesem Paket -unerwarteter Weise Probleme auftreten, ist dessen Anleitung in \scrguide zu -finden. Eine weitere Möglichkeit, das beschriebene Problem der geringen Menge -an Ausgabe-Streams zu umgehen, stellt das Paket \Package{morewrites} dar. -Allerdings ist dessen Verwendung nicht in allen Fällen von Erfolg gekrönt. - - - \section{Änderung des Papierformates} \index{Papierformat} Es kann vorkommen, dass man innerhalb eines Dokumentes kurzzeitig das @@ -592,6 +517,11 @@ \chapter{Überschrift Drei} +\ToDo[imp,nxt]{Schnittmarken implementieren und dokumentieren}[v2.04] +%\section{Schnittmarken} + + + \section{Platzierung von Gleitobjekten} \manualhyperdef'{sec:tips:floats}{}% \index{Gleitobjekte|?}% @@ -814,3 +744,36 @@ \section{Probleme bei der Verwendung von \Package{auto-pst-pdf}} \fi \end{Code} \end{quoting} + + + +\section{Fehlermeldung: ! No room for a new \textbackslash write} +% +\ChangedAt{v2.02!\TaT: Fehler beim Schreiben von Hilfsdateien} +% +Für das Erstellen und Schreiben externer Hilfsdateien steht \hologo{LaTeXe} nur +eine begrenzte Anzahl sogenannter Ausgabe-Streams zur Verfügung. Allein für +jedes zu erstellende Verzeichnis reserviert \hologo{LaTeX} selbst jeweils einen +neuen Stream. Auch einige bereits zuvor in diesem Handbuch vorgestellte, sehr +hilfreiche Pakete~-- wie beispielsweise \Package{hyperref}, \Package{biblatex}, +\Package{glossaries}, \Package{todonotes} oder auch \Package{filecontents}~-- +benötigen eigene Hilfsdateien und öffnen für das Erstellen dieser einen +Ausgabe-Stream oder mehr. + +Lädt der Anwender mehrere, in eine Hilfsdatei schreibende Pakete, kann es zur +der Fehlermeldung +% +\begin{quoting} +\begin{Code} +! No room for a new \write . +\end{Code} +\end{quoting} +% +kommen. Abhilfe schafft hier das Paket \Package{scrwfile}(koma-script), welches +einige Änderungen am \hologo{LaTeX}-Kern vornimmt, um die Anzahl der benötigten +Hilfsdateien für das Schreiben aller Verzeichnisse zu reduzieren. Es muss +einfach in der Präambel eingebunden werden. Sollten mit diesem Paket +unerwarteter Weise Probleme auftreten, ist dessen Anleitung in \scrguide zu +finden. Eine weitere Möglichkeit, das beschriebene Problem der geringen Menge +an Ausgabe-Streams zu umgehen, stellt das Paket \Package{morewrites} dar. +Allerdings ist dessen Verwendung nicht in allen Fällen von Erfolg gekrönt. diff --git a/source/doc/tudscr-index.tex b/source/doc/tudscr-index.tex index d8a2348d..233611d4 100644 --- a/source/doc/tudscr-index.tex +++ b/source/doc/tudscr-index.tex @@ -66,12 +66,12 @@ } \addchap*{\indexname} \addxcontentsline{toc}{part}{\indexname} -\PrintIndexPrologue{% - Die aufgelisteten Schlagworte sollen sowohl Antworten bei generellen Fragen - als auch Lösungen für typische Probleme beim Umgang mit \hologo{LaTeXe} sowie - dem \TUDScript-Bundle liefern. -% Falls ein gesuchter Begriff hier nicht auftaucht, ist das Forum erster -% Anlaufpunkt. -} +%\PrintIndexPrologue{% +% Die aufgelisteten Schlagworte sollen sowohl Antworten bei generellen Fragen +% als auch Lösungen für typische Probleme beim Umgang mit \hologo{LaTeXe} +% sowie dem \TUDScript-Bundle liefern. +% Falls ein gesuchter Begriff hier nicht auftaucht, sollte das \Forum erster +% Anlaufpunkt sein, um Fragen bei der Nutzung von \TUDScript zu beantworten. +%} \PrintIndex \PrintChangelog diff --git a/source/doc/tudscr-installation.tex b/source/doc/tudscr-installation.tex index 36de3d01..e98a2387 100644 --- a/source/doc/tudscr-installation.tex +++ b/source/doc/tudscr-installation.tex @@ -4,16 +4,16 @@ \chapter{Weiterführende Installationshinweise} \noindent\Attention{% Im Folgenden werden unterschiedliche Varianten erläutert, wie die jeweils aktuelle Version von \TUDScript genutzt werden kann, falls bereits eine - frühere Variante \textbf{lokal} installiert ist. Unabhängig davon, für welche - Möglichkeit Sie sich entscheiden, ist eine abermalige Installation der - PostScript"=Schriften für eine fehlerfreie Verwendung von \TUDScript zwingend - notwendig, wenn Sie bisher \TUDScript vor der Version~v2.02 verwendet haben. - Das liegt daran, dass der Installationsprozess der Schriften des \CDs für die - Version~v2.02 nochmals angepasst werden musste. Dieser Schritt ließ sich - leider nicht vermeiden. Für zukünftige Versionen kann darauf hoffentlich - verzichtet werden, sodass Aktualisierungen ausschließlich über CTAN - eingespielt werden können. Die Installation der PostScript"=Schriften ist in - \autoref{sec:install} beschrieben. + frühere Variante als \textbf{lokale Nutzerinstallation} verwendet wird. + Unabhängig davon, für welche Möglichkeit Sie sich entscheiden, ist eine + abermalige Installation der PostScript"=Schriften für eine fehlerfreie + Verwendung von \TUDScript zwingend notwendig, wenn Sie bisher \TUDScript vor + der Version~v2.02 verwendet haben, da der Installationsprozess der Schriften + des \CDs für die Version~v2.02 nochmals angepasst werden musste. Dieser + Schritt ließ sich leider nicht vermeiden. Für zukünftige Versionen kann + darauf hoffentlich verzichtet werden, sodass Aktualisierungen ausschließlich + über CTAN eingespielt werden können. In \autoref{sec:install} wird der + Installationsprozess der PostScript"=Schriften beschrieben. } \bigskip\noindent @@ -92,16 +92,17 @@ \section{Lokale Deinstallation des \TUDScript-Bundles} Wird \emph{nur} das lokale Nutzerverzeichnis oder gar kein Verzeichnis gefunden, so wird höchstwahrscheinlich eine veraltete Distribution -verwendet. In diesem Fall \emph{muss} \TUDScript lokal aktualisiert -(\autoref{sec:local:update}) beziehungsweise bei der erstmaligen Verwendung -lokal installiert (\autoref{sec:local:install}) werden. Sollte neben dem -Pfad der Distribution immer noch mindestens ein weiterer Pfad angezeigt werden, -so ist weiterhin eine lokale Nutzerversion installiert. In diesem Fall hat der -Anwender zwei Möglichkeiten: +verwendet. In diesem Fall wird eine Aktualisierung dieser \emph{unbedingt} +empfohlen. Sollte dies nicht möglich sein, \emph{muss} \TUDScript als lokale +Nutzerversion aktualisiert (\autoref{sec:local:update}) beziehungsweise bei der +erstmaligen Verwendung installiert (\autoref{sec:local:install}) werden. Sollte +neben dem Pfad der Distribution immer noch mindestens ein weiterer Pfad +angezeigt werden, so ist weiterhin eine lokale Nutzerversion installiert. In +diesem Fall hat der Anwender zwei Möglichkeiten: % \begin{enumerate} \item Entfernen der lokalen Nutzerinstallation (manuell) -\item Update der lokalen Nutzerversion +\item Aktualisierung der lokalen Nutzerversion \end{enumerate} % Die erste Variante wird nachfolgend erläutert, die zweite Möglichkeit wird in @@ -125,7 +126,7 @@ \section{Lokale Deinstallation des \TUDScript-Bundles} \Path{\emph{}} navigiert werden. Anschließend ist in diesem Pfad Folgendes durchzuführen: % -\settowidth{\tempdim}{\Path{tex/latex/tudscr/}}% +\settowidth\tempdim{\Path{tex/latex/tudscr/}}% \begin{description}[labelwidth=\tempdim,labelsep=1em] \item[\Path{tex/latex/tudscr/}]alle .cls- und .sty-Dateien löschen \item[\Path{tex/latex/tudscr/}]Ordner \Path{logo} vollständig löschen @@ -137,8 +138,8 @@ \section{Lokale Deinstallation des \TUDScript-Bundles} \textbf{sollte erhalten bleiben}. Andernfalls müssen die Schriften des \CDs abermals wie unter \autoref{sec:install} beschrieben installiert werden. Zum Abschluss ist in der Kommandozeile beziehungsweise im Terminal der Befehl -\Path{texhash} aufzurufen. Damit wurde die lokale Version entfernt und es wird -von nun an die Version von \TUDScript genutzt, welche durch die verwendete +\Path{texhash} aufzurufen. Damit wurde die lokale Nutzerversion entfernt und es +wird von nun an die Version von \TUDScript genutzt, welche durch die verwendete Distribution bereitgestellt wird. @@ -147,15 +148,15 @@ \section{Lokale Installation des \TUDScript-Bundles} \label{sec:local:install} \index{Installation!Nutzerinstallation}\index{Nutzerinstallation (lokal)} % -Für die lokale Installation von \TUDScript inklusive der Schriften des \CDs -werden für Windows sowie unixartige Betriebssysteme die passenden Skripte +Für die lokale Nutzerinstallation von \TUDScript inklusive der Schriften des +\CDs werden für Windows sowie unixartige Betriebssysteme die passenden Skripte angeboten. Eine lokale Installation sollte nur von Anwender ausgeführt werden, die genau wissen, aus welchen Gründen dies geschehen soll. \subsection{Lokale Installation von \TUDScript unter Windows} \index{Installation!Nutzerinstallation}\index{Nutzerinstallation (lokal)} -Für eine lokale Installation sowohl des \TUDScript-Bundles als auch der +Für eine lokale Nutzerinstallation sowohl des \TUDScript-Bundles als auch der dazugehörigen Schriften für die Distributionen \Distribution{\hologo{TeX}~Live} oder \Distribution{\hologo{MiKTeX}} werden neben Schriftarchiven die Dateien aus \hrfn{https://github.com/tud-cd/tudscr/releases/download/\vTUDScript/TUD-KOMA-Script\_\vTUDScript\_Windows\_full.zip}% @@ -164,7 +165,7 @@ \subsection{Lokale Installation von \TUDScript unter Windows} sichergestellt werden, dass sich \emph{alle} der folgenden Dateien im selben Verzeichnis befinden: % -\settowidth{\tempdim}{\File{tudscr\_\vTUDScript\_install.bat}}% +\settowidth\tempdim{\File{tudscr\_\vTUDScript\_install.bat}}% \begin{description}[labelwidth=\tempdim,labelsep=1em] \item[\File{tudscr\_\vTUDScript.zip}]Archiv mit Klassen- und Paketdateien \item[\File{tudscr\_\vTUDScript\_install.bat}]Installationsskript @@ -188,7 +189,7 @@ \subsection{Lokale Installation von \TUDScript unter Windows} \subsection{Lokale Installation von \TUDScript unter Linux und OS~X} \index{Installation!Nutzerinstallation}\index{Nutzerinstallation (lokal)} -Für eine lokale Installation sowohl des \TUDScript-Bundles als auch der +Für eine lokale Nutzerinstallation sowohl des \TUDScript-Bundles als auch der dazugehörigen Schriften für die Distributionen \Distribution{\hologo{TeX}~Live} oder \Distribution{Mac\hologo{TeX}} werden neben Schriftarchiven die Dateien aus \hrfn{https://github.com/tud-cd/tudscr/releases/download/\vTUDScript/TUD-KOMA-Script\_\vTUDScript\_Unix\_full.zip}% @@ -198,7 +199,7 @@ \subsection{Lokale Installation von \TUDScript unter Linux und OS~X} Verzeichnis befinden: % \begin{description}[labelwidth=\tempdim,labelsep=1em] -\settowidth{\tempdim}{\File{tudscr\_\vTUDScript\_install.sh}}% +\settowidth\tempdim{\File{tudscr\_\vTUDScript\_install.sh}}% \item[\File{tudscr\_\vTUDScript.zip}]Archiv mit Klassen- und Paketdateien \item[\File{tudscr\_\vTUDScript\_install.sh}]Installationsskript (Terminal: \Path{bash tudscr\_\vTUDScript\_install.sh}) @@ -218,31 +219,34 @@ \subsection{Lokale Installation von \TUDScript unter Linux und OS~X} \section{Lokales Update des \TUDScript-Bundles} \label{sec:local:update} \index{Update!Nutzerinstallation}\index{Nutzerinstallation (lokal)} -% -%\subsection{Update des \TUDScript-Bundles ab Version~\NoCaseChange{v}2.02} -%Für eine lokale Aktualisierung von \TUDScript auf \vTUDScript{} muss das Archiv -%\hrfn{https://github.com/tud-cd/tudscr/releases/download/\vTUDScript/TUD-KOMA-Script\_\vTUDScript\_Windows\_update.zip}% -%{TUD-KOMA-Script\_\vTUDScript\_Windows\_update.zip} respektive -%\hrfn{https://github.com/tud-cd/tudscr/releases/download/\vTUDScript/TUD-KOMA-Script\_\vTUDScript\_Unix\_update.zip}% -%{TUD-KOMA-Script\_\vTUDScript\_Unix\_update.zip} entpackt und anschließend -%\File{tudscr\_\vTUDScript\_update.bat} oder -%\File{tudscr\_\vTUDScript\_update.sh} ausgeführt werden. -%\Attention{% -% Das lokale Update funktioniert nur, wenn bereits mindestens Version~v2.02 -% entweder lokal oder über die Distribution installiert ist.% -%} + + + +\subsection{Update des \TUDScript-Bundles ab Version~\NoCaseChange{v}2.02} +Für eine lokale Aktualisierung von \TUDScript auf \vTUDScript{} muss das Archiv +\hrfn{https://github.com/tud-cd/tudscr/releases/download/\vTUDScript/TUD-KOMA-Script\_\vTUDScript\_Windows\_update.zip}% +{TUD-KOMA-Script\_\vTUDScript\_Windows\_update.zip} respektive +\hrfn{https://github.com/tud-cd/tudscr/releases/download/\vTUDScript/TUD-KOMA-Script\_\vTUDScript\_Unix\_update.zip}% +{TUD-KOMA-Script\_\vTUDScript\_Unix\_update.zip} entpackt und anschließend +\File{tudscr\_\vTUDScript\_update.bat} oder +\File{tudscr\_\vTUDScript\_update.sh} ausgeführt werden. +\Attention{% + Die lokale Aktualisierung funktioniert nur, wenn \TUDScript bereits + mindestens in der Version~v2.02 entweder als lokale Nutzerversion oder über + die Distribution sowie die PostScript"=Schriften installiert sind.% +} \subsection{Update des \TUDScript-Bundles ab Version~\NoCaseChange{v}2.00} Mit der Version~v2.02 gab es einige tiefgreifende Änderungen. Deshalb wird für vorausgehende Versionen~-- sprich v2.00 und v2.01~-- kein dediziertes Update angeboten. Die Aktualisierung kann durch den Anwender entweder~-- wie in \autoref{sec:local:install} erläutert~-- mit einer skriptbasierten oder mit -einer manuellen Neuinstallation lokal erfolgen. Für die zweite Variante muss +einer manuellen Neuinstallation erfolgen. Für die zweite Variante muss der Inhalt des Archivs \hrfn{https://github.com/tud-cd/tudscr/releases/download/\vTUDScript/tudscr\_\vTUDScript.zip}% {\File{tudscr\_\vTUDScript.zip}} in das lokale \Path{texmf}"=Nutzerverzeichnis kopiert werden. Des Weiteren wurde die Installation der Schriften überarbeitet. -Deshalb wird auch für diese eine Neuinstallation (\autoref{sec:install}) +Deshalb wird auch für diese eine Neuinstallation (\autoref{sec:install}) sehr empfohlen. @@ -263,9 +267,9 @@ \subsection{Update des \TUDScript-Bundles von Version \NoCaseChange{v}1.0} Version~\vTUDScript{} kann nach der Deinstallation der Version~v1.0 wie unter \autoref{sec:install} beschrieben installiert werden. -Sollen die obsoleten \TUDScript-Klassen in der Version~v1.0 nach einer -Aktualisierung weiterhin genutzt werden, so müssen diese erst wie zuvor -beschrieben de"~~und anschließend neu installiert werden. Dafür kann das Archiv +Möchten Sie die obsoleten \TUDScript-Klassen in der Version~v1.0 nach einer +Aktualisierung weiterhin nutzen, so müssen diese nach der Deinstallation neu +installiert werden. Dafür kann das Archiv \hrfn{https://github.com/tud-cd/tudscrold/releases/download/v1.0/TUD-KOMA-Script_v1.0old.zip}% {\File*{TUD-KOMA-Script\_v1.0old.zip}} verwendet werden, welches sowohl die genannten Skripte zur Deinstallation als auch die zur neuerlichen Installation @@ -276,15 +280,14 @@ \subsection{Update des \TUDScript-Bundles von Version \NoCaseChange{v}1.0} parallel zur aktuellen Version~\vTUDScript{} genutzt werden. Im Vergleich zur Version~v1.0 hat sich an der Benutzerschnittstelle nicht sehr -viel verändert. Treten nach dem Umstieg von der Version~v1.0 auf die -Version~\vTUDScript{} dennoch Probleme auf, sollte der Anwender als erstes in -die Beschreibung des Paketes \Package{tudscrcomp}'full' sehen. Diese Paket -stellt eine Schnittstelle bereit, mit der es möglich ist, alte und ursprünglich -nicht mehr vorgesehene Befehle und Optionen dennoch zu nutzen. Allerdings -werden einige von diesen auch durch das Paket \Package{tudscrcomp} nicht mehr -bereitgestellt, weil diese schlichtweg verworfen wurden. Diese sind in -\autoref{sec:obsolete} aufgeführt und es werden im alten Dokument notwendige -Anpassungen beschrieben. Sollten dennoch Fehler oder Probleme beim Umstieg auf +viel verändert. Treten nach dem Umstieg auf die Version~\vTUDScript{} dennoch +Probleme auf, sollte der Anwender als erstes in die Beschreibung des Paketes +\Package{tudscrcomp}'full' sehen,welches eine Schnittstelle bereitstellt, mit +der es möglich ist, alte und ursprünglich nicht mehr vorgesehene Befehle sowie +Optionen dennoch zu nutzen. Allerdings werden einige von diesen auch durch das +Paket \Package{tudscrcomp} nicht mehr bereitgestellt. Aufgeführt sind diese in +\autoref{sec:obsolete}. Sollten trotz aller Hinweise in besagtem +\autorefname[sec:obsolete] dennoch Fehler oder Probleme beim Umstieg auf die neue \TUDScript-Version auftreten, ist eine Meldung im Forum die beste Möglichkeit, um Hilfe zu erhalten. \end{Declaration*} diff --git a/source/doc/tudscr-introduction.tex b/source/doc/tudscr-introduction.tex index 7f821f36..006109b1 100644 --- a/source/doc/tudscr-introduction.tex +++ b/source/doc/tudscr-introduction.tex @@ -98,13 +98,13 @@ \section{Installation des \TUDScript-Bundles} Bedingungen \emph{ohne} die geschützten Schriften \Univers und \DIN~-- im \foreignlanguage{english}{% \hrfn{http://www.ctan.org/}{Comprehensive TeX Archive Network (CTAN)} -} zu finden und dadurch in aktuellen \hologo{LaTeX}"=Distributionen wie +} zu finden und kann dadurch die aktuellen \hologo{LaTeX}"=Distributionen wie \Distribution{\hologo{TeX}~Live}[2014], \Distribution{Mac\hologo{TeX}}[2014] -oder auch \Distribution{\hologo{MiKTeX}}[2.9] enthalten. Aus diesem Grund ist -eine komplett lokale Nutzerinstallation wie in den vorherigen Versionen nicht -mehr notwendig. Auch manuelle Updates des \TUDScript-Bundles sind~-- für den -Fall, dass die \hologo{LaTeX}"=Distribution durch den Nutzer aktuell gehalten -wird~-- prinzipiell nicht mehr nötig. +oder auch \Distribution{\hologo{MiKTeX}}[2.9] genutzt werden. Es besteht +momentan aus den drei Hauptklassen \Class{tudscrbook}, \Class{tudscrreprt} +sowie \Class{tudscrartcl}~-- dokumentiert in \autoref{sec:mainclasses}~-- und +sowohl mit den \TUDScript-Klassen assoziierten als auch eigenständigen Paketen, +welche in \autoref{sec:bundle} beschrieben sind. Zur problemlosen Verwendung des \TUDScript-Bundles ist~-- neben \KOMAScript{} in der Version~\vKOMAScript und den in \autoref{sec:packages:needed} aufgeführten @@ -128,8 +128,8 @@ \section{Installation des \TUDScript-Bundles} finden. \Attention{% - Wurde \TUDScript in einer früheren Ausführung als lokale Nutzerinstallation - eingerichtet oder soll es in der Version \vTUDScript{} lokal installiert + Wurde \TUDScript in einer früheren Ausführung als lokale Nutzerversion + installiert oder soll es in der Version \vTUDScript{} als solche genutzt werden, so sei auf \autoref{sec:install:ext} verwiesen.% } @@ -166,7 +166,7 @@ \subsection{Installation der PostScript-Schriften unter Windows} \File{tudscrfonts\_install.bat} sollte sichergestellt werden, dass sich \emph{alle} der folgenden Dateien im selben Verzeichnis befinden: % -\settowidth{\tempdim}{\File{tudscrfonts\_install.bat}}% +\settowidth\tempdim{\File{tudscrfonts\_install.bat}}% \begin{description}[labelwidth=\tempdim,labelsep=1em] \item[\File{tudscrfonts\_install.bat}]Installationsskript \item[\File{Univers\_PS.zip}]Archiv mit Schriftdateien für \Univers @@ -239,7 +239,7 @@ \subsection{Installation der PostScript-Schriften unter Linux und OS~X} \File{tudscrfonts\_install.sh} sollte sichergestellt werden, dass sich \emph{alle} der folgenden Dateien im selben Verzeichnis befinden: % -\settowidth{\tempdim}{\File{tudscrfonts\_install.sh}}% +\settowidth\tempdim{\File{tudscrfonts\_install.sh}}% \begin{description}[labelwidth=\tempdim,labelsep=1em] \item[\File{tudscrfonts\_install.sh}]Installationsskript (Terminal: \Path{bash tudscrfonts\_install.sh}) @@ -257,10 +257,10 @@ \subsection{Probleme bei der Installation der PostScript-Schriften} Treten bei der Installation wider Erwarten Probleme auf, so sollte eine Logdatei erstellt werden. Unter Windows muss das Skript, welches Probleme verursacht, aus der Kommandozeile mit -\Path{\PName{Skript}.bat > \PName{Skript}.log} aufgerufen werden, wobei hierbei -das doppelte Betätigen der Eingabetaste nötig ist. Für unixartige Systeme -ist der Aufruf \Path{./\PName{Skript}.sh > \PName{Skript}.log} aus dem Terminal -heraus zu verwenden. Die erstellte Logdatei kann mit einer kurzen +\Path{\PName{Skript}.bat > \PName{Skript}.log} aufgerufen werden, wobei das +doppelte Betätigen der Eingabetaste nötig ist. Für unixartige Systeme +ist der Aufruf \Path{bash \PName{Skript}.sh > \PName{Skript}.log} aus dem +Terminal heraus zu verwenden. Die erstellte Logdatei kann mit einer kurzen Fehlerbeschreibung direkt an \Email{\tudscrmail} gesendet werden. diff --git a/source/doc/tudscr-mainclasses.tex b/source/doc/tudscr-mainclasses.tex index 63feffb1..cb60a9fd 100644 --- a/source/doc/tudscr-mainclasses.tex +++ b/source/doc/tudscr-mainclasses.tex @@ -1,4 +1,10 @@ \chapter[Die Klassen tudscrbook, tudscrreprt und tudscrartcl]{Die Hauptklassen} +\label{sec:mainclasses} +\ChangedAt*{% + v2.00!Robustheit vieler Befehle und Optionen erhöht,% + v2.02!Umbenennung einiger Befehle für Kompatibilität mit anderen Paketen,% + v2.03!Anpassungen interner Befehle an \KOMAScript-Version~v3.15% +} \begin{Declaration*}{\Class{tudscrbook}} \begin{Declaration*}{\Class{tudscrreprt}} \begin{Declaration*}{\Class{tudscrartcl}} @@ -55,10 +61,15 @@ \end{Declaration} + \section{Die Schriften des \CDs} \label{sec:fonts} \index{Schrift|?} % +\ChangedAt*{% + v2.00!Schriften~-- insbesondere für den mathematischen Satz~-- verbessert,% + v2.01!Unterschneidung (Kerning) der Ziffern für \Univers verbessert% +} Das \CD der \TnUD gibt die Verwendung der Schriften \Univers für den Fließtext sowie \DIN für das Setzen von Überschriften vor. Im Standardfall wird dies so unterstützt. Da jedoch in längeren Texten die Verwendung von Serifenschriften @@ -87,7 +98,7 @@ \section{Die Schriften des \CDs} \subsection{Schriften für den Textsatz} \begin{Declaration}[% - v2.02!Werte für Optionen \Option{barfont} und \Option{fontspec} ergänzt% + v2.02!Werte für Optionen \Option{cdhead} und \Option{fontspec} ergänzt% ]{\Option{cdfont}[\PSet]}[true]% \printdeclarationlist% \label{sec:text}% @@ -108,7 +119,7 @@ \subsection{Schriften für den Textsatz} Für die Verwendung der klassischen \hologo{LaTeX}"=Schriften, ist das Paket \Package{lmodern} sehr empfehlenswert.% } - Sollte das Layout des \CDs aktiviert sein (siehe \Option{cd}), werden die + Sollte das Layout des \CDs aktiviert sein (\see*{\Option{cd}}), werden die Überschriften in Großbuchstaben und \DIN gesetzt und nur die Schriftart des Fließtextes kann angepasst werden. \itemtrue*[light/lightfont/noheavyfont] @@ -141,33 +152,33 @@ \subsection{Schriften für den Textsatz} Für den Text im Querbalken gibt es folgende Einstellmöglichkeiten: % \begin{values} -\item[barfont] +\item[head/lighthead/lightfonthead/noheavyfonthead] Für den Querbalken der Kopfzeile wird unabhängig von der Verwendung der Hausschriften die Schrift \Univers in normaler Schriftstärke verwendet, - siehe \Option{barfont}[true]. -\item[heavybarfont] - Die im Querbalken der Kopfzeile verwendete Stärke der Schrift \Univers wird - erhöht, siehe \Option{barfont}[heavy]. + \see*{\Option{cdhead}[true]}. +\item[heavyhead/heavyfonthead] + Die im Querbalken der Kopfzeile verwendete Schrift ist in jedem Fall \Univers + in erhöhter Stärke, \see*{\Option{cdhead}[heavy]}. \end{values} % Die verwendeten Mathematikschriften lassen sich mit folgenden Werte beeinflussen: % \begin{values} -\item[serifmath/serif/nosansmath/nosans] +\item[nomath/nocdmath] Diese Einstellung deaktiviert die Verwendung von serifenlosen Schriften für den mathematischen Satz. Es werden die \hologo{LaTeX}"=Standardschriften verwendet und der Benutzer kann beliebige Schriftpakete für den - Mathematikmodus nutzen, siehe \Option{sansmath}[false]. -\item[sansmath/sans] + Mathematikmodus nutzen, \see*{\Option{cdmath}[false]}. +\item[math/cdmath] Es werden serifenlose Mathematikschriften für lateinische und griechische - Lettern genutzt, siehe \Option{sansmath}[true]. -\item[upgreek/uprightgreek/uprightGreek] + Lettern genutzt, \see*{\Option{cdmath}[true]}. +\item[upgreek/uprightgreek] Die großen griechischen Buchstaben werden im Mathematikmodus aufrecht gesetzt, - siehe \Option{slantedgreek}[false]. -\item[slgreek/slantedgreek/slantedGreek] + \see*{\Option{slantedgreek}[false]}. +\item[slgreek/slantedgreek] In mathematischen Umgebungen erfolgt die Ausgabe der griechischen Majuskeln - kursiv, siehe \Option{slantedgreek}[true]. + kursiv, \see*{\Option{slantedgreek}[true]}. \end{values} % \ChangedAt{v2.02} @@ -260,7 +271,7 @@ \subsubsection{Auszeichnungen im Text} Schriftelemente. Dabei wird \Font{titlepage} auf der Titelseite für alle Felder verwendet, welche kein spezielles Schriftelement verwenden und \Font{thesis} für das mit \Macro{thesis} angegebene Feld, in welchem der Typ -einer Abschlussarbeit angegeben wird (siehe \autoref{sec:title}). Mit +einer Abschlussarbeit angegeben wird (\see*{\autoref{sec:title}}). Mit \Font{parttitle} kann die Schrift für die Bezeichnung des Teils bei aktivierter \Option{parttitle}-Option beeinflusst werden. Alle Schriften lassen sich mit \Macro{addtokomafont}\Parameter{Schriftelement} anpassen. @@ -286,8 +297,8 @@ \subsubsection{Auszeichnungen im Text} \begin{Declaration}{\Macro{textuxs}\Parameter{Text}} \begin{Declaration}{\Macro{dinbn}} \begin{Declaration}{\Macro{textdbn}\Parameter{Text}} -\settowidth{\tempdim}{\Macro{textuln}\Parameter{Text}}% -\addtolength{\tempdim}{\dimexpr 2\tabcolsep+2\arrayrulewidth-\textwidth}% +\settowidth\tempdim{\Macro{textuln}\Parameter{Text}}% +\addtolength\tempdim{\dimexpr 2\tabcolsep+2\arrayrulewidth-\textwidth}% \printdeclarationlist(% \begin{minipage}{-\tempdim}% \centering% @@ -353,35 +364,37 @@ \subsubsection{Auszeichnungen im Text} \end{Declaration} \end{Declaration} + \subsection{Schriften für den Mathematiksatz} -\begin{Declaration}{\Option{sansmath}[\PBoolean]}% +\begin{Declaration}[v2.03]{\Option{cdmath}[\PBoolean]}% [true][\Option{cdfont}[false]:false] \printdeclarationlist% \label{sec:math} \index{Schrift!Mathematiksatz}\index{Mathematiksatz|!} \index{Schrift!Griechische Buchstaben}\index{Griechische Buchstaben} % -Diese Option dient zur Verwendung serifenloser Mathematikschriften. Dafür -werden zum einen die griechischen Buchstaben aus \Package{cmbright} und zum -anderen die Symbole aus \Package{iwona} verwendet. Für die lateinischen -Buchstaben wird \Univers genutzt. Ein Umschalten auf Serifenlose und zurück -innerhalb des Dokumentes ist~-- beispielsweise in einer Abbildung oder in einer -Tabelle~-- durch \Macro{TUDoptions}\PParameter{\Option{sansmath}[true]} und -\Macro{TUDoptions}\PParameter{\Option{sansmath}[false]} möglich. Mit -\Macro{boldmath} kann auf fette Mathematikschriften umgeschaltet werden. - -Mit der Einstellung \Option{sansmath}[false] wird auf die Standardschriften -für den Mathematikmodus zurückgeschaltet. Sollen stattdessen andere serifenlose -Mathematikschriften genutzt werden, so sei auf \Package{sansmath}, -\Package{sansmathfonts}, \Package{mathastext}, \Package{sfmath} sowie -\Package{sansmathaccent} verwiesen. +Diese Option dient zur Anpassung der Mathematikschriften. Wird diese aktiviert, +so werden zu den Hausschriften passende im Mathematikmodus genutzt, mit +\Option{cdmath}[false] wird auf die Standardschriften zurückgeschaltet. Ein +Umschalten innerhalb des Dokumentes ist~-- beispielsweise für Abbildungen oder +Tabellen~-- durch \Macro{TUDoptions}\PParameter{\Option{cdmath}[true/false]} +möglich. Mit \Macro{boldmath} kann auf fette Mathematikschriften umgeschaltet +werden. % \begin{values} \itemfalse Es werden die normalen \hologo{LaTeX}"=Serifenschriften beziehungsweise die Schriften beliebig nutzbarer Pakete für den Mathematiksatz verwendet. \itemtrue* - Die serifenlose Mathematikschriften werden aktiviert. + Im Mathematikmodus wird \Univers genutzt. Außerdem kommen die griechischen + Buchstaben aus dem Paket \Package{cmbright} sowie Symbole aus dem Paket + \Package{iwona} zum Einsatz. +\item[upgreek/uprightgreek] + Die griechischen Majuskeln werden aufrecht gesetzt, + \see*{\Option{slantedgreek}[false]}. +\item[slgreek/slantedgreek] + Die Ausgabe der griechischen Großbuchstaben erfolgt kursiv, + \see*{\Option{slantedgreek}[true]}. \end{values} \end{Declaration} @@ -410,8 +423,8 @@ \subsubsection{Griechischen Buchstaben} \begin{Declaration}{\Macro{upPsi}} \begin{Declaration}{\Macro{upOmega}} \index{Schrift!Griechische Buchstaben}\index{Griechische Buchstaben}% -\settowidth{\tempdim}{\Macro{varUpsilon}}% -\addtolength{\tempdim}{\dimexpr 2\tabcolsep+2\arrayrulewidth-\textwidth}% +\settowidth\tempdim{\Macro{varUpsilon}}% +\addtolength\tempdim{\dimexpr 2\tabcolsep+2\arrayrulewidth-\textwidth\relax}% \printdeclarationlist(% \begin{minipage}{-\tempdim}% \newcommand\tablecontent{}% @@ -440,7 +453,7 @@ \subsubsection{Griechischen Buchstaben} )% % Griechische Majuskeln werden sowohl in aufrechter als auch in geneigter Form -bereitgestellt. Unabhängig von den beiden Optionen \Option{sansmath} und +bereitgestellt. Unabhängig von den beiden Optionen \Option{cdmath} und \Option{slantedgreek} können sowohl kursive als auch aufrechte griechischen Großbuchstaben im Mathematikmodus direkt verwendet werden. Dies ist nützlich, um zwischen kursiven Variablen und aufrechten Konstanten zu unterscheiden. Die @@ -543,23 +556,24 @@ \subsection{Die Schriften des \CDs im OpenType-Format} \section{Das Layout des \CDs} Das Hauptaugenmerk der neuen Klassen liegt auf der Umsetzung des \CDs der \TnUD für \hologo{LaTeX}. Ein großer Teil der definierten Optionen und Befehle -dient genau dazu und wird folgend beschrieben. +dient genau dazu und wird nachfolgend beschrieben. Einige spezielle Seiten werden im prägnanten Stil mit dem Logo der \TnUD und der dazugehörigen Kopfzeile mit Querbalken gesetzt. Dies betrifft insbesondere -\hyperref[sec:title]{die Umschlagseite und den Titel in \autoref{sec:title}}, +\hyperref[sec:title]{die Umschlagseite und den Titel aus \autoref{sec:title}}, die \hyperref[sec:part]{Teileseiten in \autoref{sec:part}} sowie die -\hyperref[sec:chapter]{Kapitelseiten in \autoref{sec:chapter}}. -Außerdem können entweder mit den \PageStyle{tudheadings}"=Seitenstilen oder -mit der \Environment{tudpage}-Umgebung aus \autoref{sec:tudheadings} eigene -Seiten im selben Stil erzeugt werden. Wird das Paket \Package{tudscrsupervisor} -verwendet und mit den entsprechenden Befehlen oder Umgebungen aus diesem eine -Aufgabenstellung, ein Gutachten oder ein Aushang erstellt, so erscheinen auch -diese in besagtem Seitenstil. +\hyperref[sec:chapter]{Kapitelseiten in \autoref{sec:chapter}}. Mit den +\PageStyle{tudheadings}"=Seitenstilen oder der \Environment{tudpage}-Umgebung +können weitere Seiten in diesem Stil erzeugt werden. Wird das Paket +\Package{tudscrsupervisor} verwendet und mit den bereitgestellten Befehlen oder +Umgebungen eine Aufgabenstellung, ein Gutachten oder ein Aushang erstellt, so +erscheinen auch diese in besagtem Seitenstil. -\subsection{Das Erscheinungsbild von Titel, Teilen und Kapiteln} -\begin{Declaration}{\Option{cd}[\PSet]}[true] +\subsection{Die Gestalt von Titel, Umschlagseite, Teilen und Kapiteln} +\begin{Declaration}[% + v2.03!Option für neue Gestaltungsmöglichkeiten erweitert% +]{\Option{cd}[\PSet]}[true] \printdeclarationlist% \index{Layout}% % @@ -570,18 +584,25 @@ \subsection{Das Erscheinungsbild von Titel, Teilen und Kapiteln} \itemfalse Diese Einstellung erzeugt das Standard"=Verhalten der \KOMAScript"=Klassen, es wird kein \CD genutzt. -\itemtrue*[standard/simple/monochrom] +\itemtrue*[nocolor/nocolour/monochrome] Das Layout für Titel"~, Teil"~ und Kapitelseiten ist im \CD, es wird schwarze Schrift für Titel, Teil"~ und Kapitelüberschriften sowie im Seitenkopf verwendet. -\item[lite/light/pale] +\item[lightcolor/pale] Die Einstellung entspricht weitestgehend der Option \Option{cd}[true], - allerdings wird die primäre Hausfarbe \Color{HKS41} anstelle schwarzer - Schrift genutzt. -\item[color/colour/full] + allerdings wird die primäre Hausfarbe \Color{HKS41} für den Kopf des + \PageStyle{tudheadings}"=Seitenstils und die Schrift genutzt. +\item[bicolor/bicolour/bichrome] + \ChangedAt{v2.03} Der Kopf wird mit einem farbigen Hintergrund in der + Hausfarbe gesetzt, auch der Querbalken wird farbig hinterlegt. Die Schrift + wird in der primären Hausfarbe gesetzt. +\item[color/colour] Der Titel sowie Teil"~ und Kapitelseiten werden allesamt farbig und im \CD gestaltet, der Seitenkopf wird in der primären Hausfarbe \Color{HKS41} - gesetzt. + gesetzt, der Querbalken erhält Linien als Begrenzung. +\item[full/fullcolor/fullcolour] + \ChangedAt{v2.03} Entspricht der vorherigen Einstellung, allerdings wird der + Querbalken nicht durch Linien begrenzt sondern farbig hinterlegt. \end{values} \end{Declaration} @@ -599,12 +620,11 @@ \subsection{Das Erscheinungsbild von Titel, Teilen und Kapiteln} auch die Überschrift eines Kapitels bei deaktivierter Kapitelseite (\Option{chapterpage}[false]) in ihrer vertikalen Position anzupassen. -Normalerweise werden alle der zuvor genannten Überschriften im Layout relativ -tief im Textbereich gesetzt. Mit negativen Werten wird diese nach oben -verschoben, positive Werte setzen diese dementsprechend tiefer. Beim -Verschieben nach oben, sollte darauf geachtet werden, dass diese sich danach -noch innerhalb des Satzspiegels befinden, da dies \emph{nicht} automatisch -durch die Hauptklassen überprüft wird. +Die zuvor genannten Überschriften werden normalerweise im Layout relativ tief +im Textbereich gesetzt. Mit negativen Werten werden die Überschriften nach oben +verschoben, wobei darauf geachtet werden sollte, dass diese sich danach noch +innerhalb des Satzspiegels befinden. Positive Werte setzen die Überschriften +dementsprechend tiefer. \end{Declaration} \end{Declaration} @@ -615,23 +635,20 @@ \subsubsection{Einstellungen für Titel, Umschlagseite, Teile und Kapitel} Teileseite (\Macro{part}, \Macro{addpart}), Kapitelseite (\Macro{chapter}, \Macro{addchap})% } -wird normalerweise von der Option \Option{cd}[\PSet] bestimmt. Bedarfsweise -können einzelne Elemente andererseits auch individuell mit abweichenden -Wertzuweisungen angepasst werden. Soll ein bestimmtes Elemente des Layouts -anders erscheinen als der Rest des Dokumentes, so kann der entsprechende Wert -mithilfe der folgenden Optionen überschrieben werden. Die gültigen -Wertzuweisungen für die einzelnen Elemente entsprechend dabei den möglichen -Werten für die Option \Option{cd}. +wird von der Option \Option{cd}[\PSet] bestimmt. Soll ein bestimmtes Element +des Layouts abweichend erscheinen, so kann eine der folgenden Optionen genutzt +werden, um dieses individuell anzupassen. Die gültigen Wertzuweisungen für die +einzelnen Elemente entsprechend dabei den möglichen Werten für die Option +\Option{cd}. \begin{Declaration}{\Option{cdtitle}[\PSet]} \printdeclarationlist% \index{Titel}\index{Layout!Titel}% % -Mit \Option{cdtitle} kann der Wert des Schlüssels \Option{cd} für die -Titelseite überschrieben werden. Es kann zwischen dem Standardtitel~-- welcher -durch \KOMAScript{} bereitgestellt wird~-- und dem Titel im \CD umgeschaltet -werden. Die neue Titelseite unterstützt alle durch \KOMAScript{} definierten -Befehle für den Titel.% +Mit der Option \Option{cdtitle} kann die allgemeine Einstellung für den Titel +überschrieben werden. Es kann zwischen dem normalen (\Option{cdtitle}[false]) +und dem im \CD umgeschaltet werden. Die neue Titelseite unterstützt alle durch +\KOMAScript{} definierten Befehle für den Titel.% \footnote{\raggedright% \Macro{extratitle}\Parameter{Schmutztitel},\Macro{titlehead}\Parameter{Kopf}, \Macro{subject}\Parameter{Typisierung},\Macro{title}\Parameter{Titel}, @@ -642,8 +659,8 @@ \subsubsection{Einstellungen für Titel, Umschlagseite, Teile und Kapitel} \Macro{lowertitleback}\Parameter{Titelrückseitenfuß} und \Macro{dedication}\Parameter{Widmung} } -Zusätzlich werden viele neue Felder für den Titel definiert, welche vor allem -für den Titel einer wissenschaftlichen Arbeit von Relevanz sind. Genaueres dazu +Zusätzlich werden viele neue Felder definiert, welche vor allem für eine +wissenschaftliche Arbeit von Relevanz sind. Genaueres dazu ist in \autoref{sec:title} nachzulesen. Unabhängig von der gewählten Variante der Titelseite wird diese immer mit \Macro{maketitle} erzeugt. \end{Declaration} @@ -740,7 +757,7 @@ \subsubsection{Vakatseiten/Leerseiten} erzeugte Rückseite verwendet. \item[color/colour] Im farbigen Layout ist auch die Rückseite von Teilen und Kapiteln farbig, - siehe \Option{clearcolor}. + \see*{\Option{clearcolor}}. \makeatletter\item@values[\PName{Seitenstil}\textsl{:}]\makeatother Mit der Angabe von \Option{cleardoublespecialpage}[\PName{Seitenstil}] kann ein beliebiger, bereits definierter Seitenstil für die Rückseite nach @@ -765,7 +782,7 @@ \subsubsection{Vakatseiten/Leerseiten} } Die Option wirkt sich ebenfalls auf die Rückseite des Titels aus.% \footnote{% - siehe \Macro{uppertitleback} und \Macro{lowertitleback} der + \see*{\Macro{uppertitleback} und \Macro{lowertitleback}} der \KOMAScript"=Dokumentation (\scrguide*) } Der Stil dieser zusätzlich eingefügten Rückseiten ist abhängig von der Option @@ -787,35 +804,50 @@ \subsection{Seiten im Stil des \CDs} \printdeclarationlist% \label{sec:tudheadings} % -Ein zentrales Element des \CDs der \TnUD ist der eingeführte prägnante -Seitenkopf mit der Angabe von Fakultät (\Macro{faculty}), Einrichtung -(\Macro{department}), Institut (\Macro{institute}) und Lehrstuhl -(\Macro{chair}) in der dazugehörigen Kopfzeile mit Querbalken. Durch die -Verwendung von \Package{scrlayer-scrpage} lassen sich einzelne Seiten oder auch -ganze Dokumente sehr einfach in diesem Stil setzen. Hierzu muss lediglich einer -der Seitenstile mit \Macro{pagestyle}\Parameter{Seitenstil} geladen werden. - -Allen Seitenstilen ist der typische Kopf gemein. Der Fuß des Seitenstils -\PageStyle{empty.tudheadings} ist immer leer, \PageStyle{tudheadings} und -\PageStyle{plain.tudheadings} übernehmen die Einstellungen für den Fuß aus der -Anwenderschnittstelle von \Package{scrlayer-scrpage}.% +\ChangedAt*{% + v2.03!Seitenstile um zweifarbigen Kopf und farbigen Fuß erweitert% +}% +Ein zentrales Element des \CDs der \TnUD ist der prägnante Seitenkopf mit der +Angabe von Fakultät~(\Macro{faculty}), Einrichtung~(\Macro{department}), +Institut~(\Macro{institute}) und Lehrstuhl~(\Macro{chair}) im dazugehörigen +Querbalken. Durch die Nutzung des Paketes \Package{scrlayer-scrpage} lassen +sich entweder einzelne Seiten oder auch ganze Dokumente sehr einfach in diesem +Stil setzen. Hierzu muss lediglich mit \Macro{pagestyle}\Parameter{Seitenstil} +einer der Seitenstile geladen werden. + +Allen Seitenstilen gemein ist der typische Kopf mit dem charakteristischen +Querbalken, dessen Gestalt für \emph{alle} Seitenstile gleichermaßen über die +Option \Option{cdhead} angepasst werden kann. Die Ausprägung des Fußes ist für +die einzelnen Seitenstile unterschiedlich. Dieser ist der Verwendung des Stils +\PageStyle{empty.tudheadings} immer leer. Die beiden Stile~-- oder vielmehr das +Seitenstil-Paar~-- \PageStyle{tudheadings} und \PageStyle{plain.tudheadings} +übernehmen die Einstellungen für die Fußzeile aus der Anwenderschnittstelle von +\Package{scrlayer-scrpage}.% \footnote{% Es können die Befehle \Macro{lefoot}, \Macro{cefoot} und \Macro{refoot} sowie - \Macro{lofoot}, \Macro{cofoot} und \Macro{rofoot} verwendet werden. + \Macro{lofoot}, \Macro{cofoot} und \Macro{rofoot} respektive \Macro{ofoot}, + \Macro{cfoot} und \Macro{ifoot} genutzt werden. } -Wie diese zu verwenden ist, ist der \KOMAScript"=Anleitung zu entnehmen. -Alternativ zu einer eigenen Definition der Fußzeile kann außerdem die Option -\Option{cdfoot} verwendet werden. +Wie diese zu verwenden ist, kann der \KOMAScript"=Anleitung entnommen werden. +Alternativ zu einer eigenen Definition der Fußzeile lässt sich außerdem die +Option \Option{cdfoot} verwenden. -Sobald einer der neu definierten Seitenstile aktiviert wurde, sind diese -zusätzlich unter den Namen \PageStyle{headings}, \PageStyle{plain} und -\PageStyle{empty} verwendbar. Das hat den Vorteil, dass bei Optionen oder -Befehlen, die automatisch zwischen \PageStyle{headings}, \PageStyle{plain} -und \PageStyle{empty} umschalten, durch die einmalige Auswahl von einem der -Stile \PageStyle{tudheadings}, \PageStyle{plain.tudheadings} oder -\PageStyle{empty.tudheadings} nun zwischen diesen Stilen umgeschaltet wird. Um -auf das normale Verhalten zurückzuschalten, muss einer der beiden Seitenstile -\PageStyle{scrheadings} oder \PageStyle{plain.scrheadings} aktiviert werden. +Sobald einer der definierten Stile mit \Macro{pagestyle}\Parameter{Seitentil} +aktiviert wurde, sind die beiden Seitenstile \PageStyle{tudheadings} sowie +\PageStyle{plain.tudheadings} zusätzlich unter den Namen \PageStyle{headings} +respektive \PageStyle{plain} verwendbar. Dies hat den Vorteil, dass bei +Optionen oder Befehlen, welche automatisch zwischen den beiden Seitenstilen +\PageStyle{headings} und \PageStyle{plain} umschalten, durch die einmalige +Auswahl von einem der \PageStyle{tudheadings}-Stilen nun zwischen diesen +umgeschaltet wird. + +Der Seitenstil \PageStyle{empty} erzeugt allerdings weiterhin eine komplett +leere Seite. Soll eine Seite mit der prägnanten Kopfzeile der \TnUD und leerem +Seitenfuß erschienen, so muss \Macro{pagestyle}\PParameter{empty.tudheadings} +manuell aufgerufen werden. Um auf das typische Verhalten von \KOMAScript{} +zurückzuschalten und Seiten ohne den prägnanten Kopf der \TnUD zu erhalten, +muss einer der Stile \PageStyle{scrheadings} oder \PageStyle{plain.scrheadings} +aktiviert werden. \end{Declaration} \end{Declaration} \end{Declaration} @@ -837,15 +869,183 @@ \subsection{Seiten im Stil des \CDs} automatischer Zeilenumbruch. In besonderen Ausnahmefällen erlaubt das \CD die Angabe einer zusätzlichen -zweiten beziehungsweise dritten Zeile, welche weitere, frei wählbare Angaben -enthält. Diese kann mit dem Befehl \Macro{extraheadline}\Parameter{Textzeile} -definiert werden. +zweiten beziehungsweise dritten Zeile unterhalb der Angaben des Bereichs an der +\TnUD, welche weitere, frei wählbare Angaben enthält. Diese kann mit dem Befehl +\Macro{extraheadline}\Parameter{Textzeile} definiert werden. \end{Declaration} \end{Declaration} \end{Declaration} \end{Declaration} \end{Declaration} +\begin{Declaration}[v2.03]{\Option{cdhead}[\PSet]}[true][% + \Option{cdfont}[false]:false% +] +\printdeclarationlist% +\index{Kopfzeile!Schrift}% +\index{Layout!Kopfzeile}% +\index{Querbalken}\index{Layout!Querbalken}% +% +Mit dieser Option lassen sich für die \PageStyle{tudheadings}"=Seitenstile +sowohl die Gestalt des Logos sowie des Querbalkens als auch die darin +verwendete Schrift beeinflussen. Die folgenden Werte können für eine Anpassung +der Schriftart im Balken verwendet werden: +% +\begin{values} +\itemfalse + Sollte mit \Option{cdfont}[false] die Verwendung der Hausschrift im Stil des + \CDs der \TnUD deaktiviert worden sein, wird die Kopfzeile im Querbalken in + den Serifenlosen der genutzten Schrift gesetzt. Sind die Hausschriften + aktiviert, hat diese Einstellung keinen Einfluss. +\itemtrue*[light/lightfont/noheavyfont] + Im Querbalken wird für \Macro{faculty} \textubn{Univers~65~Bold} verwendet, + für die Felder \Macro{department}, \Macro{institute}, \Macro{chair} und + \Macro{extraheadline} kommt \textuln{Univers~45~Light} zum Einsatz. +\item[heavy/heavyfont] + Der Inhalt von \Macro{faculty} wird weiterhin in \textubn{Univers~65~Bold} + gesetzt, für die restlichen Felder wird \texturn{Univers~55~Regular} genutzt. +\end{values} +% +Bei der Ausprägung des Kopfes und des Querbalkens gibt es mehrere Varianten: +% +\begin{values} +\item[nocolor/nocolour/monochrome] + Der Kopf und die Linien des Querbalkens erscheinen in schwarzer Farbe. +\item[lightcolor/pale] + Sowohl Kopf als auch Querbalken werden in der primären Hausfarbe gesetzt. +\item[bicolor/bicolour/bichrome] + \ChangedAt{v2.03} Die Kopfzeile wird farblich abgesetzt, wobei der + Hintergrund des Logos und der Querbalken unterschiedlich ausfallen. Die + Außenlinien der Querbalkens entfallen. +\end{values} +% +Die Außenlinien des Querbalkens laufen entweder bis zum Text"~ oder jedoch bis +zum Blattrand. Für den Fall, dass ein randloser Ausdruck technisch nicht +möglich ist, können die Varianten bei denen der Querbalken bis an den Blattrand +reicht Probleme bereiten. Deshalb kann mit der Option \Option{cdhead} dessen +Breite angepasst werden. Normalerweise wird der Querbalken lediglich im +farbigen Layout in der Blattbreite erzeugt. +% +\begin{values} +\item[textwidth/slim] + Der Querbalken im Kopf erstreckt sich immer nur über den Textbereich. +\item[paperwidth/wide] + Die horizontale Ausdehnung des Querbalkens erstreckt sich immer bis an den + Blattrand. +\end{values} +\end{Declaration} + +\ToDo[imp,nxt]{Text im Seitenfuß}[v2.04] +\begin{Declaration}[% + v2.03!farbiger Hintergrund der Fußzeile möglich% +]{\Option{cdfoot}[\PBoolean]}[false]% +\printdeclarationlist% +\index{Kolumnentitel}\index{Layout!Kolumnentitel} +\index{Satzspiegel!doppelseitig}% + +Die \TUDScript-Klassen sind~-- insbesondere aufgrund der Möglichkeit zur +Verwendung des Paketes \Package{scrlayer-scrpage}~-- bei der Gestaltung der +Kopf"~ und Fußzeilen sehr flexibel und individuell anpassbar. Die Ausprägung +und der Inhalt dieser ist nicht explizit durch das \CD vorgegeben und können +durch den Anwender beliebig gewählt und geändert werden. Wird die Klassenoption +\Option{automark} angegeben, werden für das automatische Setzen der Marken die +Titel der Gliederungsebenen verwendet. Genaueres hierzu sowie der Möglichkeit, +die Kolumnentitel manuell festzulegen, ist dem Handbuch von \KOMAScript{} zu +entnehmen. + +Eine Möglichkeit für deren Gestaltung zeigt das Handbuch für das \CD der \TnUD. +Dieses wird ohne Kopf"~ und mit einer einfachen Fußzeile gesetzt, welche den +aktuellen Kolumnentitel sowie die Paginierung enthält. Mit \Option{cdfoot} kann +diese Ausprägung aktiviert werden, was auch für dieses Anwenderhandbuch +geschehen ist. +% +\begin{values} +\itemfalse + Die Kopf"~ und Fußzeilen zeigen Standardverhalten, zur manuellen Änderung + dieser sollte unbedingt das \KOMAScript"=Paket \Package{scrlayer-scrpage} + verwendet werden. +\itemtrue* + Die Kopf"~ und Fußzeilen des Dokumentes werden wie im Handbuch des \CDs der + \TnUD gesetzt. Im doppelseitigen Satz (\Option{twoside}[true]) wird die + Seitenzahl außen platziert. +\end{values} +% +\ChangedAt{v2.03} +Sollte einer der \PageStyle{tudheadings}-Seitenstil aktiviert sein und es wird +auf der erzeugten Seite ein farbiges Layout~-- beispielsweise der zweifarbige +Kopf (\Option{cdhead}[bicolor]) oder ein farbiger Seitenhintergrund~-- genutzt, +so kann auch die Fußzeile einen farbigen Hintergrund erhalten. +% +\begin{values} +\item[nocolor/nocolour/monochrome] + Der Fuß wird immer ohne farbigen Hintergrund gesetzt. +\item[bicolor/bicolour/bichrome] + Die Fußzeile wird farblich abgesetzt, falls entweder der zweifarbige Kopf + (\Option{cdhead}[bicolor]) oder zumindest eine Seite mit einem farbigen + Hintergrund in der Hausfarbe (Titel oder Kapitelseite) verwendet wurde. +\end{values} +\end{Declaration} + +\begin{Declaration}{\Macro{headlogo}\LParameter\Parameter{Dateiname}} +\printdeclarationlist% +\index{Zweitlogo|?}\index{Layout!Zweitlogo}\index{\DDC-Logo}% +\index{Kopfzeile}\index{Kopfzeile!Logo}\index{Layout!Kopfzeile} +% +Neben dem Logo der \TnUD darf zusätzlich ein Zweitlogo im Kopf verwendet werden. +Dieses lässt sich mit diesem Befehl einbinden. Normalerweise wird es auf die +Höhe der Erstlogos skaliert. Über das optionale Argument können weitere +Formatierungsbefehle an den verwendeten Befehl \Macro{includegraphics} +durchgereicht werden, um beispielsweise die Größe des Zweitlogos anzupassen. +Welche Parameter angepasst werden können, ist der Dokumentation des +\Package{graphicx}-Paketes zu entnehmen. + +Sollte die Option \Option{ddc} aktiviert sein, wird das \DDC-Logo nicht im Kopf +sondern automatisch im Fuß gesetzt. Die Option \Option{ddchead} setzt dieses +auf jeden Fall im Kopf und überschreibt damit das mit \Macro{headlogo} +angegebene Zweitlogo. +\end{Declaration} + +\begin{Declaration}[v2.03]{% + \Macro{footlogo}\LParameter\Parameter{Dateinamenliste}% +} +\begin{Declaration}[v2.03]{\Macro{footlogosep}}% +\begin{Declaration}[v2.03]{\Length{footlogoheight}}% +\printdeclarationlist% +\index{Drittlogo|?}\index{Layout!Drittlogo}\index{\DDC-Logo}% +\index{Fußzeile}\index{Fußzeile!Logo}\index{Layout!Fußzeile}% + +Laut den Richtlinien des \CDs dürfen im Fußbereich weitere Logos erscheinen, +beispielsweise von kooperierenden Unternehmen oder Sponsoren. Die Dateinamen +der gewünschten Logos können als kommaseparierte Liste im obligatorischen +Argument des Befehls \Macro{footlogo} angegeben werden. Sollte tatsächlich +nicht nur ein Dateiname sondern eine Liste übergeben worden sein, so wird bei +der Ausgabe der Logos zwischen diesen jeweils der in \Macro{footlogosep} +gespeicherte Separator gesetzt. Die Voreinstellung dieses Befehls lautet +\Macro*{newcommand*}\Macro{footlogosep}\PParameter{\Macro*{hfill}} und kann +beliebig angepasst werden. Der Separator wird auch gesetzt, wenn in der +\Parameter{Dateinamenliste} lediglich ein Komma verwendet wurde. So kann man +beispielsweise ein Logo mit \Macro{footlogo}\PParameter{,\PName{Dateiname},} +zentriert im Fuß setzen. + +Das optionale Argument von \Macro{footlogo} wird an \Macro{includegraphics} +weitergereicht. Bitte beachten Sie dabei, dass dies für alle angegeben Dateien +aus der Liste gleichermaßen geschieht. Sollen für einzelne Logos individuelle +Einstellungen vorgenommen werden, so sind die entsprechenden Parameter im +obligatorischen Argument dem jeweiligen Dateinamen mit Doppelpunkt~\PValue{:} +anzuhängen (\Macro{footlogo}\PParameter{\PName{Dateiname}:\PName{Parameter}}), +wobei diese \emph{nach} den allgemeinen Einstellungen für alle Logos angewendet +werden.Die möglichen Parameter und Werte für die optionalen Argumente sind der +Dokumentation des \Package{graphicx}-Paketes zu entnehmen. + +Ohne die Angabe eines optionalen Argumentes werden alle Logos im Fuß auf die +Höhe \Length{footlogoheight} skaliert, welche vom Anwender ebenfalls angepasst +werden kann. Sollte die Höhe des Fußbereiches nicht ausreichen um alle Logos in +der gewünschten Größe darstellen zu können, so kann diese über die Option +\Option{extrabottommargin} angepasst werden. +\end{Declaration} +\end{Declaration} +\end{Declaration} + \begin{Declaration}[% v2.02!\protect\DDC-Logo automatisch in Kopf oder Fuß% ]{\Option{ddc}[\PSet]}[false] @@ -885,150 +1085,84 @@ \subsection{Seiten im Stil des \CDs} grauen verwendet. Für den Fuß wird der grüne Claim ebenfalls durch einen schwarzen ersetzt. Dies ist insbesondere für kleine Darstellungen des Logos im Fuß sinnvoll. -\item[gray/grey/cdgray/cdgrey] +\item[gray/grey] Dies Ausgabe des \DDC-Logos erfolgt in Graustufen. \item[black] Verwendung des Logos in Graustufen mit schwarzem Schriftzug. -\item[blue/cddarkblue] +\item[blue] Der Schriftzug und das Logo werden in der primären Hausfarbe \Color{HKS41} und den entsprechenden Abstufungen gesetzt \item[white] Das \DDC-Logo sowie der dazugehörige Schriftzug sind vollständig weiß. \end{values} % -\end{Declaration} -\end{Declaration} -\end{Declaration} - -\begin{Declaration}{% - \Macro{headlogo}\LParameter\Parameter{Dateiname}% -} -\printdeclarationlist% -\index{Zweitlogo|?}\index{Layout!Zweitlogo}\index{\DDC-Logo}% -% -Neben dem Logo der \TnUD darf zusätzlich ein Zweitlogo im Kopf verwendet werden. -Dieses lässt sich mit diesem Befehl einbinden. Normalerweise wird es auf die -Höhe der Erstlogos skaliert. Über das optionale Argument können weitere -Formatierungsbefehle an den verwendeten Befehl \Macro{includegraphics} -durchgereicht werden, um beispielsweise die Größe des Zweitlogos anzupassen. -Welche Parameter angepasst werden können, ist der Dokumentation des -\Package{graphicx}-Paketes zu entnehmen. +Die Größe des \DDC-Logos ist vorgegeben. Es wird sowohl im Kopf als auch im Fuß +in der gleichen Höhe gesetzt, wie das Logo der \TnUD. Wird es im Fuß gesetzt, +lässt sich die Größe allerdings über die Länge \Length{footlogoheight} ändern. +Sollte nach einer Vergrößerung der Darstellung die Höhe des Fußbereiches nicht +ausreichen, so kann diese über die Option \Option{extrabottommargin} angepasst +werden. -Sollte die Option \Option{ddc} aktiviert sein, wird das \DDC-Logo nicht im Kopf -sondern automatisch im Fuß gesetzt. Die Option \Option{ddchead} setzt dieses -auf jeden Fall im Kopf und überschreibt damit das mit \Macro{headlogo} -angegebene Zweitlogo. \end{Declaration} - -\begin{Declaration}{\Option{widehead}[\PBoolean]}% - [false][\Option{cd}[color]:true]% -\printdeclarationlist% -\index{Querbalken}\index{Layout!Querbalken}% -% -Für die \TUDScript-Klassen ist ein Seitenlayout entstanden, welche den Kopf des -\CDs umsetzt. Dieser besteht aus dem Logo der \TnUD sowie einem darunter -befindlichen Querbalken, in welchem Fakultät, Einrichtung, Institut und -Lehrstuhl% -\footnote{% - \Macro{faculty}, \Macro{department}, \Macro{institute} sowie \Macro{chair}% -} -aufgeführt werden können. Bei der Ausprägung dieses Balkens gibt es zwei -Varianten. Die Außenlinien laufen entweder bis zum Text"~ oder bis zum -Blattrand. - -Für den Fall, dass ein randloser Ausdruck technisch nicht möglich ist, -kann die letztere der beiden Variante Probleme bereiten. Deshalb kann mit der -Option \Option{widehead} die Breite des Querbalkens angepasst werden. -Normalerweise ist der Balken auf die Textbreite begrenzt, lediglich im farbigen -Layout wird dieser standardmäßig bis zum Blattrand verlängert. -% -\begin{values} -\itemfalse - Der Querbalken im Kopf erstreckt sich nur über den Textbereich. -\itemtrue* - Die horizontale Ausdehnung des Querbalkens erstreckt sich bis an den - Blattrand.\footnote{Voreinstellung bei \Option{cd}[color]} -\end{values} \end{Declaration} - -\begin{Declaration}[v2.02]{\Option{barfont}[\PSet]}% - [true][\Option{cdfont}[false]:false] -\printdeclarationlist% -\index{Kopfzeile!Schrift}% -\index{Layout!Kopfzeile}% -% -Mit dieser Option kann die Schrift im Querbalken der Kopfzeile für Seiten, -welche in einem der \PageStyle{tudheadings}"=Seitenstilen gesetzt wird, -beeinflusst werden. -% -\begin{values} -\itemfalse - Sollte mit \Option{cdfont}[false] die Verwendung der Hausschrift im Stil des - \CDs der \TnUD deaktiviert worden sein, wird die Kopfzeile im Querbalken in - den Serifenlosen der genutzten Schrift gesetzt. Sind die Hausschriften - aktiviert, hat diese Einstellung keinen Einfluss. -\itemtrue*[cdfont/light/lightfont/noheavyfont] - Im Querbalken wird für \Macro{faculty} \textubn{Univers~65~Bold} verwendet, - für die Felder \Macro{department}, \Macro{institute}, \Macro{chair} und - \Macro{extraheadline} kommt \textuln{Univers~45~Light} zum Einsatz. -\item[heavy/heavyfont] - Der Inhalt von \Macro{faculty} wird weiterhin in \textubn{Univers~65~Bold} - gesetzt, für die restlichen Felder wird \texturn{Univers~55~Regular} genutzt. -\end{values} \end{Declaration} \begin{Declaration}[% - v2.02!Parameter \Key{\Environment{tudpage}}{head} und - \Key{\Environment{tudpage}}{foot} entfernt + v2.02!\Key{\Environment{tudpage}}{head} \emph{entfällt}, + v2.02!\Key{\Environment{tudpage}}{foot} \emph{entfällt}, + v2.03!\Key{\Environment{tudpage}}{color} \emph{entfällt} ]{\Environment{tudpage}[\OLParameter{Sprache}]} \begin{Declaration}{\Key{\Environment{tudpage}}{language}[\PName{Sprache}]} \begin{Declaration}{\Key{\Environment{tudpage}}{columns}[\PName{Anzahl}]} -\begin{Declaration}{\Key{\Environment{tudpage}}{color}[\PName{Farbe}]} \begin{Declaration}[v2.02]{\Key{\Environment{tudpage}}{pagestyle}[\PSet]} -\begin{Declaration}{\Key{\Environment{tudpage}}{headlogo}[\PName{Dateiname}]} -\begin{Declaration}[v2.02]{\Key{\Environment{tudpage}}{ddc}[\PSet]} -\begin{Declaration}[v2.02]{\Key{\Environment{tudpage}}{ddchead}[\PSet]} -\begin{Declaration}[v2.02]{\Key{\Environment{tudpage}}{ddcfoot}[\PSet]} -\begin{Declaration}{\Key{\Environment{tudpage}}{cdfont}[\PSet]} -\begin{Declaration}[v2.02]{\Key{\Environment{tudpage}}{barfont}[\PSet]} -\begin{Declaration}{\Key{\Environment{tudpage}}{widehead}[\PBoolean]} +\begin{Declaration}{\Key{\Environment{tudpage}}{cdfont}[\PSet]}{% + \see*{\Option{cdfont}'ppage'}% +} +\begin{Declaration}[v2.03]{\Key{\Environment{tudpage}}{cdhead}[\PSet]}{% + \see*{\Option{cdhead}'ppage'}% +} +\begin{Declaration}[v2.03]{\Key{\Environment{tudpage}}{cdfoot}[\PSet]}{% + \see*{\Option{cdfoot}'ppage'}% +} +\begin{Declaration}{\Key{\Environment{tudpage}}{headlogo}[\PName{Dateiname}]}{% + \see*{\Macro{headlogo}'ppage'}% +} +\begin{Declaration}[v2.03]{% + \Key{\Environment{tudpage}}{footlogo}[\PName{Dateinamenliste}] +}{\see*{\Macro{footlogo}'ppage'}} +\begin{Declaration}[v2.02]{\Key{\Environment{tudpage}}{ddc}[\PSet]}{% + \see*{\Option{ddc}'ppage'}% +} +\begin{Declaration}[v2.02]{\Key{\Environment{tudpage}}{ddchead}[\PSet]}{% + \see*{\Option{ddchead}'ppage'}% +} +\begin{Declaration}[v2.02]{\Key{\Environment{tudpage}}{ddcfoot}[\PSet]}{% + \see*{\Option{ddcfoot}'ppage'}% +} \printdeclarationlist% \index{Layout}\index{Layout!Seitenstil}% \index{Kopfzeile}\index{Layout!Kopfzeile}% \index{Fußzeile}\index{Layout!Fußzeile}% \index{Schrift}\index{Kopfzeile!Schrift} % -Diese Umgebung dient zum Setzen einer oder mehrerer Seiten innerhalb des -Dokumentes mit dem Kopf im \CD. Sie hat ihren Ursprung in einer früheren +Die \Environment{tudpage}"=Umgebung hat ihren Ursprung in einer früheren Version, als die \PageStyle{tudheadings}"=Seitenstile noch nicht verfügbar -waren. Diese können mittlerweile anstelle der \Environment{tudpage}"=Umgebung -verwendet werden. - -Dabei lassen sich verschiedene Parameter als optionales Argument angegeben. -Wird das Paket \Package{babel} genutzt, kann die in der Umgebung verwendete -Sprache mit \Key{\Environment{tudpage}}{language}[\PName{Sprache}] geändert -werden, was zur lokalen Anpassung der sprachspezifischen Trennungsmuster und +waren, welche mittlerweile anstelle dieser Umgebung verwendet werden können. +Für die \Environment{tudpage}"=Umgebung lassen sich verschiedene Parameter als +optionales Argument angegeben. Wird das Paket \Package{babel} genutzt, kann die +verwendete Sprache mit \Key{\Environment{tudpage}}{language}[\PName{Sprache}] +geändert werden, was zur Anpassung der sprachspezifischen Trennungsmuster und Bezeichner führt. Wurde das Paket \Package{multicol} geladen, wird mit dem Parameter \Key{\Environment{tudpage}}{columns}[\PName{Anzahl}] der Inhalt der -Umgebung mehrspaltig gesetzt. +Umgebung mehrspaltig gesetzt. Mit \Key{\Environment{tudpage}}{pagestyle} kann +der Seitenstil angepasst werden, wobei \PValue{headings}, \PValue{plain} und +\PValue{empty} gültige Werte sind. -Mit dem Parameter \Key{\Environment{tudpage}}{color} kann die Farbe des Kopfes -auf eine beliebige geändert werden. Diese ist für den Fall eines farbigen -Layouts (\Option{cd}[pale|color]) auf die primäre Hausfarbe \Color{HKS41} -gesetzt, sonst ist der Kopf standardmäßig schwarz. Außerdem kann mit -\Key{\Environment{tudpage}}{pagestyle} der Seitenstil angepasst werden. -Gültige Werte sind \PValue{headings}, \PValue{plain}, \PValue{empty} oder einer -der \PageStyle{tudheadings}"=Seitenstile. Soll lokal ein anderes Zweitlogo als -das mit \Macro{headlogo} gegebene erscheinen, so kann der Parameter -\Key{\Environment{tudpage}}{headlogo}[\PName{Dateiname}] verwendet werden. - -Die anderen Parameter entsprechen in ihrem Verhalten prinzipiell den -gleichnamigen Klassenoptionen, wirken sich jedoch nur lokal innerhalb der -\Environment{tudpage}"=Umgebung aus. Dies sind namentlich sowohl die Optionen -\Option{cdfont}'full' sowie \Option{ddc}, \Option{ddchead} und -\Option{ddcfoot}'full' als auch \Option{barfont} und \Option{widehead}'page'. -Das Verhalten sowie die jeweils gültigen Wertzuweisungen können in den -entsprechenden Abschnitten der Dokumentation nachgelesen werden. +Die weiteren Parameter entsprechen in ihrem Verhalten prinzipiell den +gleichnamigen Klassenoptionen respektive Befehlen, wirken sich jedoch nur lokal +innerhalb der \Environment{tudpage}"=Umgebung aus. Das Verhalten sowie die +jeweils gültigen Wertzuweisungen können in den entsprechenden Abschnitten des +Handbuchs nachgelesen werden. \end{Declaration} \end{Declaration} \end{Declaration} @@ -1043,7 +1177,7 @@ \subsection{Seiten im Stil des \CDs} \end{Declaration} \ToDo[imp,nxt]{% - Titelseite und Cover auf Drittlogos und dergleichen mit scrlayer erweitern. + Titelseite und Cover auf freie Gestaltung mit scrlayer erweitern. }[v2.x] @@ -1053,6 +1187,9 @@ \subsection{Der Titel und die Umschlagseite} \index{Umschlagseite|!}% \index{Titel!Umschlagseite}\index{Layout!Umschlagseite}% % +\ChangedAt*{% + v2.03!Bugfix für Umschlagseite und Titel beim Satzspiegel% +} Für den Titel werden alle Felder unterstützt, die bereits durch \KOMAScript{} bereitgestellt werden. Darüber hinaus werden für die \TUDScript-Klassen weitere Felder definiert, die Auswirkungen auf die Gestalt des Titels haben. Diese @@ -1093,7 +1230,30 @@ \subsection{Der Titel und die Umschlagseite} \begin{Declaration}[v2.02]{% \Key{\Macro{maketitle}}{pagenumber}[\PName{Seitenzahl}]% } -\begin{Declaration}[v2.02]{\Key{\Macro{maketitle}}{cdfont}[\PSet]} +\begin{Declaration}[v2.02]{\Key{\Macro{maketitle}}{cdfont}[\PSet]}{% + \see*{\Option{cdfont}'ppage'}% +} +\begin{Declaration}[v2.03]{\Key{\Macro{maketitle}}{cdhead}[\PSet]}{% + \see*{\Option{cdhead}'ppage'}% +} +\begin{Declaration}[v2.03]{\Key{\Macro{maketitle}}{cdfoot}[\PSet]}{% + \see*{\Option{cdfoot}'ppage'}% +} +\begin{Declaration}[v2.03]{% + \Key{\Macro{maketitle}}{headlogo}[\PName{Dateiname}]% +}{\see*{\Macro{headlogo}'ppage'}} +\begin{Declaration}[v2.03]{% + \Key{\Macro{maketitle}}{footlogo}[\PName{Dateinamenliste}] +}{\see*{\Macro{footlogo}'ppage'}} +\begin{Declaration}[v2.03]{\Key{\Macro{maketitle}}{ddc}[\PSet]}{% + \see*{\Option{ddc}'ppage'}% +} +\begin{Declaration}[v2.03]{\Key{\Macro{maketitle}}{ddchead}[\PSet]}{% + \see*{\Option{ddchead}'ppage'}% +} +\begin{Declaration}[v2.03]{\Key{\Macro{maketitle}}{ddcfoot}[\PSet]}{% + \see*{\Option{ddcfoot}'ppage'}% +} \printdeclarationlist% \index{Layout!Titel}% \index{Satzspiegel!doppelseitig}% @@ -1102,35 +1262,40 @@ \subsection{Der Titel und die Umschlagseite} \KOMAScript"=Titel{}, ansonsten wird die Titelseite im \CD der \TnUD erzeugt. Letztere Variante ist im Vergleich zum Standardtitel um eine Vielzahl von Feldern erweitert worden und erlaubt insbesondere die Angabe von Daten für das -Deckblatt einer akademischen Abschlussarbeit. Die einzelnen Felder werden in -diesem \autorefname erläutert. Wird das Dokument doppelseitig und mit rechts -öffnenden Kapiteln gesetzt,% +Deckblatt einer akademischen Abschlussarbeit. Die einzelnen Felder werden +später in diesem \autorefname erläutert. Wird das Dokument doppelseitig und mit +rechts öffnenden Kapiteln gesetzt,% \footnote{% \Option{twoside} und \Option{open}[right], Standard für \Class{tudscrbook} } -so wird zusätzlich die Option \Option{clearcolor} beachtet. +so wird zusätzlich die Option \Option{clearcolor} beachtet. Dies gilt es +insbesondere bei der Verwendung der Befehle \Macro{uppertitleback} respektive +\Macro{lowertitleback} für die Titelrückseite zu beachten. Das optionale Argument erlaubt~-- ebenso wie bei den \KOMAScript"=Klassen~-- die Änderung der Seitenzahl der Titelseite. Diese wird jedoch nicht ausgegeben, sondern beeinflusst lediglich die Zählung. Sie sollten hier unbedingt eine ungerade Zahl wählen, da sonst die gesamte Zählung durcheinander gerät. -Zusätzlich kann der Parameter \Key{\Macro{maketitle}}{cdfont} im optionalen -Argument verwendet werden, um die Nutzung der Schriften des \CDs zu regulieren. -Er entspricht in seinem Verhalten der gleichnamigen Klassenoption. Die gültigen -Wertzuweisungen können der Beschreibung der Option \Option{cdfont}'full' -entnommen werden. Die Einstellungen dieses Parameters wirkt sich nur lokal und -einzig auf die Umschlagseite aus. +Wird eine Titelseite (\Option{titlepage}[true]) im \CD der \TnUD gesetzt +(\Option{cdtitle}[true]), können auch die weiterhin aufgeführten Parameter im +optionalen Argument verwendet werden. Diese entsprechen in ihrem Verhalten den +gleichnamigen Optionen respektive Befehlen, wirken sich jedoch nur lokal und +einzig auf die Titelseite aus. So kann beispielsweise die Nutzung eines +\DDC-Logos auf den Titel beschränkt bleiben. +\end{Declaration} +\end{Declaration} +\end{Declaration} +\end{Declaration} +\end{Declaration} +\end{Declaration} +\end{Declaration} \end{Declaration} \end{Declaration} \end{Declaration} \begin{Declaration}{% - \Macro{maketitleonecolumn}\OParameter{Seitenzahl}\Parameter{Einspaltentext}% -} -\begin{Declaration}[v2.02]{% - \Key{\Macro{maketitleonecolumn}}{pagenumber}[\PName{Seitenzahl}]% + \Macro{maketitleonecolumn}\OLParameter{Seitenzahl}\Parameter{Einspaltentext}% } -\begin{Declaration}[v2.02]{\Key{\Macro{maketitleonecolumn}}{cdfont}[\PSet]} \printdeclarationlist% \index{Layout!Titel}% \index{Satzspiegel!doppelseitig}% @@ -1138,22 +1303,25 @@ \subsection{Der Titel und die Umschlagseite} % Im zweispaltigen Satz (\Option{twocolumn}) wird mit \Macro{maketitle} die Titelseite selbst immer einspaltig gesetzt. Direkt nach dem Titel folgt -normalerweise der zweispaltige Fließtext. Mit dem Befehl -\Macro{maketitleonecolumn} -ermöglichen die \TUDScript-Klassen, nach dem Titel zusätzlich noch weitere -Textpassagen~-- beispielsweise eine Zusammenfassung~-- einspaltig zu setzen. +normalerweise der zweispaltige Fließtext. Mit dem \TUDScript-Befehl +\Macro{maketitleonecolumn} kann nach dem Titel zusätzlich noch weiterer +Inhalt~-- beispielsweise eine Zusammenfassung~-- einspaltig gesetzt werden. Wird der Befehl bei einer Titelseite (\Option{titlepage}[true]) verwendet, wird -der Inhalt des Argumentes direkt nach dieser auf einer neuen Seite ebenfalls -einspaltig ausgegeben. Kommt jedoch ein Titelkopf (\Option{titlepage}[false]) -zum Einsatz, so folgt nach diesem die einspaltige Textpassage aus dem Argument. -Danach wird auf das zweispaltige Layout umgeschaltet, - -Der optionale Parameter von \Macro{maketitleonecolumn} kann äquivalent zum -Befehl \Macro{maketitle} für die Anpassung der Seitenzahl und der verwendeten -Schrift verwendet werden. -\end{Declaration} -\end{Declaration} +der Inhalt des Argumentes (\PName{Einspaltentext}) direkt nach dieser auf einer +oder gegebenenfalls mehreren neuen Seiten ebenfalls einspaltig ausgegeben. +Kommt jedoch ein Titelkopf (\Option{titlepage}[false]) zum Einsatz, so folgt +diesem die einspaltige Textpassage aus dem obligatorischen Argument direkt. +Dabei erfolgt gegebenenfalls ein automatischer Seitenumbruch, falls der Inhalt +nicht auf eine einzelne Seite passt. Nach dem \PName{Einspaltentext} des +obligatorischen Argumentes wird direkt danach und ohne zusätzlichen Umbruch auf +das zweispaltige Layout umgeschaltet. + +Der optionale Parameter von \Macro{maketitleonecolumn} kann äquivalent zu +\Macro{maketitle} für die Änderung der Seitenzahl, der verwendeten Schrift +sowie zur Anpassung von Kopf und Fuß verwendet werden. Dabei ist zu beachten, +dass ein Großteil der Parameter nur Auswirkungen haben, falls eine Titelseite +(\Option{titlepage}[true]) verwendet wird. \end{Declaration} \begin{Declaration}[% @@ -1162,18 +1330,41 @@ \subsection{Der Titel und die Umschlagseite} \Font*{subject}{,} \Font*{title}{,} \Font*{subtitle}{,} \Font*{author}{,} \Font*{publishers}{,} \Font*{titlepage} und \Font*{thesis}% ]{\Macro{makecover}\OLParameter{Seitenzahl}} -\begin{Declaration}{\Key{\Macro{makecover}}{cdlayout}[\PBoolean]} \begin{Declaration}[v2.02]{% \Key{\Macro{makecover}}{pagenumber}[\PName{Seitenzahl}]% } -\begin{Declaration}{\Key{\Macro{makecover}}{cdfont}[\PSet]} +\begin{Declaration}{\Key{\Macro{makecover}}{cdgeometry}[\PBoolean]} +\begin{Declaration}[v2.02]{\Key{\Macro{makecover}}{cdfont}[\PSet]}{% + \see*{\Option{cdfont}'ppage'}% +} +\begin{Declaration}[v2.03]{\Key{\Macro{makecover}}{cdhead}[\PSet]}{% + \see*{\Option{cdhead}'ppage'}% +} +\begin{Declaration}[v2.03]{\Key{\Macro{makecover}}{cdfoot}[\PSet]}{% + \see*{\Option{cdfoot}'ppage'}% +} +\begin{Declaration}[v2.03]{% + \Key{\Macro{makecover}}{headlogo}[\PName{Dateiname}]% +}{\see*{\Macro{headlogo}'ppage'}} +\begin{Declaration}[v2.03]{% + \Key{\Macro{makecover}}{footlogo}[\PName{Dateinamenliste}] +}{\see*{\Macro{footlogo}'ppage'}} +\begin{Declaration}[v2.03]{\Key{\Macro{makecover}}{ddc}[\PSet]}{% + \see*{\Option{ddc}'ppage'}% +} +\begin{Declaration}[v2.03]{\Key{\Macro{makecover}}{ddchead}[\PSet]}{% + \see*{\Option{ddchead}'ppage'}% +} +\begin{Declaration}[v2.03]{\Key{\Macro{makecover}}{ddcfoot}[\PSet]}{% + \see*{\Option{ddcfoot}'ppage'}% +} \printdeclarationlist% % Eine Umschlagseite wird zumeist für gebundene Abschlussarbeiten verlangt, um diese beispielsweise für einen Prägedruck auf dem Buchdeckel zu verwenden. -Hierfür ist es sinnvoll, mit \Option{cdcover}[true] die farbige Ausprägung der -Umschlagseite zu deaktivieren, falls diese für das restliche Dokument aktiv ist -(\Option{cd}[color]). +Deshalb ist die farbige Ausprägung der Umschlagseite auch deaktiviert, wenn +diese für das restliche Dokument aktiv ist (\Option{cd}[color]). Dies kann +jedoch jederzeit mit \Option{cdcover}[\PSet] überschrieben werden. Wird \Option{cdcover}[true] gewählt, so wird die Umschlagseite im \CD der \TnUD gesetzt. Auf dieser werden der Titel des Dokumentes, die Typisierung @@ -1187,77 +1378,26 @@ \subsection{Der Titel und die Umschlagseite} Die Titelseite selbst gehört immer zum Buchblock und wird daher im gleichen Satzspiegel gesetzt. Dem entgegen steht die Umschlagseite, welche zumeist in einem anderen Layout erscheint. Normalerweise wird das Cover~-- unabhängig von -der Option \Option{geometry}~-- im asymmetrischen Satzspiegel des \CDs gesetzt. -Mit \Key{\Macro{makecover}}{cdlayout}[false] im optionalen Argument kann das -Verhalten geändert werden. In diesem Fall erscheint auch die Umschlagseite im -Buchblock des restlichen Dokumentes. Allerdings können für diese Einstellung -die Seitenränder durch den Nutzer mit den Befehlen \Macro{coverpagetopmargin}, +der Option \Option{cdgeometry}~-- im asymmetrischen Satzspiegel des \CDs +gesetzt. Mit \Key{\Macro{makecover}}{cdgeometry}[false] im optionalen Argument +kann das Verhalten geändert werden. In diesem Fall erscheint auch die +Umschlagseite im Buchblock des restlichen Dokumentes. Allerdings können für +diese Einstellung die Seitenränder mit den Befehlen \Macro{coverpagetopmargin}, \Macro{coverpageleftmargin}, \Macro{coverpagerightmargin} sowie -\Macro{coverpagebottommargin} frei angepasst werden. Mehr dazu ist im -\KOMAScript"=Handbuch \scrguide zu finden. +\Macro{coverpagebottommargin} durch den Nutzer frei angepasst werden. Mehr dazu +ist im \KOMAScript"=Handbuch \scrguide zu finden. + +Das optionale Argument erlaubt die Änderung der Seitenzahl der Umschlagseite. +Diese wird jedoch nicht ausgegeben, sondern beeinflusst lediglich die Zählung. +Sie sollten hier unbedingt eine ungerade Zahl wählen, da sonst die gesamte +Zählung durcheinander gerät. Die weiterhin aufgeführten Parameter entsprechen +in ihrem Verhalten den gleichnamigen Optionen respektive Befehlen, wirken sich +jedoch nur lokal und einzig auf die Umschlagseite aus. -Die beiden anderen optionalen Parameter \Key{\Macro{makecover}}{pagenumber} -sowie \Key{\Macro{makecover}}{cdfont} dienen~-- äquivalent zum Befehl -\Macro{maketitle}~-- zur Anpassung der Seitenzahl und der verwendeten Schrift. \end{Declaration} \end{Declaration} \end{Declaration} \end{Declaration} - -\begin{Declaration}{\Macro{extratitle}\Parameter{Schmutztitel}} -\begin{Declaration}{\Macro{titlehead}\Parameter{Kopf}} -\begin{Declaration}{\Macro{title}\Parameter{Titel}} -\begin{Declaration}[% - v2.01a!Bugfix für Schriftstärke bei Verwendung des Untertitels% -]{\Macro{subtitle}\Parameter{Untertitel}} -\begin{Declaration}{\Macro{publishers}\Parameter{Verlag}} -\begin{Declaration}{\Macro{thanks}\Parameter{Fußnote}} -\begin{Declaration}{\Macro{uppertitleback}\Parameter{Titelrückseitenkopf}} -\begin{Declaration}{\Macro{lowertitleback}\Parameter{Titelrückseitenfuß}} -\begin{Declaration}{\Macro{dedication}\Parameter{Widmung}} -\printdeclarationlist% -\index{Titel!Felder}% -% -Diese Befehle entsprechen den in ihrem Verhalten den originalen Pendants der -\KOMAScript"=Klassen{} und sollen hier der Vollständigkeit halber erwähnt -werden. - -Die Ausgabe des mit \Macro{extratitle} definierten Schmutztitels~-- welcher -beliebig gestaltet und formatiert werden kann~-- erfolgt als Bestandteil der -Titelei mit \Macro{maketitle} vor der eigentlichen Titelseite. Mit dem Befehl -\Macro{titlehead} kann ein zusätzlicher, beliebig formatierbarer Text oberhalb -der Typisierung und des Titels ausgegeben werden. Da die vertikale Position des -Dokumenttitels durch das \CD fest vorgegeben ist, kann es~-- im Gegensatz zu -den \KOMAScript"=Klassen~-- passieren, dass der Kopf des Haupttitels selbst in -die Kopfzeile ragt. Dies wird durch die \TUDScript-Klassen nicht geprüft und -muss gegebenenfalls vom Anwender kontrolliert werden. - -Die Befehle \Macro{title} und \Macro{subtitle} bedürfen keiner weiteren -Erklärung. Anzumerken ist, dass sowohl Titel als auch Untertitel normalerweise -in Majuskeln und \DIN gesetzt werden. Der mit dem Befehl \Macro{publishers} -definierte Inhalt muss nicht zwingende einen Verlag bezeichnen sondern kann -auch andere Informationen beinhalten, welche am Ende der Titelseite ausgegeben -werden sollen. - -Fußnoten werden auf dem Titel nicht mit \Macro{footnote}, sondern mit der -Anweisung \Macro{thanks} erzeugt. Diese dienen in der Regel für Anmerkungen bei -Titel oder den Autoren. Als Fußnotenzeichen werden dabei Symbole statt Zahlen -verwendet. Der Befehl \Macro{thanks} kann nur innerhalb des Arguments einer -der Anweisungen für die Titelseite wie beispielsweise \Macro{author} oder -\Macro{title} verwendet werden. - -\index{Satzspiegel!doppelseitig}% -Im doppelseitigen Druck lässt sich die Rückseite der Haupttitelseite für -weitere Angaben nutzen. Sowohl den Titelrückseitenkopf als auch den -Titelrückseitenfuß kann der Anwender mit \Macro{uppertitleback} und -\Macro{lowertitleback} frei gestalten. - -Mit \Macro{dedication} kann eine eigene Widmungsseite zentriert und in etwas -größerer Schrift gesetzt werden. Die Rückseite ist wie die des Schmutztitels -grundsätzlich leer. Die Widmung wird zusammen mit der restlichen Titelei durch -\Macro{maketitle} ausgegeben und muss daher vor dieser Anweisung definiert sein. -\end{Declaration} -\end{Declaration} \end{Declaration} \end{Declaration} \end{Declaration} @@ -1272,14 +1412,13 @@ \subsection{Der Titel und die Umschlagseite} % Für den Titel und die Umschlagseite werden durch die \TUDScript-Klassen eine Reihe von zusätzlichen Feldern bereitgestellt. Einigen dieser Felder wird -eine Beschreibung (siehe dazu \autoref{sec:localization}) vorangestellt. -Dazwischen wird bei der Ausgabe ein Trennzeichen eingefügt. Ein Doppelpunkt -gefolgt von einem Leerzeichen (:\Macro*{nobreakspace}) ist hierfür die -Voreinstellung. Mit dem Befehl \Macro{titledelimiter} lässt sich dieses -Trennzeichen beliebig an die individuellen Wünsche des Anwenders anpassen. +eine Beschreibung (\see*{\autoref{sec:localization}}) vorangestellt. Dazwischen +wird bei der Ausgabe ein Trennzeichen eingefügt. Ein Doppelpunkt gefolgt von +einem Leerzeichen (:\Macro*{nobreakspace}) ist hierfür die Voreinstellung. Mit +dem Befehl \Macro{titledelimiter} lässt sich dieses Trennzeichen beliebig an +die individuellen Wünsche des Anwenders anpassen. \end{Declaration} - \begin{Declaration}{\Macro{author}\Parameter{Autor(en)}} \begin{Declaration}{\Macro{authormore}\Parameter{Autorenzusatz}} \begin{Declaration}{\Macro{dateofbirth}\Parameter{Geburtsdatum}} @@ -1457,8 +1596,7 @@ \subsection{Der Titel und die Umschlagseite} \end{values} \end{Declaration} -\Rename[macros]{v2.02}{\Macro{degree}}{\Macro{graduation}} -\begin{Declaration}{\Macro{graduation}\OParameter{Kurzform}\Parameter{Grad}} +\begin{Declaration}[v2.02]{\Macro{graduation}\OParameter{Kurzform}\Parameter{Grad}} \printdeclarationlist% \index{Titel!Felder}% % @@ -1516,6 +1654,68 @@ \subsection{Der Titel und die Umschlagseite} \Macro{date} und \Macro{defensedate} verwendet. \end{Declaration} \end{Declaration} + +\begin{Declaration}{\Macro{extratitle}\Parameter{Schmutztitel}} +\begin{Declaration}{\Macro{titlehead}\Parameter{Kopf}} +\begin{Declaration}{\Macro{title}\Parameter{Titel}} +\begin{Declaration}[% + v2.01a!Bugfix für Schriftstärke bei Verwendung des Untertitels% +]{\Macro{subtitle}\Parameter{Untertitel}} +\begin{Declaration}{\Macro{publishers}\Parameter{Verlag}} +\begin{Declaration}{\Macro{thanks}\Parameter{Fußnote}} +\begin{Declaration}{\Macro{uppertitleback}\Parameter{Titelrückseitenkopf}} +\begin{Declaration}{\Macro{lowertitleback}\Parameter{Titelrückseitenfuß}} +\begin{Declaration}{\Macro{dedication}\Parameter{Widmung}} +\printdeclarationlist% +\index{Titel!Felder}% +% +Diese Befehle entsprechen den in ihrem Verhalten den originalen Pendants der +\KOMAScript"=Klassen{} und sollen hier der Vollständigkeit halber erwähnt +werden. + +Die Ausgabe des mit \Macro{extratitle} definierten Schmutztitels~-- welcher +beliebig gestaltet und formatiert werden kann~-- erfolgt als Bestandteil der +Titelei mit \Macro{maketitle} vor der eigentlichen Titelseite. Mit dem Befehl +\Macro{titlehead} kann ein zusätzlicher, beliebig formatierbarer Text oberhalb +der Typisierung und des Titels ausgegeben werden. Da die vertikale Position des +Dokumenttitels durch das \CD fest vorgegeben ist, kann es~-- im Gegensatz zu +den \KOMAScript"=Klassen~-- passieren, dass der Kopf des Haupttitels selbst in +die Kopfzeile ragt. Dies wird durch die \TUDScript-Klassen nicht geprüft und +muss gegebenenfalls vom Anwender kontrolliert werden. + +Die Befehle \Macro{title} und \Macro{subtitle} bedürfen keiner weiteren +Erklärung. Anzumerken ist, dass sowohl Titel als auch Untertitel normalerweise +in Majuskeln und \DIN gesetzt werden. Der mit dem Befehl \Macro{publishers} +definierte Inhalt muss nicht zwingende einen Verlag bezeichnen sondern kann +auch andere Informationen beinhalten, welche am Ende der Titelseite ausgegeben +werden sollen. + +Fußnoten werden auf dem Titel nicht mit \Macro{footnote}, sondern mit der +Anweisung \Macro{thanks} erzeugt. Diese dienen in der Regel für Anmerkungen bei +Titel oder den Autoren. Als Fußnotenzeichen werden dabei Symbole statt Zahlen +verwendet. Der Befehl \Macro{thanks} kann nur innerhalb des Arguments einer +der Anweisungen für die Titelseite wie beispielsweise \Macro{author} oder +\Macro{title} verwendet werden. + +\index{Satzspiegel!doppelseitig}% +Im doppelseitigen Druck lässt sich die Rückseite der Haupttitelseite für +weitere Angaben nutzen. Sowohl den Titelrückseitenkopf als auch den +Titelrückseitenfuß kann der Anwender mit \Macro{uppertitleback} und +\Macro{lowertitleback} frei gestalten. + +Mit \Macro{dedication} kann eine eigene Widmungsseite zentriert und in etwas +größerer Schrift gesetzt werden. Die Rückseite ist wie die des Schmutztitels +grundsätzlich leer. Die Widmung wird zusammen mit der restlichen Titelei durch +\Macro{maketitle} ausgegeben und muss daher vor dieser Anweisung definiert sein. +\end{Declaration} +\end{Declaration} +\end{Declaration} +\end{Declaration} +\end{Declaration} +\end{Declaration} +\end{Declaration} +\end{Declaration} +\end{Declaration} \index{Titel|!)} @@ -1524,7 +1724,7 @@ \subsection{Die Teileseite} % \ChangedAt{% v2.02!\PageStyle{plain.tudheadings} wird genutzt!\Macro{partpagestyle}% -} +}[Implementierung] Wird für die Teileseiten das Layout des \CDs verwendet, so wird der Seitenstil dieser (\Macro{partpagestyle}) auf \PageStyle{plain.tudheadings} gesetzt. Möchten Sie stattdessen einen anderen Seitenstil nutzen, so kann dieser mit @@ -1574,22 +1774,22 @@ \subsection{Die Kapitelseite} \begin{values} \itemfalse Es gibt keine Sonderstellung von Kapiteln, der nachfolgende Text wird direkt - unter der Überschrift auf der gleichen Seite ausgegeben. + unter der Überschrift respektive nach der mit \Macro{setchapterpreamble} + erzeugten Kapitelpräambel auf der gleichen Seite ausgegeben. \itemtrue* - Die Kapitelüberschrift wird auf einer separaten Seite gesetzt, der folgende - Text wird erst auf der nächsten beziehungsweise übernächsten Seite - ausgegeben. Siehe dazu auch die Option \Option{cleardoublespecialpage}. + Die Kapitelüberschrift und gegebenenfalls die Kapitelpräambel werden auf + einer separaten Seite gesetzt. Der folgende Text erscheint auf der nächsten + respektive übernächsten Seite, \seealso*{\Option{cleardoublespecialpage}}. \end{values} % \ChangedAt{% v2.02!nicht mehr abhängig von \Macro{partpagestyle}!\Macro{chapterpagestyle} -} +}[Implementierung] Mit \Macro*{renewcommand*}\PParameter{\Macro{chapterpagestyle}}% \Parameter{Seitenstil} lässt sich übrigens~-- unabhängig von der Option -\Option{chapterpage}~-- der Seitenstil von Kapiteln anpassen. - -Außerdem empfehle ich insbesondere bei der Verwendung separater Kapitelseiten -das Aktivieren der \KOMAScript-Option \Option{chapterprefix}. Damit werden die +\Option{chapterpage}~-- der Seitenstil von Kapiteln anpassen. Bei der +Verwendung von separaten Kapitelseiten ist außerdem das Aktivieren der +\KOMAScript-Option \Option{chapterprefix} empfehlenswert. Damit werden die Kapitelüberschriften mit einer Vorsatzzeile gesetzt. Falls ein nummeriertes Kapitel erzeugt wird, so wird zunächst in einer Zeile \enquote{Kapitel} gefolgt von der aktuellen Kapitelnummer ausgegeben, in der nächsten Zeile wird @@ -1599,11 +1799,12 @@ \subsection{Die Kapitelseite} \end{Declaration} -\subsection{Satzspiegel und Kolumnentitel} -\begin{Declaration}{\Option{geometry}[\PSet]}[true]% +\subsection{Der Satzspiegel} +\begin{Declaration}[v2.03]{\Option{cdgeometry}[\PSet]}[true]% \printdeclarationlist% +\index{Satzspiegel|(}\index{Layout!Satzspiegel|(}% \index{Seitenstil}\index{Layout!Seitenstil}% -\index{Satzspiegel}\index{Satzspiegel!doppelseitig}\index{Layout!Satzspiegel}% +\index{Satzspiegel!doppelseitig}% \index{Layout!Seitenränder}% % Diese Option ist für die Aufteilung beziehungsweise die Berechnung des @@ -1615,14 +1816,14 @@ \subsection{Satzspiegel und Kolumnentitel} Des Weiteren besteht die Möglichkeit, auf das Standardverhalten von \KOMAScript{} zurückzufallen und die Satzspiegelberechnung durch das Paket \Package{typearea} vornehmen zu lassen. Hier hat insbesondere die Klassenoption -\Option{DIV}[\PSet] maßgeblichen Einfluss auf den Satzspiegel. Siehe dazu die -Dokumentation von \KOMAScript{}. +\Option{DIV}[\PSet] maßgeblichen Einfluss auf den Satzspiegel. Mehr dazu ist in +der Dokumentation von \KOMAScript zu finden. % \begin{values} \itemfalse Die Satzspiegelberechnung erfolgt via \Package{typearea}, die Vorgaben des \CDs bezüglich der Seitenränder werden ignoriert. -\itemtrue*[tud/cd/asymmetric] +\itemtrue*[asymmetric/cd] Die Seitenränder werden im asymmetrischen Stil des \CDs fest definiert und auch für den doppelseitigen Satz (\Option{twoside}[true]) genutzt.% \footnote{links: 30\,mm, rechts: 20\,mm, oben: 25\,mm, unten: 30\,mm} @@ -1631,10 +1832,9 @@ \subsection{Satzspiegel und Kolumnentitel} zentriert.% \footnote{links: 25\,mm, rechts: 25\,mm, oben: 25\,mm, unten: 30\,mm} \item[balanced/twoside] - Im einseitigen Layout ist das Verhalten der Einstellung identisch zu - \Option{geometry}[symmetric]. Beim doppelseitigen Satz wird der Satzspiegel - derart verändert, dass die Ränder der inneren Seiten schmaler sind als die - der äußeren.% + Im einseitigen Layout ist diese Einstellung zu \Option{cdgeometry}[symmetric] + identisch. Beim doppelseitigen Satz wird der Satzspiegel derart verändert, + dass die Ränder der inneren Seiten schmaler sind als die der äußeren.% \footnote{innen: 20\,mm, außen: 30\,mm, oben: 25\,mm, unten: 30\,mm} \Attention{% Der so erzeugte Satzspiegel ist jedoch nicht sehr vorteilhaft. Es ist zu @@ -1644,12 +1844,43 @@ \subsection{Satzspiegel und Kolumnentitel} } \end{values} % -Für die Festlegung der Seitenränder wird das Paket \Package{geometry} -verwendet. Ist \Option{geometry}[false] gewählt, erfolgt die Berechnung des -Satzspiegels durch \Package{typearea}. Die damit berechneten Werte werden -anschließend an \Package{geometry} weitergereicht und durch dieses umgesetzt. +Für die Festlegung der Seitenränder wird das Paket \Package{geometry} genutzt. +Ist \Option{cdgeometry}[false] gewählt, erfolgt die Berechnung des Satzspiegels +durch \Package{typearea}. Die damit berechneten Werte werden anschließend an +\Package{geometry} weitergereicht und durch dieses umgesetzt. +\end{Declaration} + +\begin{Declaration}[v2.03]{\Option{extrabottommargin}[\PName{Höhe}]}% +\printdeclarationlist% +\index{Fußzeile|?} +% +Mit dieser Option kann die Größe des unteren Seitenrandes angepasst werden, +wenn der Satzspiegel des \CDs (\Option{cdgeometry}[true/symmetric/balanced]) +verwendet wird. Insbesondere für den Fall, dass Drittlogos im Fußbereich der +Seiten im Stil \PageStyle{tudheadings} verwendet werden, kann dieser unter +Umständen etwas zu klein sein. Dabei wird der Fußbereich durch positive Werte +vergrößert, negative Werte verkleinern diesen entsprechend. Es spielt dabei +keine Rolle, ob eine \hologo{LaTeX}-Länge, ein \hologo{TeX}-Abstand oder eine +\hologo{TeX}-Ausdehnung als Länge bei der Wertzuweisung verwendet wird. \end{Declaration} +\subsubsection{Kopf"~ und Fußzeile im Zusammenspiel mit dem Satzspiegel} +\index{Kopfzeile|?}\index{Layout!Kopfzeile}% +\index{Fußzeile|?}\index{Layout!Fußzeile}% +Da im \CD nicht festgelegt ist, wie die Gestaltung der Kopf"~ und Fußzeilen in +einer wissenschaftlichen Arbeit auszuführen ist, bleibt dem Nutzer dafür eine +gewisse Freiheit. Dafür sollte idealerweise das zu \KOMAScript{} gehörige Paket +\Package{scrlayer-scrpage} genutzt werden. + +In der Dokumentation zu \Package{typearea} wird auch darauf eingegangen, wann +Kopf"~ und Fußzeile bei der Satzspiegelkonstruktion entweder dem Rand oder dem +Textkörper zugeschlagen werden sollten. Dies sollte bei der Erstellung eigener +Kopf"~ und Fußzeilen beachtet werden. Die Einstellung dafür erfolgt mit den +beiden \KOMAScript"=Optionen \Option{headinclude}[\PBoolean] sowie +\Option{footinclude}[\PBoolean]. Diese können~-- unabhängig von der gewählten +Einstellung zur Satzspiegelgestaltung für die Option \Option{cdgeometry}~-- +verwendet werden. + \subsubsection{Bindekorrektur} \index{Bindekorrektur|!}\index{Layout!Bindekorrektur}% % @@ -1678,57 +1909,7 @@ \subsubsection{Bindekorrektur} Dementsprechend wäre eine Bindekorrektur von \Option{BCOR}[5mm] beziehungsweise \Option{BCOR}[6mm] bei diesem Beispiel zu wählen. \end{Example} - -\subsubsection{Kopf"~ und Fußzeile im Zusammenspiel mit dem Satzspiegel} -\index{Kopfzeile|!}\index{Layout!Kopfzeile}% -\index{Fußzeile|!}\index{Layout!Fußzeile}% -Da im \CD nicht festgelegt ist, wie die Gestaltung der Kopf"~ und Fußzeilen in -einer wissenschaftlichen Arbeit auszuführen ist, bleibt dem Nutzer dafür eine -gewisse Freiheit. Dafür sollte idealerweise das zu \KOMAScript{} gehörige Paket -\Package{scrlayer-scrpage} genutzt werden. - -In der Dokumentation zu \Package{typearea} wird auch darauf eingegangen, wann -Kopf"~ und Fußzeile bei der Satzspiegelkonstruktion entweder dem Rand oder dem -Textkörper zugeschlagen werden sollten. Dies sollte bei der Erstellung eigener -Kopf"~ und Fußzeilen beachtet werden. Die Einstellung dafür erfolgt mit den -beiden \KOMAScript"=Optionen \Option{headinclude}[\PBoolean] sowie -\Option{footinclude}[\PBoolean]. Diese können~-- unabhängig von der gewählten -Einstellung zur Satzspiegelgestaltung über \Option{geometry}~-- verwendet -werden. - -\begin{Declaration}{\Option{cdfoot}[\PBoolean]}[false]% -\printdeclarationlist% -\index{Kolumnentitel}\index{Layout!Kolumnentitel} -\index{Satzspiegel!doppelseitig}% - -Eine Möglichkeit zur Gestaltung der Kolumnentitel zeigt das Handbuch für das -\CD der \TnUD. Dieses wird ohne Kopf"~ und mit einer einfachen Fußzeile -gesetzt. Diese enthält dabei den aktuellen Kolumnentitel sowie die Paginierung. -Eine derartige Ausprägung ist nicht explizit durch das \CD vorgegeben, wurde -jedoch innerhalb der alten \Class{tudbook}"=Klasse exakt so umgesetzt. - -Die neuen \TUDScript-Klassen sind~-- insbesondere aufgrund der Möglichkeit zur -Verwendung des Paketes \Package{scrlayer-scrpage}~-- bei der Gestaltung der -Kopf"~ und Fußzeilen wesentlich flexibler. Dennoch kann mit dieser Option das -beschriebene Verhalten aktiviert werden. Hierbei wird beim doppelseitigen Satz -(\Option{twoside}[true]) die Seitenzahl außen gesetzt. -% -\begin{values} -\itemfalse - Die Kopf"~ und Fußzeilen zeigen Standardverhalten, zur manuellen Änderung - dieser sollte unbedingt das \KOMAScript"=Paket \Package{scrlayer-scrpage} - verwendet werden. -\itemtrue* - Die Kopf"~ und Fußzeilen des Dokumentes werden wie im Handbuch des \CDs der - \TnUD beziehungsweise der \Class{tudbook}"=Klasse gesetzt. -\end{values} -% -Der Inhalt der Kolumnentitel kann durch den Anwender frei gewählt werden. Wird -die Klassenoption \Option{automark} angegeben, werden für das automatische -Setzen der Marken die Titel der Gliederungsebenen verwendet. Genaueres hierzu -sowie der Möglichkeit, die Kolumnentitel manuell festzulegen, ist dem Handbuch -von \KOMAScript{} zu entnehmen. -\end{Declaration} +\index{Satzspiegel|)}\index{Layout!Satzspiegel|)}% \subsection{Die Farben des \CDs} @@ -1743,6 +1924,10 @@ \subsection{Die Farben des \CDs} \section{Zusätzliche Optionen und Erweiterungen} +\ChangedAt*{% + v2.03!Bugfix für \abstractname{,} \confirmationname{} und \blockingname{} + bei Seitenstil und Kolumnentitel% +}% Neben den Befehlen für die Anpassung des Layouts an das \CD der \TnUD stellen die \TUDScript-Klassen weitere Befehle und Umgebungen zur Verfügung, um die Anwendung insbesondere für wissenschaftliche Arbeiten zu erleichtern. @@ -1811,7 +1996,7 @@ \subsection{Zusammenfassung} Es wird ein nicht nummerierten Eintrag im Inhaltsverzeichnis auf der obersten Gliederungsebene der verwendeten Dokumentklasse für die Zusammenfassung gesetzt. -\item[tocleveldown/totocleveldown/leveldown] +\item[leveldown/tocleveldown/totocleveldown] \ChangedAt{v2.02} Der Inhaltsverzeichniseintrag wird eine Gliederungsebene unterhalb der obersten erzeugt. @@ -1866,7 +2051,7 @@ \subsection{Zusammenfassung} \end{values} % Die zuletzt genannten Einstellungen zur Positionierung der Zusammenfassungen -innerhalb der \Environment{abstract}"=Umgebung nur wirksam sind, wenn eine +innerhalb der \Environment{abstract}"=Umgebung sind nur wirksam, wenn eine Titelseite (\Option{titlepage}[true]) und \emph{keine} Überschriften in Form von Kapiteln (\Option{abstract}[chapter]) verwendet werden. \end{Declaration} @@ -1883,19 +2068,22 @@ \subsection{Zusammenfassung} \Key{\Environment{abstract}}{pagestyle}[\PName{Seitenstil}]% } \begin{Declaration}{\Key{\Environment{abstract}}{columns}[\PName{Anzahl}]} -\begin{Declaration}{\Key{\Environment{abstract}}{option}[\PSet]} +\begin{Declaration}{\Key{\Environment{abstract}}{option}[\PSet]}{% + \see*{\Option{abstract}'ppage'}% +} \printdeclarationlist% \index{Zweispaltensatz}% % -Diese Umgebung dient speziell für die Ausgabe einer Zusammenfassung. Wird ein -Titelkopf (\Option{titlepage}[false]) und keine Titelseite verwendet, so wird -für den Fall, dass die Zusammenfassung \emph{nicht} mit der Überschrift einer -Gliederungsebene gesetzt wird, diese wie bei den \KOMAScript"=Klassen in einer -\Environment{quotation}"=Umgebung gesetzt, um diese vom restlichen Fließtext -abzuheben. Diese hat jedoch den Nachteil, dass in besagter Umgebung die Option -\Option{parskip} nicht beachtet wird. Um dieses Problem zu beheben, kann das -Paket \Package{quoting} geladen werden, wodurch stattdessen die Umgebung -\Environment{quoting} verwendet wird. +Die \Environment{abstract}-Umgebung dient speziell für die Ausgabe einer +Zusammenfassung, entweder zu Beginn eines Dokumentes oder beispielsweise vor +einem Teil oder Kapitel. Wird ein Titelkopf (\Option{titlepage}[false]) und +keine Titelseite verwendet, so wird für den Fall, dass die Zusammenfassung +\emph{nicht} mit der Überschrift einer Gliederungsebene gesetzt wird, diese wie +bei den \KOMAScript"=Klassen in einer \Environment{quotation}"=Umgebung +gesetzt, um diese vom restlichen Fließtext abzuheben. Diese hat jedoch den +Nachteil, dass in besagter Umgebung die Option \Option{parskip} nicht beachtet +wird. Um dieses Problem zu beheben, kann das Paket \Package{quoting} geladen +werden, wodurch stattdessen die Umgebung \Environment{quoting} verwendet wird. Mit der zuvor erläuterten Option \Option{abstract} kann eingestellt werden, in welcher Gestalt die Zusammenfassung ausgegeben werden soll. Des Weiteren lässt @@ -1923,10 +2111,12 @@ \subsection{Zusammenfassung} Kolumnentitel mit \Key{\Environment{abstract}}{markboth}[\PName{Kolumnentitel}] auch direkt festlegen. So können die Kolumnen beispielsweise mit der Verwendung von \Key{\Environment{abstract}}{markboth}[\PParameter{}] auch gelöscht werden. -Sollte \Key{\Environment{abstract}}{markboth} verwendet werden, so wird in der -Umgebung automatisch der Seitenstil \PageStyle{headings} verwendet. Mit dem -Parameter \Key{\Environment{abstract}}{pagestyle} dieser auch manuell angegeben -werden. Auch die \PageStyle{tudheadings}"=Seitenstile werden unterstützt. +Sollte \Key{\Environment{abstract}}{markboth} aktiviert werden, so wird in der +Umgebung automatisch der Seitenstil \PageStyle{headings} genutzt~-- falls eine +Titelseite und kein Titelkopf (\Option{titlepage}[true]) verwendet wird. Mit +dem Parameter \Key{\Environment{abstract}}{pagestyle} kann dieser auch manuell +angegeben werden, wobei die \PageStyle{tudheadings}"=Seitenstile ebenfalls +unterstützt werden. Wurde das Paket \Package{multicol} geladen, kann mit dem Parameter \Key{\Environment{abstract}}{columns}[\PName{Anzahl}] die Zusammenfassung @@ -1950,9 +2140,9 @@ \subsection{Zusammenfassung} zeigt hierfür das notwendige Vorgehen. Wird die \Environment{abstract}"=Umgebung innerhalb des Argumentes der Befehle -\Macro{partpreamble} beziehungsweise \Macro{chapterpreamble} verwendet, so wird -die Überschrift~-- im Fall, dass nicht \Option{abstract}[false] gewählt ist~-- -\emph{immer} in Textgröße und zentriert gesetzt. +\Macro{setpartpreamble} beziehungsweise \Macro{setchapterpreamble} verwendet, +so wird die Überschrift~-- im Fall, dass nicht \Option{abstract}[false] gewählt +ist~-- \emph{immer} in Textgröße und zentriert gesetzt. \end{Declaration} \end{Declaration} \end{Declaration} @@ -2022,7 +2212,7 @@ \subsection{Selbstständigkeitserklärung und Sperrvermerk} Unabhängig von der Wahl der Überschrift erhält jede Erklärung einen nicht nummerierten Eintrag im Inhaltsverzeichnis auf der obersten Gliederungsebene der aktuell gerade verwendeten Dokumentklasse. -\item[tocleveldown/totocleveldown/leveldown] +\item[leveldown/tocleveldown/totocleveldown] \ChangedAt{v2.02} Der Inhaltsverzeichniseintrag wird eine Gliederungsebene unterhalb der obersten erzeugt. @@ -2047,11 +2237,10 @@ \subsection{Selbstständigkeitserklärung und Sperrvermerk} Die Einstellung für manuelle oder automatische Kolumnentitel werden beachtet. \end{values} % -Des Weiteren kann mit dem Parameter \Key{\Environment{declaration}}{markboth} -der \Environment{declarations}"=Umgebung der Kolumnentitel mit einem beliebigen -Inhalt gesetzt werden. Verwenden Sie einen der Befehle \Macro{declaration} -beziehungsweise \Macro{confirmation} und \Macro{blocking} ist dies mit dem -gleichnamigen, optionalen Parameter ebenfalls möglich. +Für \Macro{declaration} respektive \Macro{confirmation} und \Macro{blocking} +sowie die \Environment{declaration}"=Umgebung kann mit dem Parameter +\Key{\Environment{declaration}}{markboth} außerdem der Kolumnentitel mit einem +beliebigen Inhalt gesetzt werden. Die folgenden Einstellungen zur Positionierung der Erklärungen haben lediglich Auswirkungen, wenn die Überschrift der Erklärung \emph{nicht} im Form eines @@ -2100,6 +2289,13 @@ \subsection{Selbstständigkeitserklärung und Sperrvermerk} \printdeclarationlist% \index{Selbstständigkeitserklärung}\index{Sperrvermerk}% % +Für Selbstständigkeitserklärung und Sperrvermerk sollten im einfachsten Fall +die Befehle \Macro{declaration} beziehungsweise \Macro{confirmation} und +\Macro{blocking} verwendet werden. Sobald diese jedoch in anderer Reihenfolge, +mehrfacher Ausführung, unterschiedlichen Sprachen oder durch zusätzliche +Erklärungen ergänzt werden, so bietet die \Environment{declarations}-Umgebung +die notwendigen Freiheiten. + Innerhalb dieser Umgebung können Selbstständigkeitserklärung und Sperrvermerk mit dem Befehl \Macro{declaration} direkt nacheinander folgend beziehungsweise mit \Macro{confirmation} und \Macro{blocking} auch separat ausgegeben werden. @@ -2128,50 +2324,14 @@ \subsection{Selbstständigkeitserklärung und Sperrvermerk} festlegen. Sollte \Key{\Environment{declarations}}{markboth} verwendet werden, wird der Seitenstil automatisch auf \PageStyle{headings} gesetzt. Mit dem Parameter \Key{\Environment{declarations}}{pagestyle} lässt sich dieser für die -Umgebung auch manuell angegeben. - +Umgebung auch manuell angegeben. Wurde das Paket \Package{multicol} geladen, +wird mit \Key{\Environment{declarations}}{columns}[\PName{Anzahl}] der Inhalt +der Umgebung mehrspaltig gesetzt. Für \Key{\Environment{declarations}}{option} +können alle gültigen Werte der Option \Option{declaration} angegeben werden. Die Verwendung der Parameter \Key{\Macro{confirmation}}{supporter} sowie \Key{\Macro{confirmation}}{place} und \Key{\Macro{confirmation}}{closing} ist in der Dokumentation des Befehls \Macro{confirmation} zu finden, der Parameter -\Key{\Macro{blocking}}{company} ist für \Macro{blocking} erläutert. Für den -Parameter \Key{\Environment{declarations}}{option} können alle gültigen Werte -der Option \Option{declaration} angegeben werden. Diese wirken sich nur lokal -innerhalb der \Environment{declarations}"=Umgebung aus. -\end{Declaration} -\end{Declaration} -\end{Declaration} -\end{Declaration} -\end{Declaration} -\end{Declaration} -\end{Declaration} -\end{Declaration} -\end{Declaration} -\end{Declaration} - -\begin{Declaration}{\Macro{declaration}\LParameter} -\begin{Declaration}{\Key{\Macro{declaration}}{language}[\PName{Sprache}]} -\begin{Declaration}[v2.02]{% - \Key{\Macro{declaration}}{markboth}[\PBName{Kolumnentitel}]% -} -\begin{Declaration}[v2.02]{% - \Key{\Macro{declaration}}{pagestyle}[\PName{Seitenstil}]% -} -\begin{Declaration}[v2.02]{\Key{\Macro{declaration}}{columns}[\PName{Anzahl}]} -\begin{Declaration}{\Key{\Macro{declaration}}{option}[\PSet]} -\begin{Declaration}{\Key{\Macro{declaration}}{supporter}[\PName{Unterstützer}]} -\begin{Declaration}{\Key{\Macro{declaration}}{place}[\PName{Ort}]} -\begin{Declaration}{\Key{\Macro{declaration}}{closing}[\PName{Ende}]} -\begin{Declaration}{\Key{\Macro{declaration}}{company}[\PName{Firma}]} -\printdeclarationlist% -\index{Selbstständigkeitserklärung}\index{Sperrvermerk}% -% -Dieser Befehl gibt die Selbstständigkeitserklärung und den Sperrvermerk direkt -aufeinanderfolgend aus. Dabei werden die Einstellungen zur Positionierung der -einzelnen Erklärungen, welche über die Wertzuweisungen an die Option -\Option{declaration}[simple/multiple/fill/nofill] erfolgen, beachtet. Er kann -sowohl innerhalb der \Environment{declarations}"=Umgebung als auch außerhalb -direkt im Dokument verwendet werden und akzeptiert im optionalen Argument dabei -alle für die \Environment{declarations}"=Umgebung beschriebenen Parameter. +\Key{\Macro{blocking}}{company} ist für \Macro{blocking} erläutert. \end{Declaration} \end{Declaration} \end{Declaration} @@ -2205,21 +2365,20 @@ \subsection{Selbstständigkeitserklärung und Sperrvermerk} Selbstständigkeitserklärung ausgegeben, welcher in \Term{confirmationtext} gespeichert ist. Wie dieser angepasst beziehungsweise geändert werden kann, ist unter \autoref{sec:localization} zu finden. Er kann sowohl innerhalb der -\Environment{declarations}"=Umgebung als auch außerhalb direkt im Dokument -verwendet werden. - -Wird er in seiner ursprünglichen Form belassen, kann er im optionalen Argument -über die deklarierten Parameter angepasst werden. Im Standardtext der -Selbstständigkeitserklärung werden sowohl der Titel als auch der Typ der -Abschlussarbeit~-- falls dieser mit \Macro{thesis} oder \Macro{subject} und -einem speziellen Wert aus \autoref{tab:thesis} beziehungsweise mit der Option +\Environment{declarations}"=Umgebung als auch außerhalb dieser direkt im +Dokument verwendet werden. + +Wird \Term{confirmationtext} nicht geändert, kann dieser über das optionale +Argument von \Macro{confirmation} und die deklarierten Parameter angepasst +werden. Im Standardtext der Selbstständigkeitserklärung werden sowohl der Titel +als auch der Typ der Abschlussarbeit~-- falls dieser mit \Macro{thesis}, +\Macro{subject}\Parameter{\autoref{tab:thesis}} beziehungsweise mit der Option \Option{subjectthesis} angegeben wurde~-- aufgeführt. Über den Parameter -\Key{\Macro{confirmation}}{supporter} können weitere an der Arbeit beteiligte -Personen angegeben werden. Dies ist auch mit dem Befehl \Macro{supporter} -möglich, wenn dieser \emph{vor} \Macro{confirmation} verwendet wird. Mehrere -zu nennende Personen sind auch hier durch \Macro{and} zu trennen. Das Feld der -Unterstützer kann auch mit dem bloßen optionalen Argument ohne die Angabe eines -Parameters angepasst werden. +\Key{\Macro{confirmation}}{supporter} oder \emph{zuvor} mit dem Befehl +\Macro{supporter} können weitere an der Arbeit beteiligte Personen angegeben +werden. Mehrere zu nennende Personen sind auch hier durch \Macro{and} zu +trennen. Das Feld der Unterstützer kann auch mit dem bloßen optionalen Argument +ohne die Angabe eines Parameters angepasst werden. Nach dem eigentlichen Text der Selbstständigkeitserklärung wird der mit \Key{\Macro{confirmation}}{place} beziehungsweise \Macro{place} angegebene Ort @@ -2231,6 +2390,7 @@ \subsection{Selbstständigkeitserklärung und Sperrvermerk} mit dem Parameter \Key{\Macro{confirmation}}{closing} oder zuvor mit dem Befehl \Macro{confirmationclosing} angepasst werden. Die Parameter \Key{\Environment{declarations}}{language}, +\Key{\Environment{declarations}}{markboth}, \Key{\Environment{declarations}}{pagestyle}, \Key{\Environment{declarations}}{columns} und \Key{\Environment{declarations}}{option} entsprechen in ihrem Verhalten denen @@ -2245,19 +2405,14 @@ \subsection{Selbstständigkeitserklärung und Sperrvermerk} \end{Declaration} \end{Declaration} -\Rename[macros]{v2.02}{\Macro{restriction}}{\Macro{blocking}} -\begin{Declaration}{\Macro{blocking}\OLParameter{Firma}} +\begin{Declaration}[v2.02]{\Macro{blocking}\OLParameter{Firma}} \begin{Declaration}{\Key{\Macro{blocking}}{company}[\PName{Firma}]} \begin{Declaration}{\Key{\Macro{blocking}}{language}[\PName{Sprache}]} \begin{Declaration}[v2.02]{% \Key{\Macro{blocking}}{markboth}[\PBName{Kolumnentitel}]% } -\begin{Declaration}[v2.02]{% - \Key{\Macro{blocking}}{pagestyle}[\PName{Seitenstil}]% -} -\begin{Declaration}[v2.02]{% - \Key{\Macro{blocking}}{columns}[\PName{Anzahl}]% -} +\begin{Declaration}[v2.02]{\Key{\Macro{blocking}}{pagestyle}[\PName{Seitenstil}]} +\begin{Declaration}[v2.02]{\Key{\Macro{blocking}}{columns}[\PName{Anzahl}]} \begin{Declaration}{\Key{\Macro{blocking}}{option}[\PSet]} \printdeclarationlist% \index{Sperrvermerk}% @@ -2272,14 +2427,14 @@ \subsection{Selbstständigkeitserklärung und Sperrvermerk} In seiner ursprünglichen Definition, kann er im optionalen Argument über die deklarierten Parameter angepasst werden. Im Standardtext des Sperrvermerks werden sowohl der Titel als auch der Typ der Abschlussarbeit~-- falls dieser -mit \Macro{thesis} oder \Macro{subject} und einem speziellen Wert aus -\autoref{tab:thesis} beziehungsweise mit der Option \Option{subjectthesis} -angegeben wurde~-- aufgeführt. Mit \Key{\Macro{blocking}}{company}~-- oder -\emph{vorher} mit dem Befehl \Macro{company}~-- kann zusätzlich eine im -Sperrvermerk zu nennende Firma oder ähnliches angegeben werden. Dieses Feld -kann auch direkt im optionalen Argument ohne die Verwendung eines Parameters -gesetzt werden. Die weiteren Parameter +mit \Macro{thesis}, \Macro{subject}\Parameter{\autoref{tab:thesis}} respektive +mit der Option \Option{subjectthesis} angegeben wurde~-- aufgeführt. Mit +\Key{\Macro{blocking}}{company} oder \emph{vorher} mit \Macro{company} kann +zusätzlich eine im Sperrvermerk zu nennende Firma oder ähnliches angegeben +werden. Dieses Feld kann auch direkt im optionalen Argument ohne die Verwendung +eines Parameters gesetzt werden. Die weiteren Parameter \Key{\Environment{declarations}}{language}, +\Key{\Environment{declarations}}{markboth}, \Key{\Environment{declarations}}{pagestyle}, \Key{\Environment{declarations}}{columns} und \Key{\Environment{declarations}}{option} entsprechen in ihrem Verhalten denen @@ -2292,6 +2447,41 @@ \subsection{Selbstständigkeitserklärung und Sperrvermerk} \end{Declaration} \end{Declaration} +\begin{Declaration}{\Macro{declaration}\LParameter} +\begin{Declaration}{\Key{\Macro{declaration}}{language}[\PName{Sprache}]} +\begin{Declaration}[v2.02]{% + \Key{\Macro{declaration}}{markboth}[\PBName{Kolumnentitel}]% +} +\begin{Declaration}[v2.02]{% + \Key{\Macro{declaration}}{pagestyle}[\PName{Seitenstil}]% +} +\begin{Declaration}[v2.02]{\Key{\Macro{declaration}}{columns}[\PName{Anzahl}]} +\begin{Declaration}{\Key{\Macro{declaration}}{option}[\PSet]} +\begin{Declaration}{\Key{\Macro{declaration}}{supporter}[\PName{Unterstützer}]} +\begin{Declaration}{\Key{\Macro{declaration}}{place}[\PName{Ort}]} +\begin{Declaration}{\Key{\Macro{declaration}}{closing}[\PName{Ende}]} +\begin{Declaration}{\Key{\Macro{declaration}}{company}[\PName{Firma}]} +\printdeclarationlist% +\index{Selbstständigkeitserklärung}\index{Sperrvermerk}% +% +Dieser Befehl gibt die Selbstständigkeitserklärung und den Sperrvermerk direkt +aufeinanderfolgend aus. Dabei werden die Einstellungen zur Positionierung der +einzelnen Erklärungen, welche über die Wertzuweisungen an die Option +\Option{declaration}[simple/multiple/fill/nofill] erfolgen, beachtet. Er kann +sowohl innerhalb der \Environment{declarations}"=Umgebung als auch außerhalb +direkt im Dokument verwendet werden und akzeptiert im optionalen Argument dabei +alle für die \Environment{declarations}"=Umgebung beschriebenen Parameter. +\end{Declaration} +\end{Declaration} +\end{Declaration} +\end{Declaration} +\end{Declaration} +\end{Declaration} +\end{Declaration} +\end{Declaration} +\end{Declaration} +\end{Declaration} + \begin{Declaration}{\Macro{supporter}\Parameter{Unterstützer}} \begin{Declaration}{\Macro{place}\Parameter{Ort}} \begin{Declaration}{\Macro{confirmationclosing}\Parameter{Ende}} @@ -2360,12 +2550,12 @@ \section{Sprachabhängige Bezeichner} welche von einem beliebigen (Sprach"~)Paket bereitgestellt werden, ändern wollen, ist hierfür der Befehl \Macro{renewcaptionname}\Parameter{Sprache}\Parameter{Makro}\Parameter{Inhalt} -zu verwenden. Seit der Version~v3.12 stellt \KOMAScript sicher, dass die -Bezeichner erst \textbf{nach} \Macro*{begin}\PParameter{document} angepasst -werden und somit nicht durch ein später geladenes Paket abermals geändert -werden können. Es sollte natürlich dabei eine \PName{Sprache} angegeben werden, -welche im Dokument durch \Package{babel} oder ein anderes Sprachpaket verwendet -wird, beispielsweise \PValue{ngerman} oder \PValue{english}. +zu verwenden. Dabei stellt \KOMAScript{} sicher, dass die Bezeichner erst +\textbf{nach} \Macro*{begin}\PParameter{document} angepasst werden und somit +nicht durch ein später geladenes Paket abermals geändert werden können. Es +sollte natürlich dabei eine \PName{Sprache} angegeben werden, welche im +Dokument durch \Package{babel} oder ein anderes Sprachpaket verwendet wird, +beispielsweise \PValue{ngerman} oder \PValue{english}. Die Makros der Bezeichner und deren Verwendung werden folgend kurz beschrieben und tabellarisch aufgeführt. Dabei wurde versucht, alle Befehle der Bezeichner @@ -2375,7 +2565,7 @@ \section{Sprachabhängige Bezeichner} \begin{Declaration}{\Term{supervisorname}} \begin{Declaration}{\Term{supervisorothername}} \begin{Declaration}[% - v2.02!Unterscheidung zwischen einem und mehreren Gutachtern% + v2.02!Unterscheidung von einem und mehreren Gutachtern% ]{\Term{refereename}} \begin{Declaration}{\Term{refereeothername}} \begin{Declaration}{\Term{advisorname}} @@ -2478,8 +2668,7 @@ \section{Sprachabhängige Bezeichner} \end{Declaration} \end{Declaration} -\Rename[terms]{v2.02}{\Term{degreetext}}{\Term{graduationtext}} -\begin{Declaration}{\Term{graduationtext}} +\begin{Declaration}[v2.02]{\Term{graduationtext}} \printdeclarationlist% \index{Titel}\index{Abschlussarbeit}\index{Typisierung}% % @@ -2515,9 +2704,8 @@ \section{Sprachabhängige Bezeichner} \TermTable{abstractname} \end{Declaration} -\Rename[terms]{v2.02}{\Term{restrictionname}}{\Term{blockingname}} \begin{Declaration}{\Term{confirmationname}} -\begin{Declaration}{\Term{blockingname}} +\begin{Declaration}[v2.02]{\Term{blockingname}} \printdeclarationlist% \index{Selbstständigkeitserklärung}\index{Sperrvermerk}% % @@ -2527,9 +2715,8 @@ \section{Sprachabhängige Bezeichner} \end{Declaration} \end{Declaration} -\Rename[terms]{v2.02}{\Term{restrictiontext}}{\Term{blockingtext}} \begin{Declaration}{\Term{confirmationtext}} -\begin{Declaration}{\Term{blockingtext}} +\begin{Declaration}[v2.02]{\Term{blockingtext}} \printdeclarationlist% % Die Texte der Erklärungen selbst sind derart aufgebaut, dass sie in @@ -2599,3 +2786,45 @@ \section{Sprachabhängige Bezeichner} \end{Declaration} \end{Declaration} \index{Bezeichner|!)} + +\section{Kompatibilitätseinstellungen zu früheren Versionen} +Bei der Entwicklung von \TUDScript lässt es sich nicht immer vermeiden, dass +Verbesserungen sowie Korrekturen an den Klassen und Paketen zu Änderungen am +Ergebnis der Ausgabe führen, insbesondere bei Umbruch und Layout. Für bereits +archivierte Dokumente, welche mit einer früheren Version erstellt wurden ist +dies jedoch bei einer erneuten Kompilierung unter Umständen eher unerwünscht. + +\begin{Declaration}[v2.03]{\Option{tudscrver}[% + \PName{Version}\textOR\PValue{first}\textOR\PValue{last}% +]}[last] +\printdeclarationlist% +\index{Kompatibilität|!}% +% +Mit der Option \Option{tudscrver} wird es möglich, auf das Verhalten einer +älteren Version von \TUDScript umzuschalten, um nach der Kompilierung das +erwartete Ergebnis zu erhalten. Neue Möglichkeiten, die sich nicht auf den +Umbruch oder das Layout auswirken, sind auch für den Fall verfügbar, dass per +Option die Kompatibilität zu einer älteren Version ausgewählt wurde. + +Bei der Angabe einer unbekannten Version als Wert wird eine Warnung ausgegeben +und \Option{tudscrver}[first] angenommen. Mit \Option{tudscrver}[last] wird die +jeweils aktuell verfügbare Version ausgewählt und folglich auf die zukünftige +Kompatibilität des Dokumentes zu der genutzten Version verzichtet. Dieses +Verhalten entspricht der Voreinstellung. Es ist zu beachten, dass die Nutzung +von \Option{tudscrver} nur als Klassenoption möglich ist. +% +\begin{values} +\item[\PValue{v2.02}\textOR\PValue{last}] + \ChangedAt{% + v2.03!Satzspiegel im \CD geändert{,} das \protect\DDC-Logo im Fußbereich + wird ohne vergrößerten Seitenrand verwendet + } + Der Satzspiegel im Layout des \CDs (\see*{\Option{cdgeometry}}) wurde in der + Version~v2.03 leicht geändert. Der obere Seitenrand wurde verkleinert, der + untere im gleichen Maße vergrößert. Der verfügbare Textbereich ist folglich + identisch. Bei der Aktivierung des \DDC-Logos im Fußbereich der Seite + (\see*{\Option{ddcfoot}}) wird im Gegensatz zur Version~v2.02 der gleiche + Satzspiegel genutzt. Mit \Option{tudscrver}[v2.02] kann dieses Verhalten + deaktiviert werden. +\end{values} +\end{Declaration} \ No newline at end of file diff --git a/source/doc/tudscr-obsolete.tex b/source/doc/tudscr-obsolete.tex index 02ccdb60..999bb594 100644 --- a/source/doc/tudscr-obsolete.tex +++ b/source/doc/tudscr-obsolete.tex @@ -1,6 +1,7 @@ \chapter{Obsolete sowie vollständig entfernte Optionen und Befehle} \label{sec:obsolete}% % +\section{Veraltete Optionen und Befehle in \TUDScript} Einige Optionen und Befehle waren während der Weiterentwicklung von \TUDScript in ihrer ursprünglichen Form nicht mehr umsetzbar oder wurden~-- unter anderem aus Gründen der Kompatibilität zu anderen Paketen~-- schlichtweg verworfen. @@ -9,11 +10,13 @@ \chapter{Obsolete sowie vollständig entfernte Optionen und Befehle} \vTUDScript{} darzustellen. Ist dies der Fall, wird hier entsprechend kurz darauf hingewiesen. -\begin{Declaration}{\Option{cd}[alternative]}{entfällt} -\begin{Declaration}{\Option{cdtitle}[alternative]}{entfällt} -\begin{Declaration}{\Length{titlecolwidth}}{entfällt} -\begin{Declaration}{\Term{authortext}}{entfällt} -\printdeclarationlist*% + +\subsection{Änderungen für \TUDScript~v2.00} +\begin{Declaration}[v2.00]{\Option*{cd}[alternative]} +\begin{Declaration}[v2.00]{\Option*{cdtitle}[alternative]} +\begin{Declaration}[v2.00]{\Length{titlecolwidth}} +\begin{Declaration}[v2.00]{\Term{authortext}} +\printdeclarationlist*[\emph{entfällt}]% \index{Titel!alternativer}% % Die alternative Titelseite ist komplett aus dem \TUDScript-Bundle entfernt @@ -24,118 +27,193 @@ \chapter{Obsolete sowie vollständig entfernte Optionen und Befehle} \end{Declaration} \end{Declaration} -\begin{Declaration}{\Option{color}[\PBoolean]}{siehe \Option*{cd}[color]} -\printdeclarationlist*% +\Replace{v2.00}{\Option{cd}}{\Option{color}} +\begin{Declaration}[v2.00]{\Option{color}[\PBoolean]} +\printdeclarationlist*[\see*{\Option*{cd}'page'}]% % Die Einstellungen der farbigen Ausprägung des Dokumentes erfolgt über die Option \Option*{cd}. \end{Declaration} -\begin{Declaration}{\Option{tudfonts}[\PBoolean]}{siehe \Option*{cdfont}[\PSet]} -\printdeclarationlist*% +\Replace{v2.00}{\Option{cdfont}}{\Option{tudfonts}} +\begin{Declaration}[v2.00]{\Option{tudfonts}[\PBoolean]} +\begin{Declaration}[v2.00]{\Option*{cdfonts}[\PBoolean]} +\printdeclarationlist*[\see*{\Option*{cdfont}'page'}]% % Die Option zur Schrifteinstellung ist wesentlich erweitert worden. Aus Gründen der Konsistenz wurde diese umbenannt. \end{Declaration} +\end{Declaration} -\begin{Declaration}{\Option{tudfoot}[\PBoolean]}{ - siehe \Option*{cdfoot}[\PBoolean]% -} -\printdeclarationlist*% +\Replace{v2.00}{\Option{cdfoot}}{\Option{tudfoot}} +\begin{Declaration}[v2.00]{\Option{tudfoot}[\PBoolean]} +\printdeclarationlist*[\see*{\Option*{cdfoot}'page'}]% % Ebenso wurde die Option \Option*{tudfoot} umbenannt, um dem Namensschema der restlichen Optionen von \TUDScript zu entsprechen. \end{Declaration} -\begin{Declaration}{\Option{headfoot}[\PSet]}{entfällt} -\printdeclarationlist*% +\begin{Declaration}[v2.00]{\Option{headfoot}[\PSet]} +\printdeclarationlist*[\emph{entfällt}, + \KOMAScript-Optionen \Option*{headinclude} und \Option*{footinclude}% +]% % Diese Option war für \TUDScript in der Version~v1.0 notwendig, um die parallele -Verwendung der beiden Pakete \Package{typearea} und \Package{geometry} zu +Verwendung der beiden Pakete \Package*{typearea} und \Package*{geometry} zu ermöglichen. Die Erstellung des Satzspiegels wurde komplett überarbeitet. -Mittlerweile werden an das Paket \Package{geometry} die Einstellungen für die -\KOMAScript"=Optionen \Option{headinclude} und \Option{footinclude} direkt +Mittlerweile werden an das Paket \Package*{geometry} die Einstellungen für die +\KOMAScript"=Optionen \Option*{headinclude} und \Option*{footinclude} direkt weitergereicht, so dass die Option \Option*{headfoot} nicht mehr notwendig ist und deshalb entfernt wurde. \end{Declaration} -\begin{Declaration}{\Option{partclear}[\PBoolean]}{% - entfällt, siehe \Option*{cleardoublespecialpage}% -} -\begin{Declaration}{\Option{chapterclear}[\PBoolean]}{% - entfällt, siehe \Option*{cleardoublespecialpage}% -} -\printdeclarationlist*% -% +\Replace{v2.00}{\Option{cleardoublespecialpage}}{% + \Option{partclear},\Option{chapterclear}% +} +\begin{Declaration}[v2.00]{\Option{partclear}[\PBoolean]} +\begin{Declaration}[v2.00]{\Option{chapterclear}[\PBoolean]} +\printdeclarationlist*[% + \emph{entfällt}, \see*{\Option*{cleardoublespecialpage}'page'}% +]% Beide Optionen sind in der neuen Option \Option*{cleardoublespecialpage} aufgegangen, womit ein konsistentes Layout erreicht wird. Die ursprünglichen Optionen entfallen. \end{Declaration} \end{Declaration} -\begin{Declaration}{\Option{abstracttotoc}[\PBoolean]}{% - entfällt, siehe \Option*{abstract}[\PSet]% -} -\begin{Declaration}{\Option{abstractdouble}[\PBoolean]}{% - entfällt, siehe \Option*{abstract}[\PSet]% +\Replace{v2.00}{\Option{abstract}}{% + \Option{abstracttotoc},\Option{abstractdouble}% } -\printdeclarationlist*% +\begin{Declaration}[v2.00]{\Option{abstracttotoc}[\PBoolean]} +\begin{Declaration}[v2.00]{\Option{abstractdouble}[\PBoolean]} +\printdeclarationlist*[\emph{entfällt}, \see*{\Option*{abstract}'page'}]% % Beide Optionen wurden in die Option \Option*{abstract} integriert und sind deshalb überflüssig. \end{Declaration} \end{Declaration} -\begin{Declaration}{\Macro{logofile}\Parameter{Dateiname}}% - {siehe \Macro*{headlogo}\Parameter{Dateiname}% -} -\begin{Declaration}{\Macro{logofilename}\Parameter{Dateiname}}% - {siehe \Macro*{headlogo}\Parameter{Dateiname}% +\Replace{v2.00}{\Macro{headlogo}}{\Macro{logofile}} +\begin{Declaration}[v2.00]{\Macro{logofile}\Parameter{Dateiname}} +\printdeclarationlist*[\see*{\Macro*{headlogo}'page'}]% +% +Der Befehl \Macro*{logofile} wurde in \Macro*{headlogo} umbenannt. wobei die +Funktionalität weiterhin bestehen bleibt. +\end{Declaration} + +\Replace{v2.00}{\Option{tudbookmarks}}{\Option{bookmarks}} +\begin{Declaration}[v2.00]{\Option{bookmarks}[\PBoolean]} +\printdeclarationlist*[\see*{\Option*{tudbookmarks}'page'}]% +% +Umbenannt, um Überschneidungen mit \Package*{hyperref} zu vermeiden. +\end{Declaration} + +\begin{Declaration}[v2.00]{\Length{signatureheight}} +\printdeclarationlist*[\emph{entfällt}]% +% +Die Höhe für die Zeile der Unterschriften wurde dehnbar gestaltet, eine etwaige +Anpassung durch den Anwender ist nicht vonnöten. +\end{Declaration} + +\Replace{v2.00}{\Macro{titledelimiter}}{\Term{titlecoldelim}} +\begin{Declaration}[v2.00]{\Term{titlecoldelim}}% +\printdeclarationlist*[\emph{entfällt}, \see*{\Macro*{titledelimiter}'page'}]% +% +Das Trennzeichen für Bezeichnungen beziehungsweise beschreibende Texte und dem +eigentlichen Feld auf der Titelseite ist nicht mehr sprachabhängig und wurde +umbenannt. +\end{Declaration} + +\Replace{v2.00}{\Macro{declaration}}{% + \Macro{confirmationandrestriction},\Macro{restrictionandconfirmation}% } -\printdeclarationlist*% +\begin{Declaration}[v2.00]{\Macro{confirmationandrestriction}} +\begin{Declaration}[v2.00]{\Macro{restrictionandconfirmation}} +\printdeclarationlist*[\emph{entfällt}, \see*{\Macro*{declaration}'page'}]% % -Der Befehl \Macro*{logofile} sowie der dazugehörige Alias \Macro*{logofilename} -wurden in \Macro*{headlogo} umbenannt. Die Funktionalität bleibt weiterhin -bestehen. +Die beiden Befehle entfallen, stattdessen sollte entweder der Befehl +\Macro*{declaration} oder die Umgebung \Environment*{declarations} zusammen mit +den Befehlen \Macro*{confirmation} und \Macro*{blocking} verwendet werden, +wobei sich diese in der Umgebung in beliebiger Reihenfolge anordnen lassen. \end{Declaration} \end{Declaration} -\begin{Declaration}{\Length{chapterheadingvskip}}{% - siehe \Length*{pageheadingsvskip} sowie \Length*{headingsvskip} +\Replace{v2.00}{\Macro{place}}{\Macro{location}} +\begin{Declaration}[v2.00]{\Macro{location}\Parameter{Ort}}{% + \see*{\Macro*{place}'page'}% } -\begin{Declaration}{\Length{signatureheight}}{entfällt} \printdeclarationlist*% +In Anlehnung an andere \hologo{LaTeX}-Pakete und "~Klassen wurde +\Macro*{location} in \Macro*{place} umbenannt. +\end{Declaration} + +\minisec{\taskname} +Die Umgebung für die Erstellung einer Aufgabenstellung für eine +wissenschaftliche Arbeit wurde in das Paket \Package{tudscrsupervisor} +ausgelagert. Dieses muss für die Verwendung der Umgebung \Environment*{task} +und der daraus abgeleiteten standardisierten Form zwingend geladen werden. + +\Replace{v2.00}{\Environment*{task}}{\Option{cdtask}} +\begin{Declaration}[v2.00]{\Option{cdtask}[\PSet]} +\begin{Declaration}[v2.00]{\Option{taskcompact}[\PBoolean]} +\begin{Declaration}[v2.00]{\Length{taskcolwidth}} +\printdeclarationlist*[\emph{entfällt}, \see*{\Environment*{task}'page'}]% % -Die vertikale Positionierung von Überschriften wurde zweigeteilt. Die Höhe für -die Zeile der Unterschriften wurde dehnbar gestaltet. Eine Anpassung durch den -Anwender ist nicht vonnöten. +Die Klassenoption \Option*{cdtask} ist komplett entfernt worden, alle +Einstellungen, welche \Environment*{task} betreffen erfolgen direkt über das +optionale Argument der Umgebung. Die Variante eines kompakten Kopfes mit der +Option \Option*{taskcompact} wird nicht mehr bereitgestellt. Die manuelle +Einstellmöglichkeit der Spaltenbreite für den Kopf der Aufgabenstellung mit +\Length*{taskcolwidth} wurde aufgrund der verbesserten automatischen Berechnung +entfernt. +\end{Declaration} \end{Declaration} \end{Declaration} -\begin{Declaration}{\Term{titlecoldelim}}{% - entfällt, siehe \Macro*{titledelimiter}% +\Replace{v2.00}{\Macro{taskform}}{\Macro{tasks}} +\begin{Declaration}[v2.00]{% + \Macro{tasks}\Parameter{Ziele}\Parameter{Schwerpunkte}% +}{\emph{entfällt}, \see*{\Macro*{taskform}'page'}} +\Replace{v2.00}{\Term{focusname}}{\Term{focustext}} +\begin{Declaration}[v2.00]{\Term{focustext}}{% + \emph{entfällt}, \see*{\Term*{focusname}'page'}% +} +\Replace{v2.00}{\Term{objectivesname}}{\Term{objectivestext}} +\begin{Declaration}[v2.00]{\Term{objectivestext}}{% + \emph{entfällt}, \see*{\Term*{objectivesname}'page'}% } \printdeclarationlist*% % -Das Trennzeichen für Bezeichnungen beziehungsweise beschreibende Texte und dem -eigentlichen Feld auf der Titelseite ist nicht mehr sprachabhängig und wurde -umbenannt. +Der Befehl \Macro*{tasks} wurde in \Macro*{taskform} umbenannt und in der +Funktionalität erweitert. Die darin verendeten Bezeichner wurden ebenfalls +leicht abgewandelt. +\end{Declaration} +\end{Declaration} \end{Declaration} -\begin{Declaration}{\Macro{submissiondate}\Parameter{Datum}}{% - Alias für \Macro*{date}% +\Replace{v2.00}{\Macro{matriculationnumber}}{\Macro{studentid}} +\begin{Declaration}[v2.00]{\Macro{studentid}\Parameter{Matrikelnummer}}{% + \see*{\Macro*{matriculationnumber}'page'}% } -\begin{Declaration}{\Macro{birthday}\Parameter{Geburtsdatum}}{% - Alias für \Macro*{dateofbirth}% +\Replace{v2.00}{\Macro{matriculationyear}}{\Macro{enrolmentyear}} +\begin{Declaration}{\Macro{enrolmentyear}\Parameter{Immatrikulationsjahr}}{% + \see*{\Macro*{matriculationyear}'page'}% } -\begin{Declaration}{\Macro{birthplace}\Parameter{Geburtsort}}{% - Alias für \Macro*{placeofbirth} +\Replace{v2.00}{\Macro{date}}{\Macro{submissiondate}} +\begin{Declaration}[v2.00]{\Macro{submissiondate}\Parameter{Datum}}{% + \see*{\Macro*{date}'page'}% } -\begin{Declaration}{\Macro{studentid}\Parameter{Matrikelnummer}}{% - Alias für \Macro*{matriculationnumber} +\Replace{v2.00}{\Macro{dateofbirth}}{\Macro{birthday}} +\begin{Declaration}[v2.00]{\Macro{birthday}\Parameter{Geburtsdatum}}{% + \see*{\Macro*{dateofbirth}'page'}% } -\begin{Declaration}{\Macro{enrolmentyear}\Parameter{Immatrikulationsjahr}}{% - Alias für \Macro*{matriculationyear}% +\Replace{v2.00}{\Macro{placeofbirth}}{\Macro{birthplace}} +\begin{Declaration}[v2.00]{\Macro{birthplace}\Parameter{Geburtsort}}{% + \see*{\Macro*{placeofbirth}'page'}% +} +\Replace{v2.00}{\Macro{issuedate}}{\Macro{startdate}} +\begin{Declaration}[v2.00]{\Macro{startdate}\Parameter{Ausgabedatum}}{% + \emph{entfällt}, \see*{\Macro*{issuedate}'page'}% } \printdeclarationlist*% % @@ -146,25 +224,43 @@ \chapter{Obsolete sowie vollständig entfernte Optionen und Befehle} \end{Declaration} \end{Declaration} \end{Declaration} +\end{Declaration} -\begin{Declaration}{\Term{submissiontext}}{umbenannt, siehe \Term*{datetext}} -\begin{Declaration}{\Term{birthdaytext}}{% - umbenannt, siehe \Term*{dateofbirthtext}% +\Replace{v2.00}{\Term{matriculationnumbername}}{\Term{studentidname}} +\begin{Declaration}[v2.00]{\Term{studentidname}}{% + \emph{entfällt}, \see*{\Term*{matriculationnumbername}'page'}% } -\begin{Declaration}{\Term{birthplacetext}}{% - umbenannt, siehe \Term*{placeofbirthtext}% +\Replace{v2.00}{\Term{matriculationyearname}}{\Term{enrolmentname}} +\begin{Declaration}[v2.00]{\Term{enrolmentname}}{% + \emph{entfällt}, \see*{\Term*{matriculationyearname}'page'}% } -\begin{Declaration}{\Term{studentidname}}{% - umbenannt, siehe \Term*{matriculationnumbername}% +\Replace{v2.00}{\Term{datetext}}{\Term{submissiontext}} +\begin{Declaration}[v2.00]{\Term{submissiontext}}{% + \emph{entfällt}, \see*{\Term*{datetext}'page'}% } -\begin{Declaration}{\Term{enrolmentname}}{% - umbenannt, siehe \Term*{matriculationyearname}% +\Replace{v2.00}{\Term{dateofbirthtext}}{\Term{birthdaytext}} +\begin{Declaration}[v2.00]{\Term{birthdaytext}}{% + \emph{entfällt}, \see*{\Term*{dateofbirthtext}'page'}% } -\begin{Declaration}{\Term{supervisorIIname}}{% - umbenannt, siehe \Term*{supervisorothername}% +\Replace{v2.00}{\Term{placeofbirthtext}}{\Term{birthplacetext}} +\begin{Declaration}[v2.00]{\Term{birthplacetext}}{% + \emph{entfällt}, \see*{\Term*{placeofbirthtext}'page'}% } -\begin{Declaration}{\Term{defensetext}}{% - umbenannt, siehe \Term*{defensedatetext}% +\Replace{v2.00}{\Term{supervisorothername}}{\Macro{supervisorIIname}} +\begin{Declaration}[v2.00]{\Macro{supervisorIIname}}{% + \emph{entfällt}, \see*{\Term*{supervisorothername}'page'}% +} +\Replace{v2.00}{\Term{defensedatetext}}{\Term{defensetext}} +\begin{Declaration}[v2.00]{\Term{defensetext}}{% + \emph{entfällt}, \see*{\Term*{defensedatetext}'page'}% +} +\Replace{v2.00}{\Term{issuedatetext}}{\Term{starttext}} +\begin{Declaration}[v2.00]{\Term{starttext}}{% + \emph{entfällt}, \see*{\Term*{issuedatetext}'page'} +} +\Replace{v2.00}{\Term{duedatetext}}{\Term{duetext}} +\begin{Declaration}[v2.00]{\Term{duetext}}{% + \emph{entfällt}, \see*{\Term*{duedatetext}'page'}% } \printdeclarationlist*% % @@ -176,11 +272,34 @@ \chapter{Obsolete sowie vollständig entfernte Optionen und Befehle} \end{Declaration} \end{Declaration} \end{Declaration} +\end{Declaration} +\end{Declaration} + + +\subsection{Änderungen für \TUDScript~v2.02} +\vskip-\lastskip +\Replace[macros]{v2.02}{\Length{pageheadingsvskip}}{% + \Length{chapterheadingvskip}% +} +\begin{Declaration}[v2.02]{\Length{chapterheadingvskip}} +\printdeclarationlist*[% + \emph{entfällt}, \see*{\Length*{pageheadingsvskip}'page'}% +]% +Die vertikale Positionierung von Überschriften wurde aufgeteilt. Zum einen kann +diese für Titel-, Teile- und Kapitelseiten (\Option*{chapterpage}[true]) über +die Länge \Length*{pageheadingsvskip} geändert werden. Für Kapitelüberschriften +(\Option*{chapterpage}[false]) sowie den Titelkopf (\Option*{titlepage}[false]) +kann dies unabhängig davon mit \Length*{headingsvskip} erfolgen. +\end{Declaration} -\begin{Declaration}{\Macro{degree}\OParameter{Kurzform}\Parameter{Grad}}{% - umbenannt, siehe \Macro*{graduation}% +\Replace[macros]{v2.02}{\Macro{graduation}}{\Macro{degree}} +\begin{Declaration}[v2.02]{\Macro{degree}\OParameter{Abk.}\Parameter{Grad}}{% + \see*{\Macro*{graduation}'page'}% +} +\Replace[terms]{v2.02}{\Term{graduationtext}}{\Term{degreetext}} +\begin{Declaration}[v2.02]{\Term{degreetext}}{% + \see*{\Term*{graduationtext}'page'}% } -\begin{Declaration}{\Term{degreetext}}{umbenannt, siehe \Term*{graduationtext}} \printdeclarationlist*% % Der Befehl wurde zur Erhöhung der Kompatibilität mit anderen Paketen umbenannt, @@ -188,14 +307,17 @@ \chapter{Obsolete sowie vollständig entfernte Optionen und Befehle} \end{Declaration} \end{Declaration} -\begin{Declaration}{\Macro{restriction}\OLParameter{Firma}}{% - umbenannt, siehe \Macro*{blocking}% +\Replace[macros]{v2.02}{\Macro{blocking}}{\Macro{restriction}} +\begin{Declaration}[v2.02]{\Macro{restriction}\OLParameter{Firma}}{% + \see*{\Macro*{blocking}'page'}% } -\begin{Declaration}{\Term{restrictionname}}{% - umbenannt, siehe \Term*{blockingname} +\Replace[terms]{v2.02}{\Term{blockingname}}{\Term{restrictionname}} +\begin{Declaration}[v2.02]{\Term{restrictionname}}{% + \see*{\Term*{blockingname}'page'}% } -\begin{Declaration}{\Term{restrictiontext}}{% - umbenannt, siehe \Term*{blockingtext}% +\Replace[terms]{v2.02}{\Term{blockingtext}}{\Term{restrictiontext}} +\begin{Declaration}[v2.02]{\Term{restrictiontext}}{% + \see*{\Term*{blockingtext}'page'}% } \printdeclarationlist*% % @@ -205,102 +327,247 @@ \chapter{Obsolete sowie vollständig entfernte Optionen und Befehle} \end{Declaration} \end{Declaration} -\begin{Declaration}{\Macro{confirmationandrestriction}}{% - entfällt, siehe \Macro*{declaration}% +\minisec{Änderungen im Paket \Package*{tudscrsupervisor}} +\vskip-\lastskip +\Replace[macros]{v2.02}{\Macro{discipline}}{\Macro{branch}} +\begin{Declaration}[v2.02]{\Macro{branch}\Parameter{Studienrichtung}}{% + \emph{entfällt}, \see*{\Macro*{discipline}'page'}% } -\begin{Declaration}{\Macro{restrictionandconfirmation}}{% - entfällt, siehe \Macro*{declaration}% +\Replace[terms]{v2.02}{\Term{disciplinename}}{\Term{branchname}} +\begin{Declaration}[v2.02]{\Term{branchname}}{% + \emph{entfällt}, \see*{\Term*{disciplinename}'page'}% } \printdeclarationlist*% % -Die beiden Befehle entfallen, stattdessen sollte entweder der Befehl -\Macro*{declaration} oder die Umgebung \Environment{declarations} zusammen mit -den Befehlen \Macro*{confirmation} und \Macro*{blocking} verwendet werden, -wobei sich diese in der Umgebung in beliebiger Reihenfolge anordnen lassen. +Für die \taskname{} wurden der Befehl sowie der dazugehörige Bezeichner +umbenannt. \end{Declaration} \end{Declaration} -\begin{Declaration}{\Macro{location}\Parameter{Ort}}{% - siehe \Macro*{place} sowie auch Parameter \Key*{\Macro{declaration}}{place}% +\Replace[macros]{v2.02}{\Macro{contactperson}}{\Macro{contact}} +\begin{Declaration}[v2.02]{\Macro{contact}\Parameter{Kontaktperson(en)}}{% + \emph{entfällt}, \see*{\Macro*{contactperson}'page'}% +} +\Replace[terms]{v2.02}{\Term{contactpersonname}}{\Term{contactname}} +\begin{Declaration}[v2.02]{\Term{contactname}}{% + \emph{entfällt}, \see*{\Term*{contactpersonname}'page'}% +} +\Replace[macros]{v2.02}{\Macro{telephone}}{\Macro{phone}} +\begin{Declaration}[v2.02]{\Macro{phone}\Parameter{Telefonnummer}}{% + \emph{entfällt}, \see*{\Macro*{telephone}'page'}% +} +\Replace[macros]{v2.02}{\Macro{emailaddress}}{\Macro{email}} +\begin{Declaration}[v2.02]{\Macro{email}\Parameter{E-Mail-Adresse}}{% + \emph{entfällt}, \see*{\Macro*{emailaddress}'page'}% } \printdeclarationlist*% -In Anlehnung an andere \hologo{LaTeX}-Pakete und "~Klassen wurde -\Macro*{location} in \Macro*{place} umbenannt. +% +Alle genannten Befehle und Bezeichner wurden für den \noticename{} umbenannt. +\end{Declaration} +\end{Declaration} +\end{Declaration} \end{Declaration} +\subsection{Änderungen für \TUDScript~v2.03} +\vskip-\lastskip +\Replace[options]{v2.03}{\Option{cdgeometry}}{\Option{geometry}}% +\begin{Declaration}[v2.03]{\Option{geometry}[\PBoolean]} +\printdeclarationlist*[\see*{\Option*{cdgeometry}'page'}]% +% +Die Option \Option*{geometry} wurde aus Gründen der Konsistenz und dem +Vermeiden eines möglichen Konfliktes mit einer späteren \KOMAScript-Version +umbenannt. An der Funktionalität wurde nichts geändert. +\end{Declaration} +\Replace[options]{v2.03}{\Option{cdmath}}{\Option{sansmath}}% +\begin{Declaration}[v2.03]{\Option{sansmath}[\PBoolean]} +\printdeclarationlist*[\see*{\Option*{cdmath}'page'}]% +% +Die Option \Option*{sansmath} wurde aus Gründen der Konsistenz umbenannt. +Zusätzlich wurde die Funktionalität erweitert. +\end{Declaration} -\minisec{\taskname{} und \noticename} -Die Umgebung für die Erstellung einer Aufgabenstellung für eine -wissenschaftliche Arbeit wurde in das Paket \Package{tudscrsupervisor} -ausgelagert. Dieses muss für die Verwendung der Umgebung \Environment*{task} -und der daraus abgeleiteten standardisierten Form zwingend geladen werden. +\Replace[options]{v2.03}{\Option{cdhead}}{\Option{barfont},\Option{widehead}} +\begin{Declaration}[v2.03]{\Option{barfont}[\PSet]} +\begin{Declaration}[v2.03]{\Option{widehead}[\PBoolean]} +\printdeclarationlist*[\see*{\Option*{cdhead}'page'}]% +% +Die Funktionalitäten der Optionen \Option*{barfont} und \Option*{widehead} +wurden in der Option \Option*{cdhead} zusammengefasst und erweitert. +\end{Declaration} +\end{Declaration} -\begin{Declaration}{\Option{cdtask}[\PSet]}{entfällt, siehe \Environment*{task}} -\begin{Declaration}{\Option{taskcompact}[\PBoolean]}{entfällt} -\begin{Declaration}{\Macro{tasks}\Parameter{Ziele}\Parameter{Schwerpunkte}}{% - umbenannt, siehe \Macro*{taskform}% + + +\section{Das Paket \Package{tudscrcomp} -- Umstieg von anderen Klassen} +\begin{Declaration*}{\Package{tudscrcomp}} +\index{Version!v1.0|(}% +\index{Kompatibilität!Version v1.0|(}% +\index{Kompatibilität!\Class{tudbook}|(}% +% +\noindent\Attention{% + Sollten Sie eine der Klassen \Class{tudbook}, \Class{tudbeamer}, + \Class{tudletter}, \Class{tudfax}, \Class{tudhaus} sowie \Class{tudform} oder + \TUDScript in der Version~v1.0 nie genutzt haben, können Sie dieses + \autorefname ohne Weiteres überspringen. Sämtliche hier vorgestellten + Optionen und Befehle sind in der aktuellen Version von \TUDScript obsolet. +} + +\bigskip\noindent +Zu Beginn der Entwicklung von \TUDScript bildete die Klasse \Class{tudbook} +die Basis. Ziel war es, sämtliche Funktionalitäten dieser beizubehalten und +zusätzlich den vollen Funktionsumfang der \KOMAScript-Klassen nutzbar zu +machen. Bei der kompletten Neuimplementierung der \TUDScript-Klassen wurde sehr +viel verändert und verbessert. Einige der Optionen und Befehle waren jedoch +bereits in der \TUDScript-Version~v1.0 Relikte, um die Kompatibilität zur +\Class{tudbook}-Klasse und ihren Derivaten zu gewährleisten. Mit \TUDScript in +der Version~v2.00 wurden einige aus Gründen der Konsistenz lediglich umbenannt, +andere wiederum wurden vollständig entfernt oder über neue Befehle und Optionen +in ihrer Funktionalität ersetzt und erweitert. + +Das Paket \Package{tudscrcomp} dient der Überführung von alten Dokumenten, die +entweder mit der \Class{tudbook}-Klasse, ihren Derivaten oder mit \TUDScript in +der Version~v1.0 erstellt wurden, auf \TUDScript~\vTUDScript. Es werden einige +Optionen und Befehle bereitgestellt, welche von den alten Klassen definiert +wurden und das entsprechende Verhalten nachahmen. Damit soll die Kompatibilität +bei der Änderung der Dokumentklasse sichergestellt werden. Die Intention ist, +alte Dokumente möglichst schnell und einfach auf die \TUDScript-Klassen +portieren zu können. Des Weiteren ist beschrieben, wie sich die Funktionalität +ohne die Verwendung des Paketes mit den Mitteln von \TUDScript umsetzen lassen. +Für den Satz neuer Dokumente wird empfohlen, auf den Einsatz dieses Paketes +komplett zu verzichten und stattdessen die neuen Befehle zu nutzen. + +\begin{Declaration}{\Option{serifmath}}{% + identisch zu \Option*{cdmath}[false]% } -\begin{Declaration}{\Length{taskcolwidth}}{entfällt} \printdeclarationlist*% % -Die Klassenoption \Option*{cdtask} ist komplett entfernt worden, alle -Einstellungen, welche \Environment*{task} betreffen erfolgen direkt über das -optionale Argument der Umgebung. Die Variante eines kompakten Kopfes mit der -Option \Option*{taskcompact} wird nicht mehr bereitgestellt. Der Befehl -\Macro*{tasks} wurde in \Macro*{taskform} umbenannt und in der Funktionalität -erweitert. Die manuelle Einstellung der Spaltenbreite für den Kopf der -Aufgabenstellung mit \Length*{taskcolwidth} wurde aufgrund der verbesserten -automatischen Berechnung entfernt. -\end{Declaration} +Die Funktionalität wird durch die Option \Option*{cdmath} bereitgestellt. \end{Declaration} + +\begin{Declaration}{\Option{colortitle}}{% + identisch zu \Option*{cdtitle}[color]% +} +\begin{Declaration}{\Option{nocolortitle}}{% + identisch zu \Option*{cdtitle}[true]% +} +\printdeclarationlist*% +% +Die Funktionalität wird durch die Option \Option*{cdtitle} bereitgestellt. \end{Declaration} \end{Declaration} -\begin{Declaration}{\Macro{branch}\Parameter{Studienrichtung}}{% - umbenannt, siehe \Macro*{discipline}% +\begin{Declaration}{\Macro{einrichtung}\Parameter{Fakultät}}{% + identisch zu \Macro*{faculty} } -\begin{Declaration}{\Term{branchname}}{umbenannt, siehe \Term*{disciplinename}} -\begin{Declaration}{\Macro{startdate}\Parameter{Ausgabedatum}}{% - Alias für \Macro*{issuedate}% +\begin{Declaration}{\Macro{fachrichtung}\Parameter{Einrichtung}}{% + identisch zu \Macro*{department} } -\begin{Declaration}{\Macro{enddate}\Parameter{Abgabetermin}}{% - Alias für \Macro*{duedate}% +\begin{Declaration}{\Macro{institut}\Parameter{Institut}}{% + identisch zu \Macro*{institute} } -\begin{Declaration}{\Term{starttext}}{umbenannt, siehe \Term*{issuedatetext}} -\begin{Declaration}{\Term{duetext}}{umbenannt, siehe \Term*{duedatetext}} -\begin{Declaration}{\Term{focustext}}{umbenannt, siehe \Term*{focusname}} -\begin{Declaration}{\Term{objectivestext}}{% - umbenannt, siehe \Term*{objectivesname}% +\begin{Declaration}{\Macro{professur}\Parameter{Lehrstuhl}}{% + identisch zu \Macro*{chair} } \printdeclarationlist*% % -Alle genannten Befehle und Bezeichner wurden für die \taskname{} umbenannt. -\end{Declaration} -\end{Declaration} +Dies sind die deutschsprachigen Befehle für den Kopf im \CD. \end{Declaration} \end{Declaration} \end{Declaration} \end{Declaration} + +\begin{Declaration}{\Macro{moreauthor}\Parameter{Autorenzusatz}}{% + identisch zu \Macro*{authormore}% +} +\printdeclarationlist*% +% +Ursprünglich war diese Befehl für das Unterbringen aller möglichen, +zusätzlichen Autoreninformationen gedacht. Auch der Befehl \Macro*{authormore} +ist ein Rudiment davon. Empfohlen wird die Verwendung der Befehle +\Macro*{dateofbirth}, \Macro*{placeofbirth}, \Macro*{matriculationnumber} und +\Macro*{matriculationyear} sowie für die Aufgabenstellung einer +wissenschaftlichen Arbeit \Macro*{course} und \Macro*{discipline} aus dem Paket +\Package*{tudscrsupervisor}. \end{Declaration} + +\begin{Declaration}{\Macro{submitdate}\Parameter{Datum}}{% + identisch zu \Macro*{date}% +} +\printdeclarationlist*% +% +Die Funktionalität wird durch den erweiterten Standardbefehl \Macro*{date} +abgedeckt. \end{Declaration} -\begin{Declaration}{\Macro{contact}\Parameter{Kontaktperson(en)}}{% - umbenannt, siehe \Macro*{contactperson}% +\begin{Declaration}{\Macro{supervisorII}\Parameter{Name}}{% + identisch zur Verwendung von \Macro*{and} innerhalb von \Macro*{supervisor}% } -\begin{Declaration}{\Term{contactname}}{% - umbenannt, siehe \Term*{contactpersonname}% +\printdeclarationlist*% +% +Es ist \Macro*{supervisor}\PParameter{\PName{Name} \Macro*{and} \PName{Name}} +statt \Macro*{supervisorII}\Parameter{Name} zu verwenden. +\end{Declaration} + +\begin{Declaration}{\Macro{supervisedby}\Parameter{Bezeichnung}}{% + siehe \Term*{supervisorname}% } -\begin{Declaration}{\Macro{phone}\Parameter{Telefonnummer}}{% - umbenannt, siehe \Macro*{telephone}% +\begin{Declaration}{\Macro{supervisedIIby}\Parameter{Bezeichnung}}{% + siehe \Term*{supervisorothername}% } -\begin{Declaration}{\Macro{email}\Parameter{E-Mail-Adresse}}{% - umbenannt, siehe \Macro*{emailaddress}% +\begin{Declaration}{\Macro{submittedon}\Parameter{Bezeichnung}}{% + siehe \Term*{datetext}% } \printdeclarationlist*% % -Alle genannten Befehle und Bezeichner wurden für den \noticename{} umbenannt. +Zur Änderung der Bezeichnung der Betreuer sollten die sprachabhängigen +Bezeichner wie in \autoref{sec:localization} beschrieben angepasst werden. Eine +Verwendung der alten Befehle entfernt die Abhängigkeit der Bezeichner von der +verwendeten Sprache. \end{Declaration} \end{Declaration} \end{Declaration} + +\begin{Declaration}{\Option{ddcfooter}}{% + identisch zu \Option*{ddcfoot}[true]% +} +\printdeclarationlist*% +% +Die Funktionalität wird durch die Option \Option*{ddcfoot} bereitgestellt. \end{Declaration} + +\begin{Declaration}{\Macro{dissertation}} +\printdeclarationlist*% +% +Die Funktionalität kann durch die Befehle \Macro*{thesis}\PParameter{diss} und +\Macro*{referee} sowie die Bezeichner \Term*{refereename} und +\Term*{refereeothername} dargestellt werden. +\end{Declaration} + +\begin{Declaration}{\Macro{chapterpage}} +\printdeclarationlist*% +% +Durch diesen Befehl können Kapitelseiten konträr zur eigentlichen Einstellung +aktiviert oder deaktiviert werden. Prinzipiell ist dies auch durch eine +Änderung der Option \Option*{chapterpage} möglich. Allerdings wird davon +abgeraten, da dies zu einem inkonsistenten Layout innerhalb des Dokumentes +führt. +\end{Declaration} + +\begin{Declaration}{\Environment{theglossary}[\OParameter{Präambel}]} +\begin{Declaration}{\Macro{glossitem}\Parameter{Begriff}} +\printdeclarationlist*% +% +Die \Class{tudbook}-Klasse stellt eine rudimentäre Umgebung für ein Glossar +bereit. Allerdings gibt es dafür bereits zahlreiche und besser implementierte +Pakete. Daher wird für diese Umgebung keine Portierung vorgenommen, sondern +lediglich die ursprüngliche Definition übernommen. Allerdings sein an dieser +Stelle auf wesentlich bessere Lösungen wie beispielsweise das Paket +\Package{glossaries} oder~-- mit Abstrichen~-- das nicht ganz so umfangreiche +Paket \Package{nomencl} verwiesen. +\end{Declaration} +\end{Declaration} +\index{Version!v1.0|)} +\index{Kompatibilität!Version v1.0|)} +\index{Kompatibilität!\Class{tudbook}|)} +\end{Declaration*} \ No newline at end of file diff --git a/source/doc/tudscr-packages.tex b/source/doc/tudscr-packages.tex index 591b7c43..2c144219 100644 --- a/source/doc/tudscr-packages.tex +++ b/source/doc/tudscr-packages.tex @@ -8,7 +8,7 @@ \subsection{Erforderliche Pakete bei der Schriftinstallation} Für die Installation der Schriften sind die folgend genannten Pakete von \emph{essentieller} Bedeutung und daher \emph{zwingend} notwendig. Das Vorhandensein dieser wird durch die jeweiligen Schriftinstallationsskripte -(siehe~\autoref{sec:install}) geprüft und die Installation beim Fehlen eines +(\see*{\autoref{sec:install}}) geprüft und die Installation beim Fehlen eines oder mehrerer Pakete mit einer entsprechenden Warnung abgebrochen. % \begin{packages} @@ -26,6 +26,7 @@ \subsection{Erforderliche Pakete bei der Schriftinstallation} Zusätzlich werden die \texttt{Schreibmaschinenschriften} aus dem Paket \Package{lmodern} verwendet. + \subsection{Notwendige Pakete für die Verwendung der Hauptklassen} In diesem \autorefname werden alle Pakete genannt, die von den neuen Klassen zwingend benötigt und geladen werden, um den Anwender das mehrmalige Laden @@ -67,19 +68,16 @@ \subsection{Notwendige Pakete für die Verwendung der Hauptklassen} Es wird eine verbesserte Deklaration von Umgebungen ermöglicht, bei der auch beim Abschluss der Umgebung auf die übergebenen Parameter zugegriffen werden kann. Dies wird die Neugestaltung der \Environment{abstract}"=Umgebung - benötigt. Das Paket lädt \Package{trimspaces}, womit das Entfernen von - überflüssigen Leerraum um einen Strings ermöglicht wird. -\item[afterpage] - \ChangedAt{v2.02!\Package{afterpage}: Für Verwendung notwendig} - Der Befehl \Macro{afterpage}\Parameter{\dots} kann genutzt werden, um den - Inhalt aus dessen Argument direkt nach der Ausgabe der aktuellen Seite - auszuführen. Es wird für den Titelkopf im \CD für das zweispaltige Layout - benötigt (\autoref{sec:title}). + benötigt. +\item[trimspaces] + Bei mehreren Eingabefeldern für den Anwender werden die Argumente mithilfe + dieses Paketes um eventuell angegebene, unnötige Leerzeichen befreit. \end{packages} % -Möchten Sie eines der hier aufgezählten Pakete selber mit bestimmten Optionen -laden, so sollten diese bereits \emph{vor} der Definition der Dokumentklasse an -das Paket weitergereicht werden. +Möchten Sie eines der hier aufgezählten Pakete selber nutzen, es jedoch mit +bestimmten Optionen laden, so sollten diese bereits \emph{vor} der Definition +der Dokumentklasse an das Paket weitergereicht werden. Ein manuelles Laden +dieser Pakete ist nicht notwendig. % \begin{Example} Das Weiterreichen von Optionen an Pakete muss folgendermaßen erfolgen: @@ -93,6 +91,10 @@ \subsection{Notwendige Pakete für die Verwendung der Hauptklassen} \section{Durch \TUDScript direkt unterstütze Pakete} % +Wird eines der genannten Pakete geladen, so wird die Funktionalität von +\TUDScript durch dieses verbessert beziehungsweise erweitert oder es wird ein +Bugfix bereitgestellt. +% \begin{packages} \item[hyperref]\index{Lesezeichen}\index{Querverweise} Hiermit können in einem PDF-Dokument Lesezeichen, Querverweise und @@ -126,10 +128,8 @@ \section{Durch \TUDScript direkt unterstütze Pakete} \item[ragged2e]\index{Worttrennung} Das Paket verbessert den Flattersatz, indem für diesen die Worttrennung aktiviert wird. -\item[pagecolor]\index{Farben} - Mit dem Paket kann die Hintergrundfarbe der Seiten im Dokument geändert - werden. Nach der Ausgabe einer farbigen Titel"~, Teile"~, oder Kapitelseite - wird auf diese zurückgeschaltet. +\item[pdfpages] + Bugfix für die Einbindung von PDF"~Dateien ohne angegebene Seitenfarbe. \end{packages} @@ -258,8 +258,8 @@ \subsubsection{Typographie und Layout} nach dem Motto \enquote{viel hilft viel} verfahren werden. In diesem Dokument wurde als Faktor für den Zeilenabstand \Macro{setstretch}\PParameter{1.1} gewählt. Nach einer Einstellung des Zeilenabstandes sollte der Satzspiegel - unbedingt mit \Macro{recalctypearea} neu berechnet werden. Siehe dazu auch - \autoref{sec:tips:headings} sowie \autoref{sec:tips:headline}. + unbedingt mit \Macro{recalctypearea} neu berechnet werden. Weitere Tipps sind + in \autoref{sec:tips:headings} sowie \autoref{sec:tips:headline} zu finden. \item[csquotes]\index{Zitate} Das Paket stellt unter anderem den Befehl \Macro{enquote}\Parameter{Zitat} zur Verfügung, welcher Anführungszeichen in Abhängigkeit der gewählten @@ -277,12 +277,11 @@ \subsubsection{Typographie und Layout} Leerzeichen automatisch. In \autoref{sec:tips:xspace} ist die Definition eines solchen Befehls exemplarisch ausgeführt. \item[ellipsis]\index{Befehle!Deklaration} - In \hologo{LaTeX} folgten den Befehlen für Auslassungspunkte (\Macro{dots} - und \Macro{textellipsis}) \emph{immer} ein Leerzeichen. Dies kann unter - Umständen unerwünscht sein. Mit dem Paket \Package{ellipsis} wird das - folgende Leerzeichen~-- im Gegensatz zum Standardverhalten~-- nur gesetzt, - wenn ein Satzzeichen und kein Buchstabe folgt. Siehe dazu auch - \autoref{sec:tips:dots}. + In \hologo{LaTeX} folgen den Befehlen für Auslassungspunkte (\Macro{dots} und + \Macro{textellipsis}) \emph{immer} ein Leerzeichen. Dies kann unter Umständen + unerwünscht sein. Mit dem Paket \Package{ellipsis} wird das nachfolgende + Leerzeichen~-- im Gegensatz zum Standardverhalten~-- nur gesetzt, wenn ein + Satzzeichen und kein Buchstabe folgt, \seealso*{\autoref{sec:tips:dots}}. \item[xpunctuate]\index{Befehle!Deklaration} Die Funktionalität von \Package{xspace} wird um die Beachtung von Interpunktionen erweitert. @@ -373,16 +372,16 @@ \subsubsection{Schriften und Sonderzeichen} gestellt. \end{packages} % -Auch für die mathematischen Schriften gibt es einige nützliche Pakete. +Auch für die Mathematikschriften gibt es einige nützliche Pakete. Werden die +Schriften des \CDs genutzt, sei auf die Option \Option{cdmath} verwiesen. \index{Mathematiksatz!Schrift}\index{Schrift!Mathematiksatz} % \begin{packages} -\item[sansmath] +\item[sansmathfonts] Sollten die normalen \hologo{LaTeX}-Schriften Computer~Modern verwendet werden, kann man dieses Paket zum serifenlosen Setzen mathematischer - Ausdrücke nutzen. Werden die Schriften des \CDs der \TnUD zusammen mit den - \TUDScript-Hauptklassen verwendet, sei auf die Option \Option{sansmath} - verwiesen. + Ausdrücke nutzen. Ein alternatives Paket mit der gleichen Zielstellung ist + \Package{sansmath} \item[sfmath] Diese Paket verfolgt ein ähnliches Ziel, kann jedoch im Gegensatz zu \Package{sansmath} nicht nur für Computer~Modern sondern mit der @@ -804,7 +803,7 @@ \subsubsection{Die kleinen und großen Helfer\dots} Argumentes ist möglich. \item[xkeyval]\index{Befehle!Deklaration} \ChangedAt{v2.02!\Package{xkeyval}: Beschreibung hinzugefügt} - Das \KOMAScript{}"=Bundle lädt das Paket \Package{keyval}, um Optionen mit + Das \KOMAScript"=Bundle lädt das Paket \Package{keyval}, um Optionen mit einer Schlüssel"=Wert"=Syntax deklarieren zu können. Zusätzlich wird von \TUDScript das Paket \Package{kvsetkeys} geladen, um auf nicht definierte Schlüssel reagieren zu können. Die Schlüssel"=Wert"=Syntax kann auch für @@ -842,6 +841,13 @@ \subsubsection{Die kleinen und großen Helfer\dots} {~}{{\textasciitilde}}1 {ß}{{\ss}}1 } \end{Code}\vspace{-\baselineskip}% +\item[afterpage] + Der Befehl \Macro{afterpage}\Parameter{\dots} kann genutzt werden, um den + Inhalt aus dessen Argument direkt nach der Ausgabe der aktuellen Seite + auszuführen. +\item[pagecolor]\index{Farben} + Mit dem Paket kann die Hintergrundfarbe der Seiten im Dokument geändert + werden. \item[mwe]\index{Minimalbeispiel|!} \ChangedAt{v2.02!\Package{mwe}: Beschreibung hinzugefügt} Mit diesem Paket lassen sich sehr einfach Minimalbeispiele erzeugen, die diff --git a/source/doc/tudscr.tex b/source/doc/tudscr.tex index 0fea5fe0..adc1e003 100644 --- a/source/doc/tudscr.tex +++ b/source/doc/tudscr.tex @@ -10,13 +10,11 @@ {~}{{\textasciitilde}}1 {ß}{{\ss}}1 } -\usepackage[open,openlevel=0]{bookmark}[2011/12/02] - \begin{document} \faculty{http://tu-dresden.de/cd} -\date{17.12.2014} +\date{15.02.2015} \author{Falk Hanisch\thanks{\noexpand\Email{\tudscrmail}}} -\subject{\TUDScript{} \vTUDScript{} basierend auf \KOMAScript{} \vKOMAScript} +\subject{\TUDScript{} \vTUDScript{} basierend auf \KOMAScript{}} \title{% Ein \NoCaseChange{\hologo{LaTeXe}}-Bundle für Dokumente im~neuen \CD der \TnUD } @@ -38,18 +36,20 @@ pdfkeywords = {LaTeX, \TUDScript, Benutzerhandbuch},% }% \endgroup% +\renewcommand*\@pnumwidth{1.7em} \makeatother -\maketitle -\include{tudscr-preface} -\makeatletter -\renewcommand*\@pnumwidth{1.7em} -\makeatother +\ChangedAt*{% + v2.00!Generalüberholung und komplette Neuimplementierung von \TUDScript% +}% +\maketitle +\include{tudscr-preface} \tableofcontents - \include{tudscr-introduction} + + \setpartpreamble{% \begin{abstract} \hypersetup{linkcolor=red} @@ -57,24 +57,13 @@ Anwender alle verfügbaren Optionen, Umgebungen und Befehle, die über die Funktionalität von \KOMAScript{} hinausgehen. \end{abstract} - \ChangedAt*{% - v2.00!Generalüberholung und komplette Neuimplementierung von \TUDScript,% - v2.00!Schriften~-- insbesondere für den mathematischen Satz~-- verbessert,% - v2.00!Robustheit vieler Befehle und Optionen erhöht,% - v2.01!Unterschneidung (Kerning) der Ziffern für \Univers verbessert,% - v2.01b!Bugfix für falsche Berechnungen verschiedener Längen,% - v2.02!Befehle zur besseren Kompatibilität mit anderen Paketen umbenannt{,} - siehe dazu \manualhyperref{v2.02:Umbenennungen}{\enquote{Umbenennungen}} - in der Änderungsliste zur Version~v2.02,% - }% }% -\part{Das \TUDScript-Bundle} -\label{part:main} - +\part{Das \TUDScript-Bundle}\label{part:main} \include{tudscr-mainclasses} - \include{tudscr-bundle} + + \setpartpreamble{% \begin{abstract} \hypersetup{linkcolor=red} @@ -94,25 +83,29 @@ \part{Das \TUDScript-Bundle} jederzeit empfänglich. \end{abstract} } -\part{Ergänzungen und Hinweise} -\label{part:additional} - +\part{Ergänzungen und Hinweise}\label{part:additional} \include{tudscr-examples} - \include{tudscr-packages} - \include{tudscr-hints} + + \part{Anhang} \appendix - \include{tudscr-installation} - \include{tudscr-obsolete} - \include{tudscr-index} + + \ListOfToDo +\ToDo[imp,nxt]{% + verzögertes Laden der Pakete \Package{fontspec}, \Package{graphicx}, + \Package{tudscrcolor}, \Package{scrlayer-scrpage} und \Package{geometry} + auflösen bzw. ggf. dokumentieren% +}[v2.04] +\ToDo[rls]{dtx-Dateien der vorherigen Version mit WinMerge sichten} \ToDo[rls]{Layout und Umbrüche kontrollieren, insbesondere im Index} \ToDo[rls]{Datum in tudscr-version.dtx, Handbuch und README aktualisieren} +\ToDo[rls]{ggf. notwendige KOMA-Script-Version anpassen (LoadClass)} \end{document} diff --git a/source/doc/tutorials/test.tex b/source/doc/tutorials/test.tex deleted file mode 100644 index d669cd6b..00000000 --- a/source/doc/tutorials/test.tex +++ /dev/null @@ -1,252 +0,0 @@ -\RequirePackage[ngerman=ngerman-x-latest]{hyphsubst} -\documentclass[% - english,ngerman,% - geometry=no,DIV=12,automark,% -]{tudscrartcl} -\usepackage{selinput}\SelectInputMappings{adieresis={ä},germandbls={ß}} -\usepackage[T1]{fontenc} -\usepackage{lmodern} - -\usepackage{tudscrman} -\lstset{% - inputencoding=utf8,extendedchars=true, - literate=% - {ä}{{\"a}}1 {ö}{{\"o}}1 {ü}{{\"u}}1 - {Ä}{{\"A}}1 {Ö}{{\"O}}1 {Ü}{{\"U}}1 - {~}{{\textasciitilde}}1 {ß}{{\ss}}1 -} -\lstset{escapechar=§} -\TUDoptions{cdfont=false} -\KOMAoptions{headings=normal} - -\usepackage{tudscrsupervisor} -\usepackage{array} -\usepackage{tabu} -\usepackage{tabularx} -\usepackage{tabulary} -\usepackage{booktabs} -\usepackage{siunitx} -\sisetup{% - locale = DE,% - input-decimal-markers={,},% - input-ignore={.},% - group-separator={\,},% - group-minimum-digits=3% -} -\usepackage{xfrac} -\AfterPackage*{hyperref}{% - \usepackage[% - automake,% - xindy={language=german-din},% - acronym,% - symbols,% - nomain,% - translate=babel,% - nogroupskip,% - ]{glossaries} - \setStyleFile{\jobname-temp} - \renewcommand*{\glsglossarymark}[1]{} - \newignoredglossary{abbreviation} - \newcommand*\newabbreviation[4][]{% - \newacronym[type=abbreviation,#1]{#2}{#3}{#4}% - }% - \makeglossaries -} -\usepackage{csquotes} -\usepackage[backend=biber,style=alphabetic]{biblatex} -\addbibresource{\jobname.bib} -\DefineBibliographyStrings{ngerman}{urlseen = {Am:}} - -\usepackage{enumitem} - -\usepackage{caption} -\DeclareCaptionSubType[alph]{figure} -\DeclareCaptionSubType[alph]{table} -\usepackage{floatrow} -\renewcommand{\floatpagefraction}{0.7} - -\ifpdf - \usepackage{tikz} - \usetikzlibrary{chains} - \usetikzlibrary{decorations.markings} - \tikzset{on grid} -\fi - -\usepackage{pstricks,pst-node} - -\makeatletter -\newcommand*\pcolumnfuzz[1]{\pretocmd{\@endpbox}{\hfuzz=#1}{}{}} -\makeatother - -\usepackage[open,openlevel=0]{bookmark}[2011/12/02] - - -\ActivateWarningFilters[Tutorial]% -\begin{filecontents}{\jobname.bib} -@book{talbot2012, - author = {Nicola L. C. Talbot}, - title = {{\LaTeX} for Complete Novices}, - publisher = {Dickimaw Books}, - series = {Dickimaw {\LaTeX} Series}, - volume = {1}, - isbn = {978-1-909440-00-5}, - address = {Norfolk, UK}, - year = {2012}, - url = {http://www.dickimaw-books.com/latex/novices/}, - urldate = {2014-12-01}, -} -@book{talbot2013, - author = {Nicola L. C. Talbot}, - title = {Using {\LaTeX} to Write a PhD Thesis}, - publisher = {Dickimaw Books}, - series = {Dickimaw {\LaTeX} Series}, - volume = {2}, - isbn = {978-1-909440-02-9}, - address = {Norfolk, UK}, - year = {2013}, - url = {http://www.dickimaw-books.com/latex/thesis/}, - urldate = {2014-12-01}, -} -@online{reichert2012, - author = {Reichert, Axel and Voß, Herbert}, - title = {\LaTeX~-- Satz von Tabellen}, - organization = {Freie Universität Berlin}, - date = {2012-01-12}, - url = {http://userpage.fu-berlin.de/latex/Materialien/tabsatz.pdf}, - urldate = {2014-12-01} -} -@article{neubauer1996, - author = {Marion Neubauer}, - title = {Feinheiten bei wissenschaftlichen Publikationen~-- - Mikrotypographie"=Regeln, Teil~I}, - journaltitle = {Die \TeX{}nische Komödie}, - year = {1997}, - month = {2}, - volume = {4/96}, - pages = {23-40}, - url = {http://www.dante.de/tex/Dokumente/dtk-neubauer.pdf}, - urldate = {2014-12-01}, -} -@article{neubauer1997, - author = {Marion Neubauer}, - title = {Feinheiten bei wissenschaftlichen Publikationen~-- - Mikrotypographie"=Regeln, Teil~II}, - journaltitle = {Die \TeX{}nische Komödie}, - year = {1997}, - month = {5}, - volume = {1/97}, - pages = {25--44}, - url = {http://www.dante.de/tex/Dokumente/dtk-neubauer.pdf}, - urldate = {2014-12-01}, -} -@online{struckmann2007, - author = {Struckmann, Werner}, - title = {Einige typographische Grundregeln und ihre Umsetzung in \LaTeX}, - date = {2007-09-03}, - url = {http://www2.informatik.hu-berlin.de/sv/lehre/typographie.pdf}, - urldate = {2014-12-01} -} -@online{bier2009, - author = {Bier, Christoph}, - title = {typokurz~-- Einige wichtige typografische Regeln}, - date = {2009-05-21}, - url = {http://zvisionwelt.wordpress.com/downloads/#typokurz}, - urldate = {2014-12-01} -} -\end{filecontents} -\DeactivateWarningFilters[Tutorial]% - -\begin{document} -\title{% - Ein Anwenderleitfaden für das Erstellen einer wissenschaftlichen Abhandlung% -} -\author{Falk Hanisch\thanks{\noexpand\scriptsize\noexpand\Email{\tudscrmail}}} -\date{01.12.2014} -\makeatletter -\begingroup% - \def\and{, }% - \let\thanks\@gobble% - \let\footnote\@gobble% - \hypersetup{% - pdfauthor = {\@author},% - pdftitle = {\@title},% - pdfsubject = {Tutorial für \hologo{LaTeXe}},% - pdfkeywords = {LaTeX, \TUDScript, Tutorial, Anwenderleitfaden},% - }% -\endgroup% -\makeatother -\StartTutorial[% - \begin{abstract}\noindent - Der Versuch, ein allumfassendes Tutorial für eine wissenschaftliche Arbeit - zur Verfügung zu stellen gleicht der beschwerlichen Suche nach einer - eierlegenden Wollmilchsau. Es ist quasi nicht möglich, alle möglichen - Anforderungen an eine wissenschaftliche Arbeit in einem Dokument abzudecken. - Dennoch soll hier versucht werden, einen Großteil der für gewöhnlich - auftretenden Erfordernisse zu bearbeiten. - - Dieses Tutorial hat \emph{nicht} die Intention, \hologo{LaTeX}-Einsteigern - sämtliche Grundlagen zu erläutern. Vielmehr wird davon ausgegangen, dass Sie - bereits erste Erfahrungen mit \hologo{LaTeXe} gesammelt haben. Dennoch wird - versucht, alle Schritte möglichst leicht nachvollziehbar zu gestalten. Sollte - Ihnen beim Lesen und Durcharbeiten des Tutorials etwas auf- oder missfallen, - so dürfen Sie mich gerne per E-Mail kontaktieren. Auch Anregungen und Wünsche - dürfen sie mir gegenüber gerne kommunizieren. - - Für absolute Neueinsteiger gibt es einige freie Tutorials, welche die ersten - Schritte mit \hologo{LaTeXe} stark erleichtern. Sehr empfehlenswert ist die - ausführliche \hrfn{http://www.fadi-semmo.de/latex/workshop/}{Workshop-Reihe} - von Fadi~Semmo. Außerdem stellt Nicola~L.~C.~Talbot sehr gute Tutorials für - \hrfn{http://www.dickimaw-books.com/latex/novices/}{\hologo{LaTeX}-Novizen} - \cite{talbot2012} sowie - \hrfn{http://www.dickimaw-books.com/latex/thesis/}{Dissertationen} - \cite{talbot2013} zur freien Verfügung. - - In erster Linie ist dieser Leitfaden für Anwender gedacht, die für ihre - wissenschaftliche Arbeit eine \TUDScript"=Dokumentklasse verwenden wollen. - Das vorgestellte Vorgehen kann jedoch~-- natürlich mit gewissen Abstrichen~-- - auch mit anderen Klassen, insbesondere denen aus dem \KOMAScript"=Bundle, - umgesetzt werden. Viele der hier verwendeten Optionen und Befehle aus dem - \TUDScript-Bundle werden nur sporadisch in ihrer Grundfunktion erläutert. - Eine detaillierte Erläuterung lässt sich jedoch jederzeit sehr einfach über - die farbigen Hyperlinks im \manualhyperref{}{\TUDScript-Handbuch} öffnen. - Des Weiteren wird im Tutorial auf eine Vielzahl von Pakete verwiesen, deren - Dokumentation sich entweder über den für jedes Paket erzeugten Hyperlink auf - das \href{http://www.ctan.org/}{Comprehensive TeX Archive Network (CTAN)} - oder alternativ über die Kommandozeile respektive das Terminal mit dem Aufruf - \PValue{texdoc }\PName{Paket} direkt öffnen lässt. - - Der Anwenderleitfaden muss nicht zwingend vollständig nachvollzogen werden. - Dieser ist in einzelne Abschnitte untergliedert, damit Sie sich bestimmte - Aspekte erarbeiten können. Sollten Querbezüge zu den einzelnen Abschnitten - bestehen, werden diese auch genannt. Zu guter Letzt findet sich am Ende - dieses Dokumentes das komplette Tutorial als ausführbarer Quelltext. - \end{abstract} -] -\tableofcontents -\listoffigures -\listoftables - -\addsec{Index} -Da das Tutorial etwas umfangreicher ist, wird für alle erläuterten Optionen, -Umgebungen und Befehle ein Index erstellt. -\PrintIndex - -\FinishTutorial[% - Um das im kopierten Beispiel erstellte Literaturverzeichnis in das Dokument - einbinden zu können, bedarf es dem einmaligen Aufruf von \Application{biber} - nach dem ersten Durchlauf von \hologo{pdfLaTeX}. Dies erfolgt mit dem Aufruf - \PValue{biber}~\PName{Dateiname}. Danach ist ein weiteres mal die Verwendung - von \PValue{pdflatex}~\PName{Dateiname} notwendig. - - Für das Erstellen von Abkürzungs- und Symbolverzeichnis sollte das mehrmalige - Ausführen von \PValue{pdflatex}~\PName{Dateiname} vollkommen ausreichen. In - diesem Fall werden die Einträge mit \Application{makeindex} sortiert. Soll - stattdessen \Application{xindy} die Sortierung durchführen, muss beim Laden - von \Package{glossaries} die entsprechende Paketoption aktiviert werden. Für - diesen Fall sollte nach der Verwendung von \hologo{pdfLaTeX} der Aufruf des - Perl"=Skriptes \PValue{makeglossaries}~\PName{Dateiname} erfolgen, was - allerdings nur mit \Distribution{\hologo{TeX}~Live} ohne weiteres Zutun - möglich ist. Nutzer von \Distribution{\hologo{MiKTeX}} müssen das Sortieren - mit \Application{xindy} händisch anstoßen. -] -\end{document} diff --git a/source/install/tudscr-metrics.dtx b/source/install/tudscr-metrics.dtx index 51a8a06c..831b036d 100644 --- a/source/install/tudscr-metrics.dtx +++ b/source/install/tudscr-metrics.dtx @@ -1,4 +1,4 @@ -% \CheckSum{1183} +% \CheckSum{1187} % \iffalse meta-comment % ====================================================================== % @@ -46,7 +46,7 @@ %<*driver> \ifx\ProvidesFile\undefined\def\ProvidesFile#1[#2]{}\fi \ProvidesFile{tudscr-metrics.dtx}[% - 2014/11/18 v2.02 TUD-KOMA-Script font metrics% + 2015/01/22 v2.03 TUD-KOMA-Script font metrics% ] \RequirePackage[ngerman=ngerman-x-latest]{hyphsubst} \documentclass[english,ngerman]{tudscrdoc} @@ -84,7 +84,7 @@ \input fontinst.sty \needsfontinstversion{1.933} % \end{macrocode} -% Zuerst werden die Schriften aus den Paketen \pkg{cmbright} und %\pkg{iwona}, +% Zuerst werden die Schriften aus den Paketen \pkg{cmbright} und \pkg{iwona}, % welche durch das überlagerte Installationsskript bereits mit \texttt{tftopl} % in das .pl-Format gewandelt wurden, in das .mtx-Format von \pkg{fontinst} % gewandelt. diff --git a/source/install/tudscr-scripts.dtx b/source/install/tudscr-scripts.dtx index 4c488712..ad4ff10e 100644 --- a/source/install/tudscr-scripts.dtx +++ b/source/install/tudscr-scripts.dtx @@ -1,4 +1,4 @@ -% \CheckSum{442} +% \CheckSum{439} % \iffalse meta-comment % ====================================================================== % @@ -46,7 +46,7 @@ %<*driver> \ifx\ProvidesFile\undefined\def\ProvidesFile#1[#2]{}\fi \ProvidesFile{tudscr-scripts.dtx}[% - 2014/10/14 v2.02 TUD-KOMA-Script installation scripts% + 2015/02/12 v2.03 TUD-KOMA-Script installation scripts% ] \RequirePackage[ngerman=ngerman-x-latest]{hyphsubst} \documentclass[english,ngerman]{tudscrdoc} @@ -65,6 +65,8 @@ % % \selectlanguage{ngerman} % +% \changes{v2.03}{2015/01/23}{\pkg{mweights} unnötig}%^^A +% % \section{Installationsskripte} % % Hier werden die Installationsskripte für Windows und Linux automatisch @@ -116,16 +118,16 @@ rem Tex Live 2013 rem Tex Live 2014 rem echo. -echo ======================================================================= +echo ===================================================================== % \iffalse %<*full> % \fi -echo Installation TUD-KOMA-Script-Bundle + TUD-CD-Schriften unter Windows +echo Installation TUD-KOMA-Script + TUD-CD-Schriften unter Windows % \iffalse % %<*update> % \fi -echo Update TUD-KOMA-Script-Bundle unter Windows +echo Update TUD-KOMA-Script unter Windows % \iffalse % %<*font> @@ -135,7 +137,7 @@ echo Installation TUD-CD-Schriften unter Windows % %<*uninstall> % \fi -echo Deinstallation TUD-KOMA-Script-Bundle unter Windows +echo Deinstallation TUD-KOMA-Script unter Windows % \iffalse % % \fi @@ -181,16 +183,10 @@ call:checkpackage "cmbright.sty" call:checkpackage "iwona.sty" % \iffalse % -%<*(full|update)&!old> -% \fi -call:checkpackage "mweights.sty" -% \iffalse -% % \fi if "%missing%" == "true" goto :abort tex --version> distrib.tmp set /p distrib=< distrib.tmp -% kpsewhich --var-value=TEXMFHOME> texmfpath.tmp set /p texmfpath=< texmfpath.tmp if "%texmfpath%"=="" ( @@ -199,13 +195,12 @@ if "%texmfpath%"=="" ( echo !texmfpath!> texmfpath.tmp endlocal ) -%<*!uninstall> :MiKTeX echo %distrib% | find "MiKTeX"> nul if errorlevel 1 goto :TeXLive set distrib="MiKTeX" echo MiKTeX-Distribution aktiv - echo ======================================================================= + echo ===================================================================== echo. goto :resume :TeXLive @@ -213,17 +208,17 @@ if "%texmfpath%"=="" ( if errorlevel 1 goto :nothing set distrib="TeXLive" echo TeX Live-Distribution aktiv - echo ======================================================================= + echo ===================================================================== echo. goto :resume :nothing echo weder TeX Live noch MiKTeX gefunden, Abbruch der Installation - echo ======================================================================= + echo ===================================================================== echo. goto :end :resume echo. - echo ======================================================================= + echo ===================================================================== % \iffalse %<*full> % \fi @@ -254,7 +249,7 @@ if "%texmfpath%"=="" ( echo %texmfpath% echo. :proof_userinput - echo ======================================================================= + echo ===================================================================== echo. echo Soll das Verzeichnis %texmfpath% genutzt werden? if not exist "%texmfpath%" ( @@ -279,7 +274,7 @@ if "%texmfpath%"=="" ( goto proof_userinput :install echo. - echo ======================================================================= + echo ===================================================================== % \iffalse %<*full> % \fi @@ -298,7 +293,7 @@ if "%texmfpath%"=="" ( % % \fi echo %texmfpath% - echo ======================================================================= + echo ===================================================================== echo. set /p texmfpath=< texmfpath.tmp if not exist "%texmfpath%" mkdir "%texmfpath%" @@ -306,57 +301,47 @@ if "%texmfpath%"=="" ( % %<*uninstall> % \fi -set /p texmfpath=< texmfpath.tmp -kpsewhich tudscrbase.sty --path=%texmfpath%/tex/latex/tudscr> texmfpath.tmp -set texmfpath= -set /p texmfpath=< texmfpath.tmp -del texmfpath.tmp> nul -if "%texmfpath%"=="" ( - echo ======================================================================= - echo TUD-KOMA-Script lokal nicht gefunden, Abbruch der Deinstallation - echo ======================================================================= - goto:showpaths +kpsewhich --var-value=TEXMFDIST> texmfpath.tmp +set /p texmfdist=< texmfpath.tmp +kpsewhich tudscrbase.sty --all> texmfpath.tmp +setlocal enabledelayedexpansion +for /f "tokens=*" %%f in (texmfpath.tmp) do ( + set "texmfpath=%%f" + if "%%f"=="!texmfpath:%texmfdist%=!" ( + set texmfpath=!texmfpath:tudscrbase.sty=! + echo ===================================================================== + echo Soll TUD-KOMA-Script aus folgendem Pfad entfernt werden? + echo !texmfpath! + echo ===================================================================== + echo. + echo [j]a ^(ENTER^) / [n]ein: + echo. + set /p w= + if /i "!w!"=="" call:uninstall "!texmfpath!" + if /i "!w!"=="j" call:uninstall "!texmfpath!" + echo. + ) ) -set texmfpath=%texmfpath:tudscrbase.sty=% -echo ======================================================================= -echo TUD-KOMA-Script wird aus folgendem Pfad entfernt: -echo %texmfpath% -echo ======================================================================= -echo. -echo [j]a (ENTER) / [n]ein: -echo. -set /p w= -if /i "%w%"=="" goto uninstall -if /i "%w%"=="j" goto uninstall -echo. -echo ======================================================================= -echo Abbruch der Deinstallation -echo ======================================================================= -goto:showpaths -:uninstall -cd %texmfpath% -rmdir /s /q logo> nul -del *.cls> nul -del *.sty> nul -cd ..\..\.. -if exist doc\latex\tudscr rmdir /s /q doc\latex\tudscr> nul -if exist source\latex\tudscr rmdir /s /q source\latex\tudscr> nul +endlocal +del texmfpath.tmp> nul texhash -echo ======================================================================= -echo Die Deinstallation wird beendet. -echo ======================================================================= -:showpaths -echo. -echo ======================================================================= -echo TUD-KOMA-Script ist noch in folgenden Pfaden existent: -echo. -kpsewhich tudscrbase.sty --all -echo. -echo ======================================================================= +echo ===================================================================== +echo Es wurde keine (weitere) lokale Nutzerinstallation von +echo TUD-KOMA-Script gefunden. Die Deinstallation wird beendet. +echo ===================================================================== echo. pause echo. exit 0 +:uninstall + cd %~1 + if exist logo rmdir /s /q logo> nul + del *.cls> nul + del *.sty> nul + cd ..\..\.. + if exist doc\latex\tudscr rmdir /s /q doc\latex\tudscr> nul + if exist source\latex\tudscr rmdir /s /q source\latex\tudscr> nul + goto:eof % \iffalse % %<*!uninstall> @@ -429,9 +414,9 @@ exit 0 copy DINBd___.pfb converted\0m6b8a.pfb> nul copy DINBd___.afm converted\0m6b8a.afm> nul echo. - echo ======================================================================= + echo ===================================================================== echo Virtuelle Schriften erzeugen. (Dies kann einen Moment dauern) - echo ======================================================================= + echo ===================================================================== echo. cd converted echo 00/19 @@ -500,9 +485,9 @@ exit 0 % % \fi echo. - echo ======================================================================= + echo ===================================================================== echo Konvertierung abgeschlossen. - echo ======================================================================= + echo ===================================================================== echo. % \iffalse %<*old> @@ -640,7 +625,7 @@ exit 0 goto :end :end echo. - echo ======================================================================= + echo ===================================================================== % \iffalse %<*full|font> % \fi @@ -653,7 +638,7 @@ exit 0 % \iffalse % % \fi - echo ======================================================================= + echo ===================================================================== % \iffalse %<*!old> % \fi @@ -666,7 +651,7 @@ exit 0 % % \fi echo ueber den Konsolenaufruf 'texdoc tudscr' zu finden. - echo ======================================================================= + echo ===================================================================== % \iffalse % % \fi @@ -678,9 +663,9 @@ exit 0 exit 0 :abort echo. - echo ======================================================================= + echo ===================================================================== echo Abbruch der Installation, temporaere Dateien werden geloescht. - echo ======================================================================= + echo ===================================================================== echo. pause cd /d %~dp0 @@ -693,13 +678,13 @@ exit 0 ) goto:eof :missingfile - echo ======================================================================= + echo ===================================================================== echo. echo Die Datei %~1 wurde nicht gefunden. Diese wird fuer die echo Installation zwingend benoetigt. Bitte kopieren Sie %~1 - echo in das Verzeichnis des Skriptes und fuehren dieses danach erneut aus. + echo in das Verzeichnis des Skriptes und fuehren dieses abermals aus. echo. - echo ======================================================================= + echo ===================================================================== goto:eof :checkpackage kpsewhich %~1> package.tmp @@ -710,13 +695,13 @@ exit 0 ) goto:eof :missingpackage - echo ======================================================================= + echo ===================================================================== echo. echo Das LaTeX-Paket %~1 wurde nicht gefunden. Dieses wird fuer echo die Schriftinstallation zwingend benoetigt. Bitte %~1 - echo installieren und danach dieses Skript erneut ausfuehren. + echo installieren und danach dieses Skript abermals ausfuehren. echo. - echo ======================================================================= + echo ===================================================================== goto:eof % \iffalse % @@ -798,13 +783,13 @@ checkfile() } missingfile() { - echo ======================================================================= + echo ===================================================================== echo echo Die Datei $1 wurde nicht gefunden. Diese wird fuer die echo Installation zwingend benoetigt. Bitte kopieren Sie $1 - echo in das Verzeichnis des Skriptes und fuehren dieses danach erneut aus. + echo in das Verzeichnis des Skriptes und fuehren dieses abermals aus. echo - echo ======================================================================= + echo ===================================================================== } checkpackage() { @@ -816,20 +801,20 @@ checkpackage() } missingpackage() { - echo ======================================================================= + echo ===================================================================== echo echo Das LaTeX-Paket $1 wurde nicht gefunden. Dieses wird fuer echo die Schriftinstallation zwingend benoetigt. Bitte $1 - echo installieren und danach dieses Skript erneut ausfuehren. + echo installieren und danach dieses Skript abermals ausfuehren. echo - echo ======================================================================= + echo ===================================================================== } abort() { echo - echo ======================================================================= + echo ===================================================================== echo Abbruch der Installation, temporaere Dateien werden geloescht. - echo ======================================================================= + echo ===================================================================== echo cd .. rm -rf tudscrtemp @@ -842,16 +827,16 @@ abort() % % \fi echo -echo ======================================================================= +echo ===================================================================== % \ifflse %<*full> % \fi -echo Installation TUD-KOMA-Script-Bundle + TUD-CD-Schriften unter Unix +echo Installation TUD-KOMA-Script + TUD-CD-Schriften unter Unix % \iffalse % %<*update> % \fi -echo Update TUD-KOMA-Script-Bundle unter Unix +echo Update TUD-KOMA-Script unter Unix % \iffalse % %<*font> @@ -861,7 +846,7 @@ echo Installation TUD-CD-Schriften unter Unix % %<*uninstall> % \fi -echo Deinstallation TUD-KOMA-Script-Bundle unter Unix +echo Deinstallation TUD-KOMA-Script unter Unix % \iffalse % % \fi @@ -903,11 +888,6 @@ checkpackage "cmbright.sty" checkpackage "iwona.sty" % \iffalse % -%<*(full|update)&!old> -% \fi -checkpackage "mweights.sty" -% \iffalse -% % \fi if $missing ; then abort @@ -936,26 +916,19 @@ echo Installation der TUD-CD-Schriften in den lokalen Benutzerpfad: echo echo $texmfpath echo -echo ======================================================================= +echo ===================================================================== rm -rf tudscrtemp mkdir -p tudscrtemp/converted % \iffalse % %<*uninstall> % \fi -texmfpath=$(kpsewhich --var-value=TEXMFHOME) -if [ -z "$texmfpath" ]; then - texmfpath=$(kpsewhich --var-value=TEXMFLOCAL) -fi -texmfpath=$(kpsewhich tudscrbase.sty --path=$texmfpath/tex/latex/tudscr) -if [ -z "$texmfpath" ]; then - echo ======================================================================= - echo TUD-KOMA-Script lokal nicht gefunden, Abbruch der Deinstallation - echo ======================================================================= -else - texmfpath=$(echo $texmfpath|rev|cut -c15-|rev) - cd $texmfpath - rm -rf logo +uninstall() +{ + cd $1 + if [ -d logo ]; then + rm -rf logo + fi rm -f *.cls rm -f *.sty cd ../../.. @@ -965,18 +938,32 @@ else if [ -d source/latex/tudscr ]; then rm -rf source/latex/tudscr fi - texhash - echo ======================================================================= - echo Die Deinstallation wird beendet. - echo ======================================================================= -fi -echo -echo ======================================================================= -echo TUD-KOMA-Script ist noch in folgenden Pfaden existent: -echo -kpsewhich tudscrbase.sty --all +} +texmfdist=$(kpsewhich --var-value=TEXMFDIST) +texmfpath=$(kpsewhich tudscrbase.sty --all) +while read -r line; do + if [[ $line != *"$texmfdist"* ]]; then + texmftemp=$(echo $line|rev|cut -c15-|rev) + echo ===================================================================== + echo Soll TUD-KOMA-Script aus folgendem Pfad entfernt werden? + echo $texmftemp + echo ===================================================================== + echo + select yn in "Yes" "No"; do + case $yn in + Yes ) uninstall $texmftemp; break;; + No ) break;; + esac + done <&4; + echo + fi +done 4<&0 <<< "$texmfpath" +texhash echo -echo ======================================================================= +echo ===================================================================== +echo Es wurde keine \(weitere\) lokale Nutzerinstallation von +echo TUD-KOMA-Script gefunden. Die Deinstallation wird beendet. +echo ===================================================================== echo exit 0 % \iffalse @@ -1048,9 +1035,9 @@ cp uvczo___.afm converted/lunco8a.afm cp DINBd___.pfb converted/0m6b8a.pfb cp DINBd___.afm converted/0m6b8a.afm echo -echo ======================================================================= +echo ===================================================================== echo Virtuelle Schriften erzeugen. \(Dies kann einen Moment dauern\) -echo ======================================================================= +echo ===================================================================== echo cd converted echo 00/19 @@ -1121,9 +1108,9 @@ latex createmap.tex % % \fi echo -echo ======================================================================= +echo ===================================================================== echo Konvertierung abgeschlossen. -echo ======================================================================= +echo ===================================================================== echo % \iffalse %<*old> @@ -1180,7 +1167,7 @@ updmap --enable Map=tudscr.map % % \fi echo -echo ======================================================================= +echo ===================================================================== % \iffalse %<*full|font> % \fi @@ -1193,7 +1180,7 @@ echo Das Update wird beendet, temporaere Dateien werden geloescht. % \iffalse % % \fi -echo ======================================================================= +echo ===================================================================== % \iffalse %<*!old> % \fi @@ -1206,7 +1193,7 @@ echo unter $texmfpath/doc/latex/tudscr oder % % \fi echo ueber den Konsolenaufruf texdoc tudscr zu finden. -echo ======================================================================= +echo ===================================================================== % \iffalse % % \fi diff --git a/source/logo/TUD-black.pdf b/source/logo/TUD-black.pdf index 06439682..8777e57c 100644 Binary files a/source/logo/TUD-black.pdf and b/source/logo/TUD-black.pdf differ diff --git a/source/logo/TUD-blue.eps b/source/logo/TUD-blue.eps index c035baac..6393041d 100644 --- a/source/logo/TUD-blue.eps +++ b/source/logo/TUD-blue.eps @@ -446,9 +446,8 @@ q W 0.059998 0 255.24 74.04 re W -/DeviceRGB {} cs -[0 0 0] sc -[0 0.1843 0.3686] sc +/DeviceCMYK {} cs +[1 0.7 0.1 0.5] sc false op false OP 225.986 47.138 3.4563 3.5281 re diff --git a/source/logo/TUD-blue.pdf b/source/logo/TUD-blue.pdf index de733488..4c62d0e3 100644 Binary files a/source/logo/TUD-blue.pdf and b/source/logo/TUD-blue.pdf differ diff --git a/source/logo/TUD-white.pdf b/source/logo/TUD-white.pdf index 7d102aaa..92a701c5 100644 Binary files a/source/logo/TUD-white.pdf and b/source/logo/TUD-white.pdf differ diff --git a/source/test/test.tex b/source/test/test.tex deleted file mode 100644 index e83e2000..00000000 --- a/source/test/test.tex +++ /dev/null @@ -1,444 +0,0 @@ -\RequirePackage[ngerman=ngerman-x-latest]{hyphsubst} -\documentclass[english,ngerman]{tudscrreprt} -\usepackage{babel} -\usepackage{selinput} -\SelectInputMappings{adieresis={ä},germandbls={ß}} -\usepackage[T1]{fontenc} -\usepackage{fixltx2e} -\usepackage{scrhack} -\usepackage{tudscrsupervisor} - -\AfterPackage*{hyperref}{% -\usepackage[% - automake,% -% mit Tex Live einfach verwendbar - xindy={language=german-din}, - acronym,% Abkürzungen - symbols,% Formelzeichen - nomain,% kein Glossar - translate=babel,% - nogroupskip,% - toc,% - section=chapter,% -]{glossaries} -\makeglossaries - -\newglossarystyle{acrotabu}{% - \renewenvironment{theglossary}{% - \begin{tabu}spread 0pt{@{}lX<{\strut}l@{}}% - }{% - \end{tabu}\par\bigskip% - }% - \renewcommand*{\glossaryheader}{}% - \renewcommand*{\glsgroupheading}[1]{}% - \renewcommand*{\glsgroupskip}{}% - \renewcommand*{\glossentry}[2]{% - \glsentryitem{##1}% Entry number if required - \glstarget{##1}{\sffamily\bfseries\glossentryname{##1}} & - \glsentrydesc{##1} & - ##2\tabularnewline - } -} - -\newcommand*{\newsymbol}[5][]{% - \newglossaryentry{#2}{% - type=symbols,% - description={},% - name={#3},% - symbol={\ensuremath{#4}},% - user1={\ensuremath{\mathrm{#5}}},% - sort={#2},% - #1% - }% -} - -\defglsentryfmt[symbols]{% - \ifmmode% - \glssymbol{\glslabel}% - \else% - \glsgenentryfmt~\glsentrysymbol{\glslabel}% - \fi% -} -\newglossarystyle{symblongtabu}{% - \renewenvironment{theglossary}{% - \begin{longtabu}spread 0pt[l]{ccX<{\strut}l}% - }{% - \end{longtabu}% - }% - \renewcommand*{\glossaryheader}{% - \toprule - \bfseries Symbol & \bfseries Einheit & - \bfseries Name & \bfseries Seite(n) - \tabularnewline\midrule\endhead% - \bottomrule\endfoot% - }% - \renewcommand*{\glsgroupheading}[1]{}% - \renewcommand*{\glsgroupskip}{}% - \renewcommand*{\glossentry}[2]{% - \glsentryitem{##1}% Entry number if required - \glstarget{##1}{\glossentrysymbol{##1}} & - \glsentryuseri{##1} & - \glossentryname{##1} & - ##2\tabularnewline% - }% -} -}% Ende von AfterPackage* - -\usepackage{csquotes} -\usepackage[backend=biber,style=alphabetic]{biblatex} - -\usepackage{filecontents} -\begin{filecontents}{\jobname-temp.bib} -@book{goossens94, - author = {Goossens, Michel and Mittelbach, Frank - and Samarin, Alexander}, - title = {The LaTeX Companion}, - date = {1994}, - publisher = {Addison-Wesley}, - location = {Reading, Massachusetts}, - language = {english}, -} -@book{knuth84, - author = {Knuth, Donald E.}, - title = {The \TeX book}, - date = {1984}, - maintitle = {Computers \& Typesetting}, - volume = {A}, - publisher = {Addison-Wesley}, - location = {Reading, Massachusetts}, - language = {english}, -} -@manual{hanisch14, - author = {Hanisch, Falk}, - title = {Ein \LaTeX"=Bundle für Dokumente - im neuen Corporate Design - der Technischen Universität Dresden}, - date = {2014}, - subtitle = {Benutzerhandbuch}, - location = {Dresden}, - language = {german}, -} -\end{filecontents} -\addbibresource{\jobname-temp.bib} - -\usepackage{caption} -\captionsetup{font=sf,labelfont=bf,labelsep=space} -\usepackage{floatrow} -\floatsetup{font=sf} -\floatsetup[table]{style=plaintop} -\captionsetup{singlelinecheck=off,format=hang,justification=raggedright} -\DeclareCaptionSubType[alph]{figure} -\DeclareCaptionSubType[alph]{table} -\captionsetup[subfloat]{labelformat=brace,list=off} - -\usepackage{booktabs} -\usepackage{array} -\usepackage{tabularx} -\usepackage{tabulary} -\usepackage{tabu} - -\usepackage[colorlinks,linkcolor=blue]{hyperref} - -\usepackage{quoting} - -\usepackage[babel]{microtype} - -\usepackage{xfrac} - -\usepackage{enumitem} -\setlist[itemize]{noitemsep} - -\usepackage{isodate} - -\usepackage{ellipsis} -\let\ellipsispunctuation\relax - -\begin{document} - -\faculty{Juristische Fakultät} -\department{Fachrichtung Strafrecht} -\institute{Institut für Kriminologie} -\chair{Lehrstuhl für Kriminalprognose} -\title{% - Entwicklung eines optimalen Verfahrens zur Eroberung des - Geldspeichers in Entenhausen -} -\thesis{master} -\graduation[M.Sc.]{Master of Science} -\author{% - Mickey Mouse - \matriculationnumber{12345678} - \dateofbirth{2.1.1990} - \placeofbirth{Dresden} - \course{Klinische Prognostik} - \discipline{Individualprognose} -\and% - Donald Duck - \matriculationnumber{87654321} - \dateofbirth{1.2.1990} - \placeofbirth{Berlin} - \course{Statistische Prognostik} - \discipline{Makrosoziologische Prognosen} -} -\matriculationyear{2010} -\supervisor{Dagobert Duck \and Mac Moneysac} -\professor{Prof. Dr. Kater Karlo} -\date{10.09.2014} - -\makecover -\maketitle - -\newcommand\taskcontent{% - Momentan ist das besagte Thema in aller Munde. Insbesondere wird es - gerade in vielen~-- wenn nicht sogar in allen~-- Medien diskutiert. - Es ist momentan noch nicht abzusehen, ob und wann sich diese Situation - ändert. Eine kurzfristige Verlagerung aus dem Fokus der Öffentlichkeit - wird nicht erwartet. - - Als Ziel dieser Arbeit soll identifiziert werden, warum das Thema - gerade so omnipräsent ist und wie man diesen Effekt abschwächen - könnte. Zusätzlich sollen Methoden entwickelt werden, wie sich ein - ähnlicher Vorgang zukünftig vermeiden ließe. -} -\taskform[pagestyle=empty]{\taskcontent}{% - \item Recherche - \item Analyse - \item Entwicklung eines Konzeptes - \item Anwendung der entwickelten Methodik - \item Dokumentation und grafische Aufbereitung der Ergebnisse -} - -\TUDoption{abstract}{multiple,section} -\begin{abstract} - Dies ist der deutschsprachige Teil der Zusammenfassung, in dem die - Motivation sowie der Inhalt der nachfolgenden wissenschaftlichen - Abhandlung kurz dargestellt werden. -\nextabstract[english] - This is the english part of the summary, in which the motivation and - the content of the following academic treatise are briefly presented. -\end{abstract} - -\declaration[company=FIRMA] - -\tableofcontents -\listoffigures -\listoftables - -\printacronyms[style=acrotabu] -\printsymbols[style=symblongtabu] - -\setchapterpreamble{% - \renewcommand*\dictumwidth{.4\textwidth}% - \dictum[Johann Wolfgang von Goethe]{% - Es irrt der Mensch, solang er strebt.% - }% - \bigskip -} -\chapter{Einleitung} -Nachdem nun der Vorspann und~-- bis auf das Literaturverzeichnis am -Ende des Dokumentes auf Seite~\pageref{sec:bibliography}~-- alle -Verzeichnisse erfolgreich ausgegeben wurden, wird nun die Verwendung -der weiteren Umgebungen und Befehle demonstriert, welche im Tutorial -\texturn{treatise.pdf} vorgestellt wurden. - -\section{Die Verwendung von Akronymen und Symbolen} -\newacronym{apsp}{APSP}{All-Pairs Shortest Path} -\newacronym{spsp}{SPSP}{Single-Pair Shortest Path} -\newacronym{sssp}{SSSP}{Single-Source Shortest Path} - -In der Graphentheorie wird häufig die Lösung des Problems des kürzesten -Pfades zwischen zwei Knoten gesucht. Dieses Problem wird häugig auch -mit \gls{spsp} bezeichnet. Es lässt sich auf die Variationen \gls{sssp} -und \gls{apsp} erweitern. Für die Lösung von \gls{spsp}, \gls{sssp} -oder \gls{apsp} kommen unterschiedliche Algorithmen zum Einsatz. - -\newsymbol{l}{Länge}{l}{m} -\newsymbol{m}{Masse}{m}{kg} -\newsymbol{a}{Beschleunigung}{a}{\sfrac{m}{s^2}} -\newsymbol{t}{Zeit}{t}{s} -\newsymbol{f}{Frequenz}{f}{s^{-1}} -\newsymbol{F}{Kraft}{F}{m \cdot kg \cdot s^{-2} = \sfrac{J}{m}} - -Die Einheiten für die \gls{f} sowie die \gls{F} werden aus den -SI"=Einheiten der Basisgrößen \gls{l}, \gls{m} und \gls{t} abgeleitet. -Und dann gibt es noch die Grundgleichung der Mechanik, welche für den -Fall einer konstanten Kraftwirkung in die Bewegungsrichtung einer -Punktmasse lautet: -\[\gls{F} = \gls{m} \cdot \gls{a}\] - -\section{Referenzen und das Literaturverzeichnis} -Das Literaturverzeichnis wir auf Basis der nachfolgend verwendeten -Zitate erstellt und ist auf Seite~\pageref{sec:bibliography} zu finden. -In diesem Textabschnitt werden die zwei bekannten \LaTeX-Bücher -\cite{knuth84} und \cite{goossens94} sowie das Anwenderhandbuch -\cite{hanisch14} zitiert. - -\section{Grafiken und Tabellen in Gleitumgebungen} -Es folgt die Demonstration von Gleitumgebungen, welche sowohl für -Grafiken als auch Tabellen verwendet werden sollten. Im vorliegenden -Beispiel kann unter Umständen der Eindruck entstehen, dass diese Seite -etwas zu überladen mit Gleitobjekten ist. Dies liegt nicht an der -Verwendung der Gleitobjekte sondern vielmehr am zu geringen Textvolumen -und den eingeschränkten Möglichkeiten von \LaTeX{}, diese an geigneten -Stellen zu platzieren. - -\subsection{Abbildungen als Gleitobjekte und das Einbinden von Grafiken} -In \autoref{fig:example} wird dargestellt, wie eine Grafik im PDF-Format -in ein Dokument eingebunden und auf diese verwiesen werden kann. Ein -Querverweis auf ein Gleitobjekt sollte im Fließtext am besten mit Befehl -\texttt{\textbackslash autoref\{\emph{