Skip to content

Latest commit

 

History

History
69 lines (42 loc) · 4.18 KB

TRANSLATIONS.md

File metadata and controls

69 lines (42 loc) · 4.18 KB
Raw

Translation guide

This guide will walk you through the process of creating translations for InfiniteChess.org. It is assumed you have already gone through the Setup process.

Navigation

Anything that matters to you as a translator is located in the translation directory. Translation files are stored in TOML format (you can read more about its syntax here). Generally, it is a very aproachable format, and you only need to understand the absolute basics of it, which are explained below.

Translation files

Name

Each file is named after its language BCP 47 language tag. BCP 47 tags are composed of this format (notice the capitalization):

lng-(script)-REGION-(extensions)

For example, en-US for American English, sv for Swedish, zh-Hant-HK for Chinese spoken in Hong Kong written in traditional script.

You should name your file this way and only this way, otherwise it won't be correctly detected.

Content

Translation files in TOML format consist of keys, values, table headers and comments, like this:

[table-header]
# Comment
key1 = "value1"
key2 = "value2"

Important

You should only change values. Please, leave everything else, including comments, unmodified when translating!.

Translation process

In case you are translating a language that is currently not present in the project, you can start the process by copying en-US.toml and renaming it as described above. If you are updating an existing language, the only thing you need to do is to update the version variable at the top of your TOML document to the value of the version variable in en-US.toml, indicating that the translation is up to date.

Important

You should always use en-US.toml as a reference. It is the only file that is up to date and comes straight from the developers. Do not use any other files!

Then you can start a test server with npx nodemon and start translating. If you insert the address https://localhost:3443 into your browser, the website should be there and it should automatically update as you make your changes (after reloading the page). Make sure that you have selected the language that you are editing in the website's UI. There is a footer with a language selection dropdown at the bottom of almost every page.

In case you are updating an existing language and you aren't sure what has changed since the last update, you can view changes of en-US.toml in the official changelog or in the file commit history. In general, a translation is only considered up to date if the version variable on top matches the version value of the English TOML file.

Important

If there is an HTML tag in the value you want to translate, do not modify it!

Example of an HTML tag:

<a href="https://www.google.com"> Hello World </a>

In this example you should only change the words Hello World.

Translating News Articles

In addition to the TOML translation files, you also should translate news articles located in the translation/news/ directory. Here are the steps to translate those:

  1. Make a copy of the translation/news/en-US folder: Rename it to your language's BCP 47 tag.

  2. Translate the content: For each .md file within (e.g. 2024-09-11.md), translate it from english into your language. Each news article supports markdown, please don't modify hyperlinks, bullet points, headers indicated by #, or html tags (e.g. <iframe>...</iframe>).

  3. Commit your changes: Once the translations are complete, commit the changes as you would with TOML files.

When you are finished, you should open a pull request as described in SETUP.md.

Conclusion

Thank you for your contribution! In case of any trouble or questions, you can join the discord.