Please note that the QGIS Training Manual is being ported to QGIS 2.0 and has been incorporated into the main QGIS-Documentation repository (https://github.com/qgis/QGIS-Documentation). Work is currently being done in the manual_en_v2.0 branch (https://github.com/qgis/QGIS-Documentation/tree/manual_en_v2.0)

Please read the new wiki pages (https://github.com/qgis/QGIS-Documentation/wiki) if you wish to contribute to the porting of the Training Manual

This manual was originally produced by Linfiniti Consulting CC (http://linfiniti.com) and is now a community effort.

Make sure that you understand and agree to the license conditions for this project before contributing.

To add content to the (English) source, you will need:

• Git version control software. Refer to git's documentation for help.
• A local clone of the manual's repository. You may wish to work on your own fork of this repository and submit a pull request later.
• The latest stable installation of QGIS software (in which to produce examples).
• A basic text editor to edit the RST text files which contain the content. Take care not to commit Windows line endings!
• A method to make and edit screenshots. When adding screenshots, put them in the "_static_en" directory. Use the existing structure as an example.

• You'll need a translation editor such as Qt Linguist or Virtaal. Use it to edit the .po files for your language, found under the i18n folder.
• When creating new screenshots, always save them under the same name as the ones they are to replace. If you use your own file names, the images won't show up in the document.

• The languages that will be considered for translation are in the "pre_translate.sh" and "post_translate.sh" scripts.
• In order to create a fully functional translation for a language, open each of these scripts and edit their LOCALE lists.
• Add the two-letter code for your chosen language to all of the LOCALE lists and save the files.
• Run the "pre_translate.sh" script.

• Run the "post_translate.sh" script.
• You may add the two-letter language code of your language as a parameter to make the script only render documentation for the language you specified.
• The output directory is _build, which is not under version control.
• Alternatively, to render the English documentation only as html, run the command "make html".
• The English PDF render target is specified by using "make latexpdf".
• You may need to install "texlive" or "texlive-full" for PDF rendering to work.

To use the theme, run the command "git submodule update --init linfiniti-sphinx-theme" to load the theme submodule from git.

If you wish to deploy the docs under Apache on a Vagrant box (or other remote server), you can use the included fabfile tasks to auto-deploy and build the docs.

Currently, it is only possible to build the entire training manual (in a number of localisations), but customised, automated deployments should be possible in the future. This will be useful if you plan to use the Training Manual in a networked teaching environment where internet access is unavailable, slow or expensive.

You'll need a working python environment (a virtualenv is recommended) and Vagrant (http://vagrantup.com) must be installed (unless deploying to a remote server). To launch a Vagrant box, at the repository root, run:

vagrant up

To install and boot an Ubuntu Precise 64 box.

Inside your local virtualenv run:

pip install fabgis

Then run:

fab vagrant deploy

This will install all the necessary system requirements, setup the repository and setup Apache inside the Vagrant box.

To deploy to a remote server, run:

fab -H 123.123.123.123:3456 deploy

Or if you have a host specified in your SSH config file:

fab -H HostName deploy