Translation

[aulemahal]

Pull Request Checklist:

• [ ] This PR addresses an already opened issue (for bug fixes / features)
  • This PR fixes #xyz
• [x] (If applicable) Documentation has been added / updated (for bug fixes / features).
• [ ] (If applicable) Tests have been added.
• [x] This PR does not seem to break the templates.
• [ ] HISTORY.rst has been updated (with summary of main changes).
  • [ ] Link to issue (:issue:number) and pull request (:pull:number) has been added.

What kind of change does this PR introduce?

• New utility functions utils.add_attr and utils.update_attr that enable internationalization of xclim. Both function, will add an attribute in english, but also try to add attributes for each of the activated languages, if a translation is found.
  • add_attr will add translation according to the value of xclim's option "metadata_locales".
  • update_attr is used to build an attribute from a previous version. It will do it's thing for all locales present on the dataset. For example, it can be used to go from long_name="Mean temperature" to long_name="Variability of Mean temperature".
• Translations are in xscen/data/{LOC}/LC_MESSAGES/xscen.po, this uses the gettext system. Only LOC='fr' currently implemented.
• New makefile targets :
  • make findfrench to detect translatable-strings and update the translation catalogs (xscen.po).
  • make translate to compile the catalogs into the xscen.mo format that python needs.
• New setup.py hook so that the catalogs are automatically compiled upon pip install xscen (NOT with pip install -e).
• Documented in CONTRIBUTING.rst.
• New special configuration section. A top-level locales which is a simple list of locales (2 letter names). If this section is updated through xs.load_config, it also updates xclim's metadata_locales option. Xscen actually uses xclim's option to control it's i18n.

Does this PR introduce a breaking change?

No

[aulemahal]

https://gist.github.com/aulemahal/415126d7a923f651ad9d8dcf267646bb

[review-notebook-app[bot]]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[aulemahal]

@juliettelavoie I added more details in the documentation!

[aulemahal]

hmmm, @Zeitsperre I might need help here, I don't see why the RTD build is failing... Is it the warning in the linkcheck ? If so, I can't seem to find the warning!

[Zeitsperre]

hmmm, @Zeitsperre I might need help here, I don't see why the RTD build is failing... Is it the warning in the linkcheck ? If so, I can't seem to find the warning!

Looks like it's a reference to a non-existing target:

WARNING: undefined label: 'translating xscen`

[Zeitsperre]

This is a pretty annoying sphinx convention, but thankfully someone on StackExchange has some advice: https://stackoverflow.com/questions/15394347/adding-a-cross-reference-to-a-subheading-or-anchor-in-another-page

[aulemahal]

Thanks!