Class reference documentation tree structure support

May 27, 2014 at 12:04 PM

We are using sandcastle help file builder for generating class reference documentation. I have generated a sample class reference contents and shared the contents and the project in the below link.
Sample Project :
Assemblies used : Microsoft.webpublisher.dll,Microsoft.Windows.Design.Extensibility.dll
Sample Project Output:
Here is the requirement :

I have used microsoft windows assembly and web assembly in the project, We want to differentiate the generated contents by including a Header topic as 'Essential Microsoft Windows' and we want the all the namespaces for 'Microsoft.Windows.Design.Extensibility.dll' comes under this topic. Similar to this we need to include the all the web contents under 'Essential Microsoft Web' topic.


Essential Microsoft Windows
Microsoft.Windows.Design Namespace
Microsoft.Windows.Design.Features Namespace
Microsoft.Windows.Design.MetaData Namespace
Essential Microsoft Web
Microsoft.WebPublisher Namespace
Note: Maintain both assemblies in same project and we want the output as above mentioned structure.

Kindly suggest us what we have to do for achieving this functionality from our side?

May 29, 2014 at 7:33 PM
You'll need to write a plug-in for SHFB that modifies the intermediate TOC file (toc.xml in the working folder during the build) probably after the CombiningIntermediateTocFiles build step. It would move selected namespace entries to a new parent topic based on the configuration. See the Creating Build Process Plug-Ins topic in the SHFB help file to get started.

Please note that this project site has been discontinued and may not be monitored as frequently. For future questions or issues concerning Sandcastle or SHFB, post them over on the Sandcastle Help File Builder project's discussion page. Thanks.