Visual Studio Development Bookmark and Share   
 index > Developer Documentation and Help System > Sandcastle. How do I register the help files to VS2005?
 

Sandcastle. How do I register the help files to VS2005?

Hello

I generated .chm file for my C# class library with Sandcastle March CTP and Sandcastle Help File Builder.

Can any one explain how do I register the help file to VS2005 so that I can use context sensitive help (F1) when writing code that uses my class library?

zivn  Monday, March 19, 2007 5:42 PM

Hi zvin,

Along with Eric and Ulrich's suggestions, please take a look at these two different ways to transform a MSHelp1 (chm) to MSHelp2 (.msi/.exe) integration package for the Visual Studio 2005 Combined Help Collection. As a first step, you will need to download and install the latest version of the Microsoft Visual Studio 2005 SDK to accomplish this:

Visual Studio SDK 4.0 February 2007 RTM located at this MSFT download address:

http://affiliate.vsipmembers.com/affiliate/downloadFiles.aspx

Conversion and Integration Tools:

  1. HelpStudio Lite (made by Innovasys), which comes packaged with the Visual Studio SDK.
    1. Please read the Help documentation included with this package to get started.
  2. Helpware FAR HTML (made by MSFT Help MVP Rob Chandler) + the Visual Studio 2005 Help Integration Wizard (which comes with and is installed as part of the Visual Studio SDK) + the Visual Studio 2005 IDE Solution Explorer tool (which is part of Visual Studio 2005)
    1. Download and install  the free trial version of Helpware FAR HTML from: http://www.helpware.net/FAR/index.html
    2. Please go to my Fast Track tutorials located at http://frank.helpware.net
    3. Click on Go to the Fast Track Tutorials
    4. Click on MSHelp2 Conversion and Integration Using Helpware FAR and Microsoft Visual Studio 2005.
    5. Follow the Step by Step process in each Phase of the Conversion and Integration process.

Hope this helps,

Frank

Frank Palinkas  Tuesday, March 20, 2007 5:20 PM

I don't think you can register a CHM file with VS2005. It has to be an HTML Help 2 file (Hxs). There are some manual steps you have to take in order to make it ready and register it. Search the forum here as there are some posts on how to do it.

Eric

EWoodruff  Monday, March 19, 2007 6:50 PM

Hello zivn,

in addition to Eric's posting you maybe interested for H2REG to register Help2 (.HxS) files to VS2005. Have a look at:

http://www.helpware.net/mshelp2/h2reg.htm

Best regards
Ulrich Kulle

Ulrich Kulle  Tuesday, March 20, 2007 7:56 AM

Hi zvin,

Along with Eric and Ulrich's suggestions, please take a look at these two different ways to transform a MSHelp1 (chm) to MSHelp2 (.msi/.exe) integration package for the Visual Studio 2005 Combined Help Collection. As a first step, you will need to download and install the latest version of the Microsoft Visual Studio 2005 SDK to accomplish this:

Visual Studio SDK 4.0 February 2007 RTM located at this MSFT download address:

http://affiliate.vsipmembers.com/affiliate/downloadFiles.aspx

Conversion and Integration Tools:

  1. HelpStudio Lite (made by Innovasys), which comes packaged with the Visual Studio SDK.
    1. Please read the Help documentation included with this package to get started.
  2. Helpware FAR HTML (made by MSFT Help MVP Rob Chandler) + the Visual Studio 2005 Help Integration Wizard (which comes with and is installed as part of the Visual Studio SDK) + the Visual Studio 2005 IDE Solution Explorer tool (which is part of Visual Studio 2005)
    1. Download and install  the free trial version of Helpware FAR HTML from: http://www.helpware.net/FAR/index.html
    2. Please go to my Fast Track tutorials located at http://frank.helpware.net
    3. Click on Go to the Fast Track Tutorials
    4. Click on MSHelp2 Conversion and Integration Using Helpware FAR and Microsoft Visual Studio 2005.
    5. Follow the Step by Step process in each Phase of the Conversion and Integration process.

Hope this helps,

Frank

Frank Palinkas  Tuesday, March 20, 2007 5:20 PM

You can use google to search for other answers

Custom Search

More Threads

• SandCastle: Topics for methods on classes not found by hitting F1
• Spastic curser in help system
• Converting from Visual studio 2005 XML doc to HTML Help or CHM
• Using PerformanceCounter with Process with multiple instance running
• How to bug fix the VS / VB Code Generator
• Non-displayable text in Document Explorer
• C# Classes to XSD with XS:annotation / xs:documentation
• Microsoft.SharePoint.Portal.SiteData and Microsoft.SharePoint.Portal.Topology are obsolete
• VC2008 PRO Custom Build
• Set font size ih Help, but not in IE