Debian Codegraph @

texmf-dist/doc/lualatex/seatingchart/seatingchart-doc-de.tex

raw
1 % Patch cnltx-doc class
2 \AddToHook{class/scrartcl/after}{
3 \NewCommandCopy{\originalAfterPackage}{\AfterPackage}
4 \RenewDocumentCommand{\AfterPackage}{t! m m}{
5 \IfBooleanTF{#1}{#3}{%
6 \originalAfterPackage{#2}{#3}
7 }
8 }
9 }
10 \makeatother
11 \typeout{*** Patch cnltx-doc}
12 \documentclass[
13 babel-options={ngerman},
14 load-preamble-,
15 scrartcl={headings=small}
16 ]{cnltx-doc}
17
18 \usepackage[oldstyle]{libertine}
19 \usepackage[scaled=.81]{DejaVuSansMono}
20 \usepackage{microtype}
21 \usepackage{enumitem}
22 % Since the cnltx class doesn't do examples with lualatex,
23 % we can't include our package.
24 % Thus, we use readprov to get file information.
25 \usepackage{readprov}
26 \ReadFileInfos{seatingchart.sty}
27
28 \providecommand{\packagename}{seatingchart}
29 \def\thepkg{\pkg*{\packagename}}
30 \setcnltx{
31 name = seatingchart,
32 package = \packagename,
33 version = \UseVersionOf{\packagename.sty},
34 date = \UseDateOf{\packagename.sty},
35 title = Das \thepkg-Paket,
36 info = Erstellung von Sitzplänen,
37 authors = {Matthias Werner[[email protected]]},
38 abstract = {Das Paket ermöglicht es, Sitzpläne, wie sie z. B. für Prüfungen
39 benötigt werden, einfach zu erstellen. Eine Reihe
40 verschiedener automatischer Platzierungsschemata sind vordefiniert,
41 aber man kann auch feingranular eigene Platzierungen vornehmen.
42 Während das Paket zunächst für den internen
43 Gebrauch an der TU Chemnitz gedacht war und
44 für (einige) der Räume der TU~Chemnitz vordefinierte Sitzlayouts enthält,
45 sind jedoch einerseits sowohl die Raumdaten leicht erweiter-
46 oder ersetzbar, andererseits können Räume auch
47 ad hoc erstellt werden.},
48 url =https://github.com/tuc-osg/seatingchart,
49 build-title
50 }
51
52 \begin{document}
53
54 \section{Einführung}
55 Für die Durchführung von Prüfungen benötigen wir mitunter Sitzpläne.
56 So haben sich über die einige mit Pläne in Form von TikZ-unterstützten
57 \LaTeX-Dateien angesammelt.
58 Je nach Anzahl der Studierenden in einer Prüfung (und für wie groß wir die
59 Gefahr eines Betrugsversuches bewerten) nutzen wir unterschiedliche
60 Platzierungsschemata, so dass wir die Dateien in anpassen müssen.
61 Außerdem wird uns von Zeit zu Zeit ein neuer Raum zugewiesen, für den wir noch
62 keine Pläne haben.
63
64 Dies war die Motivation zur Erschaffung des \thepkg-Pakets. Es \ldots
65 \begin{itemize}[itemsep=0pt]
66 \item ermöglicht eine schnelle und einfach Erstellung von Sitzplänen;
67 \item trennt das Sitzlayout und das Platzierungsschema voneinander;
68 \item bietet eine Reihe von Standardschemata für die Platzierung an;
69 \item enthält bereits eine Anzahl vordefinierter Räume mit Layouts der Sitze;
70 \item erlaubt eine \emph{Ad-hoc}-Erstellung neuer Räume und Platzierungsschemata.
71 \end{itemize}
72
73 \section{Abhängigkeiten}
74 Das \thepkg-Paket arbeitet nur mit Lua\LaTeX\ und benötigt eine hinreichend
75 moderne \LaTeX-Version, mindestens vom Juli 2022.
76 Es lädt folgende Pakete:
77 \begin{itemize}[nosep]
78 \item \pkg{etoolbox}
79 \item \pkg{luacode}
80 \item \pkg{tikz}
81 \end{itemize}
82 Diese Pakete sind in allen gängigen \TeX-Distributionen vorhanden und haben
83 wiederum andere Pakete als Abhängigkeit.
84 Insbesondere wird durch \pkg*{tikz} das Paket \pkg{xcolor} geladen, dessen
85 Farbdefinition auch in \thepkg\ verwendet werden.
86
87 \section{Sitzlayout}
88 \label{sec:layout}
89 Das Paket wird wie üblich mit
90 %
91 %\centerline{
92 \cs{usepackage}\oarg{optionen}\{\thepkg\}
93 %}
94 geladen.
95 Dabei kann bereits weitgehend das Layout der Sitze festgelegt werden, also
96 die Darstellung der Sitze im Raum. Die Zuweisung der Sitzbelegung erfogt später,
97 siehe Abschnitt~\ref{sec:seat-assignment}.
98
99 \subsection{Klassenoptionen}
100 \label{sec:class-options}
101 Durch die Nutzung bzw. Nichtnutzung der Option \option{room} werden zwei
102 grundsätzliche Anwendungsfälle unterschieden:
103 \begin{options}
104 \keyval-{room}{Raum}\Default{}
105 Diesen Optionsschlüssel sollte man nutzen, wenn der gewünschte
106 Raum ist bereits in der Datenbank von \thepkg\ vorhanden ist.
107 \keyval{layout}{Institution}\Default{tu-chemnitz}
108 Die Daten für die vordefinierten Räume werden
109 aus der Datei \code{seatingchart-}\meta{Institution}\code{.sc} gelesen.
110 Dieser Schlüssel kann genutzt werden, wenn eigene vordefinierte Räume deklariert
111 wurden, siehe Abschnitt~\ref{sec:new-rooms}.
112 \end{options}
113 Falls der Raum noch nicht bekannt ist, werden einige Schlüssel-Wert-Paar zur
114 Beschreibung des Raumslayout gebraucht.
115 \begin{options}
116 \keychoice{shape}{rectangle,arc}\Default{rectangle}
117 Hier wird beschrieben, ob das Layout der Sitze rechteckig
118 (\choices{rectangle}) oder bogenförmig (\choices{arc})\footnote{Z.\,B.\ an der
119 TU~Chemnitz der Raum A10.316.} ist.
120 \keyval-{rows}{Anzahl der Sitzreihen}\Default*!{}\vspace{-.3\baselineskip}
121 \keyval-{seats per row}{Sitze pro Sitzreihe}\Default!{}
122 Besimmt Anzahl der Sitzreihen und Sitze pro Reihe. Dabei muss immer von der
123 jeweils maximalen Anzahl ausgegangen werden. Für unvollständige Reihen werden später Sitze
124 entfernt, aber es können keine Sitze mehr zugefügt werden, die außerhalb des einmal
125 festgelegten Layoutrahmens liegen. \textbf{Achtung:} Auch Gänge zwischen
126 Blöcken von Sitzen müssen hier als Sitze mitgezählt werden.
127 \end{options}
128 Wenn Sie bei den Klassenoptionen \textbf{sowohl} den Schlüssel \option*{room}, \textbf{als auch}
129 eine der Schlüssel \option*{rows} oder \option*{seats per row} angeben, ist das Ergebnis
130 unbestimmt. Entsprechend wird eine Warnung ausgegeben.\medskip
131
132 Alle weiteren Klassenoptionen legen die Darstellung des Raumlayouts fest.
133 Sie können auch später mit \cs{scConfig} gesetzt werden, vgl.\ Abschnitt~\ref{sec:late-options}.
134 \begin{options}
135 \keybool{blackboard}\Default{false}
136 Zeichnet eine Tafel ein.
137 \keyval-{seat distance}{Abstand}\Default{2pt}
138 Abstand der Sitze zueinander. Damit wird auch der Reihenabstand bestimmt.
139 Möchte man beides unterschiedlich haben, so muss man die beiden folgenden
140 Schlüssel nutzen:
141
142 \keyval-{seat neighbor distance}{Abstand}\Default*{2pt}\vspace{-.3\baselineskip}
143 \keyval-{row distance}{Abstand}\Default{2pt}
144
145 \keychoice{rownumbers}{none,left,right,both}\Default{none}
146 Legt beim Rechteck-Layout fest, ob links und oder rechts der Reihen die Nummer
147 der Sitzreihe angegeben wird. Dabei wird von vorn (Tafel) gezählt.\newline
148 \emph{Anmerkung:} Für das bogenförmige Layout ist diese Funktion derzeit
149 nicht implementiert.
150 \keyval-{rownumber distance}{Abstand}\Default{2pt}
151 Abstand der Reihennummern zu den äußeren Sitzen, wenn \option*{rownumbers}
152 nicht \code{none} ist.
153 \keyval-{empty seat background color}{Farbe}\Default*{lightgray!20}\vspace{-.3\baselineskip}
154 \keyval-{empty seat border color}{Farbe}\Default*{lightgray}\vspace{-.3\baselineskip}
155 \keyval-{assigned seat background color}{Farbe}\Default*{lightgray!30}\vspace{-.3\baselineskip}
156 \keyval-{assigned seat border color}{Farbe}\Default{black}
157 Legt die Farben für den Hintergrund und die Umrandung von leeren bzw.\ durch
158 ein Sitzschema belegten Sitzen fest.
159 Falls die Sitze nicht farblich unterschieden werden sollen, können auch die
160 Schlüssel
161 \keyval-{seat background color}{Farbe}\Default*\vspace{-.3\baselineskip}
162 \keyval-{seat border color}{Farbe}\Default
163 verwendet werden.
164 \keyval{assigned seat label font}{Fontbefehl}\Default*{\cs*{small}}\vspace{-.3\baselineskip}
165 \keyval-{assigned seat label color}{Farbe}\Default{black}
166 Setzt die Größe und Farbe der Sitzbeschriftung.
167 \end{options}
168 \subsection{Späte Optionswahl}
169 \label{sec:late-options}
170 \begin{commands}
171 \command{scConfig} Mit diesem Kommando können außer
172 \option{room}, \option{shape}, \option{rows} und \option{seats per row} alle
173 im Abschnitt~\ref{sec:class-options} genannten Schlüssel auch
174 außerhalb von \cs*{documentclass}-Optionen gesetzt werden.
175 \end{commands}
176 \subsection{Modifikation des Sitzlayouts}
177 \label{sec:modify-layout}
178 Häufig ist sind nicht in jeder Reihe alle Sitze vorhanden.
179 Bei Angabe eine Raums ist dies bereits berücksichtigt, aber auch hier kann es
180 vorkommen, dass beispielsweise ein Klappsitz defekt ist und aus dem Layout
181 genommen werden muss.
182 Beim Erstellen eines eigenen Layouts ist die Modifikation die Regel.
183 Dafür stellt \pkg\ folgende Kommandos zur Verfügung
184 \begin{commands}
185 \command{scRemoveSeatAt}[\marg{Reihe}\marg{Sitznummer}]
186 Entfernt den Sitz \meta{Sitznummer} in der Reihe \meta{Reihe} aus dem
187 Layout. Dabei beziehen sich \meta{Reihe} und \meta{Sitznummer} auf das
188 vollständige Layout, ändern sich also nicht durch bereits entfernte Sitze.
189 Wenn die \meta{Sitznummer} negativ ist, wird von rechts aus gezählt
190 \command{scRemoveSeats}[\marg{Liste}]
191 Entfernt alle in der Liste vorkommenden Sitze aus dem Layout. Die Liste enthält
192 dabei kommaseparierte Einträge der Form
193 \code{\{\meta{Reihe},\meta{Sitznummer}\}}. Für \meta{Reihe} und
194 \meta{Sitznummer} gilt wie bei \cs*{scRemoveSeatAt} das urspüngliche Layout.
195 Im folgenden Beispiel werden die ersten drei Sitze links und der erste Sitz
196 rechts in der ersten Reihe entfernt:
197 \begin{example}[code-only]
198 \scRemoveSeats{{1,1},{1,2},{1,3}{1,-1}}
199 \end{example}\vspace{-1.3\baselineskip}
200 \command{scSetAisle}[\Oarg{\meta{Startreihe}-\meta{Endreihe}}\marg{Sitznummer}]
201 %\Default{\meta{erste Reihe}-\meta{letzte Reihe}}
202 An der Stelle von \meta{Sitznummer} wird durch alle Reihen ein Gang eingefügt. Nutzen Sie das
203 optionale Argument, wenn der Gang nicht alle Reihen erfassen soll (Stichgang).
204 Für horizontale Gänge (die also einen Sitzblock in einen vorderen und hinteren
205 Teil zerlegen, anstatt einen rechten und einen linke) nutzen Sie bitte
206 \cs*{scRemoveSeats}.
207 Das ist im Prinzip auch bei vertikalen Gängen möglich, jedoch können bei der automatischen
208 Sitzschemazuweisung mit \cs*{scSetAisle} erzeugte Gänge anders als die mit
209 \cs*{scRemoveSeats} erzeugten Gänge behandelt werden.
210 \end{commands}
211
212 \subsection{Ausgabe}
213 \label{sec:drawing}
214 \begin{commands}
215
216 \command{scDrawSeating}[\Oarg{seat width=\meta{Breite}, seat height=\meta{Höhe}}]
217 Gibt den Sitzplan aus. Dabei versucht \thepkg, die Ausmaße der Sitz so zu
218 berechnen, dass der zur Verfügung stehenden Platz des Gesamtplans vollständig
219 ausgenutzt wird.
220 Da damit nicht immer alle Bedürfnisse getroffen werden, können in der
221 über das optionale Argument die Breite und Höhe der Sitze auf
222 dem Sitzplan einzeln eingestellt werden.
223 \end{commands}
224
225 Das folgende Beispiel zeigt den Code und das Ergebnis für ein einfaches Sitzplanlayout
226 mit einem Mittelgang und zwei fehlenden Sitzen in der ersten Reihe.
227 \begin{example}[compile,program=lualatex,pages=1,add-frame,code-sep=\bigskip,graphics={scale=.25}]
228 \documentclass{article}
229 \usepackage[shape=rectangle, rows = 9, seats per row=15]{seatingchart}
230 \begin{document}
231 \scSetAisle{8}
232 \scRemoveSeats{{1,1},{1,2}}
233 \scDrawSeating
234 \end{document}
235 \end{example}
236
237 \section{Sitzplatzbelegung}
238 \label{sec:seat-assignment}
239 \subsection{Parameter zur Konstruktion von Belegungsschemata}
240 \label{sec:constr-scheme}
241 Natürlich ist ein Sitzplan ohne die Markierung von belegten Plätzen
242 nur bedingt nützlich.
243 Die Belegung wird in \thepkg\ mit Sitzplatzschemata realisiert.
244 Zur Erzeugung eines Sitzschemas gibt es den Befehl
245 \begin{commands}
246 \command{scSeatingScheme}[\oarg{Schlüsselliste}\marg{Name}] \vspace{-1.3\baselineskip}
247 \command{scSeatingScheme}[\sarg\oarg{Schlüsselliste}\marg{Schema}]
248 Das Pflichtargument enthält in der Standardvariante des Befehls eine Bezeichnung
249 für ein vorgegebenes Sitzschema, siehe Abschnitt~\ref{sec:defined-schemes}.
250 In der Sternvariante wird hier eine Zeichenkette von "`\code{X}"' und "`\code{-}"' übergeben,
251 die (den Anfang) eines Sitzschemas für eine einzelne Reihe beschreibt, wobei
252 "`\code{X}"' für einen belegten und "`\code{-}"' für einen leeren Platz steht. Ist die
253 Zeichenkette kürzer als die Anzahl der Sitze in der Reihe, wird sie wiederholt angewendet.
254 Reihe mehr Plätze als
255 Beispielsweise wird mit
256 \begin{example}[code-only]
257 \scSeatingScheme*{X--}
258 \end{example}\vspace{-1.3\baselineskip}
259 jeder dritte Sitz belegt.
260
261 Im optionalen Argument kann wieder eine Liste von Schlüssel-Wert-Paaren
262 übergeben werden, die die restlichen Einstellung für das Sitzschema steuern. Es
263 ist insbesondere in der Sternvariante wichtig, kann aber auch in der
264 Standardvariante genutzt werden.
265 werden:
266 \begin{options}
267 \keyval-{row sep}{Anzahl}\Default{2}
268 Legt fest, in jeder wievielten Reihe Sitze belegt werden.
269 \keyval-{start row}{Nummer}\Default*{1}\vspace{-.3\baselineskip}
270 \keyval-{end row}{Nummer}\Default{\meta{Anzahl Reihen}}
271 Durch diese beiden Schlüssel wird gesteuert, in welchen Reihen ein Schema
272 angewendet wird. Dadurch können unterschiedliche Schemata für verschiedene
273 Reihen genutzt werden.
274 \keyval-{row restart after}{Anzahl}\Default
275 Das Sitzschema wird nach \meta{Anzahl} Reihen zurückgesetzt. Damit wird es
276 möglich, alternanierende Reihenabstände zu erzielen, vergleiche Beispiel in
277 Abschnitt~\ref{sec:ex:own1}.
278 \keyval-{aisle counts}{Anzahl}\Default{1}
279 Legt fest, wie viele Sitze ein Gang zählt. Dadurch kann berücksichtigt werden,
280 dass ein Gang häufig breiter als ein Sitzplatz ist.
281 \keybool{aisle restarts scheme}\Default{false}
282 Startet das Schema nach einem Gang erneut. Der Schlüssel \option*{aisle
283 counts} wird damit wirkungslos.
284 \keybool{ignore aisle}\Default*{false}\vspace{-.3\baselineskip}
285 \keybool{ignore removed seats}\Default{false}
286 Bei der Zählung von Sitzen, die im Platzlabel genutzt werden kann (vgl.\
287 Abschnitt~\ref{sec:seat-label}) werden auch entfernte Sitze und Gänge
288 mitgezählt.
289 Dies ist sinnvoll, damit in Reihen (im Rechteck-Grundlayout) sich gleiche
290 Sitznummern hintereinander befinden. Wird einer der Schlüssel gesetzt,
291 werden entfernte Sitze bzw. Gänge nicht mitgezählt. Dies bietet sich
292 insbesondere im Bogen-Grundlayout an.
293 \keyval{assigned seat label}{Formatzeichenkette}\Default{m\{\{\string\,\}\}D}
294 Über diesen Schlüssel kann festgelegt werden, wie die belegten Sitze
295 beschriftet werden. Voreingestellt ist die Nummer der Reihe, gefolgt von einem
296 schmalen Leerzeichen und einem Buchstaben für den laufenden belegten Sitz
297 (z.\,B. "`3\,c"'). Es sind hier eine Reihe anderer Möglichkeiten
298 einstellbar. Details dazu sind im Abschnitt~\ref{sec:seat-label} beschrieben.
299 \end{options}
300 \command{scConfigScheme\marg{Schlüsselliste}}
301 Setzt die Schlüssel wie beim optionalen Argument von \cs*{scSeatingScheme},
302 führt aber keine Zuweisung von Sitzen aus.
303 \end{commands}
304 Schlüsselwerte, die durch \cs*{scSeatingScheme} oder \cs*{scConfigScheme}
305 gesetzt werden, bleiben erhalten, bis sie explizit neu gesetzt werden.
306
307 \subsection{Vordefinierte Sitzschemata}
308 \label{sec:defined-schemes}
309 Das \thepkg-Paket definiert eine Reihe vordefinierter
310 Platzierungsschemata. Manche haben auch einen Alternativnamen.
311 \begin{options}
312 \opt{1x1}
313 Jeder Platz ist markiert.\newline Alternativname: \option{all}
314 \opt{2x2}
315 Zwischen zwei belegten Plätzen ist jeweils ein Platz bzw.\ eine Reihe
316 Abstand.\newline Alternativname: \option{simple}
317 \opt{2x2-}
318 Zwischen zwei belegten Plätzen ist jeweils ein freier Platz. Nach einer freien
319 Reihe kommen \emph{zwei} Reihen mit belegten Plätzen. Dies ist das Schema, mit
320 dem in einer Prüfung die größtmögliche Zahl an Studierenden in einem Raum
321 untergebracht werden können, aber trotzdem ein seitlicher Minimalabstand
322 gegeben ist und sich die Aufsicht zu jedem Studierenden kommen kann (entweder
323 von vorn, oder von hinten). \newline Alternativname: \option{dense}
324 \opt{2x3}
325 Belegte Sitze haben einen seitlichen Abstand von zwei Sitzen und belegte
326 Reihen einen Abstand von einer Leerreihe. Dies wird in unser Gruppe als das
327 anzustrebende Standardschema für Prüfungen betrachtet.\newline Alternativname:
328 \option{sixpack}
329 \opt{2x3-}
330 Die Reihen werden wie bei \option{2x2-} belegt, der seitliche Abstand
331 innerhalb einer belegten Reihe beträgt jedoch zwei Sitze.
332 \opt{2x4}
333 Belegte Sitze haben einen seitlichen Abstand von drei Sitzen und belegte
334 Reihen einen Abstand von einer Leerreihe.
335 \opt{3x4}
336 Belegte Sitze haben einen seitlichen Abstand von drei Sitzen und belegte
337 Reihen einen Abstand von zwei Leerreihen.
338 \end{options}
339
340 \subsection{Sitzbeschriftung}
341 \label{sec:seat-label}
342 Die Beschriftung der zugewiesenen Sitzplätze kann auf unterschiedliche Weise
343 erfolgen, die durch Zuweisung einer Formatzeichenkette an den Schlüssel
344 \option{assigned seat label} gesteuert wird.
345 Es stehen dafür vier Zähler zur Verfügung:
346 \begin{itemize}
347 \item absolute Reihe: die Nummer der Reihe im Sitzlayout
348 \item laufende Reihe: die Nummer der \emph{belegten} Reihe. Reihen, in denen
349 keine Sitz zugewiesen werden, werden hier übersprungen.
350 \item absolute Sitznummer: die Nummer des Sitzes im Sitzlayout. Ob hier auch
351 entfernte Sitze berücksichtigt werden, hängt vom Wert des Schlüssels
352 \option*{ignore removed seats} ab.
353 \item laufende Sitznummer: die Nummer der \emph{belegten} Sitze. Unbelegte Sitze
354 werden bei der Zählung übersprungen.
355 \end{itemize}
356 Jeder dieser Zähler kann unterschiedlich formatiert werden. Dafür werden in der
357 Formatzeichenkette verschiedene Formatierungszeichen benutzt, die in der
358 folgenden Tabelle gelistet sind:\medskip
359
360 \begin{tabular}{llccccc}\hline
361 \textbf{\sffamily Zähler}&\textbf{\sffamily Anmerkung}&\multicolumn{5}{c}{\textbf{\sffamily Darstellung als\ldots}}\\
362 &&\rotatebox{90}{(arabische) Zahl}&\rotatebox{90}{Kleinbuchstabe}&\rotatebox{90}{Großbuchstabe}&
363 \rotatebox{90}{kleine römische Zahl}&\rotatebox{90}{große römische
364 Zahl}\\\hline
365 absolute Reihe&\emph{bezieht sich auf das Sitzlayout}&\code{m}&\code{a}&\code{A}&\code{y}&\code{Y}\\
366 laufende Reihe&\emph{bezieht sich auf das Belegungsschema}&\code{r}&\code{b}&\code{B}&\code{i}&\code{I}\\
367 absolute Sitznummer&\emph{bezieht sich auf das Sitzlayout}&\code{n}&\code{c}&\code{C}&\code{x}&\code{X}\\
368 laufende Sitznummer&\emph{bezieht sich auf das Belegungsschema}&\code{s}&\code{d}&\code{D}&\code{j}&\code{J}\\\hline
369 \end{tabular}\medskip
370
371 \noindent
372 Teile der Beschriftung, die nicht als Formatierungszeichen interpretiert werden
373 sollen, werden in doppelte geschweifte Klammern gesetzt
374 (\code{\{\{\meta{geschützte Zeichenkette}\}\}}).
375 Beispielsweise erzeugt
376 \begin{example}[code-only]
377 \scSeatingScheme[assigned seat label=Y{{-}}D]{2x3}
378 \end{example}\vspace{-1.3\baselineskip}
379 beim vierten Sitz (von links) in der dritten Reihe die Beschriftung "`III-B"'.
380
381 \subsection{Sitzplatzliste}
382 \label{sec:seats-list}
383 Insbesondere wenn es um den Anwendungsfall einer Prüfung geht, ist es nützlich,
384 eine Sitzplatzliste zu erhalten, also eine tabellarische Zuordnung zwischen Prüfling und Sitzplatz.
385 In der aktuellen Version erstellt \thepkg\ keine (\LaTeX)-Tabelle, kann aber
386 die Tabellenerstellung (mit \LaTeX\ oder einer Tabellenkalkulation)
387 unterstützen.
388 \begin{commands}
389 \command{scSeatingList}[\oarg{Eingabedatei}\marg{Ausgabedatei}]\vspace{-1.3\baselineskip}
390 \command{scSeatingList}[\sarg\oarg{Eingabedatei}\marg{Ausgabedatei}]
391 Erstellt eine CVS-Datei \meta{Ausgabedatei} mit den Labels der belegten
392 Plätze, jeweils einen pro Zeile.\medskip
393
394 \framebox{\parbox{\linewidth}{
395 \textbf{Achtung!}
396 Die in die \meta{Ausgabedatei} geschriebenen Labeltexte werden aus den
397 entsprechenden \LaTeX-Boxen extrahiert und nur die druckbaren Zeichen
398 ausgegeben.
399 Es empfiehlt sich bei Nutzung dieser Funkion daher, in der
400 Formatzeichenkette von \option*{assigned seat label} auf zuviel
401 \TeX-Magie zu verzichten.
402 }}\medskip
403
404 In der Sternvariante werden in jeder Zeile
405 die absoluten Koordinaten (Reihe, Platznummer, bezogen auf das
406 Grundlayout) kommasepariert dem Labeln vorangestellt.
407
408 Wenn eine Eingabedatei angegeben wurde, wird ihr Inhalt zweilenweise den
409 erzeugten Zeilen vorangestellt. Diese Eingabedatei könnte beispielsweise die Namen
410 oder/und die Immatrikulationsnummern von Studierenden enthalten, die dann in der
411 Ausgabedatei den markierten Plätzen zugeordnet werden.
412 Sind weniger Einträge in \meta{Eingabedatei} als Sitze belegt sind, werden
413 die Felder in der Ausgabe leer gelassen.
414 Wenn dagegen die Anzahl der Sitze nicht ausreicht, gibt \thepkg\ eine
415 Information aus, wer nicht platziert werden konnte.
416 \end{commands}
417 \section{Beispiele}
418 \label{sec:examples}
419 Zur Demonstration des Verhaltens von \thepkg\ sind hier einige Beispiele des
420 Einsatzes dokumentiert.
421 \subsection{Dichte Belegung für den Beispielraum aus Abschnitt~\ref{sec:drawing}}
422 \label{sec:ex-simple}
423 \begin{example}[compile,program=lualatex,pages=1,add-frame,code-sep=\bigskip,graphics={scale=.25}]
424 \documentclass{article}
425 \usepackage[shape=rectangle, rows = 9, seats per row=15]{seatingchart}
426 \begin{document}
427 \scSetAisle{8}
428 \scRemoveSeats{{1,1},{1,2}}
429 \scSeatingScheme{2x2-}
430 \scDrawSeating
431 \end{document}
432 \end{example}
433 \subsection{Vordefinierter Raum, rechteckig}
434 \label{sec:ex:std-rect}
435 \begin{example}[compile,program=lualatex,pages=1,add-frame,code-sep=\bigskip,graphics={scale=.5}]
436 \documentclass{scrartcl}
437 % Um das Papier gut auszunutzen, nehmen wir es Landscape-Format
438 % und reduzieren die Ränder
439 \usepackage[a4paper,landscape,inner=10pt,outer=10pt,top=1cm,bottom=1cm]{geometry}
440 \usepackage[
441 room=C10.115,
442 blackboard
443 ]{seatingchart}
444
445 \begin{document}
446 % Standardtitelei nimmt viel Platz weg.
447 \centering\textbf{\Huge\sffamily Sitzplan C10.115}\bigskip
448 \scSeatingScheme{sixpack}
449 \scDrawSeating
450 \end{document}
451 \end{example}
452
453 \subsection{Vordefinierter Raum, bogenförmig}
454 \label{sec:ex:std-arc}
455 \begin{example}[compile,program=lualatex,pages=1,add-frame,code-sep=\bigskip,graphics={scale=.5}]
456 \documentclass{scrartcl}
457 % Um das Papier gut auszunutzen, nehmen wir es Landscape-Format
458 % und reduzieren die Ränder
459 \usepackage[a4paper,landscape,inner=10pt,outer=10pt,top=1cm,bottom=1cm]{geometry}
460 \usepackage[
461 room=A10.316,
462 blackboard,
463 assigned seat label color=blue
464 ]{seatingchart}
465
466 \begin{document}
467 % Standardtitelei nimmt viel Platz weg.
468 \centering\textbf{\Huge\sffamily Sitzplan A10.316}\bigskip
469 \scSeatingScheme[ignore removed seats]{2x2}
470 \scDrawSeating
471 \end{document}
472 \end{example}
473 \subsection{Eigenes Platzlayout und angepasstes Sitzschema}
474 \label{sec:ex:own1}
475 \begin{example}[compile,program=lualatex,pages=1,add-frame,code-sep=\bigskip,graphics={scale=.5}]
476 \documentclass{scrartcl}
477 % Um das Papier gut auszunutzen, nehmen wir es Landscape-Format
478 % und reduzieren die Ränder
479 \usepackage[a4paper,landscape,inner=10pt,outer=10pt,top=1cm,bottom=1cm]{geometry}
480 \usepackage[
481 shape=rectangle, rows=9, seats per row=9,
482 assigned seat background color=yellow
483 ]{seatingchart}
484
485 \begin{document}
486 \scRemoveSeats{{1,1},{1,-1},{2,1},{2,-1},{3,1},{3,-1}}
487
488 \scSeatingScheme[ignore removed seats,end row=3]{2x3}
489 \scSeatingScheme[start row=5, end row=10]{2x4}
490 \scDrawSeating
491 \end{document}
492 \end{example}
493 \subsection{Dame}
494 \label{sec:ex:dame}
495 \begin{example}[compile,program=lualatex,pages=1,add-frame,code-sep=\bigskip,graphics={scale=.5}]
496 \documentclass{scrartcl}
497 \usepackage[a5paper,landscape,top=1cm,bottom=1cm]{geometry}
498 \usepackage[shape=rectangle, rows=10,seats per row=10,
499 assigned seat label color=blue, assigned seat background color=teal,
500 empty seat background color=lime!50,
501 seat distance=0pt]{seatingchart}
502 \usepackage{stix}
503 \begin{document}
504 \centering\textbf{\Huge\sffamily Let's play Checkers}\bigskip
505
506 \scConfigScheme{assigned seat label={}}
507 \scSeatingScheme*[start row=5, end row=5]{X-}
508 \scSeatingScheme*[start row=6, end row=6]{-X}
509 \scConfigScheme{assigned seat label font=\Huge, assigned seat label={{{\textcolor{white}{$\circledbullet$}}}}}
510 \scSeatingScheme*[start row=1, end row=3,row sep=2]{X-}
511 \scSeatingScheme*[start row=2, end row=4]{-X}
512 \scConfigScheme{assigned seat label={{{\textcolor{yellow}{$\circledbullet$}}}}}
513 \scSeatingScheme*[start row=7, end row=9]{X-}
514 \scSeatingScheme*[start row=8, end row=10]{-X}
515
516 \scDrawSeating[seat width=1cm, seat height=1cm]
517 \end{document}
518 \end{example}
519 \section{Deklaration neuer Raumlayouts}
520 \label{sec:new-rooms}
521 In der augenblicklichen Version hat das \thepkg-Paket erst eine relativ geringe Anzahl
522 von Räumen der TU~Chemnitz mit ihrem Sitzlayout erfasst.
523 Nutzer werden daher häufig darauf angewiesen sein, eigene Layouts anzulegen.
524
525 Neben der Möglichkeit zur Ad-hoc-Kreation von Layouts, wie sie im
526 Abschnitt~\ref{sec:layout} beschrieben sind, besteht auch die Möglichkeit das
527 Paket selbst zu erweitern und damit Layouts für neue Räume anzulegen, die dann
528 einfach über den \option{room}-Schlüssel angesprochen werden können.
529 Dazu können eigene \code{seatingchart-*.sc}-Dateien angelegt und über die
530 \option{layout} eingebunden werden.
531
532 In einer \code{seatingchart-*.sc} können zwei Befehle genutzt werden:
533 \begin{commands}
534 \command{scDeclareRoom}[\marg{Raumbezeichnung}\marg{Schlüsselliste}]
535 Ein neues Raumlayout wird für den Raum \meta{Raumbezeichnung} angelegt.
536 Die Schlüsselliste \emph{muss} die drei Schlüssel
537 \begin{options}
538 \keychoice{shape}{rectangle,arc}\Default*!{}%\vspace{-.3\baselineskip}
539 \keyval-{rows}{Anzahl der Sitzreihen}\Default*!{}%\vspace{-.3\baselineskip} und
540 \keyval-{seats per row}{Sitze pro Sitzreihe}\Default!{}
541 enthalten, die die analoge Bedeutung zu den
542 gleichnamigen Schlüsseln aus Abschnitt~\ref{sec:layout} haben.
543 Diese Angaben zum Basislayout \emph{müssen} von dem Schlüssel
544 \opt{init}\Default!
545 gefolgt werden.
546 Anschließend kann mit
547 \keyval-{aisle}{Sitznummer}\vspace{-1.3\baselineskip}
548 \keyval{remove}{Liste}
549 das Layout angepasst werden. Die beiden Schlüssel funktionieren analog zu
550 \cs*{scSetAisle} und \cs*{scRemoveSeats}, vgl.\ Abschnitt~\ref{sec:modify-layout}.
551 \end{options}
552 \begin{example}[code-only]
553 \scDeclareRoom{C10.115}{
554 shape=rectangle,
555 rows=21,
556 seats per row=35,
557 init,
558 aisle=18,
559 remove={{1,1},{1,2},{1,3},{1,4},{1,-1},{1,-2},{1,-3},{1,-4}}
560 }
561 \end{example}\vspace{-1.3\baselineskip}
562 \command{scAliasRoom}[\marg{Aliasname}\marg{Originalname}]
563 Setzt \meta{Aliasname} als einen Ersatznamen für \meta{Originalname}.
564 \end{commands}
565 Wenn Sie wünschen, dass eine Layoutdatei ihrer Institution Bestandteil des
566 Pakets auf CTAN wird, schicken Sie bitte dem Maintainer ihre Datei oder
567 initiieren Sie einen Pull-Request auf
568 \url{https://github.com/tuc-osg/seatingchart}.
569 Geben Sie in diesem Fall der Datei einen aussagekräftigen und
570 unterscheidungsfähigen Namen. Beispielsweise
571 sollte die \emph{Lummerland Maschinenbau Universität}
572 eher \code{seatingchart-lummerland-mu.sc} oder
573 \code{seatingchart-lummerland-machbau-uni.sc} nutzen, als
574 \code{seatingchart-lmu.sc}.
575
576 \section{Beschränkungen und Bugs}
577 \label{sec:bugs}
578 Auch wenn das \thepkg-Paket zumindest in unserer Gruppe im praktischen Einsatz
579 ist, ist es als experimentell zu betrachten.
580 Die \code{0} in der Hauptversionsnummer deutet diesen Umstand an.
581 Er bedeutet insbesondere, dass sich die API noch ändern kann.
582
583 Das Pakte unterliegt einigen Einschränkungen.
584 Ob diese in kommenden Versionen behoben werden, steht noch nicht fest.
585 Das Paket ist auf die Erstellung separater Sitzpläne ausgelegt und kann daher
586 nicht dafür genutzt werden, mehrere Sitzpläne in einem Dokument darstellen.
587 Ebenfalls können keine Sitzlayouts mit versetzten Sitzreihen dargestellt werden.
588
589 Die Anzahl der vordefinierten Räume ist derzeit noch eher gering.
590 Es besteht die Absicht, in künftigen Patches weitere Räume der TU~Chemnitz
591 aufzunehmen.
592 Layoutdateien von anderen Institutionen sind willkommen.
593
594 Bogenförmiges Raumlayout ist bei kleineren Reihenlängen problematisch.
595 Bitte nutzen Sie für Bugs-Reports oder Pull-Requests GitHub:
596 \url{https://github.com/tuc-osg/seatingchart}.
597
598 \section{Lizenz}
599 Es ist erlaubt, diese Software unter den Bedingungen der \LaTeX Project Public
600 License (LPPL), Version 1.3c oder später, zu kopieren und zu verteilen
601 (\url{http://www.latex-project.org/lppl.txt}).
602 \end{document}