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

create a multilingual translation project for Nim language documents #18821

Open
VectorWorkshopBaoErJie opened this issue Sep 8, 2021 · 11 comments
Labels
Documentation Content Related to documentation content (not generation). Feature

Comments

@VectorWorkshopBaoErJie
Copy link

Summary

It is recommended to create a multilingual translation project for NIM language documents.

Description

It is recommended to create a multilingual translation project for NIM language documents. Thus, I am willing to complete the Chinese translation of the document. For example, check out https://weblate.org/, where I've been involved in translating a lot of Godot documents. This has enabled Godot to maintain a good momentum of user growth in China.

@ringabout ringabout reopened this Sep 8, 2021
@ringabout ringabout added the Documentation Content Related to documentation content (not generation). label Sep 8, 2021
@VectorWorkshopBaoErJie
Copy link
Author

Given the need to translate into multiple languages, it may be necessary to create a separate library.

@ringabout
Copy link
Member

ringabout commented Sep 8, 2021

There are two parts of Nim docs:

IMO The second one can be translated first as a start. I would like a switch button to shift languages.

For instance, the Python documentation handles it well

image

@ringabout ringabout changed the title It is recommended to create a multilingual translation project for NIM language documents. create a multilingual translation project for Nim language documents Sep 8, 2021
@ghost
Copy link

ghost commented Sep 8, 2021

If this gets implemented, I can start contributing Russian translations. Also, some things like the tutorial were already translated to Russian by someone else in ~2015, so it's pretty easy to bring them up-to-date

@ringabout
Copy link
Member

Hi @qjyqjyqjyqjy

it may be necessary to create a separate library.

Feel free to create a separate library which can be moved into nim-lang org later (if needed).

@VectorWorkshopBaoErJie
Copy link
Author

https://github.com/nim-lang/website/tree/master/jekyll
This page doesn't seem to have a good workflow to keep updating the translation to add content.

@juancarlospaco
Copy link
Collaborator

Would be better to implement it in the docgen somehow, instead of special case it.

@FedericoCeratto
Copy link
Member

Related RFC: nim-lang/RFCs#96
Previous PR: #8842

@ringabout
Copy link
Member

ringabout commented Jan 17, 2023

@FedericoCeratto Hello, is it possible to set up a https://weblate.org/ without nimdoc changes? Since manuals and tutorials are written by rst files.

@juancarlospaco
Copy link
Collaborator

Weblate would be great, anyone can translate from browser.

@FedericoCeratto
Copy link
Member

@ringabout I proposed using weblate in nim-lang/RFCs#96.
Yet, the manual and the library documentation are generated by Nim. At some point nimdoc has to pull in the translation files from weblate to output the HTML doc.

As a side note, having translation support in nimdoc would also enable Nim developers to translate the documentation of their own projects.

@ringabout
Copy link
Member

ringabout commented Jan 19, 2023

Yeah, I'm in favor of using weblate. In a progressive view, I would like to have a weblate process first. I'm not familiar with its workflow. I would like to see a template so that I can set up a process for some Nim documentation (I tried but failed before).

Or we can maintain a forked nim doc extension to get the work done using the compilerapi, somehow. Now that we have std/importutils which make it easier to use internal procs and data structures. It seems feasible to me. Then we can set up the translation in a separate repo, pulling the Nim source from the main repo daily. @FedericoCeratto I can try to implement #8842 as a tool this weekend if I have some free time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Content Related to documentation content (not generation). Feature
Projects
None yet
Development

No branches or pull requests

4 participants