HelpSmith Logo
Making Help Authoring a Pleasure to Do
Free DownloadStart your free trial now
HelpSmith Topics
Making Help Authoring a Pleasure To Do

How to integrate help system with .NET app?

We are using HelpSmith to create documentation for our product.

Q: How can we integrate the generated help system with our .NET application?

36

Comments

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.

26

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:

  1. On the Project tab, in the Tools group, click on the lower half of the Context Tool button.
  2. Click Export Context Numbers.
  3. In the Export Context Numbers dialog, in the "Save as type" box, select the file type that you need.
  4. In the File name box, specify the filename that you need.
  5. Click Save.

Generated header file for C#

17

Is it possible to integrate a Web Help (.HTML) system with our .NET app?

18

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, you should execute the URL linking to that topic by using the code like this:

string url="http://www.example.com/webhelp/topics/my-topic.htm";
System.Diagnostics.Process.Start(url);
18

Add a Comment

Please Login or Register or leave comments.

Hello World
Lorem ipsum dolor sit amet
OK
Login
Nickname or Email:
Password:
If you do not have an account, you can register.