Live GIS Translate

From OSGeo
Revision as of 13:38, 19 December 2016 by Wiki-Magicgate (talk | contribs) (added Transifex section)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This page describes how to translate documentation for the OSGeo-Live DVD.

Getting Started

Thanks for considering translating the OSGeo-Live documentation. To get started:

Introduce yourself.
Please join our email list at:, and send an email introducing yourself and your wish to help out. If you wish to start translating to a new language, let us know so that we can create a new status worksheet for you.

We moved from svn to git. So please read about the next steps here:

Credit yourself
As a first test to see subversion is working, add your name to the list of translators.

Status Sheet

  • Documents ready to translate are marked "Final" in our Project Status Spreadsheet.
  • Check the Translation Status to find files that need translation, or need updating. Note that the hyperlink for each translated doc will take you to a page showing the differences in the English doc since last translation. (This document is updated hourly by extracting document version from subversion).

Nightly documentation builds

    • Latest documentation build can be found in the docs/ dir.
    • Please have a look at and squash any problems which show up in the error log, which can be found in the logs/ dir.


This is how it works:

  • Find documents that have a "Final" status in our Project Status sheet and which are not translated or outdated in the Translation Status.
  • If this is a new translated document, use subversion to copy the English version of the document to new language directory. (This retains our subversion history, while svn add does not)
svn copy doc/en/<doc>.rst doc/lang/<doc>.rst (old version with svn)
cp en/<doc>.rst doc/lang/<doc>.rst
  • add your name as translator of the document: add :Translator: Your_name at the top of document near :Reviewer: or Author
  • translate the document and then commit back to subversion
git add docX.rst
git commit -m "Translated docX.rst to Italian" docX.rst
git push origin master
  • Once complete change status="complete"

Adding new languages

Make sure you edit the list in:

  • doc/Makefile
  • doc/themes/overview/page.html
  • doc/index.template
  • bin/

Setup the dir structure:


cd doc/
mkdir $LCODE
mkdir overview/ quickstart/ standards/
cd ..
git add $LCODE
git commit -m 'new directory' $LCODE
git push origin master

Remember that when `doc/Makefile` changes the hash needs to be updated; contact Hamish.


At this page you can find a glossary of OSGeo-Live documentation related terms, please fell free to add new terms.

Use OmegaT for the translations

  • there is a nice tool to generate the translations (here you find a good documentation)
  • To install the tool on a Ubuntu or Debian system (such as the live disc) run:
sudo apt-get install omegat
  • add the ending rst to be supported by OmegaT
    • configure: Options → file filter → textfiles → add → add *.rst
  • Create a new project:
    • Select a folder where OmegaT can write its files
    • Select your destination language, point Source Files directory to doc/en, and Translated Files directory to doc/$your-language-code. The two middle options can stay where they are in subfolders of OmegaT project folder.
    • Translate something.
    • Write files: Project → Create Translated Documents will populate doc/$your-language into git tree. All .rst files contain both translated and untranslated strings.
    • git commit
    • git push origin master
  • Work on an already started translation:
    • TO BE DONE - is OmegaT able to handle contents under version control? Seems not, for me.

Move to Transifex

There is the plan to move the translation to Transifex. The documentation/discussion can be found here: