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

Add Japanese translations and implement I18N support #1920

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

yostos
Copy link

@yostos yostos commented Sep 26, 2024

This pull request adds Japanese translations for the documentation and implements I18N support for the project.

Intended changes:

  • Add Japanese translations for main documentation files
  • Implement an I18N framework to support multiple languages
  • Update mkdocs.yml to enable multi-language support

Motivation:
To make the project more accessible to Japanese-speaking users and to establish a framework for easy addition of other languages in the future.

There are no directly related issues, but this change aligns with the project's goal of international accessibility.

Example of changes:

  • New 'ja/' directory added with translated .md files
  • mkdocs.yml updated to include language selection options

Checklist

  • I have read the contributing doc.
  • I have included a link to the relevant issue number.
  • I have checked to ensure there aren't other open pull requests
    for the same issue.
  • I have written new tests for these changes, as needed.

- Add Japanese translations for documentation
- Implement I18N framework
- Update mkdocs.yml for multi-language support

This commit significantly enhances the project's internationalization.
@yostos yostos mentioned this pull request Sep 26, 2024
@wren
Copy link
Member

wren commented Oct 13, 2024

Hi, @yostos! Wow! This seems like it must have been a lot of work, so thank you!

A few notes:

  • Can you remove the auto-generated files (pretty much everything inside of the site/ folder)?
  • It seems like you might have an auto-formatter on. Can you please keep the PR focused on the relevant changes (example: there are a lot of unrelated changes inside of pyproject.toml file)

Does that make sense? And please let us know if you need help with any of these things.


```sh
┎──────────────────────────────────────────────────────────────────────╮2020-06-28 18:22
┃ これは最初のサンプルエントリーです ╘═══════════════╕

Choose a reason for hiding this comment

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

For whatever reason, each of these three example output displays appears to be about 5 characters short of the visual "box" alignment. (The Japanese does have fewer characters than the English, but that doesn't seem to account for the difference.)

Copy link
Author

@yostos yostos Oct 24, 2024

Choose a reason for hiding this comment

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

When running jrnl with Japanese text, the box formatting actually breaks in the program itself, as shown in the attachment. The documentation merely reflects this current behavior, so the fundamental solution would be to address the handling of multi-byte characters in jrnl's core functionality.

result-jrnl

Copy link

@ericthebell ericthebell left a comment

Choose a reason for hiding this comment

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

Translation review. I reviewed the docs/ja folder and did spot checks throughout a few files, with the PR and original code view side by side:

  • contributing.md
  • formats.md
  • installation.md
  • overview.md
  • tips-and-tricks.mf
  • usage.md

FWIW, the translation looks solid and natural to me.

Notes and caveats

  • My Japanese is fluent, but I'm not particularly familiar with any semantic conventions that might apply to technical documentation.
  • That said, the translation does a good job of maintaining the casual but clear tone of the English.
  • I left one comment where the visual formatting of a box style was misaligned, but I didn't otherwise notice any oddities with code formatting or over-translation (such as code text being translated where it shouldn't be).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants