add nodes to the CHM that don't correspond with an API

Mar 10, 2009 at 4:56 PM

With Sandscastle,

Is there a way to add nodes to the CHM that don’t correspond with an API? Basically just some content nodes that set the stage?


Mar 10, 2009 at 5:34 PM

Sandcastle doesn't generate CHM files, the HTML Help Workshop does.  The workshop includes raw HTML files that Sandcastle generates.  You can include your own files and update the TOC if you'd like.

Alternatively, and recommended, Sandcastle can produce HTML files that aren't automatically generated from XML comments, but instead are generated from XML files that you write using a specific schema - MAML (Microsoft Assistance Markup Language).  These topics are called, "conceptual", since they are typically used as end-user documentation that provides a conceptual overview, how-to instructions, walkthroughs, etc.  The look and feel of the topics will be the same style that is used for API reference topics.

There are tools that automate Sandcastle, such as DocProject and Sandcastle Help File Buidler, which make it easier to produce a CHM that includes conceptual topics written in MAML.

For more information on Sandcastle and MAML, see Sandcastle Help and download the MAML guide from the Sandcastle Styles project.

- Dave