17.2.4 Deciding whether to regenerate the WinHelp project file

When you use DITA2Go to generate WinHelp, DITA2Go writes an .hpj project file during set-up, and rewrites it later only under certain conditions.

To specify whether DITA2Go should generate the .hpj project file anew each time you run the conversion:

[HelpOptions]
; WriteHelpProjectFile = Yes (write each time) or No; if no setting,
; write only if the file does not already exist.
WriteHelpProjectFile = Yes

The values you can specify for WriteHelpProjectFile have the following effects:

Yes

If the .hpj file is present, DITA2Go overwrites it.

No

DITA2Go does not overwrite the .hpj file.

(none)

If the configuration file contains no WriteHelpProjectFile setting at all, DITA2Go writes an .hpj file, but only if the .hpj file is not already present.

DITA2Go closes the .hpj file after writing it; however, if you had the .hpj file open in Help Workshop when DITA2Go rewrote it, you could get an access violation. (Notepad would just rewrite the old file over the rewritten one.)

If you set WriteHelpProjectFile=Yes and then later decide to modify the .hpj file, be sure to set WriteHelpProjectFile=No; otherwise your edits will be wiped out the next time you convert.

If you use Help Workshop to make changes that are not reflected in the configuration file, and they are changes you want to keep, you can prevent DITA2Go from overwriting them by setting WriteHelpProjectFile=No.

Previous Topic:  17.2.3 Preparing a document for conversion to WinHelp

Next Topic:  17.2.5 Accommodating platform differences

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.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.10 Compiling a WinHelp project

17.2.11 Checking WinHelp RTF files for DITA2Go version

Table of ContentsIndex