Sandcastle Help File Builder Now Available

Jan 23, 2008 at 4:00 AM
The latest release of the Sandcastle Help File Builder is now available at

v1.6.0.4 - Changes in this release:

  • Added support for the January 2008 release of Sandcastle.
  • Added CachedCopyFromIndexComponent and CachedResolveReferenceLinksComponent to the custom build components assembly. These cache key information for use across builds that should speed up the builds in many cases. These are experimental and I'd like to get feedback on how well they work for projects of varying sizes. See the documentation in the help file or this thread for details.
  • Added the DeploymentPlugIn which allows you to deploy the resulting help file output to a location other than the output folder (i.e. a file share, a web server, an FTP site, etc.).
  • Added the VersionBuilderPlugIn that allows you to generate version information for assemblies in the current project and other projects related to the same product that can be merged into the current project's help file topics.
  • Fixed a bug that caused the {@WorkingFolder} replacement tag to fail if used in a template file.
  • Fixed a bug in the Code Block and Post-transform Components that caused "none" language code blocks in API topics to always be hidden.
  • Fixed a bug in the default topic file transforms that caused it to not find the code colorizer script and stylesheet if the topic was not in the root folder.
  • Fixed issues caused by characters such as ampersand in the table of content topic titles and filenames for Help 2 and website output.
  • If a topic file transform's output contains replacement tags, include items, blocks of code that need colorizing, or include code tags, they are now processed after the transform has occurred as well.
  • Added the map and area tags to the HTML passthrough section of the default transform files so that image maps can be used in additional content topics.
  • Added support for the Script# syntax generator to the SyntaxFilters project property.
  • The Assemblies to Document list now accepts files dragged and dropped from Windows Explorer.
  • When clearing the output folder, hidden folders and files are now ignored in addition to read-only folders and files.
  • When copying stock and additional content, hidden folders are ignored.
  • Added a Help2x_NamedURLIndex.HxK file to support the NamedURLIndex keyword options such as HomePage and DefaultPage within API and/or additional content topics.
  • Modified the Help 2 compiler check to also look for the Common Files\Microsoft Shared\Help 2.0 Compiler folder to handle versions installed by the VS 2008 SDK.
  • Fixed up handling of empty string literals in the code colorizer rules and added support for character literals (all C-style languages) and regular expression literals (JavaScript).
  • Added "Open help file after successful build" option to the View Help File sub-menu and toolbar button dropdown menu. If checked, the help file will be opened after the build completes successfully. This is a user setting and is saved across sessions.
  • Thanks to Joey Bradshaw for the PowerShell script keywords and code colorizer rule definitions. Use the language ID pshell, powershell, or ps1 to colorize a code block as PowerShell script.
  • Thanks to Milly for supplying the Japanese translations of the help file builder's shared content files.

Jan 24, 2008 at 12:27 AM
Thanks so much for the hard work.
I am currently working on the user manual of our product, but I will find the time
today or tomorrow to download and install this new version.

Best regards,