diff --git a/en/faq/activities/index.md b/en/faq/activities/index.md index 5319d00db..ac6ebce73 100644 --- a/en/faq/activities/index.md +++ b/en/faq/activities/index.md @@ -13,3 +13,4 @@ On the home page of Dodona, you can find all your drafts under _Draft exercises_ ## How do I create new exercises? As a teacher, you can use the hundreds of exercises that are available in Dodona, but you can also create new exercises yourself. You can follow [this guide](/en/guides/exercises/creating-exercises/introduction) for this. + diff --git a/en/faq/annotations/index.md b/en/faq/annotations/index.md index 917c7c0b1..68e34df51 100644 --- a/en/faq/annotations/index.md +++ b/en/faq/annotations/index.md @@ -37,13 +37,13 @@ You can also respond to an existing question from yourself or to a comment from ## How do I know if my question has been answered? -When a teacher answers your question, you will receive a notifications in Dodona. This notification will redirect you to the page where you asked the question. +When a teacher answers your question, you will receive a notification in Dodona. This notification will redirect you to the page where you asked the question. ![image](./comment_on_code.png) ## How can I enable/disable student questions? -Use the pencil in the top navigation bar of your course to go to the `edit` page. Here you can enable or disable student questions by checking or unchecking the box `Allow students to ask questions`. +Use the pencil in the top navigation bar of your course to go to the `Edit` page. Here you can enable or disable student questions by checking or unchecking the box `Allow students to ask questions`. ![img.png](./ask_questions_toggle.png) @@ -59,7 +59,7 @@ You will also see a notification in the top navigation bar of your course. Click ![img.png](./course_question_list.png) -If you want to see al open question across all your courses, you can go to the `questions` page in the navigation sidebar of Dodona. +If you want to see al open question across all your courses, you can go to the `Questions` page in the navigation sidebar of Dodona. ![img.png](./questions_index_page.png) @@ -91,11 +91,11 @@ You can either use the `Add global comment` button to add a general comment abou Students often make the same mistakes, or have similar questions. To avoid having to write the same comment over and over again, you can reuse comments. -While writing or editing a comment, you can check `save comment`. This will allow you to add a title for this comment, which should help you find the comment for future use. +While writing or editing a comment, you can check `Save comment`. This will allow you to add a title for this comment, which should help you find the comment for future use. ![Save comment while writing](./save-comment-edit.png) -You can also save an existing comment by clicking `save comment` in the comment menu. +You can also save an existing comment by clicking `Save comment` in the comment menu. ![Save existing comment](save-comment.png) diff --git a/en/faq/featured-courses/index.md b/en/faq/featured-courses/index.md index e92a9ffa7..bb80633e8 100644 --- a/en/faq/featured-courses/index.md +++ b/en/faq/featured-courses/index.md @@ -58,8 +58,8 @@ The course is only available in [English](https://dodona.be/en/courses/345/). --- -### Python-oefeningen bij Youtube videoreeks UHasselt +### Python-oefeningen bij YouTube videoreeks UHasselt -**Python-oefeningen bij Youtube videoreeks UHasselt** is an introductory Python course that combines a series of [YouTube videos](https://www.youtube.com/playlist?list=PL2iW_rkiCt7UqxL47lGkBaTgApj_QHJ0K) with exercises on Dodona. The course was created by Dirk Peeters. +**Python-oefeningen bij YouTube videoreeks UHasselt** is an introductory Python course that combines a series of [YouTube videos](https://www.youtube.com/playlist?list=PL2iW_rkiCt7UqxL47lGkBaTgApj_QHJ0K) with exercises on Dodona. The course was created by Dirk Peeters. The course is only available in [Dutch](https://dodona.be/nl/courses/290/). diff --git a/en/faq/ide-plugins/index.md b/en/faq/ide-plugins/index.md index 3c4230f3a..b1e6e4c72 100644 --- a/en/faq/ide-plugins/index.md +++ b/en/faq/ide-plugins/index.md @@ -42,7 +42,7 @@ After successfully installing the Dodona plugin for PyCharm, you can follow thes 2. **Submit your solution**: After solving the exercise, you can submit your solution directly from PyCharm. Look for a blue check mark in the top right corner of the interface. ![submit to dodona](./pc-check-mark.png) - Clicking this button will submit your code to Dodona and trigger an automatic check. Shortly after submission, you should see a popup in the bottom right corner showing the result of your submission. + Clicking this button will submit your code to Dodona and trigger an automatic check. Shortly after submission, you should see a pop-up in the bottom right corner showing the result of your submission. ![correct solution](./pc-correct.png) If you want to see more details about the result, click on the 'more details' link to open the result in a new browser version. If you would like to resubmit, simply click on the blue check mark again. Remember, you can submit your solution as many times as you like. @@ -78,5 +78,5 @@ To use the Dodona VS Code extension, follow these steps: 2. **Submit your solution:** Once you've solved the exercise, you can easily submit your solution by using the 'Submit to Dodona' command. You can do this by opening the command palette with Ctrl+Shift+P, typing (part of) `Submit to Dodona` and pressing Enter. You can also create a shortcut for this command. This command will submit your code to Dodona and trigger an automatic test. ![Submit](./vs-submit.png) -3. **Check the result:** After a few seconds, a popup should appear in the bottom right corner showing the result of your submission. Clicking the 'View results' button will open the result in a new browser window. You can submit your solution as many times as you like by repeating the same command. +3. **Check the result:** After a few seconds, a pop-up should appear in the bottom right corner showing the result of your submission. Clicking the 'View results' button will open the result in a new browser window. You can submit your solution as many times as you like by repeating the same command. ![correct solution](./vs-correct.png) diff --git a/en/guides/exercises/creating-exercises/management/index.md b/en/guides/exercises/creating-exercises/management/index.md index 406b25f96..d37abf425 100644 --- a/en/guides/exercises/creating-exercises/management/index.md +++ b/en/guides/exercises/creating-exercises/management/index.md @@ -1,7 +1,7 @@ --- title: "Creating exercises: next steps" sidebarTitle: Next steps -order: 4 +order: 5 prev: true next: false --- diff --git a/en/guides/exercises/examples/class/index.md b/en/guides/exercises/examples/class/index.md index 61e515801..4e4fa701b 100644 --- a/en/guides/exercises/examples/class/index.md +++ b/en/guides/exercises/examples/class/index.md @@ -1,7 +1,7 @@ --- title: Exercises with classes sidebarTitle: Classes -order: 3 +order: 4 --- This guide is not yet available in English. diff --git a/en/guides/exercises/examples/command-line/index.md b/en/guides/exercises/examples/command-line/index.md index f8abeb986..e174a6008 100644 --- a/en/guides/exercises/examples/command-line/index.md +++ b/en/guides/exercises/examples/command-line/index.md @@ -1,7 +1,7 @@ --- title: Exercise on command line sidebarTitle: Command line -order: 4 +order: 5 --- This guide is not yet available in English. diff --git a/en/guides/exercises/examples/content/index.md b/en/guides/exercises/examples/content/index.md new file mode 100644 index 000000000..77cedb756 --- /dev/null +++ b/en/guides/exercises/examples/content/index.md @@ -0,0 +1,7 @@ +--- +title: "Creating exercises: reading activity" +sidebarTitle: Reading activity +order: 1 +--- + +This guide is not yet available in English. diff --git a/en/guides/exercises/examples/function/index.md b/en/guides/exercises/examples/function/index.md index 4c22f2853..3ee705b7e 100644 --- a/en/guides/exercises/examples/function/index.md +++ b/en/guides/exercises/examples/function/index.md @@ -1,7 +1,7 @@ --- title: Exercise with functions sidebarTitle: Functions -order: 2 +order: 3 --- This guide is not yet available in English. diff --git a/en/guides/exercises/examples/input-output/index.md b/en/guides/exercises/examples/input-output/index.md index 5876da22f..a7612f5d4 100644 --- a/en/guides/exercises/examples/input-output/index.md +++ b/en/guides/exercises/examples/input-output/index.md @@ -1,7 +1,7 @@ --- title: Exercise with input-output sidebarTitle: "Input-output" -order: 1 +order: 2 --- This guide is not yet available in English. diff --git a/en/guides/students/courses/index.md b/en/guides/students/courses/index.md index 2c4c72dbd..98948f922 100644 --- a/en/guides/students/courses/index.md +++ b/en/guides/students/courses/index.md @@ -24,7 +24,7 @@ Om oplossingen voor oefeningen in een cursus te kunnen indienen moet je in die c ### Hoe vind je een cursus? -Eerst moet je de cursus waarvoor je wil registreren vinden. Dit kan je doen door op je startpagina op `MEER CURSUSSEN...` of op `VERKEN CURSUSSEN` te klikken. +Eerst moet je de cursus waarvoor je wil registreren vinden. Dit kan je doen door op je startpagina op `Meer cursussen...` of op `Verken cursussen` te klikken. ![image](./student.explore_courses.png) @@ -36,13 +36,13 @@ Dit zal je naar een [overzicht van alle cursussen](https://dodona.be/nl/courses/ Als je navigeert naar de cursus dat je zocht, waarvoor je nog niet geregistreerd bent, dan zie je bovenaan de cursuspagina een paneel dat aangeeft of en hoe je je voor de cursus kan registreren. Hierbij zijn er drie mogelijkheden afhankelijk van hoe de cursus geconfigureerd werd: -- De cursus werkt met een **open registratieprocedure**, wat betekent dat iedereen zich voor de cursus kan registreren zonder expliciete goedkeuring van een cursusbeheerder. Klik op de knop `REGISTREREN` om je voor de cursus te registreren. +- De cursus werkt met een **open registratieprocedure**, wat betekent dat iedereen zich voor de cursus kan registreren zonder expliciete goedkeuring van een cursusbeheerder. Klik op de knop `Registreren` om je voor de cursus te registreren. ![image](./register.png)

