Help us translate the Field Guide

[waynegraham]

Help up translate the Field Guide

The Re:Mind field guide was designed using a theme with l10n support. We endeavored to provide accurate translations, but recognize that sometimes these efforts can be slightly off.

This issue is here to organize the translation effort, as well as provide guidance for updating the existing translations.

Translation process

• Get familiar with the Re:Mind Field Guide i10n support
• Ensure default translations exist for your language
• Add a ticket to ask for your locale to be added on the project
• Translate the project.

Default translations

This site has some default translations for labels like "next" / "previous" pagination buttons...

Please help us provide/complete/double-check these labels for your own language: https://github.com/clirdlf/remind_guide/tree/main/_data

Existing language

If your language already exists in the folder above (or the page), please edit the files with completed or more accurate translations.

New language

If your language does not exist, you will need to create it from scratch. The easiest way to do this is copy _data/en and rename it as a new language and update the keys in the yaml files. You will also need to create new pages for the language with the pattern

{pagename}.{locale}.md

For instance, adding a Spanish translation would create a new page introduction.es.md that would contain the Spanish translation of the content, and the keys used by the theme would be added in data/es/l10n.yml and _data\es\strings.yml.

In most cases, use the simple language code like fr or es for the language variant. Use locales such as pt-BR and pt-PT when the differences between the two variants is strong enough.

Preview your translation work

You can test your work by running the site locally as a jekyll site.

Submit a pull request

Once you are happy with the results, you can create a pull request for review. Once the request has been reviewed, it will be merged in to the project.