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

Can we Build only the API Member Pages?

Topics: Project Management Forum, User Forum
Nov 15, 2011 at 6:18 PM

We'd like to abbreviate the TOC of our API reference to include only the members pages.  Is this feasible using Sandcastle Help File Builder?  All the information on methods, properties, fields, events etc is included in the members page, and the team would prefer to make the navigation flat and simple.

Nov 15, 2011 at 8:36 PM

This falls within the realm of the presentation style rather than a particular feature offered by SHFB.  You'd have to alter the Sandcastle transformations that generate the the manifest files to filter out the unwanted information that generates the summary pages and the transformations that generate the TOC info to flatten it.  Most of the changes would likely be made to the transformations in the C:\Program Files (x86)\Sandcastle\ProductionTransforms folder so they'd affect everything as opposed to just a custom presentation style that you might create by cloning one of the existing presentation style folders.



Nov 16, 2011 at 2:50 AM

It should be possible to simply change the TOC without having to change the presentation style.

Look into the Add-in or build process to see where the TOC is generated and change/filter that (with an add-in)
to include only what you need and it should work. 

Best regards,

Nov 18, 2011 at 8:10 PM

Thanks, Guys for your support.  We adapted an XML transform from our modeling app to get it done.