# Tools and Setup Instructions

The required tools depends on the Operating System. Linux is recommended, although several members of the documentation team uses Windows. All members require the following to commit:

- A SVN account

- A SVN client, typically from the command-line.

- A text editor

- PHP

The basic process is to check out (~download) a file (or entire SVN module) using the SVN client, edit the file, configure and validate the file, review the diff/patch, and finally commit (~upload) the file to the server. Building and viewing the file locally before commit is also an option.

All documentation and translations should be made using UTF-8 encoding.

Testing modifications takes a little time to get used to but after awhile it becomes natural. See the configuration and validation chapter for more information.

## Tools on Linux and Mac OS X

SVN:

PHP: Several operating systems include PHP by default, but the following extensions are required: libxml, xmlreader, and DOM. These are enabled by default since PHP 5.1.0.

PhD: See the PhD section for details. This is what builds the manual.

PATH: The system terminal uses the PATH environment variable to find shell commands, such as svn and php. Consider adding the appropriate paths.

## Tools on Windows

SVN: Either use cygwin, or install a svn client within the system shell.

PHP: Several operating systems include PHP by default, but the following extensions are required: libxml, xmlreader, and DOM. These are enabled by default since PHP 5.1.0.

PhD: See the PhD section for details. This is what builds the manual.

PATH: The system terminal uses the PATH environment variable to find shell commands such as svn and php. Consider adding the appropriate paths.