update images and documentation
[TortoiseGit.git] / doc / Aspell / Readme.txt
blob1678c131f277417bbab858a0b18e689e552db780
1 Install Aspell and all the Aspell dictionaries you need.\r
2 The Windows port is not currently maintained, but you can get\r
3 the 0.5 version from http://aspell.net/win32/\r
4 This has installers for the program and the dictionaries.\r
5 \r
6 Activate spellchecking by setting two properties in doc/doc.build.user.\r
7 \r
8 <property name="spellcheck" value="true"/> \r
9 <property name="path.spellcheck" value="C:\Path\to\your\Aspell.exe"/>\r
11 You may have to use the DOS 8.3 version if the path includes spaces,\r
12 as the Aspell.bat batch file doesn't handle them well.\r
13 eg. for the default installation use:\r
14 <property name="path.spellcheck" value="C:\Progra~1\Aspell\bin\aspell.exe"/>\r
16 This folder contains spellchecker dictionaries for Aspell. \r
17 One for each language and a generic template file that is copied to each language.\r
19 TortoiseGit.tmpl.pws:\r
20   Generic dictionary of terms & Keywords used in the TortoiseGit manual. \r
21   This file is language independent and is copied to each target language \r
22   (named temp.pws), when the translation takes place.\r
24 de.pws, en.pws, ...:\r
25   Dictionaries of terms for each language.\r
27 The process is still kludgy:\r
28 - Aspell doesn't work for Asian languages (yet). No fix available.\r
29 - It needs a batch file to run Aspell from nant due to IO \r
30   redirection problems. No fix found for this.\r
31 - It will fail if <NN>.pws doesn't exist yet. \r
32   Create a text file <NN>.pws that just contains the line:\r
33   "personal_ws-1.1 <NN> 0" where <NN> is the country code.\r
34   Look in de.pws or en.pws for examples. \r
35   Add your terms after this line.\r
37 The output of the spellchecking process is written to "spellcheck_<NN>.log".\r