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

How to reference own (non-msdn) html documentation

Topics: Developer Forum
Apr 11, 2012 at 10:33 AM


we use sandcastle to build our internal help. We have multiple teams working on parts of our solutions independently we need to document those independently. So we have i.e. a team creating component 1 and the help for it, and another team creating component 2 (which depends on component 1) and the help for it.

For easy access to the help is build and updated automatically as html help. So we have the help for component 1 available on http://internalserver/Components/Component1

Now the html help from Component 2 (will be deployed at http://internalserver/Components/Component2) should be able to reference the classes in the html help for Component1.

How can we configure sandcastle / sandcastle help file builder to look in our help for our own components like it does at the MSDN for framework classes?

Apr 11, 2012 at 4:04 PM

Linking between help files is supported in the Help 2 and MS Help Viewer formats and there are some ways of merging Help 1 files but currently there are no provisions for linking between websites.  That would most likely require a custom build component.