How do you integrate help files into your application?
That's a frequently asked question in the user forum and in direct support.
The answer is: it depends on the application development tool.
We have put together several tutorials for help file integration with different application development tools on this page. Please choose your language:
Integrating eWriter help with Delphi / RAD Studio
This is an implementation of the eWriter help format as a replacement for HTML Help (.chm) files in Delphi applications.
EWriter eBooks are the modern alternative to the obsolete CHM format for local application help. They offer full support for context-sensitive help and file links. They combine the benefits of CHM and WebHelp and eliminate the disadvantages of both.
The package includes the unit Vcl.EwriterHelpViewer.pas which implements support for the eWriter help format in Delphi's help system. Applications currently using CHM files for application help can switch to eWriter help with basically no changes. The distributable eWriter viewer is included.
Author: |
© EC Software GmbH |
Document link: |
|
Integrating HTML Help with Visual Studio applications (.NET / WPF)
There are several articles from Rob Chandler, Jaison John and on the Microsoft forums that explain how to connect a CHM file to a .net application.
Author: |
© Jaison John |
Web link: |
Integrate Help Into Your .NET Apps |
Author: |
© Rob Chandler, kb.helpwaregroup.com |
Web link: |
.NET Application Help |
Author: |
© Microsoft |
Web link: |
The HelpProvider Class in the .NET Framework |
Integrating online help with Visual Basic (VB6 / VB .NET / VBA)
One of the best resources for Visual Basic and online help is Ulrich Kulles www.help-info.de. The site is available in English and German and covers many aspects of HTML Help and VB, from VB6 to VB .NET to Visual Basic for Applications.
Author: |
© Ulrich Kulle, www.help-info.de |
Document link: |
Help for controls with VB .NET |
Connecting WinHelp/HTML Help to VB and C++
The two tutorials explain how to implement Winhelp resp. HTML Help into Visual Basic and C++ programs.
Author: |
© Don Lammers, Shadow Mountain Tech |
Download: |
[VBHTMLHelp.pdf] Connecting HTMLHelp to Visual Basic Programs |
Using HTML Help with Microsoft Access
Using Microsoft HTML Help with Access databases has turned out to be a bit trickier than originally imagined. Dave Liske put together a paper on the subject.
Author: |
© Dave Liske, Help Technology Centre |
Download: |
[hhaccess.pdf] Using HTML Help with Microsoft Access |
Connecting WinHelp/HTML Help to Visual Objects
A guide how to integrate Winhelp and HTML Help into a Visual Objects application. Sample help file is included.
Author: |
© Phil McGuinness, Sherlock Software |
Download: |
[helpandmanualvo27.zip] 334 kb ZIP archive |
Context sensitive help with Clarion
EasyHelper is a (shareware) tool implementing a class and templates, allowing you to add a context help into a Clarion application. Supports Winhelp and HTML Help, licensed version costs $99.
Author: |
© Ingasoftplus, http://www.ingasoftplus.com |
Document Link: |
|
Implement HTML Help within APL
How to show HTML Help from your APL application.
Author: |
© APL Team Ltd, http://www.aplteam.com |
Document Link: |
|
Implement HTML Help within FoxPro v3 or v5
This is the Microsoft knowledgebase article Q185498 with an additional help file example for Help & Manual.
Author: |
© Microsoft, www.microsoft.com |
Download: |
[vfphtml.zip] 276 kb ZIP archive |
HTML Help with Xojo (former REALbasic) for Windows
This tutorial shows step-by-step how easy it is to use compiled HTML Help files with Xojo. The download file includes the compiled application plus source code.
Author: |
© 2004 EC Software |
Download: |
[realbasic.zip] 1.06 mb ZIP archive |
Help with Visual XBase++
Comprehensive tutorial with compiled EXE demo for XBase++ showing field level help (F1 help) and general application online help with CHM files.
Author: |
© Peter Alderliesten, Solvention bv, http://www.solvention.nl |
Download: |
[xbase++helptutorial.zip] 3 mb ZIP archive |