feedback tool: Underline should not remain during & after user edit
If a tutor highlights (underline) a mistake, then the user edits their message, changing the word, the underline remains in the edit field + in the edited message.
Expected behaviour
- Underline should disappear entirely on edit
- Make sure the annotation/highlight/underline, and then edit, are properly stored for logging.
Activité
changed milestone to %0.2: Essential functions ready & corrective feedback
added To do label
assigned to @bridubois
Same issue than #102 (closed), should be fixed by 4fdefd7e.
When I edit a message in which @VictoriaDemierbe has added a comment or underline, the underlines are removed as soon as I click on 'edit', which is undesirable. For instance, Victoria added a comment to one word and an underline to a different word in the same message; both disappear as soon as I press 'edit'. (This also means that if I press 'cancel', the comments/underlines are lost.) Comments should certainly be preserved, but we also think it would be beneficial for the underline to remain to show the text that has been edited. (Victoria mentioned it would be helpful for her to be able to see what change has been made.)
Two thoughts:
- perhaps the edited text could have a different colour underline? So the red underline would go away, but the corrected text would be underlined in, e.g., yellow.
- the edit history of a message is saved backend; could it be brought frontend? Maybe with a collapsible menu? At least for the tutor, who could then expand the message to see what the student has changed.
As for duplication of text, on the one hand, it was generally not a problem because the underlines were removed as soon as the edit message box was opened. On the other hand, we did experience one instance of duplication.
The original message said "Oui, j'y pense – on travail d'habitude seulement, mais quand on doit faire quelque chose ensemble, il passe bien parfois." Victoria underlined (in red) 'travail' and 'il'. I edited the message and changed 'travail' to 'travaille' and 'il' to 'elle?'. This was the result when I saved:
(The 'highlight' on the second 'passe bien parfois' is not selected text.) Victoria could not see the duplication. She added a comment to the word 'elle?', which resulted in that 'highlighted' text shifting location:
Modifié par Tyler Dickinson-
The history of a message is already available when clicking on edited:
We could imagine to colorize edited text, but then, how should we manage when someone underline it again? And if a message is edited multiple time?
We could also show the underlines in the edited modal.
But I think those are actually separate issues and improvements, so they should have their own gitlab issue to prevent losing track.
Additionally, we note that it would be beneficial to be able to edit, comment on, and underline comments. For example, in one instance, Victoria accidentally misspelled a word in a comment, but then she couldn't edit it to correct herself. Another example, I added a comment in French; if I had made a mistake, Victoria couldn't comment on it or indicate it with a red underline. (cf. #104 (closed) and #103 (closed) )
Modifié par Tyler Dickinson-
The original idea of a comment is to allow a teacher to comment a very specific thing in a student's message. Unlike "normal" messages, their is no keylogging, history and so on them, because they were not though to be used as threads, but only for very short comments. Maybe we should restrict the ability to comment/underline to the teacher to avoid "side usages"? However, allow the teacher to edit the comment can probability be done.
We could imagine to implement such threads, but in my opinion, it would be a different usage and displayed differently. (related to #103 (closed))
I'm closing this issue (this doesn't prevent answering of course), because we are getting far from the original issue and those interesting aspects should be discussed in another one.
Modifié par Brieuc Dubois Indeed, I think this could be merged with #105 (closed) . What you describe, @bridubois, as the original idea (i.e. comments being an aside, with no keylogging or history, etc.) would, I think, further support the idea of a sidebar kind of commenting/feedback system akin to Word or Google Docs, as @sbibauw suggested. That would remove the 'meta' elements from the main thread; otherwise there would be feedback sent as 'regular' messages (with keylogging, history, etc.), which may not be what's necessary or intended for the study.
