Annotation Tool UI Fixes and Move to Xmodule/js #3529
Conversation
|
@srpearce DOC-95 in backlog |
Changes for LMS-2591, Instructor Dash switchover
…-in-csv Changing Student Anon ID Dump to return Course Specific IDs.
…x-platform into lduarte-harvardx3
There was a problem hiding this comment.
Please write docstring according to edx doc style: https://github.com/edx/edx-platform/wiki/Python-Guidelines
There was a problem hiding this comment.
No new line at the end of file. Please add it.
|
Please look at failing tests. Also please provide python and js test coverage and ensure coverage >= 95%. How can I test it manually? What steps should I do? Is there any documentation on that so I can look at? Have you consider writing acceptance tests for this feature? Thank you. |
|
Please add changelog. |
|
@lduarte1991 , @sarina and I are going to start reviewing this PR this week—can you please rebase against master before we do that? Thanks! |
|
Absolutely will do it soon. |
|
@lduarte1991 since #3480 has been merged, please rebase this PR onto master. |
There was a problem hiding this comment.
why do we have css file inside js directory?
|
@sarina okay. |
|
Yes, sorry! Working on it right now. |
|
Good for me. |
|
@lduarte1991 yes, that would actually be a lot easier. |
|
Please ping me and @polesye in the new PR. |
8 participants
Background: A few comments in #2515 stated that I should move the javascript and css code from static and into the xmodule/js and xmodule/css folders. This would allow for the js and css to be called upon only if and when the module is created.
Goal of this PR: There should be no new functionality added, but this PR will make sure that the javascript and css for the annotation tool are only pulled in when the module is used. Moving these files caused a few UI issues which have also been patched within the code.
CMS Updates: You should now be able to create annotations within the CMS (this is not really used as of yet and the annotations cannot be viewed by students, only by instructors visiting Studio) which will not appear in LMS, but only when you visit the Studio end for the unit/module. The functionality should be there fully, leaving annotations, diacritic marks, highlighting, tagging. The CMS has its own table below the text that can be used as seen in the LMS.
LMS Updates: The biggest change visually is that the skin used for the TinyMCE editor is now the one used by Studio and not the one that was previously loaded onto the code. The rest should be the same as it was in a previous iteration.
Testing notes: Probably hardest PR to test. Visually everything should look the same as before (except the TinyMCE Editor) and it should have the same functionality. I'd suggest making a few annotations, editing them, deleting them, tagging them, adding diacritic marks, replying to one. Overall most of the "testing" should just be that the code is in the correct place.