The MARS project can be extended to provide support for many languages.
The steps to configure MARS for a new language are given below:
The obvious prerequisite is having the translations of the metrics in desired language in the translations repository. They should be oraganized in the structure followed by other translated languages.
Please follow the naming convention given below:
| File | Naming Convention |
|---|---|
| YAML file | <language-dir-name>_working-groups-config.yml |
| Cover file | <language-dir-name>_cover.tex |
The MARS project automatically detects the language directories present in the translations repository.
Make sure the language directory names are the same as in the translations repository.
Refer to this README for more info.
Step 2: Add new language dictionary to word-translations.yml
Create a new language dictionary in the format <language-dir-name> in word-translations.yml
Copy the keys defined in the English dictionary and add them to the newly created dictionary.
Replace the values Focus Area, Goal, Metric and Question and Contents with appropriate translations. These variables are used to dynamically generate focus area tables.
Note:- By default, MARS provides support for the languages using English, Chinese, Japanese and Korean characters. Follow this step only if the writing characters are different than these languages. Make sure to use the Python virtual environment method to run MARS in this case.
The MARS project uses LaTeX format as the intermediate between markdown and PDF.
It is necessary to include the correct LaTeX language package to make sure the characters are displayed correctly in the PDF.
Add the required LaTeX package to the header_1.tex file. Optionally, you can specify a new header file and edit the convert_tex2pdf function in helper.py accordingly.
You are now ready to run MARS in the desired language!