This project has moved and is read-only. For the latest updates, please go here.

Is it possible to include API and Conceptual documentation together in the same help file

Topics: Developer Forum, Project Management Forum, User Forum
Jun 14, 2011 at 8:49 PM

I'm a new user to Sandcastle and I'm assigned the task of creating a help file (chm) that includes API documentation and generic documentation. I have the APIs with the required DLLs, and XML files. I'm also trying to create the conceptual help (using conceptual, content layout, sitemap) within the same file but I can only see that the output contains the concepts but not the API related information. Can anyone please help me or clarify if it's possible to merge both the documentation into the single chm file.

Jun 15, 2011 at 3:05 AM

If you add a content layout file to a project with documentation sources, the topics from it will be merged with the API content.  See the Conceptual Content section of the SHFB help file for more information.  The sitemap file is not needed as it was for including HTML topic files which has been deprecated in favor of MAML topics and content layout files.