Skip to content

Commit

Permalink
Merge pull request #441 from dodona-edu/enhance/saved_annotations
Browse files Browse the repository at this point in the history
Update documentation to inform users about changing saved annotation scoping
  • Loading branch information
jorg-vr authored Nov 13, 2024
2 parents 5ba0a1e + be0458b commit b9fea6c
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 6 deletions.
Binary file added en/faq/annotations/edit_saved_comment.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 7 additions & 3 deletions en/faq/annotations/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,11 +105,15 @@ Once you have saved one or more comments, you get a search field when writing ne

## 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.
Saved comments are scoped by course and by exercise by default. 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.
If you want to reuse a comment across your whole course, or even across multiple courses, you can edit the saved comment and remove the course and/or exercise limitations. This way the comment will be suggested in all exercises of all your courses.
![edit_saved_comment.png](edit_saved_comment.png)

You can find an overview of all your saved comments for a certain exercise by clicking the link underneath the search field.
To edit a saved comment, click on the saved comment icon on an annotation wich reuses the comment. This will open the saved comment and clicking the pencil icon will allow you to edit the comment.
![saved_comment_link.png](saved_comment_link.png)

You can find an overview of all your saved comments for a certain exercise by clicking the link underneath the search field. Or by clicking on 'saved comments' in the sidebar menu.
From here you can also edit or delete saved comments.
![Link to saved comments](./link-to-saved-comments.png)
![Saved comments](./saved-comments-list.png)
Binary file added en/faq/annotations/saved_comment_link.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added nl/faq/annotations/edit_saved_comment.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 10 additions & 3 deletions nl/faq/annotations/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,11 +100,18 @@ Eenmaal je een of meerdere opmerkingen hebt opgeslagen, krijg je een zoekveld te

## 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.
Opgeslagen opmerkingen zijn standaard beperkt tot een cursus en een oefening. Op deze manier zorgen we ervoor dat we alleen relevante opmerkingen voorstellen en blijft het aantal opgeslagen opmerkingen beheersbaar.

Als je een opmerking wil hergebruiken in een andere oefening, zal je deze opnieuw moeten opslaan. We onderzoeken momenteel hoe we dit kunnen verbeteren.
Als je een opmerking in je hele cursus of zelfs in meerdere cursussen wilt hergebruiken, kun je de opgeslagen opmerking bewerken en de beperkingen op cursus en/of oefening verwijderen. Op deze manier wordt de opmerking voorgesteld in alle oefeningen van al je cursussen.

Je kan een overzicht van al je opgeslagen opmerkingen voor een bepaalde oefening vinden door op de link onder het zoekveld te klikken.
![edit_saved_comment.png](edit_saved_comment.png)

Om een opgeslagen opmerking te bewerken, klik je op het icoon van de opgeslagen opmerking in een annotatie die de opmerking hergebruikt. Dit opent de opgeslagen opmerking en door op het potloodicoon te klikken kun je de opmerking bewerken.

![saved_comment_link.png](saved_comment_link.png)

Je kunt een overzicht van al je opgeslagen opmerkingen voor een bepaalde oefening vinden door op de link onder het zoekveld te klikken. Of door op 'opgeslagen opmerkingen' in het zijbalkmenu te klikken.
Vanaf hier kun je ook opgeslagen opmerkingen bewerken of verwijderen.

![Link to saved comments](./link-to-saved-comments.png)
![Saved comments](./saved-comments-list.png)
Binary file added nl/faq/annotations/saved_comment_link.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b9fea6c

Please sign in to comment.