TRANSLATE THIS
`) should be fine. Testing is VERY important, so do NOT skip it. If during testing, the page appears different from the original English page (besides the translated text, of course), you did something wrong and may have to start again. #### 3.1. Notes for Moneropedia Entries Moneropedia entries have two specificities: * The Front Matter: Moneropedia Fron should be translated for both *entry:* and *summary:* elements. However, *terms:* should be extanded with their translation, leaving the English words **untouched**. This is really important for compatibility purposes. With this, if a new guide is added to the site, an English term on the untranslated version of the guide in another language could be linked to the moneropedia article (of the same language). * The old *untranslated* snippet must be removed, therefore the next section is irrelevant here. Finally, your entry should go from: ``` --- entry: "Entry name in English" terms: ["English", "terms"] summary: "English summary." --- {% include untranslated.html %} ``` To: ``` --- entry: "Translated entry name" terms: ["English", "terms", "translated", "terms"] summary: "Translated summary." --- ``` ### 4. set the 'translated' snippet to true Somewhere on the page (usually the top) should be a snippet that says `{% include disclaimer.html translated="false" version=page.version %}`. Simply change this to `{% include disclaimer.html translated="true" version=page.version %}`. This will remove the orange bar from the bottom saying the page is untranslated. ## How to add a new language Adding a new language can be complicated. If you feel unsure about the steps necessary, contact the Website workgroup and somebody will add the new language for you. ### 1. \_config.yml file Navigate to the root folder of the whole website and find the file labeled `_config.yml`. Open it and find the line that says `languages:`. Add your two letter language code (Google it if you don't know it) in between the brackets after the others already present. You will need to put a comma after the previous last one. Example: ``` languages: ["en", "es", "NEW LANG HERE"] ``` Save and exit the file. ### 2. \_data folder Navigate to the `_data/lang` folder and copy the `en` folder. Paste it into the same folder and the copy renamed to the two letter language code of the language you will be translated to. **The 'en' folder itself should still be there. It should not be renamed. There should be a new folder in addition to the ones that were already there.** Translate the content of the files. Do not touch anything labeled `url`. ### 3. \_i18n folder Navigate to the \_i18n folder and duplicate the en.yml file. Rename the duplicate to the two letter language code of your language with a `.yml`. Now duplicate the `en` folder and rename it with the correct language code. **The original folder and yml file themselves should still be there. They should not be renamed. There should be a new folder and yml file in addition to the ones that were already there.** ### 4. Open an issue on the repo where the website is hosted After you've done all the above, you'll need to [open an issue on the repository](https://github.com/monero-project/monero-site/issues) asking to add the language you are working on to Weblate, where the core of the website is translated. ## Housekeeping ### GitHub Issues We ask that if you open an issue on the site that you remain available for clarifying questions or corrections. We do our best to close issues that are resolved when we make changes to the site, but If your issue is resolved by a contributor and the issue is not closed we ask that you close it in a timely manner. A contributor may ask you to close an issue after it's confirmed fixed. Please review the changes to the site and close your issue if you can verify that it's fixed. ## Updates on User Guides User guides and developer guides may need regular updates, either to fix typos, to add explanations regarding new features, to update screenshots, and so on. As those guides are translated in several languages, it could be hard to keep all languages version up to date with the English version. To keep track of those changes, the user guides (but not the developer guides) are versioned using a snippet at the top of each localized (\_i18n/en/resources/\*-guides) file: ``` {% assign version = '1.1.0' | split: '.' %} ``` This snippet is responsible for keeping track of the language version. The based version (English version) is however also tracked in the `Front Matter` from the /resources/user-guides/ or /resources/developer-guides/ directory file: ``` mainVersion: - "1" - "1" - "0" ``` - First number is the Major version number - Second number is the Minor version number - Third number is the build number. When you update a guide, you are responsible for updating this version tracking in every file involved in your update: - For an update on English files, you will update the version tracking number in the `Front Matter` of /resources/\*-guides/ and in \_i18n/en/resources/\*-guides - For an update on localized files, you will update the version tracking number in the \_i18n/{% t library.PLACEHOLDER-NAME %}
``` Where `LINK-TO-PUBLICATION` is the URL of the actual publication. If it's a resource external to Getmonero, simply add the URL (for example `https://masteringmonero.com/free-download.html`). If you uploaded the file in the `/library` folder as explained in step 1, use this structure: `{{ site.baseurl_root }}/library/NAME-FILE`. `PLACEHOLDER-NAME` needs to be a placeholder that will be added in the `_18n/en.yml` file, under the `library` category, as explained in the next step. ### 3. Add placeholder in en.yml After you found the `library` category, add your placeholder and value after the last entry of the list. For example: `mypublication: "This is the description of my publication"`. In this example `mypublication` is the placeholder and needs to be also added to the entry in `index.md`, the result will be `{% t library.mypublication %}
` and the value contained in the placeholder will be correctly displayed. Save the changes.