INSTALL.Windows

   1 Building Dasher for Microsoft Windows\r
   2 =====================================\r
   3 \r
   4 Prerequisites\r
   5 -------------\r
   6 \r
   7 Microsoft Speech SDK\r
   8 Microsoft Tablet SDK\r
   9 Microsoft Windows SDK v5.0\r
  10 Expat XML Parser\r
  11 \r
  12 The Speech, Tablet, and Windows SDKs can be installed individually, or as part \r
  13 of the Platform SDK.  Downloads can be found at http://www.microsoft.com and \r
  14 http://expat.sourceforge.net\r
  15 \r
  16 The project files use environment variables to locate the root directories of \r
  17 the prerequisites.  You can set these in the Windows control panel: \r
  18 Control Panels->System->Advanced->Environment Variables.\r
  19 \r
  20 Here are the variable names and their default install locations (you may\r
  21 need to change these to reflect reality on your system):\r
  22 \r
  23 SPEECHSDK      C:\Program Files\Microsoft Speech SDK 5.1\r
  24 TABLETSDK      C:\Program Files\Microsoft Tablet PC Platform SDK\r
  25 EXPAT          C:\Program Files\Expat 2.0.1\r
  26 MICROSOFTSDK5  C:\Program Files\Microsoft SDKs\Windows\v5.0\r
  27 \r
  28 Additional Prerequisits For Building HTML Help\r
  29 ----------------------------------------------\r
  30 \r
  31 If you aren't building a release, and don't otherwise want to build the Windows\r
  32 help (.chm) file, you can ignore these and disable the 'Manual' project in the \r
  33 solution. This project is only built for the 'Release' configurations anyway.\r
  34 \r
  35 LibXML2\r
  36 docbook-xsl\r
  37 Microsoft HTML Help Workshop\r
  38 \r
  39 LibXML2 is available at: http://www.zlatkovic.com/libxml.en.html. The minimum \r
  40 requirement here is xslproc.exe, which can be installed along with the required\r
  41 dependencies by copying the contents of the bin directories from the libxml and \r
  42 libxslt packages to (eg) C:\Program Files\LibXML2. If you want to be able to \r
  43 use these libraries more generally you should probably put them somewhere in \r
  44 the system wide library path.\r
  45 \r
  46 These need a few more environment variables\r
  47 \r
  48 LIBXML         C:\Program Files\LibXML2\r
  49 DOCBOOK_XSL    C:\Program Files\docbook-xsl-1.73.2\r
  50 HELP_COMPILER  C:\Program Files\HTML Help Workshop\hhc.exe\r
  51 \r
  52 Note that the last of these must be the full path of the compiler executable. This\r
  53 is due to technical limitations connected with hhc.exe (a) doing a bad job of \r
  54 parsing the command line and (b) giving a non-zero return value on success.\r
  55 \r
  56 ** NOTE **\r
  57 The automated build step doesn't (yet) handle the image files, so you'll need to \r
  58 manually copy Data\Help\Gnome\C\figures to Data\Help\Win32 before building.\r
  59 \r
  60 Building\r
  61 --------\r
  62 \r
  63 Visual Studio 8.0 (2005) solution/project files are included in the \r
  64 Src/Win32 directory. This should hopefully build without modification on \r
  65 any system.\r
  66 \r
  67 For earlier versions of Visual Studio, alternative project files are\r
  68 provided, although these may be out-of-date. Please consider the 8.0\r
  69 files to be authoritative, and port any modifications to that if possible \r
  70 (or at least tell us so we can do it).\r
  71 \r
  72 Building the installers\r
  73 -----------------------\r
  74 \r
  75 To build the installer MSI files, you need to install the Windows Install \r
  76 XML (WiX) toolset, from http://wix.sourceforge.net/.  For Visual Studio\r
  77 2005, you first should install "ProjectAggregator" and then the 3.0 (beta)\r
  78 version of WiX.  If it installs successfully, you should see "Windows \r
  79 Installer XML Version 3.0" listed in the about box of Visual Studio.\r
  80 \r
  81 setup.exe\r
  82 ---------\r
  83 \r
  84 The installation itself is carried out by a small utility, setup.exe, which \r
  85 downloads the .msi file and installs it. This is (a) to ensure that the\r
  86 correct version of the Windows Installer is present, and (b) to make sure\r
  87 that the installer is run with the right options to enable the desired\r
  88 upgrade behaviour.\r
  89 \r
  90 The setup.exe binary is built from source shipped as part of the MS Platform\r
  91 SDK, as si MSIStuff, which is a utility for configuring the resulting\r
  92 binary. The whole process is described in MS KB article 888473:\r
  93 \r
  94 http://support.microsoft.com/kb/888473