Skip to content

Commit

Permalink
Fehlerbehebung im *.tex-Dokument der Dokumentation
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexanderKaschta committed Aug 8, 2020
1 parent 6c9e52a commit 955779a
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions documentation/documentation.tex
Original file line number Diff line number Diff line change
Expand Up @@ -207,8 +207,8 @@ \subsection{Installation}
\href{https://github.com/AlexanderKaschta/WeidigWahl}{GitHub-Repository}\footnote{\url{https://github.com/AlexanderKaschta/WeidigWahl}} herunterladen.

Zum Download der Zip-Datei öffnet man den Link zum Repository im Internet-Browsers
seines Vertrauens. Dort muss man zuerst auf \glqq Clone or download \grqq und dann
auf \glqq Download Zip \grqq klicken. Nach dem Download muss die entsprechende
seines Vertrauens. Dort muss man zuerst auf \glqq Clone or download\grqq{} und dann
auf \glqq Download Zip\grqq{} klicken. Nach dem Download muss die entsprechende
ZIP-Datei noch entpackt werden.

Für das Klonen mittels \href{https://git-scm.com/}{Git} muss nur folgender Befehl
Expand Down Expand Up @@ -384,7 +384,7 @@ \subsection{Anmeldeseite}
man die Anmeldung ausführen kann.

Falls man sein Passwort vergessen hat, dann kann man unten auf einen Hyperlink
mit der Aufschrift \glqq Accountdaten vergessen\grqq drücken. Dies lässt eine kleine
mit der Aufschrift \glqq Accountdaten vergessen\grqq{} drücken. Dies lässt eine kleine
Box unten erscheinen, wo ein Hinweis dazu steht. Dazu soll man entweder seinen
zuständigen Lehrer fragen oder sich an den Administrator der Platform wenden.

Expand All @@ -406,13 +406,13 @@ \subsubsection{Abmeldung}

Sobald man sich angemeldet hat, sieht man auf jeder der Seiten die Navigationsleiste
mit der Aufschrift \name. Ganz rechts auf der Navigationsleiste steht der Text
\glqq Logout\grqq, womit man sich abmelden kann.
\glqq Logout\grqq{}, womit man sich abmelden kann.

\subsection{Hauptseite}

Die Hauptseite bekommt man nach der Anmeldung zu gesicht. Für einen Administrator
sind dort alle Kurswahlen aufgelistet, die es gibt. Dazu gibt es noch zwei spezielle
Einträge mit \glqq Neue Wahl!\grqq und \glqq Schüler\grqq. Bei der ersten Kachel
Einträge mit \glqq Neue Wahl!\grqq{} und \glqq Schüler\grqq{}. Bei der ersten Kachel
kann man eine neue Kurswahl erstellen. Dies ist im Abschnitt |Wahl erstellen|
dokumentiert. Mit der zweiten Kachel gelangt man zur |Teilnehmerverwaltung|.
Dort kann man alle Nutzer der Platform einsehen und verwalten. Nur Nutzer mit
Expand Down Expand Up @@ -611,7 +611,7 @@ \subsubsection{CSV-Import}
Sobald die Verarbeitung erfolgreich durchgeführt worden ist, wird die ursprüngliche
hochgeladene und im Ordner |uploads| gespeicherte |CSV-Datei| gelöscht, sodass
keinerlei Rückstände zurückbleiben. Tritt jedoch ein Fehler bei der Verarbeitung
der |CSV-Datei|\footnote{Die Datei wird im Laufe des Uploads umbenannt, sodass sie nun \glqq students.*\grqq heißt.}
der |CSV-Datei|\footnote{Die Datei wird im Laufe des Uploads umbenannt, sodass sie nun \glqq students.*\grqq{} heißt.}
auf, so kann es sein, dass diese nicht korrekt gelöscht wird. Nach der erfolgreichen
Verarbeitung wird man wieder auf die Übersicht aller Nutzer weitergeleitet.

Expand All @@ -623,10 +623,10 @@ \subsection{Verwaltung einer Wahl}
Ganz oben wird der |Name|, die |Beschreibung| als auch der Zeitraum der Wahl angezeigt.
Außerdem wird dort auch angezeigt, ob die Wahl |aktiv| ist oder nicht. Falls die
Wahl deaktiviert ist, so befindet sich unter der Zusammenfassung ein Button mit der
Beschriftung \glqq Wahl aktivieren!\grqq, womit man die Wahl aktivieren kann. Falls
Beschriftung \glqq Wahl aktivieren!\grqq{}, womit man die Wahl aktivieren kann. Falls
die Wahl aktiv ist, dann kann sie dann über den Button \glqq Wahl deaktivieren!\grqq
deaktiviert werden. Daneben gibt es noch einen \textcolor{red}{\textbf{roten hinterlegten}}
Button mit der Aufschrift \glqq Wahl löschen!\grqq, womit man eine ganze Wahl inklusive
Button mit der Aufschrift \glqq Wahl löschen!\grqq{}, womit man eine ganze Wahl inklusive
Kurse und Ergebnisse löschen kann.

Dadrunter gibt es die Möglichkeit eine Zusammenfassung hochzuladen. Dies muss eine
Expand All @@ -641,23 +641,23 @@ \subsection{Verwaltung einer Wahl}
Kursliste gibt es die Möglichkeit, |Minimum| und |Maximum| zu bearbeiten. Außerdem
gibt es die Möglichkeit, den vorhandenen Kurs zu löschen. Es wird empfohlen, dies
nur wären der Erstellung der Wahl zu tun. Für die Erstellung eines neuen Kurses
muss man nur auf \glqq Kurs anlegen!\grqq drücken. Alles weitere zu dem Thema ist
muss man nur auf \glqq Kurs anlegen!\grqq{} drücken. Alles weitere zu dem Thema ist
im Abschnitt |Erstellung von Kursen| dokumentiert.

Unter der Kursliste steht eine Liste mit allen Teilnehmern. Jeder Teilnehmer
hat einen Eintrag. Dort wird der |Vorname|, der |Nachname|, der |Jahrgang|
und die |Klasse| angezeigt. Falls ein Nutzer fälschlicher Weise trotzdem hinzugefügt
worden ist, so kann dieser mit einem Klick auf das Symbol eines Mülleimers gelöscht
werden. Natürlich kann man auch neue Teilnehmer hinzufügen. Dazu muss nur auf
\glqq Teilnehmer hinzufügen\grqq gedrückt werden. Alles weitere zu dem Thema wird
\glqq Teilnehmer hinzufügen\grqq{} gedrückt werden. Alles weitere zu dem Thema wird
im Abschnitt |Teilnehmer hinzufügen| dokumentiert.

Hierunter gibt es die Möglichkeit, die aktuell |Statistik| zur Kurswahl anzusehen.
Dazu muss man nur auf \glqq Statistik ansehen\grqq klicken. Alles weitere wird im
Dazu muss man nur auf \glqq Statistik ansehen\grqq{} klicken. Alles weitere wird im
Abschnitt |Statistikansicht| beschrieben.

Dadrunter gibt es die Möglichkeit sich die Zugangsdaten der Teilnehmer für die
Kurswahl ausgeben zu lassen. Wenn man auf \glqq Zugangsdaten ausgeben\grqq drückt,
Kurswahl ausgeben zu lassen. Wenn man auf \glqq Zugangsdaten ausgeben\grqq{} drückt,
so bekommt man eine Liste mit allen Teilnehmern der Kurswahl. Daneben sind außerdem
auch der |Benutzername| als auch das |Passwort| aufgelistet. Ganz unten am Ende
dieser Liste hat man die Möglichkeit, sich diese Zugangsdaten als Datei herunterzuladen.
Expand Down Expand Up @@ -753,7 +753,7 @@ \subsubsection{Teilnehmer hinzufügen}
bzw. Jahrgang dann aufgelistet wird. Wenn man dann sich dazu entscheidet, eine Klasse
oder einen kompletten Jahrgang hinzuzufügen, dann werden alle Nutzer zu der Kurswahl
hinzugefügt, die in dieser Klasse oder diesem Jahrgang sind und noch nicht an der Wahl
teilnehmen. Zum Hinzufügen muss einfach der Button mit der Beschriftung \glqq Hinzufügen\grqq
teilnehmen. Zum Hinzufügen muss einfach der Button mit der Beschriftung \glqq Hinzufügen\grqq{}
gedrückt werden.

Natürlich kann man auch Nutzer einzeln hinzufügen. Dazu gibt es unterhalb der Liste
Expand Down Expand Up @@ -840,7 +840,7 @@ \subsubsection{Funktionsweise des Algorithmus}
anfängt.
\begin{enumerate}
\item Erstelle einen Kurs für alle Teilnehmer, die keine Stimme abgegeben
haben. Dieser Kurs wird heißt \glqq Übrige Schüler\grqq und enthält außerdem
haben. Dieser Kurs wird heißt \glqq Übrige Schüler\grqq{} und enthält außerdem
noch die Nummer der Zeitleiste. Das |Alias| ist ein Minus und die |Zeitleistennummer|.
Dieser Kurs ist so groß, dass dort alle Teilnehmer hinpassen.
\item Gehe nun durch alle Teilnehmer der Wahl.
Expand Down Expand Up @@ -907,13 +907,13 @@ \subsection{Wahlfenster für die Teilnehmer}
Stimme bzw. jeden Wunsch, der abgegeben werden kann, gibt es eine neue Ansicht.
Dort steht oben in der Überschrift, um welche Stimme es sich gerade handelt.
Dadrunter bekommt der Nutzer eine ComboBox, woraus der dann einen der verfügbaren
Kurse auswählen kann. Wenn man die Option \glqq Bitte wählen...\grqq auswählt,
Kurse auswählen kann. Wenn man die Option \glqq Bitte wählen...\grqq{} auswählt,
dann darf man erneut die Stimme abgeben, da diese Abgabe ungültig war. Dazu
gibt es auch eine passende Meldung. Wenn man seinen Kurs nun korrekt ausgewählt
hat und die Eingabe erfolgreich gespeichert worden ist, dann bekommt man eine
dazu passende Meldung. Solange noch weitere Stimmen abgegeben können, steht unten
die Aufschrift \glqq Weiter\grqq auf dem Button. Bei der letzten Stimme steht
unten dann \glqq Fertigstellen\grqq. Nach dem Klick auf Fertigstellen kommt man
die Aufschrift \glqq Weiter\grqq{} auf dem Button. Bei der letzten Stimme steht
unten dann \glqq Fertigstellen\grqq{}. Nach dem Klick auf Fertigstellen kommt man
auf eine Erfolgsmeldung, wo steht, dass man erfolgreich die Daten eingegeben hat.
Dort gibt es wieder einen Button, womit man zur Übersicht gelangen kann.

Expand Down

0 comments on commit 955779a

Please sign in to comment.