Jump to content
  • Advertisement
Sign in to follow this  

Multi-file help system

This topic is 4092 days old which is more than the 365 day threshold we allow for new replies. Please post a new topic.

If you intended to correct an error in the post then please contact us.

Recommended Posts

I'm developing an IDE that includes a bunch of SDK code and I want to document both the IDE and the SDK. The SDK will be documented with XML documentation generated by Visual studio, compiled by NDoc. I'm manually writing the HTML documentation for the IDE in a separate HTML Help project. Is there a way to create links from the IDE's CHM file to the NDoc-generated CHM file? I tried "its:MySDKDoc.chm::/MyTopic.html" but when I click on that link, the HTML help system hangs in an infinite loop of clicking sounds. After doing a little research it seems that HTML Help 2 might be better designed for inter-file linking, but I'm nervous about switching technologies. I want to be sure that someone without Visual Studio will be able to read these help files (because the IDE I'm creating includes it's own ability to compile based on the .NET framework's compilers, so they won't need Visual Studio), and it sounds like HTML Help 2 is kind of targeted at Visual Studio. I could probably have NDoc generate its output as HTML instead of compiled HTML help and merge them manually into a single CHM file, but I'm looking for the simplest, smartest solution here. Any suggestions?

Share this post

Link to post
Share on other sites
Sign in to follow this  

  • Advertisement

Important Information

By using GameDev.net, you agree to our community Guidelines, Terms of Use, and Privacy Policy.

We are the game development community.

Whether you are an indie, hobbyist, AAA developer, or just trying to learn, GameDev.net is the place for you to learn, share, and connect with the games industry. Learn more About Us or sign up!

Sign me up!