#### 19.3.8 Getting OmniHelp supporting files in the right place

Before you can use the OmniHelp viewer, all OmniHelp supporting files must be placed in the same directory structure as the HTML or XHTML output files DITA2Go generates from your document. Supporting files include:

Viewer and control files

Graphics files

Optional files.

Viewer and control files

After you run DITA2Go, control files and viewer files must be copied from the viewer directory (see §19.2 Setting up OmniHelp viewer control files) to the final distribution directory for your project. DITA2Go can do this for you; see §19.13 Assembling OmniHelp files for viewing.

To view OmniHelp, the view directory must contain the following:

- all files marked Required in column View? in Table 19-1 (including either oh*.htm or ox*.htm, depending on the start-up file type; see §19.2.1 Choosing XHTML vs. HTML OmniHelp control files).
- all files listed in Table 19-2.

Graphics files

Graphics files must be placed either in the same directory as the generated OmniHelp HTML files, or in a subdirectory. If your graphics files are located elsewhere, they must be copied to the directory with the HTML files, or to a subdirectory.

To tell DITA2Go to fetch your referenced graphics:

    [Automation]
    WrapAndShip = Yes
    CopyOriginalGraphics = Yes

When CopyOriginalGraphics=Yes, DITA2Go follows the file paths in your DITA source to find the graphics files to copy.

To tell DITA2Go where to put copies of the graphics (for example):

    [Graphics]
    GraphPath = ./graphics

The path you specify for GraphPath should be relative to the wrap directory (see §44.3 Understanding path values for deliverables). This path will be used in HTML output, as the relative path from the HTML files to their referenced graphics. If you use backslashes in the path, DITA2Go converts them to forward slashes before inserting the references in your HTML output. If you specify CopyOriginalGraphics=Yes, DITA2Go copies graphics files to the directory specified by GraphPath, after generating HTML files.

See also:

§19.13 Assembling OmniHelp files for viewing.

§32.1 Locating graphics files for HTML

§44.7 Placing graphics files for distribution

Optional files

A browser loads optional files (marked Optional under View? in Table 19-1), only when you specify the features they support, via configuration settings. Your project might not require all the optional files. For example, if you do not want full-text search, you can omit ohfts.js from the OmniHelp view directory; and if you are not merging OmniHelp projects, you do not need ohmerge*.* in the view directory.

See §19.2 Setting up OmniHelp viewer control files.

Previous Topic: 19.3.7 Removing paths from interfile links for OmniHelp

Next Topic: 19.4 Using CSS with OmniHelp

Parent Topic: 19.3 Setting up an OmniHelp project

Sibling Topics:

19.3.1 Creating an OmniHelp project

19.3.2 Deciding where to locate configuration settings

19.3.3 Naming your OmniHelp project

19.3.4 Giving your OmniHelp project a title

19.3.5 Specifying the starting topic

19.3.6 Specifying memory requirements

19.3.7 Removing paths from interfile links for OmniHelp