Click or drag to resize
Sandcastle Help File BuilderReplacing Stock Content

A benefit of the additional content implementation is that it is possible to replace the stock content that appears in each help file. The stock content is copied from a presentation style sub-folder which can be found under the .\PresentationStyles folder of the root help file builder installation folder. Each presentation style has its own folder such as .\VS2010, .\VS2013, etc.

The folder structure for the content that gets added to each help file is the same in each and consists of the following:

  • The icons\ folder contains stock help file images (i.e. for property icons, method icons, etc).

  • The scripts\ folder contains stock JavaScript files.

  • The styles\ folder contains stock style sheets.

Modifying the Sandcastle copy of the presentation files directly will affect all help files that you build with the help file builder. For example, if you want to modify the style sheet for all projects you create with the help file builder, edit the branding.css files in the .\styles folders. The files do not need to be added to your project in that case.

If you want to modify them on a per project basis, that is when you would copy them to your project's folder. By adding an additional content entry to the project that resides in a like-named folder and has the same filename, you can replace the default entry of the same name. In the example above, you would create a .\styles folder in the Project Explorer window and place a copy of branding.css in it that you can edit for that project. The location to copy from would be the one matching the presentation style selected in your project (i.e. %ProgramFiles(x86)\EWSoftware\Sandcastle Help File Builder\PresentationStyles\VS2013\styles\branding.css). The presentation styles are all different and their files are not interchangeable.

In addition, an html\ folder is created when the help file is built to contain the help pages generated from the documented assemblies and conceptual content. You can place additional HTML files to add to the project in a folder by the same name in your project or you can place them in the root of the project. Be sure to use an appropriate relative path on image references or links to other HTML pages based on the folder in which you place the content.

See Also

Other Resources