-- De cursus werkt met een **gemodereerde registratieprocedure**, wat betekent dat je een **registratieverzoek** kunt indienen dat daarna dient goedgekeurd of afgekeurd te worden door een cursusbeheerder. Pas wanneer je registratieverzoek wordt goedgekeurd, ben je ook effectief geregistreerd voor de cursus. Klik op de knop `REGISTRATIEVERZOEK INDIENEN` om een registratieverzoek voor de cursus in te dienen. +- De cursus werkt met een **gemodereerde registratieprocedure**, wat betekent dat je een **registratieverzoek** kunt indienen dat daarna dient goedgekeurd of afgekeurd te worden door een cursusbeheerder. Pas wanneer je registratieverzoek wordt goedgekeurd, ben je ook effectief geregistreerd voor de cursus. Klik op de knop `Registratieverzoek indienen` om een registratieverzoek voor de cursus in te dienen. ![image](./moderated_register.png) @@ -126,7 +126,7 @@ Als je **na het verstrijken van de deadline** van een oefeningenreeks een oploss ## Uitschrijven uit een cursus -Als je navigeert naar een cursus waarvoor je [geregistreerd](#registreren-voor-een-cursus) bent of waarvoor je nog een registratieverzoek hebt openstaan, dan zie je onder de beschrijving van de cursus op de cursuspagina een knop `UITSCHRIJVEN` (of `REGISTRATIEVERZOEK ANNULEREN`) waarmee je je kunt uitschrijven uit de cursus. +Als je navigeert naar een cursus waarvoor je [geregistreerd](#registreren-voor-een-cursus) bent of waarvoor je nog een registratieverzoek hebt openstaan, dan zie je onder de beschrijving van de cursus op de cursuspagina een knop `Uitschrijven` (of `Registratieverzoek annuleren`) waarmee je je kunt uitschrijven uit de cursus. ![image](./student.unregister.png) diff --git a/en/guides/teachers/course-management/index.md b/en/guides/teachers/course-management/index.md index e6fbb1b91..07e9009dc 100644 --- a/en/guides/teachers/course-management/index.md +++ b/en/guides/teachers/course-management/index.md @@ -28,7 +28,7 @@ Om de eigenschappen van een bestaande cursus te bewerken, navigeer je naar de cu Je komt op een pagina terecht waar je de naam, lesgevers, beschrijving, academiejaar, zichtbaarheid en registratieprocedure kan aanpassen. Voor meer details over de specifieke eigenschappen kan je terecht op [deze pagina](../creating-a-course/#cursuseigenschappen). -Klik na het aanpassen op de afwerkknop in de rechterbovenhoek van het paneel om de nieuwe cursuseigenschappen op te slaan. Alternatief kan je ook op de `AANPASSEN` klikken onderaan het paneel. Daarna navigeer je automatisch terug naar de cursuspagina waar de nieuwe cursuseigenschappen onmiddellijk van toepassing zijn. +Klik na het aanpassen op de afwerkknop in de rechterbovenhoek van het paneel om de nieuwe cursuseigenschappen op te slaan. Alternatief kan je ook op de `Aanpassen` klikken onderaan het paneel. Daarna navigeer je automatisch terug naar de cursuspagina waar de nieuwe cursuseigenschappen onmiddellijk van toepassing zijn. ![image](./staff.course_after_edit.png) @@ -55,7 +55,7 @@ Als je klikt op het filter-icoontje voor de naam van een student of oefening, da Deze oplossingen kan je ook op andere manieren bereiken: * Een overzicht van de oplossingen voor een **specifieke oefening** vind je door op de cursuspagina op het pijltje rechts van een oefening te klikken. -* Een overzicht van de oplossingen voor **specifieke gebruiker** vind je door op `OPLOSSINGEN` te klikken op de [cursuspagina van die gebruiker](../user-management/#studenten-opvolgen). +* Een overzicht van de oplossingen voor **specifieke gebruiker** vind je door op `Oplossingen` te klikken op de [cursuspagina van die gebruiker](../user-management/#studenten-opvolgen). In het oplossingenoverzicht vindt je rechts van de filterbalk een knop met 3 puntjes. In het menu vindt je enkele acties en filter: diff --git a/en/guides/teachers/creating-a-course/index.md b/en/guides/teachers/creating-a-course/index.md index 2cda47cc4..7d0dddf4a 100644 --- a/en/guides/teachers/creating-a-course/index.md +++ b/en/guides/teachers/creating-a-course/index.md @@ -16,7 +16,7 @@ Je hebt extra rechten nodig om een cursus te kunnen aanmaken. Je kan deze rechte ::: -Als je de nodige rechten hebt op Dodona, dan kan je eenvoudig zelf een cursus aanmaken. Dit doe je door op de knop `CURSUS AANMAKEN` te klikken in de rechterbovenhoek van het [cursusoverzicht](https://dodona.be/nl/courses). Vanaf de landingspagina bereik je dit overzicht door te klikken op `MEER CURSUSSEN...`. +Als je de nodige rechten hebt op Dodona, dan kan je eenvoudig zelf een cursus aanmaken. Dit doe je door op de knop `Cursus aanmaken` te klikken in de rechterbovenhoek van het [cursusoverzicht](https://dodona.be/nl/courses). Vanaf de landingspagina bereik je dit overzicht door te klikken op `Meer cursussen...`. ![create course](./staff.courses_new_link.png) @@ -83,7 +83,7 @@ Finaal moet je nog enkele zaken over de cursus zelf, zoals de naam en lesgever, Als je de registratieprocedure aanpast, dan blijven bestaande registraties voor de cursus gelden en blijven registratieverzoeken voor de cursus openstaan. Je moet zelf de bestaande registratiestatus van cursusgebruikers aanpassen. ::: -Eenmaal alles naar wens is ingesteld klik je op de knop `CURSUS AANMAKEN` om je cursus definitief aan te maken. +Eenmaal alles naar wens is ingesteld klik je op de knop `Cursus aanmaken` om je cursus definitief aan te maken. Na het aanmaken van de nieuwe cursus navigeer je automatisch naar de cursuspagina, waar je kunt vaststellen dat je automatisch geregistreerd bent als cursusgebruiker en dat je aangeduid bent als cursusbeheerder. diff --git a/en/guides/teachers/exercise-series-management/index.md b/en/guides/teachers/exercise-series-management/index.md index 251b3f837..1f5c683c7 100644 --- a/en/guides/teachers/exercise-series-management/index.md +++ b/en/guides/teachers/exercise-series-management/index.md @@ -17,11 +17,11 @@ Het leerpad van een cursus bestaat uit verschillende oefeningenreeksen die elk o ## Oefeningenreeks aanmaken -Een cursusbeheerder kan onbeperkt oefeningenreeksen binnen je cursus aanmaken. Je doet dit door eerst naar de cursuspagina van de cursus te navigeren en vervolgens `REEKSEN BEHEREN` aan te klikken. +Een cursusbeheerder kan onbeperkt oefeningenreeksen binnen je cursus aanmaken. Je doet dit door eerst naar de cursuspagina van de cursus te navigeren en vervolgens `Reeksen beheren` aan te klikken. ![reeksen beheren](./staff.course_manage_series_button.png) -Op deze pagina vind je rechtsboven de knop `REEKS AANMAKEN`. +Op deze pagina vind je rechtsboven de knop `Reeks aanmaken`. ![reeks aanmaken](./staff.course_new_series_button.png) @@ -129,7 +129,7 @@ Dit menu bevat een aantal handige acties die cursusbeheerders kunnen uitvoeren o ![scoresheet](./staff.scoresheet.png) - Klik op de naam van een cursusgebruiker om naar de overzichtpagina van de gebruiker te navigeren. + Klik op de naam van een cursusgebruiker om naar de overzichtspagina van de gebruiker te navigeren. Klik op het icoontje van een indienstatus om naar de oplossing te navigeren die gebruikt werd om de indienstatus te bepalen (als de cursusgebruiker effectief een oplossing heeft ingediend op basis waarvan de indienstatus kon bepaald worden). Je kan in dit overzicht ook filteren op studenten die aan minstens één activiteit begonnen zijn en zoeken op naam. @@ -163,11 +163,11 @@ In het actiemenu van een reeks kan je als lesgever ook kiezen om de ingezonden c Dit brengt je naar een exporteerpagina waar je eerst gevraagd wordt om de oefeningen in de reeks te selecteren waarvan je de inzendingen wenst. ![oefeningen kiezen](./staff.series_export_exercise_choice.png) -Als je ze allemaal wenst te downloaden, dan kies je het selectievakje in de hoofding van de tabel. Daarna klik je op `VOLGENDE STAP` om verder te gaan. +Als je ze allemaal wenst te downloaden, dan kies je het selectievakje in de hoofding van de tabel. Daarna klik je op `Volgende stap` om verder te gaan. Vervolgens kan je verschillende opties aanvinken die de inhoud van de export beïnvloeden. Je kan een samenvattende csv verkrijgen, kiezen of je alle oplossingen of enkel de laatste wil, of er rekening gehouden moet worden met de deadline, of de bestanden per student of per reeks gegroepeerd moeten worden en welke studenten meegerekend moeten worden. ![export opties](./staff.series_export_options.png) -Klik op `START EXPORT` om de download te starten. Je komt op de exportpagina die je zal verwittigen als je export klaar is. Meestal is dit binnen enkele seconden al het geval. +Klik op `Start export` om de download te starten. Je komt op de exportpagina die je zal verwittigen als je export klaar is. Meestal is dit binnen enkele seconden al het geval. ![export gestart](./staff.series_export_started.png) diff --git a/en/guides/teachers/getting-started/index.md b/en/guides/teachers/getting-started/index.md index c78c807ad..e61fce798 100644 --- a/en/guides/teachers/getting-started/index.md +++ b/en/guides/teachers/getting-started/index.md @@ -34,7 +34,7 @@ Een standaard Dodona-account kan zich vrij inschrijven voor cursussen en onbeper ## Een cursus aanmaken -Eenmaal we je lesgeversrechten hebben geactiveerd kan zelf een cursus aanmaken door op de knop `CURSUS AANMAKEN` te klikken in het [cursusoverzicht](https://dodona.be/nl/courses/). +Eenmaal we je lesgeversrechten hebben geactiveerd kan zelf een cursus aanmaken door op de knop `Cursus aanmaken` te klikken in het [cursusoverzicht](https://dodona.be/nl/courses/). ![cursus aanmaken](./cursus-aanmaken.png) @@ -47,7 +47,7 @@ Vervolgens kan je kiezen om te starten vanaf een lege cursus, of om de inhoud va ## Een cursus opstellen -Een cursus op Dodona bestaat uit verschillende oefeningenreeksen die je kan gebruiken om oefeningen te groeperen. Om een nieuwe oefeningenreeks aan te maken, klik je op de `REEKSEN BEHEREN` knop op je cursuspagina en vervolgens op `REEKS AANMAKEN`. Je krijgt dan onderstaand formulier te zien. +Een cursus op Dodona bestaat uit verschillende oefeningenreeksen die je kan gebruiken om oefeningen te groeperen. Om een nieuwe oefeningenreeks aan te maken, klik je op de `Reeksen beheren` knop op je cursuspagina en vervolgens op `Reeks aanmaken`. Je krijgt dan onderstaand formulier te zien. ![reeks-aanmaken](./reeks-aanmaken.png) diff --git a/en/guides/teachers/ufora/index.md b/en/guides/teachers/ufora/index.md index ccf027a09..5bca47e78 100644 --- a/en/guides/teachers/ufora/index.md +++ b/en/guides/teachers/ufora/index.md @@ -39,7 +39,7 @@ Using the ctrl button (or command on a Mac) on your keyboard, you can select one ## 4. Select 'Open as external resource' -After clicking on the `confirm` button, the dialog closes and the chosen exercises should appear on Ufora. **Watch out!** You're not done yet. By default, Ufora will open links to Dodona in a small inline window. You can easily fix this: +After clicking on the `Confirm` button, the dialog closes and the chosen exercises should appear on Ufora. **Watch out!** You're not done yet. By default, Ufora will open links to Dodona in a small inline window. You can easily fix this: - Click on the arrow next to the exercise name - Click on `Edit Properties In-place` - Select the `Open as External Resource` checkbox diff --git a/en/guides/teachers/user-management/index.md b/en/guides/teachers/user-management/index.md index b9e654b7d..ad6846087 100644 --- a/en/guides/teachers/user-management/index.md +++ b/en/guides/teachers/user-management/index.md @@ -71,6 +71,6 @@ Afhankelijk van de ingestelde [registratieprocedure](../creating-a-course/#cursu Deze gebruiker kan je terug inschrijven voor de cursus door te klikken op ![register](../../../../images/staff_registration_icons/register.png) ## Studenten opvolgen -Om de voortgang van een individuele student op te volgen is er een overzichtpagina per student voorzien. Je kan deze pagina raadplegen door in het gebruikersoverzicht van een cursus op de naam van een student te klikken. Op deze pagina krijg je een overzicht van de vooruitgang van een gebruiker binnenin de cursus. Naast enkele statistieken kan je ook de status voor elke oefening en reeks binnen de cursus voor deze student raadplegen. +Om de voortgang van een individuele student op te volgen is er een overzichtspagina per student voorzien. Je kan deze pagina raadplegen door in het gebruikersoverzicht van een cursus op de naam van een student te klikken. Op deze pagina krijg je een overzicht van de vooruitgang van een gebruiker binnenin de cursus. Naast enkele statistieken kan je ook de status voor elke oefening en reeks binnen de cursus voor deze student raadplegen. ![cursusoverzicht](./staff.user_course_overview.png) diff --git a/en/references/exercise-config/index.md b/en/references/exercise-config/index.md index 273043f98..8417a10ff 100644 --- a/en/references/exercise-config/index.md +++ b/en/references/exercise-config/index.md @@ -30,7 +30,7 @@ Dodona allows setting the configuration of an **exercise** and a **reading activ ## Config file structure for reading activities -The structure for a reading activity is identical to that of an exercise. There are 2 big differences: the value of `type` must be set to `content` and keys that are not relevant for exercises can be omitted. The format of the description is also identical. +The structure for a reading activity is identical to that of an exercise. There are two big differences: the value of `type` must be set to `content` and keys that are not relevant for exercises can be omitted. The format of the description is also identical. - **`type`**: Must be set to `content` for reading activities - **`access`** (`public` or `private`): determines who can use this exercise @@ -97,7 +97,6 @@ The structure for a reading activity is identical to that of an exercise. There "memory_limit": 100000000 }, "programming_language": "python", - "author": "Firstname Lastname ", - "contact": "firstname_lastname@ugent.be" + "contact": "Firstname Lastname " } ``` diff --git a/en/references/exercise-description/index.md b/en/references/exercise-description/index.md index 4875dbb25..afd301930 100644 --- a/en/references/exercise-description/index.md +++ b/en/references/exercise-description/index.md @@ -8,7 +8,11 @@ order: 1 > Dodona supports exercise descriptions and reading activities in HTML and Markdown with several additional features such as support for mathematical formulas. -These features are available for both exercises and reading activities. They are rendered in exactly the same way. The only difference is that exercises have a text editor at the bottom of the exercise description, where a reading activity has a `MARK AS READ` button. +::: tip Kramdown +Dodona uses [kramdown](https://kramdown.gettalong.org) to render Markdown, which supports a lot of extensions to the standard Markdown. Advanced users can find in [this overview](https://kramdown.gettalong.org/quickref.html) more explanation on how this formatting works. +::: + +These features are available for both exercises and reading activities. They are rendered in exactly the same way. The only difference is that exercises have a text editor at the bottom of the exercise description, where a reading activity has a `Mark as read` button. ## Markdown @@ -80,6 +84,18 @@ Which results in: To use images in your description, be sure to put the images in the `description/media/` [directory](/en/references/exercise-directory-structure) of your exercise. +### Set size + +It is possible to set the size of the image using both HTML and kramdown. + +```html +Dodona logo +``` + +```markdown +![Dodona logo](https://dodona.be/icon.png){:width="25%"} +``` + ### Lightboxes Dodona automatically adds [lightbox support](https://en.wikipedia.org/wiki/Lightbox_(JavaScript)) to all images in descriptions. If you click on an image, the image will open in a lightbox. It is possible to specify a caption for an image and to set an alternative (high-resolution) version for use in the lightbox. @@ -249,13 +265,13 @@ You can easily render code fragments in a monospaced font with syntax highlighti When using HTML, wrap your code with `` and ``: ```html -In your solution, you can use variable someVariable. +In your solution, you can use variable some_variable. ``` -In Markdown, wrap your code with backticks (\`): +In Markdown, wrap your code with backticks (\`). You can even add the programming language's syntax highlighting with `{:.language-python}` for example. ```markdown -In your solution, use can use variable `someVariable`. +In your solution, use can use variable `some_variable`. Use the abbreviated notation `result += 1`{:.language-python}. ``` ### Code blocks @@ -301,6 +317,14 @@ Using Markdown, Dodona can automatically add syntax highlighting if you provide let a = 5; let b = 42; ``` +Python doctests aren't properly highlighted by default. As a workaround, you can set the language to `console?lang=python&prompt=>>>`: + + ```console?lang=python&prompt=>>> + >>> echo("Hello world!") + "Hello world!" + >>> echo(5) + 5 + ``` ## Callouts diff --git a/en/references/judges/python-judge/index.md b/en/references/judges/python-judge/index.md index 2111b9ee1..164f075b6 100644 --- a/en/references/judges/python-judge/index.md +++ b/en/references/judges/python-judge/index.md @@ -313,7 +313,7 @@ Er zijn nog meer standaard processors, maar deze zijn nogal specifiek. Ze worden ### Outputprocessors definiëren -Om een eigen ouput processor te definiëren introduceren we de `DEFINITION` tag. Deze tag laat toe om wat dan ook te definiëren in de scope van de doctest. +Om een eigen output processor te definiëren introduceren we de `DEFINITION` tag. Deze tag laat toe om wat dan ook te definiëren in de scope van de doctest. ```python >>> my_new_function() #doctest: STDOUT @@ -465,7 +465,7 @@ languages)" and None ### Bestanden -Deze tag heeft drie vormen. Elke vorm zal er voor zorgen dat de naam van het bestand als link naar de inhoud van het bestand in de feedbacktabel terechtkomt. Als de optionele `href` parameter niet is ingevuld zal de inhoud van het bestand getoond worden met een popup. Dit kan voor grote bestanden tot lange wachttijden leiden, aangezien de inhoud twee keer in de feedbacktabel verwerkt zit. Voor grote bestanden kan dus de `href` parameter gebruikt worden. Dit zal er voor zorgen dat de naam van het bestand een link is naar een download van het bestand. Als de `href` parameter leeg is zal er geen link zijn naar de inhoud van het bestand. +Deze tag heeft drie vormen. Elke vorm zal er voor zorgen dat de naam van het bestand als link naar de inhoud van het bestand in de feedbacktabel terechtkomt. Als de optionele `href` parameter niet is ingevuld zal de inhoud van het bestand getoond worden met een pop-up. Dit kan voor grote bestanden tot lange wachttijden leiden, aangezien de inhoud twee keer in de feedbacktabel verwerkt zit. Voor grote bestanden kan dus de `href` parameter gebruikt worden. Dit zal er voor zorgen dat de naam van het bestand een link is naar een download van het bestand. Als de `href` parameter leeg is zal er geen link zijn naar de inhoud van het bestand. - Ingebed @@ -483,7 +483,7 @@ Deze tag heeft drie vormen. Elke vorm zal er voor zorgen dat de naam van het bes - Open bestaand bestand Deze vorm zorgt voor bestaande bestanden. Zo kan de inhoud gelinkt worden aan - de popup. + de pop-up. ``` xml diff --git a/en/references/tested/dsl/index.md b/en/references/tested/dsl/index.md index 20e95a104..cff846aee 100644 --- a/en/references/tested/dsl/index.md +++ b/en/references/tested/dsl/index.md @@ -73,7 +73,7 @@ In most cases, it is fine to leave the description empty. Each context must have at least one test case. Since each context is executed separately, the following two constraints apply: -- Only the first test case may have a "main call", i.e. command line arguments or stdin. +- Only the first test case may have a "main call", i.e. command line arguments or _stdin_. - Only the last test case may have a test for the program's exit code. Do note that the first and last test case may be the same one: @@ -84,7 +84,7 @@ if you only have one test case, it may be a main call and have a check for the e Test cases are the building blocks of a test suite, and contain some input and the expected outputs (the _tests_). Within each context, the following constraints apply to test cases: -- Only the first test case may have a "main call", i.e. command line arguments or stdin. +- Only the first test case may have a "main call", i.e. command line arguments or _stdin_. - Only the last test case may have a test for the program's exit code. Do note that the first and last test case may be the same one: diff --git a/en/references/tested/index.md b/en/references/tested/index.md index 055d98a5b..0558aa7b6 100644 --- a/en/references/tested/index.md +++ b/en/references/tested/index.md @@ -75,7 +75,7 @@ We'll explain how to create a simple programming exercise that uses TESTed to pr and how to make the exercise available on Dodona. The exercise is called "echo" and has the following problem statement: -> Define a function `echo` that outputs its string argument to stdout. +> Define a function `echo` that outputs its string argument to _stdout_. Here are some correct submissions for this exercise in a couple of different programming languages: @@ -203,7 +203,7 @@ We'll use the problem statement from above and add an example. Create a file `echo/description/description.en.md` with the following content: ````markdown -Define a function `echo` that outputs its string argument to stdout. +Define a function `echo` that outputs its string argument to _stdout_. ### Example in Python @@ -250,7 +250,7 @@ This test suite specifies that: 1. All feedback is included in a single tab called _Echo_. 2. The tab contains feedback on a single test case. 3. The test case calls the function `echo` with a string argument `"input-1"`. -4. The expected behavior of the test case is that the text `input-1` is generated on stdout. +4. The expected behavior of the test case is that the text `input-1` is generated on _stdout_. The file structure now looks like this: diff --git a/en/references/tested/json/index.md b/en/references/tested/json/index.md index 525b1e8e9..ec2d642f9 100644 --- a/en/references/tested/json/index.md +++ b/en/references/tested/json/index.md @@ -135,7 +135,7 @@ A test case is a statement or an expression that will be executed and evaluated. Each context has at least one test case. The following two constraints apply: -- Only the first test case may have a "main call", i.e. command line arguments or stdin. +- Only the first test case may have a "main call", i.e. command line arguments or _stdin_. - Only the last test case may have a test for the program's exit code. Do note that the first and last test case may be the same one: @@ -255,7 +255,7 @@ Here's an overview of all output channels currently supported by TESTed: ### EmptyChannel -An `EmptyChannel` describes that no output is expected on a specific file descriptor (e.g. stdout or stderr). +An `EmptyChannel` describes that no output is expected on a specific file descriptor (e.g. _stdout_ or _stderr_). Any output generated will be considered as incorrect by TESTed. The `EmptyChannel` is represented by a string constant `none`. @@ -273,7 +273,7 @@ For most output types, this is the default value, meaning you don't need to spec ### IgnoredChannel -An IgnoredChannel object describes that no output is expected on a specific file descriptor (e.g. stdout or stderr). +An IgnoredChannel object describes that no output is expected on a specific file descriptor (e.g. _stdout_ or _stderr_). Any output generated on the file descriptor will be ignored, and is considered correct by TESTed. In other words, if you do not want output, you should use [`EmptyChannel`](#emptychannel), while if you don't care about the output, you should use `IgnoredChannel`. @@ -422,8 +422,8 @@ TESTed currently supports the following two oracles: ### TextOutputChannel -A `TextOutputChannel` object represents text that is expected to be generated on an output channel (e.g. stdout or -stderr). +A `TextOutputChannel` object represents text that is expected to be generated on an output channel (e.g. _stdout_ or +_stderr_). For example, if the text `"Hello world"` must be written to `stdout`: diff --git a/nl/faq/activities/index.md b/nl/faq/activities/index.md index e051b0289..59fc51c20 100644 --- a/nl/faq/activities/index.md +++ b/nl/faq/activities/index.md @@ -13,3 +13,4 @@ Op de startpagina van Dodona kan je al jouw concepten terugvinden onder _Ongepub ## Hoe maak ik nieuwe oefeningen aan? Als lesgever kan je gebruikmaken van de honderden oefeningen die in Dodona aanwezig zijn, maar je kan ook zelf nieuwe oefeningen aanmaken. Je kan hiervoor [dit stappenplan](/nl/guides/exercises/creating-exercises/introduction) volgen. + diff --git a/nl/faq/annotations/index.md b/nl/faq/annotations/index.md index 8754cbad6..ee19b98c0 100644 --- a/nl/faq/annotations/index.md +++ b/nl/faq/annotations/index.md @@ -59,7 +59,7 @@ Je zal ook een melding zien in de bovenste navigatiebalk van je cursus. Klik op ![img.png](./course_question_list.png) -Als je alle open vragen over al je cursussen wil zien, kan je naar de pagina `vragen` gaan in de linkse navigatiebalk van Dodona. +Als je alle open vragen over al je cursussen wil zien, kan je naar de pagina `Vragen` gaan in de linkse navigatiebalk van Dodona. ![img.png](./questions_index_page.png) @@ -86,11 +86,11 @@ Je kan een algemene opmerking toevoegen door op de knop `Globale opmerking toevo ## Hoe kan ik opmerkingen opslaan en hergebruiken? Studenten maken vaak dezelfde fouten, of hebben gelijkaardige vragen. Om te vermijden dat je dezelfde opmerkingen steeds opnieuw moet schrijven, kan je opmerkingen hergebruiken. -Tijdens het schrijven of bewerken van een opmerking kan je `opmerking opslaan` aanvinken. Dit zal je toelaten om een titel toe te voegen aan de opmerking, wat je zal helpen om de opmerking in de toekomst terug te vinden. +Tijdens het schrijven of bewerken van een opmerking kan je `Sla opmerking op` aanvinken. Dit zal je toelaten om een titel toe te voegen aan de opmerking, wat je zal helpen om de opmerking in de toekomst terug te vinden. ![Save comment while writing](./save-comment-edit.png) -Je kan ook een bestaande opmerking opslaan door op `opmerking opslaan` te klikken in het menu van de opmerking. +Je kan ook een bestaande opmerking opslaan door op `Opmerking opslaan` te klikken in het menu van de opmerking. ![Save existing comment](save-comment-edit.png) diff --git a/nl/faq/featured-courses/index.md b/nl/faq/featured-courses/index.md index 78b27e580..29fbb7bd7 100644 --- a/nl/faq/featured-courses/index.md +++ b/nl/faq/featured-courses/index.md @@ -42,9 +42,9 @@ Dodona biedt een interactieve versie van dit boek, beschikbaar in zowel het [Ned --- -### Python-oefeningen bij Youtube-video's UHasselt +### Python-oefeningen bij YouTube-video's UHasselt -**Python-oefeningen bij Youtube videoreeks UHasselt** is een inleidende Python-cursus die een reeks [YouTube-video's](https://www.youtube.com/playlist?list=PL2iW_rkiCt7UqxL47lGkBaTgApj_QHJ0K) combineert met oefeningen op Dodona. De cursus is gemaakt door Dirk Peeters. +**Python-oefeningen bij YouTube videoreeks UHasselt** is een inleidende Python-cursus die een reeks [YouTube-video's](https://www.youtube.com/playlist?list=PL2iW_rkiCt7UqxL47lGkBaTgApj_QHJ0K) combineert met oefeningen op Dodona. De cursus is gemaakt door Dirk Peeters. De cursus is alleen beschikbaar in het [Nederlands](https://dodona.be/nl/courses/290/). diff --git a/nl/faq/ide-plugins/index.md b/nl/faq/ide-plugins/index.md index 0adc054c5..b60dbc4f3 100644 --- a/nl/faq/ide-plugins/index.md +++ b/nl/faq/ide-plugins/index.md @@ -42,7 +42,7 @@ Nadat je de Dodona-plugin voor PyCharm met succes hebt geïnstalleerd, kun je de 2. **Stuur je oplossing in**: Nadat je de oefening hebt opgelost, kun je je oplossing direct vanuit PyCharm indienen. Zoek hiervoor een blauw vinkje in de rechterbovenhoek van de interface. ![submit to dodona](./pc-check-mark.png) - Als je op deze knop klikt, wordt je code verzonden naar Dodona en automatisch gecontroleerd. Kort na het indienen zou je rechtsonder een popup moeten zien met het resultaat van je indiening. + Als je op deze knop klikt, wordt je code verzonden naar Dodona en automatisch gecontroleerd. Kort na het indienen zou je rechtsonder een pop-up moeten zien met het resultaat van je ingediende oplossing. ![juiste oplossing](./pc-correct.png) Als je meer details over het resultaat wilt zien, klik dan op de link 'more details' om het resultaat in een nieuwe browserversie te openen. Als je opnieuw wilt indienen, klik je gewoon weer op het blauwe vinkje. Onthoud dat je zo vaak kan indienen als je wil. @@ -77,5 +77,5 @@ Volg deze stappen om de Dodona VS Code extensie te gebruiken: 2. **Stuur je oplossing in:** Als je de oefening hebt opgelost, kun je je oplossing eenvoudig insturen met het 'Submit to Dodona' commando. Je kunt dit doen door het opdrachtenpalet te openen met Ctrl+Shift+P, (een deel van) `Submit to Dodona` in te typen en op Enter te drukken. Je kunt ook een snelkoppeling maken voor dit commando. Deze opdracht stuurt je code naar Dodona en activeert een automatische test. ![Submit](./vs-submit.png) -3. **Controleer het resultaat:** Na een paar seconden zou er rechtsonder een popup moeten verschijnen met het resultaat van je oplossing. Als je op de knop 'View results' klikt, wordt het resultaat in een nieuw browservenster geopend. Je kunt je oplossing zo vaak als je wilt insturen door hetzelfde commando te herhalen. +3. **Controleer het resultaat:** Na een paar seconden zou er rechtsonder een pop-up moeten verschijnen met het resultaat van je oplossing. Als je op de knop 'View results' klikt, wordt het resultaat in een nieuw browservenster geopend. Je kunt je oplossing zo vaak als je wilt insturen door hetzelfde commando te herhalen. ![juiste oplossing](./vs-correct.png) diff --git a/nl/guides/exercises/creating-exercises/exercise/index.md b/nl/guides/exercises/creating-exercises/exercise/index.md index 6848f0fd8..2013367db 100644 --- a/nl/guides/exercises/creating-exercises/exercise/index.md +++ b/nl/guides/exercises/creating-exercises/exercise/index.md @@ -1,7 +1,7 @@ --- title: "Oefeningen opstellen: opgave en testplan schrijven" sidebarTitle: Opgave en testplan -order: 3 +order: 2 prev: true next: true --- @@ -31,7 +31,7 @@ Doe dit als volgt: 1. Klik aan de linkerkant op het icoontje voor _Source Control_. 2. Klik bovenaan de lijst met wijzigingen op de knop met `+` om alle bestanden klaar te zetten (_Stage All Changes_). 3. Kies bovenaan een _commit message_. Hierin beschrijf je wat je gedaan hebt, zoals "Voeg mijn eerste oefening toe". -4. Klik op de knop `Commit & Push`. +4. Klik op de knop `Commit & Push`. Als je een pop-up krijgt, kies je voor `Sync (Push & Pull)`. Als alles goed gegaan is, werd dit venster leeg. diff --git a/nl/guides/exercises/creating-exercises/management/index.md b/nl/guides/exercises/creating-exercises/management/index.md index 24799dc71..83dae9446 100644 --- a/nl/guides/exercises/creating-exercises/management/index.md +++ b/nl/guides/exercises/creating-exercises/management/index.md @@ -13,8 +13,8 @@ Hieronder enkele suggesties voor volgende stappen: - [Maak een cursus aan](/nl/guides/teachers/creating-a-course/). - [Gebruik je oefening in een oefeningenreeks van een cursus](/nl/guides/teachers/exercise-series-management/). +- Maak [leesactiviteiten](/nl/guides/exercises/examples/content/) met extra informatie of kleine stukken theorie. - Maak nog andere soorten oefeningen. -- Maak [leesactiviteiten](/nl/references/exercise-config/) met extra informatie of kleine stukken theorie. Veel plezier met het gebruik van Dodona! Zoals steeds, als je vragen hebt of iets is niet duidelijk, aarzel dan niet om [ons te contacteren](https://dodona.be/nl/contact/). diff --git a/nl/guides/exercises/creating-exercises/setup/index.md b/nl/guides/exercises/creating-exercises/setup/index.md index 4168457c9..0064780a6 100644 --- a/nl/guides/exercises/creating-exercises/setup/index.md +++ b/nl/guides/exercises/creating-exercises/setup/index.md @@ -43,7 +43,7 @@ Als volgende stap moet je je persoonlijke kopie van het sjabloon maken: 1. Ga naar . 2. Klik op de knop `Use this template`. -3. Kies vervolgens de eerste optie: `Create new repository`. +3. Kies vervolgens de eerste optie: `Create a new repository`. ![Template repo](./use-template-repo.png) 4. Vul de details voor de nieuwe repository in: 1. Kies een naam voor de repository. diff --git a/nl/guides/exercises/examples/_common.md b/nl/guides/exercises/examples/_common.md index 1f0a7ee3d..322acb5df 100644 --- a/nl/guides/exercises/examples/_common.md +++ b/nl/guides/exercises/examples/_common.md @@ -6,8 +6,8 @@ Elke oefening in Dodona komt overeen met een bepaalde map in de oefeningenreposi Die map heeft een [vaste structuur](/nl/references/exercise-directory-structure), die we nu zullen maken. Maak dus eerst een nieuwe map voor de oefening, die we `minimum` zullen noemen. -Maak daarna, in deze nieuwe map, nog twee mappen: -- `description`: de map waarin de opgave komt +Maak daarna, in deze nieuwe map, nog drie mappen: +- `description`: map waarin de opgave komt - `evaluation`: map met informatie over hoe een oplossing beoordeeld moet worden - `solution`: map waarin een voorbeeldoplossing komt @@ -43,9 +43,9 @@ Maak het bestand `config.json` in de map `minimum` met de volgende inhoud: In dit bestand worden drie dingen gespecifieerd: -- De **naam** van de oefening zoals getoond door Dodona in het Nederlands (_nl_) en in het Engels (_en_) (in dit geval zijn beide namen hetzelfde). -- De **programmeertaal** van de oefening: hier kies je in welke programmeertaal je de oplossingen wilt. In dit geval is dat Python. -- Het **toegangsniveau**: hier _private_. We kiezen voor een private oefening omdat dit maar een handleiding is, maar we moedigen aan om je oefeningen publiek (_public_) te zetten: dan kunnen andere leerkrachten er ook gebruik van maken (net zoals jij de keuze hebt uit duizenden publieke oefeningen op Dodona). +- `names`: De **namen** van de oefening zoals getoond door Dodona in het Nederlands (_nl_) en in het Engels (_en_) (in dit geval zijn beide namen hetzelfde). +- `programming_language`: De **programmeertaal** van de oefening: hier kies je in welke programmeertaal je de oplossingen wilt. In dit geval is dat Python. +- `access`: Het **toegangsniveau** is hier _private_. We kiezen voor een private oefening omdat dit maar een handleiding is, maar we moedigen aan om je oefeningen publiek (_public_) te zetten: dan kunnen andere leerkrachten er ook gebruik van maken (net zoals jij de keuze hebt uit duizenden publieke oefeningen op Dodona). Nadat je dit bestand gemaakt hebt, zal je repository er zo uitzien: @@ -111,6 +111,7 @@ repository/ We willen dat deze oefening automatisch getest wordt. Hiervoor moeten we een testplan schrijven, waarin we Dodona vertellen welke testen we allemaal willen uitvoeren. +Als alle testgevallen geslaagd zijn, is de ingediende oplossing van de student volgens Dodona correct. In dit geval houden we het testplan kort, met slechts een beperkt aantal testgevallen. In een echte oefening wil je waarschijnlijk meer testgevallen voorzien. diff --git a/nl/guides/exercises/examples/class/index.md b/nl/guides/exercises/examples/class/index.md index 026c31805..111c66ceb 100644 --- a/nl/guides/exercises/examples/class/index.md +++ b/nl/guides/exercises/examples/class/index.md @@ -1,7 +1,7 @@ --- title: Oefening met klassen sidebarTitle: Klassen -order: 3 +order: 4 --- # Oefening met klassen @@ -21,8 +21,8 @@ Elke oefening in Dodona komt overeen met een bepaalde map in de oefeningenreposi Die map heeft een [vaste structuur](/nl/references/exercise-directory-structure), die we nu zullen maken. Maak dus eerst een nieuwe map voor de oefening, die we `counter` zullen noemen. -Maak daarna, in deze nieuwe map, nog twee mappen: -- `description`: de map waarin de opgave komt +Maak daarna, in deze nieuwe map, nog drie mappen: +- `description`: map waarin de opgave komt - `evaluation`: map met informatie over hoe een oplossing beoordeeld moet worden - `solution`: map waarin een voorbeeldoplossing komt @@ -58,10 +58,9 @@ Maak het bestand `config.json` in de map `counter` met de volgende inhoud: In dit bestand worden drie dingen gespecifieerd: -- De naam van de oefening zoals getoond door Dodona in het Nederlands en in het Engels. -- We stellen de naam van het testplan in (later meer hierover). Dit is een bestand relatief ten opzicht van de map `evaluation`. -- De programmeertaal van de oefening: hier kies je in welke programmeertaal je de oplossingen wilt. In dit geval is dat Python. -- Het toegangsniveau: hier _private_. We kiezen voor een private oefening omdat dit maar een handleiding is, maar we moedigen aan om je oefeningen publiek te zetten: dan kunnen andere leerkrachten er ook gebruik van maken (net zoals jij de keuze hebt uit duizenden publieke oefeningen op Dodona). +- `names`: De **namen** van de oefening zoals getoond door Dodona in het Nederlands (_nl_) en in het Engels (_en_). +- `programming_language`: De **programmeertaal** van de oefening: hier kies je in welke programmeertaal je de oplossingen wilt. In dit geval is dat Python. +- `acces`: Het **toegangsniveau** is hier _private_. We kiezen voor een private oefening omdat dit maar een handleiding is, maar we moedigen aan om je oefeningen publiek (_public_) te zetten: dan kunnen andere leerkrachten er ook gebruik van maken (net zoals jij de keuze hebt uit duizenden publieke oefeningen op Dodona). Nadat je dit bestand gemaakt hebt, zal je repository er zo uitzien: @@ -108,7 +107,7 @@ Daarnaast moet de klasse de volgende methoden ondersteunen: ``` ```` -De `nl` in de naam van de opgave kan je vervangen door `en` als je ook een Engelstalige opgave wilt maken. +Als je ook een Engelstalige opgave wilt maken, gebruik je de naam `description.en.md` voor het tweede bestand. De opgave zelf wordt geschreven in Markdown, een redelijk eenvoudig opmaakformaat. Meer informatie over Markdown is [hier](/nl/references/exercise-description) te vinden. We voegen ook direct een voorbeeldoplossing toe. @@ -147,7 +146,7 @@ repository/ ## 4. Een testplan maken We willen dat deze oefening automatisch getest wordt. -Hiervoor moeten we een testplan schrijven, waarin we Dodona vertellen welke testen we allemaal willen uitvoeren. +Hiervoor moeten we een testplan schrijven, waarin we Dodona vertellen welke testen we allemaal willen uitvoeren. Als alle testgevallen geslaagd zijn, is de ingediende oplossing van de student volgens Dodona correct. Om dit kort te houden, beperken we ons testplan tot een aantal testen. Maak een bestand `suite.yaml` in de map `evaluation` met volgende inhoud: @@ -159,7 +158,7 @@ Maak een bestand `suite.yaml` in de map `evaluation` met volgende inhoud: - statement: "counter = Counter(5)" - statement: "counter.report()" stdout: "5" - - expression: "counter.count()" + - statement: "counter.count()" - statement: "counter.report()" stdout: "6" - statement: "counter.count().count().count().count().report()" @@ -185,6 +184,6 @@ repository/ ## 5. Wijzigingen opslaan -Vergeet niet om je wijzigingen te committen, anders gaan ze verloren! +Vergeet niet om je wijzigingen te _committen_, anders gaan ze verloren! -Een voorbeeld van hoe je dit kan doen vind je in [hier](/nl/guides/exercises/creating-exercises/exercise/#_5-wijzigingen-opslaan). +Een voorbeeld van hoe je dit kan doen vind je [hier](/nl/guides/exercises/creating-exercises/exercise/#_5-wijzigingen-opslaan). diff --git a/nl/guides/exercises/examples/command-line/index.md b/nl/guides/exercises/examples/command-line/index.md index e1d42e4cb..f8d4b6766 100644 --- a/nl/guides/exercises/examples/command-line/index.md +++ b/nl/guides/exercises/examples/command-line/index.md @@ -1,15 +1,15 @@ --- title: Oefening op commandoregel sidebarTitle: Commandoregel -order: 4 +order: 5 --- # Oefening op de commandoregel -In deze handleiding stellen we een oefening op die gebruik maakt argumenten op de commandoregel. +In deze handleiding stellen we een oefening op die gebruik maakt van argumenten op de commandoregel. We zullen een programma implementeren dat een aantal getallen binnenkrijgt als argumenten op de commandoregel. -Het programma moet vervolgens de som van deze getallen uitschrijven op stdout. +Het programma moet vervolgens de som van deze getallen uitschrijven op _stdout_. We gaan er in deze handleiding van uit dat je al een werkende oefeningenrepository hebt. Is dat niet het geval, volg dan eerst de handleiding [_Oefeningen opstellen_](/nl/guides/exercises/creating-exercises/introduction/). @@ -22,8 +22,8 @@ Elke oefening in Dodona komt overeen met een bepaalde map in de oefeningenreposi Die map heeft een [vaste structuur](/nl/references/exercise-directory-structure), die we nu zullen maken. Maak dus eerst een nieuwe map voor de oefening, die we `sum` zullen noemen. -Maak daarna, in deze nieuwe map, nog twee mappen: -- `description`: de map waarin de opgave komt +Maak daarna, in deze nieuwe map, nog drie mappen: +- `description`: map waarin de opgave komt - `evaluation`: map met informatie over hoe een oplossing beoordeeld moet worden - `solution`: map waarin een voorbeeldoplossing komt @@ -42,7 +42,7 @@ repository/ Dodona eist voor elke oefeningen ook een [configuratiebestand](/nl/references/exercise-config). Dit bestand bevat metadata, die door Dodona gebruikt worden. -Maak het bestand `config.json` in de map `counter` met de volgende inhoud: +Maak het bestand `config.json` in de map `sum` met de volgende inhoud: ```json { @@ -59,10 +59,9 @@ Maak het bestand `config.json` in de map `counter` met de volgende inhoud: In dit bestand worden drie dingen gespecifieerd: -- De naam van de oefening zoals getoond door Dodona in het Nederlands en in het Engels. -- We stellen de naam van het testplan in (later meer hierover). Dit is een bestand relatief ten opzicht van de map `evaluation`. -- De programmeertaal van de oefening: hier kies je in welke programmeertaal je de oplossingen wilt. In dit geval is dat Python. -- Het toegangsniveau: hier _private_. We kiezen voor een private oefening omdat dit maar een handleiding is, maar we moedigen aan om je oefeningen publiek te zetten: dan kunnen andere leerkrachten er ook gebruik van maken (net zoals jij de keuze hebt uit duizenden publieke oefeningen op Dodona). +- `names`: De **namen** van de oefening zoals getoond door Dodona in het Nederlands (_nl_) en in het Engels (_en_). +- `programming_language`: De **programmeertaal** van de oefening: hier kies je in welke programmeertaal je de oplossingen wilt. In dit geval is dat Python. +- `access`: Het **toegangsniveau** is hier _private_. We kiezen voor een private oefening omdat dit maar een handleiding is, maar we moedigen aan om je oefeningen publiek (_public_) te zetten: dan kunnen andere leerkrachten er ook gebruik van maken (net zoals jij de keuze hebt uit duizenden publieke oefeningen op Dodona). Nadat je dit bestand gemaakt hebt, zal je repository er zo uitzien: @@ -101,7 +100,7 @@ invalid arguments ``` ```` -De `nl` in de naam van de opgave kan je vervangen door `en` als je ook een Engelstalige opgave wilt maken. +Als je ook een Engelstalige opgave wilt maken, gebruik je de naam `description.en.md` voor het tweede bestand. De opgave zelf wordt geschreven in Markdown, een redelijk eenvoudig opmaakformaat. Meer informatie over Markdown is [hier](/nl/references/exercise-description) te vinden. We voegen ook direct een voorbeeldoplossing toe. @@ -143,6 +142,7 @@ repository/ We willen dat deze oefening automatisch getest wordt. Hiervoor moeten we een testplan schrijven, waarin we Dodona vertellen welke testen we allemaal willen uitvoeren. +Als alle testgevallen geslaagd zijn, is de ingediende oplossing van de student volgens Dodona correct. Om dit kort te houden, beperken we ons testplan tot een aantal testen. Maak een bestand `suite.yaml` in de map `evaluation` met volgende inhoud: @@ -175,6 +175,6 @@ repository/ ## 5. Wijzigingen opslaan -Vergeet niet om je wijzigingen te committen, anders gaan ze verloren! +Vergeet niet om je wijzigingen te _committen_, anders gaan ze verloren! -Een voorbeeld van hoe je dit kan doen vind je in [hier](/nl/guides/exercises/creating-exercises/exercise/#_5-wijzigingen-opslaan). +Een voorbeeld van hoe je dit kan doen vind je [hier](/nl/guides/exercises/creating-exercises/exercise/#_5-wijzigingen-opslaan). diff --git a/nl/guides/exercises/examples/content/index.md b/nl/guides/exercises/examples/content/index.md new file mode 100644 index 000000000..ecc8edf42 --- /dev/null +++ b/nl/guides/exercises/examples/content/index.md @@ -0,0 +1,189 @@ +--- +title: "Leesactiviteit" +sidebarTitle: Leesactiviteit +order: 1 +--- + + +# Oefeningen opstellen: leesactiviteit + +Als je in de [handleiding](/nl/guides/exercises/creating-exercises/introduction/) de _template repository_ gebruikt hebt, bevat je repository al een oefening en leesactiviteit. +Hier zullen we nu zelf nog een leesactiviteit toevoegen. +Dit is handig om extra informatie of kleine stukken theorie te integreren in je leerpad. +De bestaande leesactiviteit kan uiteraard als voorbeeld dienen. + +::: info Analoog aan een oefening +De structuur en `config.json` voor een leesactiviteit zijn identiek aan deze van een oefening. +Er zijn echter twee grote verschillen: de waarde van `type` moet ingesteld worden op `content` en alles die specifiek voor oefeningen is, mag achterwege gelaten worden. +::: + +## 1. Structuur + +Elke leesactiviteit in Dodona komt overeen met een bepaalde map in de repository. +Die map heeft een [vaste structuur](/nl/references/exercise-directory-structure), die we nu zullen maken. + +Maak dus eerst een nieuwe map voor de oefening, die we `markdown_demo` zullen noemen. +Maak daarna, in deze nieuwe map, de map `description` aan waarin de leesactiviteit komt. +Maak daarna de map `media` aan in de map `description` waarin de afbeeldingen en andere bestanden komen. + +De map voor deze leesactiviteit moet er als volgt uitzien: + +``` +repository/ +└── markdown_demo/ + └── description/ + └── media/ +``` + +## 2. Configuratie + +Dodona eist voor elke leesactiviteiten ook een [configuratiebestand](/nl/references/exercise-config). +Dit bestand bevat metadata, die door Dodona gebruikt worden. + +Maak het bestand `config.json` in de map `markdown_demo` met de volgende inhoud: + +```json +{ + "description": { + "names": { + "en": "Markdown demo", + "nl": "Markdown demo" + } + }, + "access": "private", + "type": "content" +} +``` + +In dit bestand worden drie dingen gespecifieerd: + +- `names`: De **namen** van de leesactiviteit zoals getoond door Dodona in het Nederlands (_nl_) en in het Engels (_en_) (in dit geval zijn beide namen hetzelfde). +- `acces`: Het **toegangsniveau** is hier _private_. We kiezen voor een private leesactiviteit omdat dit maar een handleiding is, maar we moedigen aan om je leesactiviteiten publiek (_public_) te zetten: dan kunnen andere leerkrachten er ook gebruik van maken (net zoals jij de keuze hebt uit publieke leesactiviteiten op Dodona). +- `type`: Moet ingesteld worden op `content` voor leesactiviteiten. De standaardwaarde indien afwezig is `exercise`. + +Nadat je dit bestand gemaakt hebt, zal je repository er zo uitzien: + +``` +repository/ +└── markdown_demo/ + ├── description/ + | └── media/ + └── config.json +``` + +## 3. Afbeeldingen of bestanden toevoegen + +Om een afbeelding toe te voegen heb je twee opties. +Ofwel verwijs je naar een afbeelding die in de map `media` staat, ofwel verwijs je naar de afbeelding via een link. +In het voorbeeld komen straks beide manieren aan bod. + +Download onderstaande afbeelding met het logo van de UGent. Dit is een [directe link](https://styleguide.ugent.be/files/uploads/logo_UGent_NL_RGB_2400_kleur_witbg.png). Rechtsklik op de afbeelding en kies voor `Afbeelding opslaan...`. + +![UGent logo](logo_UGent.png) + +Rechtsklik op de map `media` in VS Code web en klik op `Upload...`. +Selecteer de afbeelding van op je computer en klik op `Openen`. + +Verwijzen naar de afbeelding als volgt. +De code start met een uitroepingsteken (`!`) en tussen de vierkante haken zet je een beschrijving van de afbeelding. +Tussen de ronde haken staat het pad naar de afbeelding. +`![Logo van de UGent](media/logo_UGent.png)` + +## 4. Inhoud + +De volgende stap is de inhoud van de leesactiviteit. +Maak een bestand `description.nl.md` aan in de map `description` van de leesactiviteit, met volgende inhoud: + +````markdown +# Markdown demo + +## Tekstopmaak + +Dit is een voorbeeldzin met woorden in *cursief*, **vet** en met variabel `result` in functie `geef_oplossing()`. + +## Links en afbeeldingen + +Dit is een zin waarbij [deze woorden](https://docs.dodona.be/nl/references/exercise-description/) linken naar de Dodona-handleiding over Markdown. +Hieronder staat het Dodona-logo afgebeeld via een link. + +![Dodona logo](https://dodona.be/icon.png) + +Er wordt rechtstreeks verwezen naar het logo van de UGent in de map `media`. + +![UGent logo](media/logo_UGent.png) + +### Populairste programmeertalen op Dodona + +1. Python +2. R +3. Java + +### Soorten ingenieurs + +* Handelsingenieur +* Industrieel ingenieur (ing.) +* Burgerlijk ingenieur (ir.) +* Bio-ingenieur + +## Wiskundige formules + +Bereken de lengte van de schuine zijde van een driehoek $$c$$ met de formule $$c^2 = a^2 + b^2$$. + +De oplossing kan gevonden worden met de volgende formule: +$$ +c = \sqrt{a^2 + b^2} +$$ + +## Codefragmenten + +In je oplossing, kan je deze code gebruiken: `print("text")`{:.language-python}. + +```console?lang=python&prompt=>>> +>>> echo("Hello") +Hello +>>> echo("Other side") +Other side +``` + +```python +naam = input() +print(f"Hallo, {naam}!") +``` + +## Callouts + +{: .callout.callout-success} +> #### Opgelet +> Dit is een belangrijk bericht. + +## Quotes + +Dit is geen quote. + +> Dit is een quote. +```` + +Als je ook Engelstalige inhoud wilt maken, gebruik je de naam `description.en.md` voor het tweede bestand. +De inhoud van leesactiviteiten wordt geschreven in Markdown, een redelijk eenvoudig opmaakformaat. Meer informatie over Markdown is [hier](/nl/references/exercise-description) te vinden. + +Nadat je deze twee bestanden gemaakt hebt, moet je repository er zo uitzien: + +``` +repository/ +└── markdown_demo/ + ├── description/ + | ├── media/ + | | └── logo_UGent.png + | └── description.nl.md + └── config.json +``` + +## 5. Wijzigingen opslaan + +Vergeet niet om je wijzigingen te _committen_, anders gaan ze verloren! + +Een voorbeeld van hoe je dit kan doen vind je [hier](/nl/guides/exercises/creating-exercises/exercise/#_5-wijzigingen-opslaan). + +## 6. Leesactiviteit controleren + +De leesactiviteit die je daarnet gemaakt hebt, kan je terugvinden in [jouw repository](https://dodona.be/nl/repositories/) op Dodona. Controleer de leesactiviteit. Is alles naar wens? Dan kan je bovenaan de leesactiviteit publiceren (_Deze oefening publiceren_). Je leesactiviteit is nu klaar om te gebruiken op Dodona! diff --git a/nl/guides/exercises/examples/content/logo_UGent.png b/nl/guides/exercises/examples/content/logo_UGent.png new file mode 100644 index 000000000..8cde9c308 Binary files /dev/null and b/nl/guides/exercises/examples/content/logo_UGent.png differ diff --git a/nl/guides/exercises/examples/function/index.md b/nl/guides/exercises/examples/function/index.md index bc0661dff..4d4eacffc 100644 --- a/nl/guides/exercises/examples/function/index.md +++ b/nl/guides/exercises/examples/function/index.md @@ -1,7 +1,7 @@ --- title: Oefening met functies sidebarTitle: Functies -order: 2 +order: 3 --- # Oefening met functies @@ -18,6 +18,6 @@ Is dat niet het geval, volg dan eerst de handleiding [_Oefeningen opstellen_](/n ## 5. Wijzigingen opslaan -Vergeet niet om je wijzigingen te committen, anders gaan ze verloren! +Vergeet niet om je wijzigingen te _committen_, anders gaan ze verloren! -Een voorbeeld van hoe je dit kan doen vind je in [hier](/nl/guides/exercises/creating-exercises/exercise/#_5-wijzigingen-opslaan). +Een voorbeeld van hoe je dit kan doen vind je [hier](/nl/guides/exercises/creating-exercises/exercise/#_5-wijzigingen-opslaan). diff --git a/nl/guides/exercises/examples/input-output/index.md b/nl/guides/exercises/examples/input-output/index.md index f51e5c30e..866f7fc3e 100644 --- a/nl/guides/exercises/examples/input-output/index.md +++ b/nl/guides/exercises/examples/input-output/index.md @@ -1,7 +1,7 @@ --- title: Oefening met invoer-uitvoer sidebarTitle: "Invoer-uitvoer" -order: 1 +order: 2 --- # Oefening met invoer en uitvoer @@ -22,8 +22,8 @@ Elke oefening in Dodona komt overeen met een bepaalde map in de oefeningenreposi Die map heeft een [vaste structuur](/nl/references/exercise-directory-structure), die we nu zullen maken. Maak dus eerst een nieuwe map voor de oefening, die we `hello-world` zullen noemen. -Maak daarna, in deze nieuwe map, nog twee mappen: -- `description`: de map waarin de opgave komt +Maak daarna, in deze nieuwe map, nog drie mappen: +- `description`: map waarin de opgave komt - `evaluation`: map met informatie over hoe een oplossing beoordeeld moet worden - `solution`: map waarin een voorbeeldoplossing komt @@ -59,10 +59,9 @@ Maak het bestand `config.json` in de map `hello-world` met de volgende inhoud: In dit bestand worden drie dingen gespecifieerd: -- De naam van de oefening zoals getoond door Dodona in het Nederlands en in het Engels (in dit geval zijn beide namen hetzelfde). -- We stellen de naam van het testplan in (later meer hierover). Dit is een bestand relatief ten opzicht van de map `evaluation`. -- De programmeertaal van de oefening: hier kies je in welke programmeertaal je de oplossingen wilt. In dit geval is dat Python. -- Het toegangsniveau: hier _private_. We kiezen voor een private oefening omdat dit maar een handleiding is, maar we moedigen aan om je oefeningen publiek te zetten: dan kunnen andere leerkrachten er ook gebruik van maken (net zoals jij de keuze hebt uit duizenden publieke oefeningen op Dodona). +- `names`: De **namen** van de oefening zoals getoond door Dodona in het Nederlands (_nl_) en in het Engels (_en_) (in dit geval zijn beide namen hetzelfde). +- `programming_language`: De **programmeertaal** van de oefening: hier kies je in welke programmeertaal je de oplossingen wilt. In dit geval is dat Python. +- `access`: Het **toegangsniveau** is hier _private_. We kiezen voor een private oefening omdat dit maar een handleiding is, maar we moedigen aan om je oefeningen publiek (_public_) te zetten: dan kunnen andere leerkrachten er ook gebruik van maken (net zoals jij de keuze hebt uit duizenden publieke oefeningen op Dodona). Nadat je dit bestand gemaakt hebt, zal je repository er zo uitzien: @@ -87,7 +86,7 @@ Schrijf een Python-programma dat de naam van de gebruiker vraagt en vervolgens de gebruiker begroet met de zin `Hallo, [NAAM]!`, waarbij `[NAAM]` de naam van de gebruiker is. -Het programma moet de naam dus inlezen van standaardinvoer (stdin) +Het programma moet de naam dus inlezen van standaardinvoer (_stdin_) en de begroeting uitschrijven naar standaarduitvoer (stdout). ### Voorbeeld @@ -99,7 +98,7 @@ Hallo, Jan! ``` ```` -De `nl` in de naam van de opgave kan je vervangen door `en` als je ook een Engelstalige opgave wilt maken. +Als je ook een Engelstalige opgave wilt maken, gebruik je de naam `description.en.md` voor het tweede bestand. De opgave zelf wordt geschreven in Markdown, een redelijk eenvoudig opmaakformaat. Meer informatie over Markdown is [hier](/nl/references/exercise-description) te vinden. We voegen ook direct een voorbeeldoplossing toe. @@ -130,13 +129,13 @@ repository/ We willen dat deze oefening automatisch getest wordt. Hiervoor moeten we een testplan schrijven, waarin we Dodona vertellen welke testen we allemaal willen uitvoeren. +Als alle testgevallen geslaagd zijn, is de ingediende oplossing van de student volgens Dodona correct. Deze oefening heeft natuurlijk een aantal voor de hand liggende testen, waarbij verschillende namen geprobeerd worden. Ook kunnen we eens een naam met cijfers of speciale tekens invullen. Nog een leuke naam is om een naam met dubbelen en enkele aanhalingstekens te proberen. -Ook een naam met _escaped newlines_ kunnen we proberen. -Om dit kort te houden, beperken we ons testplan tot zeven testen. +Om dit kort te houden, beperken we ons testplan tot zes testen. Maak een bestand `suite.yaml` in de map `evaluation` met volgende inhoud: ```yaml @@ -157,13 +156,12 @@ Maak een bestand `suite.yaml` in de map `evaluation` met volgende inhoud: ``` Een testplan wordt geschreven in YAML, en moet ook voldoen aan een bepaalde structuur. -In het voorbeeld hierboven maken we één tabblad met als naam "Testen", en definiëren zeven testen in dat tabblad: +In het voorbeeld hierboven maken we één tabblad met als naam "Testen", en definiëren zes testen in dat tabblad: - Testen 1 en 2 gebruiken twee namen. - Test 3 gebruikt cijfers en leestekens. - Test 4 gebruikt enkele aanhalingstekens. - Test 5 gebruikt dubbele aanhalingstekens. - Test 6 heeft een naam die enkel uit spaties bestaan. -- Test 7 heeft een naam met _escaped newlines_. ::: info Invoer met meerdere regels In het voorbeeldje gebruiken we nu telkens één regel invoer. @@ -207,6 +205,6 @@ repository/ ## 5. Wijzigingen opslaan -Vergeet niet om je wijzigingen te committen, anders gaan ze verloren! +Vergeet niet om je wijzigingen te _committen_, anders gaan ze verloren! -Een voorbeeld van hoe je dit kan doen vind je in [hier](/nl/guides/exercises/creating-exercises/exercise/#_5-wijzigingen-opslaan). +Een voorbeeld van hoe je dit kan doen vind je [hier](/nl/guides/exercises/creating-exercises/exercise/#_5-wijzigingen-opslaan). diff --git a/nl/guides/exercises/testsuites/index.md b/nl/guides/exercises/testsuites/index.md index ea4203206..26c16e45b 100644 --- a/nl/guides/exercises/testsuites/index.md +++ b/nl/guides/exercises/testsuites/index.md @@ -27,9 +27,9 @@ In de [referentiegids](/nl/references/tested/dsl) staat het volledige formaat vo Een testplan bestaat uit een hiërarchie van drie niveaus: -1. _Tabbladen_, die ook als apart tabblad getoond worden op Dodona. -2. _Contexten_, die een onafhankelijke eenheid van testgevallen voorstellen. -3. _Testgevallen_, die één test en zijn resultaten bevatten. +1. `tab`: **Tabbladen**, die ook als apart tabblad getoond worden op Dodona. +2. `contexts`: **Contexten**, die een onafhankelijke eenheid van testgevallen voorstellen. +3. `testcases`: **Testgevallen**, die één test en zijn resultaten bevatten. Een voorbeeld van een testplan met alle niveaus is: @@ -52,9 +52,9 @@ Een voorbeeld van een testplan met alle niveaus is: return: !v "2" ``` -In dit testplan zijn twee analoge tabbladen. +In dit testplan zijn er twee gelijkaardige tabbladen. Elk tabblad bevat twee contexten, die elk één testgeval hebben. -Elk testgeval roept de functie `echo` op met een andere parameter en bepaalt ook de verwachte returnwaarde. +Elk testgeval roept de functie `echo` op met een andere parameter en bepaalt ook de verwachte returnwaarde (_return_). Elk testgeval zit in een eigen context omdat elke functieoproep onafhankelijk van elkaar is. Een context met één testgeval komt veel voor. @@ -149,7 +149,7 @@ Hoewel de Python-syntaxis gebruikt wordt, wijken de conventies in een testplan s Een testplan gebruikt de Python-syntaxis, maar is geen Python. De gebruikte conventies zijn: -- Functieoproepen wier naam begint met een hoofdletters worden beschouwd als +- Functieoproepen waarvan de naam begint met een hoofdletter worden beschouwd als _constructors_, bijvoorbeeld `Constructor(56)`. - Identifiers die volledig in hoofdletters geschreven zijn worden beschouwd als globale constanten, bijvoorbeeld `VERY_LONG_NAME`. - Het casten van waarden gebeurt op de gebruikelijke manier van Python. Het casten van een getal naar `int64` wordt bijvoorbeeld `int64(56)`. Er is wel geen ondersteuning voor Python-constructors. Een verzameling moet je noteren als `set([1, 2, 3, 5])`, niet als `set(1, 2, 3, 5)`. @@ -227,10 +227,10 @@ def evaluate_test(expected, actual, five, six): Wat we doen in deze functie is de datum van vandaag berekenen. We geven vervolgens een `EvaluationResult` terug met vier parameters: -1. Een eerste boolean die aangeeft of de waarde uit de oplossing juist is of niet. In dit geval vergelijken we die gewoon met de datum van vandaag. -2. De verwachte waarde om te tonen op Dodona. We overschijven hier de verwachte waarde uit het testplan met de datum van vandaag. -3. De eigenlijke waarde om te tonen op Dodona. We geven hier de eigenlijke waarde gewoon door. -4. Een optionele lijst van berichten. Deze berichten worden ook getoond op Dodona en kunnen gebruikt worden om bijkomende feedback of uitleg aan de studenten te geven. +1. `result`: Een eerste boolean die aangeeft of de waarde uit de oplossing juist is of niet. In dit geval vergelijken we die gewoon met de datum van vandaag. +2. `dsl_expected`: De verwachte waarde om te tonen op Dodona. We overschijven hier de verwachte waarde uit het testplan met de datum van vandaag. +3. `dsl_actual`: De eigenlijke waarde om te tonen op Dodona. We geven hier de eigenlijke waarde gewoon door. +4. `messages`: Een optionele lijst van berichten. Deze berichten worden ook getoond op Dodona en kunnen gebruikt worden om bijkomende feedback of uitleg aan de studenten te geven. Ook `stderr` en `stdout` kunnen een eigen checkfunctie gebruiken. Hiervoor wordt dezelfde notatie gebruikt, maar met `data` in plaats van `value`: diff --git a/nl/guides/students/courses/index.md b/nl/guides/students/courses/index.md index 00343f5df..c3c46cb0b 100644 --- a/nl/guides/students/courses/index.md +++ b/nl/guides/students/courses/index.md @@ -17,7 +17,7 @@ Om oplossingen voor oefeningen in een cursus te kunnen indienen moet je in die c ### Hoe vind je een cursus? -Eerst moet je de cursus waarvoor je wil registreren vinden. Dit kan je doen door op je startpagina op `MEER CURSUSSEN...` of op `VERKEN CURSUSSEN` te klikken. +Eerst moet je de cursus waarvoor je wil registreren vinden. Dit kan je doen door op je startpagina op `Meer cursussen...` of op `Verken cursussen` te klikken. ![image](./student.explore_courses.png) @@ -29,13 +29,13 @@ Dit zal je naar een [overzicht van alle cursussen](https://dodona.be/nl/courses/ Als je navigeert naar de cursus dat je zocht, waarvoor je nog niet geregistreerd bent, dan zie je bovenaan de cursuspagina een paneel dat aangeeft of en hoe je je voor de cursus kan registreren. Hierbij zijn er drie mogelijkheden afhankelijk van hoe de cursus geconfigureerd werd: -- De cursus werkt met een **open registratieprocedure**, wat betekent dat iedereen zich voor de cursus kan registreren zonder expliciete goedkeuring van een cursusbeheerder. Klik op de knop `REGISTREREN` om je voor de cursus te registreren. +- De cursus werkt met een **open registratieprocedure**, wat betekent dat iedereen zich voor de cursus kan registreren zonder expliciete goedkeuring van een cursusbeheerder. Klik op de knop `Registreren` om je voor de cursus te registreren. ![image](./register.png)

