19.5.1 Configuring OmniHelp window usage and frameset dimensions

You can determine whether OmniHelp opens in a new browser window, or in the existing browser window. The default is to open in a new window:

[OmniHelpOptions]
; NewWindow = Yes (default, use settings below
;  for FrameHigh, FrameWide, and FrameOptions)
;  or No (use existing browser window)
NewWindow=Yes

If you are generating OmniHelp intended for local use, probably you want the OmniHelp frameset to open in a new window, without browser “chrome” (menus, toolbars, icons, and the like). However, see §19.14.3 Coping with browser quirks.

Close empty window

By default, the mostly empty browser window that opens initially remains open, behind the OmniHelp window. To close the initial browser window:

[OmniHelpOptions]
; CloseOldWindow = No (default)
;  or Yes (if NewWindow, close opening window)
CloseOldWindow=Yes

Some browsers ignore the CloseOldWindow option (Firefox, Netscape Navigator); others request confirmation before closing the window (Internet Explorer).

Configure frameset

When OmniHelp opens in a new window (the default), you can specify frame dimensions and positioning for the OmniHelp frameset:

[OmniHelpOptions]
;Frameset dimensions (in pixels) and properties
;FrameHigh=350
;FrameWide=600
; Frame dimensions, do not reduce any of them at all
;TopHigh=50
;LeftWide=220
;MidHigh=90
; TopFirst = Yes (top frame full width) or No (left frame full height)
TopFirst = Yes

Add chrome

You can use JavaScript to add bits of chrome:

[OmniHelpOptions]
; FrameOptions = JS window.open() values as in [SecWindows]

See §19.9 Jumping to secondary windows in OmniHelp. For more information, look up the window.open() function in any JavaScript reference.

Previous Topic:  19.5 Customizing OmniHelp display features

Next Topic:  19.5.2 Altering OmniHelp top navigation frame content

Parent Topic:  19.5 Customizing OmniHelp display features

Sibling Topics:

19.5.2 Altering OmniHelp top navigation frame content

19.5.3 Modifying OmniHelp navigation aids

19.5.4 Choosing whether to use cookies for OmniHelp

19.5.5 Localizing the OmniHelp interface

19.5.6 Modifying OmniHelp CSS classes

19.5.7 Modifying the OmniHelp template

Table of ContentsIndex