2.8 KiB
Translations
Currently Consul is translated totally or partially to multiple languages, check it's Crowdin project
Please join the translators to help us complete existing ones, or contact us through consul's gitter to become a Proofreader and validate translators contributions.
If your language isn't at Crowdin project, please [open an issue](https://github.com/consul/consul/issues/new?title=New language&body=Hello I would like to have my language INSERT YOUR LANGUAGE NAME added to consul) and we'll set it up in a breeze.
If you want to check existing translations of the user-facing texts you can find them organized in YML files under config/locales/ folder. Take a look at the official Ruby on Rails internationalization guide to better understand the translations system.
Custom Texts
Since CONSUL is always evolving with new features, and in order to make your fork easier to be updated, we strongly recommend translation files not to be modified, but instead "overwritten" with custom translation files in case a text needs to be customize for you.
So if you just want to change some of the existing texts, you can just drop your changes at the config/locales/custom/ folder, we strongly recommend to include only those text that you want to change instead of a whole copy of the original file. For example if you want to customize the text "Ayuntamiento de Madrid, 2016" that appears on every page's footer, firstly you want to locate where it's used (app/views/layouts/_footer.html.erb), we can see code is:
<%= t("layouts.footer.copyright", year: Time.current.year) %>
And that the text its located at the file config/locales/es/general.yml following this structure (we're only displaying in the following snippet the relevant parts):
es:
layouts:
footer:
copyright: Ayuntamiento de Madrid, %{year}
So in order to customize it, we would create a new file config/locales/custom/es/general.yml with just that content, and change "Ayuntamiento de Madrid" for our organization name. We strongly recommend to make copies from config/locales/ and modify or delete the lines as needed to keep the indentation structure and avoid issues.
Maintaining your Custom Texts & Languages
CONSUL has the i18n-tasks gem, it's and awesome helping tool to manage i18n translations. Just check i18n-tasks health for a nice report.
If you have a custom language different than English, you should add it to the i18n-tasks.yml config file on both base_locale and locales variables so your language files will be checked as well.