ParaView Translations 101

The translation of ParaView is a long process. This README aims to resume all merge requests and features this process adds to ParaView, so developpers digging for infos are not too lost.

Related merge requests

Nearly all of my ParaView MR are about translations.

ParaView repository

• Refactors to make cpp string translatable: the main one (+ its hotfix), Plugins and examples, XRInterface, more and more fixes
• Refactors to make XML elements translatable: GetXMLLabel()
• CMake translation source files generation
• Translation loading system and translation test plugin
  • Loading system improval
  • Ignore editable text in translatability testing
• Translation developer documentation
• CI Job to get the translations
• Improve translations
• Rework pretty labels

ParaView Superbuild

• Superbuild integration to ship the translations

ParaView translations

• Add of the first template files
• Add of the CMake build system + its CI
• Add of INSTALL_SUBDIR
• Add of qt translations as submodule
• REAMDE improval

Related issues

• Once macros are ignored by --dr, we will be able to do the test pv.LoadTranslationsTestingPlugin.
• Once plugin EULA prompts are skipped by CTest, the testing of TanslationsTesting plugin will have to be refactored to use REQUIRE_PLUGIN instead of an XML manually loading the plugin.
• Some methods uses Qt labels in code logic.

Features

• Translations source files generation (this MR)
• Source files translation into other languages (this repo)
• Generating translation binary files
• Shipping binary files into ParaView's translations shared directory
• Choosing UI language from Interface language section of the general settings.

Related ParaView environment variables

• PV_TRANSLATIONS_DIR: Additional directories containing translations binary files.
• PV_TRANSLATIONS_LOCALE: Set the language to load (needed for testing purposes).

Related ParaView CMake variables

• PARAVIEW_BUILD_TRANSLATIONS (default to OFF): Enable translation files update and generation.
• PARAVIEW_TRANSLATIONS_DIRECTORY (default to ${CMAKE_BINARY_DIR}/Translations): Path where the translation files will be generated on build.