### 19.13 Assembling OmniHelp files for viewing

By default, DITA2Go copies all files with the following extensions from the project directory to the wrap directory (see §44.2 Activating and logging production of deliverables):

*.htm *.css *.js *.gif *.jpg *.png

You can change the list of files to be copied; see §44.6 Assembling files for distribution. DITA2Go automatically copies the necessary OmniHelp viewer files from the viewer-control directory to the wrap directory, according to the value of OHViewPath:

[OmniHelpOptions]
; OHViewPath = path to dir containing the OH viewer files

See §19.2.2 Making OmniHelp viewer control files available. By default, OHViewPath references the OmniHelp viewer files in one of the following directories:

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

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

If you put the viewer-control files somewhere else, you must specify the path (preferably absolute) to that location as the value of OHViewPath. Do not place the viewer-control files under the wrap directory. DITA2Go copies the files listed in Table 19-4 from the directory designated by OHViewPath to the directory designated by WrapPath, if specified, otherwise to the project directory.

Table 19-4 OmniHelp viewer files copied from OHViewPath to WrapPath

Start-up file type | OmniHelp viewer files copied to wrap directory by default
HTML | oh*.*
XHTML | ox*.htm ox*.js oh*.css oh*.js

The start-up file type (HTML or XHTML) determines which set of files will be copied; see §19.2.1 Choosing XHTML vs. HTML OmniHelp control files.

To have DITA2Go copy additional files to the wrap directory:

[OmniHelpOptions]
; OHVFiles = list of files to copy from OHViewPath (the viewer files).
OHVFiles = oh*.* some\other\files yet\more\files ...

The file specifications you assign to OHVFiles must be separated by spaces, and no spaces are allowed within a file specification. You can use wildcards in file specifications, and include absolute or relative paths to indicate where viewer files should be copied from. Relative paths are relative to the wrap directory.

The files you list for OHVFiles will be copied in addition to the files listed in Table 19-4. If you are not adding any special files of your own, there is no need to include a setting for OHVFiles. When you do not provide a setting for OHVFiles, the default value is based on the setting for OHProjFileXhtml; see §19.2.1 Choosing XHTML vs. HTML OmniHelp control files.

See also:

§16.2.2 Compiling and distributing Help systems

§44.6 Assembling files for distribution

Previous Topic: 19.12.4 Deciding when to merge OmniHelp subprojects

Next Topic: 19.14 Deploying OmniHelp

Parent Topic: 19. Generating OmniHelp

Sibling Topics:

19.1 Understanding how OmniHelp works

19.2 Setting up OmniHelp viewer control files

19.3 Setting up an OmniHelp project

19.4 Using CSS with OmniHelp

19.5 Customizing OmniHelp display features

19.6 Choosing navigation features for OmniHelp

19.7 Configuring contents and index for OmniHelp

19.8 Providing related-topic links in OmniHelp

19.9 Jumping to secondary windows in OmniHelp

19.10 Configuring full-text search for OmniHelp

19.11 Setting up CSH for OmniHelp

19.12 Merging OmniHelp projects

19.14 Deploying OmniHelp

Table of Contents • Index