19.9 Jumping to secondary windows in OmniHelp

To create a jump to a secondary window in OmniHelp, assign the window name to a character or paragraph format. For example:

[SecWindows]
; doc format = name of secondary window to use for jumps from
;  within the span marked by this style (same as WinHelp usage).
PopWindow=popup, 400, 200
ProcWindow=proc
ProcWin2=proc, 400, 600, menubar=1,titlebar=1,scrollbars=1

Window parameters

After the window name you can specify optional comma-separated parameters. The first is width in pixels, the second height in pixels, and the third a list of properties to pass to the JavaScript window.open() function. The JavaScript properties are also comma-separated, but unlike the size parameters, JavaScript parameters cannot have spaces between them; see a JavaScript reference for acceptable values.

Pop-up windows

The window name popup is reserved for specifying pop-ups, and results in a fresh pop-up window every time. In OmniHelp, a pop-up window persists until you close it; the window does not close when you click inside the pop-up (or click elsewhere), as is the case for pop-ups in other Help systems.

Links from secondary windows

To cause a link from a secondary window to bring up a new topic in the original topic window (rather than in the secondary window itself), assign reserved window name main to the hotspot format. For example:

[SecWindows]
Popup=popup, 300, 100
Link2FigWin=figure, 400, 200
Link2Main=main

In this example, a regular topic has cross-reference links to a pop-up window and to a secondary window:

In the pop-up topic, character format Link2Main is applied to a hotspot for a cross-reference link to a regular topic.

Note:  Not all browsers honor the parameters you specify for a pop-up window.

See also:

§16.7 Jumping to secondary windows in Help systems

§16.8 Creating pop-up topics for Help systems

Previous Topic:  19.8 Providing related-topic links in OmniHelp

Next Topic:  19.10 Configuring full-text search for 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.10 Configuring full-text search for OmniHelp

19.11 Setting up CSH for OmniHelp

19.12 Merging OmniHelp projects

19.13 Assembling OmniHelp files for viewing

19.14 Deploying OmniHelp