Difference between revisions of "Talk:Live GIS Translate"

Latest revision as of 11:36, 30 January 2017

It would be nice to do the translation with Transifex. In contrast to github, Transifex is much easier for non-technical people. Moreover we can get an good overview how much is translated. Other projects also use Transifex for their translations:

How is the translation handled now?

At the moment each language has its own folder with .rst files. The problem is that is difficult to see if the translation is up to date or not. In order to change files, it is necessary to change it on GitHub.

What is a better way to do translations?

One improvement would be to do the translations using .po files. This site explains how it works. The English source files are still stored in .rst files. Every other language consist of .po files. A .po file contains the English source and its translation. These .po can be updated once the English source language is updated. So it is easy to keep updated.

The translation of the .po files can be done manually in a text editor or with some special desktop programs for .po files. This is the point where Transifex comes into play: The process of translating the .po files can be "outsourced" to Transfex. It has a nice user interface and is free for open source projects (commercial projects have to pay).

Implementation

This mail already explains some basic steps and demonstrates it in this fork. Moreover the documentation on the Transifex website is useful as well. Sphinx provides instructions as well. This video gives a good overview about Sphinx and Transifex. This mail provides some findings about the implementation. There is contact to the QGIS translation community.

Current State

I used this branch https://github.com/ThomasG77/OSGeoLive-doc/tree/transifex . Then I did this commands:

First it is necessary to change these lines in the conf.py file https://github.com/OSGeo/OSGeoLive-doc/blob/master/conf.py#L25 .

The automatic reading of the version number causes troubles. So the the version number should simply be "hard-coded":

version = '10.5'

Then:

make gettext
sphinx-intl update -p _build/locale
tx init
sphinx-intl update-txconfig-resources --pot-dir _build/locale --transifex-project-name osgeolive
tx push -s
# Now the English source language should be pushed to Transifex.

# Do some translation

# Pull the translation to the local repository 
tx pull -l de

# build the html files for the German translation 
make -e SPHINXOPTS="-D language='de'" html

Now the English source language should be pushed to Transifex.

Changing the language team line by "Language-Team: ENGLISH <https://live.osgeo.org/en/contact.html\n" seems mandatory.

What has been tested so far?

The whole process of translation already works with the command lines:

- creating .pot and .po files

- pushing to Transifex

- translating in Transifex

- pulling translation to the local repo

- creating html for a translated language

Open Challenges

- the whole process should be done completely automatically: In order to do this the "Makefile" should be edited. More commands need to be edited. The "Makefile"s of other projects (QGIS, QField) could be taken as inspiration.

- The folder structure should be cleaned up. At the moment some .rst files are outside the main documentation. This causes troubles and should be fixed.

Tipps and Tricks

It is possible to delete a lot of resources on Transifex using this command:

tx delete -r osgeolive.de--*

It is possible to delete just a single file, but you can also delete a lot of files using the "*".

You might need it if you accidentally upload wrong files.

