9.13 Assembling OmniHelp files for viewing

To have Mif2Go automatically copy OmniHelp output files to another folder for viewing or distribution, specify the following:

[Automation]

WrapAndShip = Yes

WrapPath = ./dist

If you specify a value for WrapPath (absolute or relative to the project folder), by default Mif2Go copies files with the following extensions from the project folder to the folder designated by WrapPath:

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

You can change the list of files to be copied; see §33.4 Assembling files for distribution.

To have Mif2Go automatically copy the necessary OmniHelp viewer files from the viewer-control folder to the WrapPath folder, specify a path to the viewer files:

[OmniHelpOptions]

; OHViewPath = path to dir containing the OH viewer files

OHViewPath = D:\path\to\ohview\files

See §9.2.2 Making OmniHelp viewer control files available.

OHViewPath can be an absolute path, or a path relative to the folder designated by WrapPath (or if WrapPath is not specified, relative to the project folder); however, do not place the viewer-control folder under the WrapPath folder.

When you specify a value for OHViewPath, Mif2Go copies the files listed in Table 9-4 from the folder designated by OHViewPath to the folder designated by WrapPath, if specified, otherwise to the project folder.

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

Start-up file type	Viewer files copied to WrapPath folder by default, via OHVFiles
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 §9.3.7 Specifying the start-up file type. However, if you want Mif2Go to copy additional files to the WrapPath folder, list them here, in addition to the file specifications shown in Table 9-4 for the start-up file type:

[OmniHelpOptions]

; OHVFiles = list of files to copy from OHViewPath (the viewer files).

OHVFiles = oh*.* someotherfiles yetmorefiles ...

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 §9.3.7 Specifying the start-up file type.

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.

Note: Viewer files are copied only if you specify a value for OHViewPath.

See also:

§6.2.4 Compiling and distributing Help systems

§33.4 Assembling files for distribution

---

> 9 Generating OmniHelp > 9.13 Assembling OmniHelp files for viewing