17.2.10 Compiling a WinHelp project

To compile the RTF files DITA2Go produces, you need Microsoft Help Workshop (hcw.exe). Make sure you have the latest version of Help Workshop. If hcw.exe is not on your system PATH, you must tell DITA2Go where to find it:

[HelpOptions]
; Compiler = path\to\hcw; can include run parameters
Compiler = hcw /c /e

You can have the compiler display a copyright statement and a compile date in the WinHelp Version Information dialog:

[HelpOptions]
HelpCopyright = your copyright statement
HelpCopyDate = Yes

For example:

[HelpOptions]
HelpCopyright = (c) 2001-2012 Omni Systems, Inc.
HelpCopyDate = Yes

These settings resulted in the following, displayed in the WinHelp Version Information dialog:

(c) 2001-2012 Omni Systems, Inc.
Monday, February 20, 2012 18:24:39

When you specify the following options in the configuration file, DITA2Go automatically runs the WinHelp compiler after generating output files:

[Automation]
; CompileHelp = No (default, run Help compiler separately), or Yes
CompileHelp=Yes

To have DITA2Go copy the .hpj file to another directory for compiling, specify the following:

[Automation]
; WrapPath = path to dir for compiling and distribution,
;  default is output dir
WrapPath=.\help

See §44.6 Assembling files for distribution.

Tell the Help compiler where to find graphics

If your graphics are in more than one place, you can add multiple BMROOT= entries to the [OPTIONS] section of your Help Project (.hpj) file. For example:

[OPTIONS]
BMROOT=..\MyGraphics
BMROOT=..\Test\Graphics

Previous Topic:  17.2.9 Integrating WinHelp from RoboHelp

Next Topic:  17.2.11 Checking WinHelp RTF files for DITA2Go version

Parent Topic:  17.2 Setting up a WinHelp project

Sibling Topics:

17.2.1 Setting up a WinHelp project

17.2.2 Deciding where to locate configuration settings

17.2.3 Preparing a document for conversion to WinHelp

17.2.4 Deciding whether to regenerate the WinHelp project file

17.2.5 Accommodating platform differences

17.2.6 Setting basic WinHelp options in the configuration file

17.2.7 Handling page breaks and section breaks

17.2.8 Providing multiple .hlp files

17.2.9 Integrating WinHelp from RoboHelp

17.2.11 Checking WinHelp RTF files for DITA2Go version

Table of ContentsIndex