Merge pull request #328 from dodona-edu/feat/add-saved-annotations

Introduce teacher documentation for annotations

en/faq/annotations/index.md

@@ -0,0 +1,115 @@
+---
+title: Questions and comments
+---
+
+# Questions and comments
+
+[[toc]]
+
+## How can I ask a question about my code? <Badge type="tip" text="student" />
+
+::: tip Note
+This feature is only available if your teacher has enabled it.
+:::
+
+![image](./student.ask_questions.png)
+After you have submitted your solution, you can ask a question in three ways. At the top of the submitted code, you can ask a general question by clicking on `Ask a question about your code`. In addition, you can click on the pink circle to the left of the line number to ask a question about a specific line of code. You can also select a piece of code and then ask questions about it using the same button.
+
+
+![image](./student.ask_question.gif)
+
+Type the question you want to ask the teacher in the text box. You can use Markdown to add extra formatting to your text. Finally, click on `Ask question`.
+
+::: tip Markdown support
+
+You can add extra formatting with Markdown by:
+
+- asterisks (\*) around words to make it italic. \*italic text\* will be displayed as *italic text*.
+- double asterisks (\**) around words to make it bold. \*\*bold text\*\* will be displayed as **bold text**.
+- backticks (\`) around a piece of code. \`Variables\` will be displayed as `Variables`.
+
+Here you can view [all the possibilities of Markdown](/en/references/exercise-description/#markdown).
+:::
+
+![img.png](./student.react.png)
+
+You can also respond to an existing question from yourself or to a comment from a teacher. To do this, click on `Reply` below the question or comment. Type your response in the text box and click on `Reply`.
+
+## How do I know if my question has been answered? <Badge type="tip" text="student" />
+
+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.
+
+![image](./comment_on_code.png)
+
+## How can I enable/disable student questions? <Badge type="tip" text="teacher" />
+
+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)
+
+Don't forget to save your changes by clicking on the pink checkmark at the top right of the page.
+
+## How do I know if there are any open questions? <Badge type="tip" text="teacher" />
+
+If there are open questions within a course, you will see a notification in the course card on your homepage.
+
+![img.png](./course_card_question.png)
+
+You will also see a notification in the top navigation bar of your course. Click on the notification to go to the page where you can see all the open questions.
+
+![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.
+
+![img.png](./questions_index_page.png)
+
+## How can I reply to a question from a student? <Badge type="tip" text="teacher" />
+
+![Question on code](./question-on-code.png)
+
+You can choose to type a reply to the question by clicking the input field. While typing, the question will be marked as in progress, to notify other teachers someone is already working on it.
+Finishing the reply will mark the question as answered and send the student a notification.
+
+You can also directly mark a question as answered. This is often useful if you know the student has already solved the question in another way. For example, if the student has submitted another solution where the problem is fixed, or if you have replied to the question outside of Dodona.
+
+> Note: comments support Markdown formatting, so you can use bold, italics, lists, ... You can check out all Markdown features in [this reference](/en/references/exercise-description/#markdown).
+
+## How can I comment on a students' submission? <Badge type="tip" text="teacher" />
+
+As a teacher, you can also comment on the code of your students. This can be useful to give feedback on their solution, or to point out a mistake.
+
+> If you want to go through the submissions of all your students and provide feedback, it can be useful to [create an evaluation](/en/guides/teachers/grading).
+
+You can either use the `Add global comment` button to add a general comment about the submission, or you can select a piece of code and click the `Add comment` button to add a comment about that specific piece of code.
+
+![add comment](./add-comment.png)
+
+> Note: comments support Markdown formatting, so you can use bold, italics, lists, ... You can check out all Markdown features in [this reference](/en/references/exercise-description/#markdown).
+
+
+## How can I save and reuse comments? <Badge type="tip" text="teacher" />
+
+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.
+
+![Save comment while writing](./save-comment-edit.png)
+
+You can also save an existing comment by clicking `save comment` in the comment menu.
+
+![Save existing comment](save-comment.png)
+
+Once you have saved one or more comments, you get a search field when writing new comments. Select the desired comment from the list to reuse it. You can still edit the comment before posting it.
+
+![Reuse comment](./reuse-annotations.png)
+
+## Why can't I find my saved comments? <Badge type="tip" text="teacher" />
+
+Saved comments are scoped by course and by exercise. This way we are sure we only suggest relevant comments and the number of saved comments remains manageable.
+
+Unfortunately, this means that you can't reuse comments from one exercise in another exercise. This will probably be changed in the future to give teachers more flexibility.
+
+You can find an overview of all your saved comments for a certain exercise by clicking the link underneath the search field.
+
+![Link to saved comments](./link-to-saved-comments.png)
+![Saved comments](./saved-comments-list.png)

en/faq/index.md

@@ -31,3 +31,17 @@ In this FAQ section you will find answers to the most frequently asked questions
 - [How can I use the PyCharm plugin?](./ide-plugins/#how-can-i-use-the-pycharm-plugin)
 - [How do I install the VS Code extension?](./ide-plugins/#how-do-i-install-the-vs-code-extension)
 - [How can I use the VS Code extension?](./ide-plugins/#how-can-i-use-the-vs-code-extension)
+
+## Questions and comments
+- [How can I ask a question about my code?](./annotations/#how-can-i-ask-a-question-about-my-code)
+- [How do I know if my question has been answered?](./annotations/#how-do-i-know-if-my-question-has-been-answered)
+- [How can I enable/disable student questions?](./annotations/#how-can-i-enable-disable-student-questions)
+- [How do I know if there are any open questions?](./annotations/#how-do-i-know-if-there-are-any-open-questions)
+- [How can I reply to a question from a student?](./annotations/#how-can-i-reply-to-a-question-from-a-student)
+- [How can I comment on a students' submission?](./annotations/#how-can-i-comment-on-a-students-submission)
+- [How can I save and reuse comments?](./annotations/#how-can-i-save-and-reuse-comments)
+- [Why can't I find my saved comments?](./annotations/#why-cant-i-find-my-saved-comments)
+
+## Activities
+- [What is a draft activity?](./activities/#what-is-a-draft-activity)
+- [What is the effect of a draft activity?](./activities/#what-is-the-effect-of-a-draft-activity)

en/guides/teachers/grading/index.md

@@ -102,7 +102,7 @@ In de rechterbovenhoek van het puntenoverzicht is een downloadknop zichtbaar. Al
 
 Op de evaluatiepagina krijg je steeds de laatst ingediende oplossing voor de deadline van een student voor een bepaalde oefening te zien.
 
-Aan de linkerkant zie je de status van de testen en de ingediende code. Op de code kan feedback worden toegevoegd aan een bepaalde regel door op het regelnummer te klikken. Voor algemene feedback klik je op "Globale opmerking toevoegen".
+Aan de linkerkant zie je de status van de testen en de ingediende code. Op de code kan feedback worden toegevoegd aan een bepaalde regel door op het regelnummer te klikken. Voor algemene feedback klik je op "Globale opmerking toevoegen". Meer info over het toevoegen en hergebruiken van opmerkingen vind je in [deze faq](/en/faq/annotations#how-can-i-comment-on-a-students-submission).
 
 **Merk op**: de feedback die je hier geeft is niet automatisch zichtbaar voor de studenten. Feedback binnen een evaluatie moet je steeds vrijgeven via de knop "Feedback vrijgeven" op het evaluatieoverzicht.
 

nl/faq/annotations/index.md

@@ -0,0 +1,110 @@
+---
+title: Vragen en opmerkingen
+---
+
+# Vragen en opmerkingen
+
+[[toc]]
+
+## Hoe kan ik vragen stellen over mijn code? <Badge type="tip" text="student" />
+
+::: tip Opmerking
+Deze functionaliteit is enkel beschikbaar als je lesgever dit heeft ingeschakeld.
+:::
+
+![image](./student.ask_questions.png)
+Nadat je je oplossing hebt ingediend, kan je op drie manieren een vraag stellen. Bovenaan de ingediende code kan je een algemene vraag stellen door op `Stel een vraag over je code` te klikken. Daarnaast kan je links van het regelnummer op de roze cirkel klikken een vraag stellen bij een specifieke regel code. Je kan ook een stuk code selecteren en dan hierover vragen stellen via diezelfde knop.
+
+![image](./student.ask_question.gif)
+
+Typ in het tekstvak de vraag die je aan de lesgever wil stellen. Je kan Markdown gebruiken om je tekst extra opmaak te geven. Klik als laatste op `Vraag stellen`.
+
+::: tip Ondersteuning voor Markdown
+
+Je kan met Markdown extra opmaak toevoegen door:
+
+- asterisken (\*) rond woorden te zetten om het schuin weer te geven. \*schuine tekst\* wordt bijvoorbeeld weergegeven als *schuine tekst*.
+- twee asterisken (\**) rond woorden te zetten om het in het vet weer te geven. \*\*vette tekst\*\* wordt bijvoorbeeld weergegeven als **vette tekst**.
+- backticks (\`) rond een stukje code te zetten. \`Variabelen\` wordt bijvoorbeeld weergegeven als `Variabelen`.
+
+Bekijk hier [alle mogelijkheden van Markdown](/nl/references/exercise-description/#markdown).
+:::
+
+![img.png](./student.react.png)
+
+Daarnaast kan je ook reageren op een bestaande vraag van jezelf of op een opmerking van een lesgever. Klik hiervoor op `Reageer` onder de vraag of opmerking. Typ je reactie in het tekstvak en klik op `Reageer`.
+
+
+## Hoe weet ik of mijn vraag beantwoord is? <Badge type="tip" text="student" />
+
+Wanneer een lesgever je vraag beantwoordt, krijg je een melding in Dodona. Deze melding zal je doorverwijzen naar de pagina waar je de vraag stelde.
+
+![image](./comment_on_code.png)
+
+## Hoe kan ik vragen voor studenten inschakelen/uitschakelen? <Badge type="tip" text="lesgever" />
+
+Gebruik het potloodje in de bovenste navigatiebalk van je cursus om naar de pagina `bewerken` te gaan. Hier kan je vragen voor studenten inschakelen of uitschakelen door het vakje `Sta toe dat studenten vragen stellen` aan of uit te vinken.
+
+![img.png](./ask_questions_toggle.png)
+
+Vergeet niet om je wijzigingen op te slaan door op het roze vinkje bovenaan rechts op de pagina te klikken.
+
+## Hoe weet ik of er open vragen zijn? <Badge type="tip" text="lesgever" />
+
+Als er open vragen zijn binnen een cursus, zal je een melding zien in de cursuskaart op je startpagina.
+
+![img.png](./course_card_question.png)
+
+Je zal ook een melding zien in de bovenste navigatiebalk van je cursus. Klik op de melding om naar de pagina te gaan waar je alle open vragen kan zien.
+
+![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.
+
+![img.png](./questions_index_page.png)
+
+## Hoe kan ik een vraag beantwoorden? <Badge type="tip" text="lesgever" />
+
+![Question on code](./question-on-code.png)
+
+Je kan een antwoord typen op de vraag door op het invoerveld te klikken. Terwijl je typt, zal de vraag gemarkeerd worden als in behandeling, om andere lesgevers te verwittigen dat iemand er al mee bezig is.
+Wanneer je jouw antwoord afwerkt, zal de vraag gemarkeerd worden als beantwoord en krijgt de student een melding.
+
+Je kan ook direct een vraag markeren als beantwoord. Dit is vaak handig als je weet dat de student de vraag al opgelost heeft op een andere manier. Bijvoorbeeld als de student een andere oplossing ingediend heeft waar het probleem opgelost is, of als je de vraag beantwoord hebt buiten Dodona.
+
+## Hoe kan ik opmerkingen geven op een oplossing van een student? <Badge type="tip" text="lesgever" />
+
+Als lesgever kan je ook opmerkingen geven op de code van je studenten. Dit kan handig zijn om feedback te geven op hun oplossing, of om een fout aan te duiden.
+
+> Als je alle oplossingen van je studenten wil overlopen en feedback wil geven, kan het handig zijn om [een evaluatie aan te maken](/nl/guides/teachers/grading).
+
+Je kan een algemene opmerking toevoegen door op de knop `Globale opmerking toevoegen` te klikken. Je kan ook een stuk code selecteren en op de knop `Voeg opmerking toe` klikken om een opmerking toe te voegen over dat specifieke stuk code.
+
+![add comment](./add-comment.png)
+> Terzijde: opmerkingen ondersteunen Markdown, dus je kan gebruik maken van vet, cursief, lijsten, ... Je kan alle Markdown features bekijken in [deze referentie](/nl/references/exercise-description/#markdown).
+
+## Hoe kan ik opmerkingen opslaan en hergebruiken? <Badge type="tip" text="lesgever" />
+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.
+
+![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.
+
+![Save existing comment](save-comment-edit.png)
+
+Eenmaal je een of meerdere opmerkingen hebt opgeslagen, krijg je een zoekveld te zien wanneer je een nieuwe opmerking schrijft. Selecteer de gewenste opmerking uit de lijst om deze te hergebruiken. Je kan de opmerking nog steeds bewerken voor je deze post.
+
+![Reuse comment](./reuse-annotations.png)
+
+## Waarom vind ik mijn opgeslagen opmerkingen niet terug? <Badge type="tip" text="lesgever" />
+
+Opgeslagen opmerkingen worden gegroepeerd per oefening, cursus en gebruiker. Dit betekent dat je een opmerking kan opslaan voor een oefening, en deze opmerking kan hergebruiken in alle oplossingen van die oefening. 
+
+Als je een opmerking wil hergebruiken in een andere oefening, zal je deze opnieuw moeten opslaan. We onderzoeken momenteel hoe we dit kunnen verbeteren.
+
+Je kan een overzicht van al je opgeslagen opmerkingen voor een bepaalde oefening vinden door op de link onder het zoekveld te klikken.
+
+![Link to saved comments](./link-to-saved-comments.png)
+![Saved comments](./saved-comments-list.png)

nl/faq/index.md

@@ -30,3 +30,17 @@ In deze FAQ-sectie vind je antwoorden op de meest gestelde vragen over het gebru
 - [Ik heb een cursus gemaakt, hoe kan ik deze laten uitlichten?](./featured-courses/#ik-heb-een-cursus-gemaakt-hoe-kan-ik-deze-laten-uitlichten)
 - [Hoe kan ik een uitgelichte cursus gebruiken?](./featured-courses/#hoe-kan-ik-een-uitgelichte-cursus-gebruiken)
 - [Welke uitgelichte cursussen zijn er beschikbaar?](./featured-courses/#welke-uitgelichte-cursussen-zijn-er-beschikbaar)
+
+## Vragen en opmerkingen
+- [Hoe kan ik een vraag stellen over mijn code?](./annotations/#hoe-kan-ik-een-vraag-stellen-over-mijn-code)
+- [Hoe weet ik of mijn vraag beantwoord is?](./annotations/#hoe-weet-ik-of-mijn-vraag-beantwoord-is)
+- [Hoe kan ik vragen voor studenten inschakelen/uitschakelen?](./annotations/#hoe-kan-ik-vragen-voor-studenten-inschakelen-uitschakelen)
+- [Hoe weet ik of er open vragen zijn?](./annotations/#hoe-weet-ik-of-er-open-vragen-zijn)
+- [Hoe kan ik een vraag beantwoorden?](./annotations/#hoe-kan-ik-een-vraag-beantwoorden)
+- [Hoe kan ik opmerkingen geven op een oplossing van een student?](./annotations/#hoe-kan-ik-opmerkingen-geven-op-een-oplossing-van-een-student)
+- [Hoe kan ik opmerkingen opslaan en hergebruiken?](./annotations/#hoe-kan-ik-opmerkingen-opslaan-en-hergebruiken)
+- [Waarom vind ik mijn opgeslagen opmerkingen niet terug?](./annotations/#waarom-vind-ik-mijn-opgeslagen-opmerkingen-niet-terug)
+
+## Activiteiten
+- [Wat is een conceptactiviteit?](./activities/#wat-is-een-conceptactiviteit)
+- [Wat is het doel van conceptactiviteiten?](./activities/#wat-is-het-doel-van-concept-activiteiten)

nl/guides/teachers/grading/index.md

@@ -98,7 +98,7 @@ In de rechterbovenhoek van het puntenoverzicht is een downloadknop zichtbaar. Al
 
 Op de evaluatiepagina krijg je steeds de laatst ingediende oplossing voor de deadline van een student voor een bepaalde oefening te zien.
 
-Aan de linkerkant zie je de status van de testen en de ingediende code. Op de code kan feedback worden toegevoegd aan een bepaalde regel door op het regelnummer te klikken. Voor algemene feedback klik je op "Globale opmerking toevoegen".
+Aan de linkerkant zie je de status van de testen en de ingediende code. Op de code kan feedback worden toegevoegd aan een bepaalde regel door op het regelnummer te klikken. Voor algemene feedback klik je op "Globale opmerking toevoegen". Meer info over het toevoegen en hergebruiken van opmerkingen vind je in [deze faq](/nl/faq/annotations#hoe-kan-ik-opmerkingen-geven-op-een-oplossing-van-een-student).
 
 **Merk op**: de feedback die je hier geeft is niet automatisch zichtbaar voor de studenten. Feedback binnen een evaluatie moet je steeds vrijgeven via de knop "Feedback vrijgeven" op het evaluatieoverzicht.