summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/tuda-ci/DEMO-TUDaExercise.tex
blob: d08ea2d2d4f25f3b232f10b02ded6e97f38501da (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
%% This is file `DEMO-TUDaExercise.tex' version 3.03 (2020/09/19),
%% it is part of
%% TUDa-CI -- Corporate Design for TU Darmstadt
%% ----------------------------------------------------------------------------
%%
%%  Copyright (C) 2018--2020 by Marei Peischl <marei@peitex.de>
%%
%% ============================================================================
%% This work may be distributed and/or modified under the
%% conditions of the LaTeX Project Public License, either version 1.3c
%% of this license or (at your option) any later version.
%% The latest version of this license is in
%% http://www.latex-project.org/lppl.txt
%% and version 1.3c or later is part of all distributions of LaTeX
%% version 2008/05/04 or later.
%%
%% This work has the LPPL maintenance status `maintained'.
%%
%% The Current Maintainers of this work are
%%   Marei Peischl <tuda-ci@peitex.de>
%%   Markus Lazanowski <latex@ce.tu-darmstadt.de>
%%
%% The development respository can be found at
%% https://github.com/tudace/tuda_latex_templates
%% Please use the issue tracker for feedback!
%%
%% If you need a compiled version of this document, have a look at
%% http://mirror.ctan.org/tex-archive/macros/latex/contrib/tuda-ci/doc
%% or at the documentation directory of this package (if installed)
%% <path to your LaTeX distribution>/doc/latex/tuda-ci
%% ============================================================================
%%
% !TeX program = lualatex
%%

\documentclass[
	ngerman,
	]{tudaexercise}

\usepackage[english, main=ngerman]{babel}
\usepackage[babel]{csquotes}

\usepackage{biblatex}
\bibliography{DEMO-TUDaBibliography}

%Formatierungen für Beispiele in diesem Dokument. Im Allgemeinen nicht notwendig!
\let\file\texttt
\let\code\texttt
\let\pck\textsf
\let\cls\textsf
\let\tbs\textbackslash

\ConfigureHeadline{
	headline={title-name-id}
}

\begin{document}

\title[Übung TUDaExercise]{Übung zur Benutzung der TUDaExercise-Klasse}
\author{Marei Peischl}
\term{Sommersemester 2042 -- v\fileversion\space(\filedate)}
\sheetnumber{5}

\maketitle

\begin{task}{Titelei}
Im Gegensatz zu den ganzen Titelseiten bei TUDaPub benötigt TUDaExercise eine platzsparende Möglichkeit für die Titelerzeugung. Daher verfügt TUDaexercise nur über einen Titelkopf. Für die Übergabe der Daten werden die folgenden Makros ausgewertet:
\begin{verbatim}
\title[Kurztitel für die Kopfzeile]{Titel}
\subtitle{Untertitel}
\author{Autor*in/Dozent*in}
\term{Semester}
\date{Datum}
\sheetnumber{Nummer des Übungsblatts}
\end{verbatim}
Mit Ausnahme des Titels können alle Felder auch leer bleiben . Sofern keine Blattnummer übergeben wird, werden die Übungsaufgaben beginnend mit 1, fortlaufend nummeriert.
\end{task}

\begin{task}{Farbgebung}
	Die Farbgebung nutzt die selben Mechanismen wie die übrigen Klassen des TUDa-CI-Bundles. Die Optionen \code{color}, \code{accentcolor}, \code{textaccentcolor}, \code{identbarcolor} funktionieren wie gewohnt (vgl. TUDaPub). Darüber hinaus ist es auch hier möglich den farbigen Titelblock zu deaktivieren. Die Option \code{colorback=false} ermöglicht es für Versionen zum Ausdrucken die Tonersparende Variante einzustellen.
\end{task}

\begin{task}{Eine Aufgabe erstellen}
Aufgaben werden bei \cls{tudaexercise.cls} durch die Umgebung \code{task} definiert. Das Notwendige Argument übernimmt dabei eine Überschrift. Es kann leer bleiben.

\begin{verbatim}
	\begin{task}[<Optionen>]{Überschrift}
		Text der Aufgabe
	\end{task}
\end{verbatim}

Querverweise zwischen den Aufgaben sind wie üblich mit \code{\tbs{}label} und \code{\tbs{}ref} möglich.

Neben der Umgebungsstruktur, die zur besseren Übersichtlichkeit zu empfehlen ist, verfügt tudaexercise auch über die Möglichkeit eine Aufgabe nur mit \code{\tbs{}task} einzuleiten.

\begin{verbatim}
\task{Überschrift der Aufgabe}
\end{verbatim}

In diesem Dokument wird lediglich die empfohlene Variante unter Nutzung der Umgebung gezeigt.

Falls die Makro-Version benutzt und damit Optionen gesetzt werden, ist zu beachten, dass diese nicht automatisch wieder beendet werden kann, da ja das Ende der Umgebung fehlt. Dies ist der Hauptgrund für die Empfehlung der Umgebung.
\end{task}

\begin{task}{Kopfzeilenanpassungen}
Der Mechanismus für die Kopfzeilen wurde angepasst, sodass sein Inhalt frei wählbar ist.

\begin{verbatim}
\ConfigureHeadline{
   headline={Inhalt der Kopfzeile}
}
\end{verbatim}

Es existiert nun eine Unterscheidung zwischen linken und rechten Seiten, sofern \code{twoside=true}.

\begin{verbatim}
\ConfigureHeadline{
   even={Inhalt der Kopfzeile für linke Seiten},
   odd={Inhalt der Kopfzeile für rechte Seiten},
   oneside={Inhalt der Kopfzeile im einseitigen Modus}
}
\end{verbatim}

Einstellungen, die gleiche Felder betreffen, überschreiben sich gegenseitig.

\begin{subtask}[Freie Inhalte]
Die Inhalte sind frei wählbar und werden automatisch in einer Box mit der gleichen Breite, wie der Text gesetzt. Der Inhalt wird linksbündig platziert. Es ist möglich Grafiken oder Tabellen innerhalb dieser Box zu platzieren.
\end{subtask}

\begin{subtask}[Vorgefertigte Elemente]
Für die Kopfzeilen existieren einige vorgefertigte Elemente, die dort platziert werden können.
\begin{verbatim}
	\ShortTitle
	\StudentID
	\StudentName
\end{verbatim}
Darüber hinaus kann auch jeglicher \LaTeX-Content dort eingefügt werden.

Zusätzlich sind einige Werte vorbelegt und platzieren die Einträge nach dem selbsterklärenden Namensschema:
\code{title-name-id}, \code{title-name}, \code{title}, \code{name-id}, \code{name}
\end{subtask}

\begin{subtask}[Kopfzeile auch auf der Titelseite]
Da die Kopfzeile häufig für die Angabe von Studentendaten genutzt wird, ist es mit der Klassenoption \code{headtotitle} auch möglich die Kopfzeile ebenfalls auf der Titelseite einzufügen.
\end{subtask}
\end{task}


\begin{task}[solution=true]{Lösungen}
tudaexercise verfügt über einen Mechanismus um Lösungsvorschläge innerhalb der Dateien mit zu verwalten. Hierfür existiert die Umgebung \code{solution}.

Die Ausgabe der Lösungen wird entweder global
\begin{verbatim}
\documentclass[...,
   solution=true,
]{tudaexercise}
\end{verbatim}
oder lokal für einzelne Aufgaben konfiguriert:

\begin{verbatim}
\begin{task}[solution=true]{Überschrift}
Aufgabentext
   \begin{solution}
   Lösungstext
   \end{solution}
\end{task}
\end{verbatim}
Die Voreinstellung ist \code{solution=false}.
\begin{solution}
Beispiel für einen Lösungsvorschlag
\end{solution}

\end{task}

\begin{task}[credit=10]{Punkte}
Punkteangaben sind über den Optionsschlüssel \code{credit} möglich. Der Wert wird hinter den Aufgabentitel in runde Klammern gesetzt. Dies geschieht mithilfe des Makros \code{\tbs{}creditformat}

Alternativ existiert der Schlüssel \code{points} dieser ergänzt zusätzlich zur Angabe auch den Text \code{\tbs{}PointName} bzw. \code{\tbs{PointsName}} je nachdem ob der Wert größer 1 oder nicht. Der Schlüssel \code{points} akzeptiert daher nur numerische Werte.
\begin{subtask}[points=1,title=Beispiel für den Schlüssel points]
Da ältere Versionen von TUDaExercise keine Optionsverarbeitung für subtask erlaubten, ist hier ein zusätzlicher Mechanismus enthalten. Falls sowohl ein Titel, als auch spezifische Angaben notwendig sind, existiert hier zusätzlich der Schlüssel \code{title}.
Geprüft wird darauf, ob das Argument ein Gleichheitszeichen enthält, ist dies der Fall, so wird davon ausgegangen, dass Optionen nach Schlüssel=Wert-Struktur übergeben werden.
\end{subtask}

\begin{subtask}[Fallback-Modus, falls ein = im Titel detektiert wird, aber keine Zuweisung möglich ist.]
Falls bei der Optionsverarbeitung Unstimmigkeiten festgestellt werden, so wird das gesamte Argument als Titel verarbeitet.
\end{subtask}
\end{task}

\begin{task*}{Beta-Feature: Einheitliche Syntax für Task/Subtask}
TUDaExercise unterscheidet in der Standardeinstellung zwischen \code{task} und \code{subtask}. Dies ist dadurch begründet, dass \code{subtask} keine Angabe eines Titels erfordert.

Es wurde der Bedarf nach einer einheitlichen Syntax geäußert (siehe \url{https://github.com/tudace/tuda_latex_templates/issues/189}). 

\begin{subtask*}{Die gesternten Verianten der task/subtaks-Umgebungen}
Die mit Version 3.0 implementierten Varianten \code{task*} und \code{subtask*} ermöglichen dies.

Beide Varianten stehe nur als Umgebung und nicht als Makro zur Verfügung:

\begin{verbatim}
\begin{task*}{Aufgabentitel}
  \begin{subtask*}{Titel der Teilaufgabe}
    Beschreibung
  \end{subtask*}
\end{task*}
\end{verbatim}

\end{subtask*}

\begin{subtask*}{Vertauschen der beiden Varianten}
Zusätzlich erlaubt die Klassenoption \code{match-task-subtask-syntax} das Vertauschen von \code{subtask} und \code{subtask*}.

Die Umgebungen \code{task*} und \code{task} sind identisch.
\end{subtask*}
\end{task*}

\begin{task}{Kompatibilitätsmodus}
Die Klasse \cls{tudaexercise} verfügt über einen Kompatibilitätsmodus, um den Umstieg von zuvor existierenden Templates, wie TUDexercise zu erleichtern.
Um den Kompatibilitätsmodus zu aktivieren, existiert die Option \code{compat=true}.

Damit können Strukturen wie \code{examheader}, \code{examheaderdefault} und die Erzeugung von Aufgaben mitilfe von \code{\tbs{}subsection} wie gewohnt verwendet werden. Da einige dieser Mechanismen jedoch der Philosophie der semantischen Auszeichnung widersprechen wird ihre Verwendung hier nicht genauer erklärt. Nutzer, denen diese Mechanismen nicht vertraut sind, wird empfohlen die durch TUDaExercise zur Verfügung gestellten Varianten zu nutzen.

Beim zugehörigen Release im Development Repository findet sich auch eine Beispieldatei, die die alten Mechanismen verwendet und spezielle Hinweise für Umsteiger enthält. %TODO link einfügen.
\end{task}
\end{document}