User Name Password Register
DaniWeb IT Discussion Community
All
What is DaniWeb IT Discussion Community?
You're currently browsing the Pascal and Delphi section within the Software Development category of DaniWeb, a massive community of 402,062 software developers, web developers, Internet marketers, and tech gurus who are all enthusiastic about making contacts, networking, and learning from each other. In fact, there are 2,492 IT professionals currently interacting right now! Registration is free, only takes a minute and lets you enjoy all of the interactive features of the site.
Please support our Pascal and Delphi advertiser: Programming Forums
Views: 805 | Replies: 5
Reply
Join Date: Oct 2007
Posts: 34
Reputation: adrive is an unknown quantity at this point 
Rep Power: 1
Solved Threads: 0
adrive adrive is offline Offline
Light Poster

help file creation

  #1  
Jan 7th, 2008
hi, after some search with google, i can't seem to find a proper tutorial on how to create help files in delphi applications.

I have no prior experience in creating help files in any client based applications, i was wondering if delphi ide itself has these components for me to write to?
AddThis Social Bookmark Button
Reply With Quote  
Join Date: Oct 2007
Location: Cherry Hill, NJ
Posts: 1,836
Reputation: Duoas is a splendid one to behold Duoas is a splendid one to behold Duoas is a splendid one to behold Duoas is a splendid one to behold Duoas is a splendid one to behold Duoas is a splendid one to behold Duoas is a splendid one to behold 
Rep Power: 11
Solved Threads: 189
Featured Poster
Duoas's Avatar
Duoas Duoas is offline Offline
Posting Virtuoso

Re: help file creation

  #2  
Jan 8th, 2008
Delphi provides you with the Microsoft Help Compiler (at least versions as old as D5 did), but using it directly is not fun.

You can google "help file creator" for the right stuff.

If you want to make HLP files, you can always check out Finn Christiansen's Shalom Help Maker, which is a nice, simple, 100% free tool. It looks like danish-shareware.dk is down right now... but you can google elsewhere.

If you want to make CHM files, I've never done that, so you'll have to sort through google yourself, alas.
Reply With Quote  
Join Date: Oct 2007
Posts: 34
Reputation: adrive is an unknown quantity at this point 
Rep Power: 1
Solved Threads: 0
adrive adrive is offline Offline
Light Poster

Re: help file creation

  #3  
Jan 8th, 2008
Duoas, hi again.

I was wondering, is HLP files embeddable to delphi applications itself ?
Reply With Quote  
Join Date: Oct 2007
Location: Cherry Hill, NJ
Posts: 1,836
Reputation: Duoas is a splendid one to behold Duoas is a splendid one to behold Duoas is a splendid one to behold Duoas is a splendid one to behold Duoas is a splendid one to behold Duoas is a splendid one to behold Duoas is a splendid one to behold 
Rep Power: 11
Solved Threads: 189
Featured Poster
Duoas's Avatar
Duoas Duoas is offline Offline
Posting Virtuoso

Re: help file creation

  #4  
Jan 8th, 2008
Well, you can do that if you like, but you'd have to extract them before they could be used.

This is because WinHelp is a separate program which the application uses to display the help.
Reply With Quote  
Join Date: Oct 2007
Posts: 34
Reputation: adrive is an unknown quantity at this point 
Rep Power: 1
Solved Threads: 0
adrive adrive is offline Offline
Light Poster

Re: help file creation

  #5  
Jan 8th, 2008
ok i had another go with this, i went through
http://www.devarticles.com/c/a/Delph...-Applications/

i downloaded my hcw from :
http://www.microsoft.com/Downloads/d...displaylang=en

but the application could not even call the help file at the end, when i click on 'help->about' it'll say that the file doesn't have table of contents!

what's weird, is that if i double click on the hlp file i compiled, and then click on contents, it ignores me and i won't see any table index.

if i move the file out from my project's folder and open the file, i could click on 'contents' and there'll be index coming out.
Reply With Quote  
Join Date: Oct 2007
Location: Cherry Hill, NJ
Posts: 1,836
Reputation: Duoas is a splendid one to behold Duoas is a splendid one to behold Duoas is a splendid one to behold Duoas is a splendid one to behold Duoas is a splendid one to behold Duoas is a splendid one to behold Duoas is a splendid one to behold 
Rep Power: 11
Solved Threads: 189
Featured Poster
Duoas's Avatar
Duoas Duoas is offline Offline
Posting Virtuoso

Re: help file creation

  #6  
Jan 9th, 2008
You are doing it the hard way. You really should download something like Shalom and use it...

The problem is that your help file doesn't have a table of contents. This is usually stored in a separate file, so you'd have
frobinator.cnt
frobinator.hlp

How are you calling the help file? It doesn't need to have a contents, but WinHelp will complain if it is instructed to display the contents page for a help that doesn't have one.

(My own help files are often pretty small and succinct, so I tend to omit contents pages. However, all substantial help files should have a table of contents...)

In your code, you should have something like
  1. procedure TForm1.FormCreate( Sender: tObject );
  2. begin
  3. // The help file is named the same as the program,
  4. // and is located in the same directory.
  5. application.helpFile := changeFileExt( paramStr( 0 ), '.hlp' )
  6. end;
  7.  
  8. procedure TForm1.AboutClick( Sender: tObject );
  9. begin
  10. // Context 42 is the help file's about page...
  11. application.helpContext( 42 )
  12. end;

If you use Shalom Help Maker, it can generate a little include file for you that gives constants for all the help contexts. So it could read:
  1. ...
  2. implementation
  3. {$R *.dfm}
  4. {$include MY_HELP_Constants.inc}
  5.  
  6. ...
  7.  
  8. procedure TForm1.AboutClick( Sender: tObject );
  9. begin
  10. application.helpContext( MY_HELP_ABOUT )
  11. end;
  12.  
  13. procedure TForm1.HelpClick( Sender: tObject );
  14. begin
  15. application.helpContext( MY_HELP_CONTENTS )
  16. end;
  17.  
  18. ...

Hope this helps.
Reply With Quote  
Reply

Only community members can participate in forum threads. You must register or log in to contribute.

DaniWeb Pascal and Delphi Marketplace
Currently Active Users Viewing This Thread: 1 (0 members and 1 guests)

 

Thread Tools Display Modes

Similar Threads
Other Threads in the Pascal and Delphi Forum

All times are GMT -4. The time now is 12:30 am.
Forum system based on vBulletin Copyright ©2000 - 2008, Jelsoft Enterprises Ltd.
©2003 - 2008 DaniWeb® LLC