19.2.2 Making OmniHelp viewer control files available

Your DITA2Go distribution includes the following OmniHelp viewer control-file directories:

%OMSYSHOME%\common\system\omnihelp\ohvhtm (for HTML output)

%OMSYSHOME%\common\system\omnihelp\ohvxml (for XHTML output)

Choose the control-file directory that matches your choice of start-up project file type (see §19.2.1 Choosing XHTML vs. HTML OmniHelp control files), and copy all the files to the corresponding local directory, one of:

%OMSYSHOME%\common\local\omnihelp\ohvhtm (for HTML output)

%OMSYSHOME%\common\local\omnihelp\ohvxml (for XHTML output)

If you modify any OmniHelp viewer files, modify only the files in the local directory. Files in the system directory will be overwritten every time you update DITA2Go. Do not rename any of these files.

Unless you copy viewer files to some other location, you should not need to specify a path to those files. However, if you do put them somewhere other than the local viewer directory, you must specify the path to this other location:

[OmniHelpOptions]
; OHViewPath = path to dir containing the OH viewer files
OHViewPath = D:\path\to\ohview\files

The default value of OHViewPath depends on the value of OHProjFileXhtml (see §19.2.1 Choosing XHTML vs. HTML OmniHelp control files): 

OHProjFileXhtml

OHViewPath default value

No
%OMSYSHOME%\common\system\omnihelp\ohvhtm
Yes
%OMSYSHOME%\common\system\omnihelp\ohvxml

When you finish running DITA2Go, for viewing your OmniHelp system, copies of the control files must be included in the same final directory as the OmniHelp HTML or XHTML output files; see §19.13 Assembling OmniHelp files for viewing.

Previous Topic:  19.2.1 Choosing XHTML vs. HTML OmniHelp control files

Next Topic:  19.2.3 Customizing OmniHelp viewer control files

Parent Topic:  19.2 Setting up OmniHelp viewer control files

Sibling Topics:

19.2.1 Choosing XHTML vs. HTML OmniHelp control files

19.2.3 Customizing OmniHelp viewer control files

19.2.4 Examining generated control and data files