@@ Line 1: / Line 1: @@
-= German Translations =
+It would be nice to do the translation with [https://www.transifex.com/osgeo/osgeolive Transifex]. In contrast to [https://github.com/OSGeo/OSGeoLive-doc github], Transifex is much easier for non-technical people. Moreover we can get an good overview how much is translated. Other projects also use Transifex for their translations:
+* [https://github.com/qgis/QGIS-Documentation QGIS-Documentation] [https://www.transifex.com/qgis/qgis-documentation translation]
+* [https://github.com/opengisch/QField-docs QField-Documentation] [https://www.transifex.com/opengisch/qfield-documentation translation]
-; application status sheet
+== How is the translation handled now? ==
-* https://spreadsheets.google.com/ccc?key=0AlRFyY1XenjJdFRDbjFyWHg1MlNTRm10QXk0UWEzWlE&hl=en_GB&authkey=CPTB6uIE#gid=30
-; Ansicht der Seiten unter:
+At the moment each language has its own folder with .rst files. The problem is that is difficult to see if the translation is up to date or not. In order to change files, it is necessary to change it on GitHub.
-http://adhoc.osgeo.osuosl.org/livedvd/docs/de/index.html
-; Trac
+== What is a better way to do translations? ==
-http://trac.osgeo.org/osgeo/browser/livedvd/gisvm/trunk/doc/de/
-'''fett''' -> erledigt
+One improvement would be to do the translations using .po files. [http://www.sphinx-doc.org/en/1.5.1/intl.html This site] explains how it works. The English source files are still stored in .rst files. Every other language consist of .po files. A .po file contains the English source and its translation. These .po can be updated once the English source language is updated. So it is easy to keep updated.
-== de ==
+The translation of the .po files can be done manually in a text editor or with some special desktop programs for .po files. This is the point where Transifex comes into play: The process of translating the .po files can be "outsourced" to Transfex. It has a nice user interface and is free for open source projects (commercial projects have to pay).
-* copyright -> astrid
-== de overviews translations==
+== Implementation ==
-* '''geokettle_overview.rst''' -> frank
-* '''geomajas_overview.rst''' -> dominik
-* geomoose_overview.rst -> astrid --needs review
-* '''geotools_overview.rst''' -> frank
-* '''liblas_overview.html''' -> astrid
-* '''mapguide_overview.rst''' -> dominik
-* metacrs_overview.rst  -> astrid --> needs review
-* nc_dataset_overview.rst -> lars
-* mapwindow_overview.rst -> lars
-* 52nWSS_overview.rst -> thomas (please review)
-* osm_dataset_overview.rst -> thomas (please review)
-* '''naturalearth_overview.rst''' -> frank
-* '''pycws_overview.rst''' -> astrid
-* '''tinyows_overview.rst''' -> frank
-* '''vmware_overview.rst''' -> frank
-== de quickstart translations ==
+This [https://lists.osgeo.org/pipermail/live-demo/2016-August/011644.html mail] already explains some basic steps and demonstrates it in this [https://github.com/ThomasG77/OSGeoLive-doc/tree/transifex fork]. Moreover the [https://docs.transifex.com/integrations/sphinx-doc/ documentation] on the Transifex website is useful as well. [http://www.sphinx-doc.org/en/1.5.1/intl.html Sphinx] provides instructions as well. This [https://www.youtube.com/watch?v=Nz8zutA55fI video] gives a good overview about Sphinx and Transifex. This [https://lists.osgeo.org/pipermail/live-demo/2017-January/011741.html mail] provides some findings about the implementation. There is [https://lists.osgeo.org/pipermail/qgis-tr/2017-January/000797.html contact] to the QGIS translation community.
-* '''52nSOS_quickstart.rst'''   -> projekt
+== Current State ==
-* 52nWPS_quickstart.rst -> projekt
-* atlasstyler_quickstart.rst -> projekt stefan
+I used this branch https://github.com/ThomasG77/OSGeoLive-doc/tree/transifex . Then I did this commands:
-* '''deegree_quickstart.rst''' -> projekt latlon
-* '''gdal_quickstart.rst''' -> astrid
+First it is necessary to change these lines in the conf.py file https://github.com/OSGeo/OSGeoLive-doc/blob/master/conf.py#L25 .
-* '''geokettle_quickstart.rst''' -> frank
-* '''geomajas_quickstart.rst''' -> dominik
+The automatic reading of the version number causes troubles. So the the version number should simply be "hard-coded":
-* geomoose_quickstart.rst -> ??
-* '''geonetwork_quickstart.rst''' -> david
+ version = '10.5'
-* geopublisher_quickstart.rst -> projekt stefan
-* '''geoserver_quickstart.rst''' -> frank
+Then:
-* '''gmt_quickstart.rst''' -> frank
-* gpsdrive_quickstart.rst --> ??
+ make gettext
-* '''grass_quickstart.rst''' -> otto
+ sphinx-intl update -p _build/locale
-* '''gvsig_quickstart.rst''' ruth
+  tx init
-* '''internationalisation_quickstart.rst''' -> frank
+ sphinx-intl update-txconfig-resources --pot-dir _build/locale --transifex-project-name osgeolive
-* kosmo_quickstart.rst -> ??
+ tx push -s
-* liblas_quickart.rst -> ??
+ # Now the English source language should be pushed to Transifex.
-* '''mapbender_quickstart.rst''' -> astrid
-* '''mapfish_quickstart.rst''' -> dominik
+ # Do some translation
-* mapguide_quickstart.rst
-* '''mapnik_quickstart.rst''' -> dominik
+ # Pull the translation to the local repository
-* '''mapproxy_quickstart.rst''' -> dominik
+ tx pull -l de
-* '''mapserver_quickstart.rst''' -> otto
-* maptiler_quickstart.rst
+ # build the html files for the German translation
-* mapwindow_quickstart.rst -> ??
+ make -e SPHINXOPTS="-D language='de'" html
-* marble_quickstart.rst
-* mb-system_quickstart.rst
-* '''opencpn_quickstart.rst''' -> frank
+Now the English source language should be pushed to Transifex.
-* openjump_quickstart.rst-> ??
-* openlayers_quickstart.rst --> dominik
+Changing the language team line by "Language-Team: ENGLISH <https://live.osgeo.org/en/contact.html\n" seems mandatory.
-* osgearth_quickstart.rst -> pirmin
-* '''osgeolive_install_quickstart.rst''' -> thomas
+== What has been tested so far? ==
-* '''osgeolive_quickstart.rst''' -> thomas
-* osm_quickstart.rst-> ??
+The whole process of translation already works with the command lines:
-* '''ossim_quickstart.rst''' -> otto
-* otb_quickstart.rst-> ??
+- creating .pot and .po files
-* '''pgrouting_quickstart.rst''' -> daniel
-* '''postgis_quickstart.rst''' -> astrid
+- pushing to Transifex
-* '''prune_quickstart.rst'''-> ??
-* '''qgis_mapserver_quickstart.rst ''' -> pirmin
+- translating in Transifex
-* qgis_quickstart.rst -> pirmin
-* rasdaman_quickstart.rst -> projekt
+- pulling translation to the local repo
-* '''R_quickstart.rst''' -> otto
-* '''saga_quickstart.rst''' -> otto
+- creating html for a translated language
-* '''sahana_quickstart.rst''' -> daniel
-* '''spatialite_quickstart.rst''' -> daniel
+== Open Challenges ==
-* '''tinyows_quickstart.rst''' -> pirmin
-* '''udig_quickstart.rst''' -> frank
+- the whole process should be done completely automatically: In order to do this the "Makefile" should be edited. More commands need to be edited. The "Makefile"s of other projects (QGIS, QField) could be taken as inspiration.
-* '''usb_quickstart.rst''' -> thomas
-* '''ushahidi_quickstart.rst''' -> daniel
-* viking_quickstart.rst -> ??
+- The folder structure should be cleaned up. At the moment some .rst files are outside the main documentation. This causes troubles and should be fixed.
-* '''virtualbox_quickstart.rst''' -> otto
-* '''vmware_quickstart.rst''' -> frank
+== Tipps and Tricks ==
-* '''zoo-project_quickstart.rst''' -> daniel
-* zygrib_quickstart.rst-> ??
+It is possible to delete a lot of resources on Transifex using this command:
+ tx delete -r osgeolive.de--*
+It is possible to delete just a single file, but you can also delete a lot of files using the "*".
+You might need it if you accidentally upload wrong files.