doc/readme.txt

   1 Documentation\r
   2 =============\r
   3 \r
   4 You can find the "readable" version of the TortoiseGit manual under\r
   5 https://tortoisegit.org/docs/tortoisegit/.\r
   6 \r
   7 For general information on TortoiseGit please see https://tortoisegit.org/ or the [README file in the root](README.md).\r
   8 \r
   9 HowTo build the docs\r
  10 ====================\r
  11 \r
  12 First of all you need a local copy of the TortoiseGit repository.\r
  13 \r
  14 Tools needed\r
  15 ------------\r
  16 \r
  17 There are some tools for processing the XML input that you need to build the docs.\r
  18 Scripts and dtd are included, but the executables (formatting processor, microsoft\r
  19 help compiler, translation tools) have to be installed separately.\r
  20 You will also need to have a Java Runtime Environment version 1.3.x or above.\r
  21 \r
  22     tools\fop\          - the fop processor (for PDF generation)\r
  23     tools\xsl\          - the docbook xsl files from sourceforge\r
  24     tools\                      - xsl processor, hhc.exe, ...\r
  25 \r
  26 you can download all the required tools as a 7-Zip package from the TortoiseSVN project:\r
  27 <https://osdn.net/projects/tortoisesvn/storage/build%20tools/>\r
  28 Use 7-zip extract the tools-*.7z file to e.g. \TortoiseGit\Tools. You might want to\r
  29 place your tools directory somewhere else on your harddisk, if you want to use it\r
  30 to build other docs too. This will, however, require tweaking the build scripts.\r
  31 \r
  32 Please note that having spaces in your directory path will (for the time being)\r
  33 cause the documentation build process to fail.\r
  34 \r
  35 For chm docs you need:\r
  36 - Microsofts makehm.exe, Part of visual studio, sources available on msdn\r
  37 - Microsofts html workshop, Binaries available on msdn\r
  38 \r
  39 If you want to update the git-man pages see [source/en/TortoiseGit/git_doc.patch](doc/source/en/TortoiseGit/git_doc.patch).\r
  40 \r
  41 \r
  42 Structure\r
  43 ---------\r
  44 The most important directories for you are:\r
  45 \r
  46     source\en - contains the english XML text source.\r
  47     images\en - contains the base (english) images for the docs\r
  48     xsl\          - contains the stylesheets for the doc creation\r
  49     dtd\      - contains the tools and the dtd to validate and build the docs.\r
  50 \r
  51 Please see [Screenshots.txt](doc/Screenshots.txt) for notes on how to create screenshots.\r
  52 \r
  53 Building the docs\r
  54 =================\r
  55 \r
  56 NAnt Build\r
  57 ----------\r
  58 \r
  59     VS->Tools->Visual Studio 2013 command line\r
  60     cd TortoiseGit\r
  61     cd doc\r
  62     ..\tools\nant\nant.exe\r
  63 \r
  64 A NAnt build script has been provided to build the docs. When doc.build is run for\r
  65 the first time, the template doc.build.include.template is copied to doc.build.include.\r
  66 \r
  67 For local customisations, copy the doc.build.user.tmpl file to doc.build.user and\r
  68 modify that copy to point to the location of the tools on your system.\r
  69 \r
  70 All other parameters are defined in doc.build.include. You can override all settings\r
  71 in doc.build.user or via the NAnt command line.\r