How to integrate help system with .NET app?
We are using HelpSmith to create documentation for our desktop software.
Q: How can we integrate the generated help system with our .NET application?
We are using HelpSmith to create documentation for our desktop software.
Q: How can we integrate the generated help system with our .NET application?
Integration of a .CHM help file
.NET includes built-in support for HTML Help (CHM) files.
So you can interact with a .CHM file from your application as explained in the article below:
https://www.helpsmith.com/how-to-connect-htmlhelp-chm-net.php
For example, you can use the Help.ShowHelp() method to display a specific topic from the code of your application.
How to export the topic list to a header file
Please note that HelpSmith allows you to export the topic list to a header file which can be included into your application (e.g. C#, VB.NET, etc.).
To generate a header file:
Is it possible to integrate a Web Help (.HTML) system with our .NET app?
Integrating a Web Help system
If you need to integrate a Web Help (browser-based) help system, you can find the details in this topic:
https://www.helpsmith.com/webhelp/topics/context-sensitive-help-web-help.htm
For example, to display a specific topic in a Web Help system from the desktop application, you should execute the URL linking to that topic by using the code like this: