Arconix's Translations Guide
Client: Arconix
March 14th, 2022
Writing
Welcome to Arconix's translation guide. This document will run through the process of starting a translation, pulling and updating translations, and the fundamental system that goes into translating for the server. Don't hesitate to ask an administrator or the translations administrator any inquiries that this document may not offer. Following this process is vital to your role as a translator.
Choose A Language:
Since on the translation team, you must be semi-fluent with the language that you'd be translating. Choose a language or pick the language that was assigned to you.
Language List:
- Spanish
- Italian
- Romanian
- Mandarin
- Hindi
- Arabic
- French
- Portuguese
- Russian
Obtain The Correct Documents:
If a person is already working on that chosen language or there is already a translation but it needs to be updated, the correct translations must be chosen in order to be the most efficient.
New:
If your chosen language has not been translated yet, then simply obtain a copy of the "en_us.yml" file from here, and make a copy of it. Then change the name of the document to "language_region". Each side of the underscore should have two characters each.
Updating:
If there is already a language configuration and you need to update the file, simply go here and view the "en_us.yml" file. Also, open the name of your translated file. For example, if you're updating the Romanian language file, then it would be "ro_ro.yml". Compare the number of lines on the file or check if there's any English in that file. This would be how you'd update translations.
Obtaining From Others:
Check in with who is doing what translations. If someone is already doing the translation of your chosen language, then talk and communicate with them. Make sure that the work is split accordingly and that work doesn't overlap. If none of you have started, you may need to obtain the proper files from the GitHub repository by following the processes above.
Translating:
The translations to different languages would never actually have an exact replica translation for each word or phrase. So how would you translate?
- As close to the phrase as possible.
- Rewrite the message in your translation language but make it as close to the idea of what the message needs to be as possible.
- Apply any special characters and accents as necessary.
- Make sure to keep color codes where they may be. Use the color codes to highlight keywords, the translations may not be exact from English.
- Everything on the plugins is configurable. So, there will be a lot of language translations, however, everything should look uniform. There shouldn't be any mismatching styles.
Finalizing:
Translations will nearly never be finished as long as there is development still in progress. If you're finished, ping the translation administrator to upload your finished translations to the GitHub repository.
If more features are added, the translation would be quickly outdated. You would need to consistently check the GitHub repository for new commits and check and see if the language files have been updated.
If there are Git commits, follow this process once again for the updating section.
When submitting, double-check everything and make sure that everything is correctly translated and up to date. The number of lines on the translated file should match that of the "en_us.yml" file.