HTML Help Workshop: Meaningful index results

Posted on 2007-07-30
Last Modified: 2012-06-27

Say I have a topic XYZ that appears on three separate pages of a .CHM I'm building using HTML Help Workshop. In the final .CHM file, if I click on XYZ in the index it lists all three places where the topic appears in the final file. But the titles shown in the index aren't always helpful. It appears the problem occurs when the target of the link is an anchor within a page.

Checking the XML file created, I see:
          <param name="Name" value="Device Address">  
          <param name="Local" value="address.htm">
will make an entry of "Device Address", but
          <param name="Name" value="Serial Panel">  
          <param name="Local" value="serial.htm#addr">
will make a link of "XYZ" instead of "Serial Panel." If I have all three references as anchor links, all three references will show up in the index as XYZ, with no way to distinguish them without following each link to see where they go.

Is there any way to improve this functionality, to make it always use the page title, for example, whether the link is an anchor or not?


-- b.r.t.
Question by:BarryTice
    LVL 7

    Accepted Solution

    Hallo Barry,

    I think this will always occur if your index is binary. If you toggle off  binary mode, you should be able to specify what appears in the Topics Found  dialog by editing the .HHK file entries. Specifically the (param name="Name" value=) line that precedes each (param name="Local" value=) line.
    Code Sample from a *.HHK file working for me with :
          <LI> <OBJECT type="text/sitemap">
                <param name="Name" value="AnchorSample">
                <param name="Name" value="How to jump to a anchor - Sample">
                <param name="Local" value="Thema_Tiere\jump_to_anchor.htm#AnchorSample">
                <param name="Name" value="How to jump to a anchor - Second Sample">
                <param name="Local" value="Thema_Tiere\jump_to_anchor.htm#SecondAnchor">

    Check the [OPTIONS] section of your *.HHP file and set Binary Index=No and re-compile:
    Binary Index=No

    You know you can edit the *.hhk and *.hhk files by your preferred text editor like Notepad.

    AFAIK there is an annoying problem if the keyword appears in more than one HTML document in combination with anchors. Hope Binary Index=NO is working for you.
    Best regards
    Ulrich Kulle
    LVL 9

    Author Comment

    Thanks, Ulrich! That was exactly it.

    What does having non-binary indexing lose me?
    LVL 7

    Expert Comment

    Hallo Barry,

    the index is more compressed and faster for large CHM's with many index items.

    Binary Index=Yes must be Yes for some HTML Help features to work like merging CHM's = "Modular Help".

    Large help systems can be broken into smaller sub-systems (Modular Help) while still presenting a single help system to the user. Each project must enable the "Binary Index" in order for index merge to work. A binary index will not be created if you select 1.0 as the version in the Compatibility box > Compiler tab > Project Options dialog or if the Create a binary index check box is cleared.

    Best regards and take care
    Ulrich Kulle

    Featured Post

    How to run any project with ease

    Manage projects of all sizes how you want. Great for personal to-do lists, project milestones, team priorities and launch plans.
    - Combine task lists, docs, spreadsheets, and chat in one
    - View and edit from mobile/offline
    - Cut down on emails

    Join & Write a Comment

    I use more than 1 computer in my office for various reasons. Multiple keyboards and mice take up more than just extra space, they make working a little more complicated. Using one mouse and keyboard for all of my computers makes life easier. This co…
    Using SQL Scripts we can save all the SQL queries as files that we use very frequently on our database later point of time. This is one of the feature present under SQL Workshop in Oracle Application Express.
    This tutorial walks through the best practices in adding a local business to Google Maps including how to properly search for duplicates, marker placement, and inputing business details. Login to your Google Account, then search for "Google Mapmaker…
    Viewers will learn how to use the Hootsuite Dashboard.

    732 members asked questions and received personalized solutions in the past 7 days.

    Join the community of 500,000 technology professionals and ask your questions.

    Join & Ask a Question

    Need Help in Real-Time?

    Connect with top rated Experts

    25 Experts available now in Live!

    Get 1:1 Help Now