Tek-Tips is the largest IT community on the Internet today!

Members share and learn making Tek-Tips Forums the best source of peer-reviewed technical information on the Internet!

  • Congratulations TouchToneTommy on being selected by the Tek-Tips community for having the most helpful posts in the forums last week. Way to Go!

creating help files 1

Status
Not open for further replies.

CADTenchy

Technical User
Dec 12, 2007
237
GB

Looking for exactly this topic: thread102-831847 but wondering if there is more up to date advice?



Steve (Delphi 2007 & XP)
 
Depends on your needs and your budget. If the help isn't that many pages a free solution that's portable is to create html pages and use an index creator that creates an index.html file with links to all the pages. Suitable for web based help and can be used anywhere html can be read. Also you can then use the MS help workshop stuff.

There was a nice little freebie that used awk to format an .hlp help for small projects. Only thing is to get .hlp to
work in Vista you have to take ownership of the dummy help executable they put on Vista, delete it, and replace it with a real .hlp help engine. So that's a mess. It's too bad because some of the hotspot stuff is cool and no longer works in html help.

For documenting a component or unit if you search around there are some good freebies that read formatted comments and compile them into html help. It's been a couple of years since I used this particular one so I can't recall the
name. Try I'm sure there are some free help tools there. The one I used came with a style sheet that formatted the component help in Virtual Basic style.. with grid lines and whatnot but without the style sheet it was suitable for Delphi component or control docs.
 
If you want to create .hlp files (as opposed to html), my favorite is Cheetah 9 particularly because it was not only written in Delphi, but also interfaces so well with Delphi. Even though it is aged (last update 2002)
Cheetah 9 is an editor to create rtf Help Topic Files to be used with Microsoft's Help Workshop. Features: syntax highlighting, topics and keywords Trees, click-insert text and image hotspots, includes as a sample all files used to create the Cheetah help file. Find/Replace, Print, AutoComplete, import component source; Instant Delphi Component help; smart replace; import pascal source as rtf; import existing RTF topic files; Visual contents designer, single topic editor, auto-create project, follow link, quick preview; HelpContext Mapping and LinksTree. NEW in version 9: Export/Import chapters via XML; fast-link; improved interface.
I found it easy to use and customize and the price is right. See zip file download at (click programming, under software on the left.) or here:

Roo
Delphi Rules!
 
I used Help & Manual for a while but have since settled in with HelpSmith. It is a lot less expensive than Help & Manual and does what I need.

Mel
 

Follow up...

After looking at a lot of the alternatives, I'm going for HelpMaker to author my help files, and compile into CHM help file, and EC Software Help Suite.

Thanks all.


Steve (Delphi 2007 & XP)
 
I've tried out many of the help tools including EC Software Help and Manual and recently bought Helpsmith 2.0. It is very affordable and has a much more power system of dynamic styles. I really like it.
 
Status
Not open for further replies.

Part and Inventory Search

Sponsor

Back
Top