-- De cursus werkt met een **gemodereerde registratieprocedure**, wat betekent dat je een **registratieverzoek** kunt indienen dat daarna dient goedgekeurd of afgekeurd te worden door een cursusbeheerder. Pas wanneer je registratieverzoek wordt goedgekeurd, ben je ook effectief geregistreerd voor de cursus. Klik op de knop `REGISTRATIEVERZOEK INDIENEN` om een registratieverzoek voor de cursus in te dienen. +- De cursus werkt met een **gemodereerde registratieprocedure**, wat betekent dat je een **registratieverzoek** kunt indienen dat daarna dient goedgekeurd of afgekeurd te worden door een cursusbeheerder. Pas wanneer je registratieverzoek wordt goedgekeurd, ben je ook effectief geregistreerd voor de cursus. Klik op de knop `Registratieverzoek indienen` om een registratieverzoek voor de cursus in te dienen. ![image](./moderated_register.png) @@ -119,7 +119,7 @@ Als je **na het verstrijken van de deadline** van een oefeningenreeks een oploss ## Uitschrijven uit een cursus -Als je navigeert naar een cursus waarvoor je [geregistreerd](#registreren-voor-een-cursus) bent of waarvoor je nog een registratieverzoek hebt openstaan, dan zie je onder de beschrijving van de cursus op de cursuspagina een knop `UITSCHRIJVEN` (of `REGISTRATIEVERZOEK ANNULEREN`) waarmee je je kunt uitschrijven uit de cursus. +Als je navigeert naar een cursus waarvoor je [geregistreerd](#registreren-voor-een-cursus) bent of waarvoor je nog een registratieverzoek hebt openstaan, dan zie je onder de beschrijving van de cursus op de cursuspagina een knop `Uitschrijven` (of `Registratieverzoek annuleren`) waarmee je je kunt uitschrijven uit de cursus. ![image](./student.unregister.png) diff --git a/nl/guides/teachers/course-management/index.md b/nl/guides/teachers/course-management/index.md index 0ba91952b..f47657d6d 100644 --- a/nl/guides/teachers/course-management/index.md +++ b/nl/guides/teachers/course-management/index.md @@ -22,7 +22,7 @@ Om de eigenschappen van een bestaande cursus te bewerken, navigeer je naar de cu Je komt op een pagina terecht waar je de naam, lesgevers, beschrijving, academiejaar, zichtbaarheid en registratieprocedure kan aanpassen. Voor meer details over de specifieke eigenschappen kan je terecht op [deze pagina](../creating-a-course/#cursuseigenschappen). -Klik na het aanpassen op de afwerkknop in de rechterbovenhoek van het paneel om de nieuwe cursuseigenschappen op te slaan. Alternatief kan je ook op de `AANPASSEN` klikken onderaan het paneel. Daarna navigeer je automatisch terug naar de cursuspagina waar de nieuwe cursuseigenschappen onmiddellijk van toepassing zijn. +Klik na het aanpassen op de afwerkknop in de rechterbovenhoek van het paneel om de nieuwe cursuseigenschappen op te slaan. Alternatief kan je ook op de `Aanpassen` klikken onderaan het paneel. Daarna navigeer je automatisch terug naar de cursuspagina waar de nieuwe cursuseigenschappen onmiddellijk van toepassing zijn. ![image](./staff.course_after_edit.png) @@ -49,7 +49,7 @@ Als je klikt op het filter-icoontje voor de naam van een student of oefening, da Deze oplossingen kan je ook op andere manieren bereiken: * Een overzicht van de oplossingen voor een **specifieke oefening** vind je door op de cursuspagina op het pijltje rechts van een oefening te klikken. -* Een overzicht van de oplossingen voor **specifieke gebruiker** vind je door op `OPLOSSINGEN` te klikken op de [cursuspagina van die gebruiker](../user-management/#studenten-opvolgen). +* Een overzicht van de oplossingen voor **specifieke gebruiker** vind je door op `Oplossingen` te klikken op de [cursuspagina van die gebruiker](../user-management/#studenten-opvolgen). In het oplossingenoverzicht vindt je rechts van de filterbalk een knop met 3 puntjes. In het menu vindt je enkele acties en filter: diff --git a/nl/guides/teachers/creating-a-course/index.md b/nl/guides/teachers/creating-a-course/index.md index 670389999..1d4f08dd2 100644 --- a/nl/guides/teachers/creating-a-course/index.md +++ b/nl/guides/teachers/creating-a-course/index.md @@ -12,7 +12,7 @@ Je hebt extra rechten nodig om een cursus te kunnen aanmaken. Je kan deze rechte ::: -Als je de nodige rechten hebt op Dodona, dan kan je eenvoudig zelf een cursus aanmaken. Dit doe je door op de knop `CURSUS AANMAKEN` te klikken in de rechterbovenhoek van het [cursusoverzicht](https://dodona.be/nl/courses). Vanaf de landingspagina bereik je dit overzicht door te klikken op `MEER CURSUSSEN...`. +Als je de nodige rechten hebt op Dodona, dan kan je eenvoudig zelf een cursus aanmaken. Dit doe je door op de knop `Cursus aanmaken` te klikken in de rechterbovenhoek van het [cursusoverzicht](https://dodona.be/nl/courses). Vanaf de landingspagina bereik je dit overzicht door te klikken op `Meer cursussen...`. ![create course](./staff.courses_new_link.png) @@ -79,7 +79,7 @@ Finaal moet je nog enkele zaken over de cursus zelf, zoals de naam en lesgever, Als je de registratieprocedure aanpast, dan blijven bestaande registraties voor de cursus gelden en blijven registratieverzoeken voor de cursus openstaan. Je moet zelf de bestaande registratiestatus van cursusgebruikers aanpassen. ::: -Eenmaal alles naar wens is ingesteld klik je op de knop `CURSUS AANMAKEN` om je cursus definitief aan te maken. +Eenmaal alles naar wens is ingesteld klik je op de knop `Cursus aanmaken` om je cursus definitief aan te maken. Na het aanmaken van de nieuwe cursus navigeer je automatisch naar de cursuspagina, waar je kunt vaststellen dat je automatisch geregistreerd bent als cursusgebruiker en dat je aangeduid bent als cursusbeheerder. diff --git a/nl/guides/teachers/exercise-series-management/index.md b/nl/guides/teachers/exercise-series-management/index.md index 46e0dec51..715b38332 100644 --- a/nl/guides/teachers/exercise-series-management/index.md +++ b/nl/guides/teachers/exercise-series-management/index.md @@ -10,11 +10,11 @@ Het leerpad van een cursus bestaat uit verschillende oefeningenreeksen die elk o ## Oefeningenreeks aanmaken -Een cursusbeheerder kan onbeperkt oefeningenreeksen binnen je cursus aanmaken. Je doet dit door eerst naar de cursuspagina van de cursus te navigeren en vervolgens `REEKSEN BEHEREN` aan te klikken. +Een cursusbeheerder kan onbeperkt oefeningenreeksen binnen je cursus aanmaken. Je doet dit door eerst naar de cursuspagina van de cursus te navigeren en vervolgens `Reeksen beheren` aan te klikken. ![reeksen beheren](./staff.course_manage_series_button.png) -Op deze pagina vind je rechtsboven de knop `REEKS AANMAKEN`. +Op deze pagina vind je rechtsboven de knop `Reeks aanmaken`. ![reeks aanmaken](./staff.course_new_series_button.png) @@ -122,7 +122,7 @@ Dit menu bevat een aantal handige acties die cursusbeheerders kunnen uitvoeren o ![scoresheet](./staff.scoresheet.png) - Klik op de naam van een cursusgebruiker om naar de overzichtpagina van de gebruiker te navigeren. + Klik op de naam van een cursusgebruiker om naar de overzichtspagina van de gebruiker te navigeren. Klik op het icoontje van een indienstatus om naar de oplossing te navigeren die gebruikt werd om de indienstatus te bepalen (als de cursusgebruiker effectief een oplossing heeft ingediend op basis waarvan de indienstatus kon bepaald worden). Je kan in dit overzicht ook filteren op studenten die aan minstens één activiteit begonnen zijn en zoeken op naam. @@ -156,11 +156,11 @@ In het actiemenu van een reeks kan je als lesgever ook kiezen om de ingezonden c Dit brengt je naar een exporteerpagina waar je eerst gevraagd wordt om de oefeningen in de reeks te selecteren waarvan je de inzendingen wenst. ![oefeningen kiezen](./staff.series_export_exercise_choice.png) -Als je ze allemaal wenst te downloaden, dan kies je het selectievakje in de hoofding van de tabel. Daarna klik je op `VOLGENDE STAP` om verder te gaan. +Als je ze allemaal wenst te downloaden, dan kies je het selectievakje in de hoofding van de tabel. Daarna klik je op `Volgende stap` om verder te gaan. Vervolgens kan je verschillende opties aanvinken die de inhoud van de export beïnvloeden. Je kan een samenvattende csv verkrijgen, kiezen of je alle oplossingen of enkel de laatste wil, of er rekening gehouden moet worden met de deadline, of de bestanden per student of per reeks gegroepeerd moeten worden en welke studenten meegerekend moeten worden. ![export opties](./staff.series_export_options.png) -Klik op `START EXPORT` om de download te starten. Je komt op de exportpagina die je zal verwittigen als je export klaar is. Meestal is dit binnen enkele seconden al het geval. +Klik op `Start export` om de download te starten. Je komt op de exportpagina die je zal verwittigen als je export klaar is. Meestal is dit binnen enkele seconden al het geval. ![export gestart](./staff.series_export_started.png) diff --git a/nl/guides/teachers/getting-started/index.md b/nl/guides/teachers/getting-started/index.md index 155e5b6b8..446c8c755 100644 --- a/nl/guides/teachers/getting-started/index.md +++ b/nl/guides/teachers/getting-started/index.md @@ -30,7 +30,7 @@ Een standaard Dodona-account kan zich vrij inschrijven voor cursussen en onbeper ## Een cursus aanmaken -Eenmaal we je lesgeversrechten hebben geactiveerd kan zelf een cursus aanmaken door op de knop `CURSUS AANMAKEN` te klikken in het [cursusoverzicht](https://dodona.be/nl/courses/). +Eenmaal we je lesgeversrechten hebben geactiveerd kan zelf een cursus aanmaken door op de knop `Cursus aanmaken` te klikken in het [cursusoverzicht](https://dodona.be/nl/courses/). ![cursus aanmaken](./cursus-aanmaken.png) @@ -43,7 +43,7 @@ Vervolgens kan je kiezen om te starten vanaf een lege cursus, of om de inhoud va ## Een cursus opstellen -Een cursus op Dodona bestaat uit verschillende oefeningenreeksen die je kan gebruiken om oefeningen te groeperen. Om een nieuwe oefeningenreeks aan te maken, klik je op de `REEKSEN BEHEREN` knop op je cursuspagina en vervolgens op `REEKS AANMAKEN`. Je krijgt dan onderstaand formulier te zien. +Een cursus op Dodona bestaat uit verschillende oefeningenreeksen die je kan gebruiken om oefeningen te groeperen. Om een nieuwe oefeningenreeks aan te maken, klik je op de `Reeksen beheren` knop op je cursuspagina en vervolgens op `Reeks aanmaken`. Je krijgt dan onderstaand formulier te zien. ![reeks-aanmaken](./reeks-aanmaken.png) diff --git a/nl/guides/teachers/user-management/index.md b/nl/guides/teachers/user-management/index.md index e40f47e73..6040b6afd 100644 --- a/nl/guides/teachers/user-management/index.md +++ b/nl/guides/teachers/user-management/index.md @@ -65,6 +65,6 @@ Afhankelijk van de ingestelde [registratieprocedure](../creating-a-course/#cursu Deze gebruiker kan je terug inschrijven voor de cursus door te klikken op ![register](../../../../images/staff_registration_icons/register.png) ## Studenten opvolgen -Om de voortgang van een individuele student op te volgen is er een overzichtpagina per student voorzien. Je kan deze pagina raadplegen door in het gebruikersoverzicht van een cursus op de naam van een student te klikken. Op deze pagina krijg je een overzicht van de vooruitgang van een gebruiker binnenin de cursus. Naast enkele statistieken kan je ook de status voor elke oefening en reeks binnen de cursus voor deze student raadplegen. +Om de voortgang van een individuele student op te volgen is er een overzichtspagina per student voorzien. Je kan deze pagina raadplegen door in het gebruikersoverzicht van een cursus op de naam van een student te klikken. Op deze pagina krijg je een overzicht van de vooruitgang van een gebruiker binnenin de cursus. Naast enkele statistieken kan je ook de status voor elke oefening en reeks binnen de cursus voor deze student raadplegen. ![cursusoverzicht](./staff.user_course_overview.png) diff --git a/nl/references/exercise-config/index.md b/nl/references/exercise-config/index.md index 7c5098d7b..9f24e1f79 100644 --- a/nl/references/exercise-config/index.md +++ b/nl/references/exercise-config/index.md @@ -20,7 +20,7 @@ Dodona laat toe om de configuratie van een **oefening** of een **leesactiviteit* - **`nl`**: de naam van de oefening in het Nederlands - `en`: de naam van de oefening in het Engels - **`evaluation`**: de specificatie van de evaluatieprocedure - - **`handler`** (string, optioneel): de naam van de judge die gebruikt wordt voor de evaluatie. Standaard gebruik Dodona de judge die ingesteld is voor de repository. Een overzicht van de mogelijke judges vind je [hier](/nl/references/judges). + - **`handler`** (string, optioneel): de naam van de judge die gebruikt wordt voor de evaluatie. Standaard gebruikt Dodona de judge die ingesteld is voor de repository. Een overzicht van de mogelijke judges vind je [hier](/nl/references/judges). - **`image`** (string, optioneel): de naam van de docker image die gebruikt wordt voor de evaluatie. Standaard gebruikt Dodona de image die ingesteld is voor de judge. - **`time_limit`** (integer, optioneel): de tijd in seconden waarna de evaluatie van een oefening stopgezet wordt. Standaard is dit 42 seconden - **`memory_limit`** (integer, optioneel): de hoeveelheid geheugen in bytes die gebruikt kan worden bij het uitvoeren van de evaluatie. Standaard is dit ingesteld op 100M. @@ -30,7 +30,7 @@ Dodona laat toe om de configuratie van een **oefening** of een **leesactiviteit* ## Configuratiebestandsstructuur voor leesactiviteiten -De structuur voor een leesactiviteit is identiek aan deze van een oefening. Er zijn echter 2 grote verschillen: de waarde van `type` moet ingesteld worden op `content` en bepaalde verplichte velden zoals `programming_language` mogen achterwege gelaten worden. +De structuur voor een leesactiviteit is identiek aan deze van een oefening. Er zijn echter twee grote verschillen: de waarde van `type` moet ingesteld worden op `content` en bepaalde verplichte velden zoals `programming_language` mogen achterwege gelaten worden. - **`type`**: Moet ingesteld worden op `content` voor leesactiviteiten. - **`access`** (`public` of `private`): bepaalt wie deze oefening kan gebruiken @@ -97,7 +97,6 @@ De structuur voor een leesactiviteit is identiek aan deze van een oefening. Er z "memory_limit": 100000000 }, "programming_language": "python", - "author": "Firstname Lastname ", - "contact": "firstname_lastname@ugent.be" + "contact": "Firstname Lastname " } ``` diff --git a/nl/references/exercise-description/index.md b/nl/references/exercise-description/index.md index da83adf2b..64a37f9ad 100644 --- a/nl/references/exercise-description/index.md +++ b/nl/references/exercise-description/index.md @@ -8,7 +8,11 @@ order: 1 > Dodona ondersteunt oefeningbeschrijvingen en leesactiviteiten in HTML en Markdown met verschillende extra features zoals ondersteuning voor wiskundige formules. -De features die op deze pagina beschreven worden zijn beschikbaar voor zowel oefeningen als leesactiviteiten. Ze worden op exact dezelfde manier weergegeven. Het enige verschil is dat oefeningen onderaan de beschrijving een tekst editor hebben, terwijl leesactiviteiten een `MARKEER ALS GELEZEN` knop hebben. +::: tip Kramdown +Dodona maakt voor de weergave van Markdown gebruik van [kramdown](https://kramdown.gettalong.org) waardoor heel wat uitbreidingen van de standaard Markdown ondersteund worden. Gevorderde gebruikers kunnen in [dit overzicht](https://kramdown.gettalong.org/quickref.html) meer uitleg vinden over hoe deze formattering werkt. +::: + +De features die op deze pagina beschreven worden zijn beschikbaar voor zowel oefeningen als leesactiviteiten. Ze worden op exact dezelfde manier weergegeven. Het enige verschil is dat oefeningen onderaan de beschrijving een teksteditor hebben, terwijl leesactiviteiten een knop `Markeer als gelezen` hebben. ## Markdown @@ -79,6 +83,18 @@ Opsommingen werken heel natuurlijk in Markdown. Afhankelijk of je een genummerde Om afbeeldingen te gebruiken in je opgave, dien je de afbeeldingen in de `description/media/` [map](/nl/references/exercise-directory-structure) te plaatsen. +### Grootte instellen + +Het is mogelijk om zowel met HTML als kramdown de grootte van de afbeelding in te stellen. + +```html +Dodona logo +``` + +```markdown +![Dodona logo](https://dodona.be/icon.png){:width="25%"} +``` + ### Lightboxes Dodona voegt automatisch een [lightbox](https://en.wikipedia.org/wiki/Lightbox_(JavaScript)) toe aan alle afbeeldingen in een opgave. Dat wil zeggen dat als je op een afbeelding klikt, deze zal openen in een lightbox. Het is ook mogelijk om zo een onderschrift toe te voegen en om een alternatieve (hoge-resolutie) versie van de afbeelding te tonen. @@ -254,13 +270,14 @@ Je kan op Dodona heel eenvoudig codefragmenten tonen in een *monospaced* lettert Als je HTML gebruikt, plaats dan `` en `` rond je code. ```html -Gebruik de variabele someVariable in je oplossing. +Gebruik de variabele some_variable in je oplossing. ``` -Als je Markdown gebruikt, plaats dan *backticks* (\`) rond je code. +Als je Markdown gebruikt, plaats dan *backticks* (\`) rond je code. Je kan ook de gebruikte programmeertaal toevoegen, bijvoorbeeld met `{:.language-python}`. Dat laatste zorgt dan voor _syntax highlighting_. ```markdown -Gebruik de variabele `someVariable` in je oplossing. +Gebruik de variabele `some_variable` in je oplossing. +Gebruik de verkorte notatie `result += 1`{:.language-python}. ``` ### Blokken code @@ -307,6 +324,15 @@ Als je Markdown gebruikt, dan kan Dodona automatisch de code opmaken als je aang let b = 42; ``` +Python doctests worden standaard niet correct gemarkeerd. Als oplossing kan je de taal instellen met `console?lang=python&prompt=>>>`: + + ```console?lang=python&prompt=>>> + >>> echo("Hello world!") + "Hello world!" + >>> echo(5) + 5 + ``` + ## Callouts Om de aandacht te vestigen op een stukje uit je opgave, kan je gebruik maken van *callouts*. Dit zorgt voor een opmaak zoals hier wordt getoond: diff --git a/nl/references/judges/python-judge/index.md b/nl/references/judges/python-judge/index.md index 1f7bef74c..282eb5aea 100644 --- a/nl/references/judges/python-judge/index.md +++ b/nl/references/judges/python-judge/index.md @@ -316,7 +316,7 @@ Er zijn nog meer standaard processors, maar deze zijn nogal specifiek. Ze worden ### Outputprocessors definiëren -Om een eigen ouput processor te definiëren introduceren we de `DEFINITION` tag. Deze tag laat toe om wat dan ook te definiëren in de scope van de doctest. +Om een eigen output processor te definiëren introduceren we de `DEFINITION` tag. Deze tag laat toe om wat dan ook te definiëren in de scope van de doctest. ```python >>> my_new_function() #doctest: STDOUT @@ -468,7 +468,7 @@ languages)" and None ### Bestanden -Deze tag heeft drie vormen. Elke vorm zal er voor zorgen dat de naam van het bestand als link naar de inhoud van het bestand in de feedbacktabel terechtkomt. Als de optionele `href` parameter niet is ingevuld zal de inhoud van het bestand getoond worden met een popup. Dit kan voor grote bestanden tot lange wachttijden leiden, aangezien de inhoud twee keer in de feedbacktabel verwerkt zit. Voor grote bestanden kan dus de `href` parameter gebruikt worden. Dit zal er voor zorgen dat de naam van het bestand een link is naar een download van het bestand. Als de `href` parameter leeg is zal er geen link zijn naar de inhoud van het bestand. +Deze tag heeft drie vormen. Elke vorm zal er voor zorgen dat de naam van het bestand als link naar de inhoud van het bestand in de feedbacktabel terechtkomt. Als de optionele `href` parameter niet is ingevuld zal de inhoud van het bestand getoond worden met een pop-up. Dit kan voor grote bestanden tot lange wachttijden leiden, aangezien de inhoud twee keer in de feedbacktabel verwerkt zit. Voor grote bestanden kan dus de `href` parameter gebruikt worden. Dit zal er voor zorgen dat de naam van het bestand een link is naar een download van het bestand. Als de `href` parameter leeg is zal er geen link zijn naar de inhoud van het bestand. - Ingebed diff --git a/nl/references/tested/dsl/index.md b/nl/references/tested/dsl/index.md index 9ebf93eca..6da5a7321 100644 --- a/nl/references/tested/dsl/index.md +++ b/nl/references/tested/dsl/index.md @@ -135,7 +135,7 @@ return: #### `stdout` / `stderr` -Specifieert het verwachte resultaat op respectievelijk standaarduitvoer (stdout) en standaardfout (stderr). +Specifieert het verwachte resultaat op respectievelijk standaarduitvoer (_stdout_) en standaardfout (_stderr_). De waarde van het attribuut is ofwel een string (dat dan het verwachte resultaat is), of een object voor meer complexe situaties. Het object heeft volgende attributen: @@ -253,8 +253,8 @@ Een configuratie-object op tabniveau gebruiken zal er bijvoorbeeld voor zorgen d Een configuratie-object kan volgende attributen hebben: -- `stdout`: de [configuratieopties](#testopties) voor standaarduitvoer (stdout) -- `stderr`: de [configuratieopties](#testopties) voor standaardfout (stderr) +- `stdout`: de [configuratieopties](#testopties) voor standaarduitvoer (_stdout_) +- `stderr`: de [configuratieopties](#testopties) voor standaardfout (_stderr_) - `return`: de [configuratieopties](#testopties) voor de verwachte returnwaarde ### Testopties diff --git a/nl/references/tested/index.md b/nl/references/tested/index.md index f07852e2d..f7249e959 100644 --- a/nl/references/tested/index.md +++ b/nl/references/tested/index.md @@ -245,7 +245,7 @@ Dit testplan definieert zegt: 1. Alle feedback is verzameld in één tabblad met naam _Echo_. 2. Het tabblad bevat feedback voor één testgeval. 3. Het testgeval roept we de functie `echo` op met een string `"input-1"` als argument. -4. Het verwachte resultaat is dat de tekst `input-1` op stdout geschreven wordt. +4. Het verwachte resultaat is dat de tekst `input-1` op _stdout_ geschreven wordt. Nu ziet de bestandsstructuur er als volgt uit: