Skip to content

Commit

Permalink
generalize guides; remove fop-related information (tudagrade#53)
Browse files Browse the repository at this point in the history
  • Loading branch information
LukasKlenner authored Feb 28, 2024
1 parent 6458109 commit 2b7b5ed
Show file tree
Hide file tree
Showing 15 changed files with 43 additions and 325 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
59 changes: 0 additions & 59 deletions docs/exercises/complaints.md

This file was deleted.

64 changes: 0 additions & 64 deletions docs/exercises/documentation.md

This file was deleted.

5 changes: 1 addition & 4 deletions docs/exercises/download-import-unsupported.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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...
<!-- Vielleicht hilft ihnen [das hier weiter](https://exmatriculate.me). -->

[Moodle]: https://moodle.informatik.tu-darmstadt.de/course/view.php?id=1469&sectionid=18762
8 changes: 3 additions & 5 deletions docs/exercises/download-import.md
Original file line number Diff line number Diff line change
@@ -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"

Expand All @@ -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.
Expand Down Expand Up @@ -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&sectionid=18762
[Git-Repository]: https://github.com/FOP-2324
[Git lokal installieren]: https://wiki.tudalgo.org/preparation/installation-git/
[Git lokal installieren]: /preparation/installation-git/
11 changes: 5 additions & 6 deletions docs/exercises/edit.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
28 changes: 9 additions & 19 deletions docs/exercises/export-upload.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,45 +19,35 @@
* 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 **<Projektname\>" -> "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.
## Abgabe Verifizieren
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 <Dateiname\>"**.
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&sectionid=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
Loading

0 comments on commit 2b7b5ed

Please sign in to comment.