Difference between revisions of "Live GIS Translate"

From OSGeo
Jump to navigation Jump to search
(added Transifex section)
 
(17 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
''This page describes how to translate documentation for the [[Live GIS Disc|OSGeo-Live DVD]].''
 
''This page describes how to translate documentation for the [[Live GIS Disc|OSGeo-Live DVD]].''
  
=Getting Started=
+
= Getting Started =
 
Thanks for considering translating the OSGeo-Live documentation. To get started:
 
Thanks for considering translating the OSGeo-Live documentation. To get started:
 
; Introduce yourself.
 
; Introduce yourself.
 
: Please join our email list at: http://lists.osgeo.org/mailman/listinfo/live-demo, 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.
 
: Please join our email list at: http://lists.osgeo.org/mailman/listinfo/live-demo, 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: https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/doc/translators.csv
 
; Get Subversion access
 
: Before updating files, you need commit access to our Subversion repository, described here: http://wiki.osgeo.org/wiki/Live_GIS_Disc#Subversion
 
; check out the doc-directory from svn:
 
svn co https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/doc/
 
svn co https://svn.osgeo.org/osgeo/livedvd/promo/en/presentations/OSGeoLive4_0Taster
 
  
Only if you want to compile with sphinx in your locale environment, you need to get check out all trunk-directory from svn:
+
We moved from svn to git. So please read about the next steps here:
svn co https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/
+
* [[Live_GIS_Disc#Git_migration]]
  
 
; Credit yourself
 
; Credit yourself
 
: As a first test to see subversion is working, add your name to the list of translators.
 
: 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, and 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 =
 
= Status Sheet =
  
Line 40: Line 27:
 
This is how it works:
 
This is how it works:
  
* In the [https://spreadsheets.google.com/ccc?key=0AlRFyY1XenjJdFRDbjFyWHg1MlNTRm10QXk0UWEzWlE&hl=en_GB&authkey=CPTB6uIE#gid=16 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). See also the [http://adhoc.osgeo.osuosl.org/livedvd/lang_stats.html gross % complete].
+
* Find documents that have a "Final" status in our [https://docs.google.com/spreadsheet/ccc?key=0Al9zh8DjmU_RdGIzd0VLLTBpQVJuNVlHMlBWSDhKLXc#gid=13 Project Status sheet] and which are not translated or outdated in the [http://adhoc.osgeo.osuosl.org/livedvd/translation_status.html Translation Status].
* 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)
 
* 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
+
  '''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
 
* translate the document and then commit back to subversion
* add your name as translator of the document: add ''''':Translator: Your_name''''' at the top of document near '':Reviewer:'' or ''Author''
 
  
  svn commit -m "Translated docX.rst to Italian" docX.rst
+
  git add docX.rst
 +
git commit -m "Translated docX.rst to Italian" docX.rst
 +
git push origin master
  
 
* Once complete change status="complete"
 
* 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 ==
 
== Adding new languages ==
Line 59: Line 47:
 
* <tt>doc/Makefile</tt>
 
* <tt>doc/Makefile</tt>
 
* <tt>doc/themes/overview/page.html</tt>
 
* <tt>doc/themes/overview/page.html</tt>
* <tt>doc/index.rst</tt>
+
* <tt>doc/index.template</tt>
 +
* <tt>bin/lang_stats.sh</tt>
 +
 
 +
Setup the dir structure:
 +
LCODE=pt
 +
 +
cd doc/
 +
mkdir $LCODE
 +
cd $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.
  
 
== Glossary ==
 
== Glossary ==
Line 66: Line 69:
 
== Use OmegaT for the translations ==
 
== Use OmegaT for the translations ==
 
* there is a nice tool to generate the translations http://www.omegat.org/ (here you find a good documentation)
 
* there is a nice tool to generate the translations http://www.omegat.org/ (here you find a good documentation)
* apt-get install omegat
+
* 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
 
* add the ending rst to be supported by OmegaT
** configure: Options - file filter - textfiles - add - add *.rst  
+
** configure: Options &rarr; file filter &rarr; textfiles &rarr; add &rarr; add *.rst  
  
 
* Create a new project:  
 
* Create a new project:  
Line 74: Line 78:
 
** 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.
 
** 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.
 
** 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.
+
** Write files: Project &rarr; Create Translated Documents will populate doc/$your-language into git tree. All .rst files contain both translated and untranslated strings.
** svn commit
+
** git commit
 +
** git push origin master
  
 
* Work on an already started translation:
 
* Work on an already started translation:
 
** TO BE DONE - is OmegaT able to handle contents under version control? Seems not, for me.
 
** TO BE DONE - is OmegaT able to handle contents under version control? Seems not, for me.
  
=Update status sheet version numbers=
+
== Move to Transifex ==
To update the version numbers of documents in the status sheet, someone should follow the following process:
 
  cd trunk/bin
 
./extract_doc_versions.sh > list.csv
 
libreoffice list.csv
 
Cut and paste the contents into the second row of the worksheet "svnlist" in https://spreadsheets.google.com/ccc?key=0AlRFyY1XenjJdFRDbjFyWHg1MlNTRm10QXk0UWEzWlE&hl=en_GB&authkey=CPTB6uIE#gid=7
 
  
( Cut & paste has to be done in two or three times, as now it is to much data for the clipboar)
+
There is the plan to move the translation to Transifex. The documentation/discussion can be found here: https://wiki.osgeo.org/wiki/Talk:Live_GIS_Translate
  
  
 
[[Category: Live-demo]]
 
[[Category: Live-demo]]
 +
[[Category: Translation]]

Latest revision as of 12:38, 19 December 2016

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: http://lists.osgeo.org/mailman/listinfo/live-demo, 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

  • http://adhoc.osgeo.osuosl.org/livedvd/
    • 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.

Translations

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/lang_stats.sh

Setup the dir structure:

LCODE=pt

cd doc/
mkdir $LCODE
cd $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.

Glossary

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 http://www.omegat.org/ (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: https://wiki.osgeo.org/wiki/Talk:Live_GIS_Translate