Sandcastle Help File Builder icon

Sandcastle Help File Builder

5 big stars
Sandcastle Help File Builder screenshot
Name: Sandcastle Help File Builder
Works on: windowsWindows 2000 and above
Developer: Eric Woodruff
Version: 2016.9
Last Updated: 15 Apr 2017
Release: 23 Sep 2016
Category: Authoring Tools > Help and e-book creators
Rate this software:
screenshotsView Screenshots(18)
try it nowTry It In Browser!
Liked it? Tell others:

Sandcastle Help File Builder Details

Works on: Windows 10 | Windows 8.1 | Windows 8 | Windows 7 | Windows XP | Windows 2000 | Windows 2003 | Windows 2008 | Windows Vista | Windows 2012
SHA1 Hash: 6c5fc1a54822da31723a02fe18d5bf4ef74069c0
Size: 44.67 MB
File Format: zip
Rating: 5 out of 5 based on 1 user ratings
Publisher Website: External Link
Downloads: 476
License: Free
Sandcastle Help File Builder is a free software by Eric Woodruff and works on Windows 10, Windows 8.1, Windows 8, Windows 7, Windows XP, Windows 2000, Windows 2003, Windows 2008, Windows Vista, Windows 2012.
You can download Sandcastle Help File Builder which is 44.67 MB in size and belongs to the software category Help and e-book creators.
Sandcastle Help File Builder was released on 2016-09-23 and last updated on our database on 2017-04-15 and is currently at version 2016.9.
download button
Thank you for downloading from SoftPaz! Your download should start any moment now. It would be great if you could rate and share:
Rate this software:
Share in your network:
Now you can try out this software directly in your browser without downloading or installing on your PC!
try it now

Sandcastle Help File Builder Description

  • The GUI interface provides an NDoc-like properties window so anyone familiar with NDoc should be quite comfortable using it. In addition, it provides a Visual Studio-like project explorer that lets you manage and edit the files associated with the project.
  • The builder can produce an HTML Help 1.x (.CHM) file, an HTML Help 2.x (.HxS) file, and/or a website.
  • The HTML Help 2.x output includes a valid set of collection files and an H2Reg.exe configuration file to simplify deployment and integration of the help file into existing collections such as those used by Visual Studio.
  • The website output contains an HTML and an ASP.NET index page with tree view that can be used to navigate the table of contents and a full-text index search feature.
  • The settings are saved in a standard MSBuild-format project file and can be built from within the standalone GUI, from the command line using MSBuild, or in a post-build step to a Visual Studio project that runs MSBuild. Support for full Visual Studio integration is planned for a future release.
  • A project file conversion option is provided to convert projects from other third-party tools such as NDoc, DocProject, SandcastleGUI, and the example GUI provided with Sandcastle to the help file builder's MSBuild project format.
  • Visual Studio 2005/2008 solution and project files are supported directly as documentation sources. When the help project is built, the assembly, XML comments file, and reference information is imported from them and used automatically.
  • In addition, both executable (.EXE) and library (.DLL) assemblies can be added individually as documentation sources along with any related XML comments files.
  • Dependency references can also be specified individually. File, GAC, project, and COM references are supported (COM references are supported in the project file but currently cannot be added via the standalone GUI).
  • The builder will automatically locate both Sandcastle and the HTML help compilers by looking at the common environment variables, in the system path, and in the Program Files special folder on all fixed hard drives. Properties are also supplied for you to specify the paths in the off-chance that it cannot locate them automatically.
  • The build process provides full logging and error handling. All output from the build is stored in a log file in the output folder. The log is in XML format and can be ran through an XSL transformation to make it more readable, to highlight warnings and errors, etc.
  • The intermediate files used to create the help file are placed in a working folder beneath an output folder of your choosing. They can be automatically removed after a successful build or kept around for further modifications.
  • Most of the NDoc features have been built into the Sandcastle help file builder including:
  • Definition of project summary and namespace summary comments that will appear in the help file. You can also easily indicate which namespaces to include or exclude from the help file. Support is also included for specifying namespace comments via a NamespaceDoc class within each namespace.
  • The ability to turn off documentation of attributes and various other unwanted API elements.
  • Automatic determination of the default topic for the help file.
  • You have control over the help file name, title, header text, and footer information such as the e-mail address, copyright text, and copyright URL.
  • Support for conceptual content is fully integrated. This allows you to define additional content that appears in the table of contents such as usage notes, tutorials, etc. Conceptual content is created using Microsoft Assistance Markup Language (MAML).
  • Standard HTML files can also be included and merged with the table of contents. A site map file can be used to define the layout.
  • Language selection and localization support is built in. Translations are provided for the help file builder resource files in several languages and information is provided on how to localize the Sandcastle content files.
  • Steps have been taken to make the build process more open so that you have a chance to customize it without having to modify the code for the builder application itself. Custom build process plug-ins are supported that can be used to extend or alter the build process in various ways. Plug-ins supplied with the help file builder include:
  • Additional Content Only - Build help files based on nothing but the conceptual and/or additional content items (no API content).
  • Additional Reference Links - Add additional sources of reference links for third-party libraries or MSDN content that does not appear in your help file.
  • AjaxDoc Builder - Build help files for Atlas script libraries in conjunction with AjaxDoc.
  • Completion Notification - E-mail the build results to someone optionally attaching the log file (raw or transformed via XSL).
  • DBCS Fix for CHM Builds - Fixes the HTML content and runs the Help 1 compiler in the proper locale to overcome its encoding issues.
  • Hierarchical Table of Contents - Used to rearrange the table of contents such that namespaces are nested within their parent namespaces.
  • Output Deployment - Copy the resulting help file to a file share, web server, FTP site, etc.
  • Script# Reflection File Fixer - Fixes up the reflection information file so that Script# assemblies are documented correctly.
  • Table of Contents Exclusion - Used to exclude API members from the table of contents (the members still appear in the help file).
  • Version Builder - Generate version information for the current project and others related to the same product and merge that information into a single help file for all of them.
  • The plug-in interface is public and is documented in this help file allowing you to create your own custom plug-ins.
  • Support is included for the tag which allows you to inherit documentation from base types/members. This is implemented via a standalone tool so it can also be used by other third-party tools and build scripts. This tool provides features beyond those found in the build component supplied with Sandcastle.

Sandcastle Help File Builder Screenshots

Sandcastle Help File Builder screenshot 1 Sandcastle Help File Builder screenshot 2 Sandcastle Help File Builder screenshot 3 Sandcastle Help File Builder screenshot 4 Sandcastle Help File Builder screenshot 5 Sandcastle Help File Builder screenshot 6 Sandcastle Help File Builder screenshot 7 Sandcastle Help File Builder screenshot 8 Sandcastle Help File Builder screenshot 9 Sandcastle Help File Builder screenshot 10 Sandcastle Help File Builder screenshot 11 Sandcastle Help File Builder screenshot 12 Sandcastle Help File Builder screenshot 13 Sandcastle Help File Builder screenshot 14 Sandcastle Help File Builder screenshot 15 Sandcastle Help File Builder screenshot 16 Sandcastle Help File Builder screenshot 17 Sandcastle Help File Builder screenshot 18
similarSimilar Software
Help & Manual icon
Help & Manual
v 7.2
Paper Killer icon
Paper Killer
v 2016.4
Helpinator icon
v 3.18
Kindle Previewer icon
Kindle Previewer
v 2.94
Jeboorker icon
v 1.2
Calibre icon
v 3.6
Lectora Inspire icon
Lectora Inspire
v 16.2
Calibre Portable icon
Calibre Portable
v 3.9
HelpScribble icon
v 8.1