SHFB v1.9.4.0 with Visual Studio Package

Rating:        Based on 9 ratings
Reviewed:  6 reviews
Downloads: 30661
Change Set: 97526
Released: Apr 29, 2012
Updated: Dec 16, 2012 by EWoodruff
Dev status: Stable Help Icon

Recommended Download

Application Sandcastle Help File Builder Installer
application, 27092K, uploaded Apr 30, 2012 - 30661 downloads

Release Notes

General Information

IMPORTANT: On some systems, the content of the ZIP file is blocked and the installer may fail to run. Before extracting it, right click on the ZIP file, select Properties, and click on the Unblock button if it is present in the lower right corner of the General tab in the properties dialog.

This release supports the Sandcastle April 2012 Release (v2.7.0.0). It includes full support for generating, installing, and removing MS Help Viewer files. This new release is compiled under .NET 4.0, supports Visual Studio 2010 and 2011 solutions and projects as documentation sources, and adds support for projects targeting the Silverlight Framework and the .NET Portable Framework.

See the Sandcastle 2.7.0.0 Release Notes for details on all of the changes made to the underlying Sandcastle tools and presentation styles.

04/29/2012 Refresh - This update includes the following fixes. If you are affected by these issues, uninstall the Sandcastle Help File Builder, download this refresh, and run the guided installer to install SHFB and the VSPackage again.
  • Fixed up issues related to the SelfBranded property. For now, leave it set to True in all cases. NOTE: If you have a project in which the SelfBranded property is set to False, set it back to True again after installing the refresh.
  • Added AttachedEventComments and AttachedPropertyComments elements to the code that checks to see if the Generate Inherited Docs tool needs to be ran.
  • Added code to set MaxJsonLength property when building the full-text index files and when loading the index files in the search web page.
  • Added code to work around a case where the project properties where not always stored in the project prior to a build occuring in the VSPackage

This release uses the Sandcastle Guided Installation package used by Sandcastle. Download and extract to a folder and then run SandcastleInstaller.exe to run the guided installation of Sandcastle, the various extra items, the Sandcastle Help File Builder core components, and the Visual Studio extension package.

What's Included
  • Help 1 compiler check and instructions on where to download it and how to install it if needed
  • Help 2 compiler check and instructions on where to download it and how to install it if needed
  • Sandcastle April 2012 2.7.0.0
  • An option to install the MAML schemas in Visual Studio to provide IntelliSense for MAML topics
  • Sandcastle Help File Builder 1.9.4.0
  • SHFB Visual Studio Extension Package

For more information about the Visual Studio extension package, see the Visual Studio Package help file topic.

Reviews for this release

     
Perfect help for documenting test adapter actions for Spec Explorer.
by bububa761 on Jul 19, 2012 at 8:57 AM
     
SHFB has been a major addition to our software build process. Love it! It has inspired me to write my own utility to generate a SHFBPROJ file and AML files from a SQL Server Database - hope to put on CodePlex when I get time to polish it up a bit.
by sjcatnandb on Jun 14, 2012 at 9:46 AM
     
I've been happily using SHFB for years, and just picked up the latest revision. All I can say is _wow_. The Visual Studio integration is fantastic. A big thank you for your efforts!
by bespokesoftware on Jun 6, 2012 at 2:43 PM
     
Great Work! With this Tool Helpfile Generation is as easy as it should be.
by Reiner_Velte on May 20, 2012 at 9:12 PM
     
WOW! What a great experience the SHFB brings to API documentation creation. Thank you for your considerable time this must have taken. Best to you, Karl
by molenator on Apr 30, 2012 at 9:49 PM
     
The release is great. Finally, Visual Studio integration is here and working as advertised. VS2010 presentation style is good and refreshing, but please fix it to show C# in Syntax section of generated CHM first (currently it shows VB).
by Bobrovsky on Apr 30, 2012 at 2:17 PM