17.2.6 Setting basic WinHelp
options in the configuration file
When you set up a WinHelp project, you must provide
your own WinHelp.hpj file, and add or modify
the configuration settings as follows:
- For each heading format that
starts a topic, specify properties:
[HelpStyles]
; style = key list, where list members are separated
; by spaces only
ParaFmt = Property1 Property2 Property3 ...
where:
ParaFmt
|
is the name of the heading format
|
PropertyN
|
is a help style attribute, such as Topic, Browse, or Key.
|
- For each topic-starting heading
format that should appear in the .cnt file, specify a Contents
level. For example:
[HelpCntStyles]
ParaFmt=Contents level
See §17.12.2.1
Understanding WinHelp contents level numbers.
- Specify whether you want a combined .cnt file:
[HelpOptions]
; MakeCombinedCnt = Yes (default, when processing from open book)
MakeCombinedCnt=Yes
- Specify whether you want to run the help compiler
automatically as the last conversion step (not recommended for
large projects); if so, provide a name for the help project file:
[Automation]
; CompileHelp = No (default, run help compiler separately), or Yes
CompileHelp=Yes
[HelpOptions]
; HPJFileName = name of .hpj to use when compiling help
HPJFileName=myproj.hpj
To have DITA2Go copy the .hpj file to another directory
after generating output files, specify the following:
[Automation]
WrapAndShip=Yes
; WrapPath = path to dir for compiling and distribution,
; default is output dir
WrapPath=.\help
See §44.6
Assembling files for distribution.
Previous Topic: 17.2.5 Accommodating
platform differences
Next Topic: 17.2.7 Handling
page breaks and section breaks
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.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