Comments on: Integrate XML code comments into Visual Studio 2005/2008 using Sandcastle and HTML Help 2.0

By: roney

roney — Wed, 22 Apr 2009 10:14:48 +0000

Dear Sir,
I need to make a windows application help file. In VS 2003 we find the tools from start-all programs-VS Help Work Shop. But in VS 2005 how can I make the help file.
Thank you.

By: David Keaveny

David Keaveny — Wed, 18 Feb 2009 01:59:39 +0000

Any word on how to get Sandcastle running on a build machine where you don’t want to install Visual Studio just so that you can install the MS Help 2.0 Compiler? I tried copying the C:\Program Files\Common Files\Microsoft Shared\Help 2.0 Compiler\ folder into my repository and point Sandcastle at that folder, but it fails with the following:

Compiling HTML Help 2.x file…
[C:\WINDOWS\Microsoft.NET\Framework\v3.5\MSBuild.exe]
Build2xHelpFile:
Compiler could not load message resources. Terminating.
D:\Build\Contracts\Development\Integration\doc\Working\Build2xHelpFile.proj(62,5): error MSB6006: "HXCOMP.EXE" exited with code 3.
Last step completed in 00:00:00.5156

There are some rather old articles on decoupling the help compiler from VS2005, but nothing up-to-date for those building .NET 3.5 projects.

By: Jessie

Jessie — Thu, 05 Feb 2009 08:03:49 +0000

Thanks!
That’s great summary what I found for the Sandcastle and help 2.0 integration.
BTW, do you have any idea how to plug-in my help to the other namesapce? Is it possible set any valuse in the Sandcastle?

Jessie

By: Michael

Michael — Wed, 14 Jan 2009 20:18:23 +0000

Great post. Thanks!

I’ve been through all the steps and everything works (my help 2.0 file/topics show up in vs2008 help system) except hitting F1 on my class method in code window doesn’t take me to the topic. Have I missed something?

Michael

By: Luiza

Luiza — Tue, 21 Oct 2008 09:33:20 +0000

Hello,

I have a question.
At step 3, what king of new project do you create ?

Luiza

By: Lewis Yancey

Lewis Yancey — Thu, 11 Sep 2008 16:43:22 +0000

Thank you.
Succint, to the point, and accurate.
Just what I needed.

It’s appreciated

By: Jim Kropa

Jim Kropa — Mon, 08 Sep 2008 20:11:32 +0000

What about a case where a help file is updated regularly? How can the tools be used to roll out an updated version of the help file?

Will rebuilding, and then re-running the setup, for instance, update the integrated help, or would these steps simply pile on more?

Thanks!

By: Joe Egan

Joe Egan — Wed, 03 Sep 2008 22:52:14 +0000

Thanks, Alexander. Your post made revisiting this topic after a year much more pleasant than I expected. To support 1.x files, I also set HtmlHelp1xCompilerPath to the directory on my computer where hhc.exe is installed (C:\Program Files\HTML Help Workshop).

Cheers,

Joe

By: Ole

Ole — Wed, 25 Jun 2008 17:59:08 +0000

A screenshot of what is going on would be nice!

By: Ian Lawton

Ian Lawton — Thu, 27 Mar 2008 12:49:36 +0000

Great article.

Although, for me, HXCOMP.EXE was in the following location after installing 2005 SDK:
C:\Program Files\Visual Studio 2005 SDK\2007.02\VisualStudioIntegration\Archive\HelpIntegration

Cheers.