Fix nonce typo

[exsheet.git] / README.markdown

diff --git a/README.markdown b/README.markdown
index d0be65c3cbc60a41a44b04fca146d7376f69581e..f5d8c6ef9a2499bbc60110fe3517000ba5d72d38 100644 (file)
--- a/README.markdown
+++ b/README.markdown
@@ -16,11 +16,19 @@ Ich verwende die Klasse für zwei Kategorien von Anwendungsfällen:
 
 ## Installation
 
+Die einfache Lösung ist, dass man `exsheet2.cls` lokal in jedes Verzeichnis
+gibt, wo es verwendet wird, d.h. wo die betreffenden LaTeX Dokumente liegen.
+
 Die nachhaltige Lösung ist das Kopieren der Datei `exsheet2.cls` in ein
 [TEXINPUTS](https://www2.ph.ed.ac.uk/~wjh/tex/documents/environmental.pdf)
-Verzeichnis. Die schlechtere Alternativ ist, dass man `exsheet2.cls` lokal in
-jedes Verzeichnis gibt, wo es verwendet wird, d.h. wo die betreffenden LaTeX
-Dokumente liegen.
+Verzeichnis. Alternativ bietet sich das Klonen dieses Repositories und das
+Verlinken von `exsheet2.cls` in ein Verzeichnis in `TEXINPUTS` an. Das macht
+ein Update über git einfacher.
+
+Das originale Repository findet sich auf
+[git.sthu.org](https://git.sthu.org/?p=exsheet.git;a=summary). Ein Klon auf
+[github.com/shuber2/exsheet](https://github.com/shuber2/exsheet) macht das
+Verwalten von Issues und Pull Requests einfacher.
 
 
 ## Allgemeine Features
@@ -67,13 +75,15 @@ weitergeleitet.
 
 Es können über folgende Befehle entsprechend die Daten zur Klausur gesetzt
 werden: `\title`, `\author`, `\date`, `\course`, `\curriculum`, `\semester`,
-`\institute`, `\school`, `\duration`, `\instructions`.
+`\institute`, `\school`, `\duration`, `\instructions`. Achtung, `\date` muss
+das Datum im ISO-Format erhalten, also yyyy-mm-dd. Wenn kein Datum gesetzt
+wird, dann wird das aktuelle Datum verwendet.
 
 
-## Aufgsabenblätter
+## Aufgabenblätter
 
 Die Klassse `exsheet2` erzeugt ohne weitere Optionen einfache Aufgabenblätter.
-Es werden zwei Sprachen unterstützt und notwendige Packete entsprechend geladen:
+Es werden zwei Sprachen unterstützt und notwendige Pakete entsprechend geladen:
 
 * american
 * german, ngerman
@@ -91,7 +101,7 @@ Aufgabenblatt mit einer Aufgabe lautet wie folgt:
 \course{ILV Numerik und Industrielle Algorithmen}
 \curriculum{ITS}
 
-\date{21.10.2022}
+\date{2022-10-21}
 \semester{WS 2022}
 
 \author{Stefan Huber}
@@ -125,6 +135,12 @@ führt zu folgendem zusätzlichem Verhalten:
   losen Blättern zu Klausuren und verhindert, dass Blätter von Student·innen
   vorgeschrieben werden können.
 
+Durch die automatische Berechnung der Punktesummen wird das **effiziente
+Generieren von Klausuren** über Fragenkataloge erleichtert: Man kann in einem
+Sammeldokumente Fragen sammeln, die vom Umfang mehrere Klausuren füllen und für
+die Erstellung konkreter Klausuren fragen löschen, um auf die gewünschte
+Punktezahl zu kommen.
+
 Die Kopfzeile enthält jene Informationen, welche rasch erkennen lassen sollen,
 um welche Klausur es sich handelt. Das ist für Sammelklausuren, wo gleichzeitig
 viele verschiedene Klausuren durchgeführt werden, für die Beaufsichtigung
@@ -134,3 +150,22 @@ Zwei Beispiele befinden sich als Demo im Repository:
 
 * [exsheet2-demo-klausur.tex](exsheet2-demo-klausur-en.tex) ist eine deutsche Klausur
 * [exsheet2-demo-klausur-en.tex](exsheet2-demo-klausur-en.tex) ist eine englische Klausur
+
+
+## Abschlussprüfungen
+
+Abschlussprüfungen, etwa eine Bachelorprüfung, ist ähnlich zu einer Klausur,
+mit wenigen Unterschieden. Da die Prüfung in unserer Anwendung für
+Student·innen individualisiert ist, ist der Studierendenname im Titel. Die
+Formularelement für die Benotung und die Studierendeninformationen sind
+obsolet. Die Dauer ist durch den Prüfungsprozess vorgegeben und muss nicht am
+Deckblatt angegeben werden. Auch die Semesterangabe hat keine Bedeutung.
+
+Um diesen Fall abzubilden werden folgende Features unterstützt:
+* Wenn `\duration` oder `\semester` nicht gesetzt werden, dann wird die
+  Information nicht angezeigt.
+* Durch die Option `nostudentinfo` und `nogradeinfo` werden die jeweiligen
+  Formularelemente auf dem Deckblatt nicht angezeigt.
+
+Ein Beipsiel [exsheet2-demo-bapruefung.tex](exsheet2-demo-bapruefung.tex)
+befindet sich im Repository.