search

vocascan / vocascan-frontend

A highly configurable vocabulary trainer
https://vocascan.com
Apache License 2.0
30 stars 8 forks source link

Support for Ruby Characters #147

Open ditmarvisser opened 1 year ago

ditmarvisser commented 1 year ago

In asian scripts like Japanese or Chinese there is a concept of Ruby Characters, annotative characters which accompany complex characters. In Japanese these are known as Furigana, and in Chinese as Bopomofo.

Vocascan could benefit from displaying these characters in the right way. Modern browsers all support Ruby Characters, and if they don't there is a fallback available.

I have made the functionality already for the Vocab Cards. image

I do not have permission to make a branch right now. If I can be given that permission then I will share my code.

The Ruby Characters need to be entered in the database in a standard format. Use [] to enclose the base characters, and {} to encase the Ruby characters. image

This is then parsed to create the appropriate HTML tags. image

Tracer1337 commented 1 year ago

Dear ditmarvisser,

Thank you for bringing up the concept of Ruby Characters in Asian scripts and how it could benefit Vocascan. We appreciate your effort in developing the functionality for Vocab Cards.

To contribute your code, we recommend following the standard procedure of creating a Pull Request (PR) via forking the repository. By forking the repository, you can make changes to your own copy of the code and then propose those changes to be merged into the original repository.

Here's a step-by-step guide to submitting a Pull Request:

  1. Fork the repository to your own GitHub account.
  2. Clone the forked repository to your local machine.
  3. Create a new branch in your forked repository to work on the feature or enhancement.
  4. Implement your changes, including the functionality for displaying Ruby Characters.
  5. Commit and push your changes to the branch in your forked repository.
  6. Visit the original repository and navigate to the "Pull Requests" tab.
  7. Click on "New pull request" and select your forked repository and branch.
  8. Provide a clear and descriptive title and description for your pull request, outlining the changes you've made.
  9. Submit the pull request.

Once your Pull Request is submitted, the repository maintainers will review your changes and provide feedback or merge them into the main repository if they are deemed appropriate.

We look forward to reviewing your code contribution and appreciate your interest in improving Vocascan.

Best regards, Merlin

ditmarvisser commented 1 year ago

The PR is available with a couple questions: #148