Apply my compiled CHM 1.x to Visual Studio IDE

Question

Hello,

I compiled the help for my component (class library) using Sandcastle and DocProject (chm). The file looks great. I do not know where to go from here. I built my component and added a reference to it from another class library. When I highlight a property or method of the referenced assembly, my help file is not used. I would rather not use any components from the forms namespace. How does Visual Studio know where to look for help? I added copies of my help file within different folders within my components file path including BIN, Debug, and Release. These components do not have a user interface and are utility classes and base classes for me to inherit from. I want to build reference information for me to utilize in the future. Any information is appreciated!
Thanks Dave!

Answer 1

After a weekend of research, I have not found that one can use a .CHM within the Visual Studio Help system. I have found that one must use the upgraded version of the help files, version 2. With the Visual Studio SDK, one can compile version 2 help files, create projects through the wizard, and distribute their help system to other developers through a setup and deployment process similar to a basic Windows application. I am going to have to research further because the projects created by the wizard needed an in-depth knowledge of their interface, and as the end result, the compiled projects were installed like an application. (.ie c:\Program Files\MyHelpDocumentation\) which is nice for finished products, but is not suited for those who build resusable components on a daily basis. Althought it seems, I can install a "base" help system and add to it as I complete components, it does not seem to be a simple task to just add to a help namespace. Trial and error it will have to be.

In sum, as of 10-27-2009 this is what I know:

1. Must use version 2 of help
2. Wizard builds and adds (2) setup and deployment projects to your solution.
3. These projects need to be setup and deployed into a users directory as an application.
4. Rather in-depth.
5. More complicated than it needs to be.

Just keep documenting your components/procedures/members. In the future, there may be an easier solution.

-dave klem

Answer 2

Hi Dave,

Yep, you've about got it.  You can search the forums here for more discussions and links to useful articles about Help 2.x and the Visual Studio help system in general.  Hopefully Help 3.x for VS 2010 will be easier to use and deploy.

- Dave

---

http://davesexton.com/blog

Answer 3

Wow! Dave Sexton himself!! Thanks for your code work on codeplex!!!!!
Very professional!

Yes suuurrrr! I will keep documenting and compiling with Sandcastle/DocProject. I think their output is more than sufficient.

Thanks again!

-Dave Klem