Debian Codegraph @

texmf-dist/source/latex/tudscr/doc/tudscr-supervisor.tex

raw
1 \setchapterpreamble{\tudhyperdef'{sec:supervisor}}
2 \chapter[Das Paket \Package*{tudscrsupervisor} -- Studentische Betreuung]{%
3 Betreuung studentischer Arbeiten
4 }
5 \begin{Bundle*}{\Package{tudscrsupervisor}}
6 %
7 Dieses Paket stellt für das Erstellen von Aufgabenstellungen und Gutachten
8 wissenschaftlicher Arbeiten sowie offiziellen Aushängen im \CD passende
9 Umgebungen und Befehle für den Anwender bereit. Deshalb richtet es sich
10 vornehmlich an Mitarbeiter an der \TnUD, kann jedoch natürlich auch von
11 Studenten genutzt werden.
12
13
14 \section{Aufgabenstellung für eine wissenschaftliche Arbeit}
15 \index{Aufgabenstellung|!(}%
16 %
17 \begin{Declaration}{\Environment{task}[\OLParameter{Überschrift}]}{%
18 \Environment{tudpage}'auto'%
19 }
20 \begin{Declaration}{\Key{\Environment{task}}{headline=\PName{Überschrift}}}
21 \begin{Declaration}[v2.05]{\Key{\Environment{task}}{style=\PName{Stil}}}
22 \printdeclarationlist%
23 %
24 Mit der \Environment{task}"=Umgebung kann ein Aufgabenstellung für eine
25 wissenschaftliche Arbeit ausgegeben werden. Diese basiert auf der Umgebung
26 \Environment{tudpage} und akzeptiert deshalb im optionalen Argument alle
27 Parameter, welche bei der Beschreibung von \Environment{tudpage}'full'
28 erläutert wurden.
29
30 Für die Aufgabenstellung wird normalerweise eine Überschrift gesetzt, welche
31 sich aus \Term{taskname} und~-- falls der Typ der Abschlussarbeit angegeben
32 wurde~-- noch aus \Term{tasktext} und \Macro{thesis} zusammensetzt. Der
33 Parameter \Key{\Environment{task}}{headline} kann genutzt werden, um diese
34 automatisch generierte Überschrift anzupassen.
35
36 Zu Beginn der Aufgabenstellung erscheint eine Tabelle mit den angegebenen
37 Informationen zum Autor respektive zu den Autoren der Abschlussarbeit. Zwingend
38 anzugeben sind dafür lediglich der Name des oder der Verfasser (\Macro{author})
39 sowie der Titel der Arbeit (\Macro{title}), welcher am Ende der Tabelle in
40 fetter Schrift aufgeführt wird. Optional werden noch die Felder für den
41 Studiengang (\Macro{course}), die Fachrichtung (\Macro{discipline}) sowie die
42 Matrikelnummer (\Macro{matriculationnumber}) und das Immatrikulationsjahr
43 (\Macro{matriculationyear}) ausgegeben, wobei nicht angegebene Felder bei der
44 Ausgabe ignoriert werden. Der eigentliche Inhalt der Umgebung~-- sprich die
45 Aufgabenstellung selbst~-- wird nach dem generierten Kopf ausgegeben
46
47 Dem Inhalt der Aufgabenstellung folgt eine zeilenweise Auflistung des oder der
48 definierten Gutachter beziehungsweise Prüfer (\Macro{referee}) sowie Betreuer
49 (\Macro{supervisor}). Dabei wird vor dem jeweiligen Namen der dazugehörige
50 Bezeichner (\Term{refereename}, \Term{refereeothername} respektive
51 \Term{supervisorname}, \Term{supervisorothername}) gesetzt.
52 \ChangedAt{v2.05}
53 Dies ist das voreingestellte Verhalten und kann über die Wahl des Parameters
54 \Key{\Environment{task}}{style=\PValue{table}} aktiviert werden. Wird hingegen
55 der Parameter \Key{\Environment{task}}{style=\PValue{inline}} gesetzt, so
56 erfolgt die Ausgabe von mehreren Prüfern und Betreuern in einer Zeile. Die
57 Bezeichner sind problemlos anpassbar, siehe dazu \autoref{sec:localization}.
58 Danach erscheinen das Ausgabedatum (\Macro{issuedate}) sowie der verpflichtende
59 Abgabetermin (\Macro{duedate}). Zum Schluss wird die Unterschriftzeile für den
60 Prüfungsausschussvorsitzenden (\Macro{chairman}) und den betreuenden
61 Hochschullehrer (\Macro{professor}) gesetzt. Für genannte Personen werden unter
62 dem Namen selbst die Bezeichner ausgegeben (\Term{chairmanname} und
63 \Term{professorname}).
64 \end{Declaration}
65 \end{Declaration}
66 \end{Declaration}
67
68 \begin{Declaration}{%
69 \Macro{taskform}[\LParameter\Parameter{Ziele}\Parameter{Schwerpunkte}]%
70 }
71 \printdeclarationlist%
72 %
73 Zusätzlich zur der frei gestaltbaren Umgebung \Environment{task} zur Erstellung
74 einer Aufgabenstellung wird ein separater Befehl für eine standardisierte
75 Ausgabe zur Verfügung gestellt. Dieser strukturiert die Aufgabenstellung in die
76 zwei Bereiche \emph{Ziele} und \emph{Schwerpunkte} der Arbeit mit dazugehörigen
77 Überschriften (\Term{objectivesname}, \Term{focusname}).
78
79 Im optionalen Argument können alle Parameter der Umgebung \Environment{task}
80 verwendet werden. Im ersten obligatorischen Argument sollte ein Text mit einer
81 kurzen thematischen Einordnung und dem eigentlichen Ziel der Arbeit erscheinen,
82 im zweiten Argument sollen die thematischen Schwerpunkte in Stichpunkten
83 benannt werden. Der Inhalt des zweiten notwendigen Argumentes wird in einer
84 \Environment{itemize}(\Package{koma-script},\Package{enumitem})'none'"=Umgebung
85 gesetzt. Deshalb \emph{muss} jedem Stichpunkt
86 \Macro{item}(\Package{koma-script},\Package{enumitem})'none' vorangestellt
87 werden.
88 \end{Declaration}
89 %
90 \begin{Example}
91 Die empfohlene Verwendung des Befehls \Macro{taskform} ist wie folgt:
92 \begin{Code}[escapechar=§]
93 \taskform{%
94 Motivation der Arbeit im ersten Absatz§\dots§
95
96 Ziele der Arbeit im zweiten Absatz§\dots§
97 }{%
98 \item Schwerpunkt 1
99 \item Schwerpunkt 2
100 }
101 \end{Code}
102 Hierzu sei auch auf das Minimalbeispiel in \autoref{sec:exmpl:task} verwiesen.
103 \index{Aufgabenstellung|!)}%
104 \end{Example}
105
106 \begin{Declaration}{\Macro{chairman}[\Parameter{Prüfungsausschussvorsitzender}]}
107 \printdeclarationlist%
108 %
109 Wird dieses Feld genutzt, wird neben dem betreuenden Hochschullehrer
110 (\Macro{professor}) auch der Vorsitzende des Prüfungsausschusses am Ende der
111 Aufgabenstellung aufgeführt. Dies wird zumeist für Abschlussarbeiten wie
112 beispielsweise \masterthesisname{} oder \diplomathesisname{} benötigt.
113 \end{Declaration}
114
115 \begin{Declaration}{\Macro{issuedate}[\Parameter{Ausgabedatum}]}
116 \begin{Declaration}{\Macro{duedate}[\Parameter{Abgabetermin}]}
117 \printdeclarationlist%
118 %
119 Mit diesen beiden Befehlen sollte das Datum der Ausgabe der Aufgabenstellung
120 sowie der spätest mögliche Abgabetermin angegeben werden. Wurde das Paket
121 \Package{isodate} oder \Package{datetime2} geladen, wird die damit eingestellte
122 Ausgabeformatierung des Datums mit \Macro{printdate}(\Package{isodate})'none'
123 beziehungsweise \Macro{DTMDate}(\Package{datetime2})'none' für \Macro{duedate}
124 und \Macro{issuedate} verwendet.
125 \end{Declaration}
126 \end{Declaration}
127
128
129 \section{Gutachten für wissenschaftliche Arbeiten}
130 \index{Gutachten|!(}%
131 %
132 \begin{Declaration}{\Environment{evaluation}[\OLParameter{Überschrift}]}{%
133 \Environment{tudpage}'auto'%
134 }
135 \begin{Declaration}{%
136 \Key{\Environment{evaluation}}{headline=\PName{Überschrift}}%
137 }
138 \begin{Declaration}{\Key{\Environment{evaluation}}{grade=\PName{Note}}}
139 \printdeclarationlist%
140 %
141 Diese Umgebung wird für das Erstellen eines Gutachtens einer wissenschaftlichen
142 Arbeit bereitgestellt. Auch diese unterstützt alle Parameter, welche für die
143 Umgebung \Environment{tudpage}'full' beschrieben wurden.
144
145 Für ein Gutachten wird gewöhnlich eine Überschrift aus \Term{evaluationname}
146 und~-- falls der Abschlussarbeitstyp angegeben wurde~-- \Term{evaluationtext}
147 sowie \Macro{thesis} generiert. Diese automatisch generierte Überschrift kann
148 mit dem Parameter \Key{\Environment{evaluation}}{headline} ersetzt werden. Am
149 Ende des Gutachtens wird die mit \Key{\Environment{evaluation}}{grade}
150 gegebene Note in fetter Schrift ausgezeichnet.
151
152 Am Anfang der \Environment{evaluation}"=Umgebung wird die gleiche Tabelle mit
153 Autorenangaben ausgegeben, wie dies bei der \Environment{task}"=Umgebung der
154 Fall ist. Nach dem Tabellenkopf folgt auch hier der eigentliche Inhalt, sprich
155 das Gutachten der Abschlussarbeit. Abgeschlossen wird die Umgebung mit der
156 gegebenen Note~-- welche innerhalb von \Term{gradetext} ausgegeben wird~--
157 sowie der Orts- und Datumsangabe (\Macro{place}, \Macro{date}) und der
158 darauffolgenden Unterschriftzeile für den oder die Gutachter (\Macro{referee}),
159 welche wiederum mit den entsprechenden sprachabhängigen Bezeichner
160 (\Term{refereename}, \Term{refereeothername}) ergänzt werden.
161 \end{Declaration}
162 \end{Declaration}
163 \end{Declaration}
164
165 \begin{Declaration}{%
166 \hskip-.06em\Macro{evaluationform}[%
167 \LParameter\Parameter{Aufgabe}\Parameter{Inhalt}%
168 \Parameter{Bewertung}\Parameter{Note}\hskip-.06em%
169 ]%
170 }
171 \printdeclarationlist%
172 %
173 Neben der individuell nutzbaren Umgebung \Environment{evaluation} wird ein
174 separater Befehl zur Erstellung eines standardisierten Gutachtens
175 bereitgestellt. Dieser strukturiert die Ausgabe in die vier Bereiche
176 \emph{Aufgabe}, \emph{Inhalt}, \emph{Bewertung} und \emph{Note} und versieht
177 diese jeweils mit der dazugehörigen Überschrift beziehungsweise Textausgabe
178 (\Term{taskname}, \Term{contentname}, \Term{assessmentname} und
179 \Term{gradetext}). Das optionale Argument unterstützt alle Parameter der
180 \Environment{evaluation}"=Umgebung.
181 \end{Declaration}
182 %
183 \begin{Example}
184 Die empfohlene Verwendung des Befehls \Macro{evaluationform} ist wie folgt:
185 \begin{Code}[escapechar=§]
186 \evaluationform{%
187 Kurzbeschreibung der Aufgabenstellung§\dots§
188 }{%
189 Zusammenfassung von Inhalt und Struktur§\dots§
190 }{%
191 Bewertung der schriftlichen Abschlussarbeit§\dots§
192 }{%
193 Zahl (Note)
194 }
195 \end{Code}
196 Hierzu sei auch auf das Minimalbeispiel in \autoref{sec:exmpl:evaluation}
197 verwiesen.
198 \index{Gutachten|!)}%
199 \end{Example}
200
201 \begin{Declaration}{\Macro{grade}[\Parameter{Note}]}
202 \printdeclarationlist%
203 %
204 Neben der Angabe der Note für ein Gutachten über den Parameter
205 \Key{\Environment{evaluation}}{grade} der Umgebung \Environment{evaluation}
206 kann dafür auch dieser global wirkende Befehl verwendet werden.
207 \end{Declaration}
208
209
210 \section{Aushang}
211 \index{Aushang|!(}%
212 %
213 \begin{Declaration}{\Environment{notice}[\OLParameter{Überschrift}]}{%
214 \Environment{tudpage}'auto'%
215 }
216 \begin{Declaration}{\Key{\Environment{notice}}{headline=\PName{Überschrift}}}
217 \printdeclarationlist%
218 %
219 Für das Anfertigen eines Aushangs kann diese Umgebung verwendet werden. Diese
220 basiert abermals auf der Umgebung \Environment{tudpage} und unterstützt alle
221 deren Parameter.
222
223 Wurde ein Datum angegeben, wird dieses standardmäßig rechtsbündig oberhalb des
224 Textbereiches angezeigt (\seeref{\Key{\Environment{tudpage}}{cdhead}}). Danach
225 erfolgt die Ausgabe der Überschrift, welche für gewöhnlich dem Inhalt von
226 \Term{noticename} entspricht und mit \Key{\Environment{notice}}{headline}
227 geändert werden kann. Nach der Überschrift folgt der Inhalt der Umgebung. Wurde
228 mit \Macro{contactperson} ein oder mehrere Ansprechpartner angegeben, werden
229 diese Informationen am Ende der Umgebung gesetzt.
230 \end{Declaration}
231 \end{Declaration}
232
233 \begin{Declaration}{%
234 \Macro{noticeform}[\LParameter\Parameter{Inhalt}\Parameter{Schwerpunkte}]%
235 }
236 \printdeclarationlist%
237 %
238 Auch für diese Umgebung gibt es einen Befehl für eine normierte Form. Diese
239 soll vor allem Verwendung für den Aushang studentischer Arbeitsthemen finden.
240 Für das optionale Argument können sämtliche Parameter verwendet werden, die
241 auch die \Environment{notice}"=Umgebung unterstützt.
242
243 Das erste obligatorische Argument wird für eine kurze Inhaltsbeschreibung
244 verwendet. Neben dem Text sollte hier wenn möglich eine thematisch passende
245 Abbildung eingefügt werden (\Macro{includegraphics}(\Package{graphicx})'none').
246 Das zweite Argument wird~-- wie schon bei \Macro{taskform}~-- dazu verwendet,
247 einige Schwerpunkte aufzuzählen. Auch hier kommt nach der gliedernden
248 Überschrift (\Term{focusname}) eine
249 \Environment{itemize}(\Package{koma-script},\Package{enumitem})'none'"=Umgebung
250 zum Einsatz, allen Schwerpunkten muss ein
251 \Macro{item}(\Package{koma-script},\Package{enumitem})'none' vorangestellt
252 werden.
253 \end{Declaration}
254 %
255 \begin{Example}
256 Die empfohlene Verwendung des Befehls \Macro{noticeform} ist wie folgt:
257 \begin{Code}[escapechar=§]
258 \noticeform{%
259 Kurzbeschreibung des Inhaltes der studentischen Arbeit§\dots§
260
261 Bild (optional), einzubinden mit:
262 \includegraphics[§\PName{Einstellungen}§]{§\PName{Datei}§}
263 }{%
264 \item Schwerpunkt 1
265 \item Schwerpunkt 2
266 }
267 \end{Code}
268 Hierzu sei auch auf das Minimalbeispiel in \autoref{sec:exmpl:notice} verwiesen.
269 \index{Aushang|!)}%
270 \end{Example}
271
272 \begin{Declaration}[v2.02]{\Macro{contactperson}[\Parameter{Kontaktperson(en)}]}
273 \begin{Declaration}{\Macro{office}[\Parameter{Dienstsitz}]}
274 \begin{Declaration}[v2.02]{\Macro{telephone}[\Parameter{Telefonnummer}]}
275 \begin{Declaration}[v2.05]{\Macro{telefax}[\Parameter{Telefaxnummer}]}
276
277 \printdeclarationlist%
278 %
279 Am Ende eines Aushangs können mit \Macro{contactperson} Kontaktinformationen
280 für eine oder mehrere Ansprechpartner angegeben werden. Soll mehr als eine
281 Kontaktperson genannt werden, so müssen diese innerhalb des Befehls
282 \Macro{contactperson} mit dem Befehl \Macro{and} getrennt werden. Für jede
283 Person kann innerhalb des Argumentes von \Macro{contactperson} der Dienstsitz
284 (\Macro{office}), die dienstliche Telefon- (\Macro{telephone}) sowie "~faxnummer
285 (\Macro{telefax}) und die geschäftliche E"~Mail"=Adresse (\Macro{emailaddress})
286 angegeben werden.
287 \end{Declaration}
288 \end{Declaration}
289 \end{Declaration}
290 \end{Declaration}
291
292
293
294 \section{Zusätzliche sprachabhängige Bezeichner}
295 \index{Bezeichner|!(}%
296 %
297 Für das Paket \Package{tudscrsupervisor} werden für die zusätzlichen Befehle
298 und Umgebungen weitere Bezeichner definiert. Für eine etwaige Anpassung dieser
299 sei auf \autoref{sec:localization} verwiesen.
300
301 \begin{Declaration}{\Term{taskname}}
302 \begin{Declaration}{\Term{tasktext}}
303 \printdeclarationlist%
304 %
305 Die Bezeichnung der Aufgabenstellung selbst ist in \Term{taskname} enthalten.
306 Für die Generierung einer Überschrift wird dieser verwendet. Wurde außerdem mit
307 \Macro{thesis} oder \Macro{subject} der Typ der Abschlussarbeit%
308 \footnote{%
309 \Option{subjectthesis} oder spezieller Wert aus \autoref{tab:thesis}%
310 }
311 angegeben, wird die Überschrift zusammen mit dem Bezeichner \Term{tasktext}
312 um die Typisierung erweitert. Falls gewünscht, kann die automatisch generierte
313 Überschrift mit dem Parameter \Key{\Environment{task}}{headline} der Umgebung
314 \Environment{task} überschrieben werden.
315 \TermTable{taskname,tasktext}
316 \end{Declaration}
317 \end{Declaration}
318
319 \begin{Declaration}[v2.04]{\Term{namesname}}
320 \begin{Declaration}{\Term{titlename}}
321 \printdeclarationlist%
322 %
323 Diese beiden Bezeichner werden in der Tabelle mit den Autoreninformationen zu
324 Beginn der Aufgabenstellung verwendet.
325 \TermTable{namesname,titlename}
326 \end{Declaration}
327 \end{Declaration}
328
329 \begin{Declaration}{\Term{issuedatetext}}
330 \begin{Declaration}{\Term{duedatetext}}
331 \printdeclarationlist%
332 %
333 Am Ende der Aufgabenstellung wird nach dem oder der Betreuer das Ausgabedatum
334 und der Abgabetermin (\Macro{issuedate}, \Macro{duedate}) der Abschlussarbeit
335 mit folgenden Bezeichner erläutert.
336 \TermTable{issuedatetext,duedatetext}
337 \end{Declaration}
338 \end{Declaration}
339
340 \begin{Declaration}{\Term{chairmanname}}
341 \printdeclarationlist%
342 %
343 Wurde der Prüfungsausschussvorsitzende (\Macro{chairman}) angegeben, erfolgt
344 unter dem Namen selbst die Ausgabe des Bezeichners.
345 \TermTable{chairmanname}
346 \end{Declaration}
347
348 \begin{Declaration}{\Term{focusname}}
349 \begin{Declaration}{\Term{objectivesname}}
350 \printdeclarationlist%
351 %
352 Die Standardformen für Aufgabenstellung (\Macro{taskform}) respektive Aushang
353 (\Macro{noticeform}) nutzen für die gesetzten Überschriften diese Bezeichner.
354 \TermTable{focusname,objectivesname}
355 \end{Declaration}
356 \end{Declaration}
357
358 \begin{Declaration}{\Term{evaluationname}}
359 \begin{Declaration}{\Term{evaluationtext}}
360 \printdeclarationlist%
361 %
362 Die Bezeichnung des Gutachten selbst ist in \Term{evaluationname} enthalten.
363 Für die Generierung der Überschrift wird der Bezeichner \Term{evaluationtext}
364 sowie der mit \Macro{thesis} oder gegebenenfalls mit \Macro{subject} gegebenen
365 Typ der Abschlussarbeit verwendet. Diese automatisch generierte Überschrift
366 kann mit dem Parameter \Key{\Environment{evaluation}}{headline} der
367 Umgebung \Environment{evaluation} durch den Anwender überschrieben werden.
368 \TermTable{evaluationname,evaluationtext}
369 \end{Declaration}
370 \end{Declaration}
371
372 \begin{Declaration}{\Term{contentname}}
373 \begin{Declaration}{\Term{assessmentname}}
374 \printdeclarationlist%
375 %
376 Bei der standardisierten Form des Gutachtens (\Macro{evaluationform}) werden
377 die darin~-- für eine strukturierte Gliederung~-- erzeugten Überschriften mit
378 den Bezeichnern \Term{taskname}, \Term{contentname} und \Term{assessmentname}
379 gesetzt.
380 \TermTable{taskname,contentname,assessmentname}
381 \end{Declaration}
382 \end{Declaration}
383
384 \begin{Declaration}{\Term{gradetext}}
385 \printdeclarationlist%
386 %
387 Wird für das Gutachten einer wissenschaftlichen Arbeit die erzielte Note
388 entweder mit dem Befehl \Macro{grade}[\Parameter{Note}] oder alternativ dazu
389 mit dem Parameter \Key{\Environment{evaluation}}{grade=\PName{Note}} der
390 Umgebung \Environment{evaluation} angegeben, so wird diese innerhalb von
391 \Term{gradetext} verwendet.
392 \grade{\PName{Note}}
393 \TermTable*{gradetext}{.8\textwidth}
394 \end{Declaration}
395
396 \begin{Declaration}{\Term{noticename}}
397 \begin{Declaration}[v2.02]{\Term{contactpersonname}}
398 \printdeclarationlist%
399 %
400 Die Bezeichnung des Aushangs selbst ist in \Term{noticename} enthalten. Für
401 die Generierung einer Überschrift wird dieser verwendet. Falls gewünscht, kann
402 diese mit dem Parameter \Key{\Environment{notice}}{headline} der Umgebung
403 \Environment{notice} überschrieben werden. Wurde eine Kontaktperson mit dem
404 Befehl \Macro{contactperson} angegeben, wird als Überschrift der Kontaktdaten
405 der Bezeichner \Term{contactpersonname} verwendet.
406
407 \TermTable{noticename,contactpersonname}
408 \end{Declaration}
409 \end{Declaration}
410 \index{Bezeichner|!)}%
411 \end{Bundle*}