17.6.2 Displaying graphics in pop-ups for WinHelp

Suppose you want one or more of the illustrations in your document to appear only in pop-ups, instead of in line with the text; and suppose you want the illustrations to appear only when a user clicks the figure caption. DITA2Go provides two ways to accomplish this:

The results of either method are as follows:

Note:  For either method to work, graphics to appear in pop-ups must have captions positioned below the graphics.

Using hypertext markers

To use hypertext PI markers for pop-up graphics (see §17.8.4 Using hypertext links for jumps and pop-ups):

  1. Embed a HyperAnchor PI marker with a unique name in the paragraph that holds the anchor for the graphic.
  2. Embed a corresponding HyperJump PI marker in the caption paragraph for the graphic.
  3. In the configuration file, set the following:
    [HelpStyles]
    FigAnchor=Topic Slide Scroll NoXScroll
    FigCaption=PopOver Green Resume
    

For this to work, every graphic must have a caption paragraph after the graphic, or at least some distinct paragraph format immediately following the graphic that can be assigned property Resume. Otherwise, the rest of the topic also appears in the pop-up.

Using format properties

To use format properties for pop-up graphics:

  1. Assign property MakeRef to the paragraph format that anchors the graphic.
  2. Assign property PrevRef to the caption paragraph, which must follow the graphic.

Configuration settings are as follows:

[HelpStyles]
FigAnchor=Topic Slide Scroll NoXScroll MakeRef
FigCaption=PopOver Green Resume PrevRef

Previous Topic:  17.6.1 Choosing a graphics format for WinHelp

Next Topic:  17.7 Configuring WinHelp topics

Parent Topic:  17.6 Managing graphics for WinHelp

Sibling Topics:

17.6.1 Choosing a graphics format for WinHelp