Skip to content

Allow LaTeX previewing for multiple prompts - #1022

Merged
efischer19 merged 1 commit into
openedx:masterfrom
open-craft:bdero/latex-preview-multiple-submission
Jul 13, 2017
Merged

Allow LaTeX previewing for multiple prompts#1022
efischer19 merged 1 commit into
openedx:masterfrom
open-craft:bdero/latex-preview-multiple-submission

Conversation

@bdero

@bdero bdero commented Jul 7, 2017

Copy link
Copy Markdown
Contributor

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:
before screenshot

After:
after screenshot

@bdero
bdero requested a review from e-kolpakov July 7, 2017 18:19
@openedx-webhooks

Copy link
Copy Markdown

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.

Create an OSPR issue for this pull request.

@openedx-webhooks

Copy link
Copy Markdown

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:

  • supporting documentation
  • edx-code email threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

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.

@openedx-webhooks openedx-webhooks added needs triage open-source-contribution PR author is not from Axim or 2U labels Jul 7, 2017
@bdero
bdero requested a review from smarnach July 7, 2017 22:50
bdero added a commit to open-craft/openedx-platform that referenced this pull request Jul 7, 2017

@e-kolpakov e-kolpakov left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

  • 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.

@bdero

bdero commented Jul 10, 2017

Copy link
Copy Markdown
Contributor Author

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.

@srpearce

Copy link
Copy Markdown
Contributor

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 efischer19 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great, thanks for the fix!

@efischer19
efischer19 merged commit e57f58f into openedx:master Jul 13, 2017
@srpearce

Copy link
Copy Markdown
Contributor

@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.

@bdero

bdero commented Jul 13, 2017

Copy link
Copy Markdown
Contributor Author

@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
bdero deleted the bdero/latex-preview-multiple-submission branch July 13, 2017 22:03
@srpearce

Copy link
Copy Markdown
Contributor

@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.

@bdero

bdero commented Jul 15, 2017

Copy link
Copy Markdown
Contributor Author

@srpearce Alrighty, here's the doc ticket which links to the PR!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

engineering review open-source-contribution PR author is not from Axim or 2U

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants