Installation

Where I can read this documentation

It is possible to read the HTML version of the documentation for many languages here:

• English: http://documentation.qgis.org/html/en/user_manual/
• French: http://documentation.qgis.org/html/fr/user_manual/
• German: http://documentation.qgis.org/html/de/user_manual/
• Italian: http://documentation.qgis.org/html/it/user_manual/
• Japanese: http://documentation.qgis.org/html/ja/user_manual/
• Portuguese: http://documentation.qgis.org/html/pt/user_manual/
• Russian: http://documentation.qgis.org/html/ru/user_manual/
• Spanish: http://documentation.qgis.org/html/es/user_manual/
• Dutch: http://documentation.qgis.org/html/nl/user_manual/

It is also available via the subdomain docs.qgis.org, for example for the German language: http://docs.qgis.org/html/de/user_manual/

In the qgis.org site the documentation is scheduled to be built every 6 hours.

Pdf versions of the manual are available here: http://documentation.qgis.org/pdf/

Quick Overview

• install required tools
• git clone the QGIS Documentation project
• run pre_translate.sh (if you want to update ALL translation files)
• translators edit their i18n files
• run 'post_translate.sh en' if you only want english docs (without locale for all)

Tools

You will need the following tools

• git (from packagemanager) to clone/download the source from Github.com
• gettext (from packagemanager) for translation tools
• texlive (from packagemanager: on Arch, it is texlive-core and texlive-bin)
• texlive-fonts-recommended (Ubuntu: from packagemanager)
• in debian you'll need 'texlive-latex-extra': sudo apt-get install texlive-latex-extra (texlive-latexextra on Arch)
• python-pip python installation (via sudo apt-get install python-pip)
• sphinx (via 'sudo pip install sphinx'; on Arch install python-sphinx)
• texi2pdf (from packagemanager: in Ubuntu it is in package 'texinfo')
• dvi2png (from packagemanager: in Ubuntu it is in package 'dvi2png')

Generation

Git clone this project:

git clone git@github.com:qgis/QGIS-Documentation.git
# to later update your tree do
git pull --rebase origin master

You should have a directory tree like this:

├── i18n               will hold the po files (translated strings) for all languages
├── output             will contain output (? not in github ?)
├── readme.rst         this file
├── resources          containing all images for sources
├── scripts            containing buildscripts and conf.py
├── source             containing all rst sources
└── themes             contains themes for output

Run pre_translate.sh script to create the gettext files (po, pot) in the i18n directory:

cd QGIS-Documentation
scripts/pre_translate.sh

Translators now can translate their local i18n files using tools like linguist or via a website.

Another option is to download a .po file from Github, translate it and sent it back to a language maintainer.

Run 'post_translate.sh' script to build all translated pdf and html files:

cd QGIS-Documentation
scripts/post_translate.sh

Note

if you only want to create docs in one language, use the locale code as parameter.

For example, to create english docs:

cd QGIS-Documentation
scripts/post_translate.sh en

Document Translators edit workflow

Every language has it's own maintainer, please contact them, if you want to help. You find a list of current language maintainers in the Project Organigram. If your language is not listed, please contact the QGIS-Community-Team Mailinglist and ask for help.

Howto for language maintainers

• get an account on github.com
• install git on your computer (On Ubuntu and with Linux systems you just need to write: sudo apt-get install git). For other OS, have a look at the github homepage (look for application section)
• on github.com search the repository of Qgis-Documentation and fork it, it just means that you create a copy of the original repository on your github account.

The maintainer should check the translations regularly. Therefore you should run the 'scripts/pre_translate.sh <language>' and 'scripts/post_translate.sh <language>' script after every significant change in the documentation. This will generate and update the .po files needed for translations. If all is fine, take care, that the translation go into the master repository from time to time.

• To update the master repository, you have to do a pull request on github. It means that you send a request to the owners of the repository you forked (so Qgis-Documentation) asking them to accept your translations and move them to the "original repository". For doing that go on github.com, browse on the directory of your repository and click pull request (https://help.github.com/articles/using-pull-requests).

Howto for translators

A thorough explanation for translators is written here: http://docs.qgis.org/html/en/docs/documentation_guidelines/do_translations.html