Live GIS Translate

From OSGeo
Revision as of 11:39, 4 April 2012 by Wiki-Fgdrf (talk | contribs) (added column header description for the translation.csv file (see Ticket #374))
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.
Say "hello" to other translators from your region. Their details are listed here:
Get Subversion access
Before updating files, you need commit access to our Subversion repository, described here:
check out the doc-directory from svn
svn co
svn co

Only if you want to compile with sphinx in your locale environment, you need to get check out all trunk-directory from svn:

svn co
Credit yourself
As a first test to see subversion is working, add your name to the list of translators.
# edit translators.csv
# please add your Language, i18n code, Name, Country, Email,Osgeo_id to the list, separated by comma
#  - Order alphabetically by language, then by first name
#  - remove punctuation from email addresses to stop harvesting for junk mail

This is so that we can credit you in releases and other translators can find you: doc/translators.csv

Status Sheet

We track status of all translations in google doc spreadsheet

It contains some excel wizardry to check reported status of English docs, and entered document versions to report on status of translations. This is where you should look to determine which file you should translate next, and also which you should update after translating a document.

Note colour coding:

  • Black text = cell is calculated from somewhere else
  • Blue text = cell to be updated by us users
  • Green background = doc is complete
  • Yellow background = translation is out of date (there is a newer English version)

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:

  • In the status worksheet find a document with status of "en Status"="..._final" or "...final_dated". Start with docs allocated the highest priority first (priority=1 in worksheet)
  • Set the "status" for the document to "draft" while you edit it and add your user-id to the "translated-by" column.
  • 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
  • translate the document and then commit back to subversion
svn commit -m "Translated docX.rst to Italian" docX.rst
  • Once complete change status="complete"
  • Someone else should then review the document, change status to "reviewed" and add their user-id to the "reviewed-by" column.

Adding new languages

Make sure you edit the list in doc/Makefile and doc/themes/overview/page.html.

Use OmegaT for the translations

  • there is a nice tool to generate the translations (here you find a good documentation)
  • 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 SVN tree. All .rst files contain both translated and untranslated strings.
    • svn commit
  • Work on an already started translation:
    • TO BE DONE - is OmegaT able to handle contents under version control? Seems not, for me.

Update status sheet version numbers

To update the version numbers of documents in the status sheet, someone should follow the following process:

cd trunk/bin
./ > list.csv
libreoffice list.csv

Cut and paste the contents into the second row of the worksheet "svnlist" in