Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: show math in plain text in library cards #36055

Open
wants to merge 12 commits into
base: master
Choose a base branch
from

Conversation

navinkarkera
Copy link
Contributor

@navinkarkera navinkarkera commented Dec 20, 2024

Description

Converts mathjax equations to unicode to be rendered as plain text in library card previews.

Useful information to include:

  • Which edX user roles will this change impact? Common user roles are "Learner", "Course Author".

Screenshot:

image

Supporting information

Testing instructions

  • Create some text or problem components with mathjax equations in the body. Make sure to add the equation within first few characters to see the preview in library card.
  • Verify that the card shows a plain text preview using unicode.
  • Examples of mathjax equations can be found in tests.

Notes

  • unicodeit supports many latex tags but some of them are missing like \frac, \mathbf, \bf etc. which I have handled using replacements.
  • Some tags like \begin{bmatrix}, \begin{cases} etc. cannot be displayed properly in plain text so they are rendered raw.
  • If you come up with some equations which are not rendered properly please let me know.

@openedx-webhooks
Copy link

openedx-webhooks commented Dec 20, 2024

Thanks for the pull request, @navinkarkera!

What's next?

Please work through the following steps to get your changes ready for engineering review:

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/wg-maintenance-edx-platform. Tag them in a comment and let them know that your changes are ready for review.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

Copy link
Contributor

@pomegranited pomegranited left a comment

Choose a reason for hiding this comment

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

Thank you for this change @navinkarkera ! It's quite clean, considering all the things that it does!

I found one bug, and left a couple other suggestions which you can choose to ignore :)

@navinkarkera navinkarkera force-pushed the navin/plain_text_math branch from 71550be to a335a9d Compare January 2, 2025 10:58
Copy link
Contributor

@DanielVZ96 DanielVZ96 left a comment

Choose a reason for hiding this comment

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

👍 This looks great and very thorough.

  • I tested this: did the testing instructions with different mathjax code
  • I read through the code
  • I checked for accessibility issues

Copy link
Contributor

@pomegranited pomegranited left a comment

Choose a reason for hiding this comment

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

👍

  • I tested this using sample mathjax code in the platform 1, 2, 3. 4.
  • I read through the code
  • I checked for accessibility issues by using my keyboard to navigate
  • Includes documentation
  • User-facing strings are extracted for translation N/A

@navinkarkera navinkarkera marked this pull request as ready for review January 3, 2025 05:15
Copy link
Contributor

@bradenmacdonald bradenmacdonald left a comment

Choose a reason for hiding this comment

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

Nice work! Just some minor concerns around \mathbf but everything else is good to go.

openedx/core/djangoapps/content/search/plain_text_math.py Outdated Show resolved Hide resolved
openedx/core/djangoapps/content/search/plain_text_math.py Outdated Show resolved Hide resolved
openedx/core/djangoapps/content/search/plain_text_math.py Outdated Show resolved Hide resolved
openedx/core/djangoapps/content/search/plain_text_math.py Outdated Show resolved Hide resolved
@navinkarkera navinkarkera force-pushed the navin/plain_text_math branch 2 times, most recently from 48ad916 to 019609c Compare January 9, 2025 05:51
@navinkarkera navinkarkera force-pushed the navin/plain_text_math branch from de9bc3e to 2def856 Compare January 10, 2025 05:12
@navinkarkera
Copy link
Contributor Author

The CI is failing due to some issue with docker login.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Status: Waiting on Author
Development

Successfully merging this pull request may close these issues.

6 participants