As promised I have packaged a "release" of the Sandcastle Help File Builder plug-in.

This is manually packaged (since I don't yet have my build server making these packages automatically), so please bare with me on structure and what might be off or missing (well it should all be there, so missing is harsh said).

The configuration is very simple, in fact in some cases you can use it with only defining one parameter. Here is an example that defines a time-out, a project file and a publish path.

<sandcastle>
  <projectFile>G:\Workspace\Help.shfb</projectFile>
  <publishPath>C:\Inetpub\wwwroot\Api</publishPath>
  <timeout>7200</timeout>
</sandcastle>

 

There is actually only use for defining the project file to build a given help project, but here we also copy the entire content to a IIS hosted web folder, and then a 2 hour time-out since sandcastle takes it's time.

Node Description Type Required Default
projectFile A path to the project file to use for building the help files. string Yes None
publishPath A path to copy all output after build. string No None
executeable A path to the SandcastleBuilderConsole.exe file. string No <program files>\EWSoftware\Sandcastle Help File Builder\SandcastleBuilderConsole.exe
timeout The time-out period in seconds for the sandcastle help file builder, this does currently not include post processing and publishing. int No 180
baseDirectory Currently not in used string No None

The base directory is currently not in use, so please don't attempt to set if for something meaning full, also the project (if you download the source) is currently not under a lot of testing, I have been focussing on getting it running for various reasons.

From the list of requirements, the following are "implemented":

  • Build a Sandcastle Help File Builder project.
  • Copy the output to a desired directory.
  • Parse Sandcastle Help File Builder log to something that can be displayed in CCNet
  • Summary for the build (number of missing references, documentations)

Yet to be desired:

  • Pass/Fail levels on missing documentation
  • Detailed report over missing documentations (Browse able by components ect.)

It is released under a LGPL license