Delphi-Kylix
  Home arrow Delphi-Kylix arrow Building a Help System for Delphi Applicat...
IBM developerWorks
Dev Articles Forums 
ADO.NET  
Apache  
ASP  
ASP.NET  
C#  
C++  
ColdFusion  
COM/COM+  
Delphi-Kylix  
Design Usability  
Development Cycles  
DHTML  
Embedded Tools  
Flash  
Graphic Design  
HTML  
IIS  
Interviews  
Java  
JavaScript  
MySQL  
Oracle  
Photoshop  
PHP  
Reviews  
Ruby-on-Rails  
SQL  
SQL Server  
Style Sheets  
VB.Net  
Visual Basic  
Web Authoring  
Web Services  
Web Standards  
XML  
Dedicated Servers  
Actuate Whitepapers 
Moblin 
IBM® developerWorks 
Sun Developer Network 
Weekly Newsletter
 
Developer Updates  
Free Website Content 
IBM developerWorks
 RSS  Articles
 RSS  Forums
 RSS  All Feeds
Write For Us Get Paid 
Request Media Kit
Contact Us 
Site Map 
Privacy Policy 
Support 
 USERNAME
 
 PASSWORD
 
 
  >>> SIGN UP!  
  Lost Password? 
DELPHI-KYLIX

Building a Help System for Delphi Applications
By: Leidago
  • Search For More Articles!
  • Disclaimer
  • Author Terms
  • Rating: 4 stars4 stars4 stars4 stars4 stars / 5
    2007-01-02

    Table of Contents:
  • Building a Help System for Delphi Applications
  • Creating Contents, Headings and Topics
  • Creating the Help Text
  • Creating the MAP File

  • Rate this Article: Poor Best 
      ADD THIS ARTICLE TO:
      Del.ici.ous Digg
      Blink Simpy
      Google Spurl
      Y! MyWeb Furl
    Email Me Similar Content When Posted
    Add Developer Shed Article Feed To Your Site
    Email Article To Friend
    Print Version Of Article
    PDF Version Of Article
     
     
    ADVERTISEMENT

    Stay one step ahead of the competition. Evaluate and give feedback on some of the hottest web development tools on the market today. Make your opinion heard! Click Here

    Building a Help System for Delphi Applications


    (Page 1 of 4 )

    Complicated applications need help systems so that those who use them have somewhere to turn when they get stuck. Fortunately, they needn't be difficult to build. This article explains how to create a help system for a Delphi application.
    Two downloadable files are available for this article, DelphiProject.rar and HelpProjectFiles.rar.

    A week ago I wrote accounting software for a client that incorporated other software as well. Because of the size of the application, it required a help system. Usually I would just include a small text file to explain how things work, but for this system something a bit more sophisticated was called for. So I set about learning how to create a help system and found that it is actually really easy. So I decided to write and share this wonderful find with you lucky Delphi developers!

    So why would any one need a help system for their applications? Well, it can be for a variety of reasons. Most applications that I've written did not require a full- fledged help system. Other applications will require a full-fledged help system, either because it is a big application with a lot of functionality that is not easy to master or to make it easy for the target audience to use the software if they are not so good with technology.

    Tools you need

    Delphi version 6 and higher. Microsoft Help Workshop (ships with Delphi) and a word processor (I will be using MS Word) that is capable of creating rich text format files.

    The Help System

    How much of the help system you want to implement is up to you and would depend on what kind of application you are writing.  The help system that I am going to write for this article is going to have the following functionality:

    • A user must be able to find a topic through a keyword.
    • Users must be able to select a topic from a list of categories.

    In addition, we will also take a look at how to use images and links within our help system.

    To create a help file we have to walk through a series of steps, mainly because we are doing everything from scratch. We need the following files to start the process:

    .rtf  - This file will contain the actual text of the help file.

    .hpj  -  This file will contain the project information for your help file.

    .cnt - This file will contain a list of "chapters" and topics and will act as the content page of your help file.

    .map - This file matches numeric values to the topicID.

    So without further ado, start your Microsoft Help Workshop application (on my machine this application is located at C:Program FilesBorlandDelphi6HelpTools)  and create a hpj file. You do this by going to File | New and then selecting "Help Project." You'll be asked to save the file, so save it as "MyHelpProjectFile.hlp" in a separate folder.

    More Delphi-Kylix Articles
    More By Leidago


       · The article uses help file creation software that come with Delphi. There are other...
     

    DELPHI-KYLIX ARTICLES

    - Client Dataset: Working with Data Packets an...
    - Using the Client Dataset in an N-Tiered Appl...
    - Using the Client Dataset in Two-Tiered Clien...
    - Using the Client Dataset in File-Based Archi...
    - Demystifying the Client Dataset
    - Working with INI Files in Delphi
    - Creating Data Link (UDL) Files in Delphi
    - Looking at the Details for an Invoicing Appl...
    - Invoicing in Delphi: Show Me the Money
    - Saving Images and Binary Files to a Database...
    - Saving Files to a Database using Delphi: Sav...
    - Creating CF Applications and Integrating a S...
    - Using Try and Finally to Help Prevent Memory...
    - The Implementation of an FTP Server
    - FTP Server: The Theory


    Iron Speed





    © 2003-2008 by Developer Shed. All rights reserved. DS Cluster 4 hosted by Hostway