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

DOCS: WIP: Translate in-game documentation to Chinese #1502

Draft
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

loliconRoot
Copy link

Originally posted by @d0sboots in #1452 (comment)

If you want to tackle a project that is still huge, but IMO doable, I suggest translating the game's documentation. That doesn't have any of the same technical challenges, and would be helpful for people who know enough English to use the UI but struggle with longer/more complicated explanations. We link to the docs in-game, and if they were fully translated I think we could figure out a way to make that link locale-aware.

I'm trying to translate the in-game documentation into Chinese.
This is a WIP asking if this is possible.
If this work is meaningful, then I will continue to translate other in-game documents.

Copy link
Collaborator

@d0sboots d0sboots left a comment

Choose a reason for hiding this comment

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

Nice job! Not knowing Chinese, I can't speak to the accuracy of the translation of course, but in terms of formatting and what you chose to translate/leave untranslated everything looks good.

I would eliminate the locales directory and just drop this in doc/zh-CN. If you make enough progress that this is includable, I'll bump the current docs down to doc/en.

(有关多线程的更多信息,请参阅[脚本](../basic/scripts.md)页面)

我们写的这个[脚本](../basic/scripts.md)需要使用 2.6GB 的[内存](../basic/ram.md)。
你可以通过下面的 `终端 \ Terminal` 命令来查看:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
你可以通过下面的 `终端 \ Terminal` 命令来查看:
你可以通过下面的 `终端 / Terminal` 命令来查看:

Later on, you use forward-slash for showing translated + literal together, probably best to be consistent.

Copy link
Author

Choose a reason for hiding this comment

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

Yes, I was going to use / for translated content / original text. The underlying reason for this is that the UI is not translated, so translating the entire literal content could be confusing.
But the document was so long that it took me over a day to complete it and make sure that the translated descriptions fit the Chinese language as well as possible and that the formatting was consistent. At the same time, I was eager to present a draft to see if it was feasible.
The problem is probably the result of some typing error with Ctrl-C & Ctrl-V. I'll fix it.

4. 再次使用 `run` 命令运行我们的[脚本](../basic/scripts.md)。
5. 对每一个服务器重复 2-4 步。

这是我完成这些步骤时使用的 `终端 \ Terminal` 命令序列:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
这是我完成这些步骤时使用的 `终端 \ Terminal` 命令序列:
这是我完成这些步骤时使用的 `终端 / Terminal` 命令序列:


在我们写[脚本](../basic/scripts.md)前,要先熟悉以下这些内容:

- `黑客攻击`
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is an interesting point. For basically all the docs, code block text is used for stuff that appears literally, and thus it shouldn't be translated (since it won't be in-game). However, these two are general concepts as opposed to literal terms that appear in-game. It's potentially an argument that they shouldn't be formatted like this at all.

Copy link
Author

Choose a reason for hiding this comment

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

Yes, after some consideration, I don't think any functions, instructions, codes or other unique concepts etc. should be translated, and for the UI related text, since it's not translated elsewhere, I've kept the original content. But for the two generic concepts, they are translated elsewhere, so I think they should be translated as well.
As to whether it should be included in the code block, allow me to reserve my opinion, after all I don't have any good ideas.

@loliconRoot
Copy link
Author

Okay, I created the locales directory just to start the translation process, and I'm going to move these documents into doc/zh-CN.

@loliconRoot
Copy link
Author

Also, I have some questions, some of the content in the beginner's tutorial seems to be outdated, e.g.: some UI placement, randomized network generation, etc... Is there a plan to fix this?

d0sboots added a commit to d0sboots/bitburner-src that referenced this pull request Jul 20, 2024
PR bitburner-official#1502 is working on adding a Chinese translation to the docs. In
general, I encouraged this (in bitburner-official#1452) as a path towards getting useful
translated content in the game without requiring a massive
refactor/rearchitecting of everything.

To support this, this takes the first step of moving our docs into an
en/ subdirectory, so that other languages can live alongside. No effort
is made at this time to support or select between alternate languages;
this is a pure-rename refactor.
@d0sboots
Copy link
Collaborator

Also, I have some questions, some of the content in the beginner's tutorial seems to be outdated, e.g.: some UI placement, randomized network generation, etc... Is there a plan to fix this?

The docs get updated strictly as people notice issues and submit fixes. If you've noticed any issues, we'd welcome fixes! (Probably best as a separate PR, so it doesn't overlap/get held up on this one.) That said, I think the part about randomized network generation is still true... (unless I misunderstand what you meant.)

@loliconRoot
Copy link
Author

loliconRoot commented Jul 20, 2024

That said, I think the part about randomized network generation is still true... (unless I misunderstand what you meant.)

Sorry, I apologize for not checking the source code to determine if the problem exists before asking this question. I now realize that this was a misjudgment on my part, and that the network is in fact randomly generated, but lately I've been using my own scripts to connect to arbitrary servers, which has led me to misinterpret two similar, but not identical, network structures as being the same. (But some UI changes have been made).

Probably best as a separate PR, so it doesn't overlap/get held up on this one.

I'm busy translating the documentation right now, so I won't do anything with it even if I find a document that actually has an error until I'm done with the task at hand.

@Vargas-morningstar
Copy link

hello,I would like to knoew if there ara other languages you are working on?

@d0sboots
Copy link
Collaborator

hello,I would like to knoew if there ara other languages you are working on?

This PR is just about Chinese. AFAIK, no one else has taken on trying to translate the docs (it's a big project), but they're welcome to. It doesn't even have to be all of them at once, if we can find a good place to cut it partway.

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