Allow LaTeX previewing for multiple prompts - #1022
Conversation
|
Thanks for the pull request, @bdero! It looks like you're a member of a company that does contract work for edX. If you're doing this work as part of a paid contract with edX, you should talk to edX about who will review this pull request. If this work is not part of a paid contract with edX, then you should ensure that there is an OSPR issue to track this work in JIRA, so that we don't lose track of your pull request. |
|
Thanks for the pull request, @bdero! I've created OSPR-1816 to keep track of it in JIRA. JIRA is a place for product owners to prioritize feature reviews by the engineering development teams. Feel free to add as much of the following information to the ticket:
All technical communication about the code itself will still be done via the GitHub pull request interface. As a reminder, our process documentation is here. If you like, you can add yourself to the AUTHORS file for this repo, though that isn't required. Please see the CONTRIBUTING file for more information. |
To include these changes: - openedx/edx-ora2#1016 - openedx/edx-ora2#1017 - openedx/edx-ora2#1022
There was a problem hiding this comment.
👍
- I tested this: Preview buttons are shown for each of the prompts and they render LaTeX previews as expected
- I read through the code
- I checked for accessibility issues to the best of my knowledge; I'm not 100% sure latex preview is accessible to accessible technology, but if not it's a limitation of the MathJax renderer anyway.
- Includes documentation - user-facing interface have changed, so we probably should mention it. However, edx-ora2 does not have docs in the repository, so it is outside of the scope of this PR.
|
Hi @edx/doc, this PR along with #1017 makes a small modification to the interface for edx-ora2: When LaTeX is enabled, there are preview buttons available for all fields accepting LaTeX (not just the submission field). Should I make a docs ticket for this change? I was able to find some documentation for ora2, but I couldn't seem to find any documentation referencing the interface, so I'm not sure if there is a doc at the moment. |
|
Hi @bdero — It looks like this PR will require a doc update, so it would be great if you could create a doc PR. Thanks! We have the following end user documentation for ORA: Open Response Assessments (for edx.org course authors) Open Response Assessments (for Open edX course authors) Completing Essay Assignments (for edx.org learners) Completing Essay Assignments (for Open edX learners) |
efischer19
left a comment
There was a problem hiding this comment.
This looks great, thanks for the fix!
|
@bdero and @e-kolpakov : I just noticed the checklist above, and documentation is very much inside the scope of this PR—it's actually necessary. I was under the impression that you were going to create a DOC ticket, no? FYI, all of our course author and learner documentation is in the edx-documentation repo. You're welcome to submit a PR there. |
|
@srpearce Apologies for the delay. I took a look and I was only able to find one mention of LaTeX in all the ORA2 documentation, which was for configuring the flag: https://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/exercises_tools/open_response_assessments/CreateORAAssignment.html#specify-the-response-type It looks like as far as the end user experience is concerned, there is no documentation relating to the LaTeX previewing feature. I'm not sure it needs a whole section to explain it, but I'm thinking of adding a "Note" here in the learner documentation that basically says: "Some essay response problems accept LaTeX entry. In these cases, there will be a "Preview in LaTeX" button that can be used to generate a preview of the response before submission". Do you think this would be the right change for me to make? |
|
@bdero That change to the learner docs sounds fine. I think it would fit best in the note under step 2 in the section you've mentioned. |
|
@srpearce Alrighty, here's the doc ticket which links to the PR! |
Development for openfun: This is a follow-up PR to #1017 and #1016. While implementing #1017, I missed implementing preview buttons for each prompt in the case where there is more than one prompt.
Please refer to the testing instructions in #1017!
Screenshots:
Before:

After:
