19.2.3 Customizing OmniHelp viewer control files

Table 19-1 lists the OmniHelp viewer control files. Files that have names that start with oh are for HTML output. Files with names that start with ox are for XHTML. In Table 19-1, the names of these files are shown as starting with o?. All other files listed are included in both archives.

To customize OmniHelp, you can edit control files marked Yes under Edit? in Table 19-1. If you are a JavaScript expert, you can also edit .js files marked No. Edit control files only if necessary.

If you intend to undertake extensive customization and distribute the results to third parties, you will also need the files in the following directory:

%OMSYSHOME%\common\system\omnihelp\ohvd2g

Copy all files from this directory to the following location:

%OMSYSHOME%\common\local\omnihelp\ohvd2g

Modify only the files in the local directory; those in the system directory will be overwritten every time you update DITA2Go.

Table 19-1 OmniHelp viewer control files included in the distribution

File type

File name

Content

View?

Edit?

Ref.

CSS

ohctie.css

CSS for IE for navigation panes

Req for IE

Yes

19.4

ohctn4.css

CSS for NN4 for navigation panes

Req for NN4

Yes

19.4

ohctn6.css

CSS for Mozilla for nav. panes

Firefox, etc.

Yes

19.4

ohctrl.css

Generic CSS for navigation panes

Required

Yes

19.4

HTML (?=h) or XHTML (?=x)

o?ctrl.htm

Loader for JavaScript

Required

No

19.3

o?frame.htm

Frameset

Required

No

19.3

o?main.htm

Loading... message

Required

No

 

o?merged.htm

Run-time project merging

Optional

No

19.12

o?nav.htm

Loading... message for IE

Req for IE

No

 

o?navctrl.htm

Another Loading... message for IE

Req for IE

No

 

o?top.htm

Top-navigation-pane loader

Required

No

19.5.1

JavaScript

ohctrl.js

Start-up and interfacing script

Required

No

19.3

ohframe.js

Frameset script

Required

No

19.3

ohfts.js

Search presentation script

Optional

No

19.6

ohidx.js

Index presentation script

Optional

No

19.7

o?lang.js

Text of error messages

Required

Yes

19.5.5

ohlangct.js

Text of control labels, etc.

Required

Yes

19.5.5

ohlangtp.js

Text of button labels

Required

Yes

19.5.5

ohmain.js

CSS-setting script for topic pane

Required

No

19.11

ohmerge.js

Script used in ohctrl.htm

Optional

No

19.12

ohmerged.js

Run-time merging script

Optional

No

19.12

ohrel.js

Related-topics presentation script

Optional

No

19.8

ohstart.js

Start-up script for project

Required

No

19.3

ohtoc.js

Contents presentation script

Optional

No

19.7

ohtop.js

Top-navigation-pane script

Required

No

19.5.1

Image

 

 

ohlogo.jpg

OmniHelp logo

Optional

No

 

ohtc*.gif

Icons for expandable TOC view

Optional

No

19.7

ohvalid?.gif

W3C validation icon

Optional

No

 

Previous Topic:  19.2.2 Making OmniHelp viewer control files available

Next Topic:  19.2.4 Examining generated control and data 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.2 Making OmniHelp viewer control files available

19.2.4 Examining generated control and data files