Documentation
=============

You can find the "readable" version of the TortoiseGit manual under
https://tortoisegit.org/docs/tortoisegit/.

For general information on TortoiseGit please see https://tortoisegit.org/ or the [README file in the root](README.md).

HowTo build the docs
====================

First of all you need a local copy of the TortoiseGit repository.

Tools needed
------------

There are some tools for processing the XML input that you need to build the docs.
Scripts and dtd are included, but the executables (formatting processor,
translation tools) have to be installed separately.
For building the PDF manual, you will also need to have a recent Java Runtime Environment.

    tools\fop\		- the fop processor (for PDF generation)
    tools\xsl\		- the docbook xsl files from sourceforge
    tools\			- xsl processor, aspell, ...

you can download all the required tools as a 7-Zip package from the TortoiseSVN project:
<https://sourceforge.net/projects/tortoisesvn/files/build%20tools/>
Use 7-zip extract the tools-*.7z file to e.g. \TortoiseGit\Tools. You might want to
place your tools directory somewhere else on your harddisk, if you want to use it
to build other docs too. This will, however, require tweaking the build scripts.

Furthermore, Python 3 (can be installed from the Microsoft Store) is required.

Please note that having spaces in your directory path will (for the time being)
cause the documentation build process to fail.

If you want to update the git-man pages see [source/en/TortoiseGit/git_doc.patch](doc/source/en/TortoiseGit/git_doc.patch).


Structure
---------
The most important directories for you are:

    source\en - contains the english XML text source.
    images\en - contains the base (english) images for the docs
    xsl\	  - contains the stylesheets for the doc creation
    dtd\      - contains the tools and the dtd to validate and build the docs.

Please see [Screenshots.txt](doc/Screenshots.txt) for notes on how to create screenshots.

Building the docs
=================

NAnt Build
----------

    Open a command line
    cd TortoiseGit
    cd doc
    ..\tools\nant\nant.exe

A NAnt build script has been provided to build the docs. When doc.build is run for
the first time, the template doc.build.include.template is copied to doc.build.include.

For local customisations, copy the doc.build.user.tmpl file to doc.build.user and
modify that copy to point to the location of the tools on your system.

All other parameters are defined in doc.build.include. You can override all settings
in doc.build.user or via the NAnt command line.
