From 2b7b5edad42fd73a6d778d69ba0b60fabe62358e Mon Sep 17 00:00:00 2001 From: LukasKlenner <73290081+LukasKlenner@users.noreply.github.com> Date: Wed, 28 Feb 2024 15:19:18 +0100 Subject: [PATCH] generalize guides; remove fop-related information (#53) --- README.md | 10 +-- docs/exercises/complaints.md | 59 ----------------- docs/exercises/documentation.md | 64 ------------------ docs/exercises/download-import-unsupported.md | 5 +- docs/exercises/download-import.md | 8 +-- docs/exercises/edit.md | 11 ++-- docs/exercises/export-upload.md | 28 +++----- docs/exercises/fix-errors.md | 30 +++------ docs/preparation/installation-git.md | 6 +- docs/preparation/installation-intellij.md | 8 +-- docs/preparation/installation-java.md | 8 +-- docs/preparation/installation-racket.md | 66 ------------------- docs/preparation/packagemanager.md | 2 +- docs/support/good-bad-questions.md | 58 ---------------- mkdocs.yml | 5 -- 15 files changed, 43 insertions(+), 325 deletions(-) delete mode 100644 docs/exercises/complaints.md delete mode 100644 docs/exercises/documentation.md delete mode 100644 docs/preparation/installation-racket.md delete mode 100644 docs/support/good-bad-questions.md diff --git a/README.md b/README.md index 9d852ec..2f263f5 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ -# Haudy -The official student guide for the course "Funktionale und objektorientierte Programmierkonzepte" at TU Darmstadt. This guide provides information about the necessary programs and how to submit the exercises. +# Wiki +The official student guide for the courses using [jagr] at TU Darmstadt. This guide provides information about the necessary programs and how to submit the exercises. You can view the guide by following [this] link. -For further questions please contact us via our [Moodle course]. +To use this guide, either directly link to it, or create a fork of it to add custom information. -[this]: https://wiki.tudalgo.org/ -[Moodle course]: https://moodle.informatik.tu-darmstadt.de/course/view.php?id=1469 +[this]: https://wiki.tudagrade.org/ +[jagr]: https://github.com/sourcegrade/jagr diff --git a/docs/exercises/complaints.md b/docs/exercises/complaints.md deleted file mode 100644 index a7674a4..0000000 --- a/docs/exercises/complaints.md +++ /dev/null @@ -1,59 +0,0 @@ -# Beanstandungen - -## Was ist eine Beanstandung? - -* Sie haben ab dem Zeitpunkt der Bewertung Ihrer Hausübung zwei Wochen Zeit, Ihre Bewertung zu beanstanden. - -* Wählen Sie im Abschnitt des jeweiligen Übungsblatts das Modul Beanstandung zur Bewertung von Übungsblatt aus. Geben Sie im Textfeld Ihre Beanstandung begründet separiert nach Nummer der Kriterien (links neben dem Kriterium) an. Die Nachkorrektur kann auch zu einem Punktabzug führen. -Sobald Ihre Beanstandung bearbeitet wurde, wird Ihre Beanstandung als bewertet markiert. Nach Ende der Beanstandungsfrist können keine Beanstandungen mehr entgegengenommen werden. Es werden nur Beanstandungen bearbeitet, die über den beschriebenen Weg eingegangen sind. - -!!! warning "Achtung" - Nachdem Sie Ihre Beanstandung abgegeben haben, können Sie diese nicht mehr ändern. Ihre Beanstandung wird danach bearbeitet. - -## Bevor Sie eine Beanstandung schreiben - -- Sie haben sich Ihre Bewertung genau angeguckt, inklusive der Hinweise/Fehlermeldungen in der Kommentar-Spalte -- Sie haben sich je Kriterium, bei dem Ihnen Punkte fehlen, überprüft, - - warum der Fehler auftritt - - ob Sie alle für das Kriterium relevanten verbindlichen Anforderungen eingehalten haben - - ob Sie alle für das Kriterium erforderlichen Aufgaben vollständig bearbeitet haben -- Sie haben Ihre Lösung mit der Musterlösungen verglichen -- Sie haben Public- und Private-Tests auf Ihrer Lösung ausgeführt -- Sie haben Ihre Lösung mit dem Debugger ausgeführt und sich insbesondere das Verhalten des Programms in der „Fehlersituation“ angeschaut - -## Wie sieht eine gute Beanstandung aus? -Beanstandungen müssen immer gut begründet sein und sollten sich auf konkrete Kriterien beziehen, für die Sie Ihrer Auffassung nach mehr Punkte verdienen. - -**Beispielaufbau**: - -1. Auf welches Kriterium beziehen Sie sich: - * "Ich habe für Kriterium X nur 2 von 4 Punkten bekommen. Im Kommentar steht // als Fehler steht da, dass … auftritt // dass ... nicht eingehalten wurde // ..." -2. Woraus schließen Sie, dass die Bewertung falsch ist: - * "Ich habe meine Lösung mit der Musterlösung verglichen // meine Lösung debuggt // die private tests auf meiner Lösung ausgeführt // ..." -3. Was ist Ihnen dabei aufgefallen, weshalb verdient Ihre Lösung mehr Punkte in Bezug auf dieses Kriterium: - * "Ich bin der Meinung, dass meine Lösung die Aspekte … // eigentlich erfüllt, weil ... // ..." - -## Wie sieht eine schlechte Beanstandung aus? - -Beanstandungen dieser Art werden höchstwahrscheinlich ignoriert: - -!!! quote "Beispiel" - ``` - Ich bin mir sicher, dass meine Abgabe korrekt ist. Bitte nochmal anschauen. - ``` - **Erklärung**: Ohne Verweis auf spezifische Kriterien und ähnliche Beschreibung ist der Zeitaufwand für die Bewertung der Beanstandung zu hoch. - -!!! quote "Beispiel" - ``` - Alle Public-Tests funktionieren bei mir. Wieso habe ich nicht volle Punktzahl? - ``` - **Erklärung**: Die Public-Tests garantieren nicht die volle Punktzahl, nur mindestens 50% der Punkte. In den Private-Tests können etwa Randfälle oder ähnliches geprüft werden, die Sie möglicherweise nicht beachtet haben. - -!!! quote "Beispiel" - ``` - Ich bitte um eine vollständige Erklärung meiner Fehler! - ``` - **Erklärung**: Beastandungen dienen zur Korrektur einer fehlerhaften oder unfairen Bewertung. Eine Erklärung für Aufgaben oder für Ihre Fehler können Sie durch diverse andere Angebote erhalten, wie zum Beispiel: Intensivbetreuung, Lösung der Hausübung, Fragen auf [Discord]/[Moodle], Sprechstunden, ... - - [Discord]: https://moodle.informatik.tu-darmstadt.de/course/view.php?id=1469§ionid=18782 - [Moodle]: https://moodle.informatik.tu-darmstadt.de/course/view.php?id=1469 diff --git a/docs/exercises/documentation.md b/docs/exercises/documentation.md deleted file mode 100644 index 7f6b0f4..0000000 --- a/docs/exercises/documentation.md +++ /dev/null @@ -1,64 +0,0 @@ -# Dokumentation von Java-QuellCode - -!!! info "Information" - In der Softwareentwicklung ist es wichtig, seinen Code ordentlich zu dokumentieren, damit es möglich ist, diesen ohne viel Aufwand zu verstehen. - Dies hilft sowohl anderen, die mit Ihrem Code arbeiten oder ihn benutzen, als auch Ihnen selber, wenn Sie länger nicht mehr mit diesem gearbeitet haben. - Die Dokumentation sollte dabei kurz erklären, was der Code macht und wie er zu benutzen ist. - Es sollte aber nicht erklärt werden, wie genau der Code funktioniert, sondern dieser sollte als eine Blackbox, in welche man nicht genauer hineingucken kann, betrachtet werden. - -* In Java werden JavaDoc Kommentare als standardisierte Methode benutzt um Code zu dokumentieren. - * JavaDoc Kommentare haben dabei den Vorteil, dass IDEs sie automatisch anzeigen können und HTML Seiten aus ihnen generiert werden können. -* Jeder JavaDoc Kommentar beginnt dabei mit **/\*\*** und endet mit **\*/**. - Jede neue Zeile beginnt mit einem **\***. -* JavaDoc Kommentare werden direkt über die zugehörige Klasse, Methode, etc. geschrieben. -* Wenn Sie in IntelliJ über einer Methode, Klasse, etc. **/\*\*** schreiben und dann **Enter** drücken, wird automatisch eine Vorlage für Sie erstellt. -* Ein JavaDoc Kommentar sieht dabei z.B. wie folgt aus: - -!!! example "Beispiel" - ```java - /** - * This method accepts two real numbers belonging to a - * vector and calculates the euclidean norm of said - * vector. - * - * @param x first component of two-dimensional vector (x, y) - * @param y second component of two-dimensional vector (x, y) - * @return Euclidean norm of the vector (x,y) - */ - double euclid2(float x, float y) { - return Math.sqrt(x*x + y*y); - } - ``` - -* In der [Dokumentation der Java Standardbibliothek] finden Sie etliche Beispiele, wie gute JavaDoc Kommentare aussehen sollten. - -## Aufbau - -* Zu Beginn eines JavaDoc Kommentars steht eine allgemeine Beschreibung der Methode, welche auf alle Details der Methode eingeht und beschreibt, was sie bewirkt, wie sie zu benutzten ist und was man dabei beachten muss. -* Danach folgen sogenannte Tags, welche mit einem **@** und dem Namen des Tags beginnen. -* Jeder JavaDoc Kommentar muss dabei, falls notwendig, folgende Tags haben: - * **@param Parametername description** Beschreibt kurz die Bedeutung des Parameters **Parametername**. - Für jeden Parameter muss ein solcher Tag vorhanden sein. - * **@return description** Beschreibt kurz die Bedeutung der Rückgabe der Methode. - Wenn die Methode keine Rückgabe hat, wird dieser Tag weggelassen. - * **@throws Exceptionname description** Beschreibt kurz, in welchem Fall die Exception **Exceptionname** geworfen wird. - Für jede Exception, welche in der throws-Klausel der Methode angegeben wird, muss ein solcher Tag vorhanden sein. - * Optional können Sie diesen Tag auch für Runtime Exceptions hinzufügen, welche geworfen werden können. - -## Verpflichtende Dokumentation - -* Ab dem dritten Übungsblatt kann es vorkommen, dass von Ihnen gefordert wird, Ihren selbstgeschriebenen Code zu dokumentieren. Wenn dies der Fall ist, müssen alle von Ihnen deklarierten Klassen, Interfaces, Enums und Methoden (inklusive Konstruktoren) mittels JavaDoc dokumentiert werden. -* Private Methoden und Methoden, welche andere, bereits dokumentierte, Methoden überschreiben, sowie private Attribute und Enumerationselemente müssen **nicht** dokumentiert werden. - -## Einige weitere Tags -* **@author name** Gibt den Autor an. - Kann nur in Klassen, Interface und Enums verwendet werden. -* **@version version** Gibt die Version an. - Kann nur in Klassen, Interface und Enums verwendet werden. -* **@since version** Gibt an, seit wann das Objekt verfügbar ist. -* **@see reference** Erzeugt eine Referenz auf eine andere Dokumentation. -* **@deprecated** Gibt an, dass die Methode veraltet ist und nicht verwendet werden sollte. -* Eine vollständige Liste finden Sie [hier]. - -[hier]: https://de.wikipedia.org/wiki/Javadoc#%C3%9Cbersicht_der_Javadoc-Tags -[Dokumentation der Java Standardbibliothek]: https://docs.oracle.com/en/java/javase/17/docs/api/java.base/module-summary.html diff --git a/docs/exercises/download-import-unsupported.md b/docs/exercises/download-import-unsupported.md index af8f527..0e18d43 100644 --- a/docs/exercises/download-import-unsupported.md +++ b/docs/exercises/download-import-unsupported.md @@ -47,7 +47,7 @@ * Importieren - * Sie können die Hausübungen entweder importieren, indem Sie sich die zip Datei von [Moodle] herunterladen, entpacken und dann über **"File" -> "Import..." -> "Gradle" -> "Existing Gradle Project"** auswählen, oder über **"File" -> "Import..." -> "Git" -> "Projects from Git" -> "Clone URl"** die Daten des Git-Repositories eingeben. + * Sie können die Hausübungen entweder importieren, indem Sie sich die zip Datei von Moodle herunterladen, entpacken und dann über **"File" -> "Import..." -> "Gradle" -> "Existing Gradle Project"** auswählen, oder über **"File" -> "Import..." -> "Git" -> "Projects from Git" -> "Clone URl"** die Daten des Git-Repositories eingeben. * Gradle Tasks @@ -59,6 +59,3 @@ === "Andere" * Wenn Sie einen anderen Editor/ein anderes IDE benutzen und denken ein Guide hier könnte helfen können Sie gerne einen Pull Request aufmachen und dieses ergänzen... - - -[Moodle]: https://moodle.informatik.tu-darmstadt.de/course/view.php?id=1469§ionid=18762 diff --git a/docs/exercises/download-import.md b/docs/exercises/download-import.md index 6ba2645..7eaf921 100644 --- a/docs/exercises/download-import.md +++ b/docs/exercises/download-import.md @@ -1,7 +1,7 @@ # Herunterladen und Importieren von Hausübungen in IntelliJ Zum Bearbeiten der Hausübungen benötigen Sie die von uns zur Verfügung gestellten Vorlagen. -Diese erhalten sie entweder, indem sie das zugehörige [Git-Repository] klonen, oder die Zip-Datei von [Moodle] herunterladen. +Diese erhalten sie entweder, indem sie das zugehörige Git-Repository klonen, oder die Zip-Datei von Moodle herunterladen. !!! warning "Warnung" @@ -16,7 +16,7 @@ Diese erhalten sie entweder, indem sie das zugehörige [Git-Repository] klonen, #### Repositories klonen !!! warning "Achtung" Forken Sie nicht die Repositories. Auf Forks hat jeder Zugriff, weshalb diese als Plagiarismus gewertet werden und Ihre Abgabe dann eventuell nicht von uns bewertet werden kann. - 1. IntelliJ bietet Ihnen die Möglichkeit, Git-Repositories automatisch zu klonen. Gehen Sie dafür links oben auf die drei Punkte und dann im **"File"** Reiter **"New" -> "Project From Version Controll..."** aus. + 1. IntelliJ bietet Ihnen die Möglichkeit, Git-Repositories automatisch zu klonen. Gehen Sie dafür links oben auf die drei Punkte und dann im **"File"** Reiter **"New" -> "Project From Version Control..."** aus. * Wenn Sie IntelliJ das erste Mal starten oder momentan kein Projekt geöffnet haben, müssen Sie stattdessen rechts oben auf **"Get from VCS"** drücken. 2. Geben Sie nun bei **"URL"** die URL zum Repository der entsprechenden Hausübungen ein. * Ein Link zu den entsprechenden Repositories finden Sie auf Moodle. @@ -76,6 +76,4 @@ Diese erhalten sie entweder, indem sie das zugehörige [Git-Repository] klonen, * Auch, wenn wir es nicht empfehlen, können Sie die Vorlage alternativ manuell updaten. Kopieren Sie dafür entweder Ihre Implementation in die neue Vorlage oder die Änderungen aus der neuen Vorlage in die alte Vorlage. -[Moodle]: https://moodle.informatik.tu-darmstadt.de/course/view.php?id=1469§ionid=18762 -[Git-Repository]: https://github.com/FOP-2324 -[Git lokal installieren]: https://wiki.tudalgo.org/preparation/installation-git/ +[Git lokal installieren]: /preparation/installation-git/ diff --git a/docs/exercises/edit.md b/docs/exercises/edit.md index cd3c3b4..d206c64 100644 --- a/docs/exercises/edit.md +++ b/docs/exercises/edit.md @@ -47,7 +47,7 @@ * Tragen Sie zunächst in der build.gradle.kts Datei ihre persönlichen Daten ein. Siehe dafür den ersten Punkt im Abschnitt [Exportieren]. * Sie können die Public Tests mittels der [Gradle Task] verification/graderPublicRun ausführen. Nach der Ausführung werden Ihnen in der Konsole die erreichte Punktzahl, sowie ein Link zu einer Datei mit weiteren Hinweisen angezeigt. * Wenn Sie die Vorlage herunterladen bevor die Public Tests veröffentlicht wurden, müssen Sie diese noch hinzufügen. Hinweise dazu finden Sie [hier]. - * Beachten Sie unbedingt auch die Hinweise bezüglich den Public Tests auf [Moodle]. + * Beachten Sie unbedingt auch die Hinweise bezüglich den Public Tests auf Moodle. * Wenn Java zu wenig Speicher zur Verfügung hat, kann es dazu kommen, dass Sie den Fehler **"java.lang.outOfMemoryError: Java heap space"** bekommen. Versuchen Sie zunächst die Public Tests erneut auszuführen oder IntelliJ neuzustarten. Falls der Fehler weiterhin auftritt, versuchen Sie [Java mehr Speicher zuzuweisen]. ## Tests ausführen @@ -81,8 +81,7 @@ * Der Fehler ist in der Methode **divide** der Klasse **Divider** in Zeile 20 aufgetreten. * Diese Methode wurde von der Methode **main** der Klasse **Main** in Zeile 10 aufgerufen. -[Gradle Task]: https://wiki.tudalgo.org/exercises/edit/#gradle-tasks -[hier]: https://wiki.tudalgo.org/exercises/download-import/#aktualisieren-der-vorlage -[Moodle]: https://moodle.informatik.tu-darmstadt.de/mod/page/view.php?id=60388 -[Java mehr Speicher zuzuweisen]: https://wiki.tudalgo.org/exercises/fix-errors/#java-mehr-speicher-zuweisen -[Exportieren]: https://wiki.tudalgo.org/exercises/export-upload/#exportieren +[Gradle Task]: /exercises/edit/#gradle-tasks +[hier]: /exercises/download-import/#aktualisieren-der-vorlage +[Java mehr Speicher zuzuweisen]: /exercises/fix-errors/#java-mehr-speicher-zuweisen +[Exportieren]: /exercises/export-upload/#exportieren diff --git a/docs/exercises/export-upload.md b/docs/exercises/export-upload.md index 5405888..a6a9ef1 100644 --- a/docs/exercises/export-upload.md +++ b/docs/exercises/export-upload.md @@ -19,29 +19,20 @@ * Falls ihr Name Leer- oder Sonderzeichen enthält, können Sie diese unverändert drin lassen. * Verändern Sie bis auf diese drei Zeilen nichts Weiteres an der Datei. * Beachten Sie, dass die Anführungszeichen notwendig sind. - * Falls Sie noch eine alte Version verwenden, sehen die Zeilen stattdessen wie folgt aus: - ``` java - studentID.set("ab12cdef") - firstName.set("Max") - lastName.set("Mustermann") - ``` - * Bei der alten Version müssen Sie die drei Zeilen noch einkommentieren, d.h. die **//** am Anfang der Zeile entfernen. Anschließend einmal auf die Blauen Pfeile oben in der Gradle Übersicht klicken, um die Konfiguration neu zu laden. - 2. Öffnen Sie am rechten oberen Rand die Gradle Übersicht (das Elefantensymbol). -3. Unter **"FOP-2324-HXX-Student" -> "Task" -> "build"** finden Sie die Gradle Task **"mainBuildSubmission"**. Führen Sie diese mit einem Doppelklick aus. +3. Unter **" -> "Task" -> "build"** finden Sie die Gradle Task **"mainBuildSubmission"**. Führen Sie diese mit einem Doppelklick aus. * Wenn unten in der Konsole **"BUILD SUCCESSFUL"** steht, war das Erstellen der Abgabedatei erfolgreich. * Achten Sie darauf, dass Sie nicht die Task **"build"** ausführen, da diese nicht die Abgabedatei erstellt. Abgaben, die mit dieser Task erstellt wurden, können nicht bewertet werden. 4. In dem Projektordner finden Sie nun im Ordner **"build"** einen weiteren Ordner **"libs"**. In diesem befindet sich die Abgabedatei. - * Die Datei ist nach dem Schema **"hXX-TU-ID-firstName-lastName-submission.jar"** benannt. Ändern Sie diese Benennung **nicht**. + * Die Datei ist nach dem Schema **"XXX-TU-ID-firstName-lastName-submission.jar"** benannt. Ändern Sie diese Benennung **nicht**. * Beachten Sie, dass IntelliJ die Datei nicht unbedingt sofort anzeigt. Suchen Sie die Datei am besten im File Explorer. * Um den Inhalt der Abgabedatei zu überprüfen, befolgen Sie die Schritte unter [Abgabe Verifizieren]. ## Hochladen -* Laden Sie nun die zuvor erstellte Datei in [Moodle] bei der entsprechenden Abgabe hoch. - * Sie finden das Abgabemodul auf der selben Seite, wie auch das Übungsblatt, unter dem Namen **"Abgabe zu Übungsblatt X"** +* Laden Sie nun die zuvor erstellte Datei in Moodle bei der entsprechenden Abgabe hoch. * Sie können bis zum Abgabeende beliebig oft Ihre Abgabe ändern. Wir empfehlen Ihnen daher regelmäßig Ihren Zwischenstand hochzuladen, damit Sie nicht leer dastehen, wenn Sie die Abgabefrist verpassen. * Alle Abgaben, die auf Moodle hochgeladen werden konnten, werden bewertet. Wenn keine Datei hochgeladen werden kann, weil die Abgabefrist überschritten wurde, kann die Aufgabe nicht bewertet werden. @@ -49,15 +40,14 @@ Sie können wie folgt sicherstellen, dass Sie die Abgabedatei korrekt erstellt haben. -1. Nach dem Ausführen der Task **"build/mainBuildSubmission"** sollte die Abgabedatei sich im Ordner **"build/libs"** befinden und nach dem Schema **"hXX-TU-ID-firstName-lastName-submission.jar"** benannt sein. +1. Nach dem Ausführen der Task **"build/mainBuildSubmission"** sollte die Abgabedatei sich im Ordner **"build/libs"** befinden und nach dem Schema **"XXX-TU-ID-firstName-lastName-submission.jar"** benannt sein. 2. Entpacken Sie die .jar Datei entweder mit einem Entpackungsprogramm wie z.B. 7Zip oder in einem [Terminal] mit dem Befehl **"jar -xf "**. 3. Nach dem Entpacken sollte nun im Besonderen folgendes vorhanden sein: * eine Datei **"Submission-info.json"** - * ein Ordner **hXX**, welcher der Package Struktur des Projektes entspricht und die Quelldateien (.java) enthält. + * ein Ordner, welcher der Package Struktur des Projektes entspricht und die Quelldateien (.java) enthält. * Falls nur .class Dateien vorhanden sind, haben Sie vermutlich die Task **"build/build"** und nicht **"build/mainBuildSubmission"** ausgeführt. Abgaben, die auf diese Art erstellt wurden, werden nicht bewertet. -[Moodle]: https://moodle.informatik.tu-darmstadt.de/course/view.php?id=1469§ionid=18762 -[Gradle Task]: https://wiki.tudalgo.org/exercises/edit/#gradle-tasks -[hier]: https://wiki.tudalgo.org/exercises/fix-errors/ -[Terminal]: https://wiki.tudalgo.org/preparation/terminal/ -[Abgabe Verifizieren]: https://wiki.tudalgo.org/exercises/export-upload/#abgabe-verifizieren +[Gradle Task]: /exercises/edit/#gradle-tasks +[hier]:/exercises/fix-errors/ +[Terminal]: /preparation/terminal/ +[Abgabe Verifizieren]: /exercises/export-upload/#abgabe-verifizieren diff --git a/docs/exercises/fix-errors.md b/docs/exercises/fix-errors.md index 82ad0f4..6cee4ea 100644 --- a/docs/exercises/fix-errors.md +++ b/docs/exercises/fix-errors.md @@ -2,7 +2,7 @@ === "Technische Fehler" - * Stellen Sie zunächst sicher, dass Sie den richtigen Ordner importiert haben. Der oberste Ordner sollte nach der Hausübung benannt sein (z. B. **"FOP-2324-HXX-Student-master"**) und direkt die build.gradle.kts Datei enthalten sein. Wählen Sie beim Importieren **nicht** einen identisch benannten Oberordner aus. + * Stellen Sie zunächst sicher, dass Sie den richtigen Ordner importiert haben. Der oberste Ordner sollte nach der Hausübung benannt sein (z. B. **"--XXX-Student-master"**) und direkt die build.gradle.kts Datei enthalten. Wählen Sie beim Importieren **nicht** einen identisch benannten Oberordner aus. * Beachten Sie, dass es mit Gradle zu Problemen kommen kann, wenn das Projekt auf einer externen Festplatte gespeichert wurde. * Anbei finden Sie ein paar mögliche Fehler, welche Ihnen in der Konsole, die sich beim Ausführen der des Programmes oder einer Gradle Task automatisch öffnet, angezeigt werden. Damit Ihnen die vollständigen Fehlermeldungen angezeigt werden, wählen Sie links von der Konsole die zweite Option von oben aus. @@ -19,7 +19,7 @@ 2. !!! error "" ``` - A problem occurred configuring root project 'FOP-2324-H00-Student'. + A problem occurred configuring root project ''. Could not resolve all files for configuration ':classpath'. Could not resolve org.tudalgo:algomate:0.1.0-SNAPSHOT. ``` @@ -78,7 +78,7 @@ execution failed for task ':graderPublicRun'. There were failing tests. ``` - Die von uns zur Verfügung gestellten public-Tests laufen nicht erfolgreich durch. Um dies zu beheben, fixen Sie entweder den Fehler, den die Tests aufzeigen, oder ändern Sie in der build.gradle.kts Datei direkt unter Ihren persönlichen Daten requirePublicTests von true auf false: + Die von uns zur Verfügung gestellten public-Tests laufen nicht erfolgreich durch. Um dies zu beheben, fixen Sie entweder den Fehler, den die Tests aufzeigen, oder ändern Sie in der build.gradle.kts Datei direkt unter Ihren persönlichen Daten requirePublicTests von true auf false. ``` requireGraderPublic = false ``` @@ -110,17 +110,6 @@ ``` Dieser Fehler kann manchmal beim Ausführen der Public Tests auftreten. Versuchen Sie zunächst die Public Tests erneut auszuführen, im IntelliJ Terminal, welches sich am linken unteren Rand öffnen lässt, den Befehl "**./gradlew --stop**" auszuführen, oder IntelliJ neuzustarten. Falls der Fehler weiterhin auftritt, versuchen Sie [Java mehr Speicher zuzuweisen]. - 11. !!! error "" - ``` - Unsupported Java. - Your build is currently configured to use Java 21 and Gradle 8.4. - - Possible solution: - - Use Java 20 as Gradle JVM: Open Gradle settings - - Open Gradle wrapper settings, change `distributionUrl` property to use compatible Gradle version and reload the project - ``` - Offiziell wird Java 21 noch nicht von Gradle unterstützt. Für die Bearbeitung der Hausübungen ist dies allerdings eigentlich kein Problem. Falls Sie die Fehlermeldung in der Konsole angezigt bekommen, liegt dies meist eigentlich ein anderes Problem vor. Überprüfen Sie, ob links neben der Fehlermeldung in einem der anderen Logs eine andere Fehlermeldung angezeigt wird und beheben sie diese. Meist liegt es an kompilierfehler oder an fehlenden Daten in der build.gradle.kts Datei. Falls Sie die Nachricht beim Öffnen der Hausübung als Hinweis erhalten, können Sie diese zunächst ignorieren. Als letzte Möglichkeit können Sie auch versuchen, die Java Version in IntelliJ auf Java 17 zu ändern. Siehe dafür [Korrekte Java Version in IntelliJ einstellen]. - 12. !!! error "" ``` Hauptklasse hxx.Main konnte nicht gefunden oder geladen werden @@ -133,7 +122,7 @@ ``` Caused by: java.lang.ClassNotFoundException: hxx.Main ``` - Dieser Fehler entsteht meistens, wenn die Vorlage nicht korrket importiert wurde, oder die Vorlage in einem Pfad gespeichert wurde, welcher Leerzeichen oder Sonderzeichen enthält. Stellen Sie sicher, dass die Vorlage korrekt importiert wurde (am besten durch die Verwendung von Git) und verschieben Sie die Vorlage ggf. an einen Dateipfad, welcher keine Leerzeichen oder Sonderzeichen enthält. + Dieser Fehler entsteht meistens, wenn die Vorlage nicht korrekt importiert wurde, oder die Vorlage in einem Pfad gespeichert wurde, welcher Leerzeichen oder Sonderzeichen enthält. Stellen Sie sicher, dass die Vorlage korrekt importiert wurde (am besten durch die Verwendung von Git) und verschieben Sie die Vorlage ggf. an einen Dateipfad, welcher keine Leerzeichen oder Sonderzeichen enthält. ### Korrekte Java Version in IntelliJ einstellen @@ -538,14 +527,11 @@ Beachten Sie die Seite [Bevor Sie eine Sprechstunde besuchen]. -[Korrekte Java Version in IntelliJ Einstellen]: https://wiki.tudalgo.org/exercises/fix-errors/#korrekte-java-version-in-intellij-einstellen -[Anleitung zum Installieren von Java]: https://wiki.tudalgo.org/preparation/installation-java/ -[Anleitung zum Exportieren]: https://wiki.tudalgo.org/exercises/export-upload/#exportieren -[Java mehr Speicher zuzuweisen]: https://wiki.tudalgo.org/exercises/fix-errors/#java-mehr-speicher-zuweisen +[Korrekte Java Version in IntelliJ Einstellen]: /exercises/fix-errors/#korrekte-java-version-in-intellij-einstellen +[Anleitung zum Installieren von Java]: /preparation/installation-java/ +[Anleitung zum Exportieren]: /exercises/export-upload/#exportieren +[Java mehr Speicher zuzuweisen]: /exercises/fix-errors/#java-mehr-speicher-zuweisen [Aktualisieren der Vorlage]: /exercises/download-import/#aktualisieren-der-vorlage [Typische Programmierfehler]: /exercises/fix-errors/#typische-programmierfehler -[Bevor Sie eine Sprechstunde besuchen]: /support/good-bad-questions [Debugging]: /exercises/fix-errors/#debugging [List]: https://docs.oracle.com/javase/8/docs/api/java/util/List.html -[Moodle Forum für technische Fragen]: https://moodle.informatik.tu-darmstadt.de/mod/forum/view.php?id=60391 -[Discord Server]: https://moodle.informatik.tu-darmstadt.de/course/view.php?id=1469§ionid=18782 diff --git a/docs/preparation/installation-git.md b/docs/preparation/installation-git.md index a020679..366018e 100644 --- a/docs/preparation/installation-git.md +++ b/docs/preparation/installation-git.md @@ -49,6 +49,6 @@ [GitHub]: https://github.com/FOP-2324 [Git]: https://git-scm.com/download -[Terminal]: https://wiki.tudalgo.org/preparation/terminal/ -[Homebrew]: https://wiki.tudalgo.org/preparation/packagemanager/ -[Scoop]: https://wiki.tudalgo.org/preparation/packagemanager/ +[Terminal]: /preparation/terminal/ +[Homebrew]: /preparation/packagemanager/ +[Scoop]: /preparation/packagemanager/ diff --git a/docs/preparation/installation-intellij.md b/docs/preparation/installation-intellij.md index 5ee31ed..abe31b0 100644 --- a/docs/preparation/installation-intellij.md +++ b/docs/preparation/installation-intellij.md @@ -86,7 +86,7 @@ [AUR-Helper]: https://wiki.archlinux.org/title/AUR_helper [intellij-idea-ce]: https://aur.archlinux.org/packages/intellij-idea-ce [intellij-idea-ultimate-edition]: https://aur.archlinux.org/packages/intellij-idea-ultimate-edition -[Herunterladen und Exportieren]: https://wiki.tudalgo.org/exercises/download-import/ -[Terminal]: https://wiki.tudalgo.org/preparation/terminal/ -[Homebrew]: https://wiki.tudalgo.org/preparation/packagemanager/ -[Scoop]: https://wiki.tudalgo.org/preparation/packagemanager/ +[Herunterladen und Exportieren]: /exercises/download-import/ +[Terminal]: /preparation/terminal/ +[Homebrew]: /preparation/packagemanager/ +[Scoop]: /preparation/packagemanager/ diff --git a/docs/preparation/installation-java.md b/docs/preparation/installation-java.md index 15d4116..a6e4f4a 100644 --- a/docs/preparation/installation-java.md +++ b/docs/preparation/installation-java.md @@ -111,8 +111,8 @@ java --version [Adoptium Website]: https://adoptium.net/de/ -[Terminal]: https://wiki.tudalgo.org/preparation/terminal/ +[Terminal]: /preparation/terminal/ [Überprüfung der Installation]: #installation-uberprufen -[Homebrew]: https://wiki.tudalgo.org/preparation/packagemanager/ -[Scoop]: https://wiki.tudalgo.org/preparation/packagemanager/ -[Installation von IntelliJ]: https://wiki.tudalgo.org/preparation/installation-intellij/ +[Homebrew]: /preparation/packagemanager/ +[Scoop]: /preparation/packagemanager/ +[Installation von IntelliJ]: /preparation/installation-intellij/ diff --git a/docs/preparation/installation-racket.md b/docs/preparation/installation-racket.md deleted file mode 100644 index bb67897..0000000 --- a/docs/preparation/installation-racket.md +++ /dev/null @@ -1,66 +0,0 @@ -# Installieren von DrRacket - -=== "Windows" - - === "Scoop" - - 1. Falls noch nicht geschehen, installieren Sie [Scoop]. - 2. Führen Sie folgenden Befehl in einem [Terminal] aus, um Racket zu installieren: - ``` - scoop install racket - ``` - - === "Manuell" - - 1. Laden Sie [hier] DrRacket herunter. Achten Sie darauf, dass Windows als Betriebssystem ausgewählt ist. - 2. Führen Sie den heruntergeladenen Installer aus und drücken Sie auf **"Next"**, bzw. **"Install"**, bis der Installationsprozess abgeschlossen ist und am Ende auf **"Finish"**. - -=== "macOS" - - === "Homebrew" - - 1. Falls noch nicht geschehen, installieren Sie [Homebrew]. - 2. Führen Sie in einem [Terminal] folgenden Befehl aus, um Racket zu installieren. - ``` - brew install --cask racket - ``` - - === "Manuell" - 1. Laden Sie [hier] DrRacket herunter. Achten Sie darauf, dass Mac OS als Betriebssystem ausgewählt ist. - 2. Öffnen Sie die heruntergeladenen .dmg Datei. - 3. Kopieren Sie die Racket Installation in den Applications Ordner. - -=== "Linux" - === "Manuell" - 1. Laden Sie [hier] DrRacket herunter. Achten Sie darauf, dass Linux als Betriebssystem ausgewählt ist. - * Alternativ können Sie es auch mit dem folgenden Befehl herunterladen: - ``` - wget https://mirror.racket-lang.org/installers/8.6/racket-8.6-x86_64-linux.sh - ``` - 2. Stellen Sie mit - ``` - chmod +x racket-8.6-x86_64-linux.sh - ``` - sicher, dass der Installer ausführbar ist und führen Sie diesen dann mit - ``` - sudo ./racket-8.6-x86_64-linux.sh - ``` - aus. - 4. Beantworten Sie die Fragen, die Ihnen im Terminal gestellt werden. Standardmäßig können diese mit **"no"**, **"1"** und **"/usr/local"** beantworten. - - === "Arch Based Linux" - - 1. Installieren Sie Racket (als Root). - ``` - pacman -S racket --needed - ``` - -## DrRacket einrichten - -* Öffnen Sie nun DrRacket und gehen Sie auf oben auf **"Language"** -> **"Choose Language"** und wählen Sie unter **"Teaching Languages"** **"Advanced Student"** aus. Bestätigen Sie danach die Auswahl, indem Sie auf **"OK"** drücken. -* Nun können Sie Racket Programme ausführen, indem Sie rechts oben auf **"Run"** drücken. - -[hier]: https://download.racket-lang.org/ -[Terminal]: https://wiki.tudalgo.org/preparation/terminal/ -[Homebrew]: https://wiki.tudalgo.org/preparation/packagemanager/ -[Scoop]: https://wiki.tudalgo.org/preparation/packagemanager/ diff --git a/docs/preparation/packagemanager.md b/docs/preparation/packagemanager.md index b2bfa53..47d06e4 100644 --- a/docs/preparation/packagemanager.md +++ b/docs/preparation/packagemanager.md @@ -46,4 +46,4 @@ Wir empfehlen Ihnen für die Installation der benötigten Programme einen solche [Scoop]: https://scoop.sh/ [Homebrew]: https://brew.sh/ -[Terminal]: https://wiki.tudalgo.org/preparation/terminal/ +[Terminal]: /preparation/terminal/ diff --git a/docs/support/good-bad-questions.md b/docs/support/good-bad-questions.md deleted file mode 100644 index 6ee7b14..0000000 --- a/docs/support/good-bad-questions.md +++ /dev/null @@ -1,58 +0,0 @@ -# Bevor Sie eine Sprechstunde besuchen ... - -In unseren Sprechstunden können Sie Ihre Fragen zur Vorlesung und zu Hausübungen in 1:1 Gesprächen mit erfahrenen Tutoren klären. -Die Sprechstunden dienen jedoch *keinesfalls* als Ersatz für die Vorlesung. -Daher wird von Ihnen erwartet, dass Sie sich vorab mit folgenden Punkten auseinandergesetzt haben: - -* [Vorlesungsinhalten] – für Hausübung auf jedem Blatt angegeben -* diesem Studierenden-Guide -* dem [Moodle-Forum] – bei Hausübungen insbesondere auch FAQ -* der Dokumentation der verwendeten Materialien - -### Fragen zu Lösungen von Hausübungen - -Wir erwarten von Ihnen, -dass Sie Hausübungem selbstständig bearbeiten und damit auch selbstständig versuchen, -Fehler zu beheben. - -Sie sollten erst einen Tutor Fragen, -wenn Sie wirklich nicht weiterkommen. -Hierbei erwarten wir von Ihnen Folgendes: - -* Wenn Sie eine Fehlermeldung erhalten haben, erwarten wir, dass Sie sich bereits mit der Fehlermeldung auseinandergesetzt haben und versucht haben, den Fehler zu beheben. - -* Wenn Sie eine Verständnisfrage haben, erwarten wir, dass Sie sich bereits eine eigene Interpretation überlegt haben und versucht haben, die Frage selbstständig zu beantworten. Mit dem Tutor können Sie dann gemeinsam überlegen, ob Ihre Interpretation korrekt ist. - -### Good Questions -Bevor Sie eine Sprechstunde besuchen, -um einen Fehler in Ihrer Lösung zu klären, -müssen Sie in der Lage sein, folgende Fragen beantworten zu können. - -* In welchem Kontext tritt das Problem auf? -* Was ist das erwartete Verhalten? -* Was ist das tatsächliche Verhalten? -* Tritt ein Fehler auf? Wenn ja, welcher? -* Was haben Sie bereits versucht, um den Fehler zu lösen? - -!!! error "" - Haben Sie sich auf die genannten Fragen vorbereitet? - Dann beschäftigen wir uns gerne mit Ihrer Angelegenheit! - Andernfalls priorisieren wir andere Studenten und verweisen Sie auf dieses Guide. - -### Bad Questions - -Folgende Fragen wurden bereits in abgewandelter Form in unseren Sprechstunden gestellt. - -!!! error "" - An diesen Fragen sollten Sie sich *nicht* orientieren! Wenn Sie eine Frage nach folgendem Muster stellen, - beantworten wir Ihnen diese nicht und verweisen Sie auf dieses Guide! - - -* *Ist das so richtig?* -* *Wie löse ich die Hausübung?* -* *Ich habe die Aufgabe korrekt bearbeitet, aber Ihre Public Tests sind falsch!* -* *Ich bekomme diese Fehlermeldung. Was bedeutet die?* (Ohne Versuch, diese zu verstehen.) -* *Mein Code macht nicht das, was er soll :(* - -[Moodle-Forum]: https://moodle.informatik.tu-darmstadt.de/course/view.php?id=1469§ionid=18762 -[Vorlesungsinhalten ]: https://moodle.informatik.tu-darmstadt.de/mod/folder/view.php?id=61435 diff --git a/mkdocs.yml b/mkdocs.yml index e98ee37..94dadbf 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -36,7 +36,6 @@ nav: - Paket Manager: preparation/packagemanager.md - Installieren von Java: preparation/installation-java.md - Installieren von IntelliJ: preparation/installation-intellij.md - - Installieren von DrRacket: preparation/installation-racket.md - Installieren von Git: preparation/installation-git.md - Hinzufügen der Matrikelnummer: preparation/matriculation-number.md - Hausübungen: @@ -45,10 +44,6 @@ nav: - Beheben von häufigen Fehlern: exercises/fix-errors.md - Exportieren und Hochladen: exercises/export-upload.md - Nicht Unterstützte IDEs: exercises/download-import-unsupported.md - - Dokumentation von Java-Quellcode: exercises/documentation.md - - Beanstandungen: exercises/complaints.md - - Sprechstunden: - - Bevor Sie eine Sprechstunde besuchen ...: support/good-bad-questions.md markdown_extensions: - pymdownx.highlight: