Skip to content

TEKSI Translation Guide

Urs Kaufmann edited this page Oct 23, 2024 · 8 revisions

General

It is possible to contribute to TEKSI modules translations :

  • Documentation
  • QGIS .qgs projects (Forms)
  • Plugin (Interface)

Join the TEKSI organisation on Transifex

https://explore.transifex.com/teksi/

image

Here you will be able to join any "project" you want to help to translate (just after your account is created and your joining request is accepted) :

image

Old organisations are still available for QWAT and QGEP

Reference glossaries

To ease translation and improve quality, glossaries have been set to provide translation terms from official repositories (at least for switzerland)

https://docs.google.com/spreadsheets/d/1qeoCVwdOLyhdLHqVKsOzZ5zyle3iiQd1pVTFKU_rbGU/edit?usp=sharing

In Transifex, it can be seen like that :

image image

Translations rules and good practices

Use official terms when possible as first rule. And take care about specific details of attention listed here under.

Relationnal value (value_en)

When translating it's important to know, where the word is coming from. In "more info" you find for every text the context. "value_en" has two contexts:

  1. it can be a value_relation value: then it has to be translated to value_de or value_fr:

image

green: table or view, field. blue: valuerelation value

image

effect: in the translated project, there will stand value_de / value_fr instead of value_en - you have your language.

  1. it can by a field alias (name of the attribute of a table or of a view). All other fieldaliases should be translated, but not field-aliases of value lists (Wertetabellen). Becaue if you do this, there will be two fields with value_de after the translation. The value relation goes to the field with name value_de. QGIS will take the first field with value_de. This is the field with the english values, but has alias value_de. Your valuelists in the attributes form will be in english!

image these blue value_en should keep his name.

image

Do not translate field aliases of value list!.

Value lists are tables with name "classname"_"fieldname". In the example: class reach_point, field elevation_accuracy

Value-map field widgets

Database type items/attributes (like ws_type) can only be translated manually (translate Description and not Value!)

image

See https://github.com/teksi/wastewater/issues/60 for more information about that.

Translation automation and update mechanisms

Translations assets (documentation, project, plugin) are provided and updated by the CI using Transifex API and GitHub actions.

In a general way :

  • Documentation translation is updated every day
  • Project translation is done every release or triggered manually
  • Plugin translation is done every release

How to trigger a translation update

  1. Go to the corresponding workflow https://github.com/teksi/wastewater/actions/workflows/project-translation.yml
  2. Click run workflow (you have to be member of TEKSI GitHub organisation to do it)
  3. Refresh the page
  4. Once the workflow is done (about 2m30s) click on it and click on summary
  5. Here you will find the translated project file available to download
Clone this wiki locally