Internationalization

ngeo and server

In the file <package>.mk, define the supported languages with (default):

LANGUAGES ?= en fr de

In the file vars.yaml, define the available and default locales:

vars:
     ...
     default_locale_name: fr
     available_locale_names: [en, fr, de]

In the file language_mapping, define any desired locale variants, for example:

fr=fr-ch

Build your application.

The files to translate are:

  • geoportal/<package>_geoportal/locale/<lang>/LC_MESSAGES/demo-client.po for the ngeo client
  • geoportal/<package>_geoportal/locale/<lang>/LC_MESSAGES/demo-server.po for the server part (should be empty for ngeo interfaces)

Note

All the #, fuzzy strings should be verified and the line should be removed (if the line is not removed, the localisation will not be used).

To update the po files, you must run the following command:

For Docker project:

./docker-compose-run  make --makefile=<package>.mk update-po

For non Docker project:

./docker-run make --makefile=<package>.mk update-po

Note

You should run this command when you change something in the following:

  • layer in mapfile (new or modified)
  • layer in administration (new or modified)
  • raster layer in the vars file (new or modified)
  • print template
  • full text search
  • application (JavaScript and HTML files)
  • layer enumeration
  • some metadata as disclaimer
  • editable layer (database structure, data or enumerations)

Note

In mapfiles, attributes added by mapserver substitution will not be collected for translation.

Collecte custom strings

If the standard system can not collect some strings, you can add them manually in one of your JavaScript application controllers:

/** @type {angular.gettext.gettextCatalog} */
const gettextCatalog = $injector.get('gettextCatalog');
gettextCatalog.getString('My previously not collected string');

CGXP

Translations of the browser interfaces (main viewer, edit interfaces and APIs) are included in two kinds of Javascript files, stored in <package>/static/js/Proj/Lang/:

  • <lang>.js is used to translate data-related strings such as layernames or attributenames (in interrogation results). It is based upon the OpenLayers translation syntax. For instance:

    OpenLayers.Util.extend(OpenLayers.Lang.<lang>, {
    "layertree": "Themes"
});

  • GeoExt-<lang>.js is used to adapt the translations of existing plugins/widgets or to add translations of project-specific plugins. It is based upon the GeoExt translation syntax. Key-value translation pairs are encapsulated by class. For instance:

    GeoExt.Lang.add("<lang>", {
    "cgxp.tree.LayerTree.prototype": {
        moveupText: "Move up"
    }
});

Note

<lang> is the ISO 639-1 code. For example: en, de or fr.

Note

Standard translations for CGXP plugins/widgets strings are available on Github.

Note

Translations from both OpenLayers- and GeoExt-based systems are stored in separated files because of API constraints. Read more at Internationalization.