Sandcastle Help File Builder

PHP version of the web index, as discussed here: http://shfb.codeplex.com/discussions/287959
Also includes automatic TOC synchronization when the IFRAME location changes

Applied Feb 19: Merged into the project. Thanks.

There's a small bug in the MSHCComponent that allows for duplicate <meta> tags even when not desired.

The side-effect is that the "sync-with-toc" function in MS Help Viewer does not work - it gets confused by the duplicate metadata.

Applied Feb 8: Fixed as indicated. Thanks.

The AllMembersTopicId is not getting generated in autogenSeeAlsoLinks (genericTemplates.xsl). This is because /document/reference/containers/type/topicdata is not getting created.

I'm submitting a fix to VS2005.config in the "Copy in container data" part.

Change source="apidata|typedata|templates|attributes" to source="apidata|topicdata|typedata|templates|attributes"

Applied Feb 8: Applied as indicated.

Tweaked FileTree.cs to include the offending entry in the event of an ArgumentException, which occurs whenever a duplicate item shows up in the project file.

Applied Nov 6 2010: Thanks. The patch was applied.

Updated SharedContent for Japanese(ja-JP). The file is based on SHFB 1.9.1.0 (Jul 2010).

Applied Aug 21 2010: Thanks. The file has been updated with your changes.

When adding images for conceptual content the image id and alternate text are set automatically. This saves a lot of time, maybe this should be enabled or disabled through an option.

Example:
Filename: ScreenshotOfDialogX.png
ImageId: ScreenshotOfDialogX
Alternate Text: Screenshot Of Dialog X

Applied Apr 5 2010: I added the necessary code in the FileItem.BuildAction property rather than the project. Image files are added as Content items intentionally for backward compatibility with prior releases since not everyone is using MAML just yet. BuildAction must still be set to Image but it will default the ImageId and AlternateText properties if not already set based on the filename.

Hi Eric, as discussed via email I have created a WiX based setup for SHFB. The zip files contains the whole source code (taken from the 1.8.0.1 release). I have also created a bit art work for the setup (a dialog bitmap for the start and finish screens as well as a banner for the other dialogs).

The SancastleBuilder folder contains now a new folder called "Build" that contains a single MSBuild project file for building SHFB from scratch, including help file creation and setup. To make invocation easier I have also included a bunch of batch files that kick-off the build. The results will be placed in a folder named "Output". To build everything just invoke "Build.bat".

The Setup folder now contains the WiX based setup project. I simply deleted the old Visual Studio deployment project.

To make building easier I have also created a new solution file Setup.sln. That means the setup is no longer part of SandcastleBuilder.sln.

If you have any further questions feel free to contact me.

Applied Feb 8 2010: Thanks. I've used the included Wix project as the basis for the SHFB setup project.

I looked at the source code and I found why it isn't working:
if(!Directory.Exists(destPath))
Directory.CreateDirectory(destPath);

within the DeployOutput function, destPath is almost a constant to which the remaining path is added. Since this validation is done within the foreach(string sourceFile in files) loop, I suppose it was meant to create subfolders along with the main folder but for now, it will never do that. This would correct the situation. I'll post a patch.

if(!Directory.Exists(Path.GetDirectoryName(destFile)))
Directory.CreateDirectory(Path.GetDirectoryName((destFile));

I know this isn't optimal and that storing a variable or using fileInfo instead of a simple string would probably be better but, not having a C# compiler here, I don't want to modify the file too much.

Applied Dec 8 2008: Fixed as indicated.

Updated SharedContent for Japanese(ja-JP).
Thanks TimberLandChapel (http://timberlandchapel.com/).

Applied Apr 14 2008: Shared content changes merged. Thanks.

SharedContent for Japanese(ja-JP).

Applied Nov 21 2007: Japanese shared content merged. Thanks.