Manual Translation
From Quantum GIS Wiki
Contents |
Introduction
These pages provide details of everything you need to know relating to the QGIS documentation translation effort including checking out, compiling, translating and procedural details. It is managed by the Manual Translation Team Lead. If you plan to translate the manual into a foreign maybe not yet existing language and for any other related questions, please write to the qgis-community-team mailing list.
Mailing List
A (currently low volume) mailing list is available for discussion of both, translation of the QGIS user interface and documentation (User, Compilation and Coding Guide) issues. We strongly encourage anyone joining the documentation effort to join this list!
The Documentation Process
The documentation process works in the following way. In the build up to each release the master document (in english) is updated. When this document is complete and we are absolutely sure there will be no more changes to the application ('code freeze') the documentation in subversion will be tagged and branched for translation into several foreign languages.
|-- branches | `-- 1.0.0 | |-- italian | `-- german | `-- etc...
Document writers will be given write access to their branch and the translation process can commence. The table in the next section can be used to give a macro level view of how you are in the translation process. If you read on, we will explain how to get the docs from SVN in more detail.
Translation Maintainers
Note: The QGIS project is looking for people who are willing to invest some more time - even perhaps to coordinate the documentation translation effort. We are trying to improve our project management process and spread the load more evenly between people who each have a specific area of resposibility, so any contribution you have to make will be greately appreciated.
Please add your details to the list below. If you would like to nominate yourself as a coordinator for a language please go ahead. If more than one person nominates themselves as coordinator for the same language, please contact each other and resolve how you will manage your efforts.
Translation Coordinators of QGIS User Guide 1.0
| Language | Coordinator | Additional Contributors | |
| French | Jean Roc MORREALE | jr.morreale at enoreth.net | |
| Yves Jacolin | yjacolin at free.fr | ||
| Sebastien Vial | sebastien.vial at gmail.com | ||
| Ludovic Granjon | ludovic.granjon at free.fr | ||
| Jeremy Garniaux | jeremy.grx at gmail.com | ||
| German | Otto Dassau | otto.dassau at gmx.de | |
| Italian | Paolo Cavallini | cavallini at faunalia.it | |
| Giuseppe Patti | geognu at infinito.it | ||
| Simona Santini | simona_santini03 at yahoo.it | ||
| Polish | Robert Szczepanek | robert at szczepanek.pl | |
| Andrzej Swiader | andrzej.swiader at uj.edu.pl | ||
| Brazilian Portuguese (PT_BR) | Christian Ferreira | christian.linux at gmail.com | |
| Marco Aurélio Roncatti | marco at codexremote.com.br | ||
| Arthur Nanni | arthur.nanni at gmail.com | ||
| Portuguese (PT_PT) | Giovanni Manghi | giovanni.manghi at faunalia.pt | |
| Vânia Neves | vania.neves at faunalia.pt | ||
| Carlos Santos | capsantos2 at gmail.com | ||
| Russian | Denis Rykov | rykovd at gmail.com | |
| Maxim Dubinin | sim at gis-lab.info | ||
| Spanish | Mario Pisa | mario.pisa at gmail.com | |
| Carlos Dávila | cdavilam at jemila.jazztel.es | ||
| Axel Moser | moser.axel at gmail.com |
How to become a maintainer
There are currently some restrictions to check out the QGIS documentations with write-support. If you like to help with the translation of the current QGIS manual please write to the qgis-community-team mailing list. and contact the current language coordinator listed above.
What you need to get started
Following steps are needed to get write-access to the documentation repository.
- LaTeX (tetex and tetex-extra on debian-based systems)
- convert from the image-magick-package
- subversion client
- Read more about subversion here: http://svnbook.red-bean.com/
- latest QGIS version
- some time to contribute to the manual :)
Further you need to decide on a username and password. You will be given access to write to the documentation translation branch for your chosen language.
Translating the english documentation
Translating the latex sources inside the svn branches (translation areas) is pretty simple. To contribute directly you need a valid username with password and a subversion installation on your PC. You can write to the qgis-community-team mailing list. The Manual Translation Team Lead help you and organize everything you need and create a translation branch for the language you want to translate the english latex files into.
Structure of the translation repositories
The folder structure looks like this (3 levels deep):
|-- branches | `-- 0.9.1 | `-- 1.0.0 | |-- italian | `-- german | `-- spanish | `-- ...
Checkout a translation branch
Once your account has been set up you are able to check out the translation branch as a named user. For a clean checkout you need a svn-client. The following procedure is written for GNU/Linux to access to the documentation repository:
# Checkout as a guest svn co https://svn.osgeo.org/qgis/docs/branches/1.0.0/<language> # Checkout as a named user svn co --username <your username here> https://svn.osgeo.org/qgis/docs/branches/1.0.0/<language>
Editing and Building
Before you start translating content you should update your local working copy with the latest copy of the SVN-server. This is necessary, because another person might have updated the SVN-server with his/her latest work:
cd branches/1.0.0/<language>/user_guide svn update
Now xou can start with the translation of the .tex files with your favorite text editor. To build the translation as a PDF-doc, change into the folder user_guide and do the following:
cd branches/1.0.0/<language>/user_guide make make pdf
when finished you need to commit (upload) your changes as soon as possible to prevent that work is done twice by another person. Inside the folder user_guide type:
svn commit
Windows
For Windows a nice SVN-client is Tortoise SVN which integrates smoothly into the windows explorer. All needed SVN-commands described above can be used inside the explorer using the context-menu. Find more information at the Support Page.
For using LaTeX with windows it is recommended to use the MikTeX distribution located at MikTeX Page. There are also several LaTeX-Editors available for windows like Winshell TeXMaker TeXnicCenter if you like WYSIWYG editing (mostly you loose some advantages of LaTeX) you can use LaTeXEditor or for a 28day free period BaKoMa TeX
Some hints translating the latex files
- All you need to translate is the english text within the files ending with .tex (e.g. map_composer.tex).
- You don't need to adapt or change the images nor the names of the images.
- You can ignore all commands starting with \ (e.g. \section) and only translate the text inside the brackets (e.g. \section{Introduction} becomes in german \section{Einführung}).
- For figures you can also almost ignore most of the definition and only translate small parts (see the example below):
\begin{figure}[ht]
\begin{center}
\caption{Image of a blank Map Composer}\label{fig:map_composer_blank}\smallskip
\includegraphics[clip=true, width=\textwidth]{map_composer_blank08}
\end{center}
\end{figure}
in german becomes:
\begin{figure}[ht]
\begin{center}
\caption{Bild eines leeren Map Composer}\label{fig:map_composer_blank}\smallskip
\includegraphics[clip=true, width=\textwidth]{map_composer_blank08}
\end{center}
\end{figure}
- To check the translation you can build the latex sources simply with 'make':
For any questions you can get help from the qgis-community-team mailing list.
