#### 17.7.2 Assigning properties to formats for topics and hotspots

Assign properties for topics and hotspots as follows:

    [HelpStyles]
    ; style = key list, where list members are separated by spaces only
    Format=StartingProperty FollowingProperty1 FollowingProperty2 ...

Properties for topics and hotspots are assigned to the following formats:

Topic | Starting paragraph format; see §17.7.1 Creating WinHelp topics
Hotspot | Delimiting character (or paragraph) format; see §17.8.2 Creating hotspots for jumps and pop-ups in WinHelp.

Table 17-1 shows which properties you can assign to formats as starting and following properties for topics and hotspots. Table 17-2 shows the effects of the properties you assign.

Table 17-1 Starting and following format properties for topics and hotspots

Type | Starting | Following
Topic |
    PopContent
    AKey Delete Key SpKey Suffix
    JumpTarget
    AKey Contents Delete Key Local1 Resume SpKey Suffix
    Topic
    AKey Browse Build Contents Delete Key Macro MakeRef
    NoScroll NoTitle NoXScroll Refer Scroll Slide SpKey
    Suffix TitleSuf Window XScroll
Hotspot |
    AKey
    Delete Key Resume SpKey
    Delete
    AKey Key Resume SpKey Suffix
    JumpHot
    AKey Delete File Green Key Local Resume SpKey Suffix
    Uline Window
    Key
    AKey Delete Resume SpKey
    MacroHot
    AKey Delete Green Key Resume SpKey Uline
    ParaLink
    Resume
    PopHot
    AKey Delete File Green Key Local Resume SpKey Suffix
    Uline
    PopOver
    AKey Delete Green2 Key ParaLink PrevRef Resume SpKey
    Suffix Uline2
    Replace
    AKey Key Resume SpKey Suffix
    Resume
    Delete
    SpKey
    AKey Delete Key Resume
1 Within current topic only. 2 Applied to cross references or hypertext links.,

Table 17-2 Effects of format properties on topics and hotspots

Property | Effect
    AKey
| Adds the topic title as an “A” footnote. See §17.10.2 Adding ALinks and KLinks with PI markers.
    Browse
| Includes the topic in the browse sequence; DITA2Go creates the “+” footnote. See §17.13 Creating browse sequences.
    Build
| Specifies a “build tag” for the topic, defined in the .hpj file, which is used to enable conditional compilation of different Help-file versions. The build tag name is in the [HelpTopicBuildStyles] section, as format=buildtag; DITA2Go creates the “*” footnote.
    Contents
| Includes the topic (as a page, book, or both) in the WinHelp .cnt file produced by DITA2Go. See §17.12 Configuring contents for WinHelp.
    Delete
| Suppresses appearance in the output of text in the assigned format. Tables and graphics anchored in a suppressed paragraph are retained; see §17.3.1 Suppressing unwanted paragraphs.
    File
| Directs the jump or pop-up to a topic in a different .hlp file.
    Green
| Makes a hotspot green and underlined. See §17.8.2.1 Configuring jump vs. pop-up hotspots.
    Key
| Adds the topic title as a keyword, so it appears in the WinHelp index. See §17.10.3 Adding related-topic keywords with formats.
    Local
| Produces a reference string that is local to the topic, so the same term can be used in more than one topic in the same .hlp file.
    Macro
| Specifies an entry macro for the topic; this macro is run whenever the topic is selected. The macro text appears in the [HelpMacroStyles] section, as format=macro; DITA2Go creates the “!” footnote. See §17.9 Invoking WinHelp macros.
    MakeRef
| Creates a unique reference tag for the current paragraph, to use as a pop-up or jump destination for a PrevRef paragraph; see §17.6.2 Displaying graphics in pop-ups for WinHelp.
    NoScroll
| Prevents the topic title from scrolling; overrides [HelpOptions]TitleScroll=Yes. See §17.7.3.2 Deciding whether to scroll titles
    NoTitle
| Prevents the topic title from being displayed; when applied to a pop-up topic, prevents the topic from appearing in full-text search.
    NoXScroll
| Overrides [HelpOptions]ExtendHelpNoScroll=No for pop-ups. See §17.7.3.2 Deciding whether to scroll titles.
    PrevRef
| Uses the previous unique reference (MakeRef) tag as a pop-up or jump destination for the whole paragraph or character span; if also PopOver, it is a pop-up. See §17.6.2 Displaying graphics in pop-ups for WinHelp.
    Replace
| Deletes the content, which is replace by the RTF code in [HelpReplacements].
    Refer
| Includes the topic name in a slightly modified form as a reference string for the topic. The modification consists of removing spaces and any characters other than letters, numbers, and underscores. DITA2Go creates the “#” footnote for you. Omit this property if the topic is accessed only from cross references or hypertext links, and from the Contents.
    Resume
| If the topic being processed is a sliding topic, causes that topic to end and the topic that preceded the sliding topic to continue. See §17.7.1 Creating WinHelp topics.
    Scroll
| Causes the topic title to scroll; overrides [HelpOptions]TitleScroll=No. See §17.7.3.2 Deciding whether to scroll titles.
    Slide
| Makes the topic a sliding topic. See §17.7.1 Creating WinHelp topics.
    SpKey
| Produces a keyword footnote designated with a different letter (neither “A” nor “K”) See §17.10.3 Adding related-topic keywords with formats.
    Suffix
| Differentiates character formats that use the same hotspot text but different references, by adding a suffix string; use the keyword Suffix for the formats, and add entries for those formats in [HelpSuffixStyles]format=Suffix text.
    TitleSuf
| Becomes a suffix to the topic title, to further define or categorize the topic; for example, for glossary terms. In [HelpStyles], use the keyword TitleSuf for the format, and add an entry for the format in [HelpTitleSufStyles]format=Suffix text. See §17.7.3.1 Categorizing titles.
    Topic
| Ends any prior topics and starts a new topic. DITA2Go creates the WinHelp topic start coding, a page break, and a title ($) footnote, using the tagged text as the title. See §17.7.1 Creating WinHelp topics.
    Uline
| Underlines a hotspot without turning it green.
    Window
| Makes the topic appear in a specific window, defined in the .hpj file, when it is accessed from the Index or Find tabs, or from an ALink or KLink macro; but not when it is selected from a jump or from the Contents. The name of the window appears in the [HelpWindowStyles] section, as format=Window; DITA2Go creates the “>” footnote. See §17.8.6 Specifying jumps to secondary windows in WinHelp.
    XScroll
| Overrides [HelpOptions]ExtendHelpNoScroll=Yes for pop-ups. See §17.7.3.2 Deciding whether to scroll titles.

Previous Topic: 17.7.1 Creating WinHelp topics

Next Topic: 17.7.3 Configuring topic titles for WinHelp

Parent Topic: 17.7 Configuring WinHelp topics

Sibling Topics:

17.7.1 Creating WinHelp topics

17.7.3 Configuring topic titles for WinHelp

Table of Contents • Index