Skip to main content
Known Participant
May 12, 2010
Answered

Is a CHM file appropriate for my project?

  • May 12, 2010
  • 26 replies
  • 4216 views

Hi,

I've been asked to document our API codes in a help file to be provided to customers. Is a CHM file the most appropriate way to go?

Also, can pages in the CHM file be bookmarked? This is one of the requirements and as far as I can see, they cannot be.

If not CHM, I would appreciate any recommendations for output that I can generate with RoboHelp8.

Related question: in a CHM file that I just generated, the topic content is not displayed. I am receiving pages with the error message: The address is not valid. Again, would appreciate understanding why this is occurring.

Thanks very much,

DGR

    This topic is closed to new replies. Start a new post to keep the conversation going.
    Correct answer RoboColum_n_

    CHM files are designed to be installed locally on each users PC, something that more than likely explains your related question, typically as part of an application. As they are installed locally, it means updating is more difficult. Web based output (e.g. WebHelp) is stored on an intranet, server or web location and can therefore be more easily updated. It sounds like you may be better to go the WebHelp route but without knowing more detail that decision is best left in your court.

    As for "bookmarks", do you mean the ability for a user to store a page of the help that they can refer to again at a later date? If so, this can be achieved inside a CHM file. In the window properties inside your project, there is a "Tri-pane Tabs and Windows" section. In there is a Favorites option which when ticked adds a tab to the left hand tri-pane of the CHM. Adding a bookmark in this fashion is a little more complicated than in a browser, but it does work. It also has drawbacks in that the data behind these favourites is stored in a HH.DAT file. If this is deleted, the user looses their favourites as well as other information.

    Finally as I intimated earlier, CHM files are best run on a local drive. The reason for this is that Microsost issued a security update a few years ago rendering them next to useless unless they are. You can find further detail about this update here.


    • Read the RoboColum(n) for a tips, tricks and musings on the Technical Communication Suite products.
    • Follow the RoboColum(n) on Twitter

    26 replies

    Peter Grainge
    Community Expert
    Community Expert
    May 12, 2010

    Without realising it, you've almost answered your question. What you are probably seeing is what happens when a CHM is placed on a network drive. The location of your help is what drives the type.

    Stored on users PC = CHM (or AIR Help)

    Accessed from a server = WebHelp (or FlashHelp)

    To answer your question on bookmarks, what is the objective of the bookmarks? Is it just so that you can open the help at a specific topic? How to do that with WebHelp is on my site under Calling WebHelp.


    See www.grainge.org for RoboHelp and Authoring tips

    @petergrainge

    Use the menu (bottom right) to mark the Best Answer or Highlight particularly useful replies. Found the answer elsewhere? Share it here.
    RoboColum_n_
    RoboColum_n_Correct answer
    Legend
    May 12, 2010

    CHM files are designed to be installed locally on each users PC, something that more than likely explains your related question, typically as part of an application. As they are installed locally, it means updating is more difficult. Web based output (e.g. WebHelp) is stored on an intranet, server or web location and can therefore be more easily updated. It sounds like you may be better to go the WebHelp route but without knowing more detail that decision is best left in your court.

    As for "bookmarks", do you mean the ability for a user to store a page of the help that they can refer to again at a later date? If so, this can be achieved inside a CHM file. In the window properties inside your project, there is a "Tri-pane Tabs and Windows" section. In there is a Favorites option which when ticked adds a tab to the left hand tri-pane of the CHM. Adding a bookmark in this fashion is a little more complicated than in a browser, but it does work. It also has drawbacks in that the data behind these favourites is stored in a HH.DAT file. If this is deleted, the user looses their favourites as well as other information.

    Finally as I intimated earlier, CHM files are best run on a local drive. The reason for this is that Microsost issued a security update a few years ago rendering them next to useless unless they are. You can find further detail about this update here.


    • Read the RoboColum(n) for a tips, tricks and musings on the Technical Communication Suite products.
    • Follow the RoboColum(n) on Twitter
    DGR2Author
    Known Participant
    May 12, 2010

    Thanks very much for all the help and advice!