diff options
author | Karl Berry <karl@freefriends.org> | 2015-02-16 21:40:28 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2015-02-16 21:40:28 +0000 |
commit | 68695b0b7015bb233b4f5697ebdb9def46b9cb4a (patch) | |
tree | 94745a5ea3bedbf6b6904bf5cbb949151e8f41fd /Master/texmf-dist/source/latex/tudscr/doc/tudscr-bundle.tex | |
parent | e016928e2bd0e7163bde478d7ab2419f49468c3c (diff) |
tudscr (16feb15)
git-svn-id: svn://tug.org/texlive/trunk@36296 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/tudscr/doc/tudscr-bundle.tex')
-rw-r--r-- | Master/texmf-dist/source/latex/tudscr/doc/tudscr-bundle.tex | 224 |
1 files changed, 18 insertions, 206 deletions
diff --git a/Master/texmf-dist/source/latex/tudscr/doc/tudscr-bundle.tex b/Master/texmf-dist/source/latex/tudscr/doc/tudscr-bundle.tex index 2fc21272109..a50c3f324ae 100644 --- a/Master/texmf-dist/source/latex/tudscr/doc/tudscr-bundle.tex +++ b/Master/texmf-dist/source/latex/tudscr/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 @@ Die empfohlene Verwendung des Befehls \Macro{taskform} ist wie folgt: 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 @@ Die empfohlene Verwendung des Befehls \Macro{noticeform} ist wie folgt: 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 @@ um die Typisierung erweitert. Falls gewünscht, kann die automatisch generierte \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 @@ wird diese innerhalb von \Term{gradetext} verwendet. \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 @@ beschriebenen Grundfarben \Color*{HKS41}, \Color*{HKS92}, \Color*{HKS44}, \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 @@ Dieses Paket stellt die Schriften des \CDs für \hologo{LaTeXe}-Klassen bereit, 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 @@ werden. -\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 @@ Diese Dinge sollen langfristig in das \TUDScript-Bundle eingearbeitet werden. %\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